コレクション 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 このサブスクリプションの名前。サブスクリプションを作成すると自動的に与えられます。subscriptions/* という形式になり、* は不完全文字列です。
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「Zulu」形式のタイムスタンプ。精度はナノ秒。例: "2014-10-02T15:01:23.045123456Z"。
updateTime string

サブスクリプションが前回修正されたときのタイムスタンプ。入力として与えられた場合は、サーバーで無視されます。@OutputOnly

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒。例: "2014-10-02T15:01:23.045123456Z"。

ステータス

サブスクリプションの現在のステータス。

列挙値 説明
UNKNOWN_STATUS デフォルト値。この値が戻されてはいけません。
ACTIVE サブスクリプションが処理され、現在進行中です。
COMPLETE サブスクリプションがいったんアクティブになりましたが、終了しました。完了とマークされたサブスクリプションが再び ACTIVE になることはありません。
PENDING サブスクリプションが作成されましたが、まだ開始されていません。開始日が未来になっているか、1 つ以上の RequiredApprovals が必要です。
CANCELED サブスクリプションを履行できませんでした。ACTIVE になる前にキャンセルされました。

SubscribedResource

サブスクリプションによって購入した 1 つのリソースを、サブスクリプション プロバイダ、リソース、および購入したリソースを識別する追加メタデータなどで識別します。

JSON 表現 

{
  "subscriptionProvider": string,
  "resource": string,
  "labels": {
    string: string,
    ...
  },
}
フィールド名 タイプ 説明
subscriptionProvider string 登録するリソースのプロバイダの名前。サブスクリプションが既存の API と関連付けられている場合は、その API の URL（例: example.googleapis.com）にする必要があります。リソースが既存の API と関連付けられていない場合、この名前はこの API の URL の前にプロバイダの名前を追加したものになります（例: 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「Zulu」形式のタイムスタンプ。精度はナノ秒。例: "2014-10-02T15:01:23.045123456Z"。
approvalNote string ステータス変更の説明。ステータスが APPROVED の場合は任意、ステータスが DENIED の場合は必須です。

ステータス

必要な承認の現在の状態を示します。

列挙値 説明
STATUS_UNSPECIFIED デフォルト値。この値が戻されてはいけません。
PENDING 承認は付与も拒否もされていません。
APPROVED 承認が付与されました。
DENIED 承認が拒否されました。

日付

生年月日などのように、カレンダーの日付全体を表します。時間帯とタイムゾーンは、他の場所で指定されているか、重要ではありません。日付は先発グレゴリオ暦を基準にしています。クレジット カードの有効期限などのように日が重要ではない場合は日を 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 ある 1 つのサブスクリプションの現在のステータスを取得します。
list 指定された外部アカウント ID のすべてのサブスクリプションをリスト表示します。