2025-07-22
▼ ▲ androidpublisher.monetization.onetimeproducts.get
Path : androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}
Flat Path : androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}
HTTP Method : GET
Parameters :
packageName
Description : Required. The parent app (package name) of the product to retrieve.
Location : path
Required : Yes
Type : string
productId
Description : Required. The product ID of the product to retrieve.
Location : path
Required : Yes
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/androidpublisher
Description : Reads a single one-time product.
▼ ▲ androidpublisher.monetization.onetimeproducts.batchGet
Path : androidpublisher/v3/applications/{packageName}/oneTimeProducts:batchGet
Flat Path : androidpublisher/v3/applications/{packageName}/oneTimeProducts:batchGet
HTTP Method : GET
Parameters :
packageName
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.
Location : path
Required : Yes
Type : string
productIds
Description : Required. A list of up to 100 product IDs to retrieve. All IDs must be different.
Location : query
Repeated : Yes
Type : string
Parameter Order : packageName
Scopes : https://www.googleapis.com/auth/androidpublisher
Description : Reads one or more one-time products.
▼ ▲ androidpublisher.monetization.onetimeproducts.list
Path : androidpublisher/v3/applications/{packageName}/oneTimeProducts
Flat Path : androidpublisher/v3/applications/{packageName}/oneTimeProducts
HTTP Method : GET
Parameters :
packageName
Description : Required. The parent app (package name) for which the one-time product should be read.
Location : path
Required : Yes
Type : string
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.
Location : query
Type : integer
Format : int32
pageToken
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.
Location : query
Type : string
Parameter Order : packageName
Scopes : https://www.googleapis.com/auth/androidpublisher
Description : Lists all one-time products under a given app.
▼ ▲ androidpublisher.monetization.onetimeproducts.patch
Path : androidpublisher/v3/applications/{packageName}/onetimeproducts/{productId}
Flat Path : androidpublisher/v3/applications/{packageName}/onetimeproducts/{productId}
HTTP Method : PATCH
Parameters :
packageName
Description : Required. Immutable. Package name of the parent app.
Location : path
Required : Yes
Type : string
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 (.).
Location : path
Required : Yes
Type : string
updateMask
Description : Required. The list of fields to be updated.
Location : query
Type : string
Format : google-fieldmask
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
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.
Location : query
Type : boolean
latencyTolerance
Description : Optional. The latency tolerance for the propagation of this product upsert. Defaults to latency-sensitive.
Location : query
Type : string
Enum Descriptions :
Enum :
Parameter Order :
Scopes : https://www.googleapis.com/auth/androidpublisher
Description : Creates or updates a one-time product.
▼ ▲ androidpublisher.monetization.onetimeproducts.batchUpdate
Path : androidpublisher/v3/applications/{packageName}/oneTimeProducts:batchUpdate
Flat Path : androidpublisher/v3/applications/{packageName}/oneTimeProducts:batchUpdate
HTTP Method : POST
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 : Yes
Type : string
Parameter Order : packageName
Scopes : https://www.googleapis.com/auth/androidpublisher
Description : Creates or updates one or more one-time products.
▼ ▲ androidpublisher.monetization.onetimeproducts.delete
Path : androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}
Flat Path : androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}
HTTP Method : DELETE
Parameters :
packageName
Description : Required. The parent app (package name) of the one-time product to delete.
Location : path
Required : Yes
Type : string
productId
Description : Required. The one-time product ID of the one-time product to delete.
Location : path
Required : Yes
Type : string
latencyTolerance
Description : Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
Location : query
Type : string
Enum Descriptions :
Enum :
Parameter Order :
Scopes : https://www.googleapis.com/auth/androidpublisher
Description : Deletes a one-time product.
▼ ▲ androidpublisher.monetization.onetimeproducts.batchDelete
Path : androidpublisher/v3/applications/{packageName}/oneTimeProducts:batchDelete
Flat Path : androidpublisher/v3/applications/{packageName}/oneTimeProducts:batchDelete
HTTP Method : POST
Parameters :
packageName
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 : Yes
Type : string
Parameter Order : packageName
Scopes : https://www.googleapis.com/auth/androidpublisher
Description : Deletes one or more one-time products.
▼ ▲ androidpublisher.monetization.onetimeproducts.purchaseOptions.batchUpdateStates
Path : androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions:batchUpdateStates
Flat Path : androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions:batchUpdateStates
HTTP Method : POST
Parameters :
packageName
Description : Required. The parent app (package name) of the updated purchase options.
Location : path
Required : Yes
Type : string
productId
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 "-".
Location : path
Required : Yes
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/androidpublisher
Description : Activates or deactivates purchase options across one or multiple one-time products.
▼ ▲ androidpublisher.monetization.onetimeproducts.purchaseOptions.batchDelete
Path : androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions:batchDelete
Flat Path : androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions:batchDelete
HTTP Method : POST
Parameters :
packageName
Description : Required. The parent app (package name) of the purchase options to delete.
Location : path
Required : Yes
Type : string
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 : Yes
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/androidpublisher
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.
▼ ▲ androidpublisher.monetization.onetimeproducts.purchaseOptions.offers.list
Path : androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers
Flat Path : androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers
HTTP Method : GET
Parameters :
packageName
Description : Required. The parent app (package name) for which the offers should be read.
Location : path
Required : Yes
Type : string
productId
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 : Yes
Type : string
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 '-'.
Location : path
Required : Yes
Type : string
pageSize
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
Type : integer
Format : int32
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.
Location : query
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/androidpublisher
Description : Lists all offers under a given app, product, or purchase option.
▼ ▲ androidpublisher.monetization.onetimeproducts.purchaseOptions.offers.batchGet
Path : androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers:batchGet
Flat Path : androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers:batchGet
HTTP Method : POST
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 : Yes
Type : string
productId
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 : Yes
Type : string
purchaseOptionId
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.
Location : path
Required : Yes
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/androidpublisher
Description : Reads one or more one-time product offers.
▼ ▲ androidpublisher.monetization.onetimeproducts.purchaseOptions.offers.batchUpdate
Path : androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers:batchUpdate
Flat Path : androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers:batchUpdate
HTTP Method : POST
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 : Yes
Type : string
productId
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 : Yes
Type : string
purchaseOptionId
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.
Location : path
Required : Yes
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/androidpublisher
Description : Creates or updates one or more one-time product offers.
▼ ▲ androidpublisher.monetization.onetimeproducts.purchaseOptions.offers.batchUpdateStates
Path : androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers:batchUpdateStates
Flat Path : androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers:batchUpdateStates
HTTP Method : POST
Parameters :
packageName
Description : Required. The parent app (package name) of the updated one-time product offers.
Location : path
Required : Yes
Type : string
productId
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 : Yes
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 "-".
Location : path
Required : Yes
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/androidpublisher
Description : Updates a batch of one-time product offer states.
▼ ▲ androidpublisher.monetization.onetimeproducts.purchaseOptions.offers.batchDelete
Path : androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers:batchDelete
Flat Path : androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers:batchDelete
HTTP Method : POST
Parameters :
packageName
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 : Yes
Type : string
productId
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 "-".
Location : path
Required : Yes
Type : string
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 : Yes
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/androidpublisher
Description : Deletes one or more one-time product offers.
▼ ▲ androidpublisher.monetization.onetimeproducts.purchaseOptions.offers.activate
Path : androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers/{offerId}:activate
Flat Path : androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers/{offerId}:activate
HTTP Method : POST
Parameters :
packageName
Description : Required. The parent app (package name) of the offer to activate.
Location : path
Required : Yes
Type : string
productId
Description : Required. The parent one-time product (ID) of the offer to activate.
Location : path
Required : Yes
Type : string
purchaseOptionId
Description : Required. The parent purchase option (ID) of the offer to activate.
Location : path
Required : Yes
Type : string
offerId
Description : Required. The offer ID of the offer to activate.
Location : path
Required : Yes
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/androidpublisher
Description : Activates a one-time product offer.
▼ ▲ androidpublisher.monetization.onetimeproducts.purchaseOptions.offers.cancel
Path : androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers/{offerId}:cancel
Flat Path : androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers/{offerId}:cancel
HTTP Method : POST
Parameters :
packageName
Description : Required. The parent app (package name) of the offer to cancel.
Location : path
Required : Yes
Type : string
productId
Description : Required. The parent one-time product (ID) of the offer to cancel.
Location : path
Required : Yes
Type : string
purchaseOptionId
Description : Required. The parent purchase option (ID) of the offer to cancel.
Location : path
Required : Yes
Type : string
offerId
Description : Required. The offer ID of the offer to cancel.
Location : path
Required : Yes
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/androidpublisher
Description : Cancels a one-time product offer.
▼ ▲ androidpublisher.monetization.onetimeproducts.purchaseOptions.offers.deactivate
Path : androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers/{offerId}:deactivate
Flat Path : androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers/{offerId}:deactivate
HTTP Method : POST
Parameters :
packageName
Description : Required. The parent app (package name) of the offer to deactivate.
Location : path
Required : Yes
Type : string
productId
Description : Required. The parent one-time product (ID) of the offer to deactivate.
Location : path
Required : Yes
Type : string
purchaseOptionId
Description : Required. The parent purchase option (ID) of the offer to deactivate.
Location : path
Required : Yes
Type : string
offerId
Description : Required. The offer ID of the offer to deactivate.
Location : path
Required : Yes
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/androidpublisher
Description : Deactivates a one-time product offer.