Method: monetization.subscriptions.basePlans.offers.list
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
HTTP 要求
GET https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 |
packageName |
string
必要欄位。應讀取訂閱項目的父項應用程式 (套件名稱)。
|
productId |
string
必要欄位。應讀取優惠的父項訂閱項目 (ID)。可以指定為「-」閱讀應用程式提供的所有優惠。
|
basePlanId |
string
必要欄位。應讀取優惠的父項基本方案 (ID)。可以指定為「-」閱讀訂閱項目或應用程式的所有優惠。必須以「-」指定。
|
查詢參數
參數 |
pageSize |
integer
要傳回的訂閱數量上限。服務傳回的產品數量可能會少於這個值。如未指定,最多將傳回 50 個訂閱項目。值的數量上限是 1000;超過 1000 個值會強制轉換為 1000。
|
pageToken |
string
屬於接收自前一個 ListSubscriptionsOffers 呼叫的網頁權杖。提供此項目即可擷取後續網頁。 進行分頁時,提供至 offers.list 的所有其他參數須與提供網頁權杖的呼叫相符。
|
回應主體
Offer.list 的回應訊息。
如果成功,回應主體會含有以下結構的資料:
JSON 表示法 |
{
"subscriptionOffers": [
{
object (SubscriptionOffer )
}
],
"nextPageToken": string
} |
欄位 |
subscriptionOffers[] |
object (SubscriptionOffer )
指定訂閱項目的訂閱優惠。
|
nextPageToken |
string
可做為 pageToken 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。
|
授權範圍
需要下列 OAuth 範圍:
https://www.googleapis.com/auth/androidpublisher
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2025-07-26 (世界標準時間)。
[null,null,["上次更新時間:2025-07-26 (世界標準時間)。"],[[["\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`"]]