Method: customers.list
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
בקשת HTTP
GET https://sasportal.googleapis.com/v1alpha1/customers
כתובת ה-URL משתמשת בתחביר של gRPC Transcoding.
פרמטרים של שאילתה
| פרמטרים |
pageSize |
number
המספר המקסימלי של customers שיוחזרו בתשובה.
|
pageToken |
string
אסימון עימוד שהוחזר מקריאה קודמת ל-customers.list method ומציין מאיפה צריך להמשיך את הרישום הזה.
|
גוף הבקשה
גוף הבקשה צריך להיות ריק.
גוף התשובה
אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:
תשובה לשאילתה customers.list.
| ייצוג ב-JSON |
{
"customers": [
{
object (Customer)
}
],
"nextPageToken": string
} |
| שדות |
customers[] |
object (Customer)
ה-list of customers שתואמים לבקשה.
|
nextPageToken |
string
אסימון עימוד שהוחזר מקריאה קודמת ל-customers.list method ומציין מאיפה צריך להמשיך את הרשימה. אם השדה חסר או ריק, המשמעות היא שאין יותר לקוחות.
|
היקפי הרשאות
נדרש היקף ההרשאות הבא של OAuth:
https://www.googleapis.com/auth/userinfo.email
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-25 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-25 (שעון UTC)."],[[["\u003cp\u003eLists requested customers based on provided parameters and authorization.\u003c/p\u003e\n"],["\u003cp\u003eAllows for pagination to retrieve large sets of customers with \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eResponse includes a list of customers and a token for retrieving further results.\u003c/p\u003e\n"],["\u003cp\u003eRequires the \u003ccode\u003ehttps://www.googleapis.com/auth/userinfo.email\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"],["\u003cp\u003eUtilizes a GET request to the specified endpoint \u003ccode\u003ehttps://sasportal.googleapis.com/v1alpha1/customers\u003c/code\u003e with optional query parameters.\u003c/p\u003e\n"]]],["The core content describes the process of retrieving a list of customers using a `GET` request to `https://sasportal.googleapis.com/v1alpha1/customers`. This request supports optional `pageSize` and `pageToken` query parameters for pagination. The request body must be empty. The response returns a JSON object containing an array of customer objects and a `nextPageToken` for further pagination if available. An `OAuth` scope is required.\n"],null,["# Method: customers.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.ListCustomersResponse.SCHEMA_REPRESENTATION)\n- [Authorization Scopes](#body.aspect)\n\nReturns a list of requested [customers](/spectrum-access-system/reference/rest/customers#Customer).\n\n### HTTP request\n\n`GET https://sasportal.googleapis.com/v1alpha1/customers`\n\nThe URL uses [gRPC Transcoding](https://github.com/googleapis/googleapis/blob/master/google/api/http.proto) syntax.\n\n### Query parameters\n\n| Parameters ||\n|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `number` The maximum number of [customers](/spectrum-access-system/reference/rest/customers#Customer) to return in the response. |\n| `pageToken` | `string` A pagination token returned from a previous call to [customers.list method](/spectrum-access-system/reference/rest/customers/list#spectrum.sas.portal.v1alpha1.Customers.ListCustomers) that indicates where this listing should continue from. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\nResponse for `customers.list`.\n\n| JSON representation ||\n|------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"customers\": [ { object (/spectrum-access-system/reference/rest/customers#Customer) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customers[]` | `object (`[Customer](/spectrum-access-system/reference/rest/customers#Customer)`)` The [list of customers](/spectrum-access-system/reference/rest/customers#Customer) that match the request. |\n| `nextPageToken` | `string` A pagination token returned from a previous call to [customers.list method](/spectrum-access-system/reference/rest/customers/list#spectrum.sas.portal.v1alpha1.Customers.ListCustomers) that indicates from where listing should continue. If the field is missing or empty, it means there are no more customers. |\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/userinfo.email`"]]
