Method: subscriptions.list

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

必要に応じて、このメソッドで customerNamePrefix でレスポンスをフィルタできます。詳しくは、サブスクリプションを管理するをご覧ください。

HTTP リクエスト

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

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

クエリ パラメータ

パラメータ
customerAuthToken

string

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

customerId

string

顧客のメインのドメイン名または顧客の一意の ID を指定できます。お客様のドメイン名が変更された場合、古いドメイン名を使用してお客様にアクセスすることはできませんが、(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

詳しくは、認可ガイドをご覧ください。