Method: monetization.onetimeproducts.purchaseOptions.offers.batchGet
Stay organized with collections
Save and categorize content based on your preferences.
Reads one or more one-time product offers.
HTTP request
POST https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers:batchGet
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
packageName |
string
Required. The parent app (package name) of the updated offers. Must be equal to the packageName field on all the updated OneTimeProductOffer resources.
|
productId |
string
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 "-".
|
purchaseOptionId |
string
Required. The parent purchase option (ID) for which the offers should be updated. May be specified as '-' to update offers from multiple purchase options.
|
Request body
The request body contains data with the following structure:
| Fields |
requests[] |
object (GetOneTimeProductOfferRequest)
Required. A list of get requests of up to 100 elements. All requests must retrieve different offers.
|
Response body
Response message for the offers.batchGet endpoint.
If successful, the response body contains data with the following structure:
| Fields |
oneTimeProductOffers[] |
object (OneTimeProductOffer)
The list of updated one-time product offers, in the same order as the request.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/androidpublisher
GetOneTimeProductOfferRequest
Request message for GetOneTimeProductOffers.
| JSON representation |
{
"packageName": string,
"productId": string,
"purchaseOptionId": string,
"offerId": string
} |
| Fields |
packageName |
string
Required. The parent app (package name) of the offer to get.
|
productId |
string
Required. The parent one-time product (ID) of the offer to get.
|
purchaseOptionId |
string
Required. The parent purchase option (ID) of the offer to get.
|
offerId |
string
Required. The unique offer ID of the offer to get.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-16 UTC.
[null,null,["Last updated 2025-07-16 UTC."],[],[],null,["# Method: monetization.onetimeproducts.purchaseOptions.offers.batchGet\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.BatchGetOneTimeProductOffersResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [GetOneTimeProductOfferRequest](#GetOneTimeProductOfferRequest)\n - [JSON representation](#GetOneTimeProductOfferRequest.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nReads one or more one-time product offers.\n\n### HTTP request\n\n`POST https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers:batchGet`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `packageName` | `string` Required. The parent app (package name) of the updated offers. Must be equal to the packageName field on all the updated OneTimeProductOffer resources. |\n| `productId` | `string` 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 \"-\". |\n| `purchaseOptionId` | `string` Required. The parent purchase option (ID) for which the offers should be updated. May be specified as '-' to update offers from multiple purchase options. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"requests\": [ { object (/android-publisher/api-ref/rest/v3/monetization.onetimeproducts.purchaseOptions.offers/batchGet#GetOneTimeProductOfferRequest) } ] } ``` |\n\n| Fields ||\n|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `requests[]` | `object (`[GetOneTimeProductOfferRequest](/android-publisher/api-ref/rest/v3/monetization.onetimeproducts.purchaseOptions.offers/batchGet#GetOneTimeProductOfferRequest)`)` Required. A list of get requests of up to 100 elements. All requests must retrieve different offers. |\n\n### Response body\n\nResponse message for the offers.batchGet endpoint.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"oneTimeProductOffers\": [ { object (/android-publisher/api-ref/rest/v3/monetization.onetimeproducts.purchaseOptions.offers#OneTimeProductOffer) } ] } ``` |\n\n| Fields ||\n|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `oneTimeProductOffers[]` | `object (`[OneTimeProductOffer](/android-publisher/api-ref/rest/v3/monetization.onetimeproducts.purchaseOptions.offers#OneTimeProductOffer)`)` The list of updated one-time product offers, in the same order as the request. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/androidpublisher`\n\nGetOneTimeProductOfferRequest\n-----------------------------\n\nRequest message for GetOneTimeProductOffers.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------|\n| ``` { \"packageName\": string, \"productId\": string, \"purchaseOptionId\": string, \"offerId\": string } ``` |\n\n| Fields ||\n|--------------------|--------------------------------------------------------------------------|\n| `packageName` | `string` Required. The parent app (package name) of the offer to get. |\n| `productId` | `string` Required. The parent one-time product (ID) of the offer to get. |\n| `purchaseOptionId` | `string` Required. The parent purchase option (ID) of the offer to get. |\n| `offerId` | `string` Required. The unique offer ID of the offer to get. |"]]