View Source API Reference google_api_android_publisher v0.34.1

Modules

API client metadata for GoogleApi.AndroidPublisher.V2.

API calls for all endpoints tagged Purchases.

Handle Tesla connections for GoogleApi.AndroidPublisher.V2.

Attributes

  • resultPerPage (type: integer(), default: nil) -
  • startIndex (type: integer(), default: nil) -
  • totalResults (type: integer(), default: nil) -

A ProductPurchase resource indicates the status of a user's inapp product purchase.

Attributes

  • nextPageToken (type: String.t, default: nil) -
  • previousPageToken (type: String.t, default: nil) -

A VoidedPurchase resource indicates a purchase that was either canceled/refunded/charged-back.

Attributes

  • pageInfo (type: GoogleApi.AndroidPublisher.V2.Model.PageInfo.t, default: nil) -
  • tokenPagination (type: GoogleApi.AndroidPublisher.V2.Model.TokenPagination.t, default: nil) -
  • voidedPurchases (type: list(GoogleApi.AndroidPublisher.V2.Model.VoidedPurchase.t), default: nil) -

API client metadata for GoogleApi.AndroidPublisher.V3.

API calls for all endpoints tagged Applications.

API calls for all endpoints tagged Apprecovery.

API calls for all endpoints tagged Edits.

API calls for all endpoints tagged Externaltransactions.

API calls for all endpoints tagged Generatedapks.

API calls for all endpoints tagged Grants.

API calls for all endpoints tagged Inappproducts.

API calls for all endpoints tagged Internalappsharingartifacts.

API calls for all endpoints tagged Monetization.

API calls for all endpoints tagged Orders.

API calls for all endpoints tagged Purchases.

API calls for all endpoints tagged Reviews.

API calls for all endpoints tagged Systemapks.

API calls for all endpoints tagged Users.

Handle Tesla connections for GoogleApi.AndroidPublisher.V3.

Represents a targeting rule of the form: User never had {scope} before.

Request message for ActivateBasePlan.

Request message for ActivateSubscriptionOffer.

Object representation to describe all set of users.

Android api level targeting data for app recovery action targeting.

Information about an APK. The resource for ApksService.

Represents the binary payload of an APK.

Description of the created apks.

A set of apks representing a module.

Represents a set of apk-level targetings.

Request to create a new externally hosted APK.

Response for creating a new externally hosted APK.

The app details. The resource for DetailsService.

An app edit. The resource for EditsService.

Information about an app recovery action.

Data format for a list of app versions.

Data format for a continuous range of app versions.

Deprecated: subscription archiving is not supported.

Set of asset slices belonging to a single asset module.

Represents a base plan that automatically renews at the end of its subscription period.

Information related to an auto renewing plan.

A single base plan for a subscription.

Request message for BatchGetSubscriptionOffers endpoint.

Response message for BatchGetSubscriptionOffers endpoint.

Response message for BatchGetSubscriptions endpoint.

Request message for BatchMigrateBasePlanPrices.

Response message for BatchMigrateBasePlanPrices.

Request message for BatchUpdateBasePlanStates.

Response message for BatchUpdateBasePlanStates.

Request message for BatchUpdateSubscriptionOfferStates.

Response message for BatchUpdateSubscriptionOfferStates.

Request message for BatchUpdateSubscriptionOffers.

Response message for BatchUpdateSubscriptionOffers.

Request message for BatchUpdateSubscription.

Response message for BatchUpdateSubscription.

Information about an app bundle. The resource for BundlesService.

Request message for CancelAppRecovery.

Response message for CancelAppRecovery.

Result of the cancel survey when the subscription was canceled by the user.

Information specific to a subscription in canceled state.

An entry of conversation between user and developer.

Request message for ConvertRegionPrices.

Response message for ConvertRegionPrices.

Country targeting specification.

Request message for CreateDraftAppRecovery.

Request message for DeactivateBasePlan.

Request message for DeactivateSubscriptionOffer.

Information related to deferred item replacement.

Request message for DeployAppRecovery.

Response message for DeployAppRecovery.

Developer entry from conversation between user and developer.

Information specific to cancellations initiated by developers.

A group of devices. A group is defined by a set of device selectors. A device belongs to the group if it matches any selector (logical OR).

Characteristics of the user's device.

Conditions about a device's RAM capabilities.

Selector for a device group. A selector consists of a set of conditions on the device that should all match (logical AND) to determine a device group eligibility. For instance, if a selector specifies RAM conditions, device model inclusion and device model exclusion, a device is considered to match if: device matches RAM conditions AND device matches one of the included device models AND device doesn't match excluded device models

The device spec used to generate a system APK.

A single device tier. Devices matching any of the device groups in device_group_names are considered to match the tier.

Configuration describing device targeting criteria for the content of an app.

A set of device tiers. A tier set determines what variation of app content gets served to a specific device, for device-targeted content. You should assign a priority level to each tier, which determines the ordering by which they are evaluated by Play. See the documentation of DeviceTier.level for more details.

An expansion file. The resource for ExpansionFilesService.

Response for uploading an expansion file.

User account identifier in the third-party service.

Details of an external subscription.

The details of an external transaction.

User's address for the external transaction.

Represents a transaction performed using a test account. These transactions will not be charged by Google.

Defines an APK available for this application that is hosted externally and not uploaded to Google Play. This function is only available to organizations using Managed Play whose application is configured to restrict distribution to the organizations.

A full refund of the remaining amount of a transaction.

Download metadata for split, standalone and universal APKs, as well as asset pack slices, signed with a given key.

Download metadata for an asset pack slice.

Download metadata for an app recovery module.

Download metadata for a split APK.

Download metadata for a standalone APK.

Download metadata for a universal APK.

Request message for GetSubscriptionOffer.

An access grant resource.

An uploaded image. The resource for ImagesService.

An in-app product. The resource for InappproductsService.

Store listing of a single in-app product.

Request to delete multiple in-app products.

Response message for BatchGetSubscriptions endpoint.

Request to update or insert one or more in-app products.

Response for a batch in-app product update.

An artifact resource which gets created when uploading an APK or Android App Bundle through internal app sharing.

Contains the introductory price information for a subscription.

Response message for ListAppRecoveries. -- api-linter: core::0158::response-next-page-token-field=disabled

Response listing existing device tier configs.

Response message for ListSubscriptionOffers.

Response message for ListSubscriptions.

A response containing one or more users with access to an account.

A localized store listing. The resource for ListingsService.

Response listing all localized listings.

Localized text in given language.

Details about taxation and legal compliance for managed products.

Request message for MigrateBasePlanPrices.

Response message for MigrateBasePlanPrices.

Represents an amount of money with its currency type.

Targeting based on multiple abis.

Offer details information related to a purchase line item.

Represents a custom tag specified for one-time products, purchase options, base plans and offers.

Pricing information for any new locations Play may launch in.

Configuration for any new locations Play may launch in specified on a subscription offer.

Configuration for any new locations Play may launch in for a single offer phase.

Pricing information for any new locations Play may launch in.

Information about the current page. List operations that supports paging return only one "page" of results. This protocol buffer message describes the page that has been returned.

A partial refund of a transaction.

Information specific to a subscription in paused state.

Represents a base plan that does not automatically renew at the end of the base plan, and must be manually renewed by the user.

Information related to a prepaid plan.

Definition of a price, i.e. currency and units.

A ProductPurchase resource indicates the status of a user's inapp product purchase.

Request for the product.purchases.acknowledge API.

Represents a transaction that is part of a recurring series of payments. This can be a subscription or a one-time product with multiple payments (such as preorder).

A request to refund an existing external transaction.

Configuration for a base plan specific to a region.

Configuration for a subscription offer in a single region.

Configuration for a single phase of a subscription offer in a single region.

Specified details about taxation in a given geographical region.

Region targeting data for app recovery action targeting.

The version of the available regions being used for the specified resource.

Object representation for Remote in-app update action type.

Data related to Remote In-App Update action such as recovered user count, affected user count etc.

Data related to the recovery action at bundle level.

Information specific to cancellations caused by subscription replacement.

The result of replying/updating a reply to review.

Request to reply to review or update existing reply.

Response on status of replying to a review.

Revocation context of the purchases.subscriptionsv2.revoke API.

Used to determine if the refund type in the RevocationContext is a prorated refund.

Request for the purchases.subscriptionsv2.revoke API.

Response for the purchases.subscriptionsv2.revoke API.

Request to update Safety Labels of an app.

Holds data specific to Split APKs.

Variant is a group of APKs that covers a part of the device configuration space. APKs from multiple variants are never combined on one device.

Holds data specific to Standalone APKs.

Information associated with purchases made with 'Subscribe with Google'.

A single subscription for an app.

Information provided by the user when they complete the subscription cancellation flow (cancellation reason survey).

A SubscriptionDeferralInfo contains the data needed to defer a subscription purchase to a future expiry time.

Price change related information of a subscription item.

The consumer-visible metadata of a subscription.

A single phase of a subscription offer.

Defines the rule a user needs to satisfy to receive this offer.

Contains the price change information for a subscription that can be used to control the user journey for the price change in the app. This can be in the form of seeking confirmation from the user or tailoring the experience for a successful conversion.

A SubscriptionPurchase resource indicates the status of a user's subscription purchase.

Item-level info for a subscription purchase.

Indicates the status of a user's subscription purchase.

Request for the purchases.subscriptions.acknowledge API.

Request for the purchases.subscriptions.defer API.

Response for the purchases.subscriptions.defer API.

Details about taxation, Google Play policy and legal compliance for subscription products.

Response to list previously created system APK variants.

Representation of a system feature.

Information specific to cancellations initiated by Google system.

Targeting details for a recovery action such as regions, android sdk levels, app versions etc.

Targeting information about the generated apks.

Defines the scope of subscriptions which a targeting rule can match to target offers to users based on past or current entitlement.

Represents the targeting rule scope corresponding to any subscription in the parent app.

Represents the targeting rule scope corresponding to the subscriptions in which this offer is defined.

Update type for targeting. Note it is always a subset Targeting.

Whether this subscription purchase is a test purchase.

The testers of an app. The resource for TestersService. Note: while it is possible in the Play Console UI to add testers via email lists, email lists are not supported by this resource.

Represents texture compression format.

A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970.

Pagination information returned by a List operation when token pagination is enabled. List operations that supports paging return only one "page" of results. This protocol buffer message describes the page that has been returned. When using token pagination, clients should use the next/previous token to get another page of the result. The presence or absence of next/previous token indicates whether a next/previous page is available and provides a mean of accessing this page. ListRequest.page_token should be set to either next_page_token or previous_page_token to access another page.

A track configuration. The resource for TracksService.

Configurations of the new track.

Resource for per-track country availability information.

Representation of a single country where the contents of a track are available.

Request message to update the state of a subscription base plan.

Request message for UpdateSubscriptionOffer.

Request message to update the state of a subscription offer.

Request message for UpdateSubscription.

Represents a targeting rule of the form: User currently has {scope} [with billing period {billing_period}].

User entry from conversation between user and developer.

Describes an inclusive/exclusive list of country codes that module targets.

A set of user countries. A country set determines what variation of app content gets served to a specific location.

Information specific to cancellations initiated by users.

APK that is suitable for inclusion in a system image. The resource of SystemApksService.

Targeting on the level of variants.

A VoidedPurchase resource indicates a purchase that was either canceled/refunded/charged-back.

Response for the voidedpurchases.list API.