Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / androiddeviceprovisioning_v1.customers.devices.html
blob: 45cb19131021530bcca045de7c94f76962f7102a [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]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, x__xgafv=None)</a></code></p>
79<p class="firstline">Applies a Configuration to the device to register the device for zero-touch</p>
80<p class="toc_element">
81 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Gets the details of a device.</p>
83<p class="toc_element">
84 <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
85<p class="firstline">Lists a customer's devices.</p>
86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<p class="toc_element">
90 <code><a href="#removeConfiguration">removeConfiguration(parent, body, x__xgafv=None)</a></code></p>
91<p class="firstline">Removes a configuration from device.</p>
92<p class="toc_element">
93 <code><a href="#unclaim">unclaim(parent, body, x__xgafv=None)</a></code></p>
94<p class="firstline">Unclaims a device from a customer and removes it from zero-touch</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="applyConfiguration">applyConfiguration(parent, body, x__xgafv=None)</code>
98 <pre>Applies a Configuration to the device to register the device for zero-touch
99enrollment. After applying a configuration to a device, the device
100automatically provisions itself on first boot, or next factory reset.
101
102Args:
103 parent: string, Required. The customer managing the device. An API resource name in the
104format `customers/[CUSTOMER_ID]`. (required)
105 body: object, The request body. (required)
106 The object takes the form of:
107
108{ # Request message for customer to assign a configuration to device.
109 "device": { # A `DeviceReference` is an API abstraction that lets you supply a _device_ # Required. The device the configuration is applied to.
110 # argument to a method using one of the following identifier types:
111 #
112 # * A numeric API resource ID.
113 # * Real-world hardware IDs, such as IMEI number, belonging to the manufactured
114 # device.
115 #
116 # Methods that operate on devices take a `DeviceReference` as a parameter type
117 # because it's more flexible for the caller. To learn more about device
118 # identifiers, read [Identifiers](/zero-touch/guides/identifiers).
119 "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # The hardware IDs of the device.
120 # To understand requirements on identifier sets, read
121 # [Identifiers](/zero-touch/guides/identifiers).
122 "imei": "A String", # The device’s IMEI number. Validated on input.
123 "model": "A String", # The device model's name. Matches the device's built-in value returned from
124 # `android.os.Build.MODEL`. Allowed values are listed in
125 # [models](/zero-touch/resources/manufacturer-names#model-names).
126 "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
127 # unique across different device models.
128 "meid": "A String", # The device’s MEID number.
129 "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in
130 # value returned from `android.os.Build.MANUFACTURER`. Allowed values are
131 # listed in
132 # [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
133 },
134 "deviceId": "A String", # The ID of the device.
135 },
136 "configuration": "A String", # Required. The configuration applied to the device in the format
137 # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`.
138 }
139
140 x__xgafv: string, V1 error format.
141 Allowed values
142 1 - v1 error format
143 2 - v2 error format
144
145Returns:
146 An object of the form:
147
148 { # A generic empty message that you can re-use to avoid defining duplicated
149 # empty messages in your APIs. A typical example is to use it as the request
150 # or the response type of an API method. For instance:
151 #
152 # service Foo {
153 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
154 # }
155 #
156 # The JSON representation for `Empty` is empty JSON object `{}`.
157 }</pre>
158</div>
159
160<div class="method">
161 <code class="details" id="get">get(name, x__xgafv=None)</code>
162 <pre>Gets the details of a device.
163
164Args:
165 name: string, Required. The device to get. An API resource name in the format
166`customers/[CUSTOMER_ID]/devices/[DEVICE_ID]`. (required)
167 x__xgafv: string, V1 error format.
168 Allowed values
169 1 - v1 error format
170 2 - v2 error format
171
172Returns:
173 An object of the form:
174
175 { # An Android device registered for zero-touch enrollment.
176 "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # The hardware IDs that identify a manufactured device. To learn more, read
177 # [Identifiers](/zero-touch/guides/identifiers).
178 # To understand requirements on identifier sets, read
179 # [Identifiers](/zero-touch/guides/identifiers).
180 "imei": "A String", # The device’s IMEI number. Validated on input.
181 "model": "A String", # The device model's name. Matches the device's built-in value returned from
182 # `android.os.Build.MODEL`. Allowed values are listed in
183 # [models](/zero-touch/resources/manufacturer-names#model-names).
184 "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
185 # unique across different device models.
186 "meid": "A String", # The device’s MEID number.
187 "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in
188 # value returned from `android.os.Build.MANUFACTURER`. Allowed values are
189 # listed in
190 # [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
191 },
192 "name": "A String", # Output only. The API resource name in the format
193 # `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
194 "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
195 # learn more, read [Device metadata](/zero-touch/guides/metadata).
196 # [Device metadata](/zero-touch/guides/metadata).
197 "entries": { # Metadata entries recorded as key-value pairs.
198 "a_key": "A String",
199 },
200 },
201 "deviceId": "A String", # Output only. The ID of the device. Assigned by the server.
202 "claims": [ # Output only. The provisioning claims for a device. Devices claimed for
203 # zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`.
204 # Call
205 # `partners.devices.unclaim`
206 # or
207 # `partners.devices.unclaimAsync`
208 # to remove the device from zero-touch enrollment.
209 { # A record of a device claimed by a reseller for a customer. Devices claimed
210 # for zero-touch enrollment have a claim with the type
211 # `SECTION_TYPE_ZERO_TOUCH`. To learn more, read
212 # [Claim devices for customers](/zero-touch/guides/how-it-works#claim).
213 "vacationModeStartTime": "A String", # The timestamp when the device was put into ‘vacation mode’. This value is
214 # present iff the device is in 'vacation mode'.
215 "resellerId": "A String", # The ID of the reseller that claimed the device.
216 "vacationModeExpireTime": "A String", # The timestamp when the device will exit ‘vacation mode’. This value is
217 # present iff the device is in 'vacation mode'.
218 "sectionType": "A String", # Output only. The type of claim made on the device.
219 "ownerCompanyId": "A String", # The ID of the Customer that purchased the device.
220 },
221 ],
222 "configuration": "A String", # Not available to resellers.
223 }</pre>
224</div>
225
226<div class="method">
227 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
228 <pre>Lists a customer's devices.
229
230Args:
231 parent: string, Required. The customer managing the devices. An API resource name in the
232format `customers/[CUSTOMER_ID]`. (required)
233 pageToken: string, A token specifying which result page to return.
234 x__xgafv: string, V1 error format.
235 Allowed values
236 1 - v1 error format
237 2 - v2 error format
238 pageSize: string, The maximum number of devices to show in a page of results.
239Must be between 1 and 100 inclusive.
240
241Returns:
242 An object of the form:
243
244 { # Response message of customer's liting devices.
245 "nextPageToken": "A String", # A token used to access the next page of results. Omitted if no further
246 # results are available.
247 "devices": [ # The customer's devices.
248 { # An Android device registered for zero-touch enrollment.
249 "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # The hardware IDs that identify a manufactured device. To learn more, read
250 # [Identifiers](/zero-touch/guides/identifiers).
251 # To understand requirements on identifier sets, read
252 # [Identifiers](/zero-touch/guides/identifiers).
253 "imei": "A String", # The device’s IMEI number. Validated on input.
254 "model": "A String", # The device model's name. Matches the device's built-in value returned from
255 # `android.os.Build.MODEL`. Allowed values are listed in
256 # [models](/zero-touch/resources/manufacturer-names#model-names).
257 "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
258 # unique across different device models.
259 "meid": "A String", # The device’s MEID number.
260 "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in
261 # value returned from `android.os.Build.MANUFACTURER`. Allowed values are
262 # listed in
263 # [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
264 },
265 "name": "A String", # Output only. The API resource name in the format
266 # `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
267 "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
268 # learn more, read [Device metadata](/zero-touch/guides/metadata).
269 # [Device metadata](/zero-touch/guides/metadata).
270 "entries": { # Metadata entries recorded as key-value pairs.
271 "a_key": "A String",
272 },
273 },
274 "deviceId": "A String", # Output only. The ID of the device. Assigned by the server.
275 "claims": [ # Output only. The provisioning claims for a device. Devices claimed for
276 # zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`.
277 # Call
278 # `partners.devices.unclaim`
279 # or
280 # `partners.devices.unclaimAsync`
281 # to remove the device from zero-touch enrollment.
282 { # A record of a device claimed by a reseller for a customer. Devices claimed
283 # for zero-touch enrollment have a claim with the type
284 # `SECTION_TYPE_ZERO_TOUCH`. To learn more, read
285 # [Claim devices for customers](/zero-touch/guides/how-it-works#claim).
286 "vacationModeStartTime": "A String", # The timestamp when the device was put into ‘vacation mode’. This value is
287 # present iff the device is in 'vacation mode'.
288 "resellerId": "A String", # The ID of the reseller that claimed the device.
289 "vacationModeExpireTime": "A String", # The timestamp when the device will exit ‘vacation mode’. This value is
290 # present iff the device is in 'vacation mode'.
291 "sectionType": "A String", # Output only. The type of claim made on the device.
292 "ownerCompanyId": "A String", # The ID of the Customer that purchased the device.
293 },
294 ],
295 "configuration": "A String", # Not available to resellers.
296 },
297 ],
298 }</pre>
299</div>
300
301<div class="method">
302 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
303 <pre>Retrieves the next page of results.
304
305Args:
306 previous_request: The request for the previous page. (required)
307 previous_response: The response from the request for the previous page. (required)
308
309Returns:
310 A request object that you can call 'execute()' on to request the next
311 page. Returns None if there are no more items in the collection.
312 </pre>
313</div>
314
315<div class="method">
316 <code class="details" id="removeConfiguration">removeConfiguration(parent, body, x__xgafv=None)</code>
317 <pre>Removes a configuration from device.
318
319Args:
320 parent: string, Required. The customer managing the device in the format
321`customers/[CUSTOMER_ID]`. (required)
322 body: object, The request body. (required)
323 The object takes the form of:
324
325{ # Request message for customer to remove the configuration from device.
326 "device": { # A `DeviceReference` is an API abstraction that lets you supply a _device_ # Required. The device to remove the configuration from.
327 # argument to a method using one of the following identifier types:
328 #
329 # * A numeric API resource ID.
330 # * Real-world hardware IDs, such as IMEI number, belonging to the manufactured
331 # device.
332 #
333 # Methods that operate on devices take a `DeviceReference` as a parameter type
334 # because it's more flexible for the caller. To learn more about device
335 # identifiers, read [Identifiers](/zero-touch/guides/identifiers).
336 "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # The hardware IDs of the device.
337 # To understand requirements on identifier sets, read
338 # [Identifiers](/zero-touch/guides/identifiers).
339 "imei": "A String", # The device’s IMEI number. Validated on input.
340 "model": "A String", # The device model's name. Matches the device's built-in value returned from
341 # `android.os.Build.MODEL`. Allowed values are listed in
342 # [models](/zero-touch/resources/manufacturer-names#model-names).
343 "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
344 # unique across different device models.
345 "meid": "A String", # The device’s MEID number.
346 "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in
347 # value returned from `android.os.Build.MANUFACTURER`. Allowed values are
348 # listed in
349 # [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
350 },
351 "deviceId": "A String", # The ID of the device.
352 },
353 }
354
355 x__xgafv: string, V1 error format.
356 Allowed values
357 1 - v1 error format
358 2 - v2 error format
359
360Returns:
361 An object of the form:
362
363 { # A generic empty message that you can re-use to avoid defining duplicated
364 # empty messages in your APIs. A typical example is to use it as the request
365 # or the response type of an API method. For instance:
366 #
367 # service Foo {
368 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
369 # }
370 #
371 # The JSON representation for `Empty` is empty JSON object `{}`.
372 }</pre>
373</div>
374
375<div class="method">
376 <code class="details" id="unclaim">unclaim(parent, body, x__xgafv=None)</code>
377 <pre>Unclaims a device from a customer and removes it from zero-touch
378enrollment.
379
380After removing a device, a customer must contact their reseller to register
381the device into zero-touch enrollment again.
382
383Args:
384 parent: string, Required. The customer managing the device. An API resource name in the
385format `customers/[CUSTOMER_ID]`. (required)
386 body: object, The request body. (required)
387 The object takes the form of:
388
389{ # Request message for customer to unclaim a device.
390 "device": { # A `DeviceReference` is an API abstraction that lets you supply a _device_ # Required. The device to unclaim.
391 # argument to a method using one of the following identifier types:
392 #
393 # * A numeric API resource ID.
394 # * Real-world hardware IDs, such as IMEI number, belonging to the manufactured
395 # device.
396 #
397 # Methods that operate on devices take a `DeviceReference` as a parameter type
398 # because it's more flexible for the caller. To learn more about device
399 # identifiers, read [Identifiers](/zero-touch/guides/identifiers).
400 "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # The hardware IDs of the device.
401 # To understand requirements on identifier sets, read
402 # [Identifiers](/zero-touch/guides/identifiers).
403 "imei": "A String", # The device’s IMEI number. Validated on input.
404 "model": "A String", # The device model's name. Matches the device's built-in value returned from
405 # `android.os.Build.MODEL`. Allowed values are listed in
406 # [models](/zero-touch/resources/manufacturer-names#model-names).
407 "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
408 # unique across different device models.
409 "meid": "A String", # The device’s MEID number.
410 "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in
411 # value returned from `android.os.Build.MANUFACTURER`. Allowed values are
412 # listed in
413 # [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
414 },
415 "deviceId": "A String", # The ID of the device.
416 },
417 }
418
419 x__xgafv: string, V1 error format.
420 Allowed values
421 1 - v1 error format
422 2 - v2 error format
423
424Returns:
425 An object of the form:
426
427 { # A generic empty message that you can re-use to avoid defining duplicated
428 # empty messages in your APIs. A typical example is to use it as the request
429 # or the response type of an API method. For instance:
430 #
431 # service Foo {
432 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
433 # }
434 #
435 # The JSON representation for `Empty` is empty JSON object `{}`.
436 }</pre>
437</div>
438
439</body></html>