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.com 、example20.com 、example.com を含む顧客グループの例を使用します。 exa - 「exa」で始まるすべての顧客名を返します(exam.com 、example20.com 、example.com など)。名前の接頭辞は、正規表現のアスタリスク(exa*)を使用する場合と似ています。 example - example20.com と example.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
詳しくは、認可ガイドをご覧ください。
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-07-25 UTC。
[null,null,["最終更新日 2025-07-25 UTC。"],[],[],null,["# Method: subscriptions.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.Subscriptions.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists of subscriptions managed by the reseller. The list can be all subscriptions, all of a customer's subscriptions, or all of a customer's transferable subscriptions.\n\nOptionally, this method can filter the response by a `customerNamePrefix`. For more information, see [manage subscriptions](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions).\n\n### HTTP request\n\n`GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customerAuthToken` | `string` The `customerAuthToken` query string is required when creating a resold account that transfers a direct customer's subscription or transfers another reseller customer's subscription to your reseller management. This is a hexadecimal authentication token needed to complete the subscription transfer. For more information, see the [administrator help center](//support.google.com/a/bin/answer.py?answer=142336). |\n| `customerId` | `string` This can be either the customer's primary domain name or the customer's unique identifier. If the domain name for a customer changes, the old domain name cannot be used to access the customer, but the customer's unique identifier (as returned by the API) can always be used. We recommend storing the unique identifier in your systems where applicable. |\n| `customerNamePrefix` | `string` When retrieving all of your subscriptions and filtering for specific customers, you can enter a prefix for a customer name. Using an example customer group that includes `exam.com`, `example20.com` and `example.com`: - `exa` -- Returns all customer names that start with 'exa' which could include `exam.com`, `example20.com`, and `example.com`. A name prefix is similar to using a regular expression's asterisk, exa\\*. - `example` -- Returns `example20.com` and `example.com`. \u003cbr /\u003e |\n| `maxResults` | `integer (`[uint32](https://developers.google.com/discovery/v1/type-format)` format)` When retrieving a large list, the `maxResults` is the maximum number of results per page. The `nextPageToken` value takes you to the next page. The default is 20. |\n| `pageToken` | `string` Token to specify next page in the list |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nA subscription manages the relationship of a Google customer's payment plan with a product's SKU, user licenses, 30-day free trial status, and renewal options. A primary role of a reseller is to manage the Google customer's subscriptions.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"subscriptions\": [ { object (/workspace/admin/reseller/reference/rest/v1/subscriptions#Subscription) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies the resource as a collection of subscriptions. Value: reseller#subscriptions |\n| `subscriptions[]` | `object (`[Subscription](/workspace/admin/reseller/reference/rest/v1/subscriptions#Subscription)`)` The subscriptions in this page of results. |\n| `nextPageToken` | `string` The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/apps.order`\n- `\n https://www.googleapis.com/auth/apps.order.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]