findDevicesByIdentifier
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
指定したデバイス ID を持つデバイスを一覧表示します。
メソッド シグネチャ
public FindDevicesResponse findDevicesByDeviceIdentifier(FindDevicesByDeviceIdentifierRequest request) throws CommonException;
FindDevicesByDeviceIdentifierRequest
プロパティ名 |
値 |
必須 |
説明 |
deviceIdentifier |
object( DeviceIdentifier ) |
はい |
取得するデバイスのデバイス ID。オブジェクトに部分的にデータを入力できます。 |
pageSize |
int |
いいえ |
ページサイズ(最大 100 )。100 または null より大きい場合は、100 が使用されます。 |
pageToken |
string |
いいえ |
ページトークン。空の場合は、最初のページが返されます。 |
vendorParams |
map |
いいえ |
追加フィールド、ベンダー指定の Key-Value ペア。 |
FindDevicesResponse
プロパティ名 |
値 |
説明 |
devices |
object( Device ) |
販売パートナーがアップロードしたデバイスのリスト。一致しない場合は空になります。 |
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\u003eThis method retrieves a list of devices based on a provided device identifier.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires a \u003ccode\u003edeviceIdentifier\u003c/code\u003e object, which can be partially filled, to specify the devices to be retrieved.\u003c/p\u003e\n"],["\u003cp\u003eOptional parameters include \u003ccode\u003epageSize\u003c/code\u003e (up to 100), \u003ccode\u003epageToken\u003c/code\u003e for pagination, and \u003ccode\u003evendorParams\u003c/code\u003e for extra data.\u003c/p\u003e\n"],["\u003cp\u003eThe response contains a list of \u003ccode\u003edevices\u003c/code\u003e, the \u003ccode\u003etotalCount\u003c/code\u003e of matching devices, an optional \u003ccode\u003enextPageToken\u003c/code\u003e for additional pages, and \u003ccode\u003evendorParams\u003c/code\u003e for extra information.\u003c/p\u003e\n"],["\u003cp\u003ePotential errors during the process will result in a \u003ccode\u003eCommonException\u003c/code\u003e being thrown, with possible error codes being \u003ccode\u003eINTERNAL_SERVER_ERROR\u003c/code\u003e or \u003ccode\u003eINVALID_PAGE_TOKEN\u003c/code\u003e.\u003c/p\u003e\n"]]],["The `findDevicesByDeviceIdentifier` method retrieves a list of devices based on a provided device identifier. The request requires a `deviceIdentifier`, and optionally accepts `pageSize` (up to 100), `pageToken`, and `vendorParams`. The response includes a list of `devices`, `totalCount`, `nextPageToken`, and optional `vendorParams`. Errors result in a `CommonException`, with codes like `INTERNAL_SERVER_ERROR` or `INVALID_PAGE_TOKEN`.\n"],null,["Lists devices with given device identifier.\n\nMethod signature \n\n public FindDevicesResponse findDevicesByDeviceIdentifier(FindDevicesByDeviceIdentifierRequest request) throws CommonException;\n\nFindDevicesByDeviceIdentifierRequest\n\n| Property name | Value | Required | Description |\n|--------------------|---------------------------------------------------------------------------------------------------|----------|-----------------------------------------------------------------------------------------|\n| `deviceIdentifier` | `object(`[`DeviceIdentifier`](/zero-touch/reseller-library/reference/objects#deviceidentifier)`)` | Yes | Device identifier of the devices to be retrieve. The object can be partially populated. |\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\nFindDevicesResponse\n\n| Property name | Value | Description |\n|-----------------|-------------------------------------------------------------------------------|---------------------------------------------------------------------------|\n| `devices` | `object(`[`Device`](/zero-touch/reseller-library/reference/objects#device)`)` | The list of devices uploaded by the reseller. Empty if there is no match. |\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` | Optional. 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` |"]]