集合 partnerSubscriptions

资源 PartnerSubscription

包含完成订阅所需信息的订阅视图。订阅是客户与 Google 达成的一项协议，客户可以在特定时间段内从 Google 购买特定资源。

一次订阅代表一次购买。如果用户取消并重新开始购买或更改订阅的资源（包括升级或降级服务等级），则会表示为新的订阅。新订阅将使用新的 name，但 externalAccountId 与旧订阅相同。

JSON 表示形式 

{
  "name": string,
  "externalAccountId": string,
  "version": string,
  "status": enum(Status),
  "subscribedResources": [
    {
      object(SubscribedResource)
    }
  ],
  "requiredApprovals": [
    {
      object(RequiredApproval)
    }
  ],
  "startDate": {
    object(Date)
  },
  "endDate": {
    object(Date)
  },
  "createTime": string,
  "updateTime": string,
}
字段名称 类型 说明
name string 此订阅的名称。这将在创建订阅时自动生成。此字段采用如下格式：订阅/*，其中 * 为不透明字符串。
externalAccountId string 拥有此订阅的帐号的标识符。此标识符对于具体帐号和订阅提供程序而言是唯一的。
version string 此记录的不透明版本号。此字段可用于轻松检查订阅是否有更新。
status enum(Status) 此订阅的当前状态。
subscribedResources[] object(SubscribedResource) 此订阅中包含的资源。所有这些资源都必须属于同一订阅提供程序。
requiredApprovals[] object(RequiredApproval) 代表一组批准，订阅必须获得全部批准才能转为 ACTIVE 状态。如果订阅所需的批准为零，则其不需要任何批准即可转为 ACTIVE 状态。
startDate object(Date) 此订阅的开始日期。
endDate object(Date) 状态为 COMPLETE 时此订阅的结束日期，否则为空。
createTime string

创建此订阅的时间戳。如果作为输入提供，则服务器将忽略它。@OutputOnly

此时间戳采用 RFC3339 世界协调时间 (UTC)（即“祖鲁时”）格式，且精确到纳秒。示例："2014-10-02T15:01:23.045123456Z"。
updateTime string

上次修改此订阅的时间戳。如果作为输入提供，则服务器将忽略它。@OutputOnly

此时间戳采用 RFC3339 世界协调时间 (UTC)（即“祖鲁时”）格式，且精确到纳秒。示例："2014-10-02T15:01:23.045123456Z"。

Status

订阅的当前状态。

枚举值 说明
UNKNOWN_STATUS 默认值。应永不返回此值。
ACTIVE 订阅已处理，目前正在运行。
COMPLETE 订阅过去曾有效，但现在已结束。订阅标记为完成后，就不会再转为 ACTIVE。
PENDING 订阅已创建，但尚未开始。其开始日期可能是将来的日期，并且/或者需要一个或多个 RequiredApprovals。
CANCELED 无法完成订阅。它在转为 ACTIVE 之前已被取消。

SubscribedResource

标识由订阅购买的单个资源，包括订阅提供程序、资源以及用于标识所购买资源的其他元数据。

JSON 表示形式 

{
  "subscriptionProvider": string,
  "resource": string,
  "labels": {
    string: string,
    ...
  },
}
字段名称 类型 说明
subscriptionProvider string 要订阅的资源的提供程序名称。如果订阅与现有 API 相关联，则应为该 API 的网址（例如 example.googleapis.com）。如果资源未与现有 API 关联，则该名称是将提供程序名称附加到此 API 网址之前（例如 example-cloudbilling.googleapis.com）。
resource string 应订阅的资源类型的名称。此名称采用驼峰式大小写描述购买的内容，并在配置新资源类型时进行定义。
labels map (key: string, value: string)

此资源的标签集合。这些字段可用于为此资源提供自定义配置或存储其他元数据。

标签的常见用途是为具有多个级别的订阅类型指定服务级别。例如，具有白银级和黄金级的支持订阅可以使用具有“SupportLevel”键的标签，其可能的值为“Gold”和“Silver”。

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

RequiredApproval

表示在开始订阅之前必须提供的批准。这可能表示自动批准或手动批准。批准在创建订阅时自动创建。批准可以通过批准，也可以被拒绝。批准或拒绝后，无法更改批准状态。

JSON 表示形式 

{
  "name": string,
  "status": enum(Status),
  "approvalTime": string,
  "approvalNote": string,
}
字段名称 类型 说明
name string 此批准的名称。它必须具有值“default-approval”。
status enum(Status) 此批准的状态。创建具有批准的订阅时，此值必须为 PENDING。更新批准时，应将其设置为 APPROVED 或 DENIED。
approvalTime string

授予批准或拒绝批准的时间。这是自动设置的。@OutputOnly

此时间戳采用 RFC3339 世界协调时间 (UTC)（即“祖鲁时”）格式，且精确到纳秒。示例："2014-10-02T15:01:23.045123456Z"。
approvalNote string 状态更改的说明。当状态为 APPROVED 时，此字段是可选的；当状态为 DENIED 时，此字段是必需的。

Status

指示所需批准的当前状态。

枚举值 说明
STATUS_UNSPECIFIED 默认值。应永不返回此值。
PENDING 批准既未授予，也未拒绝。
APPROVED 已授予批准。
DENIED 已拒绝批准。

Date

代表整个日历日期，例如出生日期。一天中的时间和时区要么在别处指定，要么不重要。日期相对于前公历。天可以是 0，表示天不重要（例如信用卡失效日期）的年份和月份。年份可以是 0，表示独立于年份的月份和日期，例如周年纪念日。相关类型为 [google.type.TimeOfDay][] 和 google.protobuf.Timestamp。

JSON 表示形式 

{
  "year": number,
  "month": number,
  "day": number,
}
字段名称 类型 说明
year number 年份。必须是 1 到 9999，如果指定的日期不含年份，则为 0。
month number 月份。值必须是介于 1 和 12 之间的数字。
day number 日期。必须是 1 到 31 并且对年和月有效，如果仅指定年份/月份（天不重要），则为 0。

方法

方法 说明
approve 在合作伙伴订阅中将 PENDING 批准状态更改为 APPROVED。
deny 在合作伙伴订阅中将 PENDING 批准状态更改为 DENIED。
get 检索单个订阅的当前状态。
list 列出指定外部帐号 ID 的所有订阅。