Method: subscriptions.list
컬렉션을 사용해 정리하기
내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.
리셀러가 관리하는 구독 목록입니다. 목록은 모든 구독, 고객의 모든 구독 또는 고객의 이전 가능한 모든 구독일 수 있습니다.
원하는 경우 이 메서드는 customerNamePrefix
로 응답을 필터링할 수 있습니다. 자세한 내용은 구독 관리를 참고하세요.
HTTP 요청
GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions
URL은 gRPC 트랜스코딩 구문을 사용합니다.
쿼리 매개변수
매개변수 |
customerAuthToken |
string
직접 고객의 구독을 이전하거나 다른 리셀러 고객의 구독을 리셀러 관리로 이전하는 재판매 계정을 만들 때는 customerAuthToken 쿼리 문자열이 필요합니다. 정기 결제 이전을 완료하는 데 필요한 16진수 인증 토큰입니다. 자세한 내용은 관리자 고객센터를 참고하세요.
|
customerId |
string
고객의 기본 도메인 이름 또는 고객의 고유 식별자일 수 있습니다. 고객의 도메인 이름이 변경되면 이전 도메인 이름을 사용하여 고객에 액세스할 수 없지만 API에서 반환한 고객의 고유 식별자는 항상 사용할 수 있습니다. 해당하는 경우 고유 식별자를 시스템에 저장하는 것이 좋습니다.
|
customerNamePrefix |
string
모든 구독을 검색하고 특정 고객을 필터링할 때 고객 이름의 접두사를 입력할 수 있습니다. exam.com , example20.com , example.com 가 포함된 고객 그룹 예시를 사용합니다. exa : exam.com , example20.com , example.com 를 포함할 수 있는 'exa'로 시작하는 모든 고객 이름을 반환합니다. 이름 접두사는 정규 표현식의 별표, 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
자세한 내용은 승인 가이드를 참고하세요.
달리 명시되지 않는 한 이 페이지의 콘텐츠에는 Creative Commons Attribution 4.0 라이선스에 따라 라이선스가 부여되며, 코드 샘플에는 Apache 2.0 라이선스에 따라 라이선스가 부여됩니다. 자세한 내용은 Google Developers 사이트 정책을 참조하세요. 자바는 Oracle 및/또는 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)."]]