Method: subscriptions.list

由转销商管理的订阅的列表。该列表可以是所有订阅、客户的所有订阅或客户的所有可转移订阅。

(可选)此方法可以按 customerNamePrefix 过滤响应。有关详情,请参阅管理订阅

HTTP 请求

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions

网址采用 gRPC 转码语法。

查询参数

参数
customerAuthToken

string

创建转销商账号以转移直接客户的订阅或将其他转销商客户的订阅转移给您的转销商管理时,必须提供 customerAuthToken 查询字符串。这是完成订阅转移所需的十六进制身份验证令牌。有关详情,请参阅管理员帮助中心

customerId

string

这可以是客户的主域名或客户的唯一标识符。如果客户的域名发生了更改,就无法使用旧域名访问该客户,但可以随时使用客户的唯一标识符(由 API 返回)。我们建议视情况将唯一标识符存储在您的系统中。

customerNamePrefix

string

在检索所有订阅并过滤特定客户时,您可以为客户名称输入前缀。使用包含 exam.comexample20.comexample.com 的示例客户群组:

  • exa -- 返回所有以“exa”开头的客户名称可能包括 exam.comexample20.comexample.com。名称前缀类似于使用正则表达式的星号 (exa*)。
  • example - 返回 example20.comexample.com

maxResults

integer (uint32 format)

检索大型列表时,maxResults 是每页的结果数上限。nextPageToken 值会将您转到下一页。默认值为 20。

pageToken

string

用于指定列表中下一页的令牌

请求正文

请求正文必须为空。

响应正文

订阅管理 Google 客户付款方案与产品的 SKU、用户许可、30 天免费试用状态和续订选项之间的关系。转销商的主要职责是管理 Google 客户的订阅。

如果成功,响应正文将包含结构如下的数据:

JSON 表示法
{
  "kind": string,
  "subscriptions": [
    {
      object (Subscription)
    }
  ],
  "nextPageToken": string
}
字段
kind

string

将资源标识为订阅集合。值:reseller#subscriptions

subscriptions[]

object (Subscription)

此结果页中的订阅。

nextPageToken

string

用于对大型结果集进行分页的接续令牌。在后续请求中提供此值以返回下一页结果。

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/apps.order
  • https://www.googleapis.com/auth/apps.order.readonly

有关详情,请参阅授权指南