1<html><body> 2<style> 3 4body, 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 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, 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.customers.html">customers</a> . <a href="androiddeviceprovisioning_v1.customers.devices.html">devices</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#applyConfiguration">applyConfiguration(parent, body=None, x__xgafv=None)</a></code></p> 79<p class="firstline">Applies a Configuration to the device to register the device for zero-touch enrollment. After applying a configuration to a device, the device automatically provisions itself on first boot, or next factory reset.</p> 80<p class="toc_element"> 81 <code><a href="#close">close()</a></code></p> 82<p class="firstline">Close httplib2 connections.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Gets the details of a device.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Lists a customer's devices.</p> 89<p class="toc_element"> 90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 91<p class="firstline">Retrieves the next page of results.</p> 92<p class="toc_element"> 93 <code><a href="#removeConfiguration">removeConfiguration(parent, body=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Removes a configuration from device.</p> 95<p class="toc_element"> 96 <code><a href="#unclaim">unclaim(parent, body=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Unclaims a device from a customer and removes it from zero-touch enrollment. After removing a device, a customer must contact their reseller to register the device into zero-touch enrollment again.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="applyConfiguration">applyConfiguration(parent, body=None, x__xgafv=None)</code> 101 <pre>Applies a Configuration to the device to register the device for zero-touch enrollment. After applying a configuration to a device, the device automatically provisions itself on first boot, or next factory reset. 102 103Args: 104 parent: string, Required. The customer managing the device. An API resource name in the format `customers/[CUSTOMER_ID]`. (required) 105 body: object, The request body. 106 The object takes the form of: 107 108{ # Request message for customer to assign a configuration to device. 109 "configuration": "A String", # Required. The configuration applied to the device in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. 110 "device": { # A `DeviceReference` is an API abstraction that lets you supply a _device_ argument 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 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). # Required. The device the configuration is applied to. 111 "deviceId": "A String", # The ID of the device. 112 "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # The hardware IDs of the device. 113 "imei": "A String", # The device’s IMEI number. Validated on input. 114 "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names). 115 "meid": "A String", # The device’s MEID number. 116 "model": "A String", # The device model's name. Matches the device's built-in value returned from `android.os.Build.MODEL`. Allowed values are listed in [models](/zero-touch/resources/manufacturer-names#model-names). 117 "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be unique across different device models. 118 }, 119 }, 120} 121 122 x__xgafv: string, V1 error format. 123 Allowed values 124 1 - v1 error format 125 2 - v2 error format 126 127Returns: 128 An object of the form: 129 130 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 131}</pre> 132</div> 133 134<div class="method"> 135 <code class="details" id="close">close()</code> 136 <pre>Close httplib2 connections.</pre> 137</div> 138 139<div class="method"> 140 <code class="details" id="get">get(name, x__xgafv=None)</code> 141 <pre>Gets the details of a device. 142 143Args: 144 name: string, Required. The device to get. An API resource name in the format `customers/[CUSTOMER_ID]/devices/[DEVICE_ID]`. (required) 145 x__xgafv: string, V1 error format. 146 Allowed values 147 1 - v1 error format 148 2 - v2 error format 149 150Returns: 151 An object of the form: 152 153 { # An Android device registered for zero-touch enrollment. 154 "claims": [ # Output only. The provisioning claims for a device. Devices claimed for zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. Call `partners.devices.unclaim` or `partners.devices.unclaimAsync` to remove the device from zero-touch enrollment. 155 { # A record of a device claimed by a reseller for a customer. Devices claimed for zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. To learn more, read [Claim devices for customers](/zero-touch/guides/how-it-works#claim). 156 "additionalService": "A String", # The Additional service registered for the device. 157 "ownerCompanyId": "A String", # The ID of the Customer that purchased the device. 158 "resellerId": "A String", # The ID of the reseller that claimed the device. 159 "sectionType": "A String", # Output only. The type of claim made on the device. 160 "vacationModeExpireTime": "A String", # The timestamp when the device will exit ‘vacation mode’. This value is present iff the device is in 'vacation mode'. 161 "vacationModeStartTime": "A String", # The timestamp when the device was put into ‘vacation mode’. This value is present iff the device is in 'vacation mode'. 162 }, 163 ], 164 "configuration": "A String", # Not available to resellers. 165 "deviceId": "A String", # Output only. The ID of the device. Assigned by the server. 166 "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # The hardware IDs that identify a manufactured device. To learn more, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). 167 "imei": "A String", # The device’s IMEI number. Validated on input. 168 "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names). 169 "meid": "A String", # The device’s MEID number. 170 "model": "A String", # The device model's name. Matches the device's built-in value returned from `android.os.Build.MODEL`. Allowed values are listed in [models](/zero-touch/resources/manufacturer-names#model-names). 171 "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be unique across different device models. 172 }, 173 "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read [Device metadata](https://developers.google.com/zero-touch/guides/metadata). # The metadata attached to the device. Structured as key-value pairs. To learn more, read [Device metadata](https://developers.google.com/zero-touch/guides/metadata). 174 "entries": { # Metadata entries recorded as key-value pairs. 175 "a_key": "A String", 176 }, 177 }, 178 "name": "A String", # Output only. The API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server. 179}</pre> 180</div> 181 182<div class="method"> 183 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 184 <pre>Lists a customer's devices. 185 186Args: 187 parent: string, Required. The customer managing the devices. An API resource name in the format `customers/[CUSTOMER_ID]`. (required) 188 pageSize: string, The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive. 189 pageToken: string, A token specifying which result page to return. 190 x__xgafv: string, V1 error format. 191 Allowed values 192 1 - v1 error format 193 2 - v2 error format 194 195Returns: 196 An object of the form: 197 198 { # Response message of customer's liting devices. 199 "devices": [ # The customer's devices. 200 { # An Android device registered for zero-touch enrollment. 201 "claims": [ # Output only. The provisioning claims for a device. Devices claimed for zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. Call `partners.devices.unclaim` or `partners.devices.unclaimAsync` to remove the device from zero-touch enrollment. 202 { # A record of a device claimed by a reseller for a customer. Devices claimed for zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. To learn more, read [Claim devices for customers](/zero-touch/guides/how-it-works#claim). 203 "additionalService": "A String", # The Additional service registered for the device. 204 "ownerCompanyId": "A String", # The ID of the Customer that purchased the device. 205 "resellerId": "A String", # The ID of the reseller that claimed the device. 206 "sectionType": "A String", # Output only. The type of claim made on the device. 207 "vacationModeExpireTime": "A String", # The timestamp when the device will exit ‘vacation mode’. This value is present iff the device is in 'vacation mode'. 208 "vacationModeStartTime": "A String", # The timestamp when the device was put into ‘vacation mode’. This value is present iff the device is in 'vacation mode'. 209 }, 210 ], 211 "configuration": "A String", # Not available to resellers. 212 "deviceId": "A String", # Output only. The ID of the device. Assigned by the server. 213 "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # The hardware IDs that identify a manufactured device. To learn more, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). 214 "imei": "A String", # The device’s IMEI number. Validated on input. 215 "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names). 216 "meid": "A String", # The device’s MEID number. 217 "model": "A String", # The device model's name. Matches the device's built-in value returned from `android.os.Build.MODEL`. Allowed values are listed in [models](/zero-touch/resources/manufacturer-names#model-names). 218 "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be unique across different device models. 219 }, 220 "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read [Device metadata](https://developers.google.com/zero-touch/guides/metadata). # The metadata attached to the device. Structured as key-value pairs. To learn more, read [Device metadata](https://developers.google.com/zero-touch/guides/metadata). 221 "entries": { # Metadata entries recorded as key-value pairs. 222 "a_key": "A String", 223 }, 224 }, 225 "name": "A String", # Output only. The API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server. 226 }, 227 ], 228 "nextPageToken": "A String", # A token used to access the next page of results. Omitted if no further results are available. 229}</pre> 230</div> 231 232<div class="method"> 233 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 234 <pre>Retrieves the next page of results. 235 236Args: 237 previous_request: The request for the previous page. (required) 238 previous_response: The response from the request for the previous page. (required) 239 240Returns: 241 A request object that you can call 'execute()' on to request the next 242 page. Returns None if there are no more items in the collection. 243 </pre> 244</div> 245 246<div class="method"> 247 <code class="details" id="removeConfiguration">removeConfiguration(parent, body=None, x__xgafv=None)</code> 248 <pre>Removes a configuration from device. 249 250Args: 251 parent: string, Required. The customer managing the device in the format `customers/[CUSTOMER_ID]`. (required) 252 body: object, The request body. 253 The object takes the form of: 254 255{ # Request message for customer to remove the configuration from device. 256 "device": { # A `DeviceReference` is an API abstraction that lets you supply a _device_ argument 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 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). # Required. The device to remove the configuration from. 257 "deviceId": "A String", # The ID of the device. 258 "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # The hardware IDs of the device. 259 "imei": "A String", # The device’s IMEI number. Validated on input. 260 "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names). 261 "meid": "A String", # The device’s MEID number. 262 "model": "A String", # The device model's name. Matches the device's built-in value returned from `android.os.Build.MODEL`. Allowed values are listed in [models](/zero-touch/resources/manufacturer-names#model-names). 263 "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be unique across different device models. 264 }, 265 }, 266} 267 268 x__xgafv: string, V1 error format. 269 Allowed values 270 1 - v1 error format 271 2 - v2 error format 272 273Returns: 274 An object of the form: 275 276 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 277}</pre> 278</div> 279 280<div class="method"> 281 <code class="details" id="unclaim">unclaim(parent, body=None, x__xgafv=None)</code> 282 <pre>Unclaims a device from a customer and removes it from zero-touch enrollment. After removing a device, a customer must contact their reseller to register the device into zero-touch enrollment again. 283 284Args: 285 parent: string, Required. The customer managing the device. An API resource name in the format `customers/[CUSTOMER_ID]`. (required) 286 body: object, The request body. 287 The object takes the form of: 288 289{ # Request message for customer to unclaim a device. 290 "device": { # A `DeviceReference` is an API abstraction that lets you supply a _device_ argument 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 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). # Required. The device to unclaim. 291 "deviceId": "A String", # The ID of the device. 292 "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # The hardware IDs of the device. 293 "imei": "A String", # The device’s IMEI number. Validated on input. 294 "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names). 295 "meid": "A String", # The device’s MEID number. 296 "model": "A String", # The device model's name. Matches the device's built-in value returned from `android.os.Build.MODEL`. Allowed values are listed in [models](/zero-touch/resources/manufacturer-names#model-names). 297 "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be unique across different device models. 298 }, 299 }, 300} 301 302 x__xgafv: string, V1 error format. 303 Allowed values 304 1 - v1 error format 305 2 - v2 error format 306 307Returns: 308 An object of the form: 309 310 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 311}</pre> 312</div> 313 314</body></html>