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)。可指定为“-”以读取订阅或应用下的所有优惠。必须指定为“-”如果 productId 指定为“-”。
|
查询参数
参数 |
pageSize |
integer
要返回的最大订阅数。服务返回的值可能小于此值。如果未指定,则最多返回 50 个订阅。最大值为 1,000;大于 1,000 的值将被强制转换为 1,000。
|
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
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-07-26。
[null,null,["最后更新时间 (UTC):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`"]]