Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(431)

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: discovery/googleapis/androiddeviceprovisioning__v1.json

Issue 3006323002: Api-Roll 54: 2017-09-11 (Closed)
Patch Set: use 2.0.0-dev.infinity sdk constraint in pubspecs Created 3 years, 3 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « discovery/googleapis/analyticsreporting__v4.json ('k') | discovery/googleapis/androidenterprise__v1.json » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 { 1 {
2 "basePath": "", 2 "basePath": "",
3 "baseUrl": "https://androiddeviceprovisioning.googleapis.com/", 3 "baseUrl": "https://androiddeviceprovisioning.googleapis.com/",
4 "batchPath": "batch", 4 "batchPath": "batch",
5 "canonicalName": "Android Provisioning Partner", 5 "canonicalName": "Android Provisioning Partner",
6 "description": "Automates reseller integration into Zero Touch Provisioning by assigning devices to customers and creating device reports.", 6 "description": "Automates reseller integration into Zero Touch Provisioning by assigning devices to customers and creating device reports.",
7 "discoveryVersion": "v1", 7 "discoveryVersion": "v1",
8 "documentationLink": "https://developers.google.com/zero-touch/", 8 "documentationLink": "https://developers.google.com/zero-touch/",
9 "icons": { 9 "icons": {
10 "x16": "http://www.google.com/images/icons/product/search-16.gif", 10 "x16": "http://www.google.com/images/icons/product/search-16.gif",
11 "x32": "http://www.google.com/images/icons/product/search-32.gif" 11 "x32": "http://www.google.com/images/icons/product/search-32.gif"
12 }, 12 },
13 "id": "androiddeviceprovisioning:v1", 13 "id": "androiddeviceprovisioning:v1",
14 "kind": "discovery#restDescription", 14 "kind": "discovery#restDescription",
15 "name": "androiddeviceprovisioning", 15 "name": "androiddeviceprovisioning",
16 "ownerDomain": "google.com", 16 "ownerDomain": "google.com",
17 "ownerName": "Google", 17 "ownerName": "Google",
18 "parameters": { 18 "parameters": {
19 "upload_protocol": {
20 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
21 "location": "query",
22 "type": "string"
23 },
24 "prettyPrint": {
25 "default": "true",
26 "description": "Returns response with indentations and line breaks." ,
27 "location": "query",
28 "type": "boolean"
29 },
30 "uploadType": {
31 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
32 "location": "query",
33 "type": "string"
34 },
35 "fields": {
36 "description": "Selector specifying which fields to include in a par tial response.",
37 "location": "query",
38 "type": "string"
39 },
40 "$.xgafv": {
41 "description": "V1 error format.",
42 "enum": [
43 "1",
44 "2"
45 ],
46 "enumDescriptions": [
47 "v1 error format",
48 "v2 error format"
49 ],
50 "location": "query",
51 "type": "string"
52 },
53 "callback": {
54 "description": "JSONP",
55 "location": "query",
56 "type": "string"
57 },
19 "alt": { 58 "alt": {
20 "default": "json", 59 "default": "json",
21 "description": "Data format for response.", 60 "description": "Data format for response.",
22 "enum": [ 61 "enum": [
23 "json", 62 "json",
24 "media", 63 "media",
25 "proto" 64 "proto"
26 ], 65 ],
27 "enumDescriptions": [ 66 "enumDescriptions": [
28 "Responses with Content-Type of application/json", 67 "Responses with Content-Type of application/json",
29 "Media download with context-dependent Content-Type", 68 "Media download with context-dependent Content-Type",
30 "Responses with Content-Type of application/x-protobuf" 69 "Responses with Content-Type of application/x-protobuf"
31 ], 70 ],
32 "location": "query", 71 "location": "query",
33 "type": "string" 72 "type": "string"
34 }, 73 },
74 "key": {
75 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.",
76 "location": "query",
77 "type": "string"
78 },
35 "access_token": { 79 "access_token": {
36 "description": "OAuth access token.", 80 "description": "OAuth access token.",
37 "location": "query", 81 "location": "query",
38 "type": "string" 82 "type": "string"
39 }, 83 },
40 "key": {
41 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.",
42 "location": "query",
43 "type": "string"
44 },
45 "quotaUser": { 84 "quotaUser": {
46 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.", 85 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.",
47 "location": "query", 86 "location": "query",
48 "type": "string" 87 "type": "string"
49 }, 88 },
50 "pp": { 89 "pp": {
51 "default": "true", 90 "default": "true",
52 "description": "Pretty-print response.", 91 "description": "Pretty-print response.",
53 "location": "query", 92 "location": "query",
54 "type": "boolean" 93 "type": "boolean"
55 }, 94 },
56 "bearer_token": {
57 "description": "OAuth bearer token.",
58 "location": "query",
59 "type": "string"
60 },
61 "oauth_token": { 95 "oauth_token": {
62 "description": "OAuth 2.0 token for the current user.", 96 "description": "OAuth 2.0 token for the current user.",
63 "location": "query", 97 "location": "query",
64 "type": "string" 98 "type": "string"
65 }, 99 },
66 "upload_protocol": { 100 "bearer_token": {
67 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").", 101 "description": "OAuth bearer token.",
68 "location": "query",
69 "type": "string"
70 },
71 "prettyPrint": {
72 "default": "true",
73 "description": "Returns response with indentations and line breaks." ,
74 "location": "query",
75 "type": "boolean"
76 },
77 "uploadType": {
78 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
79 "location": "query",
80 "type": "string"
81 },
82 "fields": {
83 "description": "Selector specifying which fields to include in a par tial response.",
84 "location": "query",
85 "type": "string"
86 },
87 "$.xgafv": {
88 "description": "V1 error format.",
89 "enum": [
90 "1",
91 "2"
92 ],
93 "enumDescriptions": [
94 "v1 error format",
95 "v2 error format"
96 ],
97 "location": "query",
98 "type": "string"
99 },
100 "callback": {
101 "description": "JSONP",
102 "location": "query", 102 "location": "query",
103 "type": "string" 103 "type": "string"
104 } 104 }
105 }, 105 },
106 "protocol": "rest", 106 "protocol": "rest",
107 "resources": { 107 "resources": {
108 "partners": { 108 "partners": {
109 "resources": { 109 "resources": {
110 "devices": { 110 "devices": {
111 "methods": { 111 "methods": {
112 "updateMetadataAsync": {
113 "description": "Set metadata in batch asynchronously .",
114 "httpMethod": "POST",
115 "id": "androiddeviceprovisioning.partners.devices.up dateMetadataAsync",
116 "parameterOrder": [
117 "partnerId"
118 ],
119 "parameters": {
120 "partnerId": {
121 "description": "Partner ID.",
122 "format": "int64",
123 "location": "path",
124 "pattern": "^[^/]+$",
125 "required": true,
126 "type": "string"
127 }
128 },
129 "path": "v1/partners/{+partnerId}/devices:updateMeta dataAsync",
130 "request": {
131 "$ref": "UpdateDeviceMetadataInBatchRequest"
132 },
133 "response": {
134 "$ref": "Operation"
135 }
136 },
112 "get": { 137 "get": {
113 "description": "Get a device", 138 "description": "Get a device.",
114 "httpMethod": "GET", 139 "httpMethod": "GET",
115 "id": "androiddeviceprovisioning.partners.devices.ge t", 140 "id": "androiddeviceprovisioning.partners.devices.ge t",
116 "parameterOrder": [ 141 "parameterOrder": [
117 "name" 142 "name"
118 ], 143 ],
119 "parameters": { 144 "parameters": {
120 "name": { 145 "name": {
121 "description": "resource name in 'partners/[ PARTNER_ID]/devices/[DEVICE_ID]'.", 146 "description": "Resource name in `partners/[ PARTNER_ID]/devices/[DEVICE_ID]`.",
122 "location": "path", 147 "location": "path",
123 "pattern": "^partners/[^/]+/devices/[^/]+$", 148 "pattern": "^partners/[^/]+/devices/[^/]+$",
124 "required": true, 149 "required": true,
125 "type": "string" 150 "type": "string"
126 } 151 }
127 }, 152 },
128 "path": "v1/{+name}", 153 "path": "v1/{+name}",
129 "response": { 154 "response": {
130 "$ref": "Device" 155 "$ref": "Device"
131 } 156 }
132 }, 157 },
133 "unclaim": { 158 "unclaim": {
134 "description": "Unclaim the device identified by dev ice_id or identifier.", 159 "description": "Unclaim the device identified by the `device_id` or the `deviceIdentifier`.",
135 "httpMethod": "POST", 160 "httpMethod": "POST",
136 "id": "androiddeviceprovisioning.partners.devices.un claim", 161 "id": "androiddeviceprovisioning.partners.devices.un claim",
137 "parameterOrder": [ 162 "parameterOrder": [
138 "partnerId" 163 "partnerId"
139 ], 164 ],
140 "parameters": { 165 "parameters": {
141 "partnerId": { 166 "partnerId": {
142 "description": "Id of the partner.", 167 "description": "ID of the partner.",
143 "format": "int64", 168 "format": "int64",
144 "location": "path", 169 "location": "path",
145 "pattern": "^[^/]+$", 170 "pattern": "^[^/]+$",
146 "required": true, 171 "required": true,
147 "type": "string" 172 "type": "string"
148 } 173 }
149 }, 174 },
150 "path": "v1/partners/{+partnerId}/devices:unclaim", 175 "path": "v1/partners/{+partnerId}/devices:unclaim",
151 "request": { 176 "request": {
152 "$ref": "UnclaimDeviceRequest" 177 "$ref": "UnclaimDeviceRequest"
153 }, 178 },
154 "response": { 179 "response": {
155 "$ref": "Empty" 180 "$ref": "Empty"
156 } 181 }
157 }, 182 },
158 "findByOwner": { 183 "findByOwner": {
159 "description": "Find devices by ownership.", 184 "description": "Find devices by ownership.",
160 "httpMethod": "POST", 185 "httpMethod": "POST",
161 "id": "androiddeviceprovisioning.partners.devices.fi ndByOwner", 186 "id": "androiddeviceprovisioning.partners.devices.fi ndByOwner",
162 "parameterOrder": [ 187 "parameterOrder": [
163 "partnerId" 188 "partnerId"
164 ], 189 ],
165 "parameters": { 190 "parameters": {
166 "partnerId": { 191 "partnerId": {
167 "description": "id of the partner.", 192 "description": "ID of the partner.",
168 "format": "int64", 193 "format": "int64",
169 "location": "path", 194 "location": "path",
170 "pattern": "^[^/]+$", 195 "pattern": "^[^/]+$",
171 "required": true, 196 "required": true,
172 "type": "string" 197 "type": "string"
173 } 198 }
174 }, 199 },
175 "path": "v1/partners/{+partnerId}/devices:findByOwne r", 200 "path": "v1/partners/{+partnerId}/devices:findByOwne r",
176 "request": { 201 "request": {
177 "$ref": "FindDevicesByOwnerRequest" 202 "$ref": "FindDevicesByOwnerRequest"
178 }, 203 },
179 "response": { 204 "response": {
180 "$ref": "FindDevicesByOwnerResponse" 205 "$ref": "FindDevicesByOwnerResponse"
181 } 206 }
182 }, 207 },
183 "claim": { 208 "claim": {
184 "description": "Claim the device identified by devic e identifier.", 209 "description": "Claim the device identified by devic e identifier.",
185 "httpMethod": "POST", 210 "httpMethod": "POST",
186 "id": "androiddeviceprovisioning.partners.devices.cl aim", 211 "id": "androiddeviceprovisioning.partners.devices.cl aim",
187 "parameterOrder": [ 212 "parameterOrder": [
188 "partnerId" 213 "partnerId"
189 ], 214 ],
190 "parameters": { 215 "parameters": {
191 "partnerId": { 216 "partnerId": {
192 "description": "Id of the partner.", 217 "description": "ID of the partner.",
193 "format": "int64", 218 "format": "int64",
194 "location": "path", 219 "location": "path",
195 "pattern": "^[^/]+$", 220 "pattern": "^[^/]+$",
196 "required": true, 221 "required": true,
197 "type": "string" 222 "type": "string"
198 } 223 }
199 }, 224 },
200 "path": "v1/partners/{+partnerId}/devices:claim", 225 "path": "v1/partners/{+partnerId}/devices:claim",
201 "request": { 226 "request": {
202 "$ref": "ClaimDeviceRequest" 227 "$ref": "ClaimDeviceRequest"
203 }, 228 },
204 "response": { 229 "response": {
205 "$ref": "ClaimDeviceResponse" 230 "$ref": "ClaimDeviceResponse"
206 } 231 }
207 }, 232 },
208 "claimAsync": { 233 "claimAsync": {
209 "description": "Claim devices asynchronously", 234 "description": "Claim devices asynchronously.",
210 "httpMethod": "POST", 235 "httpMethod": "POST",
211 "id": "androiddeviceprovisioning.partners.devices.cl aimAsync", 236 "id": "androiddeviceprovisioning.partners.devices.cl aimAsync",
212 "parameterOrder": [ 237 "parameterOrder": [
213 "partnerId" 238 "partnerId"
214 ], 239 ],
215 "parameters": { 240 "parameters": {
216 "partnerId": { 241 "partnerId": {
217 "description": "partner id.", 242 "description": "Partner ID.",
218 "format": "int64", 243 "format": "int64",
219 "location": "path", 244 "location": "path",
220 "pattern": "^[^/]+$", 245 "pattern": "^[^/]+$",
221 "required": true, 246 "required": true,
222 "type": "string" 247 "type": "string"
223 } 248 }
224 }, 249 },
225 "path": "v1/partners/{+partnerId}/devices:claimAsync ", 250 "path": "v1/partners/{+partnerId}/devices:claimAsync ",
226 "request": { 251 "request": {
227 "$ref": "ClaimDevicesRequest" 252 "$ref": "ClaimDevicesRequest"
228 }, 253 },
229 "response": { 254 "response": {
230 "$ref": "Operation" 255 "$ref": "Operation"
231 } 256 }
232 }, 257 },
233 "findByIdentifier": { 258 "findByIdentifier": {
234 "description": "Find devices by device identifier.", 259 "description": "Find devices by device identifier.",
235 "httpMethod": "POST", 260 "httpMethod": "POST",
236 "id": "androiddeviceprovisioning.partners.devices.fi ndByIdentifier", 261 "id": "androiddeviceprovisioning.partners.devices.fi ndByIdentifier",
237 "parameterOrder": [ 262 "parameterOrder": [
238 "partnerId" 263 "partnerId"
239 ], 264 ],
240 "parameters": { 265 "parameters": {
241 "partnerId": { 266 "partnerId": {
242 "description": "id of the partner.", 267 "description": "ID of the partner.",
243 "format": "int64", 268 "format": "int64",
244 "location": "path", 269 "location": "path",
245 "pattern": "^[^/]+$", 270 "pattern": "^[^/]+$",
246 "required": true, 271 "required": true,
247 "type": "string" 272 "type": "string"
248 } 273 }
249 }, 274 },
250 "path": "v1/partners/{+partnerId}/devices:findByIden tifier", 275 "path": "v1/partners/{+partnerId}/devices:findByIden tifier",
251 "request": { 276 "request": {
252 "$ref": "FindDevicesByDeviceIdentifierRequest" 277 "$ref": "FindDevicesByDeviceIdentifierRequest"
253 }, 278 },
254 "response": { 279 "response": {
255 "$ref": "FindDevicesByDeviceIdentifierResponse" 280 "$ref": "FindDevicesByDeviceIdentifierResponse"
256 } 281 }
257 }, 282 },
258 "unclaimAsync": { 283 "unclaimAsync": {
259 "description": "Unclaim devices asynchronously", 284 "description": "Unclaim devices asynchronously.",
260 "httpMethod": "POST", 285 "httpMethod": "POST",
261 "id": "androiddeviceprovisioning.partners.devices.un claimAsync", 286 "id": "androiddeviceprovisioning.partners.devices.un claimAsync",
262 "parameterOrder": [ 287 "parameterOrder": [
263 "partnerId" 288 "partnerId"
264 ], 289 ],
265 "parameters": { 290 "parameters": {
266 "partnerId": { 291 "partnerId": {
267 "description": "partner id.", 292 "description": "Partner ID.",
268 "format": "int64", 293 "format": "int64",
269 "location": "path", 294 "location": "path",
270 "pattern": "^[^/]+$", 295 "pattern": "^[^/]+$",
271 "required": true, 296 "required": true,
272 "type": "string" 297 "type": "string"
273 } 298 }
274 }, 299 },
275 "path": "v1/partners/{+partnerId}/devices:unclaimAsy nc", 300 "path": "v1/partners/{+partnerId}/devices:unclaimAsy nc",
276 "request": { 301 "request": {
277 "$ref": "UnclaimDevicesRequest" 302 "$ref": "UnclaimDevicesRequest"
278 }, 303 },
279 "response": { 304 "response": {
280 "$ref": "Operation" 305 "$ref": "Operation"
281 } 306 }
282 }, 307 },
283 "metadata": { 308 "metadata": {
284 "description": "Update the metadata", 309 "description": "Update the metadata.",
285 "httpMethod": "POST", 310 "httpMethod": "POST",
286 "id": "androiddeviceprovisioning.partners.devices.me tadata", 311 "id": "androiddeviceprovisioning.partners.devices.me tadata",
287 "parameterOrder": [ 312 "parameterOrder": [
288 "metadataOwnerId", 313 "metadataOwnerId",
289 "deviceId" 314 "deviceId"
290 ], 315 ],
291 "parameters": { 316 "parameters": {
292 "metadataOwnerId": { 317 "metadataOwnerId": {
293 "description": "The owner of the newly set m etadata. Should be partner id itself.", 318 "description": "The owner of the newly set m etadata. Set this to the partner ID.",
294 "format": "int64", 319 "format": "int64",
295 "location": "path", 320 "location": "path",
296 "pattern": "^[^/]+$", 321 "pattern": "^[^/]+$",
297 "required": true, 322 "required": true,
298 "type": "string" 323 "type": "string"
299 }, 324 },
300 "deviceId": { 325 "deviceId": {
301 "description": "id of the partner.", 326 "description": "ID of the partner.",
302 "format": "int64", 327 "format": "int64",
303 "location": "path", 328 "location": "path",
304 "pattern": "^[^/]+$", 329 "pattern": "^[^/]+$",
305 "required": true, 330 "required": true,
306 "type": "string" 331 "type": "string"
307 } 332 }
308 }, 333 },
309 "path": "v1/partners/{+metadataOwnerId}/devices/{+de viceId}/metadata", 334 "path": "v1/partners/{+metadataOwnerId}/devices/{+de viceId}/metadata",
310 "request": { 335 "request": {
311 "$ref": "UpdateDeviceMetadataRequest" 336 "$ref": "UpdateDeviceMetadataRequest"
312 }, 337 },
313 "response": { 338 "response": {
314 "$ref": "DeviceMetadata" 339 "$ref": "DeviceMetadata"
315 } 340 }
316 },
317 "updateMetadataAsync": {
318 "description": "Set metadata in batch asynchronously .",
319 "httpMethod": "POST",
320 "id": "androiddeviceprovisioning.partners.devices.up dateMetadataAsync",
321 "parameterOrder": [
322 "partnerId"
323 ],
324 "parameters": {
325 "partnerId": {
326 "description": "partner id.",
327 "format": "int64",
328 "location": "path",
329 "pattern": "^[^/]+$",
330 "required": true,
331 "type": "string"
332 }
333 },
334 "path": "v1/partners/{+partnerId}/devices:updateMeta dataAsync",
335 "request": {
336 "$ref": "UpdateDeviceMetadataInBatchRequest"
337 },
338 "response": {
339 "$ref": "Operation"
340 }
341 } 341 }
342 } 342 }
343 }, 343 },
344 "customers": { 344 "customers": {
345 "methods": { 345 "methods": {
346 "list": { 346 "list": {
347 "description": "List all the customers that has dele gates some role to this customer.", 347 "description": "List the customers that are enrolled to the reseller identified by the\n`partnerId` argument. This list includes cus tomers that the reseller\ncreated and customers that enrolled themselves using t he portal.",
348 "httpMethod": "GET", 348 "httpMethod": "GET",
349 "id": "androiddeviceprovisioning.partners.customers. list", 349 "id": "androiddeviceprovisioning.partners.customers. list",
350 "parameterOrder": [ 350 "parameterOrder": [
351 "partnerId" 351 "partnerId"
352 ], 352 ],
353 "parameters": { 353 "parameters": {
354 "partnerId": { 354 "partnerId": {
355 "description": "the id of the partner.", 355 "description": "The ID of the partner.",
356 "format": "int64", 356 "format": "int64",
357 "location": "path", 357 "location": "path",
358 "pattern": "^[^/]+$", 358 "pattern": "^[^/]+$",
359 "required": true, 359 "required": true,
360 "type": "string" 360 "type": "string"
361 } 361 }
362 }, 362 },
363 "path": "v1/partners/{+partnerId}/customers", 363 "path": "v1/partners/{+partnerId}/customers",
364 "response": { 364 "response": {
365 "$ref": "ListCustomersResponse" 365 "$ref": "ListCustomersResponse"
366 } 366 }
367 },
368 "create": {
369 "description": "A customer for Zero Touch Provisioni ng will be created.\nAfter a Customer is created, their admins and owners will b e able to manage\ndevices on partner.android.com/zerotouch or via their API.",
370 "httpMethod": "POST",
371 "id": "androiddeviceprovisioning.partners.customers. create",
372 "parameterOrder": [
373 "parent"
374 ],
375 "parameters": {
376 "parent": {
377 "description": "The parent resource in forma t `partners/[PARTNER_ID]'.",
378 "location": "path",
379 "pattern": "^partners/[^/]+$",
380 "required": true,
381 "type": "string"
382 }
383 },
384 "path": "v1/{+parent}/customers",
385 "request": {
386 "$ref": "CreateCustomerRequest"
387 },
388 "response": {
389 "$ref": "Company"
390 }
367 } 391 }
368 } 392 }
369 } 393 }
370 } 394 }
371 }, 395 },
372 "operations": { 396 "operations": {
373 "methods": { 397 "methods": {
374 "get": { 398 "get": {
375 "description": "Gets the latest state of a long-running oper ation. Clients can use this\nmethod to poll the operation result at intervals a s recommended by the API\nservice.", 399 "description": "Gets the latest state of a long-running oper ation. Clients can use this\nmethod to poll the operation result at intervals a s recommended by the API\nservice.",
376 "httpMethod": "GET", 400 "httpMethod": "GET",
(...skipping 11 matching lines...) Expand all
388 } 412 }
389 }, 413 },
390 "path": "v1/{+name}", 414 "path": "v1/{+name}",
391 "response": { 415 "response": {
392 "$ref": "Operation" 416 "$ref": "Operation"
393 } 417 }
394 } 418 }
395 } 419 }
396 } 420 }
397 }, 421 },
398 "revision": "20170805", 422 "revision": "20170903",
399 "rootUrl": "https://androiddeviceprovisioning.googleapis.com/", 423 "rootUrl": "https://androiddeviceprovisioning.googleapis.com/",
400 "schemas": { 424 "schemas": {
401 "DeviceClaim": { 425 "UpdateMetadataArguments": {
402 "description": "containing the necessary info about a claim for a pa rtner.", 426 "description": "Identifies metdata updates to one device.",
403 "id": "DeviceClaim", 427 "id": "UpdateMetadataArguments",
404 "properties": { 428 "properties": {
405 "ownerCompanyId": { 429 "deviceIdentifier": {
406 "description": "owner id", 430 "$ref": "DeviceIdentifier",
407 "format": "int64", 431 "description": "Device identifier."
408 "type": "string" 432 },
433 "deviceMetadata": {
434 "$ref": "DeviceMetadata",
435 "description": "The metadata to update."
436 },
437 "deviceId": {
438 "description": "Device ID of the device.",
439 "format": "int64",
440 "type": "string"
441 }
442 },
443 "type": "object"
444 },
445 "ClaimDeviceResponse": {
446 "description": "Response message containing device id of the claim." ,
447 "id": "ClaimDeviceResponse",
448 "properties": {
449 "deviceId": {
450 "description": "The device ID of the claimed device.",
451 "format": "int64",
452 "type": "string"
453 },
454 "deviceName": {
455 "description": "The resource name of the device in the forma t\n`partners/[PARTNER_ID]/devices/[DEVICE_ID]`.",
456 "type": "string"
457 }
458 },
459 "type": "object"
460 },
461 "ListCustomersResponse": {
462 "description": "Response message of all customers related to this pa rtner.",
463 "id": "ListCustomersResponse",
464 "properties": {
465 "customers": {
466 "description": "List of customers related to this partner.",
467 "items": {
468 "$ref": "Company"
469 },
470 "type": "array"
471 }
472 },
473 "type": "object"
474 },
475 "Device": {
476 "description": "An Android device.",
477 "id": "Device",
478 "properties": {
479 "configuration": {
480 "description": "The resource name of the configuration.\nOnl y set for customers.",
481 "type": "string"
482 },
483 "claims": {
484 "description": "Claims.",
485 "items": {
486 "$ref": "DeviceClaim"
487 },
488 "type": "array"
489 },
490 "deviceIdentifier": {
491 "$ref": "DeviceIdentifier",
492 "description": "Device identifier."
493 },
494 "deviceMetadata": {
495 "$ref": "DeviceMetadata",
496 "description": "Device metadata."
497 },
498 "name": {
499 "description": "Resource name in `partners/[PARTNER_ID]/devi ces/[DEVICE_ID]`.",
500 "type": "string"
501 },
502 "deviceId": {
503 "description": "Device ID.",
504 "format": "int64",
505 "type": "string"
506 }
507 },
508 "type": "object"
509 },
510 "CreateCustomerRequest": {
511 "description": "Request message to create a customer.",
512 "id": "CreateCustomerRequest",
513 "properties": {
514 "customer": {
515 "$ref": "Company",
516 "description": "The customer to create."
517 }
518 },
519 "type": "object"
520 },
521 "Company": {
522 "description": "Company",
523 "id": "Company",
524 "properties": {
525 "ownerEmails": {
526 "description": "Owner emails.\nOwners are able to operate on the portal, and modify admins or other\nowners. This field is a write-only fiel d at creation time.",
527 "items": {
528 "type": "string"
529 },
530 "type": "array"
531 },
532 "companyId": {
533 "description": "Company ID.",
534 "format": "int64",
535 "type": "string"
536 },
537 "companyName": {
538 "description": "Company name.",
539 "type": "string"
540 },
541 "name": {
542 "description": "The API resource name of the company in the format\n`partners/[PARTNER_ID]/customers/[CUSTOMER_ID]`.",
543 "type": "string"
544 },
545 "adminEmails": {
546 "description": "Admin emails.\nAdmins are able to operate on the portal.\nThis field is a write-only field at creation time.",
547 "items": {
548 "type": "string"
549 },
550 "type": "array"
551 }
552 },
553 "type": "object"
554 },
555 "UpdateDeviceMetadataRequest": {
556 "description": "Request to set metadata for a device.",
557 "id": "UpdateDeviceMetadataRequest",
558 "properties": {
559 "deviceMetadata": {
560 "$ref": "DeviceMetadata",
561 "description": "The metdata to set."
562 }
563 },
564 "type": "object"
565 },
566 "PartnerUnclaim": {
567 "description": "Identifies one unclaim request.",
568 "id": "PartnerUnclaim",
569 "properties": {
570 "deviceId": {
571 "description": "Device ID of the device.",
572 "format": "int64",
573 "type": "string"
574 },
575 "deviceIdentifier": {
576 "$ref": "DeviceIdentifier",
577 "description": "Device identifier of the device."
409 }, 578 },
410 "sectionType": { 579 "sectionType": {
411 "description": "section type.", 580 "description": "Section type to unclaim.",
412 "enum": [ 581 "enum": [
413 "SECTION_TYPE_UNSPECIFIED", 582 "SECTION_TYPE_UNSPECIFIED",
414 "SECTION_TYPE_ZERO_TOUCH" 583 "SECTION_TYPE_ZERO_TOUCH"
415 ], 584 ],
416 "enumDescriptions": [ 585 "enumDescriptions": [
417 "Unspecified", 586 "Unspecified section type.",
418 "Zero touch" 587 "Zero touch section type."
588 ],
589 "type": "string"
590 }
591 },
592 "type": "object"
593 },
594 "Empty": {
595 "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use i t as the request\nor the response type of an API method. For instance:\n\n se rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty );\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
596 "id": "Empty",
597 "properties": {},
598 "type": "object"
599 },
600 "FindDevicesByDeviceIdentifierResponse": {
601 "description": "Response containing found devices.",
602 "id": "FindDevicesByDeviceIdentifierResponse",
603 "properties": {
604 "nextPageToken": {
605 "description": "Page token of the next page.",
606 "type": "string"
607 },
608 "devices": {
609 "description": "Found devices.",
610 "items": {
611 "$ref": "Device"
612 },
613 "type": "array"
614 }
615 },
616 "type": "object"
617 },
618 "PartnerClaim": {
619 "description": "Identifies one claim request.",
620 "id": "PartnerClaim",
621 "properties": {
622 "deviceIdentifier": {
623 "$ref": "DeviceIdentifier",
624 "description": "Device identifier of the device."
625 },
626 "deviceMetadata": {
627 "$ref": "DeviceMetadata",
628 "description": "Metadata to set at claim."
629 },
630 "sectionType": {
631 "description": "Section type to claim.",
632 "enum": [
633 "SECTION_TYPE_UNSPECIFIED",
634 "SECTION_TYPE_ZERO_TOUCH"
635 ],
636 "enumDescriptions": [
637 "Unspecified section type.",
638 "Zero touch section type."
639 ],
640 "type": "string"
641 },
642 "customerId": {
643 "description": "Customer ID to claim for.",
644 "format": "int64",
645 "type": "string"
646 }
647 },
648 "type": "object"
649 },
650 "UnclaimDeviceRequest": {
651 "description": "Request message to unclaim a device.",
652 "id": "UnclaimDeviceRequest",
653 "properties": {
654 "deviceIdentifier": {
655 "$ref": "DeviceIdentifier",
656 "description": "The device identifier you used when you clai med this device."
657 },
658 "sectionType": {
659 "description": "The section type to unclaim for.",
660 "enum": [
661 "SECTION_TYPE_UNSPECIFIED",
662 "SECTION_TYPE_ZERO_TOUCH"
663 ],
664 "enumDescriptions": [
665 "Unspecified section type.",
666 "Zero touch section type."
667 ],
668 "type": "string"
669 },
670 "deviceId": {
671 "description": "The device ID returned by `ClaimDevice`.",
672 "format": "int64",
673 "type": "string"
674 }
675 },
676 "type": "object"
677 },
678 "DeviceMetadata": {
679 "description": "A key-value pair of the device metadata.",
680 "id": "DeviceMetadata",
681 "properties": {
682 "entries": {
683 "additionalProperties": {
684 "type": "string"
685 },
686 "description": "Metadata entries",
687 "type": "object"
688 }
689 },
690 "type": "object"
691 },
692 "DeviceClaim": {
693 "description": "Information about a device claimed for a partner.",
694 "id": "DeviceClaim",
695 "properties": {
696 "ownerCompanyId": {
697 "description": "Owner ID.",
698 "format": "int64",
699 "type": "string"
700 },
701 "sectionType": {
702 "description": "Section type of the device claim.",
703 "enum": [
704 "SECTION_TYPE_UNSPECIFIED",
705 "SECTION_TYPE_ZERO_TOUCH"
706 ],
707 "enumDescriptions": [
708 "Unspecified section type.",
709 "Zero touch section type."
419 ], 710 ],
420 "type": "string" 711 "type": "string"
421 } 712 }
422 }, 713 },
423 "type": "object" 714 "type": "object"
424 }, 715 },
425 "DevicesLongRunningOperationResponse": { 716 "DevicesLongRunningOperationResponse": {
426 "description": "Long running operation response.", 717 "description": "Long running operation response.",
427 "id": "DevicesLongRunningOperationResponse", 718 "id": "DevicesLongRunningOperationResponse",
428 "properties": { 719 "properties": {
429 "successCount": { 720 "successCount": {
430 "description": "Number of succeesfully processed ones.", 721 "description": "Number of succeesfully processed ones.",
431 "format": "int32", 722 "format": "int32",
432 "type": "integer" 723 "type": "integer"
433 }, 724 },
434 "perDeviceStatus": { 725 "perDeviceStatus": {
435 "description": "processing status for each device.\nOne PerD eviceStatus per device. The order is the same as in your requests.", 726 "description": "Processing status for each device.\nOne `Per DeviceStatus` per device. The order is the same as in your requests.",
436 "items": { 727 "items": {
437 "$ref": "OperationPerDevice" 728 "$ref": "OperationPerDevice"
438 }, 729 },
439 "type": "array" 730 "type": "array"
440 } 731 }
441 }, 732 },
442 "type": "object" 733 "type": "object"
443 }, 734 },
444 "PerDeviceStatusInBatch": { 735 "PerDeviceStatusInBatch": {
445 "description": "Stores the processing result for each device.", 736 "description": "Stores the processing result for each device.",
446 "id": "PerDeviceStatusInBatch", 737 "id": "PerDeviceStatusInBatch",
447 "properties": { 738 "properties": {
448 "errorMessage": {
449 "description": "Error message",
450 "type": "string"
451 },
452 "deviceId": { 739 "deviceId": {
453 "description": "device id of the device if process succeeds. ", 740 "description": "Device ID of the device if process succeeds. ",
454 "format": "int64", 741 "format": "int64",
455 "type": "string" 742 "type": "string"
456 }, 743 },
457 "status": { 744 "status": {
458 "description": "Process result.", 745 "description": "Process result.",
459 "enum": [ 746 "enum": [
460 "SINGLE_DEVICE_STATUS_UNSPECIFIED", 747 "SINGLE_DEVICE_STATUS_UNSPECIFIED",
461 "SINGLE_DEVICE_STATUS_UNKNOWN_ERROR", 748 "SINGLE_DEVICE_STATUS_UNKNOWN_ERROR",
462 "SINGLE_DEVICE_STATUS_OTHER_ERROR", 749 "SINGLE_DEVICE_STATUS_OTHER_ERROR",
463 "SINGLE_DEVICE_STATUS_SUCCESS", 750 "SINGLE_DEVICE_STATUS_SUCCESS",
464 "SINGLE_DEVICE_STATUS_PERMISSION_DENIED", 751 "SINGLE_DEVICE_STATUS_PERMISSION_DENIED",
465 "SINGLE_DEVICE_STATUS_INVALID_DEVICE_IDENTIFIER", 752 "SINGLE_DEVICE_STATUS_INVALID_DEVICE_IDENTIFIER",
466 "SINGLE_DEVICE_STATUS_INVALID_SECTION_TYPE", 753 "SINGLE_DEVICE_STATUS_INVALID_SECTION_TYPE",
467 "SINGLE_DEVICE_STATUS_SECTION_NOT_YOURS" 754 "SINGLE_DEVICE_STATUS_SECTION_NOT_YOURS"
468 ], 755 ],
469 "enumDescriptions": [ 756 "enumDescriptions": [
470 "Invalid code. Shouldn' be used.", 757 "Invalid code. Shouldn't be used.",
471 "Unknown error.\nUnknown error is we don't expect it her e.", 758 "Unknown error.\nWe don't expect this error to occur her e.",
472 "Other error.\nOther error is we know/expect this error, but not having proper error\ncode yet.", 759 "Other error.\nWe know/expect this error, but there's no defined error code for the\nerror.",
473 "Success.", 760 "Success.",
474 "Permission denied", 761 "Permission denied.",
475 "Invalid device identifier.", 762 "Invalid device identifier.",
476 "Invalid section type.", 763 "Invalid section type.",
477 "This section is claimed by other company." 764 "This section is claimed by another company."
478 ], 765 ],
479 "type": "string" 766 "type": "string"
480 }, 767 },
481 "errorIdentifier": { 768 "errorIdentifier": {
482 "description": "Error identifier.", 769 "description": "Error identifier.",
483 "type": "string" 770 "type": "string"
484 } 771 },
485 }, 772 "errorMessage": {
486 "type": "object" 773 "description": "Error message.",
487 }, 774 "type": "string"
488 "ClaimDevicesRequest": {
489 "description": "Request to claim devices asynchronously in batch.",
490 "id": "ClaimDevicesRequest",
491 "properties": {
492 "claims": {
493 "description": "list of claims.",
494 "items": {
495 "$ref": "PartnerClaim"
496 },
497 "type": "array"
498 } 775 }
499 }, 776 },
500 "type": "object" 777 "type": "object"
501 }, 778 },
502 "FindDevicesByOwnerRequest": { 779 "FindDevicesByOwnerRequest": {
503 "description": "Request to find devices by customers.", 780 "description": "Request to find devices by customers.",
504 "id": "FindDevicesByOwnerRequest", 781 "id": "FindDevicesByOwnerRequest",
505 "properties": { 782 "properties": {
783 "limit": {
784 "description": "The number of devices to show in the result. ",
785 "format": "int64",
786 "type": "string"
787 },
788 "pageToken": {
789 "description": "Page token.",
790 "type": "string"
791 },
506 "sectionType": { 792 "sectionType": {
507 "description": "The section type.", 793 "description": "The section type.",
508 "enum": [ 794 "enum": [
509 "SECTION_TYPE_UNSPECIFIED", 795 "SECTION_TYPE_UNSPECIFIED",
510 "SECTION_TYPE_ZERO_TOUCH" 796 "SECTION_TYPE_ZERO_TOUCH"
511 ], 797 ],
512 "enumDescriptions": [ 798 "enumDescriptions": [
513 "Unspecified", 799 "Unspecified section type.",
514 "Zero touch" 800 "Zero touch section type."
515 ], 801 ],
516 "type": "string"
517 },
518 "pageToken": {
519 "description": "Page token",
520 "type": "string" 802 "type": "string"
521 }, 803 },
522 "customerId": { 804 "customerId": {
523 "description": "List of customer ids to search for.", 805 "description": "List of customer IDs to search for.",
524 "items": { 806 "items": {
525 "format": "int64", 807 "format": "int64",
526 "type": "string" 808 "type": "string"
527 }, 809 },
528 "type": "array" 810 "type": "array"
529 }, 811 }
530 "limit": { 812 },
531 "description": "The number of devices to show in the result. ", 813 "type": "object"
532 "format": "int64", 814 },
815 "ClaimDevicesRequest": {
816 "description": "Request to claim devices asynchronously in batch.",
817 "id": "ClaimDevicesRequest",
818 "properties": {
819 "claims": {
820 "description": "List of claims.",
821 "items": {
822 "$ref": "PartnerClaim"
823 },
824 "type": "array"
825 }
826 },
827 "type": "object"
828 },
829 "DeviceIdentifier": {
830 "description": "Identifies a unique device.",
831 "id": "DeviceIdentifier",
832 "properties": {
833 "serialNumber": {
834 "description": "Serial number (optional).",
835 "type": "string"
836 },
837 "imei": {
838 "description": "IMEI number.",
839 "type": "string"
840 },
841 "meid": {
842 "description": "MEID number.",
843 "type": "string"
844 },
845 "manufacturer": {
846 "description": "Manufacturer name to match `android.os.Build .MANUFACTURER` (required).\nAllowed values listed in\n[manufacturer names](/zero -touch/resources/manufacturer-names).",
533 "type": "string" 847 "type": "string"
534 } 848 }
535 }, 849 },
536 "type": "object" 850 "type": "object"
537 }, 851 },
538 "Operation": { 852 "Operation": {
539 "description": "This resource represents a long-running operation th at is the result of a\nnetwork API call.", 853 "description": "This resource represents a long-running operation th at is the result of a\nnetwork API call.",
540 "id": "Operation", 854 "id": "Operation",
541 "properties": { 855 "properties": {
856 "done": {
857 "description": "If the value is `false`, it means the operat ion is still in progress.\nIf `true`, the operation is completed, and either `er ror` or `response` is\navailable.",
858 "type": "boolean"
859 },
542 "response": { 860 "response": {
543 "additionalProperties": { 861 "additionalProperties": {
544 "description": "Properties of the object. Contains field @type with type URL.", 862 "description": "Properties of the object. Contains field @type with type URL.",
545 "type": "any" 863 "type": "any"
546 }, 864 },
547 "description": "This field will contain a `DevicesLongRunnin gOperationResponse` object if the operation is created by `claimAsync`, `unclaim Async`, or `updateMetadataAsync`.", 865 "description": "This field will contain a `DevicesLongRunnin gOperationResponse` object if the operation is created by `claimAsync`, `unclaim Async`, or `updateMetadataAsync`.",
548 "type": "object" 866 "type": "object"
549 }, 867 },
550 "name": { 868 "name": {
551 "description": "The server-assigned name, which is only uniq ue within the same service that\noriginally returns it. If you use the default H TTP mapping, the\n`name` should have the format of `operations/some/unique/name` .", 869 "description": "The server-assigned name, which is only uniq ue within the same service that\noriginally returns it. If you use the default H TTP mapping, the\n`name` should have the format of `operations/some/unique/name` .",
552 "type": "string" 870 "type": "string"
553 }, 871 },
554 "error": { 872 "error": {
555 "$ref": "Status", 873 "$ref": "Status",
556 "description": "This field will always be not set if the ope ration is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. In this case, error information for each device is set in `response.perDeviceStatus .result.status`." 874 "description": "This field will always be not set if the ope ration is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. In this case, error information for each device is set in `response.perDeviceStatus .result.status`."
557 }, 875 },
558 "metadata": { 876 "metadata": {
559 "additionalProperties": { 877 "additionalProperties": {
560 "description": "Properties of the object. Contains field @type with type URL.", 878 "description": "Properties of the object. Contains field @type with type URL.",
561 "type": "any" 879 "type": "any"
562 }, 880 },
563 "description": "This field will contain a `DevicesLongRunnin gOperationMetadata` object if the operation is created by `claimAsync`, `unclaim Async`, or `updateMetadataAsync`.", 881 "description": "This field will contain a `DevicesLongRunnin gOperationMetadata` object if the operation is created by `claimAsync`, `unclaim Async`, or `updateMetadataAsync`.",
564 "type": "object" 882 "type": "object"
565 },
566 "done": {
567 "description": "If the value is `false`, it means the operat ion is still in progress.\nIf true, the operation is completed, and either `erro r` or `response` is\navailable.",
568 "type": "boolean"
569 }
570 },
571 "type": "object"
572 },
573 "DeviceIdentifier": {
574 "description": "DeviceIdentifiers identifies an unique device.",
575 "id": "DeviceIdentifier",
576 "properties": {
577 "manufacturer": {
578 "description": "Manufacturer name to match `android.os.Build .MANUFACTURER` (required).\nAllowed values listed in\n[manufacturer names](/zero -touch/resources/manufacturer-names).",
579 "type": "string"
580 },
581 "meid": {
582 "description": "MEID",
583 "type": "string"
584 },
585 "serialNumber": {
586 "description": "Serial number (optional)",
587 "type": "string"
588 },
589 "imei": {
590 "description": "IMEI (either IMEI or MEID is required).",
591 "type": "string"
592 } 883 }
593 }, 884 },
594 "type": "object" 885 "type": "object"
595 }, 886 },
596 "UnclaimDevicesRequest": { 887 "UnclaimDevicesRequest": {
597 "description": "Request to unclaim devices asynchronously in batch." , 888 "description": "Request to unclaim devices asynchronously in batch." ,
598 "id": "UnclaimDevicesRequest", 889 "id": "UnclaimDevicesRequest",
599 "properties": { 890 "properties": {
600 "unclaims": { 891 "unclaims": {
601 "description": "list of unclaims.", 892 "description": "List of devices to unclaim.",
602 "items": { 893 "items": {
603 "$ref": "PartnerUnclaim" 894 "$ref": "PartnerUnclaim"
604 }, 895 },
605 "type": "array" 896 "type": "array"
606 } 897 }
607 }, 898 },
608 "type": "object" 899 "type": "object"
609 }, 900 },
610 "FindDevicesByDeviceIdentifierRequest": {
611 "description": "Request to find devices.",
612 "id": "FindDevicesByDeviceIdentifierRequest",
613 "properties": {
614 "deviceIdentifier": {
615 "$ref": "DeviceIdentifier",
616 "description": "The device identifier to search"
617 },
618 "pageToken": {
619 "description": "Page token",
620 "type": "string"
621 },
622 "limit": {
623 "description": "Number of devices to show.",
624 "format": "int64",
625 "type": "string"
626 }
627 },
628 "type": "object"
629 },
630 "Status": { 901 "Status": {
631 "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RP C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie ces of data: error code, error message,\nand error details. The error code shoul d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message tha t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa cing\nerror message is needed, put the localized message in the error details or \nlocalize it in the client. The optional error details may contain arbitrary\ni nformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Lang uage mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` mess age is\nexposed in different client libraries and different wire protocols, it c an be\nmapped differently. For example, it will likely be mapped to some excepti ons\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n \nThe error model and the `Status` message can be used in a variety of\nenvironm ents, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n - Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step m ay\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\ n- Asynchronous operations. If an API call embeds asynchronous operation\n re sults in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are store d in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.", 902 "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RP C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie ces of data: error code, error message,\nand error details. The error code shoul d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message tha t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa cing\nerror message is needed, put the localized message in the error details or \nlocalize it in the client. The optional error details may contain arbitrary\ni nformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Lang uage mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` mess age is\nexposed in different client libraries and different wire protocols, it c an be\nmapped differently. For example, it will likely be mapped to some excepti ons\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n \nThe error model and the `Status` message can be used in a variety of\nenvironm ents, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n - Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step m ay\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\ n- Asynchronous operations. If an API call embeds asynchronous operation\n re sults in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are store d in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
632 "id": "Status", 903 "id": "Status",
633 "properties": { 904 "properties": {
634 "details": { 905 "details": {
635 "description": "A list of messages that carry the error deta ils. There is a common set of\nmessage types for APIs to use.", 906 "description": "A list of messages that carry the error deta ils. There is a common set of\nmessage types for APIs to use.",
636 "items": { 907 "items": {
637 "additionalProperties": { 908 "additionalProperties": {
638 "description": "Properties of the object. Contains f ield @type with type URL.", 909 "description": "Properties of the object. Contains f ield @type with type URL.",
639 "type": "any" 910 "type": "any"
640 }, 911 },
641 "type": "object" 912 "type": "object"
642 }, 913 },
643 "type": "array" 914 "type": "array"
644 }, 915 },
645 "code": { 916 "code": {
646 "description": "The status code, which should be an enum val ue of google.rpc.Code.", 917 "description": "The status code, which should be an enum val ue of google.rpc.Code.",
647 "format": "int32", 918 "format": "int32",
648 "type": "integer" 919 "type": "integer"
649 }, 920 },
650 "message": { 921 "message": {
651 "description": "A developer-facing error message, which shou ld be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.", 922 "description": "A developer-facing error message, which shou ld be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
652 "type": "string" 923 "type": "string"
653 } 924 }
654 }, 925 },
655 "type": "object" 926 "type": "object"
656 }, 927 },
928 "FindDevicesByDeviceIdentifierRequest": {
929 "description": "Request to find devices.",
930 "id": "FindDevicesByDeviceIdentifierRequest",
931 "properties": {
932 "deviceIdentifier": {
933 "$ref": "DeviceIdentifier",
934 "description": "The device identifier to search."
935 },
936 "pageToken": {
937 "description": "Page token.",
938 "type": "string"
939 },
940 "limit": {
941 "description": "Number of devices to show.",
942 "format": "int64",
943 "type": "string"
944 }
945 },
946 "type": "object"
947 },
657 "OperationPerDevice": { 948 "OperationPerDevice": {
658 "description": "Operation the server received for every device.", 949 "description": "Operation the server received for every device.",
659 "id": "OperationPerDevice", 950 "id": "OperationPerDevice",
660 "properties": { 951 "properties": {
952 "updateMetadata": {
953 "$ref": "UpdateMetadataArguments",
954 "description": "Request to set metadata for a device."
955 },
956 "unclaim": {
957 "$ref": "PartnerUnclaim",
958 "description": "Request to unclaim a device."
959 },
960 "result": {
961 "$ref": "PerDeviceStatusInBatch",
962 "description": "Processing result for every device."
963 },
661 "claim": { 964 "claim": {
662 "$ref": "PartnerClaim", 965 "$ref": "PartnerClaim",
663 "description": "Request to claim a device." 966 "description": "Request to claim a device."
664 },
665 "updateMetadata": {
666 "$ref": "UpdateMetadataArguments",
667 "description": "Request to set metadata for a device."
668 },
669 "result": {
670 "$ref": "PerDeviceStatusInBatch",
671 "description": "Processing result for every device."
672 },
673 "unclaim": {
674 "$ref": "PartnerUnclaim",
675 "description": "Request to unclaim a device."
676 } 967 }
677 }, 968 },
678 "type": "object" 969 "type": "object"
679 }, 970 },
680 "FindDevicesByOwnerResponse": { 971 "FindDevicesByOwnerResponse": {
681 "description": "Response containing found devices.", 972 "description": "Response containing found devices.",
682 "id": "FindDevicesByOwnerResponse", 973 "id": "FindDevicesByOwnerResponse",
683 "properties": { 974 "properties": {
975 "nextPageToken": {
976 "description": "Page token of the next page.",
977 "type": "string"
978 },
684 "devices": { 979 "devices": {
685 "description": "Devices found.", 980 "description": "Devices found.",
686 "items": { 981 "items": {
687 "$ref": "Device" 982 "$ref": "Device"
688 }, 983 },
689 "type": "array"
690 },
691 "nextPageToken": {
692 "description": "Page token of next page",
693 "type": "string"
694 }
695 },
696 "type": "object"
697 },
698 "ClaimDeviceRequest": {
699 "description": "Request message to claim a device on behalf of a cus tomer.",
700 "id": "ClaimDeviceRequest",
701 "properties": {
702 "deviceIdentifier": {
703 "$ref": "DeviceIdentifier",
704 "description": "The device identifier of the device to claim ."
705 },
706 "sectionType": {
707 "description": "Section to claim",
708 "enum": [
709 "SECTION_TYPE_UNSPECIFIED",
710 "SECTION_TYPE_ZERO_TOUCH"
711 ],
712 "enumDescriptions": [
713 "Unspecified",
714 "Zero touch"
715 ],
716 "type": "string"
717 },
718 "customerId": {
719 "description": "The customer to claim for.",
720 "format": "int64",
721 "type": "string"
722 }
723 },
724 "type": "object"
725 },
726 "DevicesLongRunningOperationMetadata": {
727 "description": "Long running operation metadata.",
728 "id": "DevicesLongRunningOperationMetadata",
729 "properties": {
730 "processingStatus": {
731 "description": "The overall processing status.",
732 "enum": [
733 "BATCH_PROCESS_STATUS_UNSPECIFIED",
734 "BATCH_PROCESS_PENDING",
735 "BATCH_PROCESS_IN_PROGRESS",
736 "BATCH_PROCESS_PROCESSED"
737 ],
738 "enumDescriptions": [
739 "Invalid code. Shouldn't be used.",
740 "Pending",
741 "In progress",
742 "Processed.\nThis doesn't mean all items were processed sucessfully, you should\ncheck the `response` field for the result of every item ."
743 ],
744 "type": "string"
745 },
746 "progress": {
747 "description": "Processing progress from 0 to 100.",
748 "format": "int32",
749 "type": "integer"
750 },
751 "devicesCount": {
752 "description": "Number of devices parsed in your requests.",
753 "format": "int32",
754 "type": "integer"
755 }
756 },
757 "type": "object"
758 },
759 "UpdateDeviceMetadataInBatchRequest": {
760 "description": "Request to update device metadata in batch.",
761 "id": "UpdateDeviceMetadataInBatchRequest",
762 "properties": {
763 "updates": {
764 "description": "list of metadata updates.",
765 "items": {
766 "$ref": "UpdateMetadataArguments"
767 },
768 "type": "array"
769 }
770 },
771 "type": "object"
772 },
773 "ClaimDeviceResponse": {
774 "description": "Response message containing device id of the claim." ,
775 "id": "ClaimDeviceResponse",
776 "properties": {
777 "deviceId": {
778 "description": "the device id of the claimed device.",
779 "format": "int64",
780 "type": "string"
781 },
782 "deviceName": {
783 "description": "the resource name of the device in\n'partner s/[PARTNER_ID]/devices/[DEVICE_ID]'.",
784 "type": "string"
785 }
786 },
787 "type": "object"
788 },
789 "ListCustomersResponse": {
790 "description": "Response message of all customers related to this pa rtner.",
791 "id": "ListCustomersResponse",
792 "properties": {
793 "customers": {
794 "description": "List of customers related to this partner.",
795 "items": {
796 "$ref": "Company"
797 },
798 "type": "array"
799 }
800 },
801 "type": "object"
802 },
803 "UpdateMetadataArguments": {
804 "description": "Identifies metdata updates to one device.",
805 "id": "UpdateMetadataArguments",
806 "properties": {
807 "deviceMetadata": {
808 "$ref": "DeviceMetadata",
809 "description": "The metadata to update."
810 },
811 "deviceIdentifier": {
812 "$ref": "DeviceIdentifier",
813 "description": "device identifier."
814 },
815 "deviceId": {
816 "description": "device id of the device.",
817 "format": "int64",
818 "type": "string"
819 }
820 },
821 "type": "object"
822 },
823 "Device": {
824 "description": "Device",
825 "id": "Device",
826 "properties": {
827 "deviceMetadata": {
828 "$ref": "DeviceMetadata",
829 "description": "Device metadata"
830 },
831 "deviceIdentifier": {
832 "$ref": "DeviceIdentifier",
833 "description": "Device identifier"
834 },
835 "name": {
836 "description": "Resource name in 'partners/[PARTNER_ID]/devi ces/[DEVICE_ID]'.",
837 "type": "string"
838 },
839 "claims": {
840 "description": "claims",
841 "items": {
842 "$ref": "DeviceClaim"
843 },
844 "type": "array"
845 },
846 "deviceId": {
847 "description": "Device id",
848 "format": "int64",
849 "type": "string"
850 }
851 },
852 "type": "object"
853 },
854 "Company": {
855 "description": "Company",
856 "id": "Company",
857 "properties": {
858 "companyName": {
859 "description": "company name",
860 "type": "string"
861 },
862 "companyId": {
863 "description": "company id",
864 "format": "int64",
865 "type": "string"
866 }
867 },
868 "type": "object"
869 },
870 "UpdateDeviceMetadataRequest": {
871 "description": "Request to set metadata for a device.",
872 "id": "UpdateDeviceMetadataRequest",
873 "properties": {
874 "deviceMetadata": {
875 "$ref": "DeviceMetadata",
876 "description": "The metdata to set."
877 }
878 },
879 "type": "object"
880 },
881 "PartnerUnclaim": {
882 "description": "Identifies one unclaim request.",
883 "id": "PartnerUnclaim",
884 "properties": {
885 "deviceId": {
886 "description": "device id of the device.",
887 "format": "int64",
888 "type": "string"
889 },
890 "deviceIdentifier": {
891 "$ref": "DeviceIdentifier",
892 "description": "device identifier of the device."
893 },
894 "sectionType": {
895 "description": "section type to unclaim.",
896 "enum": [
897 "SECTION_TYPE_UNSPECIFIED",
898 "SECTION_TYPE_ZERO_TOUCH"
899 ],
900 "enumDescriptions": [
901 "Unspecified",
902 "Zero touch"
903 ],
904 "type": "string"
905 }
906 },
907 "type": "object"
908 },
909 "Empty": {
910 "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use i t as the request\nor the response type of an API method. For instance:\n\n se rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty );\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
911 "id": "Empty",
912 "properties": {},
913 "type": "object"
914 },
915 "FindDevicesByDeviceIdentifierResponse": {
916 "description": "Response containing found devices.",
917 "id": "FindDevicesByDeviceIdentifierResponse",
918 "properties": {
919 "nextPageToken": {
920 "description": "Page token of next page",
921 "type": "string"
922 },
923 "devices": {
924 "description": "Found devices.",
925 "items": {
926 "$ref": "Device"
927 },
928 "type": "array" 984 "type": "array"
929 } 985 }
930 }, 986 },
931 "type": "object" 987 "type": "object"
932 }, 988 },
933 "PartnerClaim": { 989 "ClaimDeviceRequest": {
934 "description": "Identifies one claim request.", 990 "description": "Request message to claim a device on behalf of a cus tomer.",
935 "id": "PartnerClaim", 991 "id": "ClaimDeviceRequest",
936 "properties": { 992 "properties": {
937 "deviceMetadata": { 993 "customerId": {
938 "$ref": "DeviceMetadata", 994 "description": "The customer to claim for.",
939 "description": "metadata to set at claim." 995 "format": "int64",
996 "type": "string"
940 }, 997 },
941 "deviceIdentifier": { 998 "deviceIdentifier": {
942 "$ref": "DeviceIdentifier", 999 "$ref": "DeviceIdentifier",
943 "description": "Device identifier of the device." 1000 "description": "The device identifier of the device to claim ."
944 }, 1001 },
945 "sectionType": { 1002 "sectionType": {
946 "description": "section type to claim.", 1003 "description": "The section to claim.",
947 "enum": [ 1004 "enum": [
948 "SECTION_TYPE_UNSPECIFIED", 1005 "SECTION_TYPE_UNSPECIFIED",
949 "SECTION_TYPE_ZERO_TOUCH" 1006 "SECTION_TYPE_ZERO_TOUCH"
950 ], 1007 ],
951 "enumDescriptions": [ 1008 "enumDescriptions": [
952 "Unspecified", 1009 "Unspecified section type.",
953 "Zero touch" 1010 "Zero touch section type."
954 ], 1011 ],
955 "type": "string" 1012 "type": "string"
956 },
957 "customerId": {
958 "description": "customer id to claim for.",
959 "format": "int64",
960 "type": "string"
961 } 1013 }
962 }, 1014 },
963 "type": "object" 1015 "type": "object"
964 }, 1016 },
965 "UnclaimDeviceRequest": { 1017 "DevicesLongRunningOperationMetadata": {
966 "description": "Request message to unclaim a device.", 1018 "description": "Long running operation metadata.",
967 "id": "UnclaimDeviceRequest", 1019 "id": "DevicesLongRunningOperationMetadata",
968 "properties": { 1020 "properties": {
969 "deviceIdentifier": { 1021 "devicesCount": {
970 "$ref": "DeviceIdentifier", 1022 "description": "Number of devices parsed in your requests.",
971 "description": "The device identifier you use when you claim ed this device." 1023 "format": "int32",
1024 "type": "integer"
972 }, 1025 },
973 "sectionType": { 1026 "processingStatus": {
974 "description": "The section type to unclaim for.", 1027 "description": "The overall processing status.",
975 "enum": [ 1028 "enum": [
976 "SECTION_TYPE_UNSPECIFIED", 1029 "BATCH_PROCESS_STATUS_UNSPECIFIED",
977 "SECTION_TYPE_ZERO_TOUCH" 1030 "BATCH_PROCESS_PENDING",
1031 "BATCH_PROCESS_IN_PROGRESS",
1032 "BATCH_PROCESS_PROCESSED"
978 ], 1033 ],
979 "enumDescriptions": [ 1034 "enumDescriptions": [
980 "Unspecified", 1035 "Invalid code. Shouldn't be used.",
981 "Zero touch" 1036 "Pending.",
1037 "In progress.",
1038 "Processed.\nThis doesn't mean all items were processed sucessfully, you should\ncheck the `response` field for the result of every item ."
982 ], 1039 ],
983 "type": "string" 1040 "type": "string"
984 }, 1041 },
985 "deviceId": { 1042 "progress": {
986 "description": "The device id returned by ClaimDevice.", 1043 "description": "Processing progress from 0 to 100.",
987 "format": "int64", 1044 "format": "int32",
988 "type": "string" 1045 "type": "integer"
989 } 1046 }
990 }, 1047 },
991 "type": "object" 1048 "type": "object"
992 }, 1049 },
993 "DeviceMetadata": { 1050 "UpdateDeviceMetadataInBatchRequest": {
994 "description": "metadata", 1051 "description": "Request to update device metadata in batch.",
995 "id": "DeviceMetadata", 1052 "id": "UpdateDeviceMetadataInBatchRequest",
996 "properties": { 1053 "properties": {
997 "entries": { 1054 "updates": {
998 "additionalProperties": { 1055 "description": "List of metadata updates.",
999 "type": "string" 1056 "items": {
1057 "$ref": "UpdateMetadataArguments"
1000 }, 1058 },
1001 "description": "Metadata entries", 1059 "type": "array"
1002 "type": "object"
1003 } 1060 }
1004 }, 1061 },
1005 "type": "object" 1062 "type": "object"
1006 } 1063 }
1007 }, 1064 },
1008 "servicePath": "", 1065 "servicePath": "",
1009 "title": "Android Device Provisioning Partner API", 1066 "title": "Android Device Provisioning Partner API",
1010 "version": "v1" 1067 "version": "v1"
1011 } 1068 }
OLDNEW
« no previous file with comments | « discovery/googleapis/analyticsreporting__v4.json ('k') | discovery/googleapis/androidenterprise__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698