Method: monetization.subscriptions.basePlans.offers.batchGet
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
HTTP リクエスト
POST https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers:batchGet
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ |
packageName |
string
必須。定期購入を作成または更新する親アプリ(パッケージ名)。すべてのリクエストの packageName フィールドと同じにする必要があります。
|
productId |
string
必須。親定期購入のプロダクト ID(更新されたオファーがすべて同じ定期購入に属している場合)。このリクエストが複数の定期購入にまたがっている場合は、このフィールドを「-」に設定します。設定する必要があります。
|
basePlanId |
string
必須。特典の読み取り先となる親基本プラン(ID)。「-」として指定できるを使用して、複数の基本プランの特典を読み取ることができます。
|
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
フィールド |
requests[] |
object (GetSubscriptionOfferRequest )
必須。最大 100 個の要素を含む更新リクエストのリスト。すべてのリクエストで異なるサブスクリプションを更新する必要があります。
|
レスポンスの本文
offer.batchGet エンドポイントに対するレスポンス メッセージ。
成功した場合、レスポンスの本文には次の構造のデータが含まれます。
フィールド |
subscriptionOffers[] |
object (SubscriptionOffer )
|
認可スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/androidpublisher
GetSubscriptionOfferRequest
offer.get に対するリクエスト メッセージです。
JSON 表現 |
{
"packageName": string,
"productId": string,
"basePlanId": string,
"offerId": string
} |
フィールド |
packageName |
string
必須。取得するクーポンの親アプリ(パッケージ名)。
|
productId |
string
必須。取得するオファーの親サブスクリプション(ID)。
|
basePlanId |
string
必須。取得する特典の親基本プラン(ID)。
|
offerId |
string
必須。取得するオファーの一意のオファー ID。
|
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-07-26 UTC。
[null,null,["最終更新日 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. |"]]