{ "schemas": { "UploadApkRequest": { "id": "UploadApkRequest", "description": "Request to upload an APK.", "properties": {}, "type": "object" }, "UpdateAppStoreHostedAppPublishStatusResponse": { "type": "object", "id": "UpdateAppStoreHostedAppPublishStatusResponse", "description": "Response for updating the publish status of an app store hosted app.", "properties": {} }, "DeployAppRecoveryRequest": { "type": "object", "properties": {}, "id": "DeployAppRecoveryRequest", "description": "Request message for DeployAppRecovery." }, "EnrollNewApp": { "id": "EnrollNewApp", "description": "Enroll a new app into Play signing.", "properties": { "cloudKmsKeyAndCert": { "description": "Required. Self-hosted key. Once enrolled, this key will be used to sign your app.", "$ref": "CloudKmsKeyAndCert" } }, "type": "object" }, "SubscriptionOfferTargeting": { "description": "Defines the rule a user needs to satisfy to receive this offer.", "id": "SubscriptionOfferTargeting", "properties": { "upgradeRule": { "description": "Offer targeting rule for upgrading users' existing plans.", "$ref": "UpgradeTargetingRule" }, "acquisitionRule": { "description": "Offer targeting rule for new user acquisition.", "$ref": "AcquisitionTargetingRule" } }, "type": "object" }, "RevokeSubscriptionPurchaseRequest": { "properties": { "revocationContext": { "$ref": "RevocationContext", "description": "Required. Additional details around the subscription revocation." } }, "id": "RevokeSubscriptionPurchaseRequest", "description": "Request for the purchases.subscriptionsv2.revoke API.", "type": "object" }, "ImagesListResponse": { "properties": { "images": { "items": { "$ref": "Image" }, "description": "All listed Images.", "type": "array" } }, "id": "ImagesListResponse", "type": "object", "description": "Response listing all images." }, "DeviceGroup": { "description": "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).", "properties": { "deviceSelectors": { "type": "array", "description": "Device selectors for this group. A device matching any of the selectors is included in this group.", "items": { "$ref": "DeviceSelector" } }, "name": { "description": "The name of the group.", "type": "string" } }, "id": "DeviceGroup", "type": "object" }, "InternalAppSharingArtifact": { "properties": { "downloadUrl": { "description": "The download URL generated for the uploaded artifact. Users that are authorized to download can follow the link to the Play Store app to install it.", "type": "string" }, "sha256": { "description": "The sha256 hash of the artifact represented as a lowercase hexadecimal number, matching the output of the sha256sum command.", "type": "string" }, "certificateFingerprint": { "type": "string", "description": "The sha256 fingerprint of the certificate used to sign the generated artifact." } }, "description": "An artifact resource which gets created when uploading an APK or Android App Bundle through internal app sharing.", "type": "object", "id": "InternalAppSharingArtifact" }, "AppStoreAppPolicyDeclaration": { "description": "A policy declaration with its responses.", "type": "object", "id": "AppStoreAppPolicyDeclaration", "properties": { "responses": { "description": "Required. Responses provided for this declaration.", "items": { "$ref": "PolicyResponse" }, "type": "array" }, "declarationId": { "type": "string", "description": "Required. ID of the policy declaration." } } }, "DeviceCompatibilityRequirements": { "description": "Defines a set of device compatibility requirements for the app. A device must satisfy all of the requirements in a set to be considered compatible with the app.", "id": "DeviceCompatibilityRequirements", "type": "object", "properties": { "supportedGlTextures": { "description": "Supported gl textures as specified by the `supported-gl-texture` Manifest tag.", "type": "array", "items": { "type": "string" } }, "compatibleScreens": { "items": { "$ref": "CompatibleScreen" }, "description": "Compatible screens as listed in the `compatible-screens` Manifest tag.", "type": "array" }, "usesConfigurations": { "items": { "$ref": "UsesConfiguration" }, "description": "Lists all configurations marked as required by use of the `uses-configuration` manifest tag. Each instance of this proto represents a single `uses-configuration` entry. See http://developer.android.com/guide/topics/manifest/uses-configuration-element.html", "type": "array" }, "use32BitAbi": { "description": "Value of `android:use32BitAbi` flag retrieved from the Manifest.", "type": "string", "enum": [ "USE_32_BIT_ABI_UNSPECIFIED", "USE_32_BIT_ABI_TRUE", "USE_32_BIT_ABI_OTHER" ], "enumDescriptions": [ "Unspecified 32-bit ABI usage.", "Value of use32BitAbi is set to \"true\".", "Value of use32BitAbi is not set or set to something other than \"true\"." ] }, "requiresSmallestWidthDp": { "format": "int64", "type": "string", "description": "Specifies the minimum smallest width required of the screen." }, "isScreenRequired": { "type": "boolean", "description": "Specifies if the app requires a screen." }, "requiredSystemFeatures": { "type": "array", "description": "The system features that the app requires. A device must have all of the system features to be considered compatible with the app.", "items": { "type": "string" } }, "sdkVersion": { "description": "Defines a range of SDK versions that the app is compatible with.", "$ref": "CatalogSdkVersion" }, "supportedScreens": { "description": "Compatible screens as listed in the `supports-screens` Manifest tag.", "items": { "enumDescriptions": [ "Unspecified screen size.", "Small screen size.", "Normal screen size.", "Large screen size.", "Extra large screen size." ], "type": "string", "enum": [ "SCREEN_SIZE_UNSPECIFIED", "SCREEN_SIZE_SMALL", "SCREEN_SIZE_NORMAL", "SCREEN_SIZE_LARGE", "SCREEN_SIZE_EXTRA_LARGE" ] }, "type": "array" }, "nativePlatforms": { "items": { "type": "string" }, "type": "array", "description": "List of required ABIs (Application Binary Interface), e.g. `armeabi` or `x86`." }, "glEsVersion": { "format": "int32", "type": "integer", "description": "Required version of OpenGL ES." }, "requiredSoftwareLibraries": { "items": { "type": "string" }, "type": "array", "description": "List of required libraries as declared in the `uses-library` manifest tag." } } }, "DeobfuscationFilesUploadResponse": { "properties": { "deobfuscationFile": { "$ref": "DeobfuscationFile", "description": "The uploaded Deobfuscation File configuration." } }, "id": "DeobfuscationFilesUploadResponse", "description": "Responses for the upload.", "type": "object" }, "ItemExpiryTimeDetails": { "description": "Expiry time details of a subscription item.", "properties": { "productId": { "description": "The product ID of the subscription item (for example, 'premium_plan').", "type": "string" }, "expiryTime": { "format": "google-datetime", "description": "The new expiry time for this subscription item.", "type": "string" } }, "id": "ItemExpiryTimeDetails", "type": "object" }, "OneTimeProductBuyPurchaseOption": { "properties": { "multiQuantityEnabled": { "description": "Optional. Whether this purchase option allows multi-quantity. Multi-quantity allows buyer to purchase more than one item in a single checkout.", "type": "boolean" }, "legacyCompatible": { "type": "boolean", "description": "Optional. Whether this purchase option will be available in legacy PBL flows that do not support one-time products model. Up to one \"buy\" purchase option can be marked as backwards compatible." } }, "id": "OneTimeProductBuyPurchaseOption", "description": "A purchase option that can be bought.", "type": "object" }, "Testers": { "id": "Testers", "properties": { "googleGroups": { "items": { "type": "string" }, "type": "array", "description": "All testing Google Groups, as email addresses." } }, "type": "object", "description": "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." }, "ReplacementCancellation": { "id": "ReplacementCancellation", "properties": {}, "description": "Information specific to cancellations caused by subscription replacement.", "type": "object" }, "ProrationPeriodOfferPhase": { "properties": { "originalOfferPhaseType": { "type": "string", "enum": [ "ORIGINAL_OFFER_PHASE_TYPE_UNSPECIFIED", "BASE", "INTRODUCTORY", "FREE_TRIAL" ], "description": "The original offer phase type before the proration period. Only set when the proration period is updated from an existing offer phase.", "enumDescriptions": [ "Unspecified original offer phase type.", "The subscription is in the base pricing phase (e.g. full price).", "The subscription is in an introductory pricing phase.", "The subscription is in a free trial." ] } }, "type": "object", "description": "Details about proration period offer phase.", "id": "ProrationPeriodOfferPhase" }, "ImagesDeleteAllResponse": { "type": "object", "description": "Response for deleting all images.", "properties": { "deleted": { "items": { "$ref": "Image" }, "description": "The deleted images.", "type": "array" } }, "id": "ImagesDeleteAllResponse" }, "SubscribeWithGoogleInfo": { "id": "SubscribeWithGoogleInfo", "properties": { "profileName": { "description": "The profile name of the user when the subscription was purchased.", "type": "string" }, "familyName": { "description": "The family name of the user when the subscription was purchased.", "type": "string" }, "profileId": { "description": "The Google profile id of the user when the subscription was purchased.", "type": "string" }, "emailAddress": { "type": "string", "description": "The email address of the user when the subscription was purchased." }, "givenName": { "description": "The given name of the user when the subscription was purchased.", "type": "string" } }, "description": "Information associated with purchases made with 'Subscribe with Google'.", "type": "object" }, "ListSubscriptionOffersResponse": { "id": "ListSubscriptionOffersResponse", "properties": { "subscriptionOffers": { "type": "array", "items": { "$ref": "SubscriptionOffer" }, "description": "The subscription offers from the specified subscription." }, "nextPageToken": { "type": "string", "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." } }, "description": "Response message for ListSubscriptionOffers.", "type": "object" }, "InappproductsDeleteRequest": { "type": "object", "description": "Request to delete an in-app product.", "id": "InappproductsDeleteRequest", "properties": { "latencyTolerance": { "description": "Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.", "enumDescriptions": [ "Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.", "The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.", "The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods." ], "type": "string", "enum": [ "PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT" ] }, "sku": { "description": "Unique identifier for the in-app product.", "type": "string" }, "packageName": { "description": "Package name of the app.", "type": "string" } } }, "OneTimeProductOffer": { "properties": { "discountedOffer": { "description": "A discounted offer.", "$ref": "OneTimeProductDiscountedOffer" }, "productId": { "type": "string", "description": "Required. Immutable. The ID of the parent product this offer belongs to." }, "regionalPricingAndAvailabilityConfigs": { "type": "array", "items": { "$ref": "OneTimeProductOfferRegionalPricingAndAvailabilityConfig" }, "description": "Set of regional pricing and availability information for this offer. Must not have duplicate entries with the same region_code." }, "packageName": { "type": "string", "description": "Required. Immutable. The package name of the app the parent product belongs to." }, "gameRewardOffer": { "description": "A game reward offer.", "$ref": "OneTimeProductGameRewardOffer" }, "offerId": { "description": "Required. Immutable. The ID of this product offer. Must be unique within the purchase option. It must start with a number or lower-case letter, and can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-). The maximum length is 63 characters.", "type": "string" }, "offerTags": { "items": { "$ref": "OfferTag" }, "type": "array", "description": "Optional. List of up to 20 custom tags specified for this offer, and returned to the app through the billing library." }, "regionsVersion": { "$ref": "RegionsVersion", "readOnly": true, "description": "Output only. The version of the regions configuration that was used to generate the one-time product offer." }, "preOrderOffer": { "$ref": "OneTimeProductPreOrderOffer", "description": "A pre-order offer." }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "DRAFT", "ACTIVE", "CANCELLED", "INACTIVE" ], "description": "Output only. The current state of this offer. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.", "readOnly": true, "enumDescriptions": [ "Default value, should never be used.", "The offer is not and has never been available to users.", "The offer is available to users, as long as its conditions are met.", "This state is specific to pre-orders. The offer is cancelled and not available to users. All pending orders related to this offer were cancelled.", "This state is specific to discounted offers. The offer is no longer available to users." ] }, "purchaseOptionId": { "description": "Required. Immutable. The ID of the purchase option to which this offer is an extension.", "type": "string" } }, "description": "A single offer for a one-time product.", "id": "OneTimeProductOffer", "type": "object" }, "Group": { "description": "A group of responses.", "properties": { "responses": { "description": "Required. Responses within a group.", "type": "array", "items": { "$ref": "NestedPolicyResponse" } } }, "id": "Group", "type": "object" }, "ProductOfferDetails": { "type": "object", "properties": { "consumptionState": { "enumDescriptions": [ "Consumption state unspecified. This value should never be set.", "Yet to be consumed.", "Consumed already." ], "type": "string", "readOnly": true, "description": "Output only. The consumption state of the purchase.", "enum": [ "CONSUMPTION_STATE_UNSPECIFIED", "CONSUMPTION_STATE_YET_TO_BE_CONSUMED", "CONSUMPTION_STATE_CONSUMED" ] }, "refundableQuantity": { "type": "integer", "format": "int32", "description": "The quantity eligible for refund, i.e. quantity that hasn't been refunded. The value reflects quantity-based partial refunds and full refunds." }, "offerId": { "type": "string", "description": "The offer ID. Only present for offers." }, "preorderOfferDetails": { "description": "Offer details for a preorder offer. This will only be set for preorders.", "$ref": "PreorderOfferDetails" }, "rentOfferDetails": { "description": "Offer details about rent offers. This will only be set for rental line items.", "$ref": "RentOfferDetails" }, "offerToken": { "description": "The per-transaction offer token used to make this purchase line item.", "type": "string" }, "purchaseOptionId": { "type": "string", "description": "The purchase option ID." }, "quantity": { "description": "The quantity associated with the purchase of the inapp product.", "type": "integer", "format": "int32" }, "offerTags": { "description": "The latest offer tags associated with the offer. It includes tags inherited from the purchase option.", "items": { "type": "string" }, "type": "array" } }, "description": "Offer details information related to a purchase line item.", "id": "ProductOfferDetails" }, "OtherRegionsSubscriptionOfferPhasePrices": { "description": "Pricing information for any new locations Play may launch in.", "type": "object", "id": "OtherRegionsSubscriptionOfferPhasePrices", "properties": { "eurPrice": { "description": "Required. Price in EUR to use for any new locations Play may launch in.", "$ref": "Money" }, "usdPrice": { "$ref": "Money", "description": "Required. Price in USD to use for any new locations Play may launch in." } } }, "RevocationContextFullRefund": { "type": "object", "id": "RevocationContextFullRefund", "properties": {}, "description": "Used to determine if the refund type in the RevocationContext is a full refund." }, "OtherRegionsSubscriptionOfferPhaseFreePriceOverride": { "properties": {}, "description": "Represents the free price override configuration for any new locations Play may launch for a single offer phase.", "id": "OtherRegionsSubscriptionOfferPhaseFreePriceOverride", "type": "object" }, "ListUsersResponse": { "description": "A response containing one or more users with access to an account.", "properties": { "nextPageToken": { "description": "A token to pass to subsequent calls in order to retrieve subsequent results. This will not be set if there are no more results to return.", "type": "string" }, "users": { "type": "array", "description": "The resulting users.", "items": { "$ref": "User" } } }, "id": "ListUsersResponse", "type": "object" }, "CoarseLocation": { "properties": { "sublocality": { "description": "Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district. For most addresses, you can omit this.", "type": "string" }, "regionCode": { "type": "string", "description": "Required. [CLDR region code](https://cldr.unicode.org/) of the country/region of the address. This value is never inferred and you must ensure the value is correct. Example: \"CH\" for Switzerland." }, "locality": { "description": "Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty.", "type": "string" }, "administrativeArea": { "description": "Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, \"Barcelona\" and not \"Catalonia\"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.", "type": "string" } }, "description": "Coarse Geographic location details for where the consumption happened.", "type": "object", "id": "CoarseLocation" }, "EnrollExistingApp": { "id": "EnrollExistingApp", "type": "object", "description": "Enroll an existing app into Play signing.", "properties": { "cloudKmsKey": { "$ref": "CloudKmsKey", "description": "Required. Self-hosted key. Once enrolled, this key will be used to sign your app." } } }, "RevocationContextProratedRefund": { "properties": {}, "type": "object", "description": "Used to determine if the refund type in the RevocationContext is a prorated refund.", "id": "RevocationContextProratedRefund" }, "DeviceSpec": { "properties": { "supportedAbis": { "description": "Supported ABI architectures in the order of preference. The values should be the string as reported by the platform, e.g. \"armeabi-v7a\", \"x86_64\".", "items": { "type": "string" }, "type": "array" }, "screenDensity": { "format": "uint32", "description": "Screen dpi.", "type": "integer" }, "supportedLocales": { "type": "array", "description": "All installed locales represented as BCP-47 strings, e.g. \"en-US\".", "items": { "type": "string" } } }, "type": "object", "id": "DeviceSpec", "description": "The device spec used to generate a system APK." }, "RegionsVersion": { "type": "object", "description": "The version of the available regions being used for the specified resource.", "properties": { "version": { "type": "string", "description": "Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available." } }, "id": "RegionsVersion" }, "UploadImageRequest": { "type": "object", "id": "UploadImageRequest", "description": "Request to upload an image.", "properties": {} }, "ManagedProductTaxAndComplianceSettings": { "description": "Details about taxation and legal compliance for managed products.", "type": "object", "properties": { "isTokenizedDigitalAsset": { "description": "Whether this in-app product is declared as a product representing a tokenized digital asset.", "type": "boolean" }, "regionalProductAgeRatingInfos": { "items": { "$ref": "RegionalProductAgeRatingInfo" }, "type": "array", "description": "Regional age rating information. Currently this field is only supported for region code `US`." }, "eeaWithdrawalRightType": { "enumDescriptions": [ "", "", "" ], "description": "Digital content or service classification for products distributed to users in the European Economic Area (EEA). The withdrawal regime under EEA consumer laws depends on this classification. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.", "type": "string", "enum": [ "WITHDRAWAL_RIGHT_TYPE_UNSPECIFIED", "WITHDRAWAL_RIGHT_DIGITAL_CONTENT", "WITHDRAWAL_RIGHT_SERVICE" ] }, "productTaxCategoryCode": { "type": "string", "description": "Product tax category code to assign to the in-app product. Product tax category determines the transaction tax rates applied to the product. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/16408159) for more information." }, "taxRateInfoByRegionCode": { "type": "object", "description": "A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's \"CLDR\".", "additionalProperties": { "$ref": "RegionalTaxRateInfo" } } }, "id": "ManagedProductTaxAndComplianceSettings" }, "LanguageTargeting": { "description": "Targeting based on language.", "type": "object", "id": "LanguageTargeting", "properties": { "alternatives": { "items": { "type": "string" }, "type": "array", "description": "Alternative languages." }, "value": { "items": { "type": "string" }, "description": "ISO-639: 2 or 3 letter language code.", "type": "array" } } }, "RevokeSubscriptionPurchaseResponse": { "id": "RevokeSubscriptionPurchaseResponse", "properties": {}, "description": "Response for the purchases.subscriptionsv2.revoke API.", "type": "object" }, "DeveloperComment": { "id": "DeveloperComment", "properties": { "lastModified": { "$ref": "Timestamp", "description": "The last time at which this comment was updated." }, "text": { "type": "string", "description": "The content of the comment, i.e. reply body." } }, "type": "object", "description": "Developer entry from conversation between user and developer." }, "UpdateSubscriptionOfferRequest": { "description": "Request message for UpdateSubscriptionOffer.", "id": "UpdateSubscriptionOfferRequest", "type": "object", "properties": { "regionsVersion": { "description": "Required. The version of the available regions being used for the subscription_offer.", "$ref": "RegionsVersion" }, "subscriptionOffer": { "description": "Required. The subscription offer to update.", "$ref": "SubscriptionOffer" }, "allowMissing": { "type": "boolean", "description": "Optional. If set to true, and the subscription offer with the given package_name, product_id, base_plan_id and offer_id doesn't exist, an offer will be created. If a new offer is created, update_mask is ignored." }, "latencyTolerance": { "enumDescriptions": [ "Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.", "The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.", "The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods." ], "description": "Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.", "type": "string", "enum": [ "PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT" ] }, "updateMask": { "type": "string", "description": "Required. The list of fields to be updated.", "format": "google-fieldmask" } } }, "ScreenshotSet": { "properties": { "screenshots": { "description": "The image assets of the screenshots.", "items": { "$ref": "ImageAsset" }, "type": "array" } }, "description": "A set of screenshots.", "id": "ScreenshotSet", "type": "object" }, "VoidedPurchasesListResponse": { "type": "object", "id": "VoidedPurchasesListResponse", "properties": { "tokenPagination": { "description": "Pagination information for token pagination.", "$ref": "TokenPagination" }, "pageInfo": { "description": "General pagination information.", "$ref": "PageInfo" }, "voidedPurchases": { "type": "array", "items": { "$ref": "VoidedPurchase" } } }, "description": "Response for the voidedpurchases.list API." }, "BatchUpdateOneTimeProductOfferStatesRequest": { "id": "BatchUpdateOneTimeProductOfferStatesRequest", "description": "Request message for BatchUpdateOneTimeProductOfferStates.", "properties": { "requests": { "items": { "$ref": "UpdateOneTimeProductOfferStateRequest" }, "description": "Required. The update request list of up to 100 elements. All requests must update different offers.", "type": "array" } }, "type": "object" }, "ScreenDensityTargeting": { "description": "Targeting based on screen density.", "properties": { "alternatives": { "description": "Targeting of other sibling directories that were in the Bundle. For main splits this is targeting of other main splits.", "type": "array", "items": { "$ref": "ScreenDensity" } }, "value": { "description": "Value of a screen density.", "items": { "$ref": "ScreenDensity" }, "type": "array" } }, "id": "ScreenDensityTargeting", "type": "object" }, "CancellationEvent": { "type": "object", "id": "CancellationEvent", "properties": { "eventTime": { "type": "string", "description": "The time when the order was canceled.", "format": "google-datetime" } }, "description": "Details of when the order was canceled." }, "SubscriptionPurchaseLineItem": { "description": "Item-level info for a subscription purchase.", "properties": { "offerPhase": { "description": "Current offer phase details for this item.", "$ref": "OfferPhase" }, "productId": { "description": "The purchased product ID (for example, 'monthly001').", "type": "string" }, "deferredItemRemoval": { "description": "Information for deferred item removal.", "$ref": "DeferredItemRemoval" }, "autoRenewingPlan": { "$ref": "AutoRenewingPlan", "description": "The item is auto renewing." }, "prepaidPlan": { "description": "The item is prepaid.", "$ref": "PrepaidPlan" }, "latestSuccessfulOrderId": { "type": "string", "description": "The order id of the latest successful order associated with this item. Not present if the item is not owned by the user yet (e.g. the item being deferred replaced to)." }, "expiryTime": { "description": "Time at which the subscription expired or will expire unless the access is extended (ex. renews).", "type": "string", "format": "google-datetime" }, "offerDetails": { "$ref": "OfferDetails", "description": "The offer details for this item." }, "itemReplacement": { "description": "Details of the item being replaced. This field is only populated if this item replaced another item in a previous subscription and is only available for 60 days after the purchase time.", "$ref": "ItemReplacement" }, "deferredItemReplacement": { "description": "Information for deferred item replacement.", "$ref": "DeferredItemReplacement" }, "signupPromotion": { "$ref": "SignupPromotion", "description": "Promotion details about this item. Only set if a promotion was applied during signup." } }, "id": "SubscriptionPurchaseLineItem", "type": "object" }, "ApkTargeting": { "description": "Represents a set of apk-level targetings.", "type": "object", "id": "ApkTargeting", "properties": { "sdkVersionTargeting": { "description": "The sdk version that the apk targets", "$ref": "SdkVersionTargeting" }, "textureCompressionFormatTargeting": { "description": "Texture-compression-format-level targeting", "$ref": "TextureCompressionFormatTargeting" }, "screenDensityTargeting": { "description": "The screen density that this apk supports.", "$ref": "ScreenDensityTargeting" }, "abiTargeting": { "description": "The abi that the apk targets", "$ref": "AbiTargeting" }, "multiAbiTargeting": { "$ref": "MultiAbiTargeting", "description": "Multi-api-level targeting." }, "languageTargeting": { "$ref": "LanguageTargeting", "description": "The language that the apk targets" } } }, "BatchGetOrdersResponse": { "id": "BatchGetOrdersResponse", "type": "object", "description": "Response for the orders.batchGet API.", "properties": { "orders": { "type": "array", "description": "Details for the requested order IDs.", "items": { "$ref": "Order" } } } }, "ApksAddExternallyHostedRequest": { "type": "object", "description": "Request to create a new externally hosted APK.", "id": "ApksAddExternallyHostedRequest", "properties": { "externallyHostedApk": { "description": "The definition of the externally-hosted APK and where it is located.", "$ref": "ExternallyHostedApk" } } }, "AddTargetingResponse": { "properties": {}, "type": "object", "description": "Response message for AddTargeting.", "id": "AddTargetingResponse" }, "PriceStepUpConsentDetails": { "properties": { "state": { "enum": [ "CONSENT_STATE_UNSPECIFIED", "PENDING", "CONFIRMED", "COMPLETED" ], "enumDescriptions": [ "Unspecified consent state.", "The user has not yet provided consent.", "The user has consented, and the new price is waiting to take effect.", "The user has consented, and the new price has taken effect." ], "readOnly": true, "type": "string", "description": "Output only. The state of the price step-up consent." }, "consentDeadlineTime": { "description": "The deadline by which the user must provide consent. If consent is not provided by this time, the subscription will be canceled.", "type": "string", "format": "google-datetime" }, "newPrice": { "description": "The new price which requires user consent.", "$ref": "Money" } }, "id": "PriceStepUpConsentDetails", "description": "Information related to a price step-up that requires user consent.", "type": "object" }, "AllUsers": { "type": "object", "description": "Object representation to describe all set of users.", "id": "AllUsers", "properties": { "isAllUsersRequested": { "type": "boolean", "description": "Required. Set to true if all set of users are needed." } } }, "ExternalAccountIds": { "id": "ExternalAccountIds", "type": "object", "properties": { "obfuscatedAccountId": { "description": "Optional. Specifies an optional obfuscated string that is uniquely associated with the purchaser's user account in your app. If you pass this value, Google Play can use it to detect irregular activity. Do not use this field to store any Personally Identifiable Information (PII) such as emails in cleartext. Attempting to store PII in this field will result in purchases being blocked. Google Play recommends that you use either encryption or a one-way hash to generate an obfuscated identifier to send to Google Play. This identifier is limited to 64 characters. This field can only be set for resubscription purchases. See https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid to set this field for purchases made using the standard in-app billing flow.", "type": "string" }, "obfuscatedProfileId": { "type": "string", "description": "Optional. Specifies an optional obfuscated string that is uniquely associated with the purchaser's user profile in your app. If you pass this value, Google Play can use it to detect irregular activity. Do not use this field to store any Personally Identifiable Information (PII) such as emails in cleartext. Attempting to store PII in this field will result in purchases being blocked. Google Play recommends that you use either encryption or a one-way hash to generate an obfuscated identifier to send to Google Play. This identifier is limited to 64 characters. This field can only be set for resubscription purchases. See https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid to set this field for purchases made using the standard in-app billing flow." } }, "description": "User account identifier in your app." }, "SignupPromotion": { "properties": { "vanityCode": { "description": "A vanity code was applied.", "$ref": "VanityCode" }, "oneTimeCode": { "$ref": "OneTimeCode", "description": "A one-time code was applied." } }, "id": "SignupPromotion", "description": "The promotion applied on this item when purchased.", "type": "object" }, "GeneratedAssetPackSlice": { "id": "GeneratedAssetPackSlice", "type": "object", "description": "Download metadata for an asset pack slice.", "properties": { "moduleName": { "description": "Name of the module that this asset slice belongs to.", "type": "string" }, "version": { "type": "string", "description": "Asset module version.", "format": "int64" }, "downloadId": { "type": "string", "description": "Download ID, which uniquely identifies the APK to download. Should be supplied to `generatedapks.download` method." }, "sliceId": { "type": "string", "description": "Asset slice ID." } } }, "UserCountriesTargeting": { "type": "object", "id": "UserCountriesTargeting", "properties": { "countryCodes": { "type": "array", "items": { "type": "string" }, "description": "List of country codes in the two-letter CLDR territory format." }, "exclude": { "type": "boolean", "description": "Indicates if the list above is exclusive." } }, "description": "Describes an inclusive/exclusive list of country codes that module targets." }, "ArtifactSummary": { "properties": { "versionCode": { "type": "integer", "description": "Artifact's version code", "format": "int32" } }, "id": "ArtifactSummary", "type": "object", "description": "Summary of an artifact." }, "Variant": { "type": "object", "properties": { "options": { "description": "Optional. Options applied to the generated APK.", "$ref": "SystemApkOptions" }, "deviceSpec": { "description": "The device spec used to generate the APK.", "$ref": "DeviceSpec" }, "variantId": { "description": "Output only. The ID of a previously created system APK variant.", "readOnly": true, "type": "integer", "format": "uint32" } }, "id": "Variant", "description": "APK that is suitable for inclusion in a system image. The resource of SystemApksService." }, "DeployAppRecoveryResponse": { "properties": {}, "id": "DeployAppRecoveryResponse", "description": "Response message for DeployAppRecovery.", "type": "object" }, "OfferPhaseDetails": { "description": "Details of a pricing phase for the entitlement period funded by this order.", "properties": { "baseDetails": { "description": "The order funds a base price period.", "$ref": "BaseDetails" }, "prorationPeriodDetails": { "$ref": "ProrationPeriodDetails", "description": "The order funds a proration period." }, "introductoryPriceDetails": { "$ref": "IntroductoryPriceDetails", "description": "The order funds an introductory pricing period." }, "freeTrialDetails": { "description": "The order funds a free trial period.", "$ref": "FreeTrialDetails" } }, "type": "object", "id": "OfferPhaseDetails" }, "OnHoldStateContext": { "id": "OnHoldStateContext", "type": "object", "properties": { "renewalDeclined": { "description": "Optional. The payment for the renewal was declined.", "$ref": "RenewalDeclinedContext" } }, "description": "Additional context around subscriptions in ON_HOLD state." }, "TrackCountryAvailability": { "description": "Resource for per-track country availability information.", "id": "TrackCountryAvailability", "properties": { "countries": { "items": { "$ref": "TrackTargetedCountry" }, "description": "A list of one or more countries where artifacts in this track are available. This list includes all countries that are targeted by the track, even if only specific carriers are targeted in that country.", "type": "array" }, "restOfWorld": { "type": "boolean", "description": "Whether artifacts in this track are available to \"rest of the world\" countries." }, "syncWithProduction": { "type": "boolean", "description": "Whether this track's availability is synced with the default production track. See https://support.google.com/googleplay/android-developer/answer/7550024 for more information on syncing country availability with production. Note that if this is true, the returned \"countries\" and \"rest_of_world\" fields will reflect the values for the default production track." } }, "type": "object" }, "AcquisitionTargetingRule": { "type": "object", "description": "Represents a targeting rule of the form: User never had {scope} before.", "id": "AcquisitionTargetingRule", "properties": { "scope": { "description": "Required. The scope of subscriptions this rule considers. Only allows \"this subscription\" and \"any subscription in app\".", "$ref": "TargetingRuleScope" } } }, "OneTimeProductPreOrderOffer": { "description": "Configuration specific to pre-order offers.", "properties": { "releaseTime": { "description": "Required. Time on which the product associated with the pre-order will be released and the pre-order orders fulfilled.", "type": "string", "format": "google-datetime" }, "endTime": { "format": "google-datetime", "description": "Required. Time when the pre-order will stop being available.", "type": "string" }, "priceChangeBehavior": { "type": "string", "enum": [ "PRE_ORDER_PRICE_CHANGE_BEHAVIOR_UNSPECIFIED", "PRE_ORDER_PRICE_CHANGE_BEHAVIOR_TWO_POINT_LOWEST", "PRE_ORDER_PRICE_CHANGE_BEHAVIOR_NEW_ORDERS_ONLY" ], "description": "Required. Immutable. Specifies how price changes affect pre-existing pre-orders.", "enumDescriptions": [ "Unspecified price change behavior. Must not be used.", "The buyer gets charged the minimum between the initial price at the time of pre-order and the final offer price on the release date.", "The buyer gets the same price as the one they pre-ordered, regardless of any price changes that may have happened after the pre-order." ] }, "startTime": { "format": "google-datetime", "description": "Required. Time when the pre-order will start being available.", "type": "string" } }, "id": "OneTimeProductPreOrderOffer", "type": "object" }, "ExpansionFile": { "type": "object", "properties": { "fileSize": { "description": "If set, this field indicates that this APK has an expansion file uploaded to it: this APK does not reference another APK's expansion file. The field's value is the size of the uploaded expansion file in bytes.", "format": "int64", "type": "string" }, "referencesVersion": { "type": "integer", "format": "int32", "description": "If set, this APK's expansion file references another APK's expansion file. The file_size field will not be set." } }, "description": "An expansion file. The resource for ExpansionFilesService.", "id": "ExpansionFile" }, "OneTimeProductPurchaseOptionNewRegionsConfig": { "id": "OneTimeProductPurchaseOptionNewRegionsConfig", "properties": { "eurPrice": { "$ref": "Money", "description": "Required. Price in EUR to use for any new regions Play may launch in." }, "usdPrice": { "description": "Required. Price in USD to use for any new regions Play may launch in.", "$ref": "Money" }, "availability": { "description": "Required. The regional availability for the new regions config. When set to AVAILABLE, the pricing information will be used for any new regions Play may launch in the future.", "type": "string", "enum": [ "AVAILABILITY_UNSPECIFIED", "AVAILABLE", "NO_LONGER_AVAILABLE" ], "enumDescriptions": [ "Unspecified availability. Must not be used.", "The config will be used for any new regions Play may launch in the future.", "The config is not available anymore and will not be used for any new regions Play may launch in the future. This value can only be used if the availability was previously set as AVAILABLE." ] } }, "type": "object", "description": "Pricing information for any new regions Play may launch in the future." }, "LocalizedStoreListing": { "id": "LocalizedStoreListing", "description": "A localized store listings of the app.", "properties": { "tabletRegularScreenshots": { "description": "The regular tablet screenshots of the app.", "$ref": "ScreenshotSet" }, "tabletSmallScreenshots": { "description": "The small tablet screenshots of the app.", "$ref": "ScreenshotSet" }, "video": { "$ref": "VideoAsset", "description": "The video of the app." }, "featureGraphic": { "description": "The feature graphic of the app.", "$ref": "ImageAsset" }, "appName": { "description": "The name of the app in this localization.", "type": "string" }, "icon": { "description": "The icon of the app.", "$ref": "ImageAsset" }, "languageCode": { "description": "The BCP-47 language code for this localization.", "type": "string" }, "shortDescription": { "description": "A short description of the app in this localization.", "type": "string" }, "fullDescription": { "description": "A longer description of the app in this localization.", "type": "string" }, "phoneScreenshots": { "description": "The phone screenshots of the app.", "$ref": "ScreenshotSet" } }, "type": "object" }, "ImagesUploadResponse": { "id": "ImagesUploadResponse", "properties": { "image": { "description": "The uploaded image.", "$ref": "Image" } }, "description": "Response for uploading an image.", "type": "object" }, "GeneratedApksPerSigningKey": { "id": "GeneratedApksPerSigningKey", "description": "Download metadata for split, standalone and universal APKs, as well as asset pack slices, signed with a given key.", "type": "object", "properties": { "generatedSplitApks": { "items": { "$ref": "GeneratedSplitApk" }, "description": "List of generated split APKs, signed with a key corresponding to certificate_sha256_hash.", "type": "array" }, "unprotectedGeneratedSplitApks": { "type": "array", "items": { "$ref": "GeneratedSplitApk" }, "description": "List of generated split APKs without automatic protection, signed with a key corresponding to certificate_sha256_hash. This field is only present if the app uses automatic protection. In this case, `generated_split_apks` contains APKs with automatic protection enabled, whereas this field contains APKs without automatic protection." }, "generatedStandaloneApks": { "items": { "$ref": "GeneratedStandaloneApk" }, "description": "List of generated standalone APKs, signed with a key corresponding to certificate_sha256_hash.", "type": "array" }, "generatedUniversalApk": { "description": "Generated universal APK, signed with a key corresponding to certificate_sha256_hash. This field is not set if no universal APK was generated for this signing key.", "$ref": "GeneratedUniversalApk" }, "unprotectedGeneratedStandaloneApks": { "description": "List of generated standalone APKs without automatic protection, signed with a key corresponding to certificate_sha256_hash. This field is only present if the app uses automatic protection. In this case, `generated_standalone_apks` contains APKs with automatic protection enabled, whereas this field contains APKs without automatic protection.", "type": "array", "items": { "$ref": "GeneratedStandaloneApk" } }, "certificateSha256Hash": { "description": "SHA256 hash of the APK signing public key certificate.", "type": "string" }, "targetingInfo": { "$ref": "TargetingInfo", "description": "Contains targeting information about the generated apks." }, "generatedAssetPackSlices": { "items": { "$ref": "GeneratedAssetPackSlice" }, "description": "List of asset pack slices which will be served for this app bundle, signed with a key corresponding to certificate_sha256_hash.", "type": "array" }, "generatedRecoveryModules": { "items": { "$ref": "GeneratedRecoveryApk" }, "type": "array", "description": "Generated recovery apks for recovery actions signed with a key corresponding to certificate_sha256_hash. This includes all generated recovery APKs, also those in draft or cancelled state. This field is not set if no recovery actions were created for this signing key." } } }, "ActivatePurchaseOptionRequest": { "properties": { "latencyTolerance": { "description": "Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.", "enumDescriptions": [ "Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.", "The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.", "The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods." ], "type": "string", "enum": [ "PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT" ] }, "packageName": { "description": "Required. The parent app (package name) of the purchase option to activate.", "type": "string" }, "productId": { "description": "Required. The parent one-time product (ID) of the purchase option to activate.", "type": "string" }, "purchaseOptionId": { "type": "string", "description": "Required. The purchase option ID of the purchase option to activate." } }, "type": "object", "description": "Request message for UpdatePurchaseOptionState.", "id": "ActivatePurchaseOptionRequest" }, "CreateDraftAppRecoveryRequest": { "description": "Request message for CreateDraftAppRecovery.", "type": "object", "properties": { "targeting": { "$ref": "Targeting", "description": "Specifies targeting criteria for the recovery action such as regions, android sdk versions, app versions etc." }, "remoteInAppUpdate": { "$ref": "RemoteInAppUpdate", "description": "Action type is remote in-app update. As a consequence of this action, a downloadable recovery module is also created for testing purposes." } }, "id": "CreateDraftAppRecoveryRequest" }, "DeviceTierConfig": { "id": "DeviceTierConfig", "type": "object", "properties": { "deviceTierSet": { "description": "Definition of the set of device tiers for the app.", "$ref": "DeviceTierSet" }, "deviceGroups": { "type": "array", "items": { "$ref": "DeviceGroup" }, "description": "Definition of device groups for the app." }, "userCountrySets": { "items": { "$ref": "UserCountrySet" }, "description": "Definition of user country sets for the app.", "type": "array" }, "deviceTierConfigId": { "readOnly": true, "type": "string", "format": "int64", "description": "Output only. The device tier config ID." } }, "description": "Configuration describing device targeting criteria for the content of an app." }, "CancelOneTimeProductOfferRequest": { "type": "object", "properties": { "productId": { "description": "Required. The parent one-time product (ID) of the offer to cancel.", "type": "string" }, "packageName": { "description": "Required. The parent app (package name) of the offer to cancel.", "type": "string" }, "purchaseOptionId": { "description": "Required. The parent purchase option (ID) of the offer to cancel.", "type": "string" }, "latencyTolerance": { "description": "Optional. The latency tolerance for the propagation of this update. Defaults to latency-sensitive.", "type": "string", "enum": [ "PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT" ], "enumDescriptions": [ "Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.", "The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.", "The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods." ] }, "offerId": { "description": "Required. The offer ID of the offer to cancel.", "type": "string" } }, "description": "Request message for CancelOneTimeProductOffer.", "id": "CancelOneTimeProductOfferRequest" }, "ProcessedEvent": { "id": "ProcessedEvent", "description": "Details of when the order was processed.", "properties": { "eventTime": { "description": "The time when the order was processed.", "type": "string", "format": "google-datetime" } }, "type": "object" }, "GeneratedRecoveryApk": { "type": "object", "properties": { "downloadId": { "description": "Download ID, which uniquely identifies the APK to download. Should be supplied to `generatedapks.download` method.", "type": "string" }, "recoveryId": { "type": "string", "format": "int64", "description": "ID of the recovery action." }, "recoveryStatus": { "enumDescriptions": [ "RecoveryStatus is unspecified.", "The app recovery action has not been canceled since it has been created.", "The recovery action has been canceled. The action cannot be resumed.", "The recovery action is in the draft state and has not yet been deployed to users.", "The recovery action is generating recovery apks.", "The app recovery action generation has failed." ], "type": "string", "enum": [ "RECOVERY_STATUS_UNSPECIFIED", "RECOVERY_STATUS_ACTIVE", "RECOVERY_STATUS_CANCELED", "RECOVERY_STATUS_DRAFT", "RECOVERY_STATUS_GENERATION_IN_PROGRESS", "RECOVERY_STATUS_GENERATION_FAILED" ], "description": "The status of the recovery action corresponding to the recovery apk." }, "moduleName": { "type": "string", "description": "Name of the module which recovery apk belongs to." } }, "description": "Download metadata for an app recovery module.", "id": "GeneratedRecoveryApk" }, "ReviewsReplyRequest": { "description": "Request to reply to review or update existing reply.", "properties": { "replyText": { "description": "The text to set as the reply. Replies of more than approximately 350 characters will be rejected. HTML tags will be stripped.", "type": "string" } }, "type": "object", "id": "ReviewsReplyRequest" }, "Track": { "id": "Track", "properties": { "releases": { "type": "array", "items": { "$ref": "TrackRelease" }, "description": "In a read request, represents all active releases in the track. In an update request, represents desired changes." }, "track": { "description": "Identifier of the track. Form factor tracks have a special prefix as an identifier, for example `wear:production`, `automotive:production`. [More on track name](https://developers.google.com/android-publisher/tracks#ff-track-name)", "type": "string" } }, "type": "object", "description": "A track configuration. The resource for TracksService." }, "OneTimeProductRentPurchaseOption": { "id": "OneTimeProductRentPurchaseOption", "type": "object", "properties": { "rentalPeriod": { "description": "Required. The amount of time a user has the entitlement for. Starts at purchase flow completion. Specified in ISO 8601 format.", "type": "string" }, "expirationPeriod": { "type": "string", "description": "Optional. The amount of time the user has after starting consuming the entitlement before it is revoked. Specified in ISO 8601 format." } }, "description": "A purchase option that can be rented." }, "VoidedPurchase": { "type": "object", "description": "A VoidedPurchase resource indicates a purchase that was either canceled/refunded/charged-back.", "id": "VoidedPurchase", "properties": { "orderId": { "description": "The order id which uniquely identifies a one-time purchase, subscription purchase, or subscription renewal.", "type": "string" }, "purchaseToken": { "type": "string", "description": "The token which uniquely identifies a one-time purchase or subscription. To uniquely identify subscription renewals use order_id (available starting from version 3 of the API)." }, "purchaseTimeMillis": { "type": "string", "format": "int64", "description": "The time at which the purchase was made, in milliseconds since the epoch (Jan 1, 1970)." }, "voidedQuantity": { "format": "int32", "description": "The voided quantity as the result of a quantity-based partial refund. Voided purchases of quantity-based partial refunds may only be returned when includeQuantityBasedPartialRefund is set to true.", "type": "integer" }, "voidedSource": { "description": "The initiator of voided purchase, possible values are: 0. User 1. Developer 2. Google", "type": "integer", "format": "int32" }, "kind": { "type": "string", "description": "This kind represents a voided purchase object in the androidpublisher service." }, "voidedTimeMillis": { "format": "int64", "type": "string", "description": "The time at which the purchase was canceled/refunded/charged-back, in milliseconds since the epoch (Jan 1, 1970)." }, "voidedReason": { "description": "The reason why the purchase was voided, possible values are: 0. Other 1. Remorse 2. Not_received 3. Defective 4. Accidental_purchase 5. Fraud 6. Friendly_fraud 7. Chargeback 8. Unacknowledged_purchase", "format": "int32", "type": "integer" } } }, "SubscriptionOfferPhase": { "type": "object", "id": "SubscriptionOfferPhase", "description": "A single phase of a subscription offer.", "properties": { "otherRegionsConfig": { "$ref": "OtherRegionsSubscriptionOfferPhaseConfig", "description": "Pricing information for any new locations Play may launch in." }, "duration": { "description": "Required. The duration of a single recurrence of this phase. Specified in ISO 8601 format.", "type": "string" }, "regionalConfigs": { "items": { "$ref": "RegionalSubscriptionOfferPhaseConfig" }, "description": "Required. The region-specific configuration of this offer phase. This list must contain exactly one entry for each region for which the subscription offer has a regional config.", "type": "array" }, "recurrenceCount": { "format": "int32", "type": "integer", "description": "Required. The number of times this phase repeats. If this offer phase is not free, each recurrence charges the user the price of this offer phase." } } }, "RotatedCloudKmsKey": { "description": "Message representing rotated Cloud KMS key. Consists of the Cloud KMS key and its associated proof of rotation.", "id": "RotatedCloudKmsKey", "properties": { "signingCertificateLineage": { "type": "string", "description": "Required. Proof-of-rotation. See [creating signing certificate lineages](https://developer.android.com/studio/command-line/apksigner#rotate_signing_keys_2).", "format": "byte" }, "cloudKmsKeyAndCert": { "$ref": "CloudKmsKeyAndCert", "description": "Required. Cloud KMS key and the certificate associated with the key." } }, "type": "object" }, "RefundEvent": { "id": "RefundEvent", "description": "Details of when the order was fully refunded.", "type": "object", "properties": { "refundReason": { "description": "The reason the order was refunded.", "type": "string", "enum": [ "REFUND_REASON_UNSPECIFIED", "OTHER", "CHARGEBACK" ], "enumDescriptions": [ "Refund reason unspecified. This value is not used.", "The order was refunded for a reason other than the listed reasons here.", "The order was charged back." ] }, "refundDetails": { "$ref": "RefundDetails", "description": "Details for the full refund." }, "eventTime": { "format": "google-datetime", "description": "The time when the order was fully refunded.", "type": "string" } } }, "DeferralContext": { "description": "Deferral context of the purchases.subscriptionsv2.defer API.", "properties": { "etag": { "description": "Required. The API will fail if the etag does not match the latest etag for this subscription. The etag is retrieved from purchases.subscriptionsv2.get: https://developers.google.com/android-publisher/api-ref/rest/v3/purchases.subscriptionsv2/get", "type": "string" }, "validateOnly": { "type": "boolean", "description": "If set to \"true\", the request is a dry run to validate the effect of Defer, the subscription would not be impacted." }, "deferDuration": { "type": "string", "description": "Required. The duration by which all subscription items should be deferred.", "format": "google-duration" } }, "id": "DeferralContext", "type": "object" }, "SystemApkOptions": { "properties": { "rotated": { "description": "Whether to use the rotated key for signing the system APK.", "type": "boolean" }, "uncompressedDexFiles": { "type": "boolean", "description": "Whether system APK was generated with uncompressed dex files." }, "uncompressedNativeLibraries": { "description": "Whether system APK was generated with uncompressed native libraries.", "type": "boolean" } }, "id": "SystemApkOptions", "description": "Options for system APKs.", "type": "object" }, "RemoteInAppUpdate": { "description": "Object representation for Remote in-app update action type.", "type": "object", "properties": { "isRemoteInAppUpdateRequested": { "description": "Required. Set to true if Remote In-App Update action type is needed.", "type": "boolean" } }, "id": "RemoteInAppUpdate" }, "MultiAbiTargeting": { "type": "object", "description": "Targeting based on multiple abis.", "id": "MultiAbiTargeting", "properties": { "alternatives": { "description": "Targeting of other sibling directories that were in the Bundle. For main splits this is targeting of other main splits.", "items": { "$ref": "MultiAbi" }, "type": "array" }, "value": { "type": "array", "description": "Value of a multi abi.", "items": { "$ref": "MultiAbi" } } } }, "BatchGetSubscriptionOffersRequest": { "type": "object", "id": "BatchGetSubscriptionOffersRequest", "description": "Request message for BatchGetSubscriptionOffers endpoint.", "properties": { "requests": { "type": "array", "description": "Required. A list of update requests of up to 100 elements. All requests must update different subscriptions.", "items": { "$ref": "GetSubscriptionOfferRequest" } } } }, "OneTimeProductGameRewardOffer": { "description": "Configuration specific to game reward offers.", "properties": { "redemptionLimit": { "type": "string", "description": "Optional. The number of times this offer can be redeemed. If unset or set to 0, allows for unlimited offer redemptions. Otherwise must be a number between 1 and 50 inclusive.", "format": "int64" } }, "id": "OneTimeProductGameRewardOffer", "type": "object" }, "CountryTargeting": { "type": "object", "description": "Country targeting specification.", "properties": { "includeRestOfWorld": { "description": "Include \"rest of world\" as well as explicitly targeted countries.", "type": "boolean" }, "countries": { "type": "array", "description": "Countries to target, specified as two letter [CLDR codes](https://unicode.org/cldr/charts/latest/supplemental/territory_containment_un_m_49.html).", "items": { "type": "string" } } }, "id": "CountryTargeting" }, "OtherRegionsBasePlanConfig": { "type": "object", "id": "OtherRegionsBasePlanConfig", "properties": { "eurPrice": { "description": "Required. Price in EUR to use for any new locations Play may launch in.", "$ref": "Money" }, "newSubscriberAvailability": { "type": "boolean", "description": "Whether the base plan is available for new subscribers in any new locations Play may launch in. If not specified, this will default to false." }, "usdPrice": { "$ref": "Money", "description": "Required. Price in USD to use for any new locations Play may launch in." } }, "description": "Pricing information for any new locations Play may launch in." }, "SocSelector": { "description": "Defines a SOC selector for a device. This will match any device whose SoC (System on Chip) matches all fields in the selector.", "properties": { "socModel": { "type": "string", "description": "The model of the SoC." }, "socMake": { "description": "The manufacturer of the SoC.", "type": "string" } }, "type": "object", "id": "SocSelector" }, "ListingsListResponse": { "type": "object", "id": "ListingsListResponse", "description": "Response listing all localized listings.", "properties": { "kind": { "type": "string", "description": "The kind of this response (\"androidpublisher#listingsListResponse\")." }, "listings": { "description": "All localized listings.", "type": "array", "items": { "$ref": "Listing" } } } }, "RegionalTaxConfig": { "id": "RegionalTaxConfig", "type": "object", "description": "Details about taxation in a given geographical region.", "properties": { "regionCode": { "type": "string", "description": "Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. \"US\"." }, "taxTier": { "description": "Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498).", "type": "string", "enum": [ "TAX_TIER_UNSPECIFIED", "TAX_TIER_BOOKS_1", "TAX_TIER_NEWS_1", "TAX_TIER_NEWS_2", "TAX_TIER_MUSIC_OR_AUDIO_1", "TAX_TIER_LIVE_OR_BROADCAST_1" ], "enumDescriptions": [ "", "", "", "", "", "" ] }, "streamingTaxType": { "description": "To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax).", "type": "string", "enum": [ "STREAMING_TAX_TYPE_UNSPECIFIED", "STREAMING_TAX_TYPE_TELCO_VIDEO_RENTAL", "STREAMING_TAX_TYPE_TELCO_VIDEO_SALES", "STREAMING_TAX_TYPE_TELCO_VIDEO_MULTI_CHANNEL", "STREAMING_TAX_TYPE_TELCO_AUDIO_RENTAL", "STREAMING_TAX_TYPE_TELCO_AUDIO_SALES", "STREAMING_TAX_TYPE_TELCO_AUDIO_MULTI_CHANNEL" ], "enumDescriptions": [ "No telecommunications tax collected.", "US-specific telecommunications tax tier for video streaming, on demand, rentals / subscriptions / pay-per-view.", "US-specific telecommunications tax tier for video streaming of pre-recorded content like movies, tv shows.", "US-specific telecommunications tax tier for video streaming of multi-channel programming.", "US-specific telecommunications tax tier for audio streaming, rental / subscription.", "US-specific telecommunications tax tier for audio streaming, sale / permanent download.", "US-specific telecommunications tax tier for multi channel audio streaming like radio." ] }, "eligibleForStreamingServiceTaxRate": { "type": "boolean", "description": "You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in the United States." } } }, "LineItem": { "id": "LineItem", "properties": { "subscriptionDetails": { "description": "Details of a subscription purchase.", "$ref": "SubscriptionDetails" }, "productTitle": { "type": "string", "description": "Developer-specified name of the product. Displayed in buyer's locale. Example: coins, monthly subscription, etc." }, "tax": { "description": "The tax paid for this line item.", "$ref": "Money" }, "total": { "$ref": "Money", "description": "The total amount paid by the user for this line item, taking into account discounts and tax." }, "oneTimePurchaseDetails": { "$ref": "OneTimePurchaseDetails", "description": "Details of a one-time purchase." }, "listingPrice": { "$ref": "Money", "description": "Item's listed price on Play Store, this may or may not include tax. Excludes Google-funded discounts only." }, "paidAppDetails": { "description": "Details of a paid app purchase.", "$ref": "PaidAppDetails" }, "productId": { "type": "string", "description": "The purchased product ID or in-app SKU (for example, 'monthly001' or 'com.some.thing.inapp1')." } }, "description": "Details of a line item.", "type": "object" }, "UserComment": { "properties": { "originalText": { "description": "Untranslated text of the review, where the review was translated. If the review was not translated this is left blank.", "type": "string" }, "thumbsUpCount": { "format": "int32", "description": "Number of users who have given this review a thumbs up.", "type": "integer" }, "appVersionCode": { "format": "int32", "type": "integer", "description": "Integer version code of the app as installed at the time the review was written. May be absent." }, "lastModified": { "$ref": "Timestamp", "description": "The last time at which this comment was updated." }, "thumbsDownCount": { "type": "integer", "format": "int32", "description": "Number of users who have given this review a thumbs down." }, "deviceMetadata": { "$ref": "DeviceMetadata", "description": "Information about the characteristics of the user's device." }, "device": { "description": "Codename for the reviewer's device, e.g. klte, flounder. May be absent.", "type": "string" }, "starRating": { "description": "The star rating associated with the review, from 1 to 5.", "type": "integer", "format": "int32" }, "reviewerLanguage": { "description": "Language code for the reviewer. This is taken from the device settings so is not guaranteed to match the language the review is written in. May be absent.", "type": "string" }, "text": { "description": "The content of the comment, i.e. review body. In some cases users have been able to write a review with separate title and body; in those cases the title and body are concatenated and separated by a tab character.", "type": "string" }, "androidOsVersion": { "format": "int32", "type": "integer", "description": "Integer Android SDK version of the user's device at the time the review was written, e.g. 23 is Marshmallow. May be absent." }, "appVersionName": { "description": "String version name of the app as installed at the time the review was written. May be absent.", "type": "string" } }, "id": "UserComment", "type": "object", "description": "User entry from conversation between user and developer." }, "UpdateAppStoreHostedAppRequest": { "type": "object", "id": "UpdateAppStoreHostedAppRequest", "description": "Request to update an app record for an app store hosted app.", "properties": { "appDetails": { "description": "Required. General developer details for the app.", "$ref": "AppStoreAppDetails" }, "activeLocalizedStoreListings": { "items": { "$ref": "AppStoreAppStoreListing" }, "description": "Required. Localized store listings details of the update.", "type": "array" }, "activeApks": { "$ref": "AppStoreAppActiveApks", "description": "Required. Actively distributed APKs of the app." }, "policyDeclarations": { "description": "Required. Policy declarations provided for the app.", "items": { "$ref": "AppStoreAppPolicyDeclaration" }, "type": "array" }, "packageName": { "description": "Required. Package name of the app.", "type": "string" } } }, "ProductLineItem": { "id": "ProductLineItem", "description": "Contains item-level info for a ProductPurchaseV2.", "type": "object", "properties": { "productId": { "type": "string", "description": "The purchased product ID (for example, 'monthly001')." }, "productOfferDetails": { "$ref": "ProductOfferDetails", "description": "The offer details for this item." } } }, "ApksAddExternallyHostedResponse": { "description": "Response for creating a new externally hosted APK.", "id": "ApksAddExternallyHostedResponse", "type": "object", "properties": { "externallyHostedApk": { "description": "The definition of the externally-hosted APK and where it is located.", "$ref": "ExternallyHostedApk" } } }, "BuyerAddress": { "id": "BuyerAddress", "type": "object", "description": "Address information for the customer, for use in tax computation.", "properties": { "buyerCountry": { "type": "string", "description": "Two letter country code based on ISO-3166-1 Alpha-2 (UN country codes)." }, "buyerState": { "type": "string", "description": "Top-level administrative subdivision of the buyer address country. When Google is the Merchant of Record for the order, this information is not included." }, "buyerPostcode": { "type": "string", "description": "Postal code of an address. When Google is the Merchant of Record for the order, this information is not included." } } }, "CreateAppStoreHostedAppResponse": { "type": "object", "properties": {}, "id": "CreateAppStoreHostedAppResponse", "description": "Response for creating a new app record for an app store hosted app." }, "Abi": { "properties": { "alias": { "description": "Alias for an abi.", "type": "string", "enum": [ "UNSPECIFIED_CPU_ARCHITECTURE", "ARMEABI", "ARMEABI_V7A", "ARM64_V8A", "X86", "X86_64", "RISCV64" ], "enumDescriptions": [ "Unspecified abi.", "ARMEABI abi.", "ARMEABI_V7A abi.", "ARM64_V8A abi.", "X86 abi.", "X86_64 abi.", "RISCV64 abi." ] } }, "type": "object", "id": "Abi", "description": "Represents an Abi." }, "InappproductsBatchGetResponse": { "type": "object", "description": "Response message for BatchGetSubscriptions endpoint.", "properties": { "inappproduct": { "type": "array", "description": "The list of requested in-app products, in the same order as the request.", "items": { "$ref": "InAppProduct" } } }, "id": "InappproductsBatchGetResponse" }, "PolicyBooleanResponse": { "properties": { "value": { "description": "Required. Provided boolean value.", "type": "boolean" } }, "description": "Responses that will only ever be a boolean.", "id": "PolicyBooleanResponse", "type": "object" }, "SystemApksListResponse": { "properties": { "variants": { "items": { "$ref": "Variant" }, "description": "All system APK variants created.", "type": "array" } }, "id": "SystemApksListResponse", "description": "Response to list previously created system APK variants.", "type": "object" }, "AppContactInformation": { "description": "Contact information for the app.", "type": "object", "properties": { "contactEmail": { "type": "string", "description": "The contact email for this app. Always set." }, "phoneNumber": { "type": "string", "description": "The contact phone for this app. Optionally provided by the developer." }, "websiteUrl": { "type": "string", "description": "The contact website url for this app. Optionally provided by the developer." } }, "id": "AppContactInformation" }, "UpdateBasePlanStateRequest": { "properties": { "deactivateBasePlanRequest": { "$ref": "DeactivateBasePlanRequest", "description": "Deactivates a base plan. Once deactivated, the base plan will become unavailable to new subscribers, but existing subscribers will maintain their subscription" }, "activateBasePlanRequest": { "description": "Activates a base plan. Once activated, base plans will be available to new subscribers.", "$ref": "ActivateBasePlanRequest" } }, "description": "Request message to update the state of a subscription base plan.", "id": "UpdateBasePlanStateRequest", "type": "object" }, "DeveloperInitiatedCancellation": { "description": "Information specific to cancellations initiated by developers.", "properties": {}, "id": "DeveloperInitiatedCancellation", "type": "object" }, "PolicyMultipleChoiceResponse": { "properties": { "values": { "description": "Optional. Provided values.", "items": { "type": "string" }, "type": "array" } }, "description": "Any response where multiple options can be chosen from several possibilities.", "id": "PolicyMultipleChoiceResponse", "type": "object" }, "BatchUpdateSubscriptionOffersRequest": { "type": "object", "description": "Request message for BatchUpdateSubscriptionOffers.", "properties": { "requests": { "type": "array", "description": "Required. A list of update requests of up to 100 elements. All requests must update different subscription offers.", "items": { "$ref": "UpdateSubscriptionOfferRequest" } } }, "id": "BatchUpdateSubscriptionOffersRequest" }, "OneTimeExternalTransaction": { "type": "object", "properties": { "externalTransactionToken": { "description": "Input only. Provided during the call to Create. Retrieved from the client when the alternative billing flow is launched.", "type": "string" } }, "id": "OneTimeExternalTransaction", "description": "Represents a one-time transaction." }, "Bundle": { "type": "object", "description": "Information about an app bundle. The resource for BundlesService.", "id": "Bundle", "properties": { "versionCode": { "description": "The version code of the Android App Bundle, as specified in the Android App Bundle's base module APK manifest file.", "type": "integer", "format": "int32" }, "sha256": { "description": "A sha256 hash of the upload payload, encoded as a hex string and matching the output of the sha256sum command.", "type": "string" }, "sha1": { "type": "string", "description": "A sha1 hash of the upload payload, encoded as a hex string and matching the output of the sha1sum command." } } }, "SafetyLabelsUpdateRequest": { "type": "object", "properties": { "safetyLabels": { "description": "Required. Contents of the CSV file containing Data Safety responses. For the format of this file, see the Help Center documentation at https://support.google.com/googleplay/android-developer/answer/10787469?#zippy=%2Cunderstand-the-csv-format To download an up to date template, follow the steps at https://support.google.com/googleplay/android-developer/answer/10787469?#zippy=%2Cexport-to-a-csv-file", "type": "string" } }, "id": "SafetyLabelsUpdateRequest", "description": "Request to update Safety Labels of an app." }, "BundlesListResponse": { "properties": { "bundles": { "items": { "$ref": "Bundle" }, "type": "array", "description": "All app bundles." }, "kind": { "description": "The kind of this response (\"androidpublisher#bundlesListResponse\").", "type": "string" } }, "description": "Response listing all app bundles.", "type": "object", "id": "BundlesListResponse" }, "SubscriptionPurchasesAcknowledgeRequest": { "description": "Request for the purchases.subscriptions.acknowledge API.", "type": "object", "id": "SubscriptionPurchasesAcknowledgeRequest", "properties": { "developerPayload": { "description": "Payload to attach to the purchase.", "type": "string" }, "externalAccountIds": { "description": "Optional. User account identifier in your app.", "$ref": "ExternalAccountIds" } } }, "Image": { "type": "object", "description": "An uploaded image. The resource for ImagesService.", "id": "Image", "properties": { "aiGeneratedState": { "description": "Optional. Whether the image was generated by AI. Attested by the developer.", "type": "string", "enum": [ "aiGeneratedStateUnspecified", "aiGeneratedStateNotAiGenerated", "aiGeneratedStateAiGeneratedDeveloperAttested" ], "enumDescriptions": [ "Catch-all for unrecognized enum values. See go/protodosdonts.", "The content is not generated by AI.", "The content is generated by AI and attested by the developer." ] }, "sha1": { "type": "string", "description": "A sha1 hash of the image." }, "sha256": { "description": "A sha256 hash of the image.", "type": "string" }, "id": { "type": "string", "description": "A unique id representing this image." }, "url": { "description": "A URL that will serve a preview of the image.", "type": "string" } } }, "DeviceFeatureTargeting": { "properties": { "requiredFeature": { "description": "Feature of the device.", "$ref": "DeviceFeature" } }, "id": "DeviceFeatureTargeting", "description": "Targeting for a device feature.", "type": "object" }, "PreorderOfferDetails": { "properties": { "preorderReleaseTime": { "format": "google-datetime", "type": "string", "description": "The time when a preordered item is released for a preorder purchase." } }, "description": "Offer details information related to a preorder line item.", "id": "PreorderOfferDetails", "type": "object" }, "CancelSubscriptionPurchaseResponse": { "type": "object", "description": "Response for the purchases.subscriptionsv2.cancel API.", "properties": {}, "id": "CancelSubscriptionPurchaseResponse" }, "RotateAppSigningKeyRequest": { "id": "RotateAppSigningKeyRequest", "type": "object", "description": "Request to rotate an app's signing key.", "properties": { "keyRotationReason": { "description": "Required. Reason for rotating the app key.", "enumDescriptions": [ "Unspecified key rotation reason. Cannot be used.", "Key is compromised.", "Stronger key is required.", "Same key is used for multiple apps.", "Routine key upgrade.", "Other reason." ], "type": "string", "enum": [ "KEY_ROTATION_REASON_UNSPECIFIED", "COMPROMISED_KEY", "USE_STRONGER_KEY", "USE_SAME_KEY_FOR_MULTIPLE_APPS", "ROUTINE_KEY_UPGRADE", "OTHER" ] }, "rotatedCloudKmsKey": { "$ref": "RotatedCloudKmsKey", "description": "Required. Self-hosted Cloud KMS key." } } }, "BatchDeleteOneTimeProductOffersRequest": { "type": "object", "id": "BatchDeleteOneTimeProductOffersRequest", "properties": { "requests": { "items": { "$ref": "DeleteOneTimeProductOfferRequest" }, "description": "Required. A list of update requests of up to 100 elements. All requests must correspond to different offers.", "type": "array" } }, "description": "Request message for BatchDeleteOneTimeProductOffers." }, "BatchMigrateBasePlanPricesRequest": { "type": "object", "properties": { "requests": { "description": "Required. Up to 100 price migration requests. All requests must update different base plans.", "type": "array", "items": { "$ref": "MigrateBasePlanPricesRequest" } } }, "id": "BatchMigrateBasePlanPricesRequest", "description": "Request message for BatchMigrateBasePlanPrices." }, "ReviewsListResponse": { "properties": { "reviews": { "description": "List of reviews.", "items": { "$ref": "Review" }, "type": "array" }, "tokenPagination": { "$ref": "TokenPagination", "description": "Pagination token, to handle a number of products that is over one page." }, "pageInfo": { "description": "Information about the current page.", "$ref": "PageInfo" } }, "description": "Response listing reviews.", "id": "ReviewsListResponse", "type": "object" }, "TracksListResponse": { "type": "object", "id": "TracksListResponse", "description": "Response listing all tracks.", "properties": { "tracks": { "type": "array", "items": { "$ref": "Track" }, "description": "All tracks (including tracks with no releases)." }, "kind": { "type": "string", "description": "The kind of this response (\"androidpublisher#tracksListResponse\")." } } }, "OneTimeProductOfferRegionalPricingAndAvailabilityConfig": { "type": "object", "id": "OneTimeProductOfferRegionalPricingAndAvailabilityConfig", "properties": { "relativeDiscount": { "description": "The fraction of the purchase option price that the user pays for this offer. For example, if the purchase option price for this region is $12, then a 50% discount would correspond to a price of $6. The discount must be specified as a fraction strictly larger than 0 and strictly smaller than 1. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in this region.", "type": "number", "format": "double" }, "availability": { "type": "string", "enum": [ "AVAILABILITY_UNSPECIFIED", "AVAILABLE", "NO_LONGER_AVAILABLE" ], "description": "Required. The availability for this region.", "enumDescriptions": [ "Unspecified availability. Must not be used.", "The offer is available to users.", "The offer is no longer available to users. This value can only be used if the availability was previously set as AVAILABLE." ] }, "regionCode": { "type": "string", "description": "Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., \"US\"." }, "noOverride": { "description": "The price defined in the purchase option for this region will be used.", "$ref": "OneTimeProductOfferNoPriceOverrideOptions" }, "absoluteDiscount": { "description": "The absolute value of the discount that is subtracted from the purchase option price. It should be between 0 and the purchase option price.", "$ref": "Money" } }, "description": "Regional pricing and availability configuration for a one-time product offer." }, "RegionalProductAgeRatingInfo": { "id": "RegionalProductAgeRatingInfo", "type": "object", "description": "Details about the age rating for a specific geographic region.", "properties": { "productAgeRatingTier": { "type": "string", "enum": [ "PRODUCT_AGE_RATING_TIER_UNKNOWN", "PRODUCT_AGE_RATING_TIER_EVERYONE", "PRODUCT_AGE_RATING_TIER_THIRTEEN_AND_ABOVE", "PRODUCT_AGE_RATING_TIER_SIXTEEN_AND_ABOVE", "PRODUCT_AGE_RATING_TIER_EIGHTEEN_AND_ABOVE" ], "description": "The age rating tier of a product for the given region.", "enumDescriptions": [ "Unknown age rating tier.", "Age rating tier for products that are appropriate for all ages.", "Age rating tier for products that are appropriate for 13 years and above.", "Age rating tier for products that are appropriate for 16 years and above.", "Age rating tier for products that are appropriate for 18 years and above." ] }, "regionCode": { "description": "Region code this configuration applies to, as defined by ISO 3166-2, e.g. \"US\".", "type": "string" } } }, "OrderHistory": { "type": "object", "id": "OrderHistory", "description": "Details about events which modified the order.", "properties": { "cancellationEvent": { "description": "Details of when the order was canceled.", "$ref": "CancellationEvent" }, "partialRefundEvents": { "items": { "$ref": "PartialRefundEvent" }, "description": "Details of the partial refund events for this order.", "type": "array" }, "refundEvent": { "$ref": "RefundEvent", "description": "Details of when the order was fully refunded." }, "processedEvent": { "$ref": "ProcessedEvent", "description": "Details of when the order was processed." } } }, "TargetingUpdate": { "id": "TargetingUpdate", "properties": { "regions": { "description": "Additional regions are targeted by the recovery action.", "$ref": "Regions" }, "allUsers": { "$ref": "AllUsers", "description": "All users are targeted." }, "androidSdks": { "$ref": "AndroidSdks", "description": "Additional android sdk levels are targeted by the recovery action." } }, "description": "Update type for targeting. Note it is always a subset Targeting.", "type": "object" }, "EnrollAppResponse": { "type": "object", "properties": { "signingCertificate": { "description": "The signing certificate hashes for the app. Always set.", "$ref": "CertificateHashes" }, "uploadCertificate": { "description": "The upload certificate hashes for the app. Set iff pem_upload_certificate was set in the request.", "$ref": "CertificateHashes" } }, "description": "Response to enroll an app into Play signing.", "id": "EnrollAppResponse" }, "ListDeviceTierConfigsResponse": { "description": "Response listing existing device tier configs.", "id": "ListDeviceTierConfigsResponse", "type": "object", "properties": { "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "deviceTierConfigs": { "items": { "$ref": "DeviceTierConfig" }, "type": "array", "description": "Device tier configs created by the developer." } } }, "Regions": { "type": "object", "id": "Regions", "description": "Region targeting data for app recovery action targeting.", "properties": { "regionCode": { "items": { "type": "string" }, "description": "Regions targeted by the recovery action. Region codes are ISO 3166 Alpha-2 country codes. For example, US stands for United States of America. See https://www.iso.org/iso-3166-country-codes.html for the complete list of country codes.", "type": "array" } } }, "DeactivateOneTimeProductOfferRequest": { "description": "Request message for DeactivateOneTimeProductOffer.", "properties": { "packageName": { "description": "Required. The parent app (package name) of the offer to deactivate.", "type": "string" }, "offerId": { "description": "Required. The offer ID of the offer to deactivate.", "type": "string" }, "productId": { "description": "Required. The parent one-time product (ID) of the offer to deactivate.", "type": "string" }, "purchaseOptionId": { "type": "string", "description": "Required. The parent purchase option (ID) of the offer to deactivate." }, "latencyTolerance": { "type": "string", "enum": [ "PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT" ], "description": "Optional. The latency tolerance for the propagation of this update. Defaults to latency-sensitive.", "enumDescriptions": [ "Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.", "The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.", "The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods." ] } }, "type": "object", "id": "DeactivateOneTimeProductOfferRequest" }, "RemoteInAppUpdateDataPerBundle": { "type": "object", "id": "RemoteInAppUpdateDataPerBundle", "properties": { "recoveredDeviceCount": { "description": "Total number of devices which have been rescued.", "type": "string", "format": "int64" }, "versionCode": { "format": "int64", "description": "Version Code corresponding to the target bundle.", "type": "string" }, "totalDeviceCount": { "type": "string", "format": "int64", "description": "Total number of devices affected by this recovery action associated with bundle of the app." } }, "description": "Data related to the recovery action at bundle level." }, "SubscriptionOffer": { "id": "SubscriptionOffer", "properties": { "otherRegionsConfig": { "$ref": "OtherRegionsSubscriptionOfferConfig", "description": "The configuration for any new locations Play may launch in the future." }, "offerTags": { "type": "array", "items": { "$ref": "OfferTag" }, "description": "List of up to 20 custom tags specified for this offer, and returned to the app through the billing library." }, "productId": { "type": "string", "description": "Required. Immutable. The ID of the parent subscription this offer belongs to." }, "basePlanId": { "type": "string", "description": "Required. Immutable. The ID of the base plan to which this offer is an extension." }, "targeting": { "description": "The requirements that users need to fulfil to be eligible for this offer. Represents the requirements that Play will evaluate to decide whether an offer should be returned. Developers may further filter these offers themselves.", "$ref": "SubscriptionOfferTargeting" }, "offerId": { "description": "Required. Immutable. Unique ID of this subscription offer. Must be unique within the base plan.", "type": "string" }, "phases": { "description": "Required. The phases of this subscription offer. Must contain at least one and at most two entries. Users will always receive all these phases in the specified order.", "type": "array", "items": { "$ref": "SubscriptionOfferPhase" } }, "regionalConfigs": { "type": "array", "items": { "$ref": "RegionalSubscriptionOfferConfig" }, "description": "Required. The region-specific configuration of this offer. Must contain at least one entry." }, "packageName": { "type": "string", "description": "Required. Immutable. The package name of the app the parent subscription belongs to." }, "state": { "enum": [ "STATE_UNSPECIFIED", "DRAFT", "ACTIVE", "INACTIVE" ], "enumDescriptions": [ "Default value, should never be used.", "The subscription offer is not and has never been available to users.", "The subscription offer is available to new and existing users.", "The subscription offer is not available to new users. Existing users retain access." ], "type": "string", "readOnly": true, "description": "Output only. The current state of this offer. Can be changed using Activate and Deactivate actions. NB: the base plan state supersedes this state, so an active offer may not be available if the base plan is not active." } }, "type": "object", "description": "A single, temporary offer" }, "GeneratedUniversalApk": { "properties": { "downloadId": { "type": "string", "description": "Download ID, which uniquely identifies the APK to download. Should be supplied to `generatedapks.download` method." } }, "type": "object", "description": "Download metadata for a universal APK.", "id": "GeneratedUniversalApk" }, "GeneratedStandaloneApk": { "id": "GeneratedStandaloneApk", "type": "object", "properties": { "variantId": { "type": "integer", "description": "ID of the generated variant.", "format": "int32" }, "downloadId": { "description": "Download ID, which uniquely identifies the APK to download. Should be supplied to `generatedapks.download` method.", "type": "string" } }, "description": "Download metadata for a standalone APK." }, "Targeting": { "description": "Targeting details for a recovery action such as regions, android sdk levels, app versions etc.", "properties": { "allUsers": { "$ref": "AllUsers", "description": "All users are targeted." }, "versionList": { "description": "Target version codes as a list.", "$ref": "AppVersionList" }, "regions": { "description": "Targeting is based on the user account region.", "$ref": "Regions" }, "versionRange": { "$ref": "AppVersionRange", "description": "Target version codes as a range." }, "androidSdks": { "description": "Targeting is based on android api levels of devices.", "$ref": "AndroidSdks" } }, "id": "Targeting", "type": "object" }, "ScreenDensity": { "description": "Represents a screen density.", "id": "ScreenDensity", "type": "object", "properties": { "densityDpi": { "type": "integer", "format": "int32", "description": "Value for density dpi." }, "densityAlias": { "description": "Alias for a screen density.", "type": "string", "enum": [ "DENSITY_UNSPECIFIED", "NODPI", "LDPI", "MDPI", "TVDPI", "HDPI", "XHDPI", "XXHDPI", "XXXHDPI" ], "enumDescriptions": [ "Unspecified screen density.", "NODPI screen density.", "LDPI screen density.", "MDPI screen density.", "TVDPI screen density.", "HDPI screen density.", "XHDPI screen density.", "XXHDPI screen density.", "XXXHDPI screen density." ] } } }, "ItemReplacement": { "description": "Details about a subscription line item that is being replaced.", "type": "object", "id": "ItemReplacement", "properties": { "offerId": { "description": "The offer ID of the subscription line item being replaced, if applicable.", "type": "string" }, "basePlanId": { "type": "string", "description": "The base plan ID of the subscription line item being replaced." }, "replacementMode": { "enumDescriptions": [ "Unspecified replacement mode.", "The new plan will be prorated and credited from the old plan.", "The user will be charged a prorated price for the new plan.", "The new plan will replace the old one without prorating the time.", "The user will be charged the full price for the new plan.", "The old plan will be cancelled and the new plan will be effective after the old one expires.", "The plan will remain unchanged with this replacement." ], "description": "The replacement mode applied during the purchase.", "type": "string", "enum": [ "REPLACEMENT_MODE_UNSPECIFIED", "WITH_TIME_PRORATION", "CHARGE_PRORATED_PRICE", "WITHOUT_PRORATION", "CHARGE_FULL_PRICE", "DEFERRED", "KEEP_EXISTING" ] }, "productId": { "description": "The product ID of the subscription line item being replaced.", "type": "string" } } }, "StandaloneApkMetadata": { "type": "object", "properties": { "fusedModuleName": { "type": "array", "description": "Names of the modules fused in this standalone APK.", "items": { "type": "string" } } }, "description": "Holds data specific to Standalone APKs.", "id": "StandaloneApkMetadata" }, "RecurringExternalTransaction": { "description": "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).", "properties": { "initialExternalTransactionId": { "type": "string", "description": "The external transaction id of the first transaction of this recurring series of transactions. For example, for a subscription this would be the transaction id of the first payment. Required when creating recurring external transactions." }, "otherRecurringProduct": { "$ref": "OtherRecurringProduct", "description": "Details of a recurring external transaction product which doesn't belong to any other specific category." }, "migratedTransactionProgram": { "description": "Input only. Provided during the call to Create. Must only be used when migrating a subscription from manual monthly reporting to automated reporting.", "type": "string", "enum": [ "EXTERNAL_TRANSACTION_PROGRAM_UNSPECIFIED", "USER_CHOICE_BILLING", "ALTERNATIVE_BILLING_ONLY" ], "enumDescriptions": [ "Unspecified transaction program. Not used.", "User choice billing, where a user may choose between Google Play Billing developer-managed billing.", "Alternative billing only, where users may only use developer-manager billing." ] }, "externalSubscription": { "description": "Details of an external subscription.", "$ref": "ExternalSubscription" }, "externalTransactionToken": { "description": "Input only. Provided during the call to Create. Retrieved from the client when the alternative billing flow is launched. Required only for the initial purchase.", "type": "string" } }, "type": "object", "id": "RecurringExternalTransaction" }, "ExternalTransactionAddress": { "properties": { "regionCode": { "description": "Required. Two letter region code based on ISO-3166-1 Alpha-2 (UN region codes).", "type": "string" }, "administrativeArea": { "type": "string", "description": "Optional. Top-level administrative subdivision of the country/region. Only required for transactions in India. Valid values are \"ANDAMAN AND NICOBAR ISLANDS\", \"ANDHRA PRADESH\", \"ARUNACHAL PRADESH\", \"ASSAM\", \"BIHAR\", \"CHANDIGARH\", \"CHHATTISGARH\", \"DADRA AND NAGAR HAVELI\", \"DADRA AND NAGAR HAVELI AND DAMAN AND DIU\", \"DAMAN AND DIU\", \"DELHI\", \"GOA\", \"GUJARAT\", \"HARYANA\", \"HIMACHAL PRADESH\", \"JAMMU AND KASHMIR\", \"JHARKHAND\", \"KARNATAKA\", \"KERALA\", \"LADAKH\", \"LAKSHADWEEP\", \"MADHYA PRADESH\", \"MAHARASHTRA\", \"MANIPUR\", \"MEGHALAYA\", \"MIZORAM\", \"NAGALAND\", \"ODISHA\", \"PUDUCHERRY\", \"PUNJAB\", \"RAJASTHAN\", \"SIKKIM\", \"TAMIL NADU\", \"TELANGANA\", \"TRIPURA\", \"UTTAR PRADESH\", \"UTTARAKHAND\", and \"WEST BENGAL\"." } }, "id": "ExternalTransactionAddress", "description": "User's address for the external transaction.", "type": "object" }, "DeleteOneTimeProductRequest": { "description": "Request message for deleting a one-time product.", "type": "object", "properties": { "latencyTolerance": { "enumDescriptions": [ "Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.", "The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.", "The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods." ], "description": "Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.", "type": "string", "enum": [ "PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT" ] }, "productId": { "type": "string", "description": "Required. The one-time product ID of the one-time product to delete." }, "packageName": { "description": "Required. The parent app (package name) of the one-time product to delete.", "type": "string" } }, "id": "DeleteOneTimeProductRequest" }, "PolicySingleChoiceResponse": { "id": "PolicySingleChoiceResponse", "description": "Any response where a single option is chosen from several possibilities.", "properties": { "value": { "type": "string", "description": "Required. Provided value." } }, "type": "object" }, "ReviewReplyResult": { "id": "ReviewReplyResult", "properties": { "replyText": { "type": "string", "description": "The reply text that was applied." }, "lastEdited": { "description": "The time at which the reply took effect.", "$ref": "Timestamp" } }, "description": "The result of replying/updating a reply to review.", "type": "object" }, "DeletePurchaseOptionRequest": { "id": "DeletePurchaseOptionRequest", "properties": { "packageName": { "type": "string", "description": "Required. The parent app (package name) of the purchase option to delete." }, "purchaseOptionId": { "description": "Required. The purchase option ID of the purchase option to delete.", "type": "string" }, "productId": { "description": "Required. The parent one-time product (ID) of the purchase option to delete.", "type": "string" }, "latencyTolerance": { "enumDescriptions": [ "Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.", "The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.", "The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods." ], "type": "string", "enum": [ "PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT" ], "description": "Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive." }, "force": { "description": "Optional. This field has no effect for purchase options with no offers under them. For purchase options with associated offers: * If `force` is set to false (default), an error will be returned. * If `force` is set to true, any associated offers under the purchase option will be deleted.", "type": "boolean" } }, "description": "Request message for deleting a purchase option.", "type": "object" }, "InstallmentPlan": { "type": "object", "description": "Information to a installment plan.", "id": "InstallmentPlan", "properties": { "pendingCancellation": { "description": "If present, this installment plan is pending to be canceled. The cancellation will happen only after the user finished all committed payments.", "$ref": "PendingCancellation" }, "subsequentCommittedPaymentsCount": { "format": "int32", "description": "Total number of payments the user will be committed for after each commitment period. Empty means the installment plan will fall back to a normal auto-renew subscription after initial commitment.", "type": "integer" }, "remainingCommittedPaymentsCount": { "description": "Total number of committed payments remaining to be paid for in this renewal cycle.", "format": "int32", "type": "integer" }, "initialCommittedPaymentsCount": { "type": "integer", "format": "int32", "description": "Total number of payments the user is initially committed for." } } }, "NestedPolicyResponse": { "properties": { "questionId": { "type": "string", "description": "Required. ID of the question being answered." }, "booleanResponse": { "$ref": "PolicyBooleanResponse", "description": "Optional. A boolean response." }, "documentResponse": { "$ref": "PolicyDocumentResponse", "description": "Optional. A document response." }, "multipleChoiceResponse": { "description": "Optional. A multiple choice response.", "$ref": "PolicyMultipleChoiceResponse" }, "stringResponse": { "description": "Optional. A string response.", "$ref": "PolicyStringResponse" }, "singleChoiceResponse": { "$ref": "PolicySingleChoiceResponse", "description": "Optional. A single choice response." } }, "description": "An individual nested response to a policy question about an app. Nested responses are like regular responses but without groups.", "id": "NestedPolicyResponse", "type": "object" }, "BatchMigrateBasePlanPricesResponse": { "description": "Response message for BatchMigrateBasePlanPrices.", "type": "object", "properties": { "responses": { "items": { "$ref": "MigrateBasePlanPricesResponse" }, "description": "Contains one response per requested price migration, in the same order as the request.", "type": "array" } }, "id": "BatchMigrateBasePlanPricesResponse" }, "DeveloperDetails": { "type": "object", "properties": { "contactEmail": { "type": "string", "description": "The contact email of the developer." }, "website": { "description": "The website of the developer.", "type": "string" }, "developerName": { "type": "string", "description": "The developer name of the app." }, "address": { "description": "The physical address of the developer.", "type": "string" }, "phoneNumber": { "type": "string", "description": "The phone number of the developer." } }, "description": "The developer details of a Google Play app.", "id": "DeveloperDetails" }, "ExternallyHostedApk": { "type": "object", "description": "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.", "id": "ExternallyHostedApk", "properties": { "nativeCodes": { "description": "The native code environments supported by this APK (optional).", "items": { "type": "string" }, "type": "array" }, "externallyHostedUrl": { "description": "The URL at which the APK is hosted. This must be an https URL.", "type": "string" }, "maximumSdk": { "format": "int32", "description": "The maximum SDK supported by this APK (optional).", "type": "integer" }, "usesPermissions": { "items": { "$ref": "UsesPermission" }, "type": "array", "description": "The permissions requested by this APK." }, "fileSha1Base64": { "type": "string", "description": "The sha1 checksum of this APK, represented as a base64 encoded byte array." }, "certificateBase64s": { "description": "A certificate (or array of certificates if a certificate-chain is used) used to sign this APK, represented as a base64 encoded byte array.", "items": { "type": "string" }, "type": "array" }, "packageName": { "description": "The package name.", "type": "string" }, "fileSize": { "format": "int64", "type": "string", "description": "The file size in bytes of this APK." }, "versionName": { "type": "string", "description": "The version name of this APK." }, "iconBase64": { "description": "The icon image from the APK, as a base64 encoded byte array.", "type": "string" }, "applicationLabel": { "type": "string", "description": "The application label." }, "fileSha256Base64": { "description": "The sha256 checksum of this APK, represented as a base64 encoded byte array.", "type": "string" }, "usesFeatures": { "items": { "type": "string" }, "type": "array", "description": "The features required by this APK (optional)." }, "minimumSdk": { "format": "int32", "type": "integer", "description": "The minimum SDK targeted by this APK." }, "versionCode": { "type": "integer", "description": "The version code of this APK.", "format": "int32" } } }, "SubscriptionPurchaseV2": { "id": "SubscriptionPurchaseV2", "description": "Indicates the status of a user's subscription purchase.", "properties": { "etag": { "type": "string", "description": "Entity tag representing the current state of the subscription. The developer will provide this etag for subscription actions. This etag is always present for auto-renewing and prepaid subscriptions." }, "onHoldStateContext": { "$ref": "OnHoldStateContext", "description": "Optional. Additional context around subscriptions in ON_HOLD state. Only present if the subscription currently has subscription_state SUBSCRIPTION_STATE_ON_HOLD." }, "outOfAppPurchaseContext": { "description": "Additional context for out of app purchases. This information is only present for re-subscription purchases (subscription purchases made after the previous subscription of the same product has expired) made through the Google Play subscriptions center. This field will be removed after you acknowledge the subscription.", "$ref": "OutOfAppPurchaseContext" }, "lineItems": { "description": "Item-level info for a subscription purchase. The items in the same purchase should be either all with AutoRenewingPlan or all with PrepaidPlan.", "items": { "$ref": "SubscriptionPurchaseLineItem" }, "type": "array" }, "regionCode": { "description": "ISO 3166-1 alpha-2 billing country/region code of the user at the time the subscription was granted.", "type": "string" }, "linkedPurchaseToken": { "description": "The purchase token of the old subscription if this subscription is one of the following: * Re-signup of a canceled but non-lapsed subscription * Upgrade/downgrade from a previous subscription. * Convert from prepaid to auto renewing subscription. * Convert from an auto renewing subscription to prepaid. * Topup a prepaid subscription.", "type": "string" }, "testPurchase": { "$ref": "TestPurchase", "description": "Only present if this subscription purchase is a test purchase." }, "acknowledgementState": { "type": "string", "enum": [ "ACKNOWLEDGEMENT_STATE_UNSPECIFIED", "ACKNOWLEDGEMENT_STATE_PENDING", "ACKNOWLEDGEMENT_STATE_ACKNOWLEDGED" ], "description": "The acknowledgement state of the subscription.", "enumDescriptions": [ "Unspecified acknowledgement state.", "The subscription is not acknowledged yet.", "The subscription is acknowledged." ] }, "subscribeWithGoogleInfo": { "description": "User profile associated with purchases made with 'Subscribe with Google'.", "$ref": "SubscribeWithGoogleInfo" }, "inGracePeriodStateContext": { "$ref": "InGracePeriodStateContext", "description": "Optional. Additional context around subscriptions in IN_GRACE_PERIOD state. Only present if the subscription currently has subscription_state SUBSCRIPTION_STATE_IN_GRACE_PERIOD." }, "subscriptionState": { "enumDescriptions": [ "Unspecified subscription state.", "Subscription was created but awaiting payment during signup. In this state, all items are awaiting payment.", "Subscription is active. - (1) If the subscription is an auto renewing plan, at least one item is auto_renew_enabled and not expired. - (2) If the subscription is a prepaid plan, at least one item is not expired.", "Subscription is paused. The state is only available when the subscription is an auto renewing plan. In this state, all items are in paused state.", "Subscription is in grace period. The state is only available when the subscription is an auto renewing plan. In this state, all items are in grace period.", "Subscription is on hold (suspended). The state is only available when the subscription is an auto renewing plan. In this state, all items are on hold.", "Subscription is canceled but not expired yet. The state is only available when the subscription is an auto renewing plan. All items have auto_renew_enabled set to false.", "Subscription is expired. All items have expiry_time in the past.", "Pending transaction for subscription is canceled. If this pending purchase was for an existing subscription, use linked_purchase_token to get the current state of that subscription." ], "description": "The current state of the subscription.", "type": "string", "enum": [ "SUBSCRIPTION_STATE_UNSPECIFIED", "SUBSCRIPTION_STATE_PENDING", "SUBSCRIPTION_STATE_ACTIVE", "SUBSCRIPTION_STATE_PAUSED", "SUBSCRIPTION_STATE_IN_GRACE_PERIOD", "SUBSCRIPTION_STATE_ON_HOLD", "SUBSCRIPTION_STATE_CANCELED", "SUBSCRIPTION_STATE_EXPIRED", "SUBSCRIPTION_STATE_PENDING_PURCHASE_CANCELED" ] }, "startTime": { "description": "Time at which the subscription was granted. Not set for pending subscriptions (subscription was created but awaiting payment during signup).", "type": "string", "format": "google-datetime" }, "canceledStateContext": { "description": "Additional context around canceled subscriptions. Only present if the subscription currently has subscription_state SUBSCRIPTION_STATE_CANCELED or SUBSCRIPTION_STATE_EXPIRED.", "$ref": "CanceledStateContext" }, "pausedStateContext": { "description": "Additional context around paused subscriptions. Only present if the subscription currently has subscription_state SUBSCRIPTION_STATE_PAUSED.", "$ref": "PausedStateContext" }, "kind": { "type": "string", "description": "This kind represents a SubscriptionPurchaseV2 object in the androidpublisher service." }, "externalAccountIdentifiers": { "description": "User account identifier in the third-party service.", "$ref": "ExternalAccountIdentifiers" } }, "type": "object" }, "UpgradeTargetingRule": { "type": "object", "id": "UpgradeTargetingRule", "properties": { "scope": { "description": "Required. The scope of subscriptions this rule considers. Only allows \"this subscription\" and \"specific subscription in app\".", "$ref": "TargetingRuleScope" }, "oncePerUser": { "description": "Limit this offer to only once per user. If set to true, a user can never be eligible for this offer again if they ever subscribed to this offer.", "type": "boolean" }, "billingPeriodDuration": { "description": "The specific billing period duration, specified in ISO 8601 format, that a user must be currently subscribed to to be eligible for this rule. If not specified, users subscribed to any billing period are matched.", "type": "string" } }, "description": "Represents a targeting rule of the form: User currently has {scope} [with billing period {billing_period}]." }, "GeneratedSplitApk": { "description": "Download metadata for a split APK.", "id": "GeneratedSplitApk", "type": "object", "properties": { "downloadId": { "type": "string", "description": "Download ID, which uniquely identifies the APK to download. Should be supplied to `generatedapks.download` method." }, "splitId": { "description": "Split ID. Empty for the main split of the base module.", "type": "string" }, "variantId": { "format": "int32", "description": "ID of the generated variant.", "type": "integer" }, "moduleName": { "description": "Name of the module that this APK belongs to.", "type": "string" } } }, "DeferSubscriptionPurchaseRequest": { "id": "DeferSubscriptionPurchaseRequest", "type": "object", "properties": { "deferralContext": { "$ref": "DeferralContext", "description": "Required. Details about the subscription deferral." } }, "description": "Request for the v2 purchases.subscriptions.defer API." }, "SubscriptionTaxAndComplianceSettings": { "type": "object", "id": "SubscriptionTaxAndComplianceSettings", "description": "Details about taxation, Google Play policy, and legal compliance for subscription products.", "properties": { "regionalProductAgeRatingInfos": { "description": "Regional age rating information. Currently this field is only supported for region code `US`.", "items": { "$ref": "RegionalProductAgeRatingInfo" }, "type": "array" }, "taxRateInfoByRegionCode": { "description": "A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's \"CLDR\".", "additionalProperties": { "$ref": "RegionalTaxRateInfo" }, "type": "object" }, "eeaWithdrawalRightType": { "description": "Digital content or service classification for products distributed to users in the European Economic Area (EEA). The withdrawal regime under EEA consumer laws depends on this classification. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.", "enumDescriptions": [ "", "", "" ], "type": "string", "enum": [ "WITHDRAWAL_RIGHT_TYPE_UNSPECIFIED", "WITHDRAWAL_RIGHT_DIGITAL_CONTENT", "WITHDRAWAL_RIGHT_SERVICE" ] }, "productTaxCategoryCode": { "type": "string", "description": "Product tax category code to assign to the subscription. Product tax category determines the transaction tax rates applied to the subscription. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/16408159) for more information." }, "isTokenizedDigitalAsset": { "type": "boolean", "description": "Whether this subscription is declared as a product representing a tokenized digital asset." } } }, "PaidAppDetails": { "id": "PaidAppDetails", "description": "Details of a paid app purchase.", "properties": {}, "type": "object" }, "BatchUpdateSubscriptionsResponse": { "description": "Response message for BatchUpdateSubscription.", "type": "object", "id": "BatchUpdateSubscriptionsResponse", "properties": { "subscriptions": { "type": "array", "items": { "$ref": "Subscription" }, "description": "The updated subscriptions list." } } }, "AndroidSdks": { "properties": { "sdkLevels": { "type": "array", "items": { "type": "string", "format": "int64" }, "description": "Android api levels of devices targeted by recovery action. See https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels for different api levels in android." } }, "type": "object", "id": "AndroidSdks", "description": "Android api level targeting data for app recovery action targeting." }, "PrepaidBasePlanType": { "description": "Represents a base plan that does not automatically renew at the end of the base plan, and must be manually renewed by the user.", "type": "object", "properties": { "billingPeriodDuration": { "description": "Required. Immutable. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center. The duration is immutable after the base plan is created.", "type": "string" }, "timeExtension": { "description": "Whether users should be able to extend this prepaid base plan in Google Play surfaces. Defaults to TIME_EXTENSION_ACTIVE if not specified.", "type": "string", "enum": [ "TIME_EXTENSION_UNSPECIFIED", "TIME_EXTENSION_ACTIVE", "TIME_EXTENSION_INACTIVE" ], "enumDescriptions": [ "Unspecified state.", "Time extension is active. Users are allowed to top-up or extend their prepaid plan.", "Time extension is inactive. Users cannot top-up or extend their prepaid plan." ] } }, "id": "PrepaidBasePlanType" }, "CancelSurveyResult": { "id": "CancelSurveyResult", "type": "object", "properties": { "reasonUserInput": { "type": "string", "description": "Only set for CANCEL_SURVEY_REASON_OTHERS. This is the user's freeform response to the survey." }, "reason": { "type": "string", "enum": [ "CANCEL_SURVEY_REASON_UNSPECIFIED", "CANCEL_SURVEY_REASON_NOT_ENOUGH_USAGE", "CANCEL_SURVEY_REASON_TECHNICAL_ISSUES", "CANCEL_SURVEY_REASON_COST_RELATED", "CANCEL_SURVEY_REASON_FOUND_BETTER_APP", "CANCEL_SURVEY_REASON_OTHERS" ], "description": "The reason the user selected in the cancel survey.", "enumDescriptions": [ "Unspecified cancel survey reason.", "Not enough usage of the subscription.", "Technical issues while using the app.", "Cost related issues.", "The user found a better app.", "Other reasons." ] } }, "description": "Result of the cancel survey when the subscription was canceled by the user." }, "DeviceTier": { "properties": { "deviceGroupNames": { "items": { "type": "string" }, "type": "array", "description": "Groups of devices included in this tier. These groups must be defined explicitly under device_groups in this configuration." }, "level": { "type": "integer", "description": "The priority level of the tier. Tiers are evaluated in descending order of level: the highest level tier has the highest priority. The highest tier matching a given device is selected for that device. You should use a contiguous range of levels for your tiers in a tier set; tier levels in a tier set must be unique. For instance, if your tier set has 4 tiers (including the global fallback), you should define tiers 1, 2 and 3 in this configuration. Note: tier 0 is implicitly defined as a global fallback and selected for devices that don't match any of the tiers explicitly defined here. You mustn't define level 0 explicitly in this configuration.", "format": "int32" } }, "description": "A single device tier. Devices matching any of the device groups in device_group_names are considered to match the tier.", "id": "DeviceTier", "type": "object" }, "TextureCompressionFormat": { "type": "object", "id": "TextureCompressionFormat", "properties": { "alias": { "type": "string", "enum": [ "UNSPECIFIED_TEXTURE_COMPRESSION_FORMAT", "ETC1_RGB8", "PALETTED", "THREE_DC", "ATC", "LATC", "DXT1", "S3TC", "PVRTC", "ASTC", "ETC2" ], "enumDescriptions": [ "Unspecified format.", "ETC1_RGB8 format.", "PALETTED format.", "THREE_DC format.", "ATC format.", "LATC format.", "DXT1 format.", "S3TC format.", "PVRTC format.", "ASTC format.", "ETC2 format." ], "description": "Alias for texture compression format." } }, "description": "Represents texture compression format." }, "TrackConfig": { "id": "TrackConfig", "description": "Configurations of the new track.", "properties": { "formFactor": { "description": "Required. Form factor of the new track. Defaults to the default track.", "enumDescriptions": [ "Fallback value, do not use.", "Default track.", "Wear form factor track.", "Automotive form factor track." ], "type": "string", "enum": [ "FORM_FACTOR_UNSPECIFIED", "DEFAULT", "WEAR", "AUTOMOTIVE" ] }, "track": { "description": "Required. Identifier of the new track. For default tracks, this field consists of the track alias only. Form factor tracks have a special prefix as an identifier, for example `wear:production`, `automotive:production`. This prefix must match the value of the `form_factor` field, if it is not a default track. [More on track name](https://developers.google.com/android-publisher/tracks#ff-track-name)", "type": "string" }, "type": { "type": "string", "enum": [ "TRACK_TYPE_UNSPECIFIED", "CLOSED_TESTING" ], "enumDescriptions": [ "Fallback value, do not use.", "Closed testing track." ], "description": "Required. Type of the new track. Currently, the only supported value is closedTesting." } }, "type": "object" }, "ExternalSubscription": { "properties": { "subscriptionType": { "enumDescriptions": [ "Unspecified, do not use.", "This is a recurring subscription where the user is charged every billing cycle.", "This is a prepaid subscription where the user pays up front." ], "description": "Required. The type of the external subscription.", "type": "string", "enum": [ "SUBSCRIPTION_TYPE_UNSPECIFIED", "RECURRING", "PREPAID" ] } }, "description": "Details of an external subscription.", "type": "object", "id": "ExternalSubscription" }, "SystemInitiatedCancellation": { "type": "object", "id": "SystemInitiatedCancellation", "properties": {}, "description": "Information specific to cancellations initiated by Google system." }, "OfferTag": { "id": "OfferTag", "type": "object", "properties": { "tag": { "description": "Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.", "type": "string" } }, "description": "Represents a custom tag specified for a product offer." }, "BasePlan": { "type": "object", "properties": { "regionalConfigs": { "description": "Region-specific information for this base plan.", "items": { "$ref": "RegionalBasePlanConfig" }, "type": "array" }, "state": { "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified state.", "The base plan is currently in a draft state, and hasn't been activated. It can be safely deleted at this point.", "The base plan is active and available for new subscribers.", "The base plan is inactive and only available for existing subscribers." ], "enum": [ "STATE_UNSPECIFIED", "DRAFT", "ACTIVE", "INACTIVE" ], "description": "Output only. The state of the base plan, i.e. whether it's active. Draft and inactive base plans can be activated or deleted. Active base plans can be made inactive. Inactive base plans can be canceled. This field cannot be changed by updating the resource. Use the dedicated endpoints instead." }, "autoRenewingBasePlanType": { "description": "Set when the base plan automatically renews at a regular interval.", "$ref": "AutoRenewingBasePlanType" }, "prepaidBasePlanType": { "description": "Set when the base plan does not automatically renew at the end of the billing period.", "$ref": "PrepaidBasePlanType" }, "offerTags": { "description": "List of up to 20 custom tags specified for this base plan, and returned to the app through the billing library. Subscription offers for this base plan will also receive these offer tags in the billing library.", "type": "array", "items": { "$ref": "OfferTag" } }, "otherRegionsConfig": { "description": "Pricing information for any new locations Play may launch in the future. If omitted, the BasePlan will not be automatically available any new locations Play may launch in the future.", "$ref": "OtherRegionsBasePlanConfig" }, "basePlanId": { "type": "string", "description": "Required. Immutable. The unique identifier of this base plan. Must be unique within the subscription, and conform with RFC-1034. That is, this ID can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 63 characters." }, "installmentsBasePlanType": { "description": "Set for installments base plans where a user is committed to a specified number of payments.", "$ref": "InstallmentsBasePlanType" } }, "description": "A single base plan for a subscription.", "id": "BasePlan" }, "RegionalSubscriptionOfferConfig": { "properties": { "newSubscriberAvailability": { "type": "boolean", "description": "Whether the subscription offer in the specified region is available for new subscribers. Existing subscribers will not have their subscription cancelled if this value is set to false. If not specified, this will default to false." }, "regionCode": { "type": "string", "description": "Required. Immutable. Region code this configuration applies to, as defined by ISO 3166-2, e.g. \"US\"." } }, "type": "object", "id": "RegionalSubscriptionOfferConfig", "description": "Configuration for a subscription offer in a single region." }, "Comment": { "description": "An entry of conversation between user and developer.", "id": "Comment", "type": "object", "properties": { "userComment": { "description": "A comment from a user.", "$ref": "UserComment" }, "developerComment": { "$ref": "DeveloperComment", "description": "A comment from a developer." } } }, "RegionalSubscriptionOfferPhaseConfig": { "type": "object", "id": "RegionalSubscriptionOfferPhaseConfig", "description": "Configuration for a single phase of a subscription offer in a single region.", "properties": { "relativeDiscount": { "description": "The fraction of the base plan price prorated over the phase duration that the user pays for this offer phase. For example, if the base plan price for this region is $12 for a period of 1 year, then a 50% discount for a phase of a duration of 3 months would correspond to a price of $1.50. The discount must be specified as a fraction strictly larger than 0 and strictly smaller than 1. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in this region.", "type": "number", "format": "double" }, "free": { "$ref": "RegionalSubscriptionOfferPhaseFreePriceOverride", "description": "Set to specify this offer is free to obtain." }, "regionCode": { "description": "Required. Immutable. The region to which this config applies.", "type": "string" }, "price": { "$ref": "Money", "description": "The absolute price the user pays for this offer phase. The price must not be smaller than the minimum price allowed for this region." }, "absoluteDiscount": { "description": "The absolute amount of money subtracted from the base plan price prorated over the phase duration that the user pays for this offer phase. For example, if the base plan price for this region is $12 for a period of 1 year, then a $1 absolute discount for a phase of a duration of 3 months would correspond to a price of $2. The resulting price may not be smaller than the minimum price allowed for this region.", "$ref": "Money" } } }, "VideoAsset": { "id": "VideoAsset", "type": "object", "properties": { "videoUrl": { "type": "string", "description": "The URL of the video asset." } }, "description": "A video asset." }, "ModuleTargeting": { "description": "Targeting on the module level.", "properties": { "sdkVersionTargeting": { "description": "The sdk version that the variant targets", "$ref": "SdkVersionTargeting" }, "userCountriesTargeting": { "$ref": "UserCountriesTargeting", "description": "Countries-level targeting" }, "deviceFeatureTargeting": { "type": "array", "items": { "$ref": "DeviceFeatureTargeting" }, "description": "Targeting for device features." } }, "type": "object", "id": "ModuleTargeting" }, "BatchDeletePurchaseOptionsRequest": { "description": "Request message for BatchDeletePurchaseOption.", "properties": { "requests": { "type": "array", "description": "Required. A list of delete requests of up to 100 elements. All requests must delete purchase options from different one-time products.", "items": { "$ref": "DeletePurchaseOptionRequest" } } }, "type": "object", "id": "BatchDeletePurchaseOptionsRequest" }, "ListReleaseSummariesResponse": { "id": "ListReleaseSummariesResponse", "description": "Response listing all releases for a given track that are either ready to be sent for review, in review, approved, not approved or available.", "properties": { "releases": { "type": "array", "items": { "$ref": "ReleaseSummary" }, "description": "List of releases for this track. A maximum of 20 releases can be returned." } }, "type": "object" }, "Order": { "description": "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.", "id": "Order", "properties": { "tax": { "$ref": "Money", "description": "The total tax paid as a part of this order." }, "salesChannel": { "type": "string", "enum": [ "SALES_CHANNEL_UNSPECIFIED", "IN_APP", "PC_EMULATOR", "NATIVE_PC", "PLAY_STORE", "OUTSIDE_PLAY_STORE" ], "enumDescriptions": [ "Sales channel unspecified. This value is not used.", "Standard orders that initiated from in-app.", "Orders initiated from a PC emulator for in-app purchases.", "Orders initiated from a native PC app for in-app purchases.", "Orders initiated from the Google Play store.", "Orders initiated outside the Google Play store." ], "description": "The originating sales channel of the order." }, "lastEventTime": { "description": "The time of the last event that occurred on the order.", "type": "string", "format": "google-datetime" }, "total": { "$ref": "Money", "description": "The final amount paid by the customer, taking into account discounts and taxes." }, "buyerAddress": { "$ref": "BuyerAddress", "description": "Address information for the customer, for use in tax computation. When Google is the Merchant of Record for the order, only country is shown." }, "pointsDetails": { "description": "Play points applied to the order, including offer information, discount rate and point values.", "$ref": "PointsDetails" }, "purchaseToken": { "type": "string", "description": "The token provided to the user's device when the subscription or item was purchased." }, "orderHistory": { "$ref": "OrderHistory", "description": "Details about events which modified the order." }, "orderId": { "type": "string", "description": "The order ID." }, "lineItems": { "description": "The individual line items making up this order.", "items": { "$ref": "LineItem" }, "type": "array" }, "createTime": { "format": "google-datetime", "type": "string", "description": "The time when the order was created." }, "state": { "enumDescriptions": [ "State unspecified. This value is not used.", "Order has been created and is waiting to be processed.", "Order has been successfully processed.", "Order was canceled before being processed.", "Requested refund is waiting to be processed.", "Part of the order amount was refunded.", "The full order amount was refunded." ], "description": "The state of the order.", "type": "string", "enum": [ "STATE_UNSPECIFIED", "PENDING", "PROCESSED", "CANCELED", "PENDING_REFUND", "PARTIALLY_REFUNDED", "REFUNDED" ] }, "developerRevenueInBuyerCurrency": { "description": "Your revenue for this order in the buyer's currency, including deductions of partial refunds, taxes and fees. Google deducts standard transaction and third party fees from each sale, including VAT in some regions.", "$ref": "Money" }, "orderDetails": { "$ref": "OrderDetails", "description": "Detailed information about the order at creation time." } }, "type": "object" }, "ListAppRecoveriesResponse": { "properties": { "recoveryActions": { "items": { "$ref": "AppRecoveryAction" }, "description": "List of recovery actions associated with the requested package name.", "type": "array" } }, "id": "ListAppRecoveriesResponse", "type": "object", "description": "Response message for ListAppRecoveries. -- api-linter: core::0158::response-next-page-token-field=disabled" }, "SubscriptionListing": { "type": "object", "properties": { "languageCode": { "description": "Required. The language of this listing, as defined by BCP-47, e.g. \"en-US\".", "type": "string" }, "title": { "type": "string", "description": "Required. The title of this subscription in the language of this listing. Plain text." }, "benefits": { "description": "A list of benefits shown to the user on platforms such as the Play Store and in restoration flows in the language of this listing. Plain text. Ordered list of at most four benefits.", "items": { "type": "string" }, "type": "array" }, "description": { "type": "string", "description": "The description of this subscription in the language of this listing. Maximum length - 200 characters. Plain text." } }, "id": "SubscriptionListing", "description": "The consumer-visible metadata of a subscription." }, "ModuleMetadata": { "properties": { "dependencies": { "type": "array", "description": "Names of the modules that this module directly depends on. Each module implicitly depends on the base module.", "items": { "type": "string" } }, "deliveryType": { "type": "string", "enum": [ "UNKNOWN_DELIVERY_TYPE", "INSTALL_TIME", "ON_DEMAND", "FAST_FOLLOW" ], "enumDescriptions": [ "Unspecified delivery type.", "This module will always be downloaded as part of the initial install of the app.", "This module is requested on-demand, which means it will not be part of the initial install, and will only be sent when requested by the client.", "This module will be downloaded immediately after initial install finishes. The app can be opened before these modules are downloaded." ], "description": "Indicates the delivery type (e.g. on-demand) of the module." }, "name": { "description": "Module name.", "type": "string" }, "moduleType": { "description": "Indicates the type of this feature module.", "enumDescriptions": [ "Unknown feature module.", "Regular feature module." ], "type": "string", "enum": [ "UNKNOWN_MODULE_TYPE", "FEATURE_MODULE" ] }, "targeting": { "$ref": "ModuleTargeting", "description": "The targeting that makes a conditional module installed. Relevant only for Split APKs." } }, "description": "Metadata of a module.", "id": "ModuleMetadata", "type": "object" }, "BatchUpdateOneTimeProductOffersResponse": { "type": "object", "description": "Response message for BatchUpdateOneTimeProductOffers.", "properties": { "oneTimeProductOffers": { "type": "array", "items": { "$ref": "OneTimeProductOffer" }, "description": "The list of updated one-time product offers, in the same order as the request." } }, "id": "BatchUpdateOneTimeProductOffersResponse" }, "CatalogAppView": { "description": "LINT.IfChange A view of a Google Play app within the Catalog Export for app stores.", "properties": { "hasInAppAds": { "type": "boolean", "description": "Whether the app has ads." }, "appContactInformation": { "description": "Developer-provided contact information for the app.", "$ref": "AppContactInformation" }, "deliveryToken": { "type": "string", "description": "The token used for delivery of the app with the Google Play Inline Install API." }, "developerDetails": { "$ref": "DeveloperDetails", "description": "The developer details of the app." }, "priceInTheUnitedStates": { "$ref": "Money", "description": "The price of the app in the United States. Empty if the app is free." }, "privacyPolicyUrl": { "type": "string", "description": "The URL of the app's privacy policy." }, "firstReleaseDate": { "description": "The date when the app was first released.", "$ref": "Date" }, "deviceCompatibilityRequirements": { "items": { "$ref": "DeviceCompatibilityRequirements" }, "description": "The app may specify multiple sets of device compatibility requirements, and a device is considered compatible with the app if it satisfies at least one of `DeviceCompatibilityRequirements`.", "type": "array" }, "lastPublishTime": { "format": "google-datetime", "description": "The timestamp when the app was last published.", "type": "string" }, "appSubcategory": { "description": "The subcategory of the app e.g. \"GAME_ACTION\".", "type": "string" }, "activeVersionNames": { "items": { "type": "string" }, "type": "array", "description": "Active versions of the app mapped from `android:versionName` manifest attributes." }, "packageName": { "description": "The package name of the app.", "type": "string" }, "iarcCertificateId": { "type": "string", "description": "The IARC certificate ID for the app." }, "appCategory": { "description": "The category of the app.", "type": "string", "enum": [ "APP_CATEGORY_UNSPECIFIED", "GAME", "APP" ], "enumDescriptions": [ "Unspecified category.", "Game app.", "General app." ] }, "isAdultOnlyAudience": { "type": "boolean", "description": "Whether the app is targeted to an adult-only (18+) audience." }, "permissionsSdk23": { "items": { "$ref": "CatalogPermission" }, "description": "Required permissions declared by the app which apply for Android SDK versions SDK 23 and above.", "type": "array" }, "permissions": { "type": "array", "description": "Required permissions declared by the app which apply for all Android SDK versions.", "items": { "$ref": "CatalogPermission" } }, "excludedDevicesByIdentifier": { "type": "array", "items": { "$ref": "DeviceIdentifier" }, "description": "List of devices excluded from the app's distribution even if they are otherwise compatible with the requirements from device_compatibility_requirements. These are OR-ed, i.e. a device is excluded if it matches any of the identifiers." }, "localizedStoreListings": { "$ref": "LocalizedStoreListings", "description": "The localized store listings of the app which are shown on Google Play." }, "excludedDevicesBySelector": { "type": "array", "description": "List of devices excluded from the app's distribution even if they are otherwise compatible with the requirements from device_compatibility_requirements. A device is excluded if it matches any of given the selectors.", "items": { "$ref": "CatalogDeviceSelector" } }, "salePriceInTheUnitedStates": { "description": "The sale price of the app in the United States. Only populated for paid apps with an active US sale.", "$ref": "Money" }, "hasInAppPurchases": { "type": "boolean", "description": "Whether the app has in-app purchases through Google Play." } }, "type": "object", "id": "CatalogAppView" }, "ExternalContentLinkDetails": { "properties": { "externalAppCategory": { "description": "Optional. The category of the downlaoded app. This must match the category provided in Play Console during the external app verification process. Only required for app installs.", "enumDescriptions": [ "Unspecified, do not use.", "The app is classified under the app category.", "The app is classified under the game category." ], "type": "string", "enum": [ "EXTERNAL_CONTENT_APP_CATEGORY_UNSPECIFIED", "APP", "GAME" ] }, "linkType": { "type": "string", "enum": [ "EXTERNAL_CONTENT_LINK_TYPE_UNSPECIFIED", "LINK_TO_DIGITAL_CONTENT_OFFER", "LINK_TO_APP_DOWNLOAD" ], "description": "Required. The type content being reported by this transaction.", "enumDescriptions": [ "Unspecified, do not use.", "An offer to purchase digital content.", "An app install." ] }, "installedAppPackage": { "description": "Optional. The package name of the app downloaded through this transaction. Only required for app installs.", "type": "string" } }, "description": "Reporting details unique to the external content link program.", "type": "object", "id": "ExternalContentLinkDetails" }, "CanceledStateContext": { "properties": { "replacementCancellation": { "$ref": "ReplacementCancellation", "description": "Subscription was replaced by a new subscription." }, "systemInitiatedCancellation": { "$ref": "SystemInitiatedCancellation", "description": "Subscription was canceled by the system, for example because of a billing problem." }, "developerInitiatedCancellation": { "description": "Subscription was canceled by the developer.", "$ref": "DeveloperInitiatedCancellation" }, "userInitiatedCancellation": { "description": "Subscription was canceled by user.", "$ref": "UserInitiatedCancellation" } }, "description": "Information specific to a subscription in the SUBSCRIPTION_STATE_CANCELED or SUBSCRIPTION_STATE_EXPIRED state.", "id": "CanceledStateContext", "type": "object" }, "UserInitiatedCancellation": { "properties": { "cancelTime": { "description": "The time at which the subscription was canceled by the user. The user might still have access to the subscription after this time. Use line_items.expiry_time to determine if a user still has access.", "format": "google-datetime", "type": "string" }, "cancelSurveyResult": { "description": "Information provided by the user when they complete the subscription cancellation flow (cancellation reason survey).", "$ref": "CancelSurveyResult" } }, "type": "object", "description": "Information specific to cancellations initiated by users.", "id": "UserInitiatedCancellation" }, "BatchGetOneTimeProductOffersRequest": { "properties": { "requests": { "type": "array", "description": "Required. A list of get requests of up to 100 elements. All requests must retrieve different offers.", "items": { "$ref": "GetOneTimeProductOfferRequest" } } }, "description": "Request message for the BatchGetOneTimeProductOffers endpoint.", "type": "object", "id": "BatchGetOneTimeProductOffersRequest" }, "RemoteInAppUpdateData": { "id": "RemoteInAppUpdateData", "properties": { "remoteAppUpdateDataPerBundle": { "description": "Data related to the recovery action at bundle level.", "type": "array", "items": { "$ref": "RemoteInAppUpdateDataPerBundle" } } }, "type": "object", "description": "Data related to Remote In-App Update action such as recovered user count, affected user count etc." }, "AppVersionList": { "type": "object", "id": "AppVersionList", "description": "Data format for a list of app versions.", "properties": { "versionCodes": { "description": "List of app version codes.", "items": { "format": "int64", "type": "string" }, "type": "array" } } }, "PrepaidPlan": { "properties": { "allowExtendAfterTime": { "type": "string", "format": "google-datetime", "description": "If present, this is the time after which top up purchases are allowed for the prepaid plan. Will not be present for expired prepaid plans." } }, "description": "Information related to a prepaid plan.", "type": "object", "id": "PrepaidPlan" }, "RotateAppSigningKeyResponse": { "description": "Response to rotate an app's signing key.", "type": "object", "properties": { "rotatedKeyCertificate": { "description": "The rotated key certificate hashes for the app. Always set.", "$ref": "CertificateHashes" } }, "id": "RotateAppSigningKeyResponse" }, "InstallmentsBasePlanType": { "description": "Represents an installments base plan where a user commits to a specified number of payments.", "id": "InstallmentsBasePlanType", "properties": { "resubscribeState": { "type": "string", "enum": [ "RESUBSCRIBE_STATE_UNSPECIFIED", "RESUBSCRIBE_STATE_ACTIVE", "RESUBSCRIBE_STATE_INACTIVE" ], "description": "Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.", "enumDescriptions": [ "Unspecified state.", "Resubscribe is active.", "Resubscribe is inactive." ] }, "renewalType": { "type": "string", "enum": [ "RENEWAL_TYPE_UNSPECIFIED", "RENEWAL_TYPE_RENEWS_WITHOUT_COMMITMENT", "RENEWAL_TYPE_RENEWS_WITH_COMMITMENT" ], "description": "Required. Immutable. Installments base plan renewal type. Determines the behavior at the end of the initial commitment. The renewal type is immutable after the base plan is created.", "enumDescriptions": [ "Unspecified state.", "Renews periodically for the billing period duration without commitment.", "Renews with the commitment of the same duration as the initial one." ] }, "committedPaymentsCount": { "description": "Required. Immutable. The number of payments the user is committed to. It is immutable after the base plan is created.", "type": "integer", "format": "int32" }, "billingPeriodDuration": { "type": "string", "description": "Required. Immutable. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center. The duration is immutable after the base plan is created." }, "prorationMode": { "description": "The proration mode for the base plan determines what happens when a user switches to this plan from another base plan. If unspecified, defaults to CHARGE_ON_NEXT_BILLING_DATE.", "enumDescriptions": [ "Unspecified mode.", "Users will be charged for their new base plan at the end of their current billing period.", "Users will be charged for their new base plan immediately and in full. Any remaining period of their existing subscription will be used to extend the duration of the new billing plan." ], "type": "string", "enum": [ "SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED", "SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE", "SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY" ] }, "gracePeriodDuration": { "description": "Grace period of the subscription, specified in ISO 8601 format. Acceptable values must be in days and between P0D and the lesser of 30D and base plan billing period. If not specified, a default value will be used based on the billing period. The sum of gracePeriodDuration and accountHoldDuration must be between P30D and P60D days, inclusive.", "type": "string" }, "accountHoldDuration": { "type": "string", "description": "Optional. Custom account hold period of the subscription, specified in ISO 8601 format. Acceptable values must be in days and between P0D and P60D. An empty field represents a recommended account hold, calculated as 60 days minus grace period. The sum of gracePeriodDuration and accountHoldDuration must be between P30D and P60D days, inclusive." } }, "type": "object" }, "OrderDetails": { "description": "Detailed information about the order at creation time.", "properties": { "taxInclusive": { "type": "boolean", "description": "Indicates whether the listed price was tax inclusive or not." } }, "type": "object", "id": "OrderDetails" }, "ImageAsset": { "type": "object", "properties": { "imageUrl": { "type": "string", "description": "The URL of the image asset." } }, "id": "ImageAsset", "description": "An image asset." }, "ProductPurchasesAcknowledgeRequest": { "description": "Request for the product.purchases.acknowledge API.", "properties": { "developerPayload": { "description": "Payload to attach to the purchase.", "type": "string" } }, "id": "ProductPurchasesAcknowledgeRequest", "type": "object" }, "SystemFeature": { "type": "object", "description": "Representation of a system feature.", "id": "SystemFeature", "properties": { "name": { "description": "The name of the feature.", "type": "string" } } }, "InappproductsBatchUpdateRequest": { "properties": { "requests": { "type": "array", "description": "Required. Individual update requests. At least one request is required. Can contain up to 100 requests. All requests must correspond to different in-app products.", "items": { "$ref": "InappproductsUpdateRequest" } } }, "description": "Request to update or insert one or more in-app products.", "type": "object", "id": "InappproductsBatchUpdateRequest" }, "PolicyResponse": { "properties": { "groupResponse": { "description": "Optional. A group response.", "$ref": "PolicyGroupResponse" }, "booleanResponse": { "$ref": "PolicyBooleanResponse", "description": "Optional. A boolean response." }, "questionId": { "description": "Required. ID of the question being answered.", "type": "string" }, "multipleChoiceResponse": { "description": "Optional. A multiple choice response.", "$ref": "PolicyMultipleChoiceResponse" }, "stringResponse": { "$ref": "PolicyStringResponse", "description": "Optional. A string response." }, "documentResponse": { "$ref": "PolicyDocumentResponse", "description": "Optional. A document response." }, "keyedGroupResponse": { "$ref": "PolicyKeyedGroupResponse", "description": "Optional. A keyed group response." }, "singleChoiceResponse": { "description": "Optional. A single choice response.", "$ref": "PolicySingleChoiceResponse" } }, "description": "An individual response (answer) to a policy question about an app.", "type": "object", "id": "PolicyResponse" }, "BatchUpdatePurchaseOptionStatesResponse": { "description": "Response message for BatchUpdatePurchaseOptionStates.", "id": "BatchUpdatePurchaseOptionStatesResponse", "type": "object", "properties": { "oneTimeProducts": { "items": { "$ref": "OneTimeProduct" }, "description": "The list of updated one-time products. This list will match the requests one to one, in the same order.", "type": "array" } } }, "BatchDeleteOneTimeProductsRequest": { "type": "object", "description": "Request message for BatchDeleteOneTimeProduct.", "id": "BatchDeleteOneTimeProductsRequest", "properties": { "requests": { "type": "array", "items": { "$ref": "DeleteOneTimeProductRequest" }, "description": "Required. A list of delete requests of up to 100 elements. All requests must delete different one-time products." } } }, "UsesPermission": { "properties": { "maxSdkVersion": { "description": "Optionally, the maximum SDK version for which the permission is required.", "type": "integer", "format": "int32" }, "name": { "description": "The name of the permission requested.", "type": "string" } }, "id": "UsesPermission", "description": "A permission used by this APK.", "type": "object" }, "DeactivateBasePlanRequest": { "id": "DeactivateBasePlanRequest", "type": "object", "description": "Request message for DeactivateBasePlan.", "properties": { "basePlanId": { "description": "Required. The unique base plan ID of the base plan to deactivate.", "type": "string" }, "latencyTolerance": { "enumDescriptions": [ "Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.", "The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.", "The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods." ], "type": "string", "enum": [ "PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT" ], "description": "Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive." }, "productId": { "description": "Required. The parent subscription (ID) of the base plan to deactivate.", "type": "string" }, "packageName": { "description": "Required. The parent app (package name) of the base plan to deactivate.", "type": "string" } } }, "TestPurchase": { "properties": {}, "type": "object", "description": "Whether this subscription purchase is a test purchase.", "id": "TestPurchase" }, "ProductPurchaseV2": { "type": "object", "id": "ProductPurchaseV2", "properties": { "orderId": { "type": "string", "description": "The order id associated with the purchase of the inapp product. May not be set if there is no order associated with the purchase." }, "purchaseStateContext": { "description": "Information about the purchase state of the purchase.", "$ref": "PurchaseStateContext" }, "obfuscatedExternalProfileId": { "type": "string", "description": "An obfuscated version of the id that is uniquely associated with the user's profile in your app. Only present if specified using https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid when the purchase was made." }, "kind": { "description": "This kind represents a ProductPurchaseV2 object in the androidpublisher service.", "type": "string" }, "productLineItem": { "description": "Contains item-level info for a ProductPurchaseV2.", "items": { "$ref": "ProductLineItem" }, "type": "array" }, "acknowledgementState": { "enum": [ "ACKNOWLEDGEMENT_STATE_UNSPECIFIED", "ACKNOWLEDGEMENT_STATE_PENDING", "ACKNOWLEDGEMENT_STATE_ACKNOWLEDGED" ], "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified acknowledgement state.", "The purchase is not acknowledged yet.", "The purchase is acknowledged." ], "description": "Output only. The acknowledgement state of the purchase." }, "purchaseCompletionTime": { "format": "google-datetime", "type": "string", "description": "The time when the purchase was successful, i.e., when the PurchaseState has changed to PURCHASED. This field will not be present until the payment is complete. For example, if the user initiated a pending transaction (https://developer.android.com/google/play/billing/integrate#pending), this field will not be populated until the user successfully completes the steps required to complete the transaction." }, "obfuscatedExternalAccountId": { "type": "string", "description": "An obfuscated version of the id that is uniquely associated with the user's account in your app. Only present if specified using https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid when the purchase was made." }, "regionCode": { "description": "ISO 3166-1 alpha-2 billing region code of the user at the time the product was granted.", "type": "string" }, "testPurchaseContext": { "description": "Information related to test purchases. This will only be set for test purchases.", "$ref": "TestPurchaseContext" } }, "description": "A ProductPurchaseV2 resource indicates the status of a user's inapp product purchase." }, "PolicyGroupResponse": { "type": "object", "properties": { "groups": { "description": "Optional. Groups of responses to questions.", "items": { "$ref": "Group" }, "type": "array" } }, "description": "A repeated group of responses.", "id": "PolicyGroupResponse" }, "CancelAppRecoveryResponse": { "properties": {}, "id": "CancelAppRecoveryResponse", "description": "Response message for CancelAppRecovery.", "type": "object" }, "UpdatePurchaseOptionStateRequest": { "description": "Request message to update the state of a one-time product purchase option.", "type": "object", "properties": { "deactivatePurchaseOptionRequest": { "$ref": "DeactivatePurchaseOptionRequest", "description": "Deactivates a purchase option. Once deactivated, the purchase option will become unavailable." }, "activatePurchaseOptionRequest": { "$ref": "ActivatePurchaseOptionRequest", "description": "Activates a purchase option. Once activated, the purchase option will be available." } }, "id": "UpdatePurchaseOptionStateRequest" }, "PointsDetails": { "type": "object", "description": "Details relating to any Play Points applied to an order.", "properties": { "pointsOfferId": { "description": "ID unique to the play points offer in use for this order.", "type": "string" }, "pointsSpent": { "description": "The number of Play Points applied in this order. E.g. for a 100 points for $2 coupon, this is 100. For coupon stacked with base offer, this is the total points spent across both.", "format": "int64", "type": "string" }, "pointsCouponValue": { "description": "The monetary value of a Play Points coupon. This is the discount the coupon provides, which may not be the total amount. Only set when Play Points coupons have been used. E.g. for a 100 points for $2 coupon, this is $2.", "$ref": "Money" }, "pointsDiscountRateMicros": { "description": "The percentage rate which the Play Points promotion reduces the cost by. E.g. for a 100 points for $2 coupon, this is 500,000. Since $2 has an estimate of 200 points, but the actual Points required, 100, is 50% of this, and 50% in micros is 500,000. Between 0 and 1,000,000.", "type": "string", "format": "int64" } }, "id": "PointsDetails" }, "UsesConfiguration": { "description": "Represents all configurations marked as required by use of the uses-configuration manifest tag.", "id": "UsesConfiguration", "properties": { "requiredNavigationType": { "enumDescriptions": [ "Unspecified navigation type.", "Undefined navigation type.", "No navigation.", "Dpad navigation.", "Trackball navigation.", "Wheel navigation." ], "description": "The navigation device required.", "type": "string", "enum": [ "NAVIGATION_TYPE_UNSPECIFIED", "NAVIGATION_TYPE_UNDEFINED", "NAVIGATION_TYPE_NO_NAVIGATION", "NAVIGATION_TYPE_DPAD", "NAVIGATION_TYPE_TRACKBALL", "NAVIGATION_TYPE_WHEEL" ] }, "requiresFiveWayNavigation": { "type": "boolean", "description": "Whether or not the application requires a five-way navigation control." }, "requiredKeyboardType": { "type": "string", "enum": [ "KEYBOARD_TYPE_UNSPECIFIED", "KEYBOARD_TYPE_UNDEFINED", "KEYBOARD_TYPE_NO_KEYS", "KEYBOARD_TYPE_QWERTY", "KEYBOARD_TYPE_TWELVE_KEY" ], "enumDescriptions": [ "Unspecified keyboard type.", "Undefined keyboard type.", "No keys keyboard.", "Qwerty keyboard.", "Twelve key keyboard." ], "description": "The type of keyboard required." }, "requiresHardwareKeyboard": { "description": "Whether or not the application requires a hardware keyboard.", "type": "boolean" }, "requiredTouchscreenType": { "enumDescriptions": [ "Unspecified touchscreen type.", "Undefined touchscreen type.", "No touchscreen.", "Stylus touchscreen.", "Finger touchscreen." ], "type": "string", "enum": [ "TOUCHSCREEN_TYPE_UNSPECIFIED", "TOUCHSCREEN_TYPE_UNDEFINED", "TOUCHSCREEN_TYPE_NO_TOUCHSCREEN", "TOUCHSCREEN_TYPE_STYLUS", "TOUCHSCREEN_TYPE_FINGER" ], "description": "The type of touchscreen required." } }, "type": "object" }, "ReleaseSummary": { "type": "object", "id": "ReleaseSummary", "description": "Summary of a release.", "properties": { "track": { "description": "Identifier for the track. [Learn more about track names.](https://developers.google.com/android-publisher/tracks).", "type": "string" }, "releaseLifecycleState": { "enumDescriptions": [ "Not specified.", "The release is not yet ready and can still be edited.", "The release is ready to be sent for review and an action is required from developer", "Submitted and in review", "Passed review and is ready to be published manually by developer", "App was rejected in review", "Available to users on the track. This includes fully- or partially-rolled out releases and any halted release that can be resumed." ], "type": "string", "enum": [ "RELEASE_LIFECYCLE_STATE_UNSPECIFIED", "RELEASE_LIFECYCLE_STATE_DRAFT", "RELEASE_LIFECYCLE_STATE_NOT_SENT_FOR_REVIEW", "RELEASE_LIFECYCLE_STATE_IN_REVIEW", "RELEASE_LIFECYCLE_STATE_APPROVED_NOT_PUBLISHED", "RELEASE_LIFECYCLE_STATE_NOT_APPROVED", "RELEASE_LIFECYCLE_STATE_PUBLISHED" ], "description": "The lifecycle state of a release." }, "releaseName": { "description": "Name of the release.", "type": "string" }, "activeArtifacts": { "type": "array", "description": "List of active artifacts on this release", "items": { "$ref": "ArtifactSummary" } } } }, "AddTargetingRequest": { "id": "AddTargetingRequest", "type": "object", "properties": { "targetingUpdate": { "description": "Specifies targeting updates such as regions, android sdk versions etc.", "$ref": "TargetingUpdate" } }, "description": "Request message for AddTargeting." }, "InappproductsBatchDeleteRequest": { "properties": { "requests": { "type": "array", "description": "Individual delete requests. At least one request is required. Can contain up to 100 requests. All requests must correspond to different in-app products.", "items": { "$ref": "InappproductsDeleteRequest" } } }, "type": "object", "id": "InappproductsBatchDeleteRequest", "description": "Request to delete multiple in-app products." }, "DeviceId": { "properties": { "buildBrand": { "description": "Value of Build.BRAND.", "type": "string" }, "buildDevice": { "description": "Value of Build.DEVICE.", "type": "string" } }, "description": "Identifier of a device.", "type": "object", "id": "DeviceId" }, "RentalDetails": { "description": "Details of a rental purchase.", "properties": {}, "type": "object", "id": "RentalDetails" }, "BatchGetOneTimeProductOffersResponse": { "type": "object", "id": "BatchGetOneTimeProductOffersResponse", "properties": { "oneTimeProductOffers": { "description": "The list of updated one-time product offers, in the same order as the request.", "type": "array", "items": { "$ref": "OneTimeProductOffer" } } }, "description": "Response message for the BatchGetOneTimeProductOffers endpoint." }, "FreeTrialDetails": { "description": "Details of a free trial pricing phase.", "properties": {}, "id": "FreeTrialDetails", "type": "object" }, "OutOfAppPurchaseContext": { "properties": { "expiredExternalAccountIdentifiers": { "$ref": "ExternalAccountIdentifiers", "description": "User account identifier from the last expired subscription for this SKU." }, "expiredPurchaseToken": { "description": "The purchase token of the last expired subscription. This purchase token must only be used to help identify the user if the link between the purchaseToken and user is stored in your database. This cannot be used to call the Google Developer API if it has been more than 60 days since expiry.", "type": "string" } }, "id": "OutOfAppPurchaseContext", "description": "Information specific to an out of app purchase.", "type": "object" }, "MultiAbi": { "description": "Represents a list of ABIs.", "properties": { "abi": { "type": "array", "items": { "$ref": "Abi" }, "description": "A list of targeted ABIs, as represented by the Android Platform" } }, "id": "MultiAbi", "type": "object" }, "BatchGetOneTimeProductsResponse": { "properties": { "oneTimeProducts": { "type": "array", "items": { "$ref": "OneTimeProduct" }, "description": "The list of requested one-time products, in the same order as the request." } }, "description": "Response message for the BatchGetOneTimeProducts endpoint.", "type": "object", "id": "BatchGetOneTimeProductsResponse" }, "PurchaseStateContext": { "type": "object", "properties": { "purchaseState": { "type": "string", "readOnly": true, "description": "Output only. The purchase state of the purchase.", "enumDescriptions": [ "Purchase state unspecified. This value should never be set.", "Purchased successfully.", "Purchase canceled.", "The purchase is in a pending state and has not yet been completed. For more information on handling pending purchases, see https://developer.android.com/google/play/billing/integrate#pending." ], "enum": [ "PURCHASE_STATE_UNSPECIFIED", "PURCHASED", "CANCELLED", "PENDING" ] } }, "description": "Context about the purchase state.", "id": "PurchaseStateContext" }, "IntroductoryPriceOfferPhase": { "id": "IntroductoryPriceOfferPhase", "type": "object", "properties": {}, "description": "Details about introductory price offer phase." }, "ProductPurchase": { "id": "ProductPurchase", "description": "A ProductPurchase resource indicates the status of a user's inapp product purchase.", "properties": { "orderId": { "description": "The order id associated with the purchase of the inapp product.", "type": "string" }, "kind": { "description": "This kind represents an inappPurchase object in the androidpublisher service.", "type": "string" }, "purchaseToken": { "type": "string", "description": "The purchase token generated to identify this purchase. May not be present." }, "quantity": { "description": "The quantity associated with the purchase of the inapp product. If not present, the quantity is 1.", "type": "integer", "format": "int32" }, "purchaseTimeMillis": { "description": "The time the product was purchased, in milliseconds since the epoch (Jan 1, 1970).", "format": "int64", "type": "string" }, "developerPayload": { "description": "A developer-specified string that contains supplemental information about an order.", "type": "string" }, "obfuscatedExternalProfileId": { "description": "An obfuscated version of the id that is uniquely associated with the user's profile in your app. Only present if specified using https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid when the purchase was made.", "type": "string" }, "productId": { "description": "The inapp product SKU. May not be present.", "type": "string" }, "purchaseState": { "type": "integer", "format": "int32", "description": "The purchase state of the order. Possible values are: 0. Purchased 1. Canceled 2. Pending" }, "refundableQuantity": { "description": "The quantity eligible for refund, i.e. quantity that hasn't been refunded. The value reflects quantity-based partial refunds and full refunds.", "format": "int32", "type": "integer" }, "acknowledgementState": { "format": "int32", "type": "integer", "description": "The acknowledgement state of the inapp product. Possible values are: 0. Yet to be acknowledged 1. Acknowledged" }, "obfuscatedExternalAccountId": { "description": "An obfuscated version of the id that is uniquely associated with the user's account in your app. Only present if specified using https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid when the purchase was made.", "type": "string" }, "consumptionState": { "type": "integer", "format": "int32", "description": "The consumption state of the inapp product. Possible values are: 0. Yet to be consumed 1. Consumed" }, "regionCode": { "type": "string", "description": "ISO 3166-1 alpha-2 billing region code of the user at the time the product was granted." }, "purchaseType": { "format": "int32", "description": "The type of purchase of the inapp product. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: 0. Test (i.e. purchased from a license testing account) 1. Promo (i.e. purchased using a promo code). Does not include Play Points purchases. 2. Rewarded (i.e. from watching a video ad instead of paying)", "type": "integer" } }, "type": "object" }, "UserCountrySet": { "properties": { "countryCodes": { "type": "array", "items": { "type": "string" }, "description": "List of country codes representing countries. A Country code is represented in ISO 3166 alpha-2 format. For Example:- \"IT\" for Italy, \"GE\" for Georgia." }, "name": { "description": "Country set name.", "type": "string" } }, "id": "UserCountrySet", "description": "A set of user countries. A country set determines what variation of app content gets served to a specific location.", "type": "object" }, "BatchUpdateOneTimeProductsResponse": { "description": "Response message for BatchUpdateOneTimeProduct.", "properties": { "oneTimeProducts": { "description": "The list of updated one-time products list, in the same order as the request.", "type": "array", "items": { "$ref": "OneTimeProduct" } } }, "type": "object", "id": "BatchUpdateOneTimeProductsResponse" }, "AppStoreAppStoreListing": { "type": "object", "properties": { "appName": { "type": "string", "description": "Required. The title of the app." }, "appIconId": { "description": "Required. Image ID generated from UploadImage for the main app icon.", "type": "string" }, "videoLink": { "description": "Optional. Link to a video about the app.", "type": "string" }, "shortDescription": { "description": "Optional. Quick summary about the app.", "type": "string" }, "screenshotId": { "type": "array", "items": { "type": "string" }, "description": "Required. Multiple image IDs for screenshot galleries." }, "languageCode": { "type": "string", "description": "Required. Language code (e.g., \"en-US\") of the listing." }, "fullDescription": { "description": "Required. Comprehensive description text about the app.", "type": "string" } }, "description": "A localized store listing. These are the details about the app as shown in your app store.", "id": "AppStoreAppStoreListing" }, "PreorderDetails": { "description": "Details of a pre-order purchase.", "properties": {}, "id": "PreorderDetails", "type": "object" }, "OneTimeProductPurchaseOption": { "type": "object", "id": "OneTimeProductPurchaseOption", "properties": { "offerTags": { "items": { "$ref": "OfferTag" }, "description": "Optional. List of up to 20 custom tags specified for this purchase option, and returned to the app through the billing library. Offers for this purchase option will also receive these tags in the billing library.", "type": "array" }, "regionalPricingAndAvailabilityConfigs": { "items": { "$ref": "OneTimeProductPurchaseOptionRegionalPricingAndAvailabilityConfig" }, "type": "array", "description": "Regional pricing and availability information for this purchase option." }, "rentOption": { "description": "A purchase option that can be rented.", "$ref": "OneTimeProductRentPurchaseOption" }, "taxAndComplianceSettings": { "description": "Optional. Details about taxes and legal compliance.", "$ref": "PurchaseOptionTaxAndComplianceSettings" }, "state": { "enum": [ "STATE_UNSPECIFIED", "DRAFT", "ACTIVE", "INACTIVE", "INACTIVE_PUBLISHED" ], "readOnly": true, "description": "Output only. The state of the purchase option, i.e., whether it's active. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.", "enumDescriptions": [ "Default value, should never be used.", "The purchase option is not and has never been available to users.", "The purchase option is available to users.", "The purchase option is not available to users anymore.", "The purchase option is not available for purchase anymore, but we continue to expose its offer via the Play Billing Library for backwards compatibility. Only automatically migrated purchase options can be in this state." ], "type": "string" }, "purchaseOptionId": { "description": "Required. Immutable. The unique identifier of this purchase option. Must be unique within the one-time product. It must start with a number or lower-case letter, and can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-). The maximum length is 63 characters.", "type": "string" }, "newRegionsConfig": { "description": "Pricing information for any new locations Play may launch in the future. If omitted, the purchase option will not be automatically available in any new locations Play may launch in the future.", "$ref": "OneTimeProductPurchaseOptionNewRegionsConfig" }, "buyOption": { "description": "A purchase option that can be bought.", "$ref": "OneTimeProductBuyPurchaseOption" } }, "description": "A single purchase option for a one-time product." }, "BatchUpdateSubscriptionOffersResponse": { "type": "object", "properties": { "subscriptionOffers": { "items": { "$ref": "SubscriptionOffer" }, "description": "The updated subscription offers list.", "type": "array" } }, "description": "Response message for BatchUpdateSubscriptionOffers.", "id": "BatchUpdateSubscriptionOffersResponse" }, "TrackTargetedCountry": { "description": "Representation of a single country where the contents of a track can be made available.", "type": "object", "id": "TrackTargetedCountry", "properties": { "countryCode": { "type": "string", "description": "The country that can be targeted, as a two-letter CLDR code." } } }, "ConvertRegionPricesResponse": { "type": "object", "properties": { "convertedRegionPrices": { "additionalProperties": { "$ref": "ConvertedRegionPrice" }, "type": "object", "description": "Map from region code to converted region price." }, "regionVersion": { "description": "The region version at which the prices were generated.", "$ref": "RegionsVersion" }, "convertedOtherRegionsPrice": { "$ref": "ConvertedOtherRegionsPrice", "description": "Converted other regions prices in USD and EUR, to use for countries where Play doesn't support a country's local currency." } }, "description": "Response message for ConvertRegionPrices.", "id": "ConvertRegionPricesResponse" }, "UploadImageResponse": { "id": "UploadImageResponse", "type": "object", "properties": { "imageId": { "type": "string", "description": "The unique ID of the uploaded image." } }, "description": "Response for uploading an image." }, "CatalogPermission": { "type": "object", "id": "CatalogPermission", "properties": { "name": { "description": "The `name` attribute indicating the permission name.", "type": "string" }, "maxSdkVersion": { "description": "The `maxSdkVersion` attribute indicating up to which Android SDK version the permission is requested.", "format": "int32", "type": "integer" } }, "description": "A permission declared by an app." }, "ConvertedOtherRegionsPrice": { "type": "object", "id": "ConvertedOtherRegionsPrice", "description": "Converted other regions prices.", "properties": { "eurPrice": { "description": "Price in EUR to use for the \"Other regions\" location exclusive of taxes.", "$ref": "Money" }, "usdPrice": { "description": "Price in USD to use for the \"Other regions\" location exclusive of taxes.", "$ref": "Money" } } }, "DeferredItemReplacement": { "id": "DeferredItemReplacement", "description": "Information related to deferred item replacement.", "type": "object", "properties": { "productId": { "description": "The product_id going to replace the existing product_id.", "type": "string" } } }, "Date": { "type": "object", "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp", "properties": { "month": { "type": "integer", "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "format": "int32" }, "year": { "format": "int32", "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "type": "integer" }, "day": { "type": "integer", "format": "int32", "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant." } }, "id": "Date" }, "CancelSubscriptionPurchaseRequest": { "properties": { "cancellationContext": { "description": "Required. Additional details around the subscription revocation.", "$ref": "CancellationContext" } }, "id": "CancelSubscriptionPurchaseRequest", "type": "object", "description": "Request for the purchases.subscriptionsv2.cancel API." }, "CatalogSdkVersion": { "id": "CatalogSdkVersion", "description": "Defines a range of SDK versions. A device is considered compatible uf its\\ SDK version falls within the min_sdk_version and max_sdk_version range.", "properties": { "targetSdkVersion": { "format": "int64", "type": "string", "description": "The target SDK version for the app." }, "minSdkVersion": { "type": "string", "format": "int64", "description": "The minimum SDK version required for the app (inclusive)." }, "maxSdkVersion": { "format": "int64", "type": "string", "description": "The maximum SDK version required for the app (inclusive)." } }, "type": "object" }, "RenewalDeclinedContext": { "properties": { "pendingOrderId": { "description": "Required. The ID of the pending or failed order causing the state.", "type": "string" } }, "description": "Context related to renewal declined scenario.", "id": "RenewalDeclinedContext", "type": "object" }, "TokenPagination": { "description": "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.", "properties": { "nextPageToken": { "description": "Tokens to pass to the standard list field 'page_token'. Whenever available, tokens are preferred over manipulating start_index.", "type": "string" }, "previousPageToken": { "type": "string" } }, "id": "TokenPagination", "type": "object" }, "ExternalTransaction": { "properties": { "currentTaxAmount": { "readOnly": true, "description": "Output only. The current tax amount. This represents the current tax amount including any refunds that may have been applied to this transaction.", "$ref": "Price" }, "externalContentLinkDetails": { "description": "Optional. Details necessary to accurately report external content link transactions.", "$ref": "ExternalContentLinkDetails" }, "oneTimeTransaction": { "$ref": "OneTimeExternalTransaction", "description": "This is a one-time transaction and not part of a subscription." }, "originalTaxAmount": { "description": "Required. The original tax amount. This represents the tax amount originally notified to Google before any refunds were applied.", "$ref": "Price" }, "transactionTime": { "type": "string", "format": "google-datetime", "description": "Required. The time when the transaction was completed." }, "originalPreTaxAmount": { "description": "Required. The original transaction amount before taxes. This represents the pre-tax amount originally notified to Google before any refunds were applied.", "$ref": "Price" }, "transactionProgramCode": { "type": "integer", "format": "int32", "description": "Optional. The transaction program code, used to help determine service fee for eligible apps participating in partner programs. Developers participating in the Play Media Experience Program (https://play.google.com/console/about/programs/mediaprogram/) must provide the program code when reporting alternative billing transactions. If you are an eligible developer, please contact your BDM for more information on how to set this field. Note: this field can not be used for external offers transactions." }, "currentPreTaxAmount": { "readOnly": true, "description": "Output only. The current transaction amount before tax. This represents the current pre-tax amount including any refunds that may have been applied to this transaction.", "$ref": "Price" }, "externalTransactionId": { "type": "string", "readOnly": true, "description": "Output only. The id of this transaction. All transaction ids under the same package name must be unique. Set when creating the external transaction." }, "packageName": { "description": "Output only. The resource name of the external transaction. The package name of the application the inapp products were sold (for example, 'com.some.app').", "type": "string", "readOnly": true }, "externalOfferDetails": { "$ref": "ExternalOfferDetails", "description": "Optional. Details necessary to accurately report external offers transactions." }, "createTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. The time when this transaction was created. This is the time when Google was notified of the transaction.", "type": "string" }, "recurringTransaction": { "description": "This transaction is part of a recurring series of transactions.", "$ref": "RecurringExternalTransaction" }, "transactionState": { "description": "Output only. The current state of the transaction.", "readOnly": true, "enum": [ "TRANSACTION_STATE_UNSPECIFIED", "TRANSACTION_REPORTED", "TRANSACTION_CANCELED" ], "enumDescriptions": [ "Unspecified transaction state. Not used.", "The transaction has been successfully reported to Google.", "The transaction has been fully refunded." ], "type": "string" }, "userTaxAddress": { "description": "Required. User address for tax computation.", "$ref": "ExternalTransactionAddress" }, "testPurchase": { "$ref": "ExternalTransactionTestPurchase", "description": "Output only. If set, this transaction was a test purchase. Google will not charge for a test transaction.", "readOnly": true } }, "description": "The details of an external transaction.", "type": "object", "id": "ExternalTransaction" }, "OneTimePurchaseDetails": { "type": "object", "properties": { "rentalDetails": { "description": "The details of a rent purchase. Only set if it is a rent purchase.", "$ref": "RentalDetails" }, "preorderDetails": { "$ref": "PreorderDetails", "description": "The details of a pre-order purchase. Only set if it is a pre-order purchase. Note that this field will be set even after pre-order is fulfilled." }, "quantity": { "description": "The number of items purchased (for multi-quantity item purchases).", "type": "integer", "format": "int32" }, "offerId": { "description": "The offer ID of the one-time purchase offer.", "type": "string" }, "purchaseOptionId": { "type": "string", "description": "ID of the purchase option. This field is set for both purchase options and variant offers. For purchase options, this ID identifies the purchase option itself. For variant offers, this ID refers to the associated purchase option, and in conjunction with offer_id it identifies the variant offer." } }, "id": "OneTimePurchaseDetails", "description": "Details of a one-time purchase." }, "BatchGetSubscriptionsResponse": { "type": "object", "properties": { "subscriptions": { "description": "The list of requested subscriptions, in the same order as the request.", "type": "array", "items": { "$ref": "Subscription" } } }, "description": "Response message for BatchGetSubscriptions endpoint.", "id": "BatchGetSubscriptionsResponse" }, "UpdateSubscriptionRequest": { "type": "object", "id": "UpdateSubscriptionRequest", "description": "Request message for UpdateSubscription.", "properties": { "allowMissing": { "type": "boolean", "description": "Optional. If set to true, and the subscription with the given package_name and product_id doesn't exist, the subscription will be created. If a new subscription is created, update_mask is ignored." }, "updateMask": { "type": "string", "description": "Required. The list of fields to be updated.", "format": "google-fieldmask" }, "regionsVersion": { "description": "Required. The version of the available regions being used for the subscription.", "$ref": "RegionsVersion" }, "latencyTolerance": { "enumDescriptions": [ "Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.", "The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.", "The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods." ], "type": "string", "enum": [ "PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT" ], "description": "Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive." }, "subscription": { "description": "Required. The subscription to update.", "$ref": "Subscription" } } }, "TargetingInfo": { "properties": { "assetSliceSet": { "items": { "$ref": "AssetSliceSet" }, "description": "List of created asset slices.", "type": "array" }, "variant": { "description": "List of the created variants.", "items": { "$ref": "SplitApkVariant" }, "type": "array" }, "packageName": { "description": "The package name of this app.", "type": "string" } }, "id": "TargetingInfo", "description": "Targeting information about the generated apks.", "type": "object" }, "OneTimeProductOfferNoPriceOverrideOptions": { "description": "Options for one-time product offers without a regional price override.", "type": "object", "properties": {}, "id": "OneTimeProductOfferNoPriceOverrideOptions" }, "AppVersionRange": { "id": "AppVersionRange", "type": "object", "description": "Data format for a continuous range of app versions.", "properties": { "versionCodeEnd": { "description": "Highest app version in the range, inclusive.", "format": "int64", "type": "string" }, "versionCodeStart": { "description": "Lowest app version in the range, inclusive.", "format": "int64", "type": "string" } } }, "InGracePeriodStateContext": { "type": "object", "description": "Additional context around subscriptions in IN_GRACE_PERIOD state.", "properties": { "renewalDeclined": { "$ref": "RenewalDeclinedContext", "description": "Optional. The payment for the renewal was declined." } }, "id": "InGracePeriodStateContext" }, "Subscription": { "properties": { "basePlans": { "items": { "$ref": "BasePlan" }, "description": "The set of base plans for this subscription. Represents the prices and duration of the subscription if no other offers apply.", "type": "array" }, "restrictedPaymentCountries": { "$ref": "RestrictedPaymentCountries", "description": "Optional. Countries where the purchase of this subscription is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed." }, "packageName": { "description": "Immutable. Package name of the parent app.", "type": "string" }, "listings": { "type": "array", "items": { "$ref": "SubscriptionListing" }, "description": "Required. List of localized listings for this subscription. Must contain at least an entry for the default language of the parent app." }, "productId": { "description": "Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length.", "type": "string" }, "archived": { "type": "boolean", "readOnly": true, "deprecated": true, "description": "Output only. Deprecated: subscription archiving is not supported." }, "taxAndComplianceSettings": { "$ref": "SubscriptionTaxAndComplianceSettings", "description": "Details about taxes and legal compliance." } }, "description": "A single subscription for an app.", "id": "Subscription", "type": "object" }, "BatchUpdateOneTimeProductOffersRequest": { "id": "BatchUpdateOneTimeProductOffersRequest", "properties": { "requests": { "description": "Required. A list of update requests of up to 100 elements. All requests must update different offers.", "type": "array", "items": { "$ref": "UpdateOneTimeProductOfferRequest" } } }, "type": "object", "description": "Request message for BatchUpdateOneTimeProductOffers." }, "SubscriptionPurchasesDeferRequest": { "description": "Request for the purchases.subscriptions.defer API.", "id": "SubscriptionPurchasesDeferRequest", "properties": { "deferralInfo": { "$ref": "SubscriptionDeferralInfo", "description": "The information about the new desired expiry time for the subscription." } }, "type": "object" }, "TargetingRuleScopeAnySubscriptionInApp": { "type": "object", "id": "TargetingRuleScopeAnySubscriptionInApp", "properties": {}, "description": "Represents the targeting rule scope corresponding to any subscription in the parent app." }, "RevocationContextItemBasedRefund": { "description": "Used to determine what specific item to revoke in a subscription with multiple items.", "type": "object", "id": "RevocationContextItemBasedRefund", "properties": { "productId": { "type": "string", "description": "Required. If the subscription is a subscription with add-ons, the product id of the subscription item to revoke." } } }, "ExternalAccountIdentifiers": { "id": "ExternalAccountIdentifiers", "description": "User account identifier in the third-party service.", "properties": { "externalAccountId": { "type": "string", "description": "User account identifier in the third-party service. Only present if account linking happened as part of the subscription purchase flow." }, "obfuscatedExternalAccountId": { "type": "string", "description": "An obfuscated version of the id that is uniquely associated with the user's account in your app. Present for the following purchases: * If account linking happened as part of the subscription purchase flow. * It was specified using https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid when the purchase was made." }, "obfuscatedExternalProfileId": { "description": "An obfuscated version of the id that is uniquely associated with the user's profile in your app. Only present if specified using https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid when the purchase was made.", "type": "string" } }, "type": "object" }, "User": { "properties": { "name": { "description": "Required. Resource name for this user, following the pattern \"developers/{developer}/users/{email}\".", "type": "string" }, "expirationTime": { "format": "google-datetime", "description": "The time at which the user's access expires, if set. When setting this value, it must always be in the future.", "type": "string" }, "email": { "description": "Immutable. The user's email address.", "type": "string" }, "accessState": { "enum": [ "ACCESS_STATE_UNSPECIFIED", "INVITED", "INVITATION_EXPIRED", "ACCESS_GRANTED", "ACCESS_EXPIRED" ], "readOnly": true, "description": "Output only. The state of the user's access to the Play Console.", "enumDescriptions": [ "Unknown or unspecified access state.", "User is invited but has not yet accepted the invitation.", "Invitation has expired.", "User has accepted an invitation and has access to the Play Console.", "Account access has expired." ], "type": "string" }, "developerAccountPermissions": { "items": { "enumDescriptions": [ "Unknown or unspecified permission.", "View app information and download bulk reports (read-only). Deprecated: Check CAN_VIEW_NON_FINANCIAL_DATA_GLOBAL.", "View financial data, orders, and cancellation survey responses.", "Admin (all permissions).", "Edit Play Games Services projects.", "Publish Play Games Services projects.", "Reply to reviews.", "Release to production, exclude devices, and use app signing by Google Play.", "Release to testing tracks.", "Manage testing tracks and edit tester lists.", "Manage store presence.", "Create, edit, and delete draft apps.", "Create and publish private apps to your organization.", "Deprecated: This permission is no longer supported. Choose whether apps are public, or only available to your organization.", "Manage orders and subscriptions.", "Manage policy related pages on all apps for the developer.", "View app information and download bulk reports (read-only).", "View app quality information for all apps for the developer.", "Manage the deep links setup for all apps for the developer.", "Allows viewing connected apps in the Google Play Console.", "Allows editing connected apps in the Google Play Console." ], "type": "string", "enum": [ "DEVELOPER_LEVEL_PERMISSION_UNSPECIFIED", "CAN_SEE_ALL_APPS", "CAN_VIEW_FINANCIAL_DATA_GLOBAL", "CAN_MANAGE_PERMISSIONS_GLOBAL", "CAN_EDIT_GAMES_GLOBAL", "CAN_PUBLISH_GAMES_GLOBAL", "CAN_REPLY_TO_REVIEWS_GLOBAL", "CAN_MANAGE_PUBLIC_APKS_GLOBAL", "CAN_MANAGE_TRACK_APKS_GLOBAL", "CAN_MANAGE_TRACK_USERS_GLOBAL", "CAN_MANAGE_PUBLIC_LISTING_GLOBAL", "CAN_MANAGE_DRAFT_APPS_GLOBAL", "CAN_CREATE_MANAGED_PLAY_APPS_GLOBAL", "CAN_CHANGE_MANAGED_PLAY_SETTING_GLOBAL", "CAN_MANAGE_ORDERS_GLOBAL", "CAN_MANAGE_APP_CONTENT_GLOBAL", "CAN_VIEW_NON_FINANCIAL_DATA_GLOBAL", "CAN_VIEW_APP_QUALITY_GLOBAL", "CAN_MANAGE_DEEPLINKS_GLOBAL", "CAN_VIEW_CONNECTED_APPS_GLOBAL", "CAN_EDIT_CONNECTED_APPS_GLOBAL" ], "enumDeprecated": [ false, true, false, false, false, false, false, false, false, false, false, false, false, true, false, false, false, false, false, false, false ] }, "description": "Permissions for the user which apply across the developer account.", "type": "array" }, "grants": { "items": { "$ref": "Grant" }, "readOnly": true, "description": "Output only. Per-app permissions for the user.", "type": "array" }, "partial": { "type": "boolean", "readOnly": true, "description": "Output only. Whether there are more permissions for the user that are not represented here. This can happen if the caller does not have permission to manage all apps in the account. This is also `true` if this user is the account owner. If this field is `true`, it should be taken as a signal that this user cannot be fully managed via the API. That is, the API caller is not be able to manage all of the permissions this user holds, either because it doesn't know about them or because the user is the account owner." } }, "id": "User", "description": "A user resource.", "type": "object" }, "TrackRelease": { "description": "A release within a track.", "type": "object", "id": "TrackRelease", "properties": { "releaseNotes": { "items": { "$ref": "LocalizedText" }, "description": "A description of what is new in this release.", "type": "array" }, "status": { "description": "The status of the release.", "enumDescriptions": [ "Unspecified status.", "The release's APKs are not being served to users.", "The release's APKs are being served to a fraction of users, determined by 'user_fraction'.", "The release's APKs will no longer be served to users. Users who already have these APKs are unaffected.", "The release will have no further changes. Its APKs are being served to all users, unless they are eligible to APKs of a more recent release." ], "type": "string", "enum": [ "statusUnspecified", "draft", "inProgress", "halted", "completed" ] }, "name": { "type": "string", "description": "The release name. Not required to be unique. If not set, the name is generated from the APK's version_name. If the release contains multiple APKs, the name is generated from the date." }, "userFraction": { "format": "double", "type": "number", "description": "Fraction of users who are eligible for a staged release. 0 \u003c fraction \u003c 1. Can only be set when status is \"inProgress\" or \"halted\"." }, "inAppUpdatePriority": { "format": "int32", "type": "integer", "description": "In-app update priority of the release. All newly added APKs in the release will be considered at this priority. Can take values in the range [0, 5], with 5 the highest priority. Defaults to 0. in_app_update_priority can not be updated once the release is rolled out. See https://developer.android.com/guide/playcore/in-app-updates." }, "countryTargeting": { "description": "Restricts a release to a specific set of countries. Note this is only allowed to be set for inProgress releases in the production track.", "$ref": "CountryTargeting" }, "versionCodes": { "description": "Version codes of all APKs in the release. Must include version codes to retain from previous releases.", "items": { "format": "int64", "type": "string" }, "type": "array" } } }, "OrdersReviewRefundRequest": { "type": "object", "id": "OrdersReviewRefundRequest", "description": "Request for the orders.reviewrefund API.", "properties": { "pendingRefundToken": { "type": "string", "description": "Required. The pending refund token included in the pending refund review notification." }, "consumptionPercentageMilliunits": { "format": "int32", "description": "Optional. Percentage of the In-App purchase the customer consumed, in milliunits. Minimum: 0 Maximum: 100,000. For paid apps, this can be omitted. Example : 45200 represents 45.2%.", "type": "integer" }, "sampleContentProvided": { "type": "boolean", "description": "Required. Indicates whether you provided a free sample, trial, or information about the functionality prior to the purchase." }, "refundPreference": { "description": "Required. Indicates your preference, based on your operational logic, as to whether the Play Store should grant the refund.", "type": "string", "enum": [ "REFUND_PREFERENCE_UNSPECIFIED", "DECLINE", "APPROVE", "NEUTRAL" ], "enumDescriptions": [ "Refund preference unspecified. This value is not used.", "Developer prefers that Play declines the refund.", "Developer prefers that Play grants the refund in full.", "Developer has no preference about Google Play's decision to issue a refund" ] }, "consumptionUsageEvents": { "items": { "$ref": "ConsumptionUsageEvent" }, "description": "Optional. List of events, each representing an instance where the user consumed or used the purchased item or service. Lists with over 1000 items will be rejected.", "type": "array" } } }, "DeferredItemRemoval": { "id": "DeferredItemRemoval", "properties": {}, "description": "Information related to deferred item replacement.", "type": "object" }, "InappproductsListResponse": { "id": "InappproductsListResponse", "properties": { "kind": { "description": "The kind of this response (\"androidpublisher#inappproductsListResponse\").", "type": "string" }, "inappproduct": { "type": "array", "description": "All in-app products.", "items": { "$ref": "InAppProduct" } }, "tokenPagination": { "description": "Pagination token, to handle a number of products that is over one page.", "$ref": "TokenPagination" }, "pageInfo": { "$ref": "PageInfo", "description": "Deprecated and unset.", "deprecated": true } }, "description": "Response listing all in-app products.", "type": "object" }, "AbiTargeting": { "id": "AbiTargeting", "type": "object", "properties": { "value": { "type": "array", "description": "Value of an abi.", "items": { "$ref": "Abi" } }, "alternatives": { "type": "array", "description": "Targeting of other sibling directories that were in the Bundle. For main splits this is targeting of other main splits.", "items": { "$ref": "Abi" } } }, "description": "Targeting based on Abi." }, "KeyedGroup": { "id": "KeyedGroup", "description": "A group of responses, with a key.", "type": "object", "properties": { "key": { "type": "string", "description": "Required. Key for this group." }, "responses": { "items": { "$ref": "NestedPolicyResponse" }, "description": "Required. Responses in this group.", "type": "array" } } }, "RevocationContext": { "id": "RevocationContext", "type": "object", "properties": { "fullRefund": { "description": "Optional. Used when users should be refunded the full amount of latest charge on each item in the subscription.", "$ref": "RevocationContextFullRefund" }, "proratedRefund": { "$ref": "RevocationContextProratedRefund", "description": "Optional. Used when users should be refunded a prorated amount they paid for their subscription based on the amount of time remaining in a subscription." }, "itemBasedRefund": { "$ref": "RevocationContextItemBasedRefund", "description": "Optional. Used when a specific item should be refunded in a subscription with add-on items." } }, "description": "Revocation context of the purchases.subscriptionsv2.revoke API." }, "Price": { "type": "object", "description": "Definition of a price, i.e. currency and units.", "id": "Price", "properties": { "priceMicros": { "description": "Price in 1/million of the currency base unit, represented as a string.", "type": "string" }, "currency": { "description": "3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java", "type": "string" } } }, "AutoRenewingPlan": { "properties": { "autoRenewEnabled": { "description": "If the subscription is currently set to auto-renew, e.g. the user has not canceled the subscription", "type": "boolean" }, "priceChangeDetails": { "$ref": "SubscriptionItemPriceChangeDetails", "description": "The information of the last price change for the item since subscription signup." }, "installmentDetails": { "description": "The installment plan commitment and state related info for the auto renewing plan.", "$ref": "InstallmentPlan" }, "recurringPrice": { "$ref": "Money", "description": "The current recurring price of the auto renewing plan. Note that the price does not take into account discounts and does not include taxes. For tax-exclusive pricing, please call orders.get API instead if transaction details are needed." }, "priceStepUpConsentDetails": { "description": "The information of the latest price step-up consent.", "$ref": "PriceStepUpConsentDetails" } }, "description": "Information related to an auto renewing plan.", "id": "AutoRenewingPlan", "type": "object" }, "ProrationPeriodDetails": { "id": "ProrationPeriodDetails", "properties": { "originalOfferPhase": { "type": "string", "enum": [ "OFFER_PHASE_UNSPECIFIED", "BASE", "INTRODUCTORY", "FREE_TRIAL" ], "description": "Represent the original offer phase from the purchased the line item if the proration period contains any of them. For example, a proration period from CHARGE_FULL_PRICE plan change may merge the 1st offer phase of the subscription offer of the new product user purchased. In this case, the original offer phase will be set here.", "enumDescriptions": [ "Offer phase unspecified. This value is not used.", "The order funds a base price period.", "The order funds an introductory pricing period.", "The order funds a free trial period." ] } }, "type": "object", "description": "Details of a proration period. A proration period can be a period calculated during a plan change to cover existing entitlements (For more information, see [Allow users to upgrade, downgrade, or change their subscription](https://developer.android.com/google/play/billing/subscriptions#allow-users-change), or a prorated period to align add-on renewal dates with the base (For more information, see [Rules applicable for items in the purchase](https://developer.android.com/google/play/billing/subscription-with-addons#rules-base-addons))." }, "CloudKmsKey": { "properties": { "cryptoKeyVersionResource": { "type": "string", "description": "Required. Resource identifier of the private key hosted in Google Cloud KMS. The Google Play service account must be granted Decrypt and Sign permissions on this resource. Format: projects//locations//keyRings//cryptoKeys//cryptoKeyVersions/" } }, "type": "object", "description": "Reference to a private key hosted in developer-managed Google Cloud KMS.", "id": "CloudKmsKey" }, "Listing": { "type": "object", "id": "Listing", "properties": { "shortDescription": { "description": "Short description of the app.", "type": "string" }, "fullDescription": { "type": "string", "description": "Full description of the app." }, "language": { "type": "string", "description": "Language localization code (a BCP-47 language tag; for example, \"de-AT\" for Austrian German)." }, "title": { "description": "Localized title of the app.", "type": "string" }, "video": { "description": "URL of a promotional YouTube video for the app.", "type": "string" } }, "description": "A localized store listing. The resource for ListingsService." }, "VanityCode": { "id": "VanityCode", "type": "object", "description": "A multiple use, predefined promotion code.", "properties": { "promotionCode": { "description": "The promotion code.", "type": "string" } } }, "BatchUpdateSubscriptionOfferStatesRequest": { "type": "object", "description": "Request message for BatchUpdateSubscriptionOfferStates.", "properties": { "requests": { "items": { "$ref": "UpdateSubscriptionOfferStateRequest" }, "description": "Required. The update request list of up to 100 elements. All requests must update different offers.", "type": "array" } }, "id": "BatchUpdateSubscriptionOfferStatesRequest" }, "UpdateAppStoreHostedAppResponse": { "description": "Response for updating an app record for an app store hosted app.", "id": "UpdateAppStoreHostedAppResponse", "type": "object", "properties": { "updateId": { "type": "string", "description": "Unique identifier for the specific version of the hosted app submitted in this update. This identifier can be used to correlate publishing signals (such as those returned by ListHostedAppsPublishingSignals) with this specific app update." } } }, "BatchUpdateOneTimeProductsRequest": { "description": "Request message for BatchUpdateOneTimeProduct.", "properties": { "requests": { "type": "array", "items": { "$ref": "UpdateOneTimeProductRequest" }, "description": "Required. A list of update requests of up to 100 elements. All requests must update different one-time products." } }, "type": "object", "id": "BatchUpdateOneTimeProductsRequest" }, "ConsumptionUsageEvent": { "id": "ConsumptionUsageEvent", "properties": { "consumptionItemDescription": { "type": "string", "description": "Optional. Free form text that allows developers to provide more info on the item consumed. Maximum length is 5000 characters." }, "ipAddress": { "description": "Optional. The IP address from which the consumption occurred.", "type": "string" }, "obfuscatedProfileId": { "type": "string", "description": "Optional. Obfuscated string that is uniquely associated with the purchaser's user profile in the app. https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setObfuscatedProfileId(java.lang.String)" }, "location": { "$ref": "CoarseLocation", "description": "Optional. Geographic location where the consumption occurred." }, "consumptionTime": { "description": "Optional. Time when the user consumed, used, downloaded, opened, or streamed the content.", "format": "google-datetime", "type": "string" }, "obfuscatedAccountId": { "description": "Optional. Obfuscated string that is uniquely associated with the purchaser's user account in the app. https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setObfuscatedAccountId(java.lang.String)", "type": "string" } }, "description": "List of events, each representing an instance where the user consumed or used the purchased item or service.", "type": "object" }, "TestPurchaseContext": { "properties": { "fopType": { "type": "string", "enum": [ "FOP_TYPE_UNSPECIFIED", "TEST" ], "enumDescriptions": [ "Fop type unspecified. This value should never be set.", "The purchase was made using a test card." ], "description": "The fop type of the test purchase." } }, "id": "TestPurchaseContext", "description": "Context about a test purchase.", "type": "object" }, "BatchUpdateSubscriptionsRequest": { "id": "BatchUpdateSubscriptionsRequest", "type": "object", "properties": { "requests": { "type": "array", "items": { "$ref": "UpdateSubscriptionRequest" }, "description": "Required. A list of update requests of up to 100 elements. All requests must update different subscriptions." } }, "description": "Request message for BatchUpdateSubscription." }, "OneTimeCode": { "id": "OneTimeCode", "description": "A single use promotion code.", "properties": {}, "type": "object" }, "OneTimeProductPurchaseOptionRegionalPricingAndAvailabilityConfig": { "type": "object", "id": "OneTimeProductPurchaseOptionRegionalPricingAndAvailabilityConfig", "properties": { "regionCode": { "description": "Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., \"US\".", "type": "string" }, "availability": { "description": "The availability of the purchase option.", "type": "string", "enum": [ "AVAILABILITY_UNSPECIFIED", "AVAILABLE", "NO_LONGER_AVAILABLE", "AVAILABLE_IF_RELEASED", "AVAILABLE_FOR_OFFERS_ONLY" ], "enumDescriptions": [ "Unspecified availability. Must not be used.", "The purchase option is available to users.", "The purchase option is no longer available to users. This value can only be used if the availability was previously set as AVAILABLE.", "The purchase option is initially unavailable, but made available via a released pre-order offer.", "The purchase option is unavailable but offers linked to it (i.e. Play Points offer) are available." ] }, "price": { "description": "The price of the purchase option in the specified region. Must be set in the currency that is linked to the specified region.", "$ref": "Money" } }, "description": "Regional pricing and availability configuration for a purchase option." }, "DeleteOneTimeProductOfferRequest": { "description": "Request message for deleting an one-time product offer.", "id": "DeleteOneTimeProductOfferRequest", "properties": { "offerId": { "type": "string", "description": "Required. The unique offer ID of the offer to delete." }, "purchaseOptionId": { "type": "string", "description": "Required. The parent purchase option (ID) of the offer to delete." }, "packageName": { "type": "string", "description": "Required. The parent app (package name) of the offer to delete." }, "productId": { "type": "string", "description": "Required. The parent one-time product (ID) of the offer to delete." }, "latencyTolerance": { "enumDescriptions": [ "Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.", "The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.", "The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods." ], "description": "Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.", "type": "string", "enum": [ "PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT" ] } }, "type": "object" }, "RegionalSubscriptionOfferPhaseFreePriceOverride": { "properties": {}, "id": "RegionalSubscriptionOfferPhaseFreePriceOverride", "description": "Represents the free price override configuration for a single phase of a subscription offer", "type": "object" }, "UpdateOneTimeProductOfferRequest": { "description": "Request message for UpdateOneTimeProductOffer.", "type": "object", "properties": { "updateMask": { "description": "Required. The list of fields to be updated.", "format": "google-fieldmask", "type": "string" }, "oneTimeProductOffer": { "description": "Required. The one-time product offer to update.", "$ref": "OneTimeProductOffer" }, "allowMissing": { "description": "Optional. If set to true, and the offer with the given package_name, product_id, purchase_option_id and offer_id doesn't exist, an offer will be created. If a new offer is created, the update_mask is ignored.", "type": "boolean" }, "latencyTolerance": { "type": "string", "enum": [ "PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT" ], "enumDescriptions": [ "Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.", "The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.", "The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods." ], "description": "Optional. The latency tolerance for the propagation of this offer update. Defaults to latency-sensitive." }, "regionsVersion": { "$ref": "RegionsVersion", "description": "Required. The version of the available regions being used for the offer." } }, "id": "UpdateOneTimeProductOfferRequest" }, "BatchUpdateSubscriptionOfferStatesResponse": { "type": "object", "description": "Response message for BatchUpdateSubscriptionOfferStates.", "properties": { "subscriptionOffers": { "type": "array", "description": "The updated subscription offers list.", "items": { "$ref": "SubscriptionOffer" } } }, "id": "BatchUpdateSubscriptionOfferStatesResponse" }, "RamSelector": { "description": "Defines a RAM selector for a device.", "id": "RamSelector", "type": "object", "properties": { "ramMbLessThanOrEqual": { "format": "int64", "type": "string", "description": "This will match any device that has less than or equal ram_mb_less_than_or_equal mb of RAM." } } }, "OfferDetails": { "description": "Offer details information related to a purchase line item.", "properties": { "offerId": { "type": "string", "description": "The offer ID. Only present for discounted offers." }, "offerTags": { "type": "array", "description": "The latest offer tags associated with the offer. It includes tags inherited from the base plan.", "items": { "type": "string" } }, "basePlanId": { "type": "string", "description": "The base plan ID. Present for all base plan and offers." } }, "type": "object", "id": "OfferDetails" }, "AssetModuleMetadata": { "type": "object", "id": "AssetModuleMetadata", "properties": { "deliveryType": { "type": "string", "enum": [ "UNKNOWN_DELIVERY_TYPE", "INSTALL_TIME", "ON_DEMAND", "FAST_FOLLOW" ], "enumDescriptions": [ "Unspecified delivery type.", "This module will always be downloaded as part of the initial install of the app.", "This module is requested on-demand, which means it will not be part of the initial install, and will only be sent when requested by the client.", "This module will be downloaded immediately after initial install finishes. The app can be opened before these modules are downloaded." ], "description": "Indicates the delivery type for persistent install." }, "name": { "type": "string", "description": "Module name." } }, "description": "Metadata of an asset module." }, "SplitApkMetadata": { "properties": { "isMasterSplit": { "description": "Indicates whether this APK is the main split of the module.", "type": "boolean" }, "splitId": { "type": "string", "description": "Id of the split." } }, "description": "Holds data specific to Split APKs.", "id": "SplitApkMetadata", "type": "object" }, "RestrictedPaymentCountries": { "type": "object", "description": "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.", "properties": { "regionCodes": { "description": "Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. \"US\".", "items": { "type": "string" }, "type": "array" } }, "id": "RestrictedPaymentCountries" }, "ListOneTimeProductOffersResponse": { "properties": { "oneTimeProductOffers": { "items": { "$ref": "OneTimeProductOffer" }, "description": "The one_time_product offers from the specified request.", "type": "array" }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "description": "Response message for ListOneTimeProductOffers.", "type": "object", "id": "ListOneTimeProductOffersResponse" }, "Grant": { "properties": { "appLevelPermissions": { "description": "The permissions granted to the user for this app.", "items": { "type": "string", "enum": [ "APP_LEVEL_PERMISSION_UNSPECIFIED", "CAN_ACCESS_APP", "CAN_VIEW_FINANCIAL_DATA", "CAN_MANAGE_PERMISSIONS", "CAN_REPLY_TO_REVIEWS", "CAN_MANAGE_PUBLIC_APKS", "CAN_MANAGE_TRACK_APKS", "CAN_MANAGE_TRACK_USERS", "CAN_MANAGE_PUBLIC_LISTING", "CAN_MANAGE_DRAFT_APPS", "CAN_MANAGE_ORDERS", "CAN_MANAGE_APP_CONTENT", "CAN_VIEW_NON_FINANCIAL_DATA", "CAN_VIEW_APP_QUALITY", "CAN_MANAGE_DEEPLINKS" ], "enumDeprecated": [ false, true, false, false, false, false, false, false, false, false, false, false, false, false, false ], "enumDescriptions": [ "Unknown or unspecified permission.", "View app information (read-only). Deprecated: Try defining a more granular capability. Otherwise, check AppLevelPermission.CAN_VIEW_NON_FINANCIAL_DATA.", "View financial data.", "Admin (all permissions).", "Reply to reviews.", "Release to production, exclude devices, and use app signing by Google Play.", "Release to testing tracks.", "Manage testing tracks and edit tester lists.", "Manage store presence.", "Edit and delete draft apps.", "Manage orders and subscriptions.", "Manage policy related pages.", "View app information (read-only).", "View app quality data such as Vitals, Crashes etc.", "Manage the deep links setup of an app." ] }, "type": "array" }, "name": { "description": "Required. Resource name for this grant, following the pattern \"developers/{developer}/users/{email}/grants/{package_name}\". If this grant is for a draft app, the app ID will be used in this resource name instead of the package name.", "type": "string" }, "packageName": { "description": "Immutable. The package name of the app. This will be empty for draft apps.", "type": "string" } }, "type": "object", "id": "Grant", "description": "An access grant resource." }, "Money": { "id": "Money", "type": "object", "properties": { "currencyCode": { "description": "The three-letter currency code defined in ISO 4217.", "type": "string" }, "units": { "description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", "format": "int64", "type": "string" }, "nanos": { "description": "Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.", "type": "integer", "format": "int32" } }, "description": "Represents an amount of money with its currency type." }, "SubscriptionDeferralInfo": { "type": "object", "properties": { "expectedExpiryTimeMillis": { "type": "string", "description": "The expected expiry time for the subscription. If the current expiry time for the subscription is not the value specified here, the deferral will not occur.", "format": "int64" }, "desiredExpiryTimeMillis": { "type": "string", "format": "int64", "description": "The desired next expiry time to assign to the subscription, in milliseconds since the Epoch. The given time must be later/greater than the current expiry time for the subscription." } }, "description": "A SubscriptionDeferralInfo contains the data needed to defer a subscription purchase to a future expiry time.", "id": "SubscriptionDeferralInfo" }, "ConvertRegionPricesRequest": { "properties": { "price": { "$ref": "Money", "description": "The intital price to convert other regions from. Tax exclusive." }, "productTaxCategoryCode": { "type": "string", "description": "Optional. Product tax category code in context. Product tax category determines the transaction tax rates applied to the product that will be factored into the price calculation. If not set, tax rates for the default product tax category will be used. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/16408159) for more information." } }, "description": "Request message for ConvertRegionPrices.", "id": "ConvertRegionPricesRequest", "type": "object" }, "ArchiveSubscriptionRequest": { "description": "Deprecated: subscription archiving is not supported.", "deprecated": true, "id": "ArchiveSubscriptionRequest", "type": "object", "properties": {} }, "DeferSubscriptionPurchaseResponse": { "type": "object", "properties": { "itemExpiryTimeDetails": { "items": { "$ref": "ItemExpiryTimeDetails" }, "description": "The new expiry time for each subscription items.", "type": "array" } }, "description": "Response for the v2 purchases.subscriptions.defer API.", "id": "DeferSubscriptionPurchaseResponse" }, "LocalizedStoreListings": { "id": "LocalizedStoreListings", "type": "object", "description": "The localized store listings of an app.", "properties": { "defaultLanguageCode": { "description": "The default language code of the app. If a localized store listing is not available for a given language, assets from the default language are used instead.", "type": "string" }, "localizedStoreListings": { "type": "array", "items": { "$ref": "LocalizedStoreListing" } } } }, "CloudKmsKeyAndCert": { "properties": { "pemCertificate": { "format": "byte", "description": "Required. Certificate associated with the key. The bytes must contain the certificate in PEM format.", "type": "string" }, "cloudKmsKey": { "description": "Required. Cloud KMS key.", "$ref": "CloudKmsKey" } }, "id": "CloudKmsKeyAndCert", "description": "Cloud KMS key and the certificate associated with the key.", "type": "object" }, "OneTimeProductDiscountedOffer": { "type": "object", "description": "Configuration specific to discounted offers.", "id": "OneTimeProductDiscountedOffer", "properties": { "redemptionLimit": { "format": "int64", "type": "string", "description": "Optional. The number of times this offer can be redeemed. If unset or set to 0, allows for unlimited offer redemptions. Otherwise must be a number between 1 and 50 inclusive." }, "endTime": { "format": "google-datetime", "type": "string", "description": "Time when the offer will stop being available." }, "startTime": { "format": "google-datetime", "description": "Time when the offer will start being available.", "type": "string" } } }, "ExternalTransactionTestPurchase": { "properties": {}, "type": "object", "description": "Represents a transaction performed using a test account. These transactions will not be charged by Google.", "id": "ExternalTransactionTestPurchase" }, "MigrateBasePlanPricesRequest": { "properties": { "basePlanId": { "type": "string", "description": "Required. The unique base plan ID of the base plan to update prices on." }, "packageName": { "description": "Required. Package name of the parent app. Must be equal to the package_name field on the Subscription resource.", "type": "string" }, "regionalPriceMigrations": { "type": "array", "items": { "$ref": "RegionalPriceMigrationConfig" }, "description": "Required. The regional prices to update." }, "regionsVersion": { "$ref": "RegionsVersion", "description": "Required. The version of the available regions being used for the regional_price_migrations." }, "latencyTolerance": { "type": "string", "enum": [ "PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT" ], "enumDescriptions": [ "Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.", "The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.", "The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods." ], "description": "Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive." }, "productId": { "description": "Required. The ID of the subscription to update. Must be equal to the product_id field on the Subscription resource.", "type": "string" } }, "type": "object", "id": "MigrateBasePlanPricesRequest", "description": "Request message for MigrateBasePlanPrices." }, "DeviceSelector": { "type": "object", "properties": { "excludedDeviceIds": { "description": "Device models excluded by this selector, even if they match all other conditions.", "items": { "$ref": "DeviceId" }, "type": "array" }, "forbiddenSystemFeatures": { "type": "array", "description": "A device that has any of these system features is excluded by this selector, even if it matches all other conditions.", "items": { "$ref": "SystemFeature" } }, "deviceRam": { "description": "Conditions on the device's RAM.", "$ref": "DeviceRam" }, "includedDeviceIds": { "description": "Device models included by this selector.", "items": { "$ref": "DeviceId" }, "type": "array" }, "systemOnChips": { "type": "array", "description": "Optional. The SoCs included by this selector. Only works for Android S+ devices.", "items": { "$ref": "SystemOnChip" } }, "requiredSystemFeatures": { "description": "A device needs to have all these system features to be included by the selector.", "items": { "$ref": "SystemFeature" }, "type": "array" } }, "description": "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", "id": "DeviceSelector" }, "ActivateSubscriptionOfferRequest": { "properties": { "productId": { "description": "Required. The parent subscription (ID) of the offer to activate.", "type": "string" }, "packageName": { "type": "string", "description": "Required. The parent app (package name) of the offer to activate." }, "latencyTolerance": { "description": "Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.", "enumDescriptions": [ "Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.", "The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.", "The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods." ], "type": "string", "enum": [ "PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT" ] }, "offerId": { "description": "Required. The unique offer ID of the offer to activate.", "type": "string" }, "basePlanId": { "type": "string", "description": "Required. The parent base plan (ID) of the offer to activate." } }, "id": "ActivateSubscriptionOfferRequest", "description": "Request message for ActivateSubscriptionOffer.", "type": "object" }, "OneTimeProduct": { "description": "A single one-time product for an app.", "type": "object", "id": "OneTimeProduct", "properties": { "offerTags": { "description": "Optional. List of up to 20 custom tags specified for this one-time product, and returned to the app through the billing library. Purchase options and offers for this product will also receive these tags in the billing library.", "items": { "$ref": "OfferTag" }, "type": "array" }, "packageName": { "description": "Required. Immutable. Package name of the parent app.", "type": "string" }, "purchaseOptions": { "type": "array", "items": { "$ref": "OneTimeProductPurchaseOption" }, "description": "Required. The set of purchase options for this one-time product." }, "restrictedPaymentCountries": { "description": "Optional. Countries where the purchase of this one-time product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed.", "$ref": "RestrictedPaymentCountries" }, "taxAndComplianceSettings": { "description": "Details about taxes and legal compliance.", "$ref": "OneTimeProductTaxAndComplianceSettings" }, "regionsVersion": { "$ref": "RegionsVersion", "description": "Output only. The version of the regions configuration that was used to generate the one-time product.", "readOnly": true }, "listings": { "items": { "$ref": "OneTimeProductListing" }, "description": "Required. Set of localized title and description data. Must not have duplicate entries with the same language_code.", "type": "array" }, "productId": { "description": "Required. Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must start with a number or lowercase letter, and can contain numbers (0-9), lowercase letters (a-z), underscores (_), and periods (.).", "type": "string" } } }, "SubscriptionDetails": { "properties": { "offerPhase": { "type": "string", "deprecated": true, "enumDescriptions": [ "Offer phase unspecified. This value is not used.", "The order funds a base price period.", "The order funds an introductory pricing period.", "The order funds a free trial period." ], "enum": [ "OFFER_PHASE_UNSPECIFIED", "BASE", "INTRODUCTORY", "FREE_TRIAL" ], "description": "Deprecated: Use offer_phase_details instead. The pricing phase for the billing period funded by this order." }, "offerId": { "description": "The offer ID for the current subscription offer.", "type": "string" }, "servicePeriodStartTime": { "format": "google-datetime", "type": "string", "description": "The start of the billing period funded by this order. This is a snapshot of the billing/service period start time at the moment the order was processed, and should be used only for accounting." }, "offerPhaseDetails": { "description": "The pricing phase details for the entitlement period funded by this order.", "$ref": "OfferPhaseDetails" }, "servicePeriodEndTime": { "type": "string", "format": "google-datetime", "description": "The end of the billing period funded by this order. This is a snapshot of the billing/service period end time at the moment the order was processed, and should be used only for accounting. To get the current end time of the subscription service period, use purchases.subscriptionsv2.get." }, "basePlanId": { "description": "The base plan ID of the subscription.", "type": "string" } }, "description": "Details of a subscription purchase.", "id": "SubscriptionDetails", "type": "object" }, "UploadApkResponse": { "type": "object", "id": "UploadApkResponse", "properties": { "apkId": { "type": "string", "description": "The unique ID of the uploaded APK." } }, "description": "Response for uploading an APK." }, "BatchUpdateBasePlanStatesResponse": { "id": "BatchUpdateBasePlanStatesResponse", "type": "object", "properties": { "subscriptions": { "items": { "$ref": "Subscription" }, "type": "array", "description": "The list of updated subscriptions. This list will match the requests one to one, in the same order." } }, "description": "Response message for BatchUpdateBasePlanStates." }, "Review": { "description": "An Android app review.", "id": "Review", "properties": { "comments": { "description": "A repeated field containing comments for the review.", "type": "array", "items": { "$ref": "Comment" } }, "authorName": { "type": "string", "description": "The name of the user who wrote the review." }, "reviewId": { "type": "string", "description": "Unique identifier for this review." } }, "type": "object" }, "UpdateAppStoreHostedAppPublishStatusRequest": { "properties": { "publishState": { "description": "Required. The new publish state for the hosted app.", "type": "string", "enum": [ "APP_STORE_APP_PUBLISH_STATE_UNSPECIFIED", "APP_STORE_APP_PUBLISH_STATE_PUBLISHED", "APP_STORE_APP_PUBLISH_STATE_UNPUBLISHED" ], "enumDescriptions": [ "Unspecified publish state. Do not use.", "The app is published and available on the third-party app store.", "The app is unpublished and no longer available on the third-party app store." ] } }, "description": "Request to update the publish status of an app store hosted app. The default state for any app with an update is PUBLISHED. It is not necessary to call this RPC explicitly to set an app to PUBLISHED.", "type": "object", "id": "UpdateAppStoreHostedAppPublishStatusRequest" }, "BatchGetSubscriptionOffersResponse": { "description": "Response message for BatchGetSubscriptionOffers endpoint.", "id": "BatchGetSubscriptionOffersResponse", "type": "object", "properties": { "subscriptionOffers": { "items": { "$ref": "SubscriptionOffer" }, "type": "array" } } }, "BaseDetails": { "description": "Details of a base price pricing phase.", "type": "object", "properties": {}, "id": "BaseDetails" }, "PolicyStringResponse": { "description": "Any response best encoded as a string. Includes URLs and multiline text fields.", "id": "PolicyStringResponse", "properties": { "value": { "type": "string", "description": "Required. Provided string value." } }, "type": "object" }, "ListRecentUpdateEventsResponse": { "type": "object", "description": "Response message for ListRecentUpdateEvents.", "id": "ListRecentUpdateEventsResponse", "properties": { "nextPageToken": { "type": "string", "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." }, "recentUpdateEvents": { "items": { "$ref": "RecentUpdateEvent" }, "type": "array", "description": "The list of recent update events." } } }, "CatalogDeviceSelector": { "description": "Defines a device selector for a device. A device is considered matched if it matches any of given the selectors.", "type": "object", "id": "CatalogDeviceSelector", "properties": { "deviceTypeSelector": { "enumDescriptions": [ "Unspecified device type selector.", "Android Go device type." ], "description": "The device type selector.", "type": "string", "enum": [ "DEVICE_TYPE_SELECTOR_UNSPECIFIED", "ANDROID_GO" ] }, "socSelectors": { "type": "array", "items": { "$ref": "SocSelector" }, "description": "The SOC selectors. A device matches the device selector if it matches any of the SOC selectors." }, "ramSelector": { "description": "Defines a RAM selector for a device.", "$ref": "RamSelector" } } }, "BatchUpdatePurchaseOptionStatesRequest": { "description": "Request message for BatchUpdatePurchaseOptionStates.", "type": "object", "properties": { "requests": { "description": "Required. The update request list of up to 100 elements. All requests must update different purchase options.", "type": "array", "items": { "$ref": "UpdatePurchaseOptionStateRequest" } } }, "id": "BatchUpdatePurchaseOptionStatesRequest" }, "FullRefund": { "type": "object", "id": "FullRefund", "properties": {}, "description": "A full refund of the remaining amount of a transaction." }, "ListSubscriptionsResponse": { "type": "object", "properties": { "subscriptions": { "type": "array", "description": "The subscriptions from the specified app.", "items": { "$ref": "Subscription" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "description": "Response message for ListSubscriptions.", "id": "ListSubscriptionsResponse" }, "ReviewsReplyResponse": { "description": "Response on status of replying to a review.", "properties": { "result": { "description": "The result of replying/updating a reply to review.", "$ref": "ReviewReplyResult" } }, "id": "ReviewsReplyResponse", "type": "object" }, "ExpansionFilesUploadResponse": { "description": "Response for uploading an expansion file.", "properties": { "expansionFile": { "$ref": "ExpansionFile", "description": "The uploaded expansion file configuration." } }, "id": "ExpansionFilesUploadResponse", "type": "object" }, "TargetingRuleScopeThisSubscription": { "id": "TargetingRuleScopeThisSubscription", "properties": {}, "description": "Represents the targeting rule scope corresponding to the subscriptions in which this offer is defined.", "type": "object" }, "OtherRecurringProduct": { "type": "object", "id": "OtherRecurringProduct", "description": "Details of a recurring external transaction product which doesn't belong to any other more specific category.", "properties": {} }, "PolicyDocumentResponse": { "id": "PolicyDocumentResponse", "description": "An uploaded document. Must be a single logical document (e.g. a financial license).", "properties": { "documentId": { "description": "Required. ID of the uploaded document.", "type": "string" }, "expiryDate": { "description": "Optional. Expiry date for the document.", "$ref": "Date" }, "nonExpiring": { "type": "boolean", "description": "Optional. True if confirmed that the document does not have an expiry date." } }, "type": "object" }, "DeobfuscationFile": { "description": "Represents a deobfuscation file.", "properties": { "symbolType": { "description": "The type of the deobfuscation file.", "enumDescriptions": [ "Unspecified deobfuscation file type.", "Proguard deobfuscation file type.", "Native debugging symbols file type." ], "type": "string", "enum": [ "deobfuscationFileTypeUnspecified", "proguard", "nativeCode" ] } }, "type": "object", "id": "DeobfuscationFile" }, "ApksListResponse": { "type": "object", "description": "Response listing all APKs.", "id": "ApksListResponse", "properties": { "kind": { "description": "The kind of this response (\"androidpublisher#apksListResponse\").", "type": "string" }, "apks": { "type": "array", "description": "All APKs.", "items": { "$ref": "Apk" } } } }, "AppDetails": { "id": "AppDetails", "type": "object", "properties": { "contactEmail": { "description": "The user-visible support email for this app.", "type": "string" }, "defaultLanguage": { "type": "string", "description": "Default language code, in BCP 47 format (eg \"en-US\")." }, "contactPhone": { "description": "The user-visible support telephone number for this app.", "type": "string" }, "contactWebsite": { "description": "The user-visible website for this app.", "type": "string" } }, "description": "The app details. The resource for DetailsService." }, "SdkVersionTargeting": { "properties": { "value": { "description": "Value of an sdk version.", "type": "array", "items": { "$ref": "SdkVersion" } }, "alternatives": { "items": { "$ref": "SdkVersion" }, "description": "Targeting of other sibling directories that were in the Bundle. For main splits this is targeting of other main splits.", "type": "array" } }, "description": "Targeting based on sdk version.", "id": "SdkVersionTargeting", "type": "object" }, "ApkSet": { "properties": { "moduleMetadata": { "$ref": "ModuleMetadata", "description": "Metadata about the module represented by this ApkSet" }, "apkDescription": { "description": "Description of the generated apks.", "items": { "$ref": "ApkDescription" }, "type": "array" } }, "id": "ApkSet", "description": "A set of apks representing a module.", "type": "object" }, "InappproductsUpdateRequest": { "description": "Request to update an in-app product.", "id": "InappproductsUpdateRequest", "properties": { "inappproduct": { "description": "The new in-app product.", "$ref": "InAppProduct" }, "packageName": { "description": "Package name of the app.", "type": "string" }, "latencyTolerance": { "description": "Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.", "type": "string", "enum": [ "PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT" ], "enumDescriptions": [ "Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.", "The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.", "The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods." ] }, "autoConvertMissingPrices": { "type": "boolean", "description": "If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false." }, "allowMissing": { "description": "If set to true, and the in-app product with the given package_name and sku doesn't exist, the in-app product will be created.", "type": "boolean" }, "sku": { "description": "Unique identifier for the in-app product.", "type": "string" } }, "type": "object" }, "UpdateOneTimeProductOfferStateRequest": { "properties": { "activateOneTimeProductOfferRequest": { "$ref": "ActivateOneTimeProductOfferRequest", "description": "Activates an offer. Once activated, the offer is available to users, as long as its conditions are met." }, "cancelOneTimeProductOfferRequest": { "description": "Cancels an offer. Once cancelled, the offer is not available to users. Any pending orders related to this offer will be cancelled. This state transition is specific to pre-orders.", "$ref": "CancelOneTimeProductOfferRequest" }, "deactivateOneTimeProductOfferRequest": { "$ref": "DeactivateOneTimeProductOfferRequest", "description": "Deactivates an offer. Once deactivated, the offer is no longer available to users. This state transition is specific to discounted offers." } }, "description": "Request message to update the state of a one-time product offer.", "id": "UpdateOneTimeProductOfferStateRequest", "type": "object" }, "DeviceMetadata": { "type": "object", "properties": { "glEsVersion": { "description": "OpenGL version", "type": "integer", "format": "int32" }, "productName": { "type": "string", "description": "Device model name (e.g. Droid)" }, "cpuModel": { "description": "Device CPU model, e.g. \"MSM8974\"", "type": "string" }, "screenWidthPx": { "type": "integer", "format": "int32", "description": "Screen width in pixels" }, "manufacturer": { "type": "string", "description": "Device manufacturer (e.g. Motorola)" }, "cpuMake": { "type": "string", "description": "Device CPU make, e.g. \"Qualcomm\"" }, "nativePlatform": { "description": "Comma separated list of native platforms (e.g. \"arm\", \"arm7\")", "type": "string" }, "ramMb": { "type": "integer", "format": "int32", "description": "Device RAM in Megabytes, e.g. \"2048\"" }, "screenHeightPx": { "type": "integer", "format": "int32", "description": "Screen height in pixels" }, "deviceClass": { "description": "Device class (e.g. tablet)", "type": "string" }, "screenDensityDpi": { "format": "int32", "description": "Screen density in DPI", "type": "integer" } }, "id": "DeviceMetadata", "description": "Characteristics of the user's device." }, "IntroductoryPriceDetails": { "id": "IntroductoryPriceDetails", "description": "Details of an introductory price pricing phase.", "properties": {}, "type": "object" }, "OneTimeProductListing": { "id": "OneTimeProductListing", "properties": { "description": { "description": "Required. The description of this product in the language of this listing. The maximum length is 200 characters.", "type": "string" }, "title": { "description": "Required. The title of this product in the language of this listing. The maximum length is 55 characters.", "type": "string" }, "languageCode": { "description": "Required. The language of this listing, as defined by BCP-47, e.g., \"en-US\".", "type": "string" } }, "description": "Regional store listing for a one-time product.", "type": "object" }, "RegionalBasePlanConfig": { "properties": { "newSubscriberAvailability": { "type": "boolean", "description": "Whether the base plan in the specified region is available for new subscribers. Existing subscribers will not have their subscription canceled if this value is set to false. If not specified, this will default to false." }, "price": { "description": "The price of the base plan in the specified region. Must be set if the base plan is available to new subscribers. Must be set in the currency that is linked to the specified region.", "$ref": "Money" }, "regionCode": { "description": "Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. \"US\".", "type": "string" } }, "description": "Configuration for a base plan specific to a region.", "id": "RegionalBasePlanConfig", "type": "object" }, "TargetingRuleScope": { "type": "object", "id": "TargetingRuleScope", "description": "Defines the scope of subscriptions which a targeting rule can match to target offers to users based on past or current entitlement.", "properties": { "thisSubscription": { "$ref": "TargetingRuleScopeThisSubscription", "description": "The scope of the current targeting rule is the subscription in which this offer is defined." }, "specificSubscriptionInApp": { "type": "string", "description": "The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app." }, "anySubscriptionInApp": { "$ref": "TargetingRuleScopeAnySubscriptionInApp", "description": "The scope of the current targeting rule is any subscription in the parent app." } } }, "SdkVersion": { "description": "Represents an sdk version.", "properties": { "min": { "description": "Inclusive minimum value of an sdk version.", "type": "integer", "format": "int32" } }, "id": "SdkVersion", "type": "object" }, "CreateAppStoreHostedAppRequest": { "id": "CreateAppStoreHostedAppRequest", "description": "Request to create a new app record for an app store hosted app.", "type": "object", "properties": { "packageName": { "description": "Required. Package name of the app.", "type": "string" } } }, "DeviceFeature": { "description": "Represents a device feature.", "id": "DeviceFeature", "type": "object", "properties": { "featureName": { "description": "Name of the feature.", "type": "string" }, "featureVersion": { "format": "int32", "type": "integer", "description": "The feature version specified by android:glEsVersion or android:version in in the AndroidManifest." } } }, "RegionalTaxRateInfo": { "id": "RegionalTaxRateInfo", "properties": { "streamingTaxType": { "type": "string", "enum": [ "STREAMING_TAX_TYPE_UNSPECIFIED", "STREAMING_TAX_TYPE_TELCO_VIDEO_RENTAL", "STREAMING_TAX_TYPE_TELCO_VIDEO_SALES", "STREAMING_TAX_TYPE_TELCO_VIDEO_MULTI_CHANNEL", "STREAMING_TAX_TYPE_TELCO_AUDIO_RENTAL", "STREAMING_TAX_TYPE_TELCO_AUDIO_SALES", "STREAMING_TAX_TYPE_TELCO_AUDIO_MULTI_CHANNEL" ], "description": "To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax).", "enumDescriptions": [ "No telecommunications tax collected.", "US-specific telecommunications tax tier for video streaming, on demand, rentals / subscriptions / pay-per-view.", "US-specific telecommunications tax tier for video streaming of pre-recorded content like movies, tv shows.", "US-specific telecommunications tax tier for video streaming of multi-channel programming.", "US-specific telecommunications tax tier for audio streaming, rental / subscription.", "US-specific telecommunications tax tier for audio streaming, sale / permanent download.", "US-specific telecommunications tax tier for multi channel audio streaming like radio." ] }, "taxTier": { "description": "Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498).", "enumDescriptions": [ "", "", "", "", "", "" ], "type": "string", "enum": [ "TAX_TIER_UNSPECIFIED", "TAX_TIER_BOOKS_1", "TAX_TIER_NEWS_1", "TAX_TIER_NEWS_2", "TAX_TIER_MUSIC_OR_AUDIO_1", "TAX_TIER_LIVE_OR_BROADCAST_1" ] }, "eligibleForStreamingServiceTaxRate": { "description": "You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in the United States.", "type": "boolean" } }, "type": "object", "description": "Specified details about taxation in a given geographical region." }, "ListOneTimeProductsResponse": { "id": "ListOneTimeProductsResponse", "type": "object", "description": "Response message for ListOneTimeProducts.", "properties": { "oneTimeProducts": { "type": "array", "description": "The one-time products from the specified app.", "items": { "$ref": "OneTimeProduct" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "InAppProductListing": { "id": "InAppProductListing", "description": "Store listing of a single in-app product.", "type": "object", "properties": { "description": { "type": "string", "description": "Description for the store listing." }, "benefits": { "description": "Deprecated: Subscriptions are no longer supported in the InAppProducts API. Use the Subscriptions API instead.", "type": "array", "items": { "type": "string" }, "deprecated": true }, "title": { "description": "Title for the store listing.", "type": "string" } } }, "Timestamp": { "type": "object", "properties": { "nanos": { "description": "Non-negative fractions of a second at nanosecond resolution. Must be from 0 to 999,999,999 inclusive.", "format": "int32", "type": "integer" }, "seconds": { "format": "int64", "type": "string", "description": "Represents seconds of UTC time since Unix epoch." } }, "id": "Timestamp", "description": "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." }, "PolicyKeyedGroupResponse": { "type": "object", "properties": { "groups": { "description": "Optional. Groups of responses to questions. Each KeyedGroup.key must be unique within this list.", "type": "array", "items": { "$ref": "KeyedGroup" } } }, "description": "A group of responses each identified by a distinct key within an allowed set.", "id": "PolicyKeyedGroupResponse" }, "ActivateBasePlanRequest": { "id": "ActivateBasePlanRequest", "properties": { "latencyTolerance": { "type": "string", "enum": [ "PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT" ], "enumDescriptions": [ "Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.", "The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.", "The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods." ], "description": "Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive." }, "productId": { "type": "string", "description": "Required. The parent subscription (ID) of the base plan to activate." }, "basePlanId": { "description": "Required. The unique base plan ID of the base plan to activate.", "type": "string" }, "packageName": { "description": "Required. The parent app (package name) of the base plan to activate.", "type": "string" } }, "type": "object", "description": "Request message for ActivateBasePlan." }, "CancelAppRecoveryRequest": { "type": "object", "description": "Request message for CancelAppRecovery.", "id": "CancelAppRecoveryRequest", "properties": {} }, "DeactivateSubscriptionOfferRequest": { "id": "DeactivateSubscriptionOfferRequest", "type": "object", "description": "Request message for DeactivateSubscriptionOffer.", "properties": { "productId": { "type": "string", "description": "Required. The parent subscription (ID) of the offer to deactivate." }, "basePlanId": { "type": "string", "description": "Required. The parent base plan (ID) of the offer to deactivate." }, "packageName": { "type": "string", "description": "Required. The parent app (package name) of the offer to deactivate." }, "offerId": { "type": "string", "description": "Required. The unique offer ID of the offer to deactivate." }, "latencyTolerance": { "enumDescriptions": [ "Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.", "The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.", "The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods." ], "description": "Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.", "type": "string", "enum": [ "PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT" ] } } }, "PartialRefundEvent": { "id": "PartialRefundEvent", "type": "object", "description": "Details of the partial refund events for this order.", "properties": { "processTime": { "description": "The time when the partial refund was processed.", "format": "google-datetime", "type": "string" }, "state": { "description": "The state of the partial refund.", "type": "string", "enum": [ "STATE_UNSPECIFIED", "PENDING", "PROCESSED_SUCCESSFULLY" ], "enumDescriptions": [ "State unspecified. This value is not used.", "The partial refund has been created, but not yet processed.", "The partial refund was processed successfully." ] }, "refundDetails": { "description": "Details for the partial refund.", "$ref": "RefundDetails" }, "createTime": { "type": "string", "format": "google-datetime", "description": "The time when the partial refund was created." } } }, "PausedStateContext": { "description": "Information specific to a subscription in paused state.", "properties": { "autoResumeTime": { "type": "string", "description": "Time at which the subscription will be automatically resumed.", "format": "google-datetime" } }, "type": "object", "id": "PausedStateContext" }, "EnrollAppRequest": { "id": "EnrollAppRequest", "description": "Request to enroll an app into Play App Signing using a self-hosted Cloud KMS key.", "properties": { "enrollNewApp": { "$ref": "EnrollNewApp", "description": "Changes the signing key of a new app to an external Cloud KMS key. The app must not have published to Open testing or Production tracks." }, "enrollExistingApp": { "description": "Enrolls an existing app into Play signing using an external Cloud KMS key.", "$ref": "EnrollExistingApp" }, "pemUploadCertificate": { "type": "string", "description": "The certificate associated with the upload key, in PEM format.", "format": "byte" } }, "type": "object" }, "BasePriceOfferPhase": { "description": "Details about base price offer phase.", "id": "BasePriceOfferPhase", "properties": {}, "type": "object" }, "DeviceTierSet": { "id": "DeviceTierSet", "description": "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.", "type": "object", "properties": { "deviceTiers": { "type": "array", "description": "Device tiers belonging to the set.", "items": { "$ref": "DeviceTier" } } } }, "RentOfferDetails": { "type": "object", "description": "Offer details information related to a rental line item.", "id": "RentOfferDetails", "properties": {} }, "RegionalPriceMigrationConfig": { "id": "RegionalPriceMigrationConfig", "properties": { "oldestAllowedPriceVersionTime": { "format": "google-datetime", "description": "Required. Subscribers in all legacy price cohorts before this time will be migrated to the current price. Subscribers in any newer price cohorts are unaffected. Affected subscribers will receive one or more notifications from Google Play about the price change. Price decreases occur at the subscriber's next billing date. Price increases occur at the subscriber's next billing date following a notification period that varies by region and price increase type.", "type": "string" }, "regionCode": { "description": "Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. \"US\".", "type": "string" }, "priceIncreaseType": { "enumDescriptions": [ "Unspecified state.", "Subscribers must accept the price increase or their subscription is canceled.", "Subscribers are notified but do not have to accept the price increase. Opt-out price increases not meeting regional, frequency, and amount limits will proceed as opt-in price increase. The first opt-out price increase for each app must be initiated in the Google Play Console." ], "type": "string", "enum": [ "PRICE_INCREASE_TYPE_UNSPECIFIED", "PRICE_INCREASE_TYPE_OPT_IN", "PRICE_INCREASE_TYPE_OPT_OUT" ], "description": "Optional. The requested type of price increase" } }, "description": "Configuration for migration of a legacy price cohort.", "type": "object" }, "AppStoreAppActiveApkSet": { "type": "object", "properties": { "versionCode": { "description": "Optional. Version code for the version this APK set represents.", "type": "string", "format": "int64" }, "splitApkId": { "description": "Optional. IDs for split modules that might be installed in combination with the base APK. Can be empty if app bundles (or a similar technology) are not used. Example: config.en.apk.", "items": { "type": "string" }, "type": "array" }, "alreadyPublishedOnPlay": { "description": "Optional. Whether all APKs referenced in this active APK set are published on Play Store (or derived from an app bundle published on Play Store). When this is set, version_code must be provided.", "type": "boolean" }, "baseApkId": { "type": "string", "description": "Required. The ID for the main base application module. Example: base.apk or app.apk." } }, "id": "AppStoreAppActiveApkSet", "description": "An installable set of active APKs. All APKs in this set should belong to the same version of the app. A set of APKs might only contain 1 APK if the app in question publishes using APKs. If the app uses app bundles (or a similar technology), this set should contain all APKs (even optional ones) that might be installed for this app. A set of APKs should be installable together. If certain APKs are exclusive to one another and cannot be installed together, then a separate AppStoreAppActiveApkSet should be created." }, "ExternalOfferDetails": { "type": "object", "properties": { "linkType": { "enumDescriptions": [ "Unspecified, do not use.", "An offer to purchase digital content.", "An app install." ], "description": "Optional. The type of content being reported by this transaction. Required when reporting app downloads or purchased digital content offers made in app installed through Google Play.", "type": "string", "enum": [ "EXTERNAL_OFFER_LINK_TYPE_UNSPECIFIED", "LINK_TO_DIGITAL_CONTENT_OFFER", "LINK_TO_APP_DOWNLOAD" ] }, "installedAppPackage": { "type": "string", "description": "Optional. The package name of the app downloaded through this transaction. Required when link_type is LINK_TO_APP_DOWNLOAD." }, "installedAppCategory": { "description": "Optional. The category of the downloaded app though this transaction. This must match the category provided in Play Console during the external app verification process. Only required for app downloads.", "enumDescriptions": [ "Unspecified, do not use.", "The app is classified under the app category.", "The app is classified under the game category." ], "type": "string", "enum": [ "EXTERNAL_OFFER_APP_CATEGORY_UNSPECIFIED", "APP", "GAME" ] }, "appDownloadEventExternalTransactionId": { "description": "Optional. The external transaction id associated with the app download event through an external link. Required when reporting transactions made in externally installed apps.", "type": "string" } }, "description": "Reporting details unique to the external offers program.", "id": "ExternalOfferDetails" }, "UpdateOneTimeProductRequest": { "id": "UpdateOneTimeProductRequest", "properties": { "oneTimeProduct": { "description": "Required. The one-time product to upsert.", "$ref": "OneTimeProduct" }, "allowMissing": { "type": "boolean", "description": "Optional. If set to true, and the one-time product with the given package_name and product_id doesn't exist, the one-time product will be created. If a new one-time product is created, update_mask is ignored." }, "updateMask": { "type": "string", "format": "google-fieldmask", "description": "Required. The list of fields to be updated." }, "regionsVersion": { "description": "Required. The version of the available regions being used for the one-time product.", "$ref": "RegionsVersion" }, "latencyTolerance": { "type": "string", "enum": [ "PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT" ], "description": "Optional. The latency tolerance for the propagation of this product upsert. Defaults to latency-sensitive.", "enumDescriptions": [ "Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.", "The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.", "The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods." ] } }, "type": "object", "description": "Request message for UpdateOneTimeProduct." }, "GeneratedApksListResponse": { "description": "Response to list generated APKs.", "type": "object", "properties": { "generatedApks": { "type": "array", "items": { "$ref": "GeneratedApksPerSigningKey" }, "description": "All generated APKs, grouped by the APK signing key." } }, "id": "GeneratedApksListResponse" }, "AppStoreAppDetails": { "description": "Details about the app.", "type": "object", "properties": { "developerName": { "description": "Required. The app developer's name.", "type": "string" }, "developerWebsite": { "description": "Optional. Website link for the developer or app.", "type": "string" }, "contactEmail": { "type": "string", "description": "Required. The app developer's contact email address." } }, "id": "AppStoreAppDetails" }, "ConvertedRegionPrice": { "description": "A converted region price.", "properties": { "price": { "description": "The converted price tax inclusive.", "$ref": "Money" }, "regionCode": { "type": "string", "description": "The region code of the region." }, "taxAmount": { "$ref": "Money", "description": "The tax amount of the converted price." } }, "type": "object", "id": "ConvertedRegionPrice" }, "GetSubscriptionOfferRequest": { "description": "Request message for GetSubscriptionOffer.", "properties": { "offerId": { "type": "string", "description": "Required. The unique offer ID of the offer to get." }, "basePlanId": { "description": "Required. The parent base plan (ID) of the offer to get.", "type": "string" }, "packageName": { "description": "Required. The parent app (package name) of the offer to get.", "type": "string" }, "productId": { "type": "string", "description": "Required. The parent subscription (ID) of the offer to get." } }, "type": "object", "id": "GetSubscriptionOfferRequest" }, "OtherRegionsSubscriptionOfferPhaseConfig": { "description": "Configuration for any new locations Play may launch in for a single offer phase.", "properties": { "free": { "description": "Set to specify this offer is free to obtain.", "$ref": "OtherRegionsSubscriptionOfferPhaseFreePriceOverride" }, "relativeDiscount": { "format": "double", "type": "number", "description": "The fraction of the base plan price prorated over the phase duration that the user pays for this offer phase. For example, if the base plan price for this region is $12 for a period of 1 year, then a 50% discount for a phase of a duration of 3 months would correspond to a price of $1.50. The discount must be specified as a fraction strictly larger than 0 and strictly smaller than 1. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in any new locations Play may launch in." }, "absoluteDiscounts": { "description": "The absolute amount of money subtracted from the base plan price prorated over the phase duration that the user pays for this offer phase. For example, if the base plan price for this region is $12 for a period of 1 year, then a $1 absolute discount for a phase of a duration of 3 months would correspond to a price of $2. The resulting price may not be smaller than the minimum price allowed for any new locations Play may launch in.", "$ref": "OtherRegionsSubscriptionOfferPhasePrices" }, "otherRegionsPrices": { "description": "The absolute price the user pays for this offer phase. The price must not be smaller than the minimum price allowed for any new locations Play may launch in.", "$ref": "OtherRegionsSubscriptionOfferPhasePrices" } }, "id": "OtherRegionsSubscriptionOfferPhaseConfig", "type": "object" }, "OtherRegionsSubscriptionOfferConfig": { "description": "Configuration for any new locations Play may launch in specified on a subscription offer.", "type": "object", "properties": { "otherRegionsNewSubscriberAvailability": { "type": "boolean", "description": "Whether the subscription offer in any new locations Play may launch in the future. If not specified, this will default to false." } }, "id": "OtherRegionsSubscriptionOfferConfig" }, "SubscriptionPurchasesDeferResponse": { "properties": { "newExpiryTimeMillis": { "description": "The new expiry time for the subscription in milliseconds since the Epoch.", "type": "string", "format": "int64" } }, "id": "SubscriptionPurchasesDeferResponse", "type": "object", "description": "Response for the purchases.subscriptions.defer API." }, "UploadAppStoreAppPolicyDeclarationFileResponse": { "description": "Response for uploading a policy declaration file.", "id": "UploadAppStoreAppPolicyDeclarationFileResponse", "properties": { "fileId": { "type": "string", "description": "The unique ID of the uploaded file." } }, "type": "object" }, "ApkDescription": { "id": "ApkDescription", "description": "Description of the created apks.", "properties": { "splitApkMetadata": { "description": "Set only for Split APKs.", "$ref": "SplitApkMetadata" }, "instantApkMetadata": { "description": "Set only for Instant split APKs.", "$ref": "SplitApkMetadata" }, "standaloneApkMetadata": { "$ref": "StandaloneApkMetadata", "description": "Set only for standalone APKs." }, "path": { "type": "string", "description": "Path of the Apk, will be in the following format: .apk where DownloadId is the ID used to download the apk using GeneratedApks.Download API." }, "assetSliceMetadata": { "$ref": "SplitApkMetadata", "description": "Set only for asset slices." }, "targeting": { "$ref": "ApkTargeting", "description": "Apk-level targeting." } }, "type": "object" }, "GetOneTimeProductOfferRequest": { "description": "Request message for GetOneTimeProductOffers.", "type": "object", "properties": { "purchaseOptionId": { "description": "Required. The parent purchase option (ID) of the offer to get.", "type": "string" }, "packageName": { "type": "string", "description": "Required. The parent app (package name) of the offer to get." }, "productId": { "type": "string", "description": "Required. The parent one-time product (ID) of the offer to get." }, "offerId": { "description": "Required. The unique offer ID of the offer to get.", "type": "string" } }, "id": "GetOneTimeProductOfferRequest" }, "BatchUpdateBasePlanStatesRequest": { "id": "BatchUpdateBasePlanStatesRequest", "description": "Request message for BatchUpdateBasePlanStates.", "properties": { "requests": { "description": "Required. The update request list of up to 100 elements. All requests must update different base plans.", "items": { "$ref": "UpdateBasePlanStateRequest" }, "type": "array" } }, "type": "object" }, "VariantTargeting": { "type": "object", "description": "Targeting on the level of variants.", "properties": { "screenDensityTargeting": { "description": "The screen densities that this variant supports", "$ref": "ScreenDensityTargeting" }, "sdkVersionTargeting": { "$ref": "SdkVersionTargeting", "description": "The sdk version that the variant targets" }, "textureCompressionFormatTargeting": { "description": "Texture-compression-format-level targeting", "$ref": "TextureCompressionFormatTargeting" }, "abiTargeting": { "description": "The abi that the variant targets", "$ref": "AbiTargeting" }, "multiAbiTargeting": { "$ref": "MultiAbiTargeting", "description": "Multi-api-level targeting" } }, "id": "VariantTargeting" }, "RecentUpdateEvent": { "type": "object", "description": "A recent update event.", "id": "RecentUpdateEvent", "properties": { "updateType": { "type": "string", "enum": [ "UPDATE_TYPE_UNSPECIFIED", "MODIFICATION", "DELETION" ], "enumDescriptions": [ "Default value. This value is not used.", "The app was modified.", "The app stopped being eligible for catalog inclusion or was removed from the Play Store." ], "description": "The type of the update event." }, "eventTime": { "description": "The timestamp of the update.", "type": "string", "format": "google-datetime" }, "playAppPackageName": { "description": "The package name of the app.", "type": "string" } } }, "CertificateHashes": { "type": "object", "id": "CertificateHashes", "description": "Hash digests of a certificate.", "properties": { "certificateHashSha256": { "description": "Hex-encoded SHA256 hash of the certificate. example: `94:49:C7:F3:A9:3C:F0:C5:5A:67:5D:DF:1C:83:73:2D:87:D5:62:55:E7:0B:15:0D:9E:6F:3C:F8:63:BB:7F:C1`", "type": "string" }, "certificateHashMd5": { "type": "string", "description": "Hex-encoded MD5 hash of the certificate. example: `43:51:43:A1:B5:FC:8B:B7:0A:3A:A9:B1:0F:66:73:A8`" }, "certificateHashSha1": { "description": "Hex-encoded SHA1 hash of the certificate. example: `86:61:97:1A:D5:EF:E5:74:1E:A7:5B:84:7C:68:37:65:CD:94:16:DE`", "type": "string" } } }, "RefundExternalTransactionRequest": { "id": "RefundExternalTransactionRequest", "description": "A request to refund an existing external transaction.", "type": "object", "properties": { "partialRefund": { "description": "A partial refund.", "$ref": "PartialRefund" }, "fullRefund": { "$ref": "FullRefund", "description": "A full-amount refund." }, "refundTime": { "description": "Required. The time that the transaction was refunded.", "type": "string", "format": "google-datetime" } } }, "UploadAppStoreAppPolicyDeclarationFileRequest": { "type": "object", "id": "UploadAppStoreAppPolicyDeclarationFileRequest", "properties": { "fileType": { "enumDescriptions": [ "Unspecified file type.", "File type for PDF, JPEG, and PNG documents." ], "description": "Required. Type of the policy declaration file.", "type": "string", "enum": [ "DECLARATION_FILE_TYPE_UNSPECIFIED", "DECLARATION_FILE_TYPE_DOCUMENT" ] } }, "description": "Request to upload a policy declaration file." }, "InAppProduct": { "id": "InAppProduct", "type": "object", "description": "An in-app product. The resource for InappproductsService.", "properties": { "defaultLanguage": { "type": "string", "description": "Default language of the localized data, as defined by BCP-47. e.g. \"en-US\"." }, "purchaseType": { "enumDeprecated": [ false, false, true ], "type": "string", "description": "The type of the product, e.g. a recurring subscription.", "enumDescriptions": [ "Unspecified purchase type.", "The default product type - one time purchase.", "Deprecated: Subscriptions are no longer supported in the InAppProducts API. Use the Subscriptions API instead." ], "enum": [ "purchaseTypeUnspecified", "managedUser", "subscription" ] }, "listings": { "additionalProperties": { "$ref": "InAppProductListing" }, "type": "object", "description": "List of localized title and description data. Map key is the language of the localized data, as defined by BCP-47, e.g. \"en-US\"." }, "status": { "type": "string", "enum": [ "statusUnspecified", "active", "inactive" ], "enumDescriptions": [ "Unspecified status.", "The product is published and active in the store.", "The product is not published and therefore inactive in the store." ], "description": "The status of the product, e.g. whether it's active." }, "managedProductTaxesAndComplianceSettings": { "description": "Details about taxes and legal compliance. Only applicable to managed products.", "$ref": "ManagedProductTaxAndComplianceSettings" }, "prices": { "description": "Prices per buyer region. None of these can be zero, as in-app products are never free. Map key is region code, as defined by ISO 3166-2.", "type": "object", "additionalProperties": { "$ref": "Price" } }, "gracePeriod": { "description": "Deprecated: Subscriptions are no longer supported in the InAppProducts API. Use the Subscriptions API instead.", "deprecated": true, "type": "string" }, "trialPeriod": { "description": "Deprecated: Subscriptions are no longer supported in the InAppProducts API. Use the Subscriptions API instead.", "type": "string", "deprecated": true }, "sku": { "type": "string", "description": "Stock-keeping-unit (SKU) of the product, unique within an app." }, "subscriptionPeriod": { "description": "Deprecated: Subscriptions are no longer supported in the InAppProducts API. Use the Subscriptions API instead.", "deprecated": true, "type": "string" }, "packageName": { "description": "Package name of the parent app.", "type": "string" }, "defaultPrice": { "description": "Default price. Cannot be zero, as in-app products are never free. Always in the developer's Checkout merchant currency.", "$ref": "Price" }, "subscriptionTaxesAndComplianceSettings": { "deprecated": true, "description": "Deprecated: Subscriptions are no longer supported in the InAppProducts API. Use the Subscriptions API instead.", "$ref": "SubscriptionTaxAndComplianceSettings" } } }, "PurchaseOptionTaxAndComplianceSettings": { "id": "PurchaseOptionTaxAndComplianceSettings", "type": "object", "description": "Details about taxation, Google Play policy and legal compliance for one-time product purchase options.", "properties": { "withdrawalRightType": { "enumDescriptions": [ "", "", "" ], "description": "Optional. Digital content or service classification for products distributed to users in eligible regions. If unset, it defaults to `WITHDRAWAL_RIGHT_DIGITAL_CONTENT`. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.", "type": "string", "enum": [ "WITHDRAWAL_RIGHT_TYPE_UNSPECIFIED", "WITHDRAWAL_RIGHT_DIGITAL_CONTENT", "WITHDRAWAL_RIGHT_SERVICE" ] } } }, "ApkBinary": { "description": "Represents the binary payload of an APK.", "properties": { "sha256": { "type": "string", "description": "A sha256 hash of the APK payload, encoded as a hex string and matching the output of the sha256sum command." }, "sha1": { "type": "string", "description": "A sha1 hash of the APK payload, encoded as a hex string and matching the output of the sha1sum command." } }, "id": "ApkBinary", "type": "object" }, "ActivateOneTimeProductOfferRequest": { "id": "ActivateOneTimeProductOfferRequest", "properties": { "offerId": { "description": "Required. The offer ID of the offer to activate.", "type": "string" }, "productId": { "description": "Required. The parent one-time product (ID) of the offer to activate.", "type": "string" }, "latencyTolerance": { "enumDescriptions": [ "Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.", "The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.", "The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods." ], "description": "Optional. The latency tolerance for the propagation of this update. Defaults to latency-sensitive.", "type": "string", "enum": [ "PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT" ] }, "packageName": { "type": "string", "description": "Required. The parent app (package name) of the offer to activate." }, "purchaseOptionId": { "description": "Required. The parent purchase option (ID) of the offer to activate.", "type": "string" } }, "description": "Request message for ActivateOneTimeProductOffer.", "type": "object" }, "InappproductsBatchUpdateResponse": { "id": "InappproductsBatchUpdateResponse", "type": "object", "properties": { "inappproducts": { "description": "The updated or inserted in-app products.", "items": { "$ref": "InAppProduct" }, "type": "array" } }, "description": "Response for a batch in-app product update." }, "UpdateSubscriptionOfferStateRequest": { "properties": { "activateSubscriptionOfferRequest": { "$ref": "ActivateSubscriptionOfferRequest", "description": "Activates an offer. Once activated, the offer will be available to new subscribers." }, "deactivateSubscriptionOfferRequest": { "$ref": "DeactivateSubscriptionOfferRequest", "description": "Deactivates an offer. Once deactivated, the offer will become unavailable to new subscribers, but existing subscribers will maintain their subscription" } }, "type": "object", "id": "UpdateSubscriptionOfferStateRequest", "description": "Request message to update the state of a subscription offer." }, "RecentAppView": { "type": "object", "id": "RecentAppView", "properties": { "appView": { "$ref": "CatalogAppView", "description": "Recently updated app view." } }, "description": "Metadata about a recently updated app." }, "SystemOnChip": { "id": "SystemOnChip", "type": "object", "description": "Representation of a System-on-Chip (SoC) of an Android device. Can be used to target S+ devices.", "properties": { "model": { "description": "Required. The model of the SoC, eg. \"Tensor\" Value of build property \"ro.soc.model\" https://developer.android.com/reference/android/os/Build#SOC_MODEL Required.", "type": "string" }, "manufacturer": { "description": "Required. The designer of the SoC, eg. \"Google\" Value of build property \"ro.soc.manufacturer\" https://developer.android.com/reference/android/os/Build#SOC_MANUFACTURER Required.", "type": "string" } } }, "AppEdit": { "type": "object", "description": "An app edit. The resource for EditsService.", "properties": { "id": { "description": "Output only. Identifier of the edit. Can be used in subsequent API calls.", "readOnly": true, "type": "string" }, "expiryTimeSeconds": { "description": "Output only. The time (as seconds since Epoch) at which the edit will expire and will be no longer valid for use.", "type": "string", "readOnly": true } }, "id": "AppEdit" }, "DeviceRam": { "id": "DeviceRam", "properties": { "minBytes": { "format": "int64", "description": "Minimum RAM in bytes (bound included).", "type": "string" }, "maxBytes": { "description": "Maximum RAM in bytes (bound excluded).", "format": "int64", "type": "string" } }, "description": "Conditions about a device's RAM capabilities.", "type": "object" }, "AutoRenewingBasePlanType": { "properties": { "resubscribeState": { "type": "string", "enum": [ "RESUBSCRIBE_STATE_UNSPECIFIED", "RESUBSCRIBE_STATE_ACTIVE", "RESUBSCRIBE_STATE_INACTIVE" ], "description": "Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.", "enumDescriptions": [ "Unspecified state.", "Resubscribe is active.", "Resubscribe is inactive." ] }, "legacyCompatibleSubscriptionOfferId": { "type": "string", "description": "Subscription offer id which is legacy compatible. The backward compatible subscription offer is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one subscription offer can be marked as legacy compatible for a given renewing base plan. To have no Subscription offer as legacy compatible set this field as empty string." }, "legacyCompatible": { "description": "Whether the renewing base plan is backward compatible. The backward compatible base plan is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one renewing base plan can be marked as legacy compatible for a given subscription.", "type": "boolean" }, "billingPeriodDuration": { "description": "Required. Immutable. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center. The duration is immutable after the base plan is created.", "type": "string" }, "gracePeriodDuration": { "type": "string", "description": "Grace period of the subscription, specified in ISO 8601 format. Acceptable values must be in days and between P0D and the lesser of 30D and base plan billing period. If not specified, a default value will be used based on the billing period. The sum of gracePeriodDuration and accountHoldDuration must be between P30D and P60D days, inclusive." }, "accountHoldDuration": { "type": "string", "description": "Optional. Custom account hold period of the subscription, specified in ISO 8601 format. Acceptable values must be in days and between P0D and P60D. An empty field represents a recommended account hold, calculated as 60 days minus grace period. The sum of gracePeriodDuration and accountHoldDuration must be between P30D and P60D days, inclusive." }, "prorationMode": { "enumDescriptions": [ "Unspecified mode.", "Users will be charged for their new base plan at the end of their current billing period.", "Users will be charged for their new base plan immediately and in full. Any remaining period of their existing subscription will be used to extend the duration of the new billing plan." ], "description": "The proration mode for the base plan determines what happens when a user switches to this plan from another base plan. If unspecified, defaults to CHARGE_ON_NEXT_BILLING_DATE.", "type": "string", "enum": [ "SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED", "SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE", "SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY" ] } }, "type": "object", "description": "Represents a base plan that automatically renews at the end of its subscription period.", "id": "AutoRenewingBasePlanType" }, "AppStoreAppActiveApks": { "description": "Information about active APKs of an app store hosted app.", "id": "AppStoreAppActiveApks", "properties": { "activeApkSets": { "description": "Required. List specifying which APK sets are distributed together. This list should contain all APKs that you're distributing for this app. Add an entry for each individual installable set of APKs.", "items": { "$ref": "AppStoreAppActiveApkSet" }, "type": "array" } }, "type": "object" }, "LocalizedText": { "id": "LocalizedText", "type": "object", "properties": { "text": { "description": "The text in the given language.", "type": "string" }, "language": { "type": "string", "description": "Language localization code (a BCP-47 language tag; for example, \"de-AT\" for Austrian German)." } }, "description": "Localized text in given language." }, "Apk": { "description": "Information about an APK. The resource for ApksService.", "type": "object", "id": "Apk", "properties": { "binary": { "$ref": "ApkBinary", "description": "Information about the binary payload of this APK." }, "versionCode": { "format": "int32", "description": "The version code of the APK, as specified in the manifest file.", "type": "integer" } } }, "SafetyLabelsUpdateResponse": { "description": "Response for SafetyLabelsUpdate rpc.", "properties": {}, "type": "object", "id": "SafetyLabelsUpdateResponse" }, "PendingCancellation": { "properties": {}, "description": "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.", "id": "PendingCancellation", "type": "object" }, "DeactivatePurchaseOptionRequest": { "type": "object", "id": "DeactivatePurchaseOptionRequest", "properties": { "purchaseOptionId": { "type": "string", "description": "Required. The purchase option ID of the purchase option to deactivate." }, "packageName": { "description": "Required. The parent app (package name) of the purchase option to deactivate.", "type": "string" }, "productId": { "description": "Required. The parent one-time product (ID) of the purchase option to deactivate.", "type": "string" }, "latencyTolerance": { "description": "Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.", "type": "string", "enum": [ "PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT" ], "enumDescriptions": [ "Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.", "The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.", "The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods." ] } }, "description": "Request message for UpdatePurchaseOptionState." }, "TextureCompressionFormatTargeting": { "properties": { "value": { "items": { "$ref": "TextureCompressionFormat" }, "description": "The list of targeted TCFs. Should not be empty.", "type": "array" }, "alternatives": { "items": { "$ref": "TextureCompressionFormat" }, "description": "List of alternative TCFs (TCFs targeted by the sibling splits).", "type": "array" } }, "description": "Targeting by a texture compression format.", "id": "TextureCompressionFormatTargeting", "type": "object" }, "AppRecoveryAction": { "properties": { "cancelTime": { "format": "google-datetime", "description": "Timestamp of when the app recovery action is canceled by the developer. Only set if the recovery action has been canceled.", "type": "string" }, "remoteInAppUpdateData": { "$ref": "RemoteInAppUpdateData", "description": "Data about the remote in-app update action such as such as recovered user base, recoverable user base etc. Set only if the recovery action type is Remote In-App Update." }, "lastUpdateTime": { "description": "Timestamp of when the developer last updated recovery action. In case the action is cancelled, it corresponds to cancellation time. It is always set after creation of the recovery action.", "format": "google-datetime", "type": "string" }, "status": { "description": "The status of the recovery action.", "enumDescriptions": [ "RecoveryStatus is unspecified.", "The app recovery action has not been canceled since it has been created.", "The recovery action has been canceled. The action cannot be resumed.", "The recovery action is in the draft state and has not yet been deployed to users.", "The recovery action is generating recovery apks.", "The app recovery action generation has failed." ], "type": "string", "enum": [ "RECOVERY_STATUS_UNSPECIFIED", "RECOVERY_STATUS_ACTIVE", "RECOVERY_STATUS_CANCELED", "RECOVERY_STATUS_DRAFT", "RECOVERY_STATUS_GENERATION_IN_PROGRESS", "RECOVERY_STATUS_GENERATION_FAILED" ] }, "deployTime": { "type": "string", "format": "google-datetime", "description": "Timestamp of when the app recovery action is deployed to the users. Only set if the recovery action has been deployed." }, "targeting": { "description": "Specifies targeting criteria for the recovery action such as regions, android sdk versions, app versions etc.", "$ref": "Targeting" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Timestamp of when the app recovery action is created by the developer. It is always set after creation of the recovery action." }, "appRecoveryId": { "type": "string", "format": "int64", "description": "ID corresponding to the app recovery action." } }, "description": "Information about an app recovery action.", "id": "AppRecoveryAction", "type": "object" }, "MigrateBasePlanPricesResponse": { "properties": {}, "type": "object", "description": "Response message for MigrateBasePlanPrices.", "id": "MigrateBasePlanPricesResponse" }, "CompatibleScreen": { "type": "object", "description": "Compatible screens as listed in the `compatible-screens` Manifest tag.", "id": "CompatibleScreen", "properties": { "screenSize": { "description": "The screen size.", "enumDescriptions": [ "Unspecified screen size.", "Small screen size.", "Normal screen size.", "Large screen size.", "Extra large screen size." ], "type": "string", "enum": [ "SCREEN_SIZE_UNSPECIFIED", "SCREEN_SIZE_SMALL", "SCREEN_SIZE_NORMAL", "SCREEN_SIZE_LARGE", "SCREEN_SIZE_EXTRA_LARGE" ] }, "density": { "type": "string", "enum": [ "DENSITY_UNSPECIFIED", "DENSITY_NODPI", "DENSITY_LDPI", "DENSITY_MDPI", "DENSITY_TVDPI", "DENSITY_HDPI", "DENSITY_280", "DENSITY_XHDPI", "DENSITY_360", "DENSITY_400", "DENSITY_420", "DENSITY_XXHDPI", "DENSITY_560", "DENSITY_XXXHDPI" ], "enumDescriptions": [ "Unspecified density.", "No density.", "Low density.", "Medium density.", "TV density.", "High density.", "280 dpi.", "Extra high density.", "360 dpi.", "400 dpi.", "420 dpi.", "Extra extra high density.", "560 dpi.", "Extra extra extra high density." ], "description": "Screen density." } } }, "PageInfo": { "properties": { "totalResults": { "format": "int32", "type": "integer", "description": "Total number of results available on the backend ! The total number of results in the result set." }, "resultPerPage": { "format": "int32", "type": "integer", "description": "Maximum number of results returned in one page. ! The number of results included in the API response." }, "startIndex": { "type": "integer", "format": "int32", "description": "Index of the first result returned in the current page." } }, "description": "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.", "id": "PageInfo", "type": "object" }, "SubscriptionItemPriceChangeDetails": { "properties": { "newPrice": { "description": "New recurring price for the subscription item.", "$ref": "Money" }, "priceChangeMode": { "enumDescriptions": [ "Price change mode unspecified. This value should never be set.", "If the subscription price is decreasing.", "If the subscription price is increasing and the user needs to accept it.", "If the subscription price is increasing with opt out mode." ], "description": "Price change mode specifies how the subscription item price is changing.", "type": "string", "enum": [ "PRICE_CHANGE_MODE_UNSPECIFIED", "PRICE_DECREASE", "PRICE_INCREASE", "OPT_OUT_PRICE_INCREASE" ] }, "priceChangeState": { "type": "string", "enum": [ "PRICE_CHANGE_STATE_UNSPECIFIED", "OUTSTANDING", "CONFIRMED", "APPLIED", "CANCELED" ], "enumDescriptions": [ "Price change state unspecified. This value should not be used.", "Waiting for the user to agree for the price change.", "The price change is confirmed to happen for the user.", "The price change is applied, i.e. the user has started being charged the new price.", "The price change was canceled." ], "description": "State the price change is currently in." }, "expectedNewPriceChargeTime": { "format": "google-datetime", "description": "The renewal time at which the price change will become effective for the user. This is subject to change(to a future time) due to cases where the renewal time shifts like pause. This field is only populated if the price change has not taken effect.", "type": "string" } }, "description": "Price change related information of a subscription item.", "type": "object", "id": "SubscriptionItemPriceChangeDetails" }, "BatchUpdateOneTimeProductOfferStatesResponse": { "properties": { "oneTimeProductOffers": { "type": "array", "description": "The updated one-time product offers list, in the same order as the request.", "items": { "$ref": "OneTimeProductOffer" } } }, "id": "BatchUpdateOneTimeProductOfferStatesResponse", "description": "Response message for BatchUpdateOneTimeProductOfferStates.", "type": "object" }, "DeviceIdentifier": { "description": "Defines a device identifier for a device.", "type": "object", "properties": { "deviceBrand": { "type": "string", "description": "The brand of the device." }, "deviceModel": { "type": "string", "description": "The model of the device." } }, "id": "DeviceIdentifier" }, "CancellationContext": { "description": "Cancellation context of the purchases.subscriptionsv2.cancel API.", "id": "CancellationContext", "properties": { "cancellationType": { "type": "string", "enum": [ "CANCELLATION_TYPE_UNSPECIFIED", "USER_REQUESTED_STOP_RENEWALS", "DEVELOPER_REQUESTED_STOP_PAYMENTS" ], "description": "Required. The type of cancellation for the purchased subscription.", "enumDescriptions": [ "Cancellation type unspecified.", "Cancellation requested by the user, and the subscription can be restored. It only stops the subscription's next renewal. For an installment subscription, users still need to finish the commitment period. For more details on renewals and payments, see https://developer.android.com/google/play/billing/subscriptions#installments", "Cancellation requested by the developer, and the subscription cannot be restored. It stops the subscription's next payment. For an installment subscription, users will not need to pay the next payment and finish the commitment period. For more details on renewals and payments, see https://developer.android.com/google/play/billing/subscriptions#installments" ] } }, "type": "object" }, "PartialRefund": { "type": "object", "properties": { "refundId": { "description": "Required. A unique id distinguishing this partial refund. If the refund is successful, subsequent refunds with the same id will fail. Must be unique across refunds for one individual transaction.", "type": "string" }, "refundPreTaxAmount": { "$ref": "Price", "description": "Required. The pre-tax amount of the partial refund. Should be less than the remaining pre-tax amount of the transaction." } }, "description": "A partial refund of a transaction.", "id": "PartialRefund" }, "SplitApkVariant": { "description": "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.", "type": "object", "properties": { "apkSet": { "type": "array", "items": { "$ref": "ApkSet" }, "description": "Set of APKs, one set per module." }, "targeting": { "$ref": "VariantTargeting", "description": "Variant-level targeting." }, "variantNumber": { "type": "integer", "format": "int32", "description": "Number of the variant, starting at 0 (unless overridden). A device will receive APKs from the first variant that matches the device configuration, with higher variant numbers having priority over lower variant numbers." } }, "id": "SplitApkVariant" }, "OneTimeProductTaxAndComplianceSettings": { "id": "OneTimeProductTaxAndComplianceSettings", "description": "Details about taxation, Google Play policy and legal compliance for one-time products.", "type": "object", "properties": { "regionalTaxConfigs": { "items": { "$ref": "RegionalTaxConfig" }, "description": "Regional tax configuration.", "type": "array" }, "regionalProductAgeRatingInfos": { "items": { "$ref": "RegionalProductAgeRatingInfo" }, "type": "array", "description": "Regional age rating information. Currently this field is only supported for region code `US`." }, "isTokenizedDigitalAsset": { "type": "boolean", "description": "Whether this one-time product is declared as a product representing a tokenized digital asset." }, "productTaxCategoryCode": { "type": "string", "description": "Product tax category code to assign to the one-time product. Product tax category determines the transaction tax rates applied to the product. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/16408159) for more information." } } }, "FreeTrialOfferPhase": { "description": "Details about free trial offer phase.", "properties": {}, "type": "object", "id": "FreeTrialOfferPhase" }, "OfferPhase": { "id": "OfferPhase", "description": "Offer phase details.", "properties": { "freeTrial": { "description": "Set when the offer phase is a free trial.", "$ref": "FreeTrialOfferPhase" }, "prorationPeriod": { "description": "Set when the offer phase is a proration period.", "$ref": "ProrationPeriodOfferPhase" }, "basePrice": { "$ref": "BasePriceOfferPhase", "description": "Set when the offer phase is a base plan pricing phase." }, "introductoryPrice": { "$ref": "IntroductoryPriceOfferPhase", "description": "Set when the offer phase is an introductory price offer phase." } }, "type": "object" }, "AssetSliceSet": { "type": "object", "id": "AssetSliceSet", "description": "Set of asset slices belonging to a single asset module.", "properties": { "assetModuleMetadata": { "description": "Module level metadata.", "$ref": "AssetModuleMetadata" }, "apkDescription": { "description": "Asset slices.", "type": "array", "items": { "$ref": "ApkDescription" } } } }, "RefundDetails": { "id": "RefundDetails", "properties": { "total": { "description": "The total amount refunded, including tax.", "$ref": "Money" }, "tax": { "description": "The amount of tax refunded.", "$ref": "Money" } }, "type": "object", "description": "Details for a partial or full refund." } }, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "servicePath": "", "protocol": "rest", "revision": "20261021", "mtlsRootUrl": "https://androidpublisher.mtls.googleapis.com/", "id": "androidpublisher:v3", "basePath": "", "documentationLink": "https://developers.google.com/android-publisher", "name": "androidpublisher", "kind": "discovery#restDescription", "rootUrl": "https://androidpublisher.googleapis.com/", "resources": { "orders": { "methods": { "reviewrefund": { "httpMethod": "POST", "flatPath": "androidpublisher/v3/applications/{packageName}/orders/{orderId}:reviewrefund", "parameterOrder": [ "packageName", "orderId" ], "path": "androidpublisher/v3/applications/{packageName}/orders/{orderId}:reviewrefund", "parameters": { "packageName": { "type": "string", "description": "Required. The package name of the application for which this subscription or in-app item was purchased (for example, 'com.some.thing').", "location": "path", "required": true }, "orderId": { "description": "Required. The order ID provided to the user when the subscription or in-app order was purchased.", "location": "path", "required": true, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "description": "Provide refund preference and purchase usage for a chargeback request", "id": "androidpublisher.orders.reviewrefund", "request": { "$ref": "OrdersReviewRefundRequest" } }, "get": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "response": { "$ref": "Order" }, "path": "androidpublisher/v3/applications/{packageName}/orders/{orderId}", "description": "Get order details for a single order.", "parameters": { "packageName": { "description": "Required. The package name of the application for which this subscription or in-app item was purchased (for example, 'com.some.thing').", "location": "path", "required": true, "type": "string" }, "orderId": { "description": "Required. The order ID provided to the user when the subscription or in-app order was purchased.", "type": "string", "location": "path", "required": true } }, "parameterOrder": [ "packageName", "orderId" ], "flatPath": "androidpublisher/v3/applications/{packageName}/orders/{orderId}", "id": "androidpublisher.orders.get" }, "refund": { "description": "Refunds a user's subscription or in-app purchase order. Orders older than 3 years cannot be refunded.", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "id": "androidpublisher.orders.refund", "flatPath": "androidpublisher/v3/applications/{packageName}/orders/{orderId}:refund", "parameterOrder": [ "packageName", "orderId" ], "httpMethod": "POST", "parameters": { "packageName": { "description": "The package name of the application for which this subscription or in-app item was purchased (for example, 'com.some.thing').", "type": "string", "location": "path", "required": true }, "revoke": { "description": "Whether to revoke the purchased item. If set to true, access to the subscription or in-app item will be terminated immediately. If the item is a recurring subscription, all future payments will also be terminated. Consumed in-app items need to be handled by developer's app. (optional).", "type": "boolean", "location": "query" }, "orderId": { "description": "The order ID provided to the user when the subscription or in-app order was purchased.", "type": "string", "location": "path", "required": true } }, "path": "androidpublisher/v3/applications/{packageName}/orders/{orderId}:refund" }, "batchget": { "httpMethod": "GET", "description": "Get order details for a list of orders.", "id": "androidpublisher.orders.batchget", "response": { "$ref": "BatchGetOrdersResponse" }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "path": "androidpublisher/v3/applications/{packageName}/orders:batchGet", "flatPath": "androidpublisher/v3/applications/{packageName}/orders:batchGet", "parameters": { "packageName": { "type": "string", "description": "Required. The package name of the application for which this subscription or in-app item was purchased (for example, 'com.some.thing').", "location": "path", "required": true }, "orderIds": { "description": "Required. The list of order IDs to retrieve order details for. There must be between 1 and 1000 (inclusive) order IDs per request. If any order ID is not found or does not match the provided package, the entire request will fail with an error. The order IDs must be distinct.", "type": "string", "repeated": true, "location": "query" } }, "parameterOrder": [ "packageName" ] } } }, "monetization": { "methods": { "convertRegionPrices": { "request": { "$ref": "ConvertRegionPricesRequest" }, "parameterOrder": [ "packageName" ], "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "response": { "$ref": "ConvertRegionPricesResponse" }, "parameters": { "packageName": { "description": "Required. The app package name.", "location": "path", "required": true, "type": "string" } }, "id": "androidpublisher.monetization.convertRegionPrices", "flatPath": "androidpublisher/v3/applications/{packageName}/pricing:convertRegionPrices", "path": "androidpublisher/v3/applications/{packageName}/pricing:convertRegionPrices", "httpMethod": "POST", "description": "Calculates the region prices, using today's exchange rate and country-specific pricing patterns, based on the price in the request for a set of regions." } }, "resources": { "onetimeproducts": { "resources": { "purchaseOptions": { "resources": { "offers": { "methods": { "batchGet": { "parameters": { "productId": { "location": "path", "required": true, "type": "string", "description": "Required. The product ID of the parent one-time product, if all updated offers belong to the same product. If this request spans multiple one-time products, set this field to \"-\"." }, "packageName": { "type": "string", "location": "path", "required": true, "description": "Required. The parent app (package name) of the updated offers. Must be equal to the package_name field on all the updated OneTimeProductOffer resources." }, "purchaseOptionId": { "location": "path", "required": true, "type": "string", "description": "Required. The parent purchase option (ID) for which the offers should be updated. May be specified as '-' to update offers from multiple purchase options." } }, "flatPath": "androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers:batchGet", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "id": "androidpublisher.monetization.onetimeproducts.purchaseOptions.offers.batchGet", "description": "Reads one or more one-time product offers.", "httpMethod": "POST", "path": "androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers:batchGet", "request": { "$ref": "BatchGetOneTimeProductOffersRequest" }, "parameterOrder": [ "packageName", "productId", "purchaseOptionId" ], "response": { "$ref": "BatchGetOneTimeProductOffersResponse" } }, "deactivate": { "flatPath": "androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers/{offerId}:deactivate", "id": "androidpublisher.monetization.onetimeproducts.purchaseOptions.offers.deactivate", "path": "androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers/{offerId}:deactivate", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "description": "Deactivates a one-time product offer.", "parameterOrder": [ "packageName", "productId", "purchaseOptionId", "offerId" ], "parameters": { "purchaseOptionId": { "type": "string", "location": "path", "required": true, "description": "Required. The parent purchase option (ID) of the offer to deactivate." }, "offerId": { "description": "Required. The offer ID of the offer to deactivate.", "type": "string", "location": "path", "required": true }, "packageName": { "type": "string", "location": "path", "required": true, "description": "Required. The parent app (package name) of the offer to deactivate." }, "productId": { "location": "path", "required": true, "description": "Required. The parent one-time product (ID) of the offer to deactivate.", "type": "string" } }, "request": { "$ref": "DeactivateOneTimeProductOfferRequest" }, "response": { "$ref": "OneTimeProductOffer" } }, "cancel": { "flatPath": "androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers/{offerId}:cancel", "httpMethod": "POST", "request": { "$ref": "CancelOneTimeProductOfferRequest" }, "path": "androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers/{offerId}:cancel", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "id": "androidpublisher.monetization.onetimeproducts.purchaseOptions.offers.cancel", "parameters": { "productId": { "location": "path", "required": true, "type": "string", "description": "Required. The parent one-time product (ID) of the offer to cancel." }, "packageName": { "description": "Required. The parent app (package name) of the offer to cancel.", "type": "string", "location": "path", "required": true }, "purchaseOptionId": { "description": "Required. The parent purchase option (ID) of the offer to cancel.", "location": "path", "required": true, "type": "string" }, "offerId": { "location": "path", "required": true, "type": "string", "description": "Required. The offer ID of the offer to cancel." } }, "response": { "$ref": "OneTimeProductOffer" }, "parameterOrder": [ "packageName", "productId", "purchaseOptionId", "offerId" ], "description": "Cancels a one-time product offer." }, "activate": { "path": "androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers/{offerId}:activate", "httpMethod": "POST", "id": "androidpublisher.monetization.onetimeproducts.purchaseOptions.offers.activate", "description": "Activates a one-time product offer.", "request": { "$ref": "ActivateOneTimeProductOfferRequest" }, "flatPath": "androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers/{offerId}:activate", "parameters": { "purchaseOptionId": { "description": "Required. The parent purchase option (ID) of the offer to activate.", "location": "path", "required": true, "type": "string" }, "packageName": { "description": "Required. The parent app (package name) of the offer to activate.", "type": "string", "location": "path", "required": true }, "offerId": { "type": "string", "location": "path", "required": true, "description": "Required. The offer ID of the offer to activate." }, "productId": { "description": "Required. The parent one-time product (ID) of the offer to activate.", "type": "string", "location": "path", "required": true } }, "response": { "$ref": "OneTimeProductOffer" }, "parameterOrder": [ "packageName", "productId", "purchaseOptionId", "offerId" ], "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ] }, "batchDelete": { "path": "androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers:batchDelete", "request": { "$ref": "BatchDeleteOneTimeProductOffersRequest" }, "parameterOrder": [ "packageName", "productId", "purchaseOptionId" ], "httpMethod": "POST", "id": "androidpublisher.monetization.onetimeproducts.purchaseOptions.offers.batchDelete", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "description": "Deletes one or more one-time product offers.", "flatPath": "androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers:batchDelete", "parameters": { "purchaseOptionId": { "description": "Required. The parent purchase option (ID) for which the offers should be deleted. May be specified as '-' to update offers from multiple purchase options.", "location": "path", "required": true, "type": "string" }, "packageName": { "type": "string", "description": "Required. The parent app (package name) of the offers to delete. Must be equal to the package_name field on all the OneTimeProductOffer resources.", "location": "path", "required": true }, "productId": { "type": "string", "location": "path", "required": true, "description": "Required. The product ID of the parent one-time product, if all offers to delete belong to the same product. If this request spans multiple one-time products, set this field to \"-\"." } } }, "batchUpdate": { "flatPath": "androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers:batchUpdate", "parameters": { "packageName": { "description": "Required. The parent app (package name) of the updated offers. Must be equal to the package_name field on all the updated OneTimeProductOffer resources.", "location": "path", "required": true, "type": "string" }, "purchaseOptionId": { "type": "string", "location": "path", "required": true, "description": "Required. The parent purchase option (ID) for which the offers should be updated. May be specified as '-' to update offers from multiple purchase options." }, "productId": { "type": "string", "description": "Required. The product ID of the parent one-time product, if all updated offers belong to the same product. If this request spans multiple one-time products, set this field to \"-\".", "location": "path", "required": true } }, "description": "Creates or updates one or more one-time product offers.", "id": "androidpublisher.monetization.onetimeproducts.purchaseOptions.offers.batchUpdate", "path": "androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers:batchUpdate", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "httpMethod": "POST", "parameterOrder": [ "packageName", "productId", "purchaseOptionId" ], "request": { "$ref": "BatchUpdateOneTimeProductOffersRequest" }, "response": { "$ref": "BatchUpdateOneTimeProductOffersResponse" } }, "list": { "path": "androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers", "description": "Lists all offers under a given app, product, or purchase option.", "parameterOrder": [ "packageName", "productId", "purchaseOptionId" ], "flatPath": "androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers", "id": "androidpublisher.monetization.onetimeproducts.purchaseOptions.offers.list", "httpMethod": "GET", "response": { "$ref": "ListOneTimeProductOffersResponse" }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameters": { "purchaseOptionId": { "description": "Required. The parent purchase option (ID) for which the offers should be read. May be specified as '-' to read all offers under a one-time product or an app. Must be specified as '-' if product_id is specified as '-'.", "type": "string", "location": "path", "required": true }, "packageName": { "location": "path", "required": true, "type": "string", "description": "Required. The parent app (package name) for which the offers should be read." }, "pageToken": { "description": "Optional. A page token, received from a previous `ListOneTimeProductsOffers` call. Provide this to retrieve the subsequent page. When paginating, product_id, package_name and purchase_option_id provided to `ListOneTimeProductsOffersRequest` must match the call that provided the page token.", "type": "string", "location": "query" }, "pageSize": { "type": "integer", "description": "Optional. The maximum number of offers to return. The service may return fewer than this value. If unspecified, at most 50 offers will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "format": "int32" }, "productId": { "type": "string", "description": "Required. The parent one-time product (ID) for which the offers should be read. May be specified as '-' to read all offers under an app.", "location": "path", "required": true } } }, "batchUpdateStates": { "request": { "$ref": "BatchUpdateOneTimeProductOfferStatesRequest" }, "flatPath": "androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers:batchUpdateStates", "parameters": { "packageName": { "description": "Required. The parent app (package name) of the updated one-time product offers.", "location": "path", "required": true, "type": "string" }, "purchaseOptionId": { "description": "Required. The purchase option ID of the parent purchase option, if all updated offers belong to the same purchase option. If this batch update spans multiple purchase options, set this field to \"-\".", "type": "string", "location": "path", "required": true }, "productId": { "type": "string", "description": "Required. The product ID of the parent one-time product, if all updated offers belong to the same one-time product. If this batch update spans multiple one-time products, set this field to \"-\".", "location": "path", "required": true } }, "id": "androidpublisher.monetization.onetimeproducts.purchaseOptions.offers.batchUpdateStates", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "path": "androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers:batchUpdateStates", "httpMethod": "POST", "response": { "$ref": "BatchUpdateOneTimeProductOfferStatesResponse" }, "parameterOrder": [ "packageName", "productId", "purchaseOptionId" ], "description": "Updates a batch of one-time product offer states." } } } }, "methods": { "batchDelete": { "flatPath": "androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions:batchDelete", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "path": "androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions:batchDelete", "parameters": { "productId": { "description": "Required. The product ID of the parent one-time product, if all purchase options to delete belong to the same one-time product. If this batch delete spans multiple one-time products, set this field to \"-\".", "location": "path", "required": true, "type": "string" }, "packageName": { "type": "string", "description": "Required. The parent app (package name) of the purchase options to delete.", "location": "path", "required": true } }, "id": "androidpublisher.monetization.onetimeproducts.purchaseOptions.batchDelete", "request": { "$ref": "BatchDeletePurchaseOptionsRequest" }, "parameterOrder": [ "packageName", "productId" ], "httpMethod": "POST", "description": "Deletes purchase options across one or multiple one-time products. By default this operation will fail if there are any existing offers under the deleted purchase options. Use the force parameter to override the default behavior." }, "batchUpdateStates": { "description": "Activates or deactivates purchase options across one or multiple one-time products.", "parameterOrder": [ "packageName", "productId" ], "request": { "$ref": "BatchUpdatePurchaseOptionStatesRequest" }, "parameters": { "productId": { "location": "path", "required": true, "type": "string", "description": "Required. The product ID of the parent one-time product, if all updated purchase options belong to the same one-time product. If this batch update spans multiple one-time products, set this field to \"-\"." }, "packageName": { "location": "path", "required": true, "type": "string", "description": "Required. The parent app (package name) of the updated purchase options." } }, "flatPath": "androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions:batchUpdateStates", "path": "androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions:batchUpdateStates", "response": { "$ref": "BatchUpdatePurchaseOptionStatesResponse" }, "id": "androidpublisher.monetization.onetimeproducts.purchaseOptions.batchUpdateStates", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "httpMethod": "POST" } } } }, "methods": { "batchDelete": { "request": { "$ref": "BatchDeleteOneTimeProductsRequest" }, "description": "Deletes one or more one-time products.", "parameters": { "packageName": { "type": "string", "description": "Required. The parent app (package name) for which the one-time products should be deleted. Must be equal to the package_name field on all the OneTimeProduct resources.", "location": "path", "required": true } }, "flatPath": "androidpublisher/v3/applications/{packageName}/oneTimeProducts:batchDelete", "parameterOrder": [ "packageName" ], "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "id": "androidpublisher.monetization.onetimeproducts.batchDelete", "httpMethod": "POST", "path": "androidpublisher/v3/applications/{packageName}/oneTimeProducts:batchDelete" }, "batchGet": { "flatPath": "androidpublisher/v3/applications/{packageName}/oneTimeProducts:batchGet", "description": "Reads one or more one-time products.", "parameters": { "packageName": { "location": "path", "required": true, "description": "Required. The parent app (package name) for which the products should be retrieved. Must be equal to the package_name field on all requests.", "type": "string" }, "productIds": { "description": "Required. A list of up to 100 product IDs to retrieve. All IDs must be different.", "repeated": true, "type": "string", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameterOrder": [ "packageName" ], "response": { "$ref": "BatchGetOneTimeProductsResponse" }, "httpMethod": "GET", "path": "androidpublisher/v3/applications/{packageName}/oneTimeProducts:batchGet", "id": "androidpublisher.monetization.onetimeproducts.batchGet" }, "get": { "parameterOrder": [ "packageName", "productId" ], "path": "androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "response": { "$ref": "OneTimeProduct" }, "id": "androidpublisher.monetization.onetimeproducts.get", "parameters": { "packageName": { "location": "path", "required": true, "description": "Required. The parent app (package name) of the product to retrieve.", "type": "string" }, "productId": { "location": "path", "required": true, "description": "Required. The product ID of the product to retrieve.", "type": "string" } }, "description": "Reads a single one-time product.", "flatPath": "androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}", "httpMethod": "GET" }, "batchUpdate": { "response": { "$ref": "BatchUpdateOneTimeProductsResponse" }, "parameterOrder": [ "packageName" ], "request": { "$ref": "BatchUpdateOneTimeProductsRequest" }, "parameters": { "packageName": { "description": "Required. The parent app (package name) for which the one-time products should be updated. Must be equal to the package_name field on all the OneTimeProduct resources.", "location": "path", "required": true, "type": "string" } }, "path": "androidpublisher/v3/applications/{packageName}/oneTimeProducts:batchUpdate", "description": "Creates or updates one or more one-time products.", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "id": "androidpublisher.monetization.onetimeproducts.batchUpdate", "httpMethod": "POST", "flatPath": "androidpublisher/v3/applications/{packageName}/oneTimeProducts:batchUpdate" }, "list": { "parameterOrder": [ "packageName" ], "path": "androidpublisher/v3/applications/{packageName}/oneTimeProducts", "flatPath": "androidpublisher/v3/applications/{packageName}/oneTimeProducts", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "id": "androidpublisher.monetization.onetimeproducts.list", "httpMethod": "GET", "description": "Lists all one-time products under a given app.", "parameters": { "pageSize": { "description": "Optional. The maximum number of one-time product to return. The service may return fewer than this value. If unspecified, at most 50 one-time products will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "packageName": { "description": "Required. The parent app (package name) for which the one-time product should be read.", "location": "path", "required": true, "type": "string" }, "pageToken": { "location": "query", "description": "Optional. A page token, received from a previous `ListOneTimeProducts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListOneTimeProducts` must match the call that provided the page token.", "type": "string" } }, "response": { "$ref": "ListOneTimeProductsResponse" } }, "patch": { "request": { "$ref": "OneTimeProduct" }, "response": { "$ref": "OneTimeProduct" }, "parameters": { "allowMissing": { "type": "boolean", "location": "query", "description": "Optional. If set to true, and the one-time product with the given package_name and product_id doesn't exist, the one-time product will be created. If a new one-time product is created, update_mask is ignored." }, "productId": { "location": "path", "required": true, "description": "Required. Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must start with a number or lowercase letter, and can contain numbers (0-9), lowercase letters (a-z), underscores (_), and periods (.).", "type": "string" }, "packageName": { "location": "path", "required": true, "description": "Required. Immutable. Package name of the parent app.", "type": "string" }, "updateMask": { "description": "Required. The list of fields to be updated.", "format": "google-fieldmask", "location": "query", "type": "string" }, "latencyTolerance": { "type": "string", "location": "query", "description": "Optional. The latency tolerance for the propagation of this product upsert. Defaults to latency-sensitive.", "enumDescriptions": [ "Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.", "The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.", "The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods." ], "enum": [ "PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT" ] }, "regionsVersion.version": { "description": "Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.", "type": "string", "location": "query" } }, "parameterOrder": [ "packageName", "productId" ], "description": "Creates or updates a one-time product.", "path": "androidpublisher/v3/applications/{packageName}/onetimeproducts/{productId}", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "flatPath": "androidpublisher/v3/applications/{packageName}/onetimeproducts/{productId}", "httpMethod": "PATCH", "id": "androidpublisher.monetization.onetimeproducts.patch" }, "delete": { "description": "Deletes a one-time product.", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameters": { "productId": { "location": "path", "required": true, "description": "Required. The one-time product ID of the one-time product to delete.", "type": "string" }, "packageName": { "location": "path", "required": true, "description": "Required. The parent app (package name) of the one-time product to delete.", "type": "string" }, "latencyTolerance": { "location": "query", "enumDescriptions": [ "Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.", "The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.", "The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods." ], "type": "string", "enum": [ "PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT" ], "description": "Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive." } }, "id": "androidpublisher.monetization.onetimeproducts.delete", "path": "androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}", "httpMethod": "DELETE", "flatPath": "androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}", "parameterOrder": [ "packageName", "productId" ] } } }, "subscriptions": { "methods": { "get": { "httpMethod": "GET", "flatPath": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}", "parameters": { "productId": { "type": "string", "description": "Required. The unique product ID of the subscription to get.", "location": "path", "required": true }, "packageName": { "location": "path", "required": true, "type": "string", "description": "Required. The parent app (package name) of the subscription to get." } }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "response": { "$ref": "Subscription" }, "parameterOrder": [ "packageName", "productId" ], "path": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}", "description": "Reads a single subscription.", "id": "androidpublisher.monetization.subscriptions.get" }, "list": { "path": "androidpublisher/v3/applications/{packageName}/subscriptions", "id": "androidpublisher.monetization.subscriptions.list", "flatPath": "androidpublisher/v3/applications/{packageName}/subscriptions", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "httpMethod": "GET", "parameterOrder": [ "packageName" ], "parameters": { "packageName": { "description": "Required. The parent app (package name) for which the subscriptions should be read.", "type": "string", "location": "path", "required": true }, "showArchived": { "deprecated": true, "location": "query", "type": "boolean", "description": "Deprecated: subscription archiving is not supported." }, "pageSize": { "format": "int32", "description": "The maximum number of subscriptions to return. The service may return fewer than this value. If unspecified, at most 50 subscriptions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer" }, "pageToken": { "type": "string", "description": "A page token, received from a previous `ListSubscriptions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscriptions` must match the call that provided the page token.", "location": "query" } }, "description": "Lists all subscriptions under a given app.", "response": { "$ref": "ListSubscriptionsResponse" } }, "batchGet": { "parameters": { "packageName": { "location": "path", "required": true, "type": "string", "description": "Required. The parent app (package name) for which the subscriptions should be retrieved. Must be equal to the package_name field on all the requests." }, "productIds": { "location": "query", "repeated": true, "type": "string", "description": "Required. A list of up to 100 subscription product IDs to retrieve. All the IDs must be different." } }, "path": "androidpublisher/v3/applications/{packageName}/subscriptions:batchGet", "flatPath": "androidpublisher/v3/applications/{packageName}/subscriptions:batchGet", "id": "androidpublisher.monetization.subscriptions.batchGet", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "httpMethod": "GET", "parameterOrder": [ "packageName" ], "description": "Reads one or more subscriptions.", "response": { "$ref": "BatchGetSubscriptionsResponse" } }, "create": { "description": "Creates a new subscription. Newly added base plans will remain in draft state until activated.", "httpMethod": "POST", "parameterOrder": [ "packageName" ], "flatPath": "androidpublisher/v3/applications/{packageName}/subscriptions", "request": { "$ref": "Subscription" }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "path": "androidpublisher/v3/applications/{packageName}/subscriptions", "parameters": { "packageName": { "description": "Required. The parent app (package name) for which the subscription should be created. Must be equal to the package_name field on the Subscription resource.", "location": "path", "required": true, "type": "string" }, "productId": { "type": "string", "location": "query", "description": "Required. The ID to use for the subscription. For the requirements on this format, see the documentation of the product_id field on the Subscription resource." }, "regionsVersion.version": { "type": "string", "description": "Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.", "location": "query" } }, "response": { "$ref": "Subscription" }, "id": "androidpublisher.monetization.subscriptions.create" }, "patch": { "parameterOrder": [ "packageName", "productId" ], "id": "androidpublisher.monetization.subscriptions.patch", "description": "Updates an existing subscription.", "request": { "$ref": "Subscription" }, "path": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameters": { "regionsVersion.version": { "location": "query", "type": "string", "description": "Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available." }, "updateMask": { "location": "query", "description": "Required. The list of fields to be updated.", "format": "google-fieldmask", "type": "string" }, "allowMissing": { "type": "boolean", "description": "Optional. If set to true, and the subscription with the given package_name and product_id doesn't exist, the subscription will be created. If a new subscription is created, update_mask is ignored.", "location": "query" }, "latencyTolerance": { "location": "query", "description": "Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.", "type": "string", "enumDescriptions": [ "Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.", "The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.", "The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods." ], "enum": [ "PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT" ] }, "packageName": { "type": "string", "location": "path", "required": true, "description": "Immutable. Package name of the parent app." }, "productId": { "description": "Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length.", "location": "path", "required": true, "type": "string" } }, "flatPath": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}", "response": { "$ref": "Subscription" }, "httpMethod": "PATCH" }, "delete": { "parameterOrder": [ "packageName", "productId" ], "httpMethod": "DELETE", "description": "Deletes a subscription. A subscription can only be deleted if it has never had a base plan published.", "parameters": { "packageName": { "location": "path", "required": true, "description": "Required. The parent app (package name) of the app of the subscription to delete.", "type": "string" }, "productId": { "type": "string", "description": "Required. The unique product ID of the subscription to delete.", "location": "path", "required": true } }, "path": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "id": "androidpublisher.monetization.subscriptions.delete", "flatPath": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}" }, "batchUpdate": { "httpMethod": "POST", "description": "Updates a batch of subscriptions. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.", "response": { "$ref": "BatchUpdateSubscriptionsResponse" }, "path": "androidpublisher/v3/applications/{packageName}/subscriptions:batchUpdate", "id": "androidpublisher.monetization.subscriptions.batchUpdate", "parameterOrder": [ "packageName" ], "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameters": { "packageName": { "location": "path", "required": true, "type": "string", "description": "Required. The parent app (package name) for which the subscriptions should be updated. Must be equal to the package_name field on all the Subscription resources." } }, "request": { "$ref": "BatchUpdateSubscriptionsRequest" }, "flatPath": "androidpublisher/v3/applications/{packageName}/subscriptions:batchUpdate" }, "archive": { "path": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}:archive", "flatPath": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}:archive", "deprecated": true, "description": "Deprecated: subscription archiving is not supported.", "parameters": { "packageName": { "type": "string", "description": "Required. The parent app (package name) of the app of the subscription to delete.", "location": "path", "required": true }, "productId": { "description": "Required. The unique product ID of the subscription to delete.", "location": "path", "required": true, "type": "string" } }, "id": "androidpublisher.monetization.subscriptions.archive", "request": { "$ref": "ArchiveSubscriptionRequest" }, "parameterOrder": [ "packageName", "productId" ], "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "httpMethod": "POST", "response": { "$ref": "Subscription" } } }, "resources": { "basePlans": { "methods": { "batchUpdateStates": { "parameterOrder": [ "packageName", "productId" ], "request": { "$ref": "BatchUpdateBasePlanStatesRequest" }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "response": { "$ref": "BatchUpdateBasePlanStatesResponse" }, "parameters": { "packageName": { "description": "Required. The parent app (package name) of the updated base plans.", "location": "path", "required": true, "type": "string" }, "productId": { "description": "Required. The product ID of the parent subscription, if all updated base plans belong to the same subscription. If this batch update spans multiple subscriptions, set this field to \"-\". Must be set.", "location": "path", "required": true, "type": "string" } }, "description": "Activates or deactivates base plans across one or multiple subscriptions. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.", "path": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans:batchUpdateStates", "id": "androidpublisher.monetization.subscriptions.basePlans.batchUpdateStates", "httpMethod": "POST", "flatPath": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans:batchUpdateStates" }, "deactivate": { "flatPath": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}:deactivate", "parameters": { "basePlanId": { "description": "Required. The unique base plan ID of the base plan to deactivate.", "location": "path", "required": true, "type": "string" }, "productId": { "description": "Required. The parent subscription (ID) of the base plan to deactivate.", "type": "string", "location": "path", "required": true }, "packageName": { "type": "string", "location": "path", "required": true, "description": "Required. The parent app (package name) of the base plan to deactivate." } }, "path": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}:deactivate", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameterOrder": [ "packageName", "productId", "basePlanId" ], "response": { "$ref": "Subscription" }, "request": { "$ref": "DeactivateBasePlanRequest" }, "id": "androidpublisher.monetization.subscriptions.basePlans.deactivate", "description": "Deactivates a base plan. Once deactivated, the base plan will become unavailable to new subscribers, but existing subscribers will maintain their subscription", "httpMethod": "POST" }, "delete": { "parameterOrder": [ "packageName", "productId", "basePlanId" ], "id": "androidpublisher.monetization.subscriptions.basePlans.delete", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "path": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}", "flatPath": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}", "parameters": { "basePlanId": { "type": "string", "description": "Required. The unique offer ID of the base plan to delete.", "location": "path", "required": true }, "packageName": { "location": "path", "required": true, "description": "Required. The parent app (package name) of the base plan to delete.", "type": "string" }, "productId": { "location": "path", "required": true, "type": "string", "description": "Required. The parent subscription (ID) of the base plan to delete." } }, "description": "Deletes a base plan. Can only be done for draft base plans. This action is irreversible.", "httpMethod": "DELETE" }, "activate": { "request": { "$ref": "ActivateBasePlanRequest" }, "response": { "$ref": "Subscription" }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameters": { "productId": { "description": "Required. The parent subscription (ID) of the base plan to activate.", "type": "string", "location": "path", "required": true }, "basePlanId": { "description": "Required. The unique base plan ID of the base plan to activate.", "type": "string", "location": "path", "required": true }, "packageName": { "type": "string", "location": "path", "required": true, "description": "Required. The parent app (package name) of the base plan to activate." } }, "parameterOrder": [ "packageName", "productId", "basePlanId" ], "description": "Activates a base plan. Once activated, base plans will be available to new subscribers.", "id": "androidpublisher.monetization.subscriptions.basePlans.activate", "httpMethod": "POST", "path": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}:activate", "flatPath": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}:activate" }, "batchMigratePrices": { "description": "Batch variant of the MigrateBasePlanPrices endpoint. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.", "id": "androidpublisher.monetization.subscriptions.basePlans.batchMigratePrices", "request": { "$ref": "BatchMigrateBasePlanPricesRequest" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "flatPath": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans:batchMigratePrices", "response": { "$ref": "BatchMigrateBasePlanPricesResponse" }, "path": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans:batchMigratePrices", "parameterOrder": [ "packageName", "productId" ], "parameters": { "packageName": { "type": "string", "description": "Required. The parent app (package name) for which the subscriptions should be created or updated. Must be equal to the package_name field on all the Subscription resources.", "location": "path", "required": true }, "productId": { "description": "Required. The product ID of the parent subscription, if all updated offers belong to the same subscription. If this batch update spans multiple subscriptions, set this field to \"-\". Must be set.", "type": "string", "location": "path", "required": true } } }, "migratePrices": { "request": { "$ref": "MigrateBasePlanPricesRequest" }, "id": "androidpublisher.monetization.subscriptions.basePlans.migratePrices", "parameters": { "productId": { "type": "string", "description": "Required. The ID of the subscription to update. Must be equal to the product_id field on the Subscription resource.", "location": "path", "required": true }, "basePlanId": { "location": "path", "required": true, "type": "string", "description": "Required. The unique base plan ID of the base plan to update prices on." }, "packageName": { "location": "path", "required": true, "type": "string", "description": "Required. Package name of the parent app. Must be equal to the package_name field on the Subscription resource." } }, "parameterOrder": [ "packageName", "productId", "basePlanId" ], "path": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}:migratePrices", "response": { "$ref": "MigrateBasePlanPricesResponse" }, "httpMethod": "POST", "flatPath": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}:migratePrices", "description": "Migrates subscribers from one or more legacy price cohorts to the current price. Requests result in Google Play notifying affected subscribers. Only up to 250 simultaneous legacy price cohorts are supported.", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ] } }, "resources": { "offers": { "methods": { "batchUpdateStates": { "parameterOrder": [ "packageName", "productId", "basePlanId" ], "request": { "$ref": "BatchUpdateSubscriptionOfferStatesRequest" }, "httpMethod": "POST", "response": { "$ref": "BatchUpdateSubscriptionOfferStatesResponse" }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "description": "Updates a batch of subscription offer states. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.", "path": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers:batchUpdateStates", "id": "androidpublisher.monetization.subscriptions.basePlans.offers.batchUpdateStates", "flatPath": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers:batchUpdateStates", "parameters": { "basePlanId": { "description": "Required. The parent base plan (ID) for which the offers should be updated. May be specified as '-' to update offers from multiple base plans.", "type": "string", "location": "path", "required": true }, "packageName": { "type": "string", "description": "Required. The parent app (package name) of the updated subscription offers. Must be equal to the package_name field on all the updated SubscriptionOffer resources.", "location": "path", "required": true }, "productId": { "location": "path", "required": true, "description": "Required. The product ID of the parent subscription, if all updated offers belong to the same subscription. If this request spans multiple subscriptions, set this field to \"-\". Must be set.", "type": "string" } } }, "delete": { "parameterOrder": [ "packageName", "productId", "basePlanId", "offerId" ], "description": "Deletes a subscription offer. Can only be done for draft offers. This action is irreversible.", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "id": "androidpublisher.monetization.subscriptions.basePlans.offers.delete", "httpMethod": "DELETE", "flatPath": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}", "parameters": { "productId": { "type": "string", "description": "Required. The parent subscription (ID) of the offer to delete.", "location": "path", "required": true }, "packageName": { "type": "string", "description": "Required. The parent app (package name) of the offer to delete.", "location": "path", "required": true }, "offerId": { "type": "string", "description": "Required. The unique offer ID of the offer to delete.", "location": "path", "required": true }, "basePlanId": { "location": "path", "required": true, "type": "string", "description": "Required. The parent base plan (ID) of the offer to delete." } }, "path": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}" }, "activate": { "parameterOrder": [ "packageName", "productId", "basePlanId", "offerId" ], "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameters": { "packageName": { "description": "Required. The parent app (package name) of the offer to activate.", "location": "path", "required": true, "type": "string" }, "productId": { "type": "string", "location": "path", "required": true, "description": "Required. The parent subscription (ID) of the offer to activate." }, "offerId": { "description": "Required. The unique offer ID of the offer to activate.", "type": "string", "location": "path", "required": true }, "basePlanId": { "type": "string", "location": "path", "required": true, "description": "Required. The parent base plan (ID) of the offer to activate." } }, "path": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}:activate", "response": { "$ref": "SubscriptionOffer" }, "flatPath": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}:activate", "description": "Activates a subscription offer. Once activated, subscription offers will be available to new subscribers.", "httpMethod": "POST", "id": "androidpublisher.monetization.subscriptions.basePlans.offers.activate", "request": { "$ref": "ActivateSubscriptionOfferRequest" } }, "list": { "flatPath": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers", "path": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers", "httpMethod": "GET", "description": "Lists all offers under a given subscription.", "parameterOrder": [ "packageName", "productId", "basePlanId" ], "id": "androidpublisher.monetization.subscriptions.basePlans.offers.list", "parameters": { "basePlanId": { "location": "path", "required": true, "type": "string", "description": "Required. The parent base plan (ID) for which the offers should be read. May be specified as '-' to read all offers under a subscription or an app. Must be specified as '-' if product_id is specified as '-'." }, "pageSize": { "location": "query", "type": "integer", "description": "The maximum number of subscriptions to return. The service may return fewer than this value. If unspecified, at most 50 subscriptions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32" }, "packageName": { "type": "string", "location": "path", "required": true, "description": "Required. The parent app (package name) for which the subscriptions should be read." }, "pageToken": { "type": "string", "description": "A page token, received from a previous `ListSubscriptionsOffers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscriptionOffers` must match the call that provided the page token.", "location": "query" }, "productId": { "description": "Required. The parent subscription (ID) for which the offers should be read. May be specified as '-' to read all offers under an app.", "location": "path", "required": true, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "response": { "$ref": "ListSubscriptionOffersResponse" } }, "batchGet": { "path": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers:batchGet", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "flatPath": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers:batchGet", "request": { "$ref": "BatchGetSubscriptionOffersRequest" }, "parameters": { "basePlanId": { "type": "string", "description": "Required. The parent base plan (ID) for which the offers should be read. May be specified as '-' to read offers from multiple base plans.", "location": "path", "required": true }, "productId": { "description": "Required. The product ID of the parent subscription, if all updated offers belong to the same subscription. If this request spans multiple subscriptions, set this field to \"-\". Must be set.", "type": "string", "location": "path", "required": true }, "packageName": { "description": "Required. The parent app (package name) for which the subscriptions should be created or updated. Must be equal to the package_name field on all the requests.", "location": "path", "required": true, "type": "string" } }, "description": "Reads one or more subscription offers.", "response": { "$ref": "BatchGetSubscriptionOffersResponse" }, "id": "androidpublisher.monetization.subscriptions.basePlans.offers.batchGet", "httpMethod": "POST", "parameterOrder": [ "packageName", "productId", "basePlanId" ] }, "create": { "parameterOrder": [ "packageName", "productId", "basePlanId" ], "path": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers", "response": { "$ref": "SubscriptionOffer" }, "parameters": { "productId": { "description": "Required. The parent subscription (ID) for which the offer should be created. Must be equal to the product_id field on the SubscriptionOffer resource.", "location": "path", "required": true, "type": "string" }, "basePlanId": { "location": "path", "required": true, "type": "string", "description": "Required. The parent base plan (ID) for which the offer should be created. Must be equal to the base_plan_id field on the SubscriptionOffer resource." }, "packageName": { "location": "path", "required": true, "type": "string", "description": "Required. The parent app (package name) for which the offer should be created. Must be equal to the package_name field on the Subscription resource." }, "regionsVersion.version": { "location": "query", "description": "Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.", "type": "string" }, "offerId": { "description": "Required. The ID to use for the offer. For the requirements on this format, see the documentation of the offer_id field on the SubscriptionOffer resource.", "type": "string", "location": "query" } }, "id": "androidpublisher.monetization.subscriptions.basePlans.offers.create", "request": { "$ref": "SubscriptionOffer" }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "httpMethod": "POST", "description": "Creates a new subscription offer. Only auto-renewing base plans can have subscription offers. The offer state will be DRAFT until it is activated.", "flatPath": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers" }, "batchUpdate": { "parameters": { "productId": { "location": "path", "required": true, "type": "string", "description": "Required. The product ID of the parent subscription, if all updated offers belong to the same subscription. If this request spans multiple subscriptions, set this field to \"-\". Must be set." }, "basePlanId": { "location": "path", "required": true, "description": "Required. The parent base plan (ID) for which the offers should be updated. May be specified as '-' to update offers from multiple base plans.", "type": "string" }, "packageName": { "location": "path", "required": true, "description": "Required. The parent app (package name) of the updated subscription offers. Must be equal to the package_name field on all the updated SubscriptionOffer resources.", "type": "string" } }, "response": { "$ref": "BatchUpdateSubscriptionOffersResponse" }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "id": "androidpublisher.monetization.subscriptions.basePlans.offers.batchUpdate", "path": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers:batchUpdate", "description": "Updates a batch of subscription offers. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.", "request": { "$ref": "BatchUpdateSubscriptionOffersRequest" }, "parameterOrder": [ "packageName", "productId", "basePlanId" ], "httpMethod": "POST", "flatPath": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers:batchUpdate" }, "get": { "parameterOrder": [ "packageName", "productId", "basePlanId", "offerId" ], "httpMethod": "GET", "id": "androidpublisher.monetization.subscriptions.basePlans.offers.get", "description": "Reads a single offer", "response": { "$ref": "SubscriptionOffer" }, "parameters": { "packageName": { "type": "string", "description": "Required. The parent app (package name) of the offer to get.", "location": "path", "required": true }, "offerId": { "type": "string", "location": "path", "required": true, "description": "Required. The unique offer ID of the offer to get." }, "basePlanId": { "location": "path", "required": true, "description": "Required. The parent base plan (ID) of the offer to get.", "type": "string" }, "productId": { "description": "Required. The parent subscription (ID) of the offer to get.", "type": "string", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "path": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}", "flatPath": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}" }, "deactivate": { "parameters": { "productId": { "location": "path", "required": true, "description": "Required. The parent subscription (ID) of the offer to deactivate.", "type": "string" }, "packageName": { "location": "path", "required": true, "type": "string", "description": "Required. The parent app (package name) of the offer to deactivate." }, "offerId": { "description": "Required. The unique offer ID of the offer to deactivate.", "location": "path", "required": true, "type": "string" }, "basePlanId": { "description": "Required. The parent base plan (ID) of the offer to deactivate.", "type": "string", "location": "path", "required": true } }, "id": "androidpublisher.monetization.subscriptions.basePlans.offers.deactivate", "response": { "$ref": "SubscriptionOffer" }, "request": { "$ref": "DeactivateSubscriptionOfferRequest" }, "httpMethod": "POST", "description": "Deactivates a subscription offer. Once deactivated, existing subscribers will maintain their subscription, but the offer will become unavailable to new subscribers.", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "path": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}:deactivate", "flatPath": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}:deactivate", "parameterOrder": [ "packageName", "productId", "basePlanId", "offerId" ] }, "patch": { "description": "Updates an existing subscription offer.", "request": { "$ref": "SubscriptionOffer" }, "id": "androidpublisher.monetization.subscriptions.basePlans.offers.patch", "flatPath": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}", "httpMethod": "PATCH", "response": { "$ref": "SubscriptionOffer" }, "parameterOrder": [ "packageName", "productId", "basePlanId", "offerId" ], "path": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameters": { "productId": { "type": "string", "description": "Required. Immutable. The ID of the parent subscription this offer belongs to.", "location": "path", "required": true }, "offerId": { "type": "string", "description": "Required. Immutable. Unique ID of this subscription offer. Must be unique within the base plan.", "location": "path", "required": true }, "regionsVersion.version": { "description": "Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.", "location": "query", "type": "string" }, "allowMissing": { "type": "boolean", "description": "Optional. If set to true, and the subscription offer with the given package_name, product_id, base_plan_id and offer_id doesn't exist, an offer will be created. If a new offer is created, update_mask is ignored.", "location": "query" }, "packageName": { "description": "Required. Immutable. The package name of the app the parent subscription belongs to.", "location": "path", "required": true, "type": "string" }, "basePlanId": { "description": "Required. Immutable. The ID of the base plan to which this offer is an extension.", "location": "path", "required": true, "type": "string" }, "updateMask": { "format": "google-fieldmask", "description": "Required. The list of fields to be updated.", "type": "string", "location": "query" }, "latencyTolerance": { "type": "string", "description": "Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.", "enum": [ "PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT" ], "enumDescriptions": [ "Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.", "The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.", "The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods." ], "location": "query" } } } } } } } } } } }, "appstoreappsreview": { "methods": { "createappstorehostedapp": { "response": { "$ref": "CreateAppStoreHostedAppResponse" }, "parameterOrder": [ "appStorePackageName" ], "parameters": { "appStorePackageName": { "description": "Required. Package name of the third-party app store.", "type": "string", "location": "path", "required": true } }, "description": "Creates an app store hosted app. This must be called before any other RPCs for this hosted app.", "path": "androidpublisher/v3/appstore/{appStorePackageName}/apps:create", "flatPath": "androidpublisher/v3/appstore/{appStorePackageName}/apps:create", "httpMethod": "POST", "request": { "$ref": "CreateAppStoreHostedAppRequest" }, "id": "androidpublisher.appstoreappsreview.createappstorehostedapp", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ] }, "uploadappstoreapppolicydeclarationfile": { "parameterOrder": [ "appStorePackageName", "packageName" ], "path": "androidpublisher/v3/appstore/{appStorePackageName}/apps/{packageName}/policyDeclarationFiles:upload", "supportsMediaUpload": true, "id": "androidpublisher.appstoreappsreview.uploadappstoreapppolicydeclarationfile", "flatPath": "androidpublisher/v3/appstore/{appStorePackageName}/apps/{packageName}/policyDeclarationFiles:upload", "parameters": { "appStorePackageName": { "description": "Required. Package name of the third-party app store.", "type": "string", "location": "path", "required": true }, "packageName": { "location": "path", "required": true, "description": "Required. Package name of the app.", "type": "string" } }, "request": { "$ref": "UploadAppStoreAppPolicyDeclarationFileRequest" }, "mediaUpload": { "protocols": { "resumable": { "multipart": true, "path": "/resumable/upload/androidpublisher/v3/appstore/{appStorePackageName}/apps/{packageName}/policyDeclarationFiles:upload" }, "simple": { "multipart": true, "path": "/upload/androidpublisher/v3/appstore/{appStorePackageName}/apps/{packageName}/policyDeclarationFiles:upload" } }, "accept": [ "application/pdf", "image/jpeg", "image/png" ], "maxSize": "10485760" }, "response": { "$ref": "UploadAppStoreAppPolicyDeclarationFileResponse" }, "description": "Upload a policy declaration file for the hosted app. Returns an ID to track the file.", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "httpMethod": "POST" }, "uploadapk": { "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameterOrder": [ "appStorePackageName", "packageName" ], "parameters": { "appStorePackageName": { "location": "path", "required": true, "description": "Required. Package name of the third-party app store.", "type": "string" }, "packageName": { "location": "path", "required": true, "type": "string", "description": "Required. Package name of the app." } }, "request": { "$ref": "UploadApkRequest" }, "description": "Upload an APK file for the hosted app. Returns an ID to track this APK.", "supportsMediaUpload": true, "mediaUpload": { "maxSize": "10737418240", "accept": [ "application/octet-stream", "application/vnd.android.package-archive" ], "protocols": { "resumable": { "path": "/resumable/upload/androidpublisher/v3/appstore/{appStorePackageName}/apps/{packageName}/apks:upload", "multipart": true }, "simple": { "multipart": true, "path": "/upload/androidpublisher/v3/appstore/{appStorePackageName}/apps/{packageName}/apks:upload" } } }, "path": "androidpublisher/v3/appstore/{appStorePackageName}/apps/{packageName}/apks:upload", "flatPath": "androidpublisher/v3/appstore/{appStorePackageName}/apps/{packageName}/apks:upload", "id": "androidpublisher.appstoreappsreview.uploadapk", "response": { "$ref": "UploadApkResponse" }, "httpMethod": "POST" }, "uploadimage": { "path": "androidpublisher/v3/appstore/{appStorePackageName}/apps/{packageName}/images:upload", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "description": "Upload a screenshot or app icon for the hosted app. Returns an ID to track the image.", "supportsMediaUpload": true, "parameterOrder": [ "appStorePackageName", "packageName" ], "flatPath": "androidpublisher/v3/appstore/{appStorePackageName}/apps/{packageName}/images:upload", "request": { "$ref": "UploadImageRequest" }, "id": "androidpublisher.appstoreappsreview.uploadimage", "mediaUpload": { "protocols": { "resumable": { "path": "/resumable/upload/androidpublisher/v3/appstore/{appStorePackageName}/apps/{packageName}/images:upload", "multipart": true }, "simple": { "multipart": true, "path": "/upload/androidpublisher/v3/appstore/{appStorePackageName}/apps/{packageName}/images:upload" } }, "accept": [ "image/*" ], "maxSize": "15728640" }, "parameters": { "packageName": { "description": "Required. Package name of the app.", "type": "string", "location": "path", "required": true }, "appStorePackageName": { "type": "string", "description": "Required. Package name of the third-party app store.", "location": "path", "required": true } }, "response": { "$ref": "UploadImageResponse" }, "httpMethod": "POST" }, "updateappstorehostedapp": { "flatPath": "androidpublisher/v3/appstore/{appStorePackageName}/apps:update", "path": "androidpublisher/v3/appstore/{appStorePackageName}/apps:update", "request": { "$ref": "UpdateAppStoreHostedAppRequest" }, "parameters": { "appStorePackageName": { "description": "Required. Package name of the third-party app store.", "type": "string", "location": "path", "required": true } }, "description": "Updates details for an app hosted on an app store. Use this to provide details for a new app, or to update details for an existing app. The update will be sent for review immediately after creation.", "id": "androidpublisher.appstoreappsreview.updateappstorehostedapp", "parameterOrder": [ "appStorePackageName" ], "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "httpMethod": "POST", "response": { "$ref": "UpdateAppStoreHostedAppResponse" } }, "updateappstorehostedapppublishstatus": { "parameters": { "packageName": { "description": "Required. Package name of the app.", "location": "path", "required": true, "type": "string" }, "appStorePackageName": { "type": "string", "description": "Required. Package name of the third-party app store.", "location": "path", "required": true } }, "id": "androidpublisher.appstoreappsreview.updateappstorehostedapppublishstatus", "response": { "$ref": "UpdateAppStoreHostedAppPublishStatusResponse" }, "flatPath": "androidpublisher/v3/appstore/{appStorePackageName}/apps/{packageName}:updateAppStoreHostedAppPublishStatus", "description": "Updates the publish status of an app store hosted app. The default state after calling UpdateAppStoreHostedApp is PUBLISHED. It is not necessary to call this RPC explicitly to set an app to PUBLISHED.", "path": "androidpublisher/v3/appstore/{appStorePackageName}/apps/{packageName}:updateAppStoreHostedAppPublishStatus", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "request": { "$ref": "UpdateAppStoreHostedAppPublishStatusRequest" }, "parameterOrder": [ "appStorePackageName", "packageName" ] } } }, "externaltransactions": { "methods": { "createexternaltransaction": { "id": "androidpublisher.externaltransactions.createexternaltransaction", "parameters": { "externalTransactionId": { "type": "string", "location": "query", "description": "Required. The id to use for the external transaction. Must be unique across all other transactions for the app. This value should be 1-63 characters and valid characters are /a-zA-Z0-9_-/. Do not use this field to store any Personally Identifiable Information (PII) such as emails. Attempting to store PII in this field may result in requests being blocked." }, "parent": { "type": "string", "pattern": "^applications/[^/]+$", "required": true, "description": "Required. The parent resource where this external transaction will be created. Format: applications/{package_name}", "location": "path" } }, "flatPath": "androidpublisher/v3/applications/{applicationsId}/externalTransactions", "parameterOrder": [ "parent" ], "path": "androidpublisher/v3/{+parent}/externalTransactions", "description": "Creates a new external transaction.", "httpMethod": "POST", "response": { "$ref": "ExternalTransaction" }, "request": { "$ref": "ExternalTransaction" }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ] }, "refundexternaltransaction": { "parameterOrder": [ "name" ], "response": { "$ref": "ExternalTransaction" }, "parameters": { "name": { "pattern": "^applications/[^/]+/externalTransactions/[^/]+$", "description": "Required. The name of the external transaction that will be refunded. Format: applications/{package_name}/externalTransactions/{external_transaction}", "location": "path", "type": "string", "required": true } }, "description": "Refunds or partially refunds an existing external transaction.", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "path": "androidpublisher/v3/{+name}:refund", "httpMethod": "POST", "id": "androidpublisher.externaltransactions.refundexternaltransaction", "flatPath": "androidpublisher/v3/applications/{applicationsId}/externalTransactions/{externalTransactionsId}:refund", "request": { "$ref": "RefundExternalTransactionRequest" } }, "getexternaltransaction": { "description": "Gets an existing external transaction.", "id": "androidpublisher.externaltransactions.getexternaltransaction", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "path": "androidpublisher/v3/{+name}", "flatPath": "androidpublisher/v3/applications/{applicationsId}/externalTransactions/{externalTransactionsId}", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "required": true, "type": "string", "pattern": "^applications/[^/]+/externalTransactions/[^/]+$", "description": "Required. The name of the external transaction to retrieve. Format: applications/{package_name}/externalTransactions/{external_transaction}" } }, "response": { "$ref": "ExternalTransaction" }, "httpMethod": "GET" } } }, "internalappsharingartifacts": { "methods": { "uploadapk": { "mediaUpload": { "accept": [ "application/octet-stream", "application/vnd.android.package-archive" ], "maxSize": "1073741824", "protocols": { "resumable": { "multipart": true, "path": "/resumable/upload/androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/apk" }, "simple": { "multipart": true, "path": "/upload/androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/apk" } } }, "parameters": { "packageName": { "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "flatPath": "androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/apk", "path": "androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/apk", "description": "Uploads an APK to internal app sharing. If you are using the Google API client libraries, please increase the timeout of the http request before calling this endpoint (a timeout of 2 minutes is recommended). See [Timeouts and Errors](https://developers.google.com/api-client-library/java/google-api-java-client/errors) for an example in java.", "response": { "$ref": "InternalAppSharingArtifact" }, "httpMethod": "POST", "supportsMediaUpload": true, "parameterOrder": [ "packageName" ], "id": "androidpublisher.internalappsharingartifacts.uploadapk" }, "uploadbundle": { "description": "Uploads an app bundle to internal app sharing. If you are using the Google API client libraries, please increase the timeout of the http request before calling this endpoint (a timeout of 2 minutes is recommended). See [Timeouts and Errors](https://developers.google.com/api-client-library/java/google-api-java-client/errors) for an example in java.", "path": "androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/bundle", "supportsMediaUpload": true, "httpMethod": "POST", "mediaUpload": { "accept": [ "application/octet-stream" ], "maxSize": "10737418240", "protocols": { "simple": { "multipart": true, "path": "/upload/androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/bundle" }, "resumable": { "multipart": true, "path": "/resumable/upload/androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/bundle" } } }, "flatPath": "androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/bundle", "response": { "$ref": "InternalAppSharingArtifact" }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameterOrder": [ "packageName" ], "parameters": { "packageName": { "location": "path", "required": true, "description": "Package name of the app.", "type": "string" } }, "id": "androidpublisher.internalappsharingartifacts.uploadbundle" } } }, "applications": { "resources": { "deviceTierConfigs": { "methods": { "list": { "description": "Returns created device tier configs, ordered by descending creation time.", "response": { "$ref": "ListDeviceTierConfigsResponse" }, "path": "androidpublisher/v3/applications/{packageName}/deviceTierConfigs", "parameters": { "pageToken": { "description": "A page token, received from a previous `ListDeviceTierConfigs` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, "pageSize": { "format": "int32", "description": "The maximum number of device tier configs to return. The service may return fewer than this value. If unspecified, at most 10 device tier configs will be returned. The maximum value for this field is 100; values above 100 will be coerced to 100. Device tier configs will be ordered by descending creation time.", "location": "query", "type": "integer" }, "packageName": { "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "id": "androidpublisher.applications.deviceTierConfigs.list", "flatPath": "androidpublisher/v3/applications/{packageName}/deviceTierConfigs", "httpMethod": "GET", "parameterOrder": [ "packageName" ] }, "get": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "id": "androidpublisher.applications.deviceTierConfigs.get", "response": { "$ref": "DeviceTierConfig" }, "description": "Returns a particular device tier config.", "flatPath": "androidpublisher/v3/applications/{packageName}/deviceTierConfigs/{deviceTierConfigId}", "parameterOrder": [ "packageName", "deviceTierConfigId" ], "path": "androidpublisher/v3/applications/{packageName}/deviceTierConfigs/{deviceTierConfigId}", "parameters": { "packageName": { "type": "string", "location": "path", "required": true, "description": "Package name of the app." }, "deviceTierConfigId": { "location": "path", "description": "Required. Id of an existing device tier config.", "required": true, "type": "string", "format": "int64" } } }, "create": { "path": "androidpublisher/v3/applications/{packageName}/deviceTierConfigs", "request": { "$ref": "DeviceTierConfig" }, "id": "androidpublisher.applications.deviceTierConfigs.create", "parameters": { "allowUnknownDevices": { "location": "query", "type": "boolean", "description": "Whether the service should accept device IDs that are unknown to Play's device catalog." }, "packageName": { "type": "string", "description": "Package name of the app.", "location": "path", "required": true } }, "parameterOrder": [ "packageName" ], "flatPath": "androidpublisher/v3/applications/{packageName}/deviceTierConfigs", "description": "Creates a new device tier config for an app.", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "response": { "$ref": "DeviceTierConfig" }, "httpMethod": "POST" } } }, "tracks": { "resources": { "releases": { "methods": { "list": { "response": { "$ref": "ListReleaseSummariesResponse" }, "httpMethod": "GET", "description": "Returns the list of all releases for a given track. This excludes any releases that are obsolete.", "id": "androidpublisher.applications.tracks.releases.list", "parameters": { "parent": { "pattern": "^applications/[^/]+/tracks/[^/]+$", "description": "Required. The parent track, which owns this collection of releases. Format: applications/{package_name}/tracks/{track}", "required": true, "type": "string", "location": "path" } }, "parameterOrder": [ "parent" ], "path": "androidpublisher/v3/{+parent}/releases", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "flatPath": "androidpublisher/v3/applications/{applicationsId}/tracks/{tracksId}/releases" } } } } } }, "methods": { "dataSafety": { "parameters": { "packageName": { "type": "string", "description": "Required. Package name of the app.", "location": "path", "required": true } }, "parameterOrder": [ "packageName" ], "description": "Writes the Safety Labels declaration of an app.", "flatPath": "androidpublisher/v3/applications/{packageName}/dataSafety", "path": "androidpublisher/v3/applications/{packageName}/dataSafety", "request": { "$ref": "SafetyLabelsUpdateRequest" }, "response": { "$ref": "SafetyLabelsUpdateResponse" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "id": "androidpublisher.applications.dataSafety" } } }, "systemapks": { "resources": { "variants": { "methods": { "get": { "id": "androidpublisher.systemapks.variants.get", "parameterOrder": [ "packageName", "versionCode", "variantId" ], "httpMethod": "GET", "response": { "$ref": "Variant" }, "description": "Returns a previously created system APK variant.", "flatPath": "androidpublisher/v3/applications/{packageName}/systemApks/{versionCode}/variants/{variantId}", "path": "androidpublisher/v3/applications/{packageName}/systemApks/{versionCode}/variants/{variantId}", "parameters": { "versionCode": { "location": "path", "format": "int64", "type": "string", "description": "The version code of the App Bundle.", "required": true }, "packageName": { "location": "path", "required": true, "description": "Package name of the app.", "type": "string" }, "variantId": { "format": "uint32", "description": "The ID of a previously created system APK variant.", "required": true, "type": "integer", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ] }, "list": { "path": "androidpublisher/v3/applications/{packageName}/systemApks/{versionCode}/variants", "response": { "$ref": "SystemApksListResponse" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "id": "androidpublisher.systemapks.variants.list", "parameters": { "packageName": { "description": "Package name of the app.", "type": "string", "location": "path", "required": true }, "versionCode": { "format": "int64", "location": "path", "type": "string", "description": "The version code of the App Bundle.", "required": true } }, "parameterOrder": [ "packageName", "versionCode" ], "flatPath": "androidpublisher/v3/applications/{packageName}/systemApks/{versionCode}/variants", "description": "Returns the list of previously created system APK variants." }, "download": { "parameterOrder": [ "packageName", "versionCode", "variantId" ], "useMediaDownloadService": true, "path": "androidpublisher/v3/applications/{packageName}/systemApks/{versionCode}/variants/{variantId}:download", "httpMethod": "GET", "flatPath": "androidpublisher/v3/applications/{packageName}/systemApks/{versionCode}/variants/{variantId}:download", "id": "androidpublisher.systemapks.variants.download", "supportsMediaDownload": true, "description": "Downloads a previously created system APK which is suitable for inclusion in a system image.", "parameters": { "versionCode": { "required": true, "format": "int64", "type": "string", "location": "path", "description": "The version code of the App Bundle." }, "variantId": { "format": "uint32", "location": "path", "type": "integer", "description": "The ID of a previously created system APK variant.", "required": true }, "packageName": { "location": "path", "required": true, "type": "string", "description": "Package name of the app." } }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ] }, "create": { "path": "androidpublisher/v3/applications/{packageName}/systemApks/{versionCode}/variants", "id": "androidpublisher.systemapks.variants.create", "flatPath": "androidpublisher/v3/applications/{packageName}/systemApks/{versionCode}/variants", "parameters": { "packageName": { "type": "string", "location": "path", "required": true, "description": "Package name of the app." }, "versionCode": { "type": "string", "location": "path", "format": "int64", "required": true, "description": "The version code of the App Bundle." } }, "description": "Creates an APK which is suitable for inclusion in a system image from an already uploaded Android App Bundle.", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameterOrder": [ "packageName", "versionCode" ], "response": { "$ref": "Variant" }, "request": { "$ref": "Variant" }, "httpMethod": "POST" } } } } }, "appstorecatalog": { "resources": { "recentupdateevents": { "methods": { "list": { "path": "androidpublisher/v3/appstorecatalog/{appStorePackageName}/recentUpdateEvents", "response": { "$ref": "ListRecentUpdateEventsResponse" }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameters": { "endTime": { "format": "google-datetime", "location": "query", "description": "Required. The end time of the range (exclusive).", "type": "string" }, "startTime": { "location": "query", "type": "string", "format": "google-datetime", "description": "Required. The start time of the range (inclusive)." }, "pageSize": { "type": "integer", "description": "Optional. The maximum number of update events to return. The service may return fewer than this value. If unspecified, at most 100 update events will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query" }, "pageToken": { "description": "Optional. A page token, received from a previous `ListRecentUpdateEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRecentUpdateEvents` must match the call that provided the page token.", "location": "query", "type": "string" }, "appStorePackageName": { "type": "string", "description": "Required. The package name of the app store on behalf of which the request is made.", "location": "path", "required": true } }, "description": "Lists update events for eligible apps in the given time range.", "parameterOrder": [ "appStorePackageName" ], "id": "androidpublisher.appstorecatalog.recentupdateevents.list", "httpMethod": "GET", "flatPath": "androidpublisher/v3/appstorecatalog/{appStorePackageName}/recentUpdateEvents" } } }, "recentappviews": { "methods": { "get": { "path": "androidpublisher/v3/appstorecatalog/{appStorePackageName}/recentAppViews/{playAppPackageName}", "response": { "$ref": "RecentAppView" }, "httpMethod": "GET", "id": "androidpublisher.appstorecatalog.recentappviews.get", "parameterOrder": [ "appStorePackageName", "playAppPackageName" ], "parameters": { "appStorePackageName": { "location": "path", "required": true, "type": "string", "description": "Required. The package name of the app store on behalf of which the request is made." }, "playAppPackageName": { "description": "Required. The package name of the requested Play app.", "type": "string", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "flatPath": "androidpublisher/v3/appstorecatalog/{appStorePackageName}/recentAppViews/{playAppPackageName}", "description": "Returns metadata about a recently updated app." } } } } }, "grants": { "methods": { "create": { "parameters": { "parent": { "location": "path", "description": "Required. The user which needs permission. Format: developers/{developer}/users/{user}", "required": true, "pattern": "^developers/[^/]+/users/[^/]+$", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameterOrder": [ "parent" ], "flatPath": "androidpublisher/v3/developers/{developersId}/users/{usersId}/grants", "request": { "$ref": "Grant" }, "id": "androidpublisher.grants.create", "httpMethod": "POST", "path": "androidpublisher/v3/{+parent}/grants", "response": { "$ref": "Grant" }, "description": "Grant access for a user to the given package." }, "patch": { "description": "Updates access for the user to the given package.", "flatPath": "androidpublisher/v3/developers/{developersId}/users/{usersId}/grants/{grantsId}", "parameterOrder": [ "name" ], "path": "androidpublisher/v3/{+name}", "httpMethod": "PATCH", "response": { "$ref": "Grant" }, "id": "androidpublisher.grants.patch", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameters": { "updateMask": { "format": "google-fieldmask", "location": "query", "type": "string", "description": "Optional. The list of fields to be updated." }, "name": { "required": true, "type": "string", "description": "Required. Resource name for this grant, following the pattern \"developers/{developer}/users/{email}/grants/{package_name}\". If this grant is for a draft app, the app ID will be used in this resource name instead of the package name.", "location": "path", "pattern": "^developers/[^/]+/users/[^/]+/grants/[^/]+$" } }, "request": { "$ref": "Grant" } }, "delete": { "parameterOrder": [ "name" ], "path": "androidpublisher/v3/{+name}", "id": "androidpublisher.grants.delete", "description": "Removes all access for the user to the given package or developer account.", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "httpMethod": "DELETE", "flatPath": "androidpublisher/v3/developers/{developersId}/users/{usersId}/grants/{grantsId}", "parameters": { "name": { "location": "path", "required": true, "type": "string", "pattern": "^developers/[^/]+/users/[^/]+/grants/[^/]+$", "description": "Required. The name of the grant to delete. Format: developers/{developer}/users/{email}/grants/{package_name}" } } } } }, "purchases": { "resources": { "subscriptionsv2": { "methods": { "get": { "parameterOrder": [ "packageName", "token" ], "flatPath": "androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}", "path": "androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}", "id": "androidpublisher.purchases.subscriptionsv2.get", "httpMethod": "GET", "description": "Get metadata about a subscription", "response": { "$ref": "SubscriptionPurchaseV2" }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameters": { "packageName": { "type": "string", "description": "The package of the application for which this subscription was purchased (for example, 'com.some.thing').", "location": "path", "required": true }, "token": { "type": "string", "location": "path", "required": true, "description": "Required. The token provided to the user's device when the subscription was purchased." } } }, "cancel": { "parameterOrder": [ "packageName", "token" ], "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "path": "androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}:cancel", "parameters": { "packageName": { "location": "path", "required": true, "type": "string", "description": "Required. The package of the application for which this subscription was purchased (for example, 'com.some.thing')." }, "token": { "location": "path", "required": true, "type": "string", "description": "Required. The token provided to the user's device when the subscription was purchased." } }, "response": { "$ref": "CancelSubscriptionPurchaseResponse" }, "request": { "$ref": "CancelSubscriptionPurchaseRequest" }, "id": "androidpublisher.purchases.subscriptionsv2.cancel", "httpMethod": "POST", "flatPath": "androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}:cancel", "description": "Cancel a subscription purchase for the user." }, "defer": { "description": "Defers the renewal of a subscription.", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "httpMethod": "POST", "response": { "$ref": "DeferSubscriptionPurchaseResponse" }, "request": { "$ref": "DeferSubscriptionPurchaseRequest" }, "flatPath": "androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}:defer", "id": "androidpublisher.purchases.subscriptionsv2.defer", "path": "androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}:defer", "parameters": { "packageName": { "type": "string", "description": "Required. The package of the application for which this subscription was purchased (for example, 'com.some.thing').", "location": "path", "required": true }, "token": { "description": "Required. The token provided to the user's device when the subscription was purchased.", "type": "string", "location": "path", "required": true } }, "parameterOrder": [ "packageName", "token" ] }, "revoke": { "flatPath": "androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}:revoke", "path": "androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}:revoke", "parameterOrder": [ "packageName", "token" ], "parameters": { "token": { "type": "string", "location": "path", "required": true, "description": "Required. The token provided to the user's device when the subscription was purchased." }, "packageName": { "location": "path", "required": true, "type": "string", "description": "Required. The package of the application for which this subscription was purchased (for example, 'com.some.thing')." } }, "request": { "$ref": "RevokeSubscriptionPurchaseRequest" }, "id": "androidpublisher.purchases.subscriptionsv2.revoke", "description": "Revoke a subscription purchase for the user.", "response": { "$ref": "RevokeSubscriptionPurchaseResponse" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ] } } }, "products": { "methods": { "consume": { "id": "androidpublisher.purchases.products.consume", "description": "Consumes a purchase for an inapp item.", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "path": "androidpublisher/v3/applications/{packageName}/purchases/products/{productId}/tokens/{token}:consume", "parameters": { "token": { "type": "string", "description": "The token provided to the user's device when the inapp product was purchased.", "location": "path", "required": true }, "packageName": { "location": "path", "required": true, "description": "The package name of the application the inapp product was sold in (for example, 'com.some.thing').", "type": "string" }, "productId": { "description": "The inapp product SKU (for example, 'com.some.thing.inapp1').", "type": "string", "location": "path", "required": true } }, "flatPath": "androidpublisher/v3/applications/{packageName}/purchases/products/{productId}/tokens/{token}:consume", "httpMethod": "POST", "parameterOrder": [ "packageName", "productId", "token" ] }, "get": { "path": "androidpublisher/v3/applications/{packageName}/purchases/products/{productId}/tokens/{token}", "httpMethod": "GET", "id": "androidpublisher.purchases.products.get", "parameterOrder": [ "packageName", "productId", "token" ], "response": { "$ref": "ProductPurchase" }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameters": { "productId": { "location": "path", "required": true, "type": "string", "description": "The inapp product SKU (for example, 'com.some.thing.inapp1')." }, "packageName": { "description": "The package name of the application the inapp product was sold in (for example, 'com.some.thing').", "type": "string", "location": "path", "required": true }, "token": { "description": "The token provided to the user's device when the inapp product was purchased.", "location": "path", "required": true, "type": "string" } }, "flatPath": "androidpublisher/v3/applications/{packageName}/purchases/products/{productId}/tokens/{token}", "description": "Checks the purchase and consumption status of an inapp item." }, "acknowledge": { "httpMethod": "POST", "request": { "$ref": "ProductPurchasesAcknowledgeRequest" }, "description": "Acknowledges a purchase of an inapp item.", "id": "androidpublisher.purchases.products.acknowledge", "parameters": { "productId": { "description": "The inapp product SKU (for example, 'com.some.thing.inapp1').", "location": "path", "required": true, "type": "string" }, "token": { "type": "string", "description": "The token provided to the user's device when the inapp product was purchased.", "location": "path", "required": true }, "packageName": { "type": "string", "location": "path", "required": true, "description": "The package name of the application the inapp product was sold in (for example, 'com.some.thing')." } }, "path": "androidpublisher/v3/applications/{packageName}/purchases/products/{productId}/tokens/{token}:acknowledge", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "flatPath": "androidpublisher/v3/applications/{packageName}/purchases/products/{productId}/tokens/{token}:acknowledge", "parameterOrder": [ "packageName", "productId", "token" ] } } }, "voidedpurchases": { "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameterOrder": [ "packageName" ], "id": "androidpublisher.purchases.voidedpurchases.list", "flatPath": "androidpublisher/v3/applications/{packageName}/purchases/voidedpurchases", "httpMethod": "GET", "path": "androidpublisher/v3/applications/{packageName}/purchases/voidedpurchases", "description": "Lists the purchases that were canceled, refunded or charged-back.", "response": { "$ref": "VoidedPurchasesListResponse" }, "parameters": { "token": { "type": "string", "description": "Defines the token of the page to return, usually taken from TokenPagination. This can only be used if token paging is enabled.", "location": "query" }, "includeQuantityBasedPartialRefund": { "type": "boolean", "location": "query", "description": "Optional. Whether to include voided purchases of quantity-based partial refunds, which are applicable only to multi-quantity purchases. If true, additional voided purchases may be returned with voidedQuantity that indicates the refund quantity of a quantity-based partial refund. The default value is false." }, "type": { "description": "The type of voided purchases that you want to see in the response. Possible values are: 0. Only voided in-app product purchases will be returned in the response. This is the default value. 1. Both voided in-app purchases and voided subscription purchases will be returned in the response. Note: Before requesting to receive voided subscription purchases, you must switch to use orderId in the response which uniquely identifies one-time purchases and subscriptions. Otherwise, you will receive multiple subscription orders with the same PurchaseToken, because subscription renewal orders share the same PurchaseToken.", "location": "query", "type": "integer", "format": "int32" }, "endTime": { "format": "int64", "location": "query", "type": "string", "description": "The time, in milliseconds since the Epoch, of the newest voided purchase that you want to see in the response. The value of this parameter cannot be greater than the current time and is ignored if a pagination token is set. Default value is current time. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response." }, "maxResults": { "description": "Defines how many results the list operation should return. The default number depends on the resource collection.", "type": "integer", "format": "uint32", "location": "query" }, "packageName": { "location": "path", "required": true, "description": "The package name of the application for which voided purchases need to be returned (for example, 'com.some.thing').", "type": "string" }, "startTime": { "format": "int64", "description": "The time, in milliseconds since the Epoch, of the oldest voided purchase that you want to see in the response. The value of this parameter cannot be older than 30 days and is ignored if a pagination token is set. Default value is current time minus 30 days. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response.", "location": "query", "type": "string" }, "startIndex": { "location": "query", "type": "integer", "format": "uint32", "description": "Defines the index of the first element to return. This can only be used if indexed paging is enabled." } } } } }, "subscriptions": { "methods": { "acknowledge": { "parameterOrder": [ "packageName", "subscriptionId", "token" ], "flatPath": "androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:acknowledge", "description": "Acknowledges a subscription purchase.", "id": "androidpublisher.purchases.subscriptions.acknowledge", "parameters": { "packageName": { "location": "path", "required": true, "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').", "type": "string" }, "token": { "location": "path", "required": true, "description": "The token provided to the user's device when the subscription was purchased.", "type": "string" }, "subscriptionId": { "description": "Note: Since May 21, 2025, subscription_id is not required, and not recommended for subscription with add-ons. The purchased subscription ID (for example, 'monthly001').", "location": "path", "required": true, "type": "string" } }, "path": "androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:acknowledge", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "request": { "$ref": "SubscriptionPurchasesAcknowledgeRequest" }, "httpMethod": "POST" }, "cancel": { "parameterOrder": [ "packageName", "subscriptionId", "token" ], "httpMethod": "POST", "flatPath": "androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:cancel", "description": "Deprecated: Use purchases.subscriptionsv2.cancel instead. Cancels a user's subscription purchase. The subscription remains valid until its expiration time. Newer version is available at purchases.subscriptionsv2.cancel for better client library support.", "id": "androidpublisher.purchases.subscriptions.cancel", "parameters": { "token": { "type": "string", "location": "path", "required": true, "description": "The token provided to the user's device when the subscription was purchased." }, "subscriptionId": { "location": "path", "required": true, "description": "Note: Since May 21, 2025, subscription_id is not required, and not recommended for subscription with add-ons. The purchased subscription ID (for example, 'monthly001').", "type": "string" }, "packageName": { "location": "path", "required": true, "type": "string", "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing')." } }, "path": "androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:cancel", "deprecated": true, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ] }, "defer": { "httpMethod": "POST", "description": "Deprecated: Use purchases.subscriptionsv2.defer instead. Defers a user's subscription purchase until a specified future expiration time.", "path": "androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:defer", "request": { "$ref": "SubscriptionPurchasesDeferRequest" }, "flatPath": "androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:defer", "response": { "$ref": "SubscriptionPurchasesDeferResponse" }, "parameters": { "subscriptionId": { "description": "The purchased subscription ID (for example, 'monthly001').", "type": "string", "location": "path", "required": true }, "token": { "description": "The token provided to the user's device when the subscription was purchased.", "location": "path", "required": true, "type": "string" }, "packageName": { "location": "path", "required": true, "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').", "type": "string" } }, "id": "androidpublisher.purchases.subscriptions.defer", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameterOrder": [ "packageName", "subscriptionId", "token" ], "deprecated": true } } }, "productsv2": { "methods": { "getproductpurchasev2": { "id": "androidpublisher.purchases.productsv2.getproductpurchasev2", "path": "androidpublisher/v3/applications/{packageName}/purchases/productsv2/tokens/{token}", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "flatPath": "androidpublisher/v3/applications/{packageName}/purchases/productsv2/tokens/{token}", "httpMethod": "GET", "response": { "$ref": "ProductPurchaseV2" }, "description": "Checks the purchase and consumption status of an inapp item.", "parameterOrder": [ "packageName", "token" ], "parameters": { "packageName": { "location": "path", "required": true, "type": "string", "description": "The package name of the application the inapp product was sold in (for example, 'com.some.thing')." }, "token": { "description": "The token provided to the user's device when the inapp product was purchased.", "location": "path", "required": true, "type": "string" } } } } } } }, "generatedapks": { "methods": { "download": { "description": "Downloads a single signed APK generated from an app bundle.", "parameterOrder": [ "packageName", "versionCode", "downloadId" ], "useMediaDownloadService": true, "id": "androidpublisher.generatedapks.download", "path": "androidpublisher/v3/applications/{packageName}/generatedApks/{versionCode}/downloads/{downloadId}:download", "httpMethod": "GET", "supportsMediaDownload": true, "flatPath": "androidpublisher/v3/applications/{packageName}/generatedApks/{versionCode}/downloads/{downloadId}:download", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameters": { "downloadId": { "type": "string", "location": "path", "required": true, "description": "Download ID, which uniquely identifies the APK to download. Can be obtained from the response of `generatedapks.list` method." }, "versionCode": { "description": "Version code of the app bundle.", "required": true, "type": "integer", "format": "int32", "location": "path" }, "packageName": { "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } } }, "list": { "description": "Returns download metadata for all APKs that were generated from a given app bundle.", "response": { "$ref": "GeneratedApksListResponse" }, "id": "androidpublisher.generatedapks.list", "parameters": { "packageName": { "description": "Package name of the app.", "type": "string", "location": "path", "required": true }, "versionCode": { "type": "integer", "required": true, "format": "int32", "location": "path", "description": "Version code of the app bundle." } }, "path": "androidpublisher/v3/applications/{packageName}/generatedApks/{versionCode}", "flatPath": "androidpublisher/v3/applications/{packageName}/generatedApks/{versionCode}", "httpMethod": "GET", "parameterOrder": [ "packageName", "versionCode" ], "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ] } } }, "apprecovery": { "methods": { "create": { "flatPath": "androidpublisher/v3/applications/{packageName}/appRecoveries", "parameters": { "packageName": { "type": "string", "location": "path", "required": true, "description": "Required. Package name of the app on which recovery action is performed." } }, "path": "androidpublisher/v3/applications/{packageName}/appRecoveries", "parameterOrder": [ "packageName" ], "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "response": { "$ref": "AppRecoveryAction" }, "request": { "$ref": "CreateDraftAppRecoveryRequest" }, "id": "androidpublisher.apprecovery.create", "description": "Create an app recovery action with recovery status as DRAFT. Note that this action does not execute the recovery action." }, "addTargeting": { "id": "androidpublisher.apprecovery.addTargeting", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "response": { "$ref": "AddTargetingResponse" }, "httpMethod": "POST", "request": { "$ref": "AddTargetingRequest" }, "parameterOrder": [ "packageName", "appRecoveryId" ], "path": "androidpublisher/v3/applications/{packageName}/appRecoveries/{appRecoveryId}:addTargeting", "parameters": { "packageName": { "description": "Required. Package name of the app for which recovery action is to be updated.", "type": "string", "location": "path", "required": true }, "appRecoveryId": { "location": "path", "format": "int64", "type": "string", "required": true, "description": "Required. ID corresponding to the app recovery action." } }, "flatPath": "androidpublisher/v3/applications/{packageName}/appRecoveries/{appRecoveryId}:addTargeting", "description": "Incrementally update targeting for a recovery action. Note that only the criteria selected during the creation of recovery action can be expanded." }, "deploy": { "flatPath": "androidpublisher/v3/applications/{packageName}/appRecoveries/{appRecoveryId}:deploy", "id": "androidpublisher.apprecovery.deploy", "request": { "$ref": "DeployAppRecoveryRequest" }, "parameters": { "packageName": { "type": "string", "description": "Required. Package name of the app for which recovery action is deployed.", "location": "path", "required": true }, "appRecoveryId": { "required": true, "type": "string", "format": "int64", "description": "Required. ID corresponding to the app recovery action to deploy.", "location": "path" } }, "path": "androidpublisher/v3/applications/{packageName}/appRecoveries/{appRecoveryId}:deploy", "description": "Deploy an already created app recovery action with recovery status DRAFT. Note that this action activates the recovery action for all targeted users and changes its status to ACTIVE.", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameterOrder": [ "packageName", "appRecoveryId" ], "httpMethod": "POST", "response": { "$ref": "DeployAppRecoveryResponse" } }, "list": { "response": { "$ref": "ListAppRecoveriesResponse" }, "parameterOrder": [ "packageName" ], "id": "androidpublisher.apprecovery.list", "parameters": { "packageName": { "type": "string", "location": "path", "required": true, "description": "Required. Package name of the app for which list of recovery actions is requested." }, "versionCode": { "type": "string", "description": "Required. Version code targeted by the list of recovery actions.", "location": "query", "format": "int64" } }, "path": "androidpublisher/v3/applications/{packageName}/appRecoveries", "description": "List all app recovery action resources associated with a particular package name and app version.", "flatPath": "androidpublisher/v3/applications/{packageName}/appRecoveries", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ] }, "cancel": { "httpMethod": "POST", "id": "androidpublisher.apprecovery.cancel", "description": "Cancel an already executing app recovery action. Note that this action changes status of the recovery action to CANCELED.", "parameterOrder": [ "packageName", "appRecoveryId" ], "response": { "$ref": "CancelAppRecoveryResponse" }, "flatPath": "androidpublisher/v3/applications/{packageName}/appRecoveries/{appRecoveryId}:cancel", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameters": { "packageName": { "description": "Required. Package name of the app for which recovery action cancellation is requested.", "type": "string", "location": "path", "required": true }, "appRecoveryId": { "description": "Required. ID corresponding to the app recovery action.", "location": "path", "format": "int64", "type": "string", "required": true } }, "path": "androidpublisher/v3/applications/{packageName}/appRecoveries/{appRecoveryId}:cancel", "request": { "$ref": "CancelAppRecoveryRequest" } } } }, "appsigning": { "methods": { "enrollApp": { "httpMethod": "POST", "description": "Enrolls an app in Play App Signing using a self-hosted Google Cloud KMS key. Warning: Do not use this method for standard Play App Signing enrollment. * Standard enrollment with Google-generated or Google-managed keys cannot be done via API. * This advanced API is strictly for enterprise organizations with mandatory compliance, regulatory, or policy requirements to retain key custody in an external Google Cloud KMS instance. * Prerequisites: Requires an active, properly configured Google Cloud KMS key with appropriate IAM permissions granted to Google Play before calling this method. See Help Center: https://support.google.com/googleplay/android-developer/answer/9842756", "id": "androidpublisher.appsigning.enrollApp", "parameterOrder": [ "name" ], "response": { "$ref": "EnrollAppResponse" }, "path": "androidpublisher/v3/applications/{name}/appSigning:enrollApp", "parameters": { "name": { "type": "string", "description": "Required. Either package name or app ID of the app enrolling in Play Signing.", "location": "path", "required": true } }, "flatPath": "androidpublisher/v3/applications/{name}/appSigning:enrollApp", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "request": { "$ref": "EnrollAppRequest" } }, "rotateAppSigningKey": { "response": { "$ref": "RotateAppSigningKeyResponse" }, "parameters": { "name": { "location": "path", "required": true, "type": "string", "description": "Required. Either package name or app ID of the app rotating the signing key." } }, "request": { "$ref": "RotateAppSigningKeyRequest" }, "description": "Rotates an app's signing key to a new self-hosted Google Cloud KMS key. Warning: This method only applies to apps enrolled with self-hosted Cloud KMS keys. For apps using standard Google-managed Play App Signing, key rotation requests must be initiated through the Google Play Console UI. See Help Center: https://support.google.com/googleplay/android-developer/answer/9842756", "id": "androidpublisher.appsigning.rotateAppSigningKey", "path": "androidpublisher/v3/applications/{name}/appSigning:rotateAppSigningKey", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "httpMethod": "POST", "parameterOrder": [ "name" ], "flatPath": "androidpublisher/v3/applications/{name}/appSigning:rotateAppSigningKey" } } }, "reviews": { "methods": { "list": { "description": "Lists all reviews.", "parameterOrder": [ "packageName" ], "flatPath": "androidpublisher/v3/applications/{packageName}/reviews", "httpMethod": "GET", "response": { "$ref": "ReviewsListResponse" }, "path": "androidpublisher/v3/applications/{packageName}/reviews", "parameters": { "maxResults": { "location": "query", "description": "How many results the list operation should return.", "format": "uint32", "type": "integer" }, "packageName": { "location": "path", "required": true, "type": "string", "description": "Package name of the app." }, "translationLanguage": { "location": "query", "type": "string", "description": "Language localization code." }, "token": { "type": "string", "location": "query", "description": "Pagination token. If empty, list starts at the first review." }, "startIndex": { "location": "query", "format": "uint32", "type": "integer", "description": "The index of the first element to return." } }, "id": "androidpublisher.reviews.list", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ] }, "get": { "id": "androidpublisher.reviews.get", "flatPath": "androidpublisher/v3/applications/{packageName}/reviews/{reviewId}", "parameters": { "translationLanguage": { "location": "query", "type": "string", "description": "Language localization code." }, "reviewId": { "type": "string", "location": "path", "required": true, "description": "Unique identifier for a review." }, "packageName": { "type": "string", "description": "Package name of the app.", "location": "path", "required": true } }, "path": "androidpublisher/v3/applications/{packageName}/reviews/{reviewId}", "parameterOrder": [ "packageName", "reviewId" ], "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "response": { "$ref": "Review" }, "description": "Gets a single review." }, "reply": { "request": { "$ref": "ReviewsReplyRequest" }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "httpMethod": "POST", "path": "androidpublisher/v3/applications/{packageName}/reviews/{reviewId}:reply", "response": { "$ref": "ReviewsReplyResponse" }, "parameterOrder": [ "packageName", "reviewId" ], "flatPath": "androidpublisher/v3/applications/{packageName}/reviews/{reviewId}:reply", "id": "androidpublisher.reviews.reply", "parameters": { "reviewId": { "location": "path", "required": true, "description": "Unique identifier for a review.", "type": "string" }, "packageName": { "location": "path", "required": true, "type": "string", "description": "Package name of the app." } }, "description": "Replies to a single review, or updates an existing reply." } } }, "inappproducts": { "methods": { "insert": { "parameterOrder": [ "packageName" ], "httpMethod": "POST", "request": { "$ref": "InAppProduct" }, "response": { "$ref": "InAppProduct" }, "description": "Creates an in-app product (a managed product or a subscription). This method should no longer be used to create subscriptions. See [this article](https://android-developers.googleblog.com/2023/06/changes-to-google-play-developer-api-june-2023.html) for more information.", "parameters": { "packageName": { "type": "string", "location": "path", "required": true, "description": "Package name of the app." }, "autoConvertMissingPrices": { "description": "If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false.", "type": "boolean", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "flatPath": "androidpublisher/v3/applications/{packageName}/inappproducts", "id": "androidpublisher.inappproducts.insert", "path": "androidpublisher/v3/applications/{packageName}/inappproducts" }, "batchDelete": { "request": { "$ref": "InappproductsBatchDeleteRequest" }, "description": "Deletes in-app products (managed products or subscriptions). Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput. This method should not be used to delete subscriptions. See [this article](https://android-developers.googleblog.com/2023/06/changes-to-google-play-developer-api-june-2023.html) for more information.", "httpMethod": "POST", "path": "androidpublisher/v3/applications/{packageName}/inappproducts:batchDelete", "parameterOrder": [ "packageName" ], "flatPath": "androidpublisher/v3/applications/{packageName}/inappproducts:batchDelete", "id": "androidpublisher.inappproducts.batchDelete", "parameters": { "packageName": { "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ] }, "delete": { "path": "androidpublisher/v3/applications/{packageName}/inappproducts/{sku}", "parameterOrder": [ "packageName", "sku" ], "description": "Deletes an in-app product (a managed product or a subscription). This method should no longer be used to delete subscriptions. See [this article](https://android-developers.googleblog.com/2023/06/changes-to-google-play-developer-api-june-2023.html) for more information.", "id": "androidpublisher.inappproducts.delete", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "flatPath": "androidpublisher/v3/applications/{packageName}/inappproducts/{sku}", "parameters": { "packageName": { "location": "path", "required": true, "description": "Package name of the app.", "type": "string" }, "sku": { "type": "string", "description": "Unique identifier for the in-app product.", "location": "path", "required": true }, "latencyTolerance": { "enumDescriptions": [ "Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.", "The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.", "The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods." ], "enum": [ "PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT" ], "description": "Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.", "type": "string", "location": "query" } }, "httpMethod": "DELETE" }, "get": { "response": { "$ref": "InAppProduct" }, "path": "androidpublisher/v3/applications/{packageName}/inappproducts/{sku}", "parameterOrder": [ "packageName", "sku" ], "httpMethod": "GET", "description": "Gets an in-app product, which can be a managed product or a subscription. This method should no longer be used to retrieve subscriptions. See [this article](https://android-developers.googleblog.com/2023/06/changes-to-google-play-developer-api-june-2023.html) for more information.", "id": "androidpublisher.inappproducts.get", "flatPath": "androidpublisher/v3/applications/{packageName}/inappproducts/{sku}", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameters": { "packageName": { "type": "string", "description": "Package name of the app.", "location": "path", "required": true }, "sku": { "type": "string", "location": "path", "required": true, "description": "Unique identifier for the in-app product." } } }, "update": { "parameters": { "latencyTolerance": { "type": "string", "enumDescriptions": [ "Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.", "The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.", "The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods." ], "description": "Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.", "enum": [ "PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT" ], "location": "query" }, "sku": { "type": "string", "location": "path", "required": true, "description": "Unique identifier for the in-app product." }, "packageName": { "type": "string", "location": "path", "required": true, "description": "Package name of the app." }, "allowMissing": { "type": "boolean", "location": "query", "description": "If set to true, and the in-app product with the given package_name and sku doesn't exist, the in-app product will be created." }, "autoConvertMissingPrices": { "type": "boolean", "location": "query", "description": "If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false." } }, "description": "Updates an in-app product (a managed product or a subscription). This method should no longer be used to update subscriptions. See [this article](https://android-developers.googleblog.com/2023/06/changes-to-google-play-developer-api-june-2023.html) for more information.", "parameterOrder": [ "packageName", "sku" ], "response": { "$ref": "InAppProduct" }, "httpMethod": "PUT", "flatPath": "androidpublisher/v3/applications/{packageName}/inappproducts/{sku}", "id": "androidpublisher.inappproducts.update", "request": { "$ref": "InAppProduct" }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "path": "androidpublisher/v3/applications/{packageName}/inappproducts/{sku}" }, "batchGet": { "flatPath": "androidpublisher/v3/applications/{packageName}/inappproducts:batchGet", "id": "androidpublisher.inappproducts.batchGet", "description": "Reads multiple in-app products, which can be managed products or subscriptions. This method should not be used to retrieve subscriptions. See [this article](https://android-developers.googleblog.com/2023/06/changes-to-google-play-developer-api-june-2023.html) for more information.", "parameters": { "sku": { "type": "string", "description": "Unique identifier for the in-app products.", "location": "query", "repeated": true }, "packageName": { "type": "string", "description": "Package name of the app.", "location": "path", "required": true } }, "path": "androidpublisher/v3/applications/{packageName}/inappproducts:batchGet", "parameterOrder": [ "packageName" ], "response": { "$ref": "InappproductsBatchGetResponse" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ] }, "batchUpdate": { "response": { "$ref": "InappproductsBatchUpdateResponse" }, "httpMethod": "POST", "id": "androidpublisher.inappproducts.batchUpdate", "request": { "$ref": "InappproductsBatchUpdateRequest" }, "path": "androidpublisher/v3/applications/{packageName}/inappproducts:batchUpdate", "description": "Updates or inserts one or more in-app products (managed products or subscriptions). Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput. This method should no longer be used to update subscriptions. See [this article](https://android-developers.googleblog.com/2023/06/changes-to-google-play-developer-api-june-2023.html) for more information.", "parameterOrder": [ "packageName" ], "parameters": { "packageName": { "type": "string", "location": "path", "required": true, "description": "Package name of the app." } }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "flatPath": "androidpublisher/v3/applications/{packageName}/inappproducts:batchUpdate" }, "patch": { "description": "Patches an in-app product (a managed product or a subscription). This method should no longer be used to update subscriptions. See [this article](https://android-developers.googleblog.com/2023/06/changes-to-google-play-developer-api-june-2023.html) for more information.", "response": { "$ref": "InAppProduct" }, "path": "androidpublisher/v3/applications/{packageName}/inappproducts/{sku}", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameters": { "sku": { "type": "string", "location": "path", "required": true, "description": "Unique identifier for the in-app product." }, "packageName": { "location": "path", "required": true, "description": "Package name of the app.", "type": "string" }, "latencyTolerance": { "description": "Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.", "location": "query", "enum": [ "PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE", "PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT" ], "type": "string", "enumDescriptions": [ "Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.", "The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.", "The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods." ] }, "autoConvertMissingPrices": { "location": "query", "type": "boolean", "description": "If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false." } }, "parameterOrder": [ "packageName", "sku" ], "id": "androidpublisher.inappproducts.patch", "httpMethod": "PATCH", "flatPath": "androidpublisher/v3/applications/{packageName}/inappproducts/{sku}", "request": { "$ref": "InAppProduct" } }, "list": { "flatPath": "androidpublisher/v3/applications/{packageName}/inappproducts", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameters": { "token": { "location": "query", "description": "Pagination token. If empty, list starts at the first product.", "type": "string" }, "packageName": { "type": "string", "location": "path", "required": true, "description": "Package name of the app." }, "startIndex": { "location": "query", "description": "Deprecated and ignored. Set the `token` parameter to retrieve the next page.", "type": "integer", "format": "uint32", "deprecated": true }, "maxResults": { "deprecated": true, "type": "integer", "description": "Deprecated and ignored. The page size is determined by the server.", "format": "uint32", "location": "query" } }, "description": "Lists all in-app products - both managed products and subscriptions. If an app has a large number of in-app products, the response may be paginated. In this case the response field `tokenPagination.nextPageToken` will be set and the caller should provide its value as a `token` request parameter to retrieve the next page. This method should no longer be used to retrieve subscriptions. See [this article](https://android-developers.googleblog.com/2023/06/changes-to-google-play-developer-api-june-2023.html) for more information.", "parameterOrder": [ "packageName" ], "id": "androidpublisher.inappproducts.list", "path": "androidpublisher/v3/applications/{packageName}/inappproducts", "httpMethod": "GET", "response": { "$ref": "InappproductsListResponse" } } } }, "users": { "methods": { "patch": { "parameterOrder": [ "name" ], "id": "androidpublisher.users.patch", "response": { "$ref": "User" }, "httpMethod": "PATCH", "description": "Updates access for the user to the developer account.", "request": { "$ref": "User" }, "flatPath": "androidpublisher/v3/developers/{developersId}/users/{usersId}", "path": "androidpublisher/v3/{+name}", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameters": { "name": { "pattern": "^developers/[^/]+/users/[^/]+$", "location": "path", "description": "Required. Resource name for this user, following the pattern \"developers/{developer}/users/{email}\".", "required": true, "type": "string" }, "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Optional. The list of fields to be updated.", "type": "string" } } }, "delete": { "httpMethod": "DELETE", "id": "androidpublisher.users.delete", "parameters": { "name": { "description": "Required. The name of the user to delete. Format: developers/{developer}/users/{email}", "type": "string", "required": true, "pattern": "^developers/[^/]+/users/[^/]+$", "location": "path" } }, "flatPath": "androidpublisher/v3/developers/{developersId}/users/{usersId}", "path": "androidpublisher/v3/{+name}", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameterOrder": [ "name" ], "description": "Removes all access for the user to the given developer account." }, "list": { "description": "Lists all users with access to a developer account.", "httpMethod": "GET", "id": "androidpublisher.users.list", "flatPath": "androidpublisher/v3/developers/{developersId}/users", "path": "androidpublisher/v3/{+parent}/users", "parameters": { "pageToken": { "location": "query", "type": "string", "description": "A token received from a previous call to this method, in order to retrieve further results." }, "pageSize": { "description": "The maximum number of results to return. This must be set to -1 to disable pagination.", "type": "integer", "format": "int32", "location": "query" }, "parent": { "location": "path", "description": "Required. The developer account to fetch users from. Format: developers/{developer}", "required": true, "type": "string", "pattern": "^developers/[^/]+$" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListUsersResponse" }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ] }, "create": { "path": "androidpublisher/v3/{+parent}/users", "parameters": { "parent": { "description": "Required. The developer account to add the user to. Format: developers/{developer}", "location": "path", "type": "string", "required": true, "pattern": "^developers/[^/]+$" } }, "response": { "$ref": "User" }, "request": { "$ref": "User" }, "id": "androidpublisher.users.create", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "flatPath": "androidpublisher/v3/developers/{developersId}/users", "httpMethod": "POST", "description": "Grant access for a user to the given developer account.", "parameterOrder": [ "parent" ] } } }, "edits": { "methods": { "get": { "parameters": { "editId": { "location": "path", "required": true, "type": "string", "description": "Identifier of the edit." }, "packageName": { "type": "string", "description": "Package name of the app.", "location": "path", "required": true } }, "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}", "response": { "$ref": "AppEdit" }, "parameterOrder": [ "packageName", "editId" ], "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "description": "Gets an app edit.", "httpMethod": "GET", "id": "androidpublisher.edits.get" }, "insert": { "id": "androidpublisher.edits.insert", "httpMethod": "POST", "description": "Creates a new edit for an app.", "flatPath": "androidpublisher/v3/applications/{packageName}/edits", "request": { "$ref": "AppEdit" }, "parameterOrder": [ "packageName" ], "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameters": { "packageName": { "type": "string", "location": "path", "required": true, "description": "Package name of the app." } }, "response": { "$ref": "AppEdit" }, "path": "androidpublisher/v3/applications/{packageName}/edits" }, "commit": { "description": "Commits an app edit.", "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}:commit", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "id": "androidpublisher.edits.commit", "parameters": { "packageName": { "type": "string", "location": "path", "required": true, "description": "Package name of the app." }, "editId": { "location": "path", "required": true, "type": "string", "description": "Identifier of the edit." }, "changesInReviewBehavior": { "description": "Optional. Specify how the API should behave if there are changes currently in review. If this value is not set, it will default to \"CANCEL_IN_REVIEW_AND_SUBMIT\", which will cancel the changes in review and then send all the changes for publishing.", "enumDescriptions": [ "Defaults to CANCEL_IN_REVIEW_AND_SUBMIT.", "If there are changes already in review, then this will cancel that review first and then send all the changes for publishing.", "If there are changes in review, then this will return an error. Please refer to the error message sample that is returned when this happens. Note that this won't invalidate the edit. If there aren't any changes in review, then this will continue and send the new changes for publishing." ], "enum": [ "CHANGES_IN_REVIEW_BEHAVIOR_TYPE_UNSPECIFIED", "CANCEL_IN_REVIEW_AND_SUBMIT", "ERROR_IF_IN_REVIEW" ], "location": "query", "type": "string" }, "changesNotSentForReview": { "location": "query", "type": "boolean", "description": "When a rejection happens, the parameter will make sure that the changes in this edit won't be reviewed until they are explicitly sent for review from within the Google Play Console UI. These changes will be added to any other changes that are not yet sent for review." } }, "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}:commit", "parameterOrder": [ "packageName", "editId" ], "response": { "$ref": "AppEdit" }, "httpMethod": "POST" }, "delete": { "id": "androidpublisher.edits.delete", "parameters": { "editId": { "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" }, "packageName": { "location": "path", "required": true, "description": "Package name of the app.", "type": "string" } }, "httpMethod": "DELETE", "parameterOrder": [ "packageName", "editId" ], "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}", "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "description": "Deletes an app edit." }, "validate": { "parameterOrder": [ "packageName", "editId" ], "httpMethod": "POST", "description": "Validates an app edit.", "response": { "$ref": "AppEdit" }, "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}:validate", "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}:validate", "id": "androidpublisher.edits.validate", "parameters": { "editId": { "description": "Identifier of the edit.", "type": "string", "location": "path", "required": true }, "packageName": { "location": "path", "required": true, "type": "string", "description": "Package name of the app." } }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ] } }, "resources": { "testers": { "methods": { "update": { "description": "Updates testers. Note: Testers resource does not support email lists.", "parameterOrder": [ "packageName", "editId", "track" ], "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/testers/{track}", "httpMethod": "PUT", "response": { "$ref": "Testers" }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/testers/{track}", "parameters": { "track": { "type": "string", "description": "The track to update.", "location": "path", "required": true }, "packageName": { "description": "Package name of the app.", "type": "string", "location": "path", "required": true }, "editId": { "description": "Identifier of the edit.", "type": "string", "location": "path", "required": true } }, "id": "androidpublisher.edits.testers.update", "request": { "$ref": "Testers" } }, "get": { "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/testers/{track}", "httpMethod": "GET", "id": "androidpublisher.edits.testers.get", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "description": "Gets testers. Note: Testers resource does not support email lists.", "parameterOrder": [ "packageName", "editId", "track" ], "response": { "$ref": "Testers" }, "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/testers/{track}", "parameters": { "packageName": { "description": "Package name of the app.", "location": "path", "required": true, "type": "string" }, "editId": { "type": "string", "description": "Identifier of the edit.", "location": "path", "required": true }, "track": { "location": "path", "required": true, "type": "string", "description": "The track to read from." } } }, "patch": { "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/testers/{track}", "request": { "$ref": "Testers" }, "httpMethod": "PATCH", "description": "Patches testers. Note: Testers resource does not support email lists.", "id": "androidpublisher.edits.testers.patch", "response": { "$ref": "Testers" }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/testers/{track}", "parameters": { "track": { "description": "The track to update.", "location": "path", "required": true, "type": "string" }, "packageName": { "type": "string", "description": "Package name of the app.", "location": "path", "required": true }, "editId": { "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "packageName", "editId", "track" ] } } }, "bundles": { "methods": { "list": { "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/bundles", "parameters": { "editId": { "location": "path", "required": true, "description": "Identifier of the edit.", "type": "string" }, "packageName": { "type": "string", "description": "Package name of the app.", "location": "path", "required": true } }, "description": "Lists all current Android App Bundles of the app and edit.", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameterOrder": [ "packageName", "editId" ], "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/bundles", "httpMethod": "GET", "response": { "$ref": "BundlesListResponse" }, "id": "androidpublisher.edits.bundles.list" }, "upload": { "id": "androidpublisher.edits.bundles.upload", "response": { "$ref": "Bundle" }, "parameters": { "packageName": { "location": "path", "required": true, "description": "Package name of the app.", "type": "string" }, "ackBundleInstallationWarning": { "type": "boolean", "location": "query", "description": "Deprecated. The installation warning has been removed, it's not necessary to set this field anymore.", "deprecated": true }, "editId": { "location": "path", "required": true, "type": "string", "description": "Identifier of the edit." }, "deviceTierConfigId": { "type": "string", "location": "query", "description": "Device tier config (DTC) to be used for generating deliverables (APKs). Contains id of the DTC or \"LATEST\" for last uploaded DTC." } }, "parameterOrder": [ "packageName", "editId" ], "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/bundles", "mediaUpload": { "accept": [ "application/octet-stream" ], "protocols": { "simple": { "multipart": true, "path": "/upload/androidpublisher/v3/applications/{packageName}/edits/{editId}/bundles" }, "resumable": { "multipart": true, "path": "/resumable/upload/androidpublisher/v3/applications/{packageName}/edits/{editId}/bundles" } }, "maxSize": "53687091200" }, "description": "Uploads a new Android App Bundle to this edit. If you are using the Google API client libraries, please increase the timeout of the http request before calling this endpoint (a timeout of 2 minutes is recommended). See [Timeouts and Errors](https://developers.google.com/api-client-library/java/google-api-java-client/errors) for an example in java.", "httpMethod": "POST", "supportsMediaUpload": true, "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/bundles", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ] } } }, "apks": { "methods": { "upload": { "parameterOrder": [ "packageName", "editId" ], "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "description": "Uploads an APK and adds to the current edit.", "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/apks", "supportsMediaUpload": true, "httpMethod": "POST", "mediaUpload": { "accept": [ "application/octet-stream", "application/vnd.android.package-archive" ], "protocols": { "simple": { "path": "/upload/androidpublisher/v3/applications/{packageName}/edits/{editId}/apks", "multipart": true }, "resumable": { "path": "/resumable/upload/androidpublisher/v3/applications/{packageName}/edits/{editId}/apks", "multipart": true } }, "maxSize": "10737418240" }, "id": "androidpublisher.edits.apks.upload", "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/apks", "response": { "$ref": "Apk" }, "parameters": { "editId": { "type": "string", "description": "Identifier of the edit.", "location": "path", "required": true }, "packageName": { "location": "path", "required": true, "type": "string", "description": "Package name of the app." } } }, "list": { "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/apks", "description": "Lists all current APKs of the app and edit.", "httpMethod": "GET", "parameterOrder": [ "packageName", "editId" ], "id": "androidpublisher.edits.apks.list", "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/apks", "response": { "$ref": "ApksListResponse" }, "parameters": { "packageName": { "description": "Package name of the app.", "location": "path", "required": true, "type": "string" }, "editId": { "description": "Identifier of the edit.", "type": "string", "location": "path", "required": true } } }, "addexternallyhosted": { "request": { "$ref": "ApksAddExternallyHostedRequest" }, "parameters": { "editId": { "location": "path", "required": true, "type": "string", "description": "Identifier of the edit." }, "packageName": { "description": "Package name of the app.", "type": "string", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "response": { "$ref": "ApksAddExternallyHostedResponse" }, "parameterOrder": [ "packageName", "editId" ], "description": "Creates a new APK without uploading the APK itself to Google Play, instead hosting the APK at a specified URL. This function is only available to organizations using Managed Play whose application is configured to restrict distribution to the organizations.", "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/externallyHosted", "httpMethod": "POST", "id": "androidpublisher.edits.apks.addexternallyhosted", "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/externallyHosted" } } }, "deobfuscationfiles": { "methods": { "upload": { "description": "Uploads a new deobfuscation file and attaches to the specified APK.", "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/deobfuscationFiles/{deobfuscationFileType}", "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/deobfuscationFiles/{deobfuscationFileType}", "mediaUpload": { "maxSize": "2097152000", "accept": [ "application/octet-stream" ], "protocols": { "simple": { "multipart": true, "path": "/upload/androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/deobfuscationFiles/{deobfuscationFileType}" }, "resumable": { "multipart": true, "path": "/resumable/upload/androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/deobfuscationFiles/{deobfuscationFileType}" } } }, "httpMethod": "POST", "supportsMediaUpload": true, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "response": { "$ref": "DeobfuscationFilesUploadResponse" }, "id": "androidpublisher.edits.deobfuscationfiles.upload", "parameters": { "packageName": { "location": "path", "required": true, "type": "string", "description": "Unique identifier for the Android app." }, "apkVersionCode": { "location": "path", "type": "integer", "format": "int32", "description": "The version code of the APK whose Deobfuscation File is being uploaded.", "required": true }, "deobfuscationFileType": { "type": "string", "required": true, "description": "The type of the deobfuscation file.", "enumDescriptions": [ "Unspecified deobfuscation file type.", "Proguard deobfuscation file type.", "Native debugging symbols file type." ], "enum": [ "deobfuscationFileTypeUnspecified", "proguard", "nativeCode" ], "location": "path" }, "editId": { "description": "Unique identifier for this edit.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "packageName", "editId", "apkVersionCode", "deobfuscationFileType" ] } } }, "expansionfiles": { "methods": { "update": { "parameters": { "editId": { "location": "path", "required": true, "description": "Identifier of the edit.", "type": "string" }, "apkVersionCode": { "location": "path", "required": true, "type": "integer", "format": "int32", "description": "The version code of the APK whose expansion file configuration is being read or modified." }, "packageName": { "description": "Package name of the app.", "location": "path", "required": true, "type": "string" }, "expansionFileType": { "enumDescriptions": [ "Unspecified expansion file type.", "Main expansion file.", "Patch expansion file." ], "type": "string", "location": "path", "description": "The file type of the file configuration which is being read or modified.", "enum": [ "expansionFileTypeUnspecified", "main", "patch" ], "required": true } }, "id": "androidpublisher.edits.expansionfiles.update", "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}", "description": "Updates the APK's expansion file configuration to reference another APK's expansion file. To add a new expansion file use the Upload method.", "parameterOrder": [ "packageName", "editId", "apkVersionCode", "expansionFileType" ], "response": { "$ref": "ExpansionFile" }, "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}", "httpMethod": "PUT", "request": { "$ref": "ExpansionFile" }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ] }, "patch": { "description": "Patches the APK's expansion file configuration to reference another APK's expansion file. To add a new expansion file use the Upload method.", "httpMethod": "PATCH", "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameters": { "editId": { "type": "string", "description": "Identifier of the edit.", "location": "path", "required": true }, "apkVersionCode": { "type": "integer", "required": true, "format": "int32", "location": "path", "description": "The version code of the APK whose expansion file configuration is being read or modified." }, "expansionFileType": { "description": "The file type of the expansion file configuration which is being updated.", "enum": [ "expansionFileTypeUnspecified", "main", "patch" ], "location": "path", "type": "string", "required": true, "enumDescriptions": [ "Unspecified expansion file type.", "Main expansion file.", "Patch expansion file." ] }, "packageName": { "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, "response": { "$ref": "ExpansionFile" }, "request": { "$ref": "ExpansionFile" }, "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}", "parameterOrder": [ "packageName", "editId", "apkVersionCode", "expansionFileType" ], "id": "androidpublisher.edits.expansionfiles.patch" }, "get": { "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "description": "Fetches the expansion file configuration for the specified APK.", "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}", "id": "androidpublisher.edits.expansionfiles.get", "parameterOrder": [ "packageName", "editId", "apkVersionCode", "expansionFileType" ], "httpMethod": "GET", "response": { "$ref": "ExpansionFile" }, "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}", "parameters": { "packageName": { "type": "string", "description": "Package name of the app.", "location": "path", "required": true }, "expansionFileType": { "enumDescriptions": [ "Unspecified expansion file type.", "Main expansion file.", "Patch expansion file." ], "location": "path", "type": "string", "description": "The file type of the file configuration which is being read or modified.", "required": true, "enum": [ "expansionFileTypeUnspecified", "main", "patch" ] }, "apkVersionCode": { "type": "integer", "required": true, "format": "int32", "location": "path", "description": "The version code of the APK whose expansion file configuration is being read or modified." }, "editId": { "type": "string", "description": "Identifier of the edit.", "location": "path", "required": true } } }, "upload": { "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "id": "androidpublisher.edits.expansionfiles.upload", "httpMethod": "POST", "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}", "parameterOrder": [ "packageName", "editId", "apkVersionCode", "expansionFileType" ], "response": { "$ref": "ExpansionFilesUploadResponse" }, "parameters": { "apkVersionCode": { "description": "The version code of the APK whose expansion file configuration is being read or modified.", "location": "path", "type": "integer", "required": true, "format": "int32" }, "expansionFileType": { "enumDescriptions": [ "Unspecified expansion file type.", "Main expansion file.", "Patch expansion file." ], "location": "path", "type": "string", "description": "The file type of the expansion file configuration which is being updated.", "required": true, "enum": [ "expansionFileTypeUnspecified", "main", "patch" ] }, "packageName": { "description": "Package name of the app.", "location": "path", "required": true, "type": "string" }, "editId": { "type": "string", "location": "path", "required": true, "description": "Identifier of the edit." } }, "description": "Uploads a new expansion file and attaches to the specified APK.", "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}", "mediaUpload": { "protocols": { "resumable": { "multipart": true, "path": "/resumable/upload/androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}" }, "simple": { "path": "/upload/androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}", "multipart": true } }, "maxSize": "2147483648", "accept": [ "application/octet-stream" ] }, "supportsMediaUpload": true } } }, "tracks": { "methods": { "list": { "description": "Lists all tracks.", "id": "androidpublisher.edits.tracks.list", "response": { "$ref": "TracksListResponse" }, "httpMethod": "GET", "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/tracks", "parameterOrder": [ "packageName", "editId" ], "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/tracks", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameters": { "packageName": { "location": "path", "required": true, "type": "string", "description": "Package name of the app." }, "editId": { "type": "string", "description": "Identifier of the edit.", "location": "path", "required": true } } }, "create": { "response": { "$ref": "Track" }, "parameters": { "editId": { "description": "Required. Identifier of the edit.", "type": "string", "location": "path", "required": true }, "packageName": { "location": "path", "required": true, "description": "Required. Package name of the app.", "type": "string" } }, "parameterOrder": [ "packageName", "editId" ], "id": "androidpublisher.edits.tracks.create", "description": "Creates a new track.", "request": { "$ref": "TrackConfig" }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/tracks", "httpMethod": "POST", "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/tracks" }, "patch": { "parameterOrder": [ "packageName", "editId", "track" ], "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/tracks/{track}", "id": "androidpublisher.edits.tracks.patch", "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameters": { "editId": { "location": "path", "required": true, "description": "Identifier of the edit.", "type": "string" }, "packageName": { "description": "Package name of the app.", "type": "string", "location": "path", "required": true }, "track": { "description": "Identifier of the track. [More on track name](https://developers.google.com/android-publisher/tracks#ff-track-name)", "location": "path", "required": true, "type": "string" } }, "request": { "$ref": "Track" }, "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/tracks/{track}", "description": "Patches a track.", "response": { "$ref": "Track" } }, "get": { "response": { "$ref": "Track" }, "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/tracks/{track}", "id": "androidpublisher.edits.tracks.get", "parameters": { "editId": { "description": "Identifier of the edit.", "type": "string", "location": "path", "required": true }, "track": { "description": "Identifier of the track. [More on track name](https://developers.google.com/android-publisher/tracks#ff-track-name)", "location": "path", "required": true, "type": "string" }, "packageName": { "location": "path", "required": true, "description": "Package name of the app.", "type": "string" } }, "description": "Gets a track.", "parameterOrder": [ "packageName", "editId", "track" ], "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "httpMethod": "GET", "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/tracks/{track}" }, "update": { "parameterOrder": [ "packageName", "editId", "track" ], "httpMethod": "PUT", "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/tracks/{track}", "description": "Updates a track.", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameters": { "editId": { "location": "path", "required": true, "description": "Identifier of the edit.", "type": "string" }, "track": { "description": "Identifier of the track. [More on track name](https://developers.google.com/android-publisher/tracks#ff-track-name)", "type": "string", "location": "path", "required": true }, "packageName": { "type": "string", "description": "Package name of the app.", "location": "path", "required": true } }, "request": { "$ref": "Track" }, "response": { "$ref": "Track" }, "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/tracks/{track}", "id": "androidpublisher.edits.tracks.update" } } }, "listings": { "methods": { "deleteall": { "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings", "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings", "description": "Deletes all store listings.", "id": "androidpublisher.edits.listings.deleteall", "parameters": { "editId": { "type": "string", "location": "path", "required": true, "description": "Identifier of the edit." }, "packageName": { "location": "path", "required": true, "type": "string", "description": "Package name of the app." } }, "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameterOrder": [ "packageName", "editId" ] }, "list": { "httpMethod": "GET", "response": { "$ref": "ListingsListResponse" }, "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings", "parameterOrder": [ "packageName", "editId" ], "parameters": { "packageName": { "description": "Package name of the app.", "type": "string", "location": "path", "required": true }, "editId": { "location": "path", "required": true, "description": "Identifier of the edit.", "type": "string" } }, "id": "androidpublisher.edits.listings.list", "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings", "description": "Lists all localized store listings.", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ] }, "patch": { "request": { "$ref": "Listing" }, "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameters": { "language": { "location": "path", "required": true, "type": "string", "description": "Language localization code (a BCP-47 language tag; for example, \"de-AT\" for Austrian German)." }, "packageName": { "location": "path", "required": true, "description": "Package name of the app.", "type": "string" }, "editId": { "type": "string", "location": "path", "required": true, "description": "Identifier of the edit." } }, "parameterOrder": [ "packageName", "editId", "language" ], "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}", "httpMethod": "PATCH", "id": "androidpublisher.edits.listings.patch", "response": { "$ref": "Listing" }, "description": "Patches a localized store listing." }, "delete": { "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}", "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameterOrder": [ "packageName", "editId", "language" ], "id": "androidpublisher.edits.listings.delete", "description": "Deletes a localized store listing.", "httpMethod": "DELETE", "parameters": { "packageName": { "location": "path", "required": true, "type": "string", "description": "Package name of the app." }, "language": { "description": "Language localization code (a BCP-47 language tag; for example, \"de-AT\" for Austrian German).", "location": "path", "required": true, "type": "string" }, "editId": { "location": "path", "required": true, "type": "string", "description": "Identifier of the edit." } } }, "get": { "description": "Gets a localized store listing.", "parameters": { "editId": { "location": "path", "required": true, "type": "string", "description": "Identifier of the edit." }, "packageName": { "type": "string", "location": "path", "required": true, "description": "Package name of the app." }, "language": { "type": "string", "location": "path", "required": true, "description": "Language localization code (a BCP-47 language tag; for example, \"de-AT\" for Austrian German)." } }, "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}", "response": { "$ref": "Listing" }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "id": "androidpublisher.edits.listings.get", "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}", "httpMethod": "GET", "parameterOrder": [ "packageName", "editId", "language" ] }, "update": { "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}", "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "id": "androidpublisher.edits.listings.update", "description": "Creates or updates a localized store listing.", "httpMethod": "PUT", "parameterOrder": [ "packageName", "editId", "language" ], "request": { "$ref": "Listing" }, "response": { "$ref": "Listing" }, "parameters": { "packageName": { "type": "string", "location": "path", "required": true, "description": "Package name of the app." }, "language": { "location": "path", "required": true, "type": "string", "description": "Language localization code (a BCP-47 language tag; for example, \"de-AT\" for Austrian German)." }, "editId": { "type": "string", "location": "path", "required": true, "description": "Identifier of the edit." } } } } }, "countryavailability": { "methods": { "get": { "id": "androidpublisher.edits.countryavailability.get", "parameters": { "packageName": { "location": "path", "required": true, "type": "string", "description": "Package name of the app." }, "track": { "type": "string", "location": "path", "required": true, "description": "The track to read from." }, "editId": { "location": "path", "required": true, "type": "string", "description": "Identifier of the edit." } }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/countryAvailability/{track}", "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/countryAvailability/{track}", "response": { "$ref": "TrackCountryAvailability" }, "httpMethod": "GET", "parameterOrder": [ "packageName", "editId", "track" ], "description": "Gets country availability." } } }, "details": { "methods": { "patch": { "request": { "$ref": "AppDetails" }, "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/details", "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/details", "httpMethod": "PATCH", "parameterOrder": [ "packageName", "editId" ], "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "description": "Patches details of an app.", "response": { "$ref": "AppDetails" }, "parameters": { "editId": { "description": "Identifier of the edit.", "type": "string", "location": "path", "required": true }, "packageName": { "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, "id": "androidpublisher.edits.details.patch" }, "update": { "id": "androidpublisher.edits.details.update", "description": "Updates details of an app.", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "response": { "$ref": "AppDetails" }, "httpMethod": "PUT", "request": { "$ref": "AppDetails" }, "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/details", "parameterOrder": [ "packageName", "editId" ], "parameters": { "editId": { "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" }, "packageName": { "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/details" }, "get": { "id": "androidpublisher.edits.details.get", "response": { "$ref": "AppDetails" }, "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/details", "description": "Gets details of an app.", "parameters": { "packageName": { "description": "Package name of the app.", "type": "string", "location": "path", "required": true }, "editId": { "description": "Identifier of the edit.", "type": "string", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/details", "parameterOrder": [ "packageName", "editId" ], "httpMethod": "GET" } } }, "images": { "methods": { "list": { "parameters": { "language": { "location": "path", "required": true, "description": "Language localization code (a BCP-47 language tag; for example, \"de-AT\" for Austrian German). There must be a store listing for the specified language.", "type": "string" }, "packageName": { "location": "path", "required": true, "type": "string", "description": "Package name of the app." }, "imageType": { "required": true, "type": "string", "location": "path", "description": "Type of the Image. Providing an image type that refers to no images will return an empty response.", "enum": [ "appImageTypeUnspecified", "phoneScreenshots", "sevenInchScreenshots", "tenInchScreenshots", "tvScreenshots", "wearScreenshots", "icon", "featureGraphic", "tvBanner" ], "enumDescriptions": [ "Unspecified type. Do not use.", "Phone screenshot.", "Seven inch screenshot.", "Ten inch screenshot.", "TV screenshot.", "Wear screenshot.", "Icon.", "Feature graphic.", "TV banner." ] }, "editId": { "type": "string", "location": "path", "required": true, "description": "Identifier of the edit." } }, "response": { "$ref": "ImagesListResponse" }, "description": "Lists all images. The response may be empty.", "httpMethod": "GET", "parameterOrder": [ "packageName", "editId", "language", "imageType" ], "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}/{imageType}", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "id": "androidpublisher.edits.images.list", "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}/{imageType}" }, "deleteall": { "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "response": { "$ref": "ImagesDeleteAllResponse" }, "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}/{imageType}", "id": "androidpublisher.edits.images.deleteall", "httpMethod": "DELETE", "parameterOrder": [ "packageName", "editId", "language", "imageType" ], "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}/{imageType}", "description": "Deletes all images for the specified language and image type. Returns an empty response if no images are found.", "parameters": { "imageType": { "enum": [ "appImageTypeUnspecified", "phoneScreenshots", "sevenInchScreenshots", "tenInchScreenshots", "tvScreenshots", "wearScreenshots", "icon", "featureGraphic", "tvBanner" ], "required": true, "enumDescriptions": [ "Unspecified type. Do not use.", "Phone screenshot.", "Seven inch screenshot.", "Ten inch screenshot.", "TV screenshot.", "Wear screenshot.", "Icon.", "Feature graphic.", "TV banner." ], "location": "path", "type": "string", "description": "Type of the Image. Providing an image type that refers to no images is a no-op." }, "language": { "location": "path", "required": true, "type": "string", "description": "Language localization code (a BCP-47 language tag; for example, \"de-AT\" for Austrian German). Providing a language that is not supported by the App is a no-op." }, "packageName": { "type": "string", "location": "path", "required": true, "description": "Package name of the app." }, "editId": { "description": "Identifier of the edit.", "type": "string", "location": "path", "required": true } } }, "upload": { "parameters": { "imageType": { "type": "string", "enumDescriptions": [ "Unspecified type. Do not use.", "Phone screenshot.", "Seven inch screenshot.", "Ten inch screenshot.", "TV screenshot.", "Wear screenshot.", "Icon.", "Feature graphic.", "TV banner." ], "required": true, "description": "Type of the Image.", "enum": [ "appImageTypeUnspecified", "phoneScreenshots", "sevenInchScreenshots", "tenInchScreenshots", "tvScreenshots", "wearScreenshots", "icon", "featureGraphic", "tvBanner" ], "location": "path" }, "editId": { "location": "path", "required": true, "description": "Identifier of the edit.", "type": "string" }, "language": { "description": "Language localization code (a BCP-47 language tag; for example, \"de-AT\" for Austrian German). Providing a language that is not supported by the App is a no-op.", "location": "path", "required": true, "type": "string" }, "packageName": { "location": "path", "required": true, "type": "string", "description": "Package name of the app." }, "aiGeneratedState": { "type": "string", "location": "query", "description": "Optional. Whether the image was generated by AI. Attested by the developer.", "enumDescriptions": [ "Catch-all for unrecognized enum values. See go/protodosdonts.", "The content is not generated by AI.", "The content is generated by AI and attested by the developer." ], "enum": [ "aiGeneratedStateUnspecified", "aiGeneratedStateNotAiGenerated", "aiGeneratedStateAiGeneratedDeveloperAttested" ] } }, "supportsMediaUpload": true, "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}/{imageType}", "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}/{imageType}", "description": "Uploads an image of the specified language and image type, and adds to the edit.", "parameterOrder": [ "packageName", "editId", "language", "imageType" ], "mediaUpload": { "maxSize": "15728640", "accept": [ "image/*" ], "protocols": { "resumable": { "path": "/resumable/upload/androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}/{imageType}", "multipart": true }, "simple": { "path": "/upload/androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}/{imageType}", "multipart": true } } }, "id": "androidpublisher.edits.images.upload", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "response": { "$ref": "ImagesUploadResponse" } }, "delete": { "id": "androidpublisher.edits.images.delete", "parameterOrder": [ "packageName", "editId", "language", "imageType", "imageId" ], "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}/{imageType}/{imageId}", "description": "Deletes the image (specified by id) from the edit.", "parameters": { "imageId": { "location": "path", "required": true, "type": "string", "description": "Unique identifier an image within the set of images attached to this edit." }, "packageName": { "location": "path", "required": true, "type": "string", "description": "Package name of the app." }, "editId": { "type": "string", "location": "path", "required": true, "description": "Identifier of the edit." }, "imageType": { "enum": [ "appImageTypeUnspecified", "phoneScreenshots", "sevenInchScreenshots", "tenInchScreenshots", "tvScreenshots", "wearScreenshots", "icon", "featureGraphic", "tvBanner" ], "required": true, "enumDescriptions": [ "Unspecified type. Do not use.", "Phone screenshot.", "Seven inch screenshot.", "Ten inch screenshot.", "TV screenshot.", "Wear screenshot.", "Icon.", "Feature graphic.", "TV banner." ], "description": "Type of the Image.", "type": "string", "location": "path" }, "language": { "location": "path", "required": true, "description": "Language localization code (a BCP-47 language tag; for example, \"de-AT\" for Austrian German).", "type": "string" } }, "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}/{imageType}/{imageId}", "httpMethod": "DELETE" } } } } } }, "parameters": { "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "prettyPrint": { "location": "query", "default": "true", "description": "Returns response with indentations and line breaks.", "type": "boolean" }, "alt": { "enum": [ "json", "media", "proto" ], "default": "json", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "description": "Data format for response.", "location": "query", "type": "string" }, "uploadType": { "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string" }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "type": "string", "location": "query" }, "access_token": { "location": "query", "type": "string", "description": "OAuth access token." }, "$.xgafv": { "enumDescriptions": [ "v1 error format", "v2 error format" ], "enum": [ "1", "2" ], "type": "string", "location": "query", "description": "V1 error format." }, "quotaUser": { "location": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "type": "string" }, "oauth_token": { "location": "query", "description": "OAuth 2.0 token for the current user.", "type": "string" }, "callback": { "location": "query", "type": "string", "description": "JSONP" }, "key": { "location": "query", "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." } }, "ownerName": "Google", "baseUrl": "https://androidpublisher.googleapis.com/", "title": "Google Play Android Developer API", "discoveryVersion": "v1", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/androidpublisher": { "description": "View and manage your Google Play Developer account" } } } }, "batchPath": "batch", "description": "Lets Android application developers access their Google Play accounts. At a high level, the expected workflow is to \"insert\" an Edit, make changes as necessary, and then \"commit\" it. ", "canonicalName": "Android Publisher", "ownerDomain": "google.com", "version": "v3" }