Method: customers.list
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Solicitud HTTP
GET https://sasportal.googleapis.com/v1alpha1/customers
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de consulta
| Parámetros |
pageSize |
integer
Es la cantidad máxima de customers que se devolverán en la respuesta.
|
pageToken |
string
Un token de paginación que dio como resultado una llamada anterior a customers.list y que indica desde dónde debería continuar esta enumeración.
|
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:
La respuesta para customers.list.
| Representación JSON |
{
"customers": [
{
object (Customer)
}
],
"nextPageToken": string
} |
| Campos |
customers[] |
object (Customer)
Es la lista de customers que coinciden con la solicitud.
|
nextPageToken |
string
Es un token de paginación que se muestra a partir de una llamada anterior a customers.list y que indica desde dónde debería continuar la enumeración. Si el campo falta o está vacío, significa que no hay más clientes.
|
Alcances de la autorización
Requiere el siguiente alcance de OAuth:
https://www.googleapis.com/auth/sasportal
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-25 (UTC)
[null,null,["Última actualización: 2025-07-25 (UTC)"],[[["\u003cp\u003eThis API call (\u003ccode\u003eGET https://sasportal.googleapis.com/v1alpha1/customers\u003c/code\u003e) retrieves a list of customers within the Spectrum Access System.\u003c/p\u003e\n"],["\u003cp\u003eUsers can control the number of results and pagination via query parameters \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe response provides a list of customers and a token for retrieving further results if available.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the \u003ccode\u003ehttps://www.googleapis.com/auth/sasportal\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],["This document details the process of listing customers via an HTTP `GET` request to `https://sasportal.googleapis.com/v1alpha1/customers`. The request utilizes query parameters `pageSize` and `pageToken` for pagination. The request body must be empty. The successful response returns a JSON object containing an array of `customers` and a `nextPageToken` for further pagination. The request requires OAuth scope `https://www.googleapis.com/auth/sasportal`.\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/v1alpha1/customers#Customer).\n\n### HTTP request\n\n`GET https://sasportal.googleapis.com/v1alpha1/customers`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of [customers](/spectrum-access-system/reference/rest/v1alpha1/customers#Customer) to return in the response. |\n| `pageToken` | `string` A pagination token returned from a previous call to [customers.list](/spectrum-access-system/reference/rest/v1alpha1/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/v1alpha1/customers#Customer) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customers[]` | `object (`[Customer](/spectrum-access-system/reference/rest/v1alpha1/customers#Customer)`)` The list of [customers](/spectrum-access-system/reference/rest/v1alpha1/customers#Customer) that match the request. |\n| `nextPageToken` | `string` A pagination token returned from a previous call to [customers.list](/spectrum-access-system/reference/rest/v1alpha1/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/sasportal`"]]
