| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="androiddeviceprovisioning_v1.html">Android Device Provisioning Partner API</a> . <a href="androiddeviceprovisioning_v1.partners.html">partners</a> . <a href="androiddeviceprovisioning_v1.partners.devices.html">devices</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 78 | <code><a href="#claim">claim(partnerId, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 79 | <p class="firstline">Claims a device for a customer and adds it to zero-touch enrollment. If the</p> |
| 80 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 81 | <code><a href="#claimAsync">claimAsync(partnerId, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 82 | <p class="firstline">Claims a batch of devices for a customer asynchronously. Adds the devices</p> |
| 83 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 84 | <code><a href="#findByIdentifier">findByIdentifier(partnerId, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 85 | <p class="firstline">Finds devices by hardware identifiers, such as IMEI.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#findByIdentifier_next">findByIdentifier_next(previous_request, previous_response)</a></code></p> |
| 88 | <p class="firstline">Retrieves the next page of results.</p> |
| 89 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 90 | <code><a href="#findByOwner">findByOwner(partnerId, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 91 | <p class="firstline">Finds devices claimed for customers. The results only contain devices</p> |
| 92 | <p class="toc_element"> |
| 93 | <code><a href="#findByOwner_next">findByOwner_next(previous_request, previous_response)</a></code></p> |
| 94 | <p class="firstline">Retrieves the next page of results.</p> |
| 95 | <p class="toc_element"> |
| 96 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 97 | <p class="firstline">Gets a device.</p> |
| 98 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 99 | <code><a href="#metadata">metadata(metadataOwnerId, deviceId, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 100 | <p class="firstline">Updates reseller metadata associated with the device.</p> |
| 101 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 102 | <code><a href="#unclaim">unclaim(partnerId, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 103 | <p class="firstline">Unclaims a device from a customer and removes it from zero-touch</p> |
| 104 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 105 | <code><a href="#unclaimAsync">unclaimAsync(partnerId, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 106 | <p class="firstline">Unclaims a batch of devices for a customer asynchronously. Removes the</p> |
| 107 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 108 | <code><a href="#updateMetadataAsync">updateMetadataAsync(partnerId, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 109 | <p class="firstline">Updates the reseller metadata attached to a batch of devices. This method</p> |
| 110 | <h3>Method Details</h3> |
| 111 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 112 | <code class="details" id="claim">claim(partnerId, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 113 | <pre>Claims a device for a customer and adds it to zero-touch enrollment. If the |
| 114 | device is already claimed by another customer, the call returns an error. |
| 115 | |
| 116 | Args: |
| 117 | partnerId: string, Required. The ID of the reseller partner. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 118 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 119 | The object takes the form of: |
| 120 | |
| 121 | { # Request message to claim a device on behalf of a customer. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 122 | "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # Required. The device identifier of the device to claim. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 123 | # To understand requirements on identifier sets, read |
| 124 | # [Identifiers](/zero-touch/guides/identifiers). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 125 | "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 126 | # value returned from `android.os.Build.MANUFACTURER`. Allowed values are |
| 127 | # listed in |
| 128 | # [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 129 | "imei": "A String", # The device’s IMEI number. Validated on input. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 130 | "meid": "A String", # The device’s MEID number. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 131 | "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be |
| 132 | # unique across different device models. |
| 133 | "model": "A String", # The device model's name. Matches the device's built-in value returned from |
| 134 | # `android.os.Build.MODEL`. Allowed values are listed in |
| 135 | # [models](/zero-touch/resources/manufacturer-names#model-names). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 136 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 137 | "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read # Optional. The metadata to attach to the device. |
| 138 | # [Device metadata](/zero-touch/guides/metadata). |
| 139 | "entries": { # Metadata entries recorded as key-value pairs. |
| 140 | "a_key": "A String", |
| 141 | }, |
| 142 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 143 | "sectionType": "A String", # Required. The section type of the device's provisioning record. |
| 144 | "customerId": "A String", # Required. The ID of the customer for whom the device is being claimed. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 145 | } |
| 146 | |
| 147 | x__xgafv: string, V1 error format. |
| 148 | Allowed values |
| 149 | 1 - v1 error format |
| 150 | 2 - v2 error format |
| 151 | |
| 152 | Returns: |
| 153 | An object of the form: |
| 154 | |
| 155 | { # Response message containing device id of the claim. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 156 | "deviceId": "A String", # The device ID of the claimed device. |
| 157 | "deviceName": "A String", # The resource name of the device in the format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 158 | # `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 159 | }</pre> |
| 160 | </div> |
| 161 | |
| 162 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 163 | <code class="details" id="claimAsync">claimAsync(partnerId, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 164 | <pre>Claims a batch of devices for a customer asynchronously. Adds the devices |
| 165 | to zero-touch enrollment. To learn more, read [Long‑running batch |
| 166 | operations](/zero-touch/guides/how-it-works#operations). |
| 167 | |
| 168 | Args: |
| 169 | partnerId: string, Required. The ID of the reseller partner. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 170 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 171 | The object takes the form of: |
| 172 | |
| 173 | { # Request to claim devices asynchronously in batch. Claiming a device adds the |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 174 | # device to zero-touch enrollment and shows the device in the customer's view |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 175 | # of the portal. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 176 | "claims": [ # Required. A list of device claims. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 177 | { # Identifies one claim request. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 178 | "customerId": "A String", # Required. The ID of the customer for whom the device is being claimed. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 179 | "sectionType": "A String", # Required. The section type of the device's provisioning record. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 180 | "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # Required. Device identifier of the device. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 181 | # To understand requirements on identifier sets, read |
| 182 | # [Identifiers](/zero-touch/guides/identifiers). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 183 | "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 184 | # value returned from `android.os.Build.MANUFACTURER`. Allowed values are |
| 185 | # listed in |
| 186 | # [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 187 | "imei": "A String", # The device’s IMEI number. Validated on input. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 188 | "meid": "A String", # The device’s MEID number. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 189 | "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be |
| 190 | # unique across different device models. |
| 191 | "model": "A String", # The device model's name. Matches the device's built-in value returned from |
| 192 | # `android.os.Build.MODEL`. Allowed values are listed in |
| 193 | # [models](/zero-touch/resources/manufacturer-names#model-names). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 194 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 195 | "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read # Required. The metadata to attach to the device at claim. |
| 196 | # [Device metadata](/zero-touch/guides/metadata). |
| 197 | "entries": { # Metadata entries recorded as key-value pairs. |
| 198 | "a_key": "A String", |
| 199 | }, |
| 200 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 201 | }, |
| 202 | ], |
| 203 | } |
| 204 | |
| 205 | x__xgafv: string, V1 error format. |
| 206 | Allowed values |
| 207 | 1 - v1 error format |
| 208 | 2 - v2 error format |
| 209 | |
| 210 | Returns: |
| 211 | An object of the form: |
| 212 | |
| 213 | { # This resource represents a long-running operation that is the result of a |
| 214 | # network API call. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 215 | "metadata": { # This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. |
| 216 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 217 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 218 | "error": { # The `Status` type defines a logical error model that is suitable for # This field will always be not set if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. In this case, error information for each device is set in `response.perDeviceStatus.result.status`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 219 | # different programming environments, including REST APIs and RPC APIs. It is |
| 220 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 221 | # three pieces of data: error code, error message, and error details. |
| 222 | # |
| 223 | # You can find out more about this error model and how to work with it in the |
| 224 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 225 | "details": [ # A list of messages that carry the error details. There is a common set of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 226 | # message types for APIs to use. |
| 227 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 228 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 229 | }, |
| 230 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 231 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 232 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 233 | # user-facing error message should be localized and sent in the |
| 234 | # google.rpc.Status.details field, or localized by the client. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 235 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 236 | "response": { # This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 237 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 238 | }, |
| 239 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 240 | # If `true`, the operation is completed, and either `error` or `response` is |
| 241 | # available. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 242 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 243 | # originally returns it. If you use the default HTTP mapping, the |
| 244 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 245 | }</pre> |
| 246 | </div> |
| 247 | |
| 248 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 249 | <code class="details" id="findByIdentifier">findByIdentifier(partnerId, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 250 | <pre>Finds devices by hardware identifiers, such as IMEI. |
| 251 | |
| 252 | Args: |
| 253 | partnerId: string, Required. The ID of the reseller partner. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 254 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 255 | The object takes the form of: |
| 256 | |
| 257 | { # Request to find devices. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 258 | "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # Required. The device identifier to search for. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 259 | # To understand requirements on identifier sets, read |
| 260 | # [Identifiers](/zero-touch/guides/identifiers). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 261 | "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 262 | # value returned from `android.os.Build.MANUFACTURER`. Allowed values are |
| 263 | # listed in |
| 264 | # [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 265 | "imei": "A String", # The device’s IMEI number. Validated on input. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 266 | "meid": "A String", # The device’s MEID number. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 267 | "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be |
| 268 | # unique across different device models. |
| 269 | "model": "A String", # The device model's name. Matches the device's built-in value returned from |
| 270 | # `android.os.Build.MODEL`. Allowed values are listed in |
| 271 | # [models](/zero-touch/resources/manufacturer-names#model-names). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 272 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 273 | "limit": "A String", # Required. The maximum number of devices to show in a page of results. Must |
| 274 | # be between 1 and 100 inclusive. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 275 | "pageToken": "A String", # A token specifying which result page to return. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 276 | } |
| 277 | |
| 278 | x__xgafv: string, V1 error format. |
| 279 | Allowed values |
| 280 | 1 - v1 error format |
| 281 | 2 - v2 error format |
| 282 | |
| 283 | Returns: |
| 284 | An object of the form: |
| 285 | |
| 286 | { # Response containing found devices. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 287 | "nextPageToken": "A String", # A token used to access the next page of results. Omitted if no further |
| 288 | # results are available. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 289 | "devices": [ # Found devices. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 290 | { # An Android device registered for zero-touch enrollment. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 291 | "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # The hardware IDs that identify a manufactured device. To learn more, read |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 292 | # [Identifiers](/zero-touch/guides/identifiers). |
| 293 | # To understand requirements on identifier sets, read |
| 294 | # [Identifiers](/zero-touch/guides/identifiers). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 295 | "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 296 | # value returned from `android.os.Build.MANUFACTURER`. Allowed values are |
| 297 | # listed in |
| 298 | # [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 299 | "imei": "A String", # The device’s IMEI number. Validated on input. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 300 | "meid": "A String", # The device’s MEID number. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 301 | "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be |
| 302 | # unique across different device models. |
| 303 | "model": "A String", # The device model's name. Matches the device's built-in value returned from |
| 304 | # `android.os.Build.MODEL`. Allowed values are listed in |
| 305 | # [models](/zero-touch/resources/manufacturer-names#model-names). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 306 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 307 | "name": "A String", # Output only. The API resource name in the format |
| 308 | # `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server. |
| 309 | "configuration": "A String", # Not available to resellers. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 310 | "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read # The metadata attached to the device. Structured as key-value pairs. To |
| 311 | # learn more, read [Device metadata](/zero-touch/guides/metadata). |
| 312 | # [Device metadata](/zero-touch/guides/metadata). |
| 313 | "entries": { # Metadata entries recorded as key-value pairs. |
| 314 | "a_key": "A String", |
| 315 | }, |
| 316 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 317 | "deviceId": "A String", # Output only. The ID of the device. Assigned by the server. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 318 | "claims": [ # Output only. The provisioning claims for a device. Devices claimed for |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 319 | # zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. |
| 320 | # Call |
| 321 | # `partners.devices.unclaim` |
| 322 | # or |
| 323 | # `partners.devices.unclaimAsync` |
| 324 | # to remove the device from zero-touch enrollment. |
| 325 | { # A record of a device claimed by a reseller for a customer. Devices claimed |
| 326 | # for zero-touch enrollment have a claim with the type |
| 327 | # `SECTION_TYPE_ZERO_TOUCH`. To learn more, read |
| 328 | # [Claim devices for customers](/zero-touch/guides/how-it-works#claim). |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 329 | "vacationModeExpireTime": "A String", # The timestamp when the device will exit ‘vacation mode’. This value is |
| 330 | # present iff the device is in 'vacation mode'. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 331 | "resellerId": "A String", # The ID of the reseller that claimed the device. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 332 | "ownerCompanyId": "A String", # The ID of the Customer that purchased the device. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 333 | "sectionType": "A String", # Output only. The type of claim made on the device. |
| 334 | "vacationModeStartTime": "A String", # The timestamp when the device was put into ‘vacation mode’. This value is |
| 335 | # present iff the device is in 'vacation mode'. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 336 | }, |
| 337 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 338 | }, |
| 339 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 340 | "totalSize": 42, # The total count of items in the list irrespective of pagination. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 341 | }</pre> |
| 342 | </div> |
| 343 | |
| 344 | <div class="method"> |
| 345 | <code class="details" id="findByIdentifier_next">findByIdentifier_next(previous_request, previous_response)</code> |
| 346 | <pre>Retrieves the next page of results. |
| 347 | |
| 348 | Args: |
| 349 | previous_request: The request for the previous page. (required) |
| 350 | previous_response: The response from the request for the previous page. (required) |
| 351 | |
| 352 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 353 | A request object that you can call 'execute()' on to request the next |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 354 | page. Returns None if there are no more items in the collection. |
| 355 | </pre> |
| 356 | </div> |
| 357 | |
| 358 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 359 | <code class="details" id="findByOwner">findByOwner(partnerId, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 360 | <pre>Finds devices claimed for customers. The results only contain devices |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 361 | registered to the reseller that's identified by the `partnerId` argument. |
| 362 | The customer's devices purchased from other resellers don't appear in the |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 363 | results. |
| 364 | |
| 365 | Args: |
| 366 | partnerId: string, Required. The ID of the reseller partner. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 367 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 368 | The object takes the form of: |
| 369 | |
| 370 | { # Request to find devices by customers. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 371 | "pageToken": "A String", # A token specifying which result page to return. |
| 372 | "sectionType": "A String", # Required. The section type of the device's provisioning record. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 373 | "customerId": [ # Required. The list of customer IDs to search for. |
| 374 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 375 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 376 | "limit": "A String", # Required. The maximum number of devices to show in a page of results. Must |
| 377 | # be between 1 and 100 inclusive. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 378 | } |
| 379 | |
| 380 | x__xgafv: string, V1 error format. |
| 381 | Allowed values |
| 382 | 1 - v1 error format |
| 383 | 2 - v2 error format |
| 384 | |
| 385 | Returns: |
| 386 | An object of the form: |
| 387 | |
| 388 | { # Response containing found devices. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 389 | "devices": [ # The customer's devices. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 390 | { # An Android device registered for zero-touch enrollment. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 391 | "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # The hardware IDs that identify a manufactured device. To learn more, read |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 392 | # [Identifiers](/zero-touch/guides/identifiers). |
| 393 | # To understand requirements on identifier sets, read |
| 394 | # [Identifiers](/zero-touch/guides/identifiers). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 395 | "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 396 | # value returned from `android.os.Build.MANUFACTURER`. Allowed values are |
| 397 | # listed in |
| 398 | # [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 399 | "imei": "A String", # The device’s IMEI number. Validated on input. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 400 | "meid": "A String", # The device’s MEID number. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 401 | "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be |
| 402 | # unique across different device models. |
| 403 | "model": "A String", # The device model's name. Matches the device's built-in value returned from |
| 404 | # `android.os.Build.MODEL`. Allowed values are listed in |
| 405 | # [models](/zero-touch/resources/manufacturer-names#model-names). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 406 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 407 | "name": "A String", # Output only. The API resource name in the format |
| 408 | # `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server. |
| 409 | "configuration": "A String", # Not available to resellers. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 410 | "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read # The metadata attached to the device. Structured as key-value pairs. To |
| 411 | # learn more, read [Device metadata](/zero-touch/guides/metadata). |
| 412 | # [Device metadata](/zero-touch/guides/metadata). |
| 413 | "entries": { # Metadata entries recorded as key-value pairs. |
| 414 | "a_key": "A String", |
| 415 | }, |
| 416 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 417 | "deviceId": "A String", # Output only. The ID of the device. Assigned by the server. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 418 | "claims": [ # Output only. The provisioning claims for a device. Devices claimed for |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 419 | # zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. |
| 420 | # Call |
| 421 | # `partners.devices.unclaim` |
| 422 | # or |
| 423 | # `partners.devices.unclaimAsync` |
| 424 | # to remove the device from zero-touch enrollment. |
| 425 | { # A record of a device claimed by a reseller for a customer. Devices claimed |
| 426 | # for zero-touch enrollment have a claim with the type |
| 427 | # `SECTION_TYPE_ZERO_TOUCH`. To learn more, read |
| 428 | # [Claim devices for customers](/zero-touch/guides/how-it-works#claim). |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 429 | "vacationModeExpireTime": "A String", # The timestamp when the device will exit ‘vacation mode’. This value is |
| 430 | # present iff the device is in 'vacation mode'. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 431 | "resellerId": "A String", # The ID of the reseller that claimed the device. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 432 | "ownerCompanyId": "A String", # The ID of the Customer that purchased the device. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 433 | "sectionType": "A String", # Output only. The type of claim made on the device. |
| 434 | "vacationModeStartTime": "A String", # The timestamp when the device was put into ‘vacation mode’. This value is |
| 435 | # present iff the device is in 'vacation mode'. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 436 | }, |
| 437 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 438 | }, |
| 439 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 440 | "nextPageToken": "A String", # A token used to access the next page of results. |
| 441 | # Omitted if no further results are available. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 442 | "totalSize": 42, # The total count of items in the list irrespective of pagination. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 443 | }</pre> |
| 444 | </div> |
| 445 | |
| 446 | <div class="method"> |
| 447 | <code class="details" id="findByOwner_next">findByOwner_next(previous_request, previous_response)</code> |
| 448 | <pre>Retrieves the next page of results. |
| 449 | |
| 450 | Args: |
| 451 | previous_request: The request for the previous page. (required) |
| 452 | previous_response: The response from the request for the previous page. (required) |
| 453 | |
| 454 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 455 | A request object that you can call 'execute()' on to request the next |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 456 | page. Returns None if there are no more items in the collection. |
| 457 | </pre> |
| 458 | </div> |
| 459 | |
| 460 | <div class="method"> |
| 461 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 462 | <pre>Gets a device. |
| 463 | |
| 464 | Args: |
| 465 | name: string, Required. The device API resource name in the format |
| 466 | `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. (required) |
| 467 | x__xgafv: string, V1 error format. |
| 468 | Allowed values |
| 469 | 1 - v1 error format |
| 470 | 2 - v2 error format |
| 471 | |
| 472 | Returns: |
| 473 | An object of the form: |
| 474 | |
| 475 | { # An Android device registered for zero-touch enrollment. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 476 | "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # The hardware IDs that identify a manufactured device. To learn more, read |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 477 | # [Identifiers](/zero-touch/guides/identifiers). |
| 478 | # To understand requirements on identifier sets, read |
| 479 | # [Identifiers](/zero-touch/guides/identifiers). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 480 | "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 481 | # value returned from `android.os.Build.MANUFACTURER`. Allowed values are |
| 482 | # listed in |
| 483 | # [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 484 | "imei": "A String", # The device’s IMEI number. Validated on input. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 485 | "meid": "A String", # The device’s MEID number. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 486 | "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be |
| 487 | # unique across different device models. |
| 488 | "model": "A String", # The device model's name. Matches the device's built-in value returned from |
| 489 | # `android.os.Build.MODEL`. Allowed values are listed in |
| 490 | # [models](/zero-touch/resources/manufacturer-names#model-names). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 491 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 492 | "name": "A String", # Output only. The API resource name in the format |
| 493 | # `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server. |
| 494 | "configuration": "A String", # Not available to resellers. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 495 | "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read # The metadata attached to the device. Structured as key-value pairs. To |
| 496 | # learn more, read [Device metadata](/zero-touch/guides/metadata). |
| 497 | # [Device metadata](/zero-touch/guides/metadata). |
| 498 | "entries": { # Metadata entries recorded as key-value pairs. |
| 499 | "a_key": "A String", |
| 500 | }, |
| 501 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 502 | "deviceId": "A String", # Output only. The ID of the device. Assigned by the server. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 503 | "claims": [ # Output only. The provisioning claims for a device. Devices claimed for |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 504 | # zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. |
| 505 | # Call |
| 506 | # `partners.devices.unclaim` |
| 507 | # or |
| 508 | # `partners.devices.unclaimAsync` |
| 509 | # to remove the device from zero-touch enrollment. |
| 510 | { # A record of a device claimed by a reseller for a customer. Devices claimed |
| 511 | # for zero-touch enrollment have a claim with the type |
| 512 | # `SECTION_TYPE_ZERO_TOUCH`. To learn more, read |
| 513 | # [Claim devices for customers](/zero-touch/guides/how-it-works#claim). |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 514 | "vacationModeExpireTime": "A String", # The timestamp when the device will exit ‘vacation mode’. This value is |
| 515 | # present iff the device is in 'vacation mode'. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 516 | "resellerId": "A String", # The ID of the reseller that claimed the device. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 517 | "ownerCompanyId": "A String", # The ID of the Customer that purchased the device. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 518 | "sectionType": "A String", # Output only. The type of claim made on the device. |
| 519 | "vacationModeStartTime": "A String", # The timestamp when the device was put into ‘vacation mode’. This value is |
| 520 | # present iff the device is in 'vacation mode'. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 521 | }, |
| 522 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 523 | }</pre> |
| 524 | </div> |
| 525 | |
| 526 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 527 | <code class="details" id="metadata">metadata(metadataOwnerId, deviceId, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 528 | <pre>Updates reseller metadata associated with the device. |
| 529 | |
| 530 | Args: |
| 531 | metadataOwnerId: string, Required. The owner of the newly set metadata. Set this to the partner ID. (required) |
| 532 | deviceId: string, Required. The ID of the device. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 533 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 534 | The object takes the form of: |
| 535 | |
| 536 | { # Request to set metadata for a device. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 537 | "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read # Required. The metadata to attach to the device. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 538 | # [Device metadata](/zero-touch/guides/metadata). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 539 | "entries": { # Metadata entries recorded as key-value pairs. |
| 540 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 541 | }, |
| 542 | }, |
| 543 | } |
| 544 | |
| 545 | x__xgafv: string, V1 error format. |
| 546 | Allowed values |
| 547 | 1 - v1 error format |
| 548 | 2 - v2 error format |
| 549 | |
| 550 | Returns: |
| 551 | An object of the form: |
| 552 | |
| 553 | { # Metadata entries that can be attached to a `Device`. To learn more, read |
| 554 | # [Device metadata](/zero-touch/guides/metadata). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 555 | "entries": { # Metadata entries recorded as key-value pairs. |
| 556 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 557 | }, |
| 558 | }</pre> |
| 559 | </div> |
| 560 | |
| 561 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 562 | <code class="details" id="unclaim">unclaim(partnerId, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 563 | <pre>Unclaims a device from a customer and removes it from zero-touch |
| 564 | enrollment. |
| 565 | |
| 566 | Args: |
| 567 | partnerId: string, Required. The ID of the reseller partner. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 568 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 569 | The object takes the form of: |
| 570 | |
| 571 | { # Request message to unclaim a device. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 572 | "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # The device identifier you used when you claimed this device. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 573 | # To understand requirements on identifier sets, read |
| 574 | # [Identifiers](/zero-touch/guides/identifiers). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 575 | "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 576 | # value returned from `android.os.Build.MANUFACTURER`. Allowed values are |
| 577 | # listed in |
| 578 | # [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 579 | "imei": "A String", # The device’s IMEI number. Validated on input. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 580 | "meid": "A String", # The device’s MEID number. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 581 | "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be |
| 582 | # unique across different device models. |
| 583 | "model": "A String", # The device model's name. Matches the device's built-in value returned from |
| 584 | # `android.os.Build.MODEL`. Allowed values are listed in |
| 585 | # [models](/zero-touch/resources/manufacturer-names#model-names). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 586 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 587 | "vacationModeExpireTime": "A String", # The expiration time of the vacation unlock. |
| 588 | "deviceId": "A String", # The device ID returned by `ClaimDevice`. |
| 589 | "vacationModeDays": 42, # The duration of the vacation unlock starting from when the request is |
| 590 | # processed. (1 day is treated as 24 hours) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 591 | "sectionType": "A String", # Required. The section type of the device's provisioning record. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 592 | } |
| 593 | |
| 594 | x__xgafv: string, V1 error format. |
| 595 | Allowed values |
| 596 | 1 - v1 error format |
| 597 | 2 - v2 error format |
| 598 | |
| 599 | Returns: |
| 600 | An object of the form: |
| 601 | |
| 602 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 603 | # empty messages in your APIs. A typical example is to use it as the request |
| 604 | # or the response type of an API method. For instance: |
| 605 | # |
| 606 | # service Foo { |
| 607 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 608 | # } |
| 609 | # |
| 610 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 611 | }</pre> |
| 612 | </div> |
| 613 | |
| 614 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 615 | <code class="details" id="unclaimAsync">unclaimAsync(partnerId, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 616 | <pre>Unclaims a batch of devices for a customer asynchronously. Removes the |
| 617 | devices from zero-touch enrollment. To learn more, read [Long‑running batch |
| 618 | operations](/zero-touch/guides/how-it-works#operations). |
| 619 | |
| 620 | Args: |
| 621 | partnerId: string, Required. The reseller partner ID. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 622 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 623 | The object takes the form of: |
| 624 | |
| 625 | { # Request to unclaim devices asynchronously in batch. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 626 | "unclaims": [ # Required. The list of devices to unclaim. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 627 | { # Identifies one unclaim request. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 628 | "vacationModeDays": 42, # The duration of the vacation unlock starting from when the request is |
| 629 | # processed. (1 day is treated as 24 hours) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 630 | "deviceId": "A String", # Device ID of the device. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 631 | "vacationModeExpireTime": "A String", # The expiration time of the vacation unlock. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 632 | "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # Device identifier of the device. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 633 | # To understand requirements on identifier sets, read |
| 634 | # [Identifiers](/zero-touch/guides/identifiers). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 635 | "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 636 | # value returned from `android.os.Build.MANUFACTURER`. Allowed values are |
| 637 | # listed in |
| 638 | # [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 639 | "imei": "A String", # The device’s IMEI number. Validated on input. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 640 | "meid": "A String", # The device’s MEID number. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 641 | "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be |
| 642 | # unique across different device models. |
| 643 | "model": "A String", # The device model's name. Matches the device's built-in value returned from |
| 644 | # `android.os.Build.MODEL`. Allowed values are listed in |
| 645 | # [models](/zero-touch/resources/manufacturer-names#model-names). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 646 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 647 | "sectionType": "A String", # Required. The section type of the device's provisioning record. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 648 | }, |
| 649 | ], |
| 650 | } |
| 651 | |
| 652 | x__xgafv: string, V1 error format. |
| 653 | Allowed values |
| 654 | 1 - v1 error format |
| 655 | 2 - v2 error format |
| 656 | |
| 657 | Returns: |
| 658 | An object of the form: |
| 659 | |
| 660 | { # This resource represents a long-running operation that is the result of a |
| 661 | # network API call. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 662 | "metadata": { # This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. |
| 663 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 664 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 665 | "error": { # The `Status` type defines a logical error model that is suitable for # This field will always be not set if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. In this case, error information for each device is set in `response.perDeviceStatus.result.status`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 666 | # different programming environments, including REST APIs and RPC APIs. It is |
| 667 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 668 | # three pieces of data: error code, error message, and error details. |
| 669 | # |
| 670 | # You can find out more about this error model and how to work with it in the |
| 671 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 672 | "details": [ # A list of messages that carry the error details. There is a common set of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 673 | # message types for APIs to use. |
| 674 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 675 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 676 | }, |
| 677 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 678 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 679 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 680 | # user-facing error message should be localized and sent in the |
| 681 | # google.rpc.Status.details field, or localized by the client. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 682 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 683 | "response": { # This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 684 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 685 | }, |
| 686 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 687 | # If `true`, the operation is completed, and either `error` or `response` is |
| 688 | # available. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 689 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 690 | # originally returns it. If you use the default HTTP mapping, the |
| 691 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 692 | }</pre> |
| 693 | </div> |
| 694 | |
| 695 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 696 | <code class="details" id="updateMetadataAsync">updateMetadataAsync(partnerId, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 697 | <pre>Updates the reseller metadata attached to a batch of devices. This method |
| 698 | updates devices asynchronously and returns an `Operation` that can be used |
| 699 | to track progress. Read [Long‑running batch |
| 700 | operations](/zero-touch/guides/how-it-works#operations). |
| 701 | |
| 702 | Args: |
| 703 | partnerId: string, Required. The reseller partner ID. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 704 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 705 | The object takes the form of: |
| 706 | |
| 707 | { # Request to update device metadata in batch. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 708 | "updates": [ # Required. The list of metadata updates. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 709 | { # Identifies metadata updates to one device. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 710 | "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # Device identifier. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 711 | # To understand requirements on identifier sets, read |
| 712 | # [Identifiers](/zero-touch/guides/identifiers). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 713 | "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 714 | # value returned from `android.os.Build.MANUFACTURER`. Allowed values are |
| 715 | # listed in |
| 716 | # [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 717 | "imei": "A String", # The device’s IMEI number. Validated on input. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 718 | "meid": "A String", # The device’s MEID number. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 719 | "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be |
| 720 | # unique across different device models. |
| 721 | "model": "A String", # The device model's name. Matches the device's built-in value returned from |
| 722 | # `android.os.Build.MODEL`. Allowed values are listed in |
| 723 | # [models](/zero-touch/resources/manufacturer-names#model-names). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 724 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 725 | "deviceId": "A String", # Device ID of the device. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 726 | "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read # Required. The metadata to update. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 727 | # [Device metadata](/zero-touch/guides/metadata). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 728 | "entries": { # Metadata entries recorded as key-value pairs. |
| 729 | "a_key": "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 730 | }, |
| 731 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 732 | }, |
| 733 | ], |
| 734 | } |
| 735 | |
| 736 | x__xgafv: string, V1 error format. |
| 737 | Allowed values |
| 738 | 1 - v1 error format |
| 739 | 2 - v2 error format |
| 740 | |
| 741 | Returns: |
| 742 | An object of the form: |
| 743 | |
| 744 | { # This resource represents a long-running operation that is the result of a |
| 745 | # network API call. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 746 | "metadata": { # This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. |
| 747 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 748 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 749 | "error": { # The `Status` type defines a logical error model that is suitable for # This field will always be not set if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. In this case, error information for each device is set in `response.perDeviceStatus.result.status`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 750 | # different programming environments, including REST APIs and RPC APIs. It is |
| 751 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 752 | # three pieces of data: error code, error message, and error details. |
| 753 | # |
| 754 | # You can find out more about this error model and how to work with it in the |
| 755 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 756 | "details": [ # A list of messages that carry the error details. There is a common set of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 757 | # message types for APIs to use. |
| 758 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 759 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 760 | }, |
| 761 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 762 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 763 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 764 | # user-facing error message should be localized and sent in the |
| 765 | # google.rpc.Status.details field, or localized by the client. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 766 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 767 | "response": { # This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 768 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 769 | }, |
| 770 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 771 | # If `true`, the operation is completed, and either `error` or `response` is |
| 772 | # available. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 773 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 774 | # originally returns it. If you use the default HTTP mapping, the |
| 775 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 776 | }</pre> |
| 777 | </div> |
| 778 | |
| 779 | </body></html> |