Method: subscriptions.list

販売パートナーが管理するサブスクリプションのリスト。すべてのサブスクリプション、お客様のすべてのサブスクリプション、お客様が移行可能なすべてのサブスクリプションをリストに含めることが可能です。

必要に応じて、このメソッドは customerNamePrefix でレスポンスをフィルタリングできます。詳しくは、定期購入の管理をご覧ください。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

クエリ パラメータ

パラメータ
customerAuthToken

string

販売パートナー経由で購入されたアカウントを作成して直接顧客のサブスクリプションを移行する場合、または別の販売パートナー顧客のサブスクリプションを販売パートナーの管理に移行する場合は、customerAuthToken クエリ文字列が必要です。これは、定期購入の移行を完了するために必要な 16 進数の認証トークンです。詳しくは、管理者向けヘルプセンターをご覧ください。
customerId

string

これは、顧客のプライマリ ドメイン名または顧客の一意の識別子のいずれかになります。顧客のドメイン名が変更された場合、古いドメイン名は顧客へのアクセスに使用できなくなりますが、顧客の一意の識別子（API から返されるもの）は常に使用できます。該当する場合は、システムに一意の識別子を保存することをおすすめします。
customerNamePrefix

string

すべてのサブスクリプションを取得して特定の顧客でフィルタする場合は、顧客名の接頭辞を入力できます。たとえば、exam.com、example20.com、example.com を含む顧客グループの例を以下に示します。

  • exa -- 「exa」で始まるすべての顧客名を返します。exam.com、example20.com、example.com などが該当します。名前の接頭辞は、正規表現のアスタリスク（exa*）を使用する場合と似ています。
  • example - example20.com と example.com を返します。
maxResults

integer (uint32 format)

大きなリストを取得する場合、maxResults は 1 ページあたりの結果の最大数です。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

詳細については、承認ガイドをご覧ください。