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)

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

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