1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<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>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#applyConfiguration">applyConfiguration(parent, body=None, x__xgafv=None)</a></code></p>
<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>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the details of a device.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists a customer's devices.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#removeConfiguration">removeConfiguration(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Removes a configuration from device.</p>
<p class="toc_element">
<code><a href="#unclaim">unclaim(parent, body=None, x__xgafv=None)</a></code></p>
<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>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="applyConfiguration">applyConfiguration(parent, body=None, x__xgafv=None)</code>
<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.
Args:
parent: string, Required. The customer managing the device. An API resource name in the format `customers/[CUSTOMER_ID]`. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for customer to assign a configuration to device.
"configuration": "A String", # Required. The configuration applied to the device in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`.
"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. There are custom validations in ApplyConfigurationRequestValidator
"deviceId": "A String", # The ID of the device.
"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.
"chromeOsAttestedDeviceId": "A String", # An identifier provided by OEMs, carried through the production and sales process. Only applicable to Chrome OS devices.
"deviceType": "A String", # The type of the device
"imei": "A String", # The device’s IMEI number. Validated on input.
"imei2": "A String", # The device’s second IMEI number.
"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 [Android manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
"meid": "A String", # The device’s MEID number.
"meid2": "A String", # The device’s second MEID number.
"model": "A String", # The device model's name. Allowed values are listed in [Android models](/zero-touch/resources/manufacturer-names#model-names) and [Chrome OS models](https://support.google.com/chrome/a/answer/10130175#identify_compatible).
"serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be unique across different device models.
},
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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); }
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets the details of a device.
Args:
name: string, Required. The device to get. An API resource name in the format `customers/[CUSTOMER_ID]/devices/[DEVICE_ID]`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Android or Chrome OS device registered for zero-touch enrollment.
"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.
{ # 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).
"additionalService": "A String", # The Additional service registered for the device.
"googleWorkspaceCustomerId": "A String", # The ID of the Google Workspace account that owns the Chrome OS device.
"ownerCompanyId": "A String", # The ID of the Customer that purchased the device.
"resellerId": "A String", # The ID of the reseller that claimed the device.
"sectionType": "A String", # Output only. The type of claim made on the device.
"vacationModeExpireTime": "A String", # The timestamp when the device will exit ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
"vacationModeStartTime": "A String", # The timestamp when the device was put into ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
},
],
"configuration": "A String", # Not available to resellers.
"deviceId": "A String", # Output only. The ID of the device. Assigned by the server.
"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).
"chromeOsAttestedDeviceId": "A String", # An identifier provided by OEMs, carried through the production and sales process. Only applicable to Chrome OS devices.
"deviceType": "A String", # The type of the device
"imei": "A String", # The device’s IMEI number. Validated on input.
"imei2": "A String", # The device’s second IMEI number.
"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 [Android manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
"meid": "A String", # The device’s MEID number.
"meid2": "A String", # The device’s second MEID number.
"model": "A String", # The device model's name. Allowed values are listed in [Android models](/zero-touch/resources/manufacturer-names#model-names) and [Chrome OS models](https://support.google.com/chrome/a/answer/10130175#identify_compatible).
"serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be unique across different device models.
},
"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).
"entries": { # Metadata entries recorded as key-value pairs.
"a_key": "A String",
},
},
"name": "A String", # Output only. The API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists a customer's devices.
Args:
parent: string, Required. The customer managing the devices. An API resource name in the format `customers/[CUSTOMER_ID]`. (required)
pageSize: string, Required. The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive.
pageToken: string, A token specifying which result page to return.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message of customer's liting devices.
"devices": [ # The customer's devices.
{ # An Android or Chrome OS device registered for zero-touch enrollment.
"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.
{ # 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).
"additionalService": "A String", # The Additional service registered for the device.
"googleWorkspaceCustomerId": "A String", # The ID of the Google Workspace account that owns the Chrome OS device.
"ownerCompanyId": "A String", # The ID of the Customer that purchased the device.
"resellerId": "A String", # The ID of the reseller that claimed the device.
"sectionType": "A String", # Output only. The type of claim made on the device.
"vacationModeExpireTime": "A String", # The timestamp when the device will exit ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
"vacationModeStartTime": "A String", # The timestamp when the device was put into ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
},
],
"configuration": "A String", # Not available to resellers.
"deviceId": "A String", # Output only. The ID of the device. Assigned by the server.
"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).
"chromeOsAttestedDeviceId": "A String", # An identifier provided by OEMs, carried through the production and sales process. Only applicable to Chrome OS devices.
"deviceType": "A String", # The type of the device
"imei": "A String", # The device’s IMEI number. Validated on input.
"imei2": "A String", # The device’s second IMEI number.
"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 [Android manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
"meid": "A String", # The device’s MEID number.
"meid2": "A String", # The device’s second MEID number.
"model": "A String", # The device model's name. Allowed values are listed in [Android models](/zero-touch/resources/manufacturer-names#model-names) and [Chrome OS models](https://support.google.com/chrome/a/answer/10130175#identify_compatible).
"serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be unique across different device models.
},
"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).
"entries": { # Metadata entries recorded as key-value pairs.
"a_key": "A String",
},
},
"name": "A String", # Output only. The API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
},
],
"nextPageToken": "A String", # A token used to access the next page of results. Omitted if no further results are available.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="removeConfiguration">removeConfiguration(parent, body=None, x__xgafv=None)</code>
<pre>Removes a configuration from device.
Args:
parent: string, Required. The customer managing the device in the format `customers/[CUSTOMER_ID]`. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for customer to remove the configuration from device.
"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. There are custom validations in RemoveConfigurationRequestValidator
"deviceId": "A String", # The ID of the device.
"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.
"chromeOsAttestedDeviceId": "A String", # An identifier provided by OEMs, carried through the production and sales process. Only applicable to Chrome OS devices.
"deviceType": "A String", # The type of the device
"imei": "A String", # The device’s IMEI number. Validated on input.
"imei2": "A String", # The device’s second IMEI number.
"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 [Android manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
"meid": "A String", # The device’s MEID number.
"meid2": "A String", # The device’s second MEID number.
"model": "A String", # The device model's name. Allowed values are listed in [Android models](/zero-touch/resources/manufacturer-names#model-names) and [Chrome OS models](https://support.google.com/chrome/a/answer/10130175#identify_compatible).
"serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be unique across different device models.
},
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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); }
}</pre>
</div>
<div class="method">
<code class="details" id="unclaim">unclaim(parent, body=None, x__xgafv=None)</code>
<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.
Args:
parent: string, Required. The customer managing the device. An API resource name in the format `customers/[CUSTOMER_ID]`. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for customer to unclaim a device.
"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. There are custom validations in UnclaimDeviceRequestValidator.
"deviceId": "A String", # The ID of the device.
"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.
"chromeOsAttestedDeviceId": "A String", # An identifier provided by OEMs, carried through the production and sales process. Only applicable to Chrome OS devices.
"deviceType": "A String", # The type of the device
"imei": "A String", # The device’s IMEI number. Validated on input.
"imei2": "A String", # The device’s second IMEI number.
"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 [Android manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
"meid": "A String", # The device’s MEID number.
"meid2": "A String", # The device’s second MEID number.
"model": "A String", # The device model's name. Allowed values are listed in [Android models](/zero-touch/resources/manufacturer-names#model-names) and [Chrome OS models](https://support.google.com/chrome/a/answer/10130175#identify_compatible).
"serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be unique across different device models.
},
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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); }
}</pre>
</div>
</body></html>
|
