ADeviceReferenceis an API abstraction that lets you supply adeviceargument to a method using one of the following identifier types:
A numeric API resource ID.
Real-world hardware IDs, such as IMEI number, belonging to the manufactured device.
Methods that operate on devices take aDeviceReferenceas a parameter type because it's more flexible for the caller. To learn more about device identifiers, readIdentifiers.
JSON representation
{// Union fielddevicecan be only one of the following:"deviceId":string,"deviceIdentifier":{object (DeviceIdentifier)}// End of list of possible types for union fielddevice.}
Fields
Union fielddevice. Required. The unique identifier for the device.devicecan be only one of the following:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-08-07 UTC."],[[["\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. |"]]
