listCustomers
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
company
(お客様)は、ゼロタッチ アカウントを持つ一意の組織を表します。このメソッドは、販売パートナー アカウントに関連付けられているお客様を一覧表示します。
メソッド シグネチャ
public ListCustomersResponse listCustomers(ListCustomersRequest request) throws CommonException;
ListCustomersRequest
プロパティ名 |
値 |
必須 |
説明 |
pageSize |
int |
いいえ |
ページサイズ(最大 100 )。100 または null より大きい場合は、100 が使用されます。 |
pageToken |
string |
いいえ |
ページトークン。空の場合は、最初のページが返されます。 |
vendorParams |
map |
いいえ |
追加フィールド、ベンダー指定の Key-Value ペア。 |
ListCustomersResponse
プロパティ名 |
値 |
説明 |
customers |
object( Company ) のリスト |
販売パートナーに関連付けられているお客様のリスト。 |
totalCount |
int |
リクエストに一致するデバイスの合計数。 |
nextPageToken |
strong |
次のページトークン。最後のページの場合は空白です。 |
vendorParams |
map |
追加フィールド、ベンダー指定の Key-Value ペア。 |
エラーの動作
エラーが発生すると、ライブラリは次のいずれかのエラーコードを含む CommonException
をスローします。
エラーコード |
INTERNAL_SERVER_ERROR |
INVALID_PAGE_TOKEN |
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-07-25 UTC。
[null,null,["最終更新日 2025-07-25 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,["A [`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 public ListCustomersResponse listCustomers(ListCustomersRequest request) throws CommonException;\n\nListCustomersRequest\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| 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\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` |"]]