Method: monetization.subscriptions.basePlans.offers.batchGet
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Lê uma ou mais ofertas de assinatura.
Solicitação HTTP
POST https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers:batchGet
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros |
packageName |
string
Obrigatório. O app pai (nome do pacote) para o qual as assinaturas precisam ser criadas ou atualizadas. Precisa ser igual ao campo "packageName" em todas as solicitações.
|
productId |
string
Obrigatório. O ID do produto da assinatura principal, se todas as ofertas atualizadas pertencerem à mesma assinatura. Se essa solicitação abranger várias assinaturas, defina esse campo como "-". Deve ser definido.
|
basePlanId |
string
Obrigatório. O plano básico (ID) pai de onde as ofertas vão ser lidas. Pode ser especificado como '-' para ler ofertas de vários planos básicos.
|
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
Campos |
requests[] |
object (GetSubscriptionOfferRequest )
Obrigatório. Uma lista de solicitações de atualização com até 100 elementos. Todas as solicitações precisam atualizar assinaturas diferentes.
|
Corpo da resposta
Mensagem de resposta para o endpoint offer.batchGet.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Campos |
subscriptionOffers[] |
object (SubscriptionOffer )
|
Escopos de autorização
Requer o seguinte escopo OAuth:
https://www.googleapis.com/auth/androidpublisher
GetSubscriptionOfferRequest
Mensagem de solicitação para offer.get.
Representação JSON |
{
"packageName": string,
"productId": string,
"basePlanId": string,
"offerId": string
} |
Campos |
packageName |
string
Obrigatório. O app pai (nome do pacote) da oferta a ser recebida.
|
productId |
string
Obrigatório. É a assinatura principal (ID) da oferta a ser recebida.
|
basePlanId |
string
Obrigatório. O plano básico (ID) pai da oferta a ser recebida.
|
offerId |
string
Obrigatório. O ID exclusivo da oferta a ser recebida.
|
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-26 UTC.
[null,null,["Última atualização 2025-07-26 UTC."],[[["\u003cp\u003eReads one or more subscription offers for a specified app, product, and base plan using a POST request.\u003c/p\u003e\n"],["\u003cp\u003eRequires providing a list of \u003ccode\u003eGetSubscriptionOfferRequest\u003c/code\u003e objects, each specifying the package name, product ID, base plan ID, and offer ID.\u003c/p\u003e\n"],["\u003cp\u003eReturns a list of \u003ccode\u003eSubscriptionOffer\u003c/code\u003e objects containing details about the retrieved subscription offers.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/androidpublisher\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eSupports batch retrieval of up to 100 offers, but all requests must update different subscriptions.\u003c/p\u003e\n"]]],["This document outlines the process for retrieving subscription offers via a batch request. It uses a `POST` request to a specified URL, including `packageName`, `productId`, and `basePlanId` as path parameters. The request body requires a JSON array of `GetSubscriptionOfferRequest` objects, each needing `packageName`, `productId`, `basePlanId`, and `offerId`. The response contains an array of `SubscriptionOffer` objects, presented in a JSON format. The `https://www.googleapis.com/auth/androidpublisher` authorization scope is required.\n"],null,["# Method: monetization.subscriptions.basePlans.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.BatchGetSubscriptionOffersResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [GetSubscriptionOfferRequest](#GetSubscriptionOfferRequest)\n - [JSON representation](#GetSubscriptionOfferRequest.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nReads one or more subscription offers.\n\n### HTTP request\n\n`POST https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/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) for which the subscriptions should be created or updated. Must be equal to the packageName field on all the requests. |\n| `productId` | `string` 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. |\n| `basePlanId` | `string` Required. The parent base plan (ID) for which the offers should be read. May be specified as '-' to read offers from multiple base plans. |\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.subscriptions.basePlans.offers/batchGet#GetSubscriptionOfferRequest) } ] } ``` |\n\n| Fields ||\n|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `requests[]` | `object (`[GetSubscriptionOfferRequest](/android-publisher/api-ref/rest/v3/monetization.subscriptions.basePlans.offers/batchGet#GetSubscriptionOfferRequest)`)` Required. A list of update requests of up to 100 elements. All requests must update different subscriptions. |\n\n### Response body\n\nResponse message for offers.batchGet endpoint.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"subscriptionOffers\": [ { object (/android-publisher/api-ref/rest/v3/monetization.subscriptions.basePlans.offers#SubscriptionOffer) } ] } ``` |\n\n| Fields ||\n|------------------------|------------------------------------------------------------------------------------------------------------------------------------|\n| `subscriptionOffers[]` | `object (`[SubscriptionOffer](/android-publisher/api-ref/rest/v3/monetization.subscriptions.basePlans.offers#SubscriptionOffer)`)` |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/androidpublisher`\n\nGetSubscriptionOfferRequest\n---------------------------\n\nRequest message for offers.get.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------|\n| ``` { \"packageName\": string, \"productId\": string, \"basePlanId\": 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 subscription (ID) of the offer to get. |\n| `basePlanId` | `string` Required. The parent base plan (ID) of the offer to get. |\n| `offerId` | `string` Required. The unique offer ID of the offer to get. |"]]