Method: monetization.subscriptions.basePlans.offers.list
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
指定されたサブスクリプションのすべてのオファーを一覧表示します。
HTTP リクエスト
GET https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
| パラメータ |
packageName |
string
必須。サブスクリプションを読み取る親アプリ（パッケージ名）。
|
productId |
string
必須。オファーを読み取る親サブスクリプション（ID）。「-」として指定できるすべてのオファーを読み取ることができます。
|
basePlanId |
string
必須。特典の読み取り先となる親基本プラン（ID）。「-」として指定できる定期購入やアプリのすべての特典を読むことができます。「-」として指定する必要がありますproductId を「-」として指定した場合。
|
クエリ パラメータ
| パラメータ |
pageSize |
integer
返されるサブスクリプションの最大数。サービスが返す値はこれよりも少ないことがあります。指定しない場合、最大で 50 個のサブスクリプションが返されます。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。
|
pageToken |
string
前回の ListSubscriptionsOffers 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。 ページ分割を行う場合、offers.list に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。
|
リクエストの本文
リクエストの本文は空にする必要があります。
レスポンスの本文
offers.list に対するレスポンス メッセージです。
成功した場合、レスポンスの本文には次の構造のデータが含まれます。
| JSON 表現 |
{
"subscriptionOffers": [
{
object (SubscriptionOffer)
}
],
"nextPageToken": string
} |
| フィールド |
subscriptionOffers[] |
object (SubscriptionOffer)
指定したサブスクリプションから定期購読が提案されます。
|
nextPageToken |
string
次のページを取得するために pageToken として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。
|
認可スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/androidpublisher
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-07-26 UTC。
[null,null,["最終更新日 2025-07-26 UTC。"],[[["\u003cp\u003eLists all subscription offers under a given base plan, subscription, or app.\u003c/p\u003e\n"],["\u003cp\u003eThe request is a standard \u003ccode\u003eGET\u003c/code\u003e request with path and query parameters for filtering.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes an array of \u003ccode\u003eSubscriptionOffer\u003c/code\u003e objects and a token for pagination.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/androidpublisher\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This document details how to retrieve a list of subscription offers for an Android app. The core action is a `GET` HTTP request to a specific URL: `https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers`. The request requires specifying the app's package name, subscription ID, and base plan ID as path parameters. Optional query parameters `pageSize` and `pageToken` control the number of results and pagination. The response body returns a list of subscription offers and a potential token for the next page. It requires specific authorization scopes.\n"],null,["# Method: monetization.subscriptions.basePlans.offers.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListSubscriptionOffersResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists all offers under a given subscription.\n\n### HTTP request\n\n`GET https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers`\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 read. |\n| `productId` | `string` Required. The parent subscription (ID) for which the offers should be read. May be specified as '-' to read all offers under an app. |\n| `basePlanId` | `string` 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 productId is specified as '-'. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` 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. |\n| `pageToken` | `string` A page token, received from a previous `ListSubscriptionsOffers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `offers.list` must match the call that provided the page token. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for offers.list.\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) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `subscriptionOffers[]` | `object (`[SubscriptionOffer](/android-publisher/api-ref/rest/v3/monetization.subscriptions.basePlans.offers#SubscriptionOffer)`)` The subscription offers from the specified subscription. |\n| `nextPageToken` | `string` A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/androidpublisher`"]]
