Method: subscriptions.list
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
רשימות של מינויים שמנוהלים על ידי המפיץ. הרשימה יכולה לכלול את כל המינויים, את כל המינויים של לקוח מסוים או את כל המינויים של לקוח מסוים שניתנים להעברה.
אפשר גם לסנן את התשובה לפי customerNamePrefix באמצעות השיטה הזו. מידע נוסף זמין במאמר ניהול מינויים.
בקשת HTTP
GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions
כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.
פרמטרים של שאילתה
| פרמטרים |
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 לבין מק"ט המוצר, רישיונות המשתמשים, סטטוס תקופת הניסיון בחינם של 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 (שעון 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)."]]
