Method: subscriptions.list
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
لیست اشتراک های مدیریت شده توسط فروشنده. این لیست می تواند همه اشتراک ها، همه اشتراک های مشتری یا همه اشتراک های قابل انتقال مشتری باشد.
به صورت اختیاری، این روش می‌تواند پاسخ را با یک customerNamePrefix فیلتر کند. برای اطلاعات بیشتر، به مدیریت اشتراک‌ها مراجعه کنید.
درخواست HTTP
GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای پرس و جو
| پارامترها |
|---|
customerAuthToken | string رشته پرس و جو customerAuthToken هنگام ایجاد یک حساب فروش مجدد که اشتراک مستقیم مشتری را منتقل می کند یا اشتراک مشتری فروشنده دیگری را به مدیریت فروشنده شما منتقل می کند، مورد نیاز است. این یک نشانه احراز هویت هگزادسیمال است که برای تکمیل انتقال اشتراک مورد نیاز است. برای اطلاعات بیشتر، به مرکز راهنمایی سرپرست مراجعه کنید. |
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 حداکثر تعداد نتایج در هر صفحه است. مقدار nextPageToken شما را به صفحه بعدی می برد. پیش فرض 20 است. |
pageToken | string رمزی برای تعیین صفحه بعدی در لیست |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
یک اشتراک، رابطه طرح پرداخت مشتری Google با SKU محصول، مجوزهای کاربر، وضعیت آزمایشی رایگان 30 روزه و گزینه‌های تمدید را مدیریت می‌کند. نقش اصلی یک فروشنده این است که اشتراک های مشتری Google را مدیریت کند.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
| نمایندگی JSON |
|---|
{
"kind": string,
"subscriptions": [
{
object (Subscription)
}
],
"nextPageToken": string
} |
| فیلدها |
|---|
kind | string منبع را به عنوان مجموعه ای از اشتراک ها شناسایی می کند. ارزش: فروشنده #اشتراک |
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 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی."],[],[],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)."]]
