listClients
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Un company (appelé client) représente une organisation unique avec un compte sans contact. Cette méthode liste les clients associés à votre compte revendeur.
Signature de méthode
public ListCustomersResponse listCustomers(ListCustomersRequest request) throws CommonException;
ListCustomersRequest
| Nom de propriété |
Valeur |
Obligatoire |
Description |
pageSize |
int |
Non |
Taille de la page (jusqu'à 100). Si la valeur est supérieure à 100 ou null, 100 est utilisé. |
pageToken |
string |
Non |
Le jeton de page. Si elle est vide, la première page est renvoyée. |
vendorParams |
map |
Non |
Champs supplémentaires, paire clé-valeur spécifiée par le fournisseur. |
ListCustomersResponse
| Nom de propriété |
Valeur |
Description |
customers |
Liste de object(Company) |
Liste des clients associés au revendeur. |
totalCount |
int |
Nombre total d'appareils correspondant à la requête. |
nextPageToken |
strong |
Jeton de la page suivante. Vide pour la dernière page. |
vendorParams |
map |
Champs supplémentaires, paire clé-valeur spécifiée par le fournisseur. |
Comportement en cas d'erreur
Si une erreur se produit, la bibliothèque génère une CommonException contenant l'un des codes d'erreur suivants:
| Code d'erreur |
INTERNAL_SERVER_ERROR |
INVALID_PAGE_TOKEN |
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/08/29 (UTC).
[null,null,["Dernière mise à jour le 2025/08/29 (UTC)."],[[["\u003cp\u003eA company, referred to as a customer, represents an organization with a zero-touch account.\u003c/p\u003e\n"],["\u003cp\u003eThis method \u003ccode\u003elistCustomers\u003c/code\u003e is used to list customers associated with a reseller account.\u003c/p\u003e\n"],["\u003cp\u003eThe request for the list of customers can be customized using \u003ccode\u003epageSize\u003c/code\u003e, \u003ccode\u003epageToken\u003c/code\u003e, and \u003ccode\u003evendorParams\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eListCustomersResponse\u003c/code\u003e provides a list of customers, total customer count, the next page token, and extra vendor parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003elistCustomers\u003c/code\u003e method can throw a \u003ccode\u003eCommonException\u003c/code\u003e with \u003ccode\u003eINTERNAL_SERVER_ERROR\u003c/code\u003e or \u003ccode\u003eINVALID_PAGE_TOKEN\u003c/code\u003e error codes.\u003c/p\u003e\n"]]],["The `listCustomers` method retrieves a list of customer organizations associated with a reseller account. It accepts a `ListCustomersRequest` with optional `pageSize` (up to 100), `pageToken`, and `vendorParams`. The response, `ListCustomersResponse`, includes a list of `customers`, `totalCount`, `nextPageToken` for pagination, and `vendorParams`. Errors are returned as `CommonException` with codes like `INTERNAL_SERVER_ERROR` or `INVALID_PAGE_TOKEN`.\n"],null,["# listCustomers\n\nA [`company`](/zero-touch/reseller-library/reference/objects#company) (referred to as a *customer*)\nrepresents a unique organization with a zero-touch account. This method lists\ncustomers associated with your reseller account.\n\nMethod signature\n----------------\n\n public ListCustomersResponse listCustomers(ListCustomersRequest request) throws CommonException;\n\nListCustomersRequest\n--------------------\n\n| Property name | Value | Required | Description |\n|----------------|----------|----------|-----------------------------------------------------------------------------|\n| `pageSize` | `int` | No | The page size, up to `100`. If greater than `100` or `null`, `100` is used. |\n| `pageToken` | `string` | No | The page token. If empty, the first page is returned. |\n| `vendorParams` | `map` | No | Extra fields, vendor specified key-value pair. |\n\nListCustomersResponse\n---------------------\n\n| Property name | Value | Description |\n|-----------------|-----------------------------------------------------------------------------------------|-----------------------------------------------------|\n| `customers` | List of `object(`[`Company`](/zero-touch/reseller-library/reference/objects#company)`)` | The list of customers associated with the reseller. |\n| `totalCount` | `int` | The total count of devices matching the request. |\n| `nextPageToken` | `strong` | The next page token. Empty for the last page. |\n| `vendorParams` | `map` | Extra fields, vendor specified key-value pair. |\n\nError behavior\n--------------\n\nIf an error occurs, the library throws a `CommonException` containing one of the\nfollowing error codes:\n\n| Error code |\n|-------------------------|\n| `INTERNAL_SERVER_ERROR` |\n| `INVALID_PAGE_TOKEN` |"]]
