Method: subscriptions.list
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
قوائم الاشتراكات التي يديرها المورّد يمكن أن تتضمّن القائمة جميع الاشتراكات أو جميع اشتراكات العميل أو جميع اشتراكات العميل القابلة للتحويل.
يمكن لهذه الطريقة اختياريًا فلترة الردّ حسب customerNamePrefix. لمزيد من المعلومات، يُرجى الاطّلاع على مقالة إدارة الاشتراكات.
طلب HTTP
GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
مَعلمات طلب البحث
| المعلمات |
customerAuthToken |
string
يجب إدخال سلسلة طلب البحث customerAuthToken عند إنشاء حساب مُعاد بيعه ينقل اشتراك عميل مباشر أو ينقل اشتراك عميل مورِّد آخر إلى حساب إدارة المورِّد. هذا رمز مصادقة سداسي عشري مطلوب لإكمال عملية نقل الاشتراك. لمزيد من المعلومات، يُرجى الاطّلاع على مركز مساعدة المشرف.
|
customerId |
string
يمكن أن يكون هذا اسم النطاق الأساسي للعميل أو المعرّف الفريد للعميل. في حال تغيير اسم نطاق العميل، لا يمكن استخدام اسم النطاق القديم للوصول إلى العميل، ولكن يمكن استخدام المعرّف الفريد للعميل (كما تعرضه واجهة برمجة التطبيقات) في أي وقت. ننصحك بتخزين المعرّف الفريد في أنظمتك كلما أمكن ذلك.
|
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 برمز التخزين التعريفي للمنتج، والتراخيص الممنوحة للمستخدمين، وحالة الفترة التجريبية المجانية لمدة 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. إنّ Java هي علامة تجارية مسجَّلة لشركة 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)."]]
