Show / Hide Table of Contents

Namespace Google.Apis.AndroidPublisher.v3.Data

Classes

Abi

Represents an Abi.

AbiTargeting

Targeting based on Abi.

AcquisitionTargetingRule

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

ActivateBasePlanRequest

Request message for ActivateBasePlan.

ActivateSubscriptionOfferRequest

Request message for ActivateSubscriptionOffer.

AddTargetingRequest

Request message for AddTargeting.

AddTargetingResponse

Response message for AddTargeting.

AllUsers

Object representation to describe all set of users.

AndroidSdks

Android api level targeting data for app recovery action targeting.

Apk

Information about an APK. The resource for ApksService.

ApkBinary

Represents the binary payload of an APK.

ApkDescription

Description of the created apks.

ApkSet

A set of apks representing a module.

ApkTargeting

Represents a set of apk-level targetings.

ApksAddExternallyHostedRequest

Request to create a new externally hosted APK.

ApksAddExternallyHostedResponse

Response for creating a new externally hosted APK.

ApksListResponse

Response listing all APKs.

AppDetails

The app details. The resource for DetailsService.

AppEdit

An app edit. The resource for EditsService.

AppRecoveryAction

Information about an app recovery action.

AppVersionList

Data format for a list of app versions.

AppVersionRange

Data format for a continuous range of app versions.

ArchiveSubscriptionRequest

Deprecated: subscription archiving is not supported.

AssetModuleMetadata

Metadata of an asset module.

AssetSliceSet

Set of asset slices belonging to a single asset module.

AutoRenewingBasePlanType

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

AutoRenewingPlan

Information related to an auto renewing plan.

BasePlan

A single base plan for a subscription.

BatchGetOrdersResponse

Response for the orders.batchGet API.

BatchGetSubscriptionOffersRequest

Request message for BatchGetSubscriptionOffers endpoint.

BatchGetSubscriptionOffersResponse

Response message for BatchGetSubscriptionOffers endpoint.

BatchGetSubscriptionsResponse

Response message for BatchGetSubscriptions endpoint.

BatchMigrateBasePlanPricesRequest

Request message for BatchMigrateBasePlanPrices.

BatchMigrateBasePlanPricesResponse

Response message for BatchMigrateBasePlanPrices.

BatchUpdateBasePlanStatesRequest

Request message for BatchUpdateBasePlanStates.

BatchUpdateBasePlanStatesResponse

Response message for BatchUpdateBasePlanStates.

BatchUpdateSubscriptionOfferStatesRequest

Request message for BatchUpdateSubscriptionOfferStates.

BatchUpdateSubscriptionOfferStatesResponse

Response message for BatchUpdateSubscriptionOfferStates.

BatchUpdateSubscriptionOffersRequest

Request message for BatchUpdateSubscriptionOffers.

BatchUpdateSubscriptionOffersResponse

Response message for BatchUpdateSubscriptionOffers.

BatchUpdateSubscriptionsRequest

Request message for BatchUpdateSubscription.

BatchUpdateSubscriptionsResponse

Response message for BatchUpdateSubscription.

Bundle

Information about an app bundle. The resource for BundlesService.

BundlesListResponse

Response listing all app bundles.

BuyerAddress

Address information for the customer, for use in tax computation.

CancelAppRecoveryRequest

Request message for CancelAppRecovery.

CancelAppRecoveryResponse

Response message for CancelAppRecovery.

CancelSurveyResult

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

CanceledStateContext

Information specific to a subscription in the SUBSCRIPTION_STATE_CANCELED or SUBSCRIPTION_STATE_EXPIRED state.

CancellationEvent

Details of when the order was canceled.

Comment

An entry of conversation between user and developer.

ConvertRegionPricesRequest

Request message for ConvertRegionPrices.

ConvertRegionPricesResponse

Response message for ConvertRegionPrices.

ConvertedOtherRegionsPrice

Converted other regions prices.

ConvertedRegionPrice

A converted region price.

CountryTargeting

Country targeting specification.

CreateDraftAppRecoveryRequest

Request message for CreateDraftAppRecovery.

DeactivateBasePlanRequest

Request message for DeactivateBasePlan.

DeactivateSubscriptionOfferRequest

Request message for DeactivateSubscriptionOffer.

DeferredItemReplacement

Information related to deferred item replacement.

DeobfuscationFile

Represents a deobfuscation file.

DeobfuscationFilesUploadResponse

Responses for the upload.

DeployAppRecoveryRequest

Request message for DeployAppRecovery.

DeployAppRecoveryResponse

Response message for DeployAppRecovery.

DeveloperComment

Developer entry from conversation between user and developer.

DeveloperInitiatedCancellation

Information specific to cancellations initiated by developers.

DeviceFeature

Represents a device feature.

DeviceFeatureTargeting

Targeting for a device feature.

DeviceGroup

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).

DeviceId

Identifier of a device.

DeviceMetadata

Characteristics of the user's device.

DeviceRam

Conditions about a device's RAM capabilities.

DeviceSelector

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

DeviceSpec

The device spec used to generate a system APK.

DeviceTier

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

DeviceTierConfig

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

DeviceTierSet

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.

ExpansionFile

An expansion file. The resource for ExpansionFilesService.

ExpansionFilesUploadResponse

Response for uploading an expansion file.

ExternalAccountIdentifiers

User account identifier in the third-party service.

ExternalSubscription

Details of an external subscription.

ExternalTransaction

The details of an external transaction.

ExternalTransactionAddress

User's address for the external transaction.

ExternalTransactionTestPurchase

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

ExternallyHostedApk

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.

FullRefund

A full refund of the remaining amount of a transaction.

GeneratedApksListResponse

Response to list generated APKs.

GeneratedApksPerSigningKey

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

GeneratedAssetPackSlice

Download metadata for an asset pack slice.

GeneratedRecoveryApk

Download metadata for an app recovery module.

GeneratedSplitApk

Download metadata for a split APK.

GeneratedStandaloneApk

Download metadata for a standalone APK.

GeneratedUniversalApk

Download metadata for a universal APK.

GetSubscriptionOfferRequest

Request message for GetSubscriptionOffer.

Grant

An access grant resource.

Image

An uploaded image. The resource for ImagesService.

ImagesDeleteAllResponse

Response for deleting all images.

ImagesListResponse

Response listing all images.

ImagesUploadResponse

Response for uploading an image.

InAppProduct

An in-app product. The resource for InappproductsService.

InAppProductListing

Store listing of a single in-app product.

InappproductsBatchDeleteRequest

Request to delete multiple in-app products.

InappproductsBatchGetResponse

Response message for BatchGetSubscriptions endpoint.

InappproductsBatchUpdateRequest

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

InappproductsBatchUpdateResponse

Response for a batch in-app product update.

InappproductsDeleteRequest

Request to delete an in-app product.

InappproductsListResponse

Response listing all in-app products.

InappproductsUpdateRequest

Request to update an in-app product.

InstallmentPlan

Information to a installment plan.

InstallmentsBasePlanType

Represents an installments base plan where a user commits to a specified number of payments.

InternalAppSharingArtifact

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

IntroductoryPriceInfo

Contains the introductory price information for a subscription.

LanguageTargeting

Targeting based on language.

LineItem

Details of a line item.

ListAppRecoveriesResponse

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

ListDeviceTierConfigsResponse

Response listing existing device tier configs.

ListSubscriptionOffersResponse

Response message for ListSubscriptionOffers.

ListSubscriptionsResponse

Response message for ListSubscriptions.

ListUsersResponse

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

Listing

A localized store listing. The resource for ListingsService.

ListingsListResponse

Response listing all localized listings.

LocalizedText

Localized text in given language.

ManagedProductTaxAndComplianceSettings

Details about taxation and legal compliance for managed products.

MigrateBasePlanPricesRequest

Request message for MigrateBasePlanPrices.

MigrateBasePlanPricesResponse

Response message for MigrateBasePlanPrices.

ModuleMetadata

Metadata of a module.

ModuleTargeting

Targeting on the module level.

Money

Represents an amount of money with its currency type.

MultiAbi

Represents a list of ABIs.

MultiAbiTargeting

Targeting based on multiple abis.

OfferDetails

Offer details information related to a purchase line item.

OfferTag

Represents a custom tag specified for a product offer.

OneTimeCode

A single use promotion code.

OneTimeExternalTransaction

Represents a one-time transaction.

OneTimePurchaseDetails

Details of a one-time purchase.

Order

The Order resource encapsulates comprehensive information about a transaction made on Google Play. It includes a variety of attributes that provide details about the order itself, the products purchased, and the history of events related to the order. The Orders APIs provide real-time access to your order data within the Google Play ecosystem. You can retrieve detailed information and metadata for both one-time and recurring orders, including transaction details like charges, taxes, and refunds, as well as metadata such as pricing phases for subscriptions. The Orders APIs let you automate tasks related to order management, reducing the need for manual checks via the Play Developer Console. The following are some of the use cases for this API: + Real-time order data retrieval - Get order details and metadata immediately after a purchase using an order ID. + Order update synchronization - Periodically sync order updates to maintain an up-to-date record of order information. Note: + The Orders API calls count towards your Play Developer API quota, which defaults to 200K daily, and may be insufficient to sync extensive order histories. + A maximum of 1000 orders can be retrieved per call. Using larger page sizes is recommended to minimize quota usage. Check your quota in the Cloud Console and request more if required.

OrderDetails

Detailed information about the order at creation time.

OrderHistory

Details about events which modified the order.

OtherRecurringProduct

Details of a recurring external transaction product which doesn't belong to any other more specific category.

OtherRegionsBasePlanConfig

Pricing information for any new locations Play may launch in.

OtherRegionsSubscriptionOfferConfig

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

OtherRegionsSubscriptionOfferPhaseConfig

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

OtherRegionsSubscriptionOfferPhaseFreePriceOverride

Represents the free price override configuration for any new locations Play may launch for a single offer phase.

OtherRegionsSubscriptionOfferPhasePrices

Pricing information for any new locations Play may launch in.

PageInfo

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.

PaidAppDetails

Details of a paid app purchase.

PartialRefund

A partial refund of a transaction.

PartialRefundEvent

Details of the partial refund events for this order.

PausedStateContext

Information specific to a subscription in paused state.

PendingCancellation

This is an indicator of whether there is a pending cancellation on the virtual installment plan. The cancellation will happen only after the user finished all committed payments.

PointsDetails

Details relating to any Play Points applied to an order.

PrepaidBasePlanType

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

PrepaidPlan

Information related to a prepaid plan.

Price

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

ProcessedEvent

Details of when the order was processed.

ProductPurchase

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

ProductPurchasesAcknowledgeRequest

Request for the product.purchases.acknowledge API.

RecurringExternalTransaction

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).

RefundDetails

Details for a partial or full refund.

RefundEvent

Details of when the order was fully refunded.

RefundExternalTransactionRequest

A request to refund an existing external transaction.

RegionalBasePlanConfig

Configuration for a base plan specific to a region.

RegionalPriceMigrationConfig

Configuration for migration of a legacy price cohort.

RegionalSubscriptionOfferConfig

Configuration for a subscription offer in a single region.

RegionalSubscriptionOfferPhaseConfig

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

RegionalSubscriptionOfferPhaseFreePriceOverride

Represents the free price override configuration for a single phase of a subscription offer

RegionalTaxRateInfo

Specified details about taxation in a given geographical region.

Regions

Region targeting data for app recovery action targeting.

RegionsVersion

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

RemoteInAppUpdate

Object representation for Remote in-app update action type.

RemoteInAppUpdateData

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

RemoteInAppUpdateDataPerBundle

Data related to the recovery action at bundle level.

ReplacementCancellation

Information specific to cancellations caused by subscription replacement.

RestrictedPaymentCountries

Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed.

Review

An Android app review.

ReviewReplyResult

The result of replying/updating a reply to review.

ReviewsListResponse

Response listing reviews.

ReviewsReplyRequest

Request to reply to review or update existing reply.

ReviewsReplyResponse

Response on status of replying to a review.

RevocationContext

Revocation context of the purchases.subscriptionsv2.revoke API.

RevocationContextFullRefund

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

RevocationContextItemBasedRefund

Used to determine what specific item to revoke in a subscription with multiple items.

RevocationContextProratedRefund

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

RevokeSubscriptionPurchaseRequest

Request for the purchases.subscriptionsv2.revoke API.

RevokeSubscriptionPurchaseResponse

Response for the purchases.subscriptionsv2.revoke API.

SafetyLabelsUpdateRequest

Request to update Safety Labels of an app.

SafetyLabelsUpdateResponse

Response for SafetyLabelsUpdate rpc.

ScreenDensity

Represents a screen density.

ScreenDensityTargeting

Targeting based on screen density.

SdkVersion

Represents an sdk version.

SdkVersionTargeting

Targeting based on sdk version.

SignupPromotion

The promotion applied on this item when purchased.

SplitApkMetadata

Holds data specific to Split APKs.

SplitApkVariant

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.

StandaloneApkMetadata

Holds data specific to Standalone APKs.

SubscribeWithGoogleInfo

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

Subscription

A single subscription for an app.

SubscriptionCancelSurveyResult

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

SubscriptionDeferralInfo

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

SubscriptionDetails

Details of a subscription purchase.

SubscriptionItemPriceChangeDetails

Price change related information of a subscription item.

SubscriptionListing

The consumer-visible metadata of a subscription.

SubscriptionOffer

A single, temporary offer

SubscriptionOfferPhase

A single phase of a subscription offer.

SubscriptionOfferTargeting

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

SubscriptionPriceChange

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.

SubscriptionPurchase

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

SubscriptionPurchaseLineItem

Item-level info for a subscription purchase.

SubscriptionPurchaseV2

Indicates the status of a user's subscription purchase.

SubscriptionPurchasesAcknowledgeRequest

Request for the purchases.subscriptions.acknowledge API.

SubscriptionPurchasesDeferRequest

Request for the purchases.subscriptions.defer API.

SubscriptionPurchasesDeferResponse

Response for the purchases.subscriptions.defer API.

SubscriptionTaxAndComplianceSettings

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

SystemApkOptions

Options for system APKs.

SystemApksListResponse

Response to list previously created system APK variants.

SystemFeature

Representation of a system feature.

SystemInitiatedCancellation

Information specific to cancellations initiated by Google system.

SystemOnChip

Representation of a System-on-Chip (SoC) of an Android device. Can be used to target S+ devices.

Targeting

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

TargetingInfo

Targeting information about the generated apks.

TargetingRuleScope

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

TargetingRuleScopeAnySubscriptionInApp

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

TargetingRuleScopeThisSubscription

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

TargetingUpdate

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

TestPurchase

Whether this subscription purchase is a test purchase.

Testers

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.

TextureCompressionFormat

Represents texture compression format.

TextureCompressionFormatTargeting

Targeting by a texture compression format.

Timestamp

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.

TokenPagination

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.

Track

A track configuration. The resource for TracksService.

TrackConfig

Configurations of the new track.

TrackCountryAvailability

Resource for per-track country availability information.

TrackRelease

A release within a track.

TrackTargetedCountry

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

TracksListResponse

Response listing all tracks.

UpdateBasePlanStateRequest

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

UpdateSubscriptionOfferRequest

Request message for UpdateSubscriptionOffer.

UpdateSubscriptionOfferStateRequest

Request message to update the state of a subscription offer.

UpdateSubscriptionRequest

Request message for UpdateSubscription.

UpgradeTargetingRule

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

User

A user resource.

UserComment

User entry from conversation between user and developer.

UserCountriesTargeting

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

UserCountrySet

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

UserInitiatedCancellation

Information specific to cancellations initiated by users.

UsesPermission

A permission used by this APK.

VanityCode

A multiple use, predefined promotion code.

Variant

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

VariantTargeting

Targeting on the level of variants.

VoidedPurchase

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

VoidedPurchasesListResponse

Response for the voidedpurchases.list API.

In this article
Back to top Generated by DocFX