DeviceReference
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
DeviceReference
是一種 API 抽象化機制,可讓您透過下列其中一種 ID 類型,為方法提供 device 引數:
- 數值 API 資源 ID。
- 製造裝置的實際硬體 ID,例如 IMEI 號碼。
在裝置上運作的方法會採用 DeviceReference
做為參數類型,因為對呼叫端而言,這個類型更具彈性。如要進一步瞭解裝置 ID,請參閱「ID」。
JSON 表示法 |
{
// Union field device can be only one of the following:
"deviceId": string,
"deviceIdentifier": {
object (DeviceIdentifier )
}
// End of list of possible types for union field device .
} |
欄位 |
聯集欄位 device 。必要欄位。裝置的專屬 ID。device 只能是下列其中一項: |
deviceId |
string (int64 format)
裝置的 ID。
|
deviceIdentifier |
object (DeviceIdentifier )
裝置的硬體 ID。
|
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2025-07-25 (世界標準時間)。
[null,null,["上次更新時間:2025-07-25 (世界標準時間)。"],[[["\u003cp\u003e\u003ccode\u003eDeviceReference\u003c/code\u003e allows methods to accept a device argument using either a numeric API resource ID or real-world hardware IDs.\u003c/p\u003e\n"],["\u003cp\u003eMethods use \u003ccode\u003eDeviceReference\u003c/code\u003e as a parameter for flexibility in identifying devices.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003edevice\u003c/code\u003e field in the JSON representation is a union field, accepting either a \u003ccode\u003edeviceId\u003c/code\u003e or \u003ccode\u003edeviceIdentifier\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003edeviceId\u003c/code\u003e is a string that represents the unique ID of the device, and \u003ccode\u003edeviceIdentifier\u003c/code\u003e refers to an object containing the hardware IDs.\u003c/p\u003e\n"]]],["A `DeviceReference` is used as a device argument in methods, accepting either a numeric API resource ID (`deviceId`) or real-world hardware IDs (`deviceIdentifier`) like IMEI. The JSON representation uses a union field named `device` that contains either a `deviceId` string (int64 format) or a `deviceIdentifier` object, which holds the device's hardware IDs. Methods use this type for increased flexibility in identifying devices.\n"],null,["# DeviceReference\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n\nA `DeviceReference` is an API abstraction that lets you supply a *device* argument to a method using one of the following identifier types:\n\n- A numeric API resource ID.\n- Real-world hardware IDs, such as IMEI number, belonging to the manufactured device.\n\nMethods that operate on devices take a `DeviceReference` as a parameter type because it's more flexible for the caller. To learn more about device identifiers, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).\n\n| JSON representation ||\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { // Union field `device` can be only one of the following: \"deviceId\": string, \"deviceIdentifier\": { object (/zero-touch/reference/customer/rest/v1/customers.devices#DeviceIdentifier) } // End of list of possible types for union field `device`. } ``` |\n\n| Fields ||\n|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------|---|\n| Union field `device`. Required. The unique identifier for the device. `device` can be only one of the following: |||\n| `deviceId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The ID of the device. |\n| `deviceIdentifier` | `object (`[DeviceIdentifier](/zero-touch/reference/customer/rest/v1/customers.devices#DeviceIdentifier)`)` The hardware IDs of the device. |"]]