| OLD | NEW |
|---|
| (Empty) | |
| 1 { |
| 2 "basePath": "", |
| 3 "baseUrl": "https://androiddeviceprovisioning.googleapis.com/", |
| 4 "batchPath": "batch", |
| 5 "canonicalName": "Android Provisioning Partner", |
| 6 "description": "Android Device Provisioning Partner API", |
| 7 "discoveryVersion": "v1", |
| 8 "documentationLink": "https://developers.google.com/zero-touch/", |
| 9 "icons": { |
| 10 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| 11 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| 12 }, |
| 13 "id": "androiddeviceprovisioning:v1", |
| 14 "kind": "discovery#restDescription", |
| 15 "name": "androiddeviceprovisioning", |
| 16 "ownerDomain": "google.com", |
| 17 "ownerName": "Google", |
| 18 "parameters": { |
| 19 "quotaUser": { |
| 20 "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.", |
| 21 "location": "query", |
| 22 "type": "string" |
| 23 }, |
| 24 "pp": { |
| 25 "default": "true", |
| 26 "description": "Pretty-print response.", |
| 27 "location": "query", |
| 28 "type": "boolean" |
| 29 }, |
| 30 "oauth_token": { |
| 31 "description": "OAuth 2.0 token for the current user.", |
| 32 "location": "query", |
| 33 "type": "string" |
| 34 }, |
| 35 "bearer_token": { |
| 36 "description": "OAuth bearer token.", |
| 37 "location": "query", |
| 38 "type": "string" |
| 39 }, |
| 40 "upload_protocol": { |
| 41 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
| 42 "location": "query", |
| 43 "type": "string" |
| 44 }, |
| 45 "prettyPrint": { |
| 46 "default": "true", |
| 47 "description": "Returns response with indentations and line breaks."
, |
| 48 "location": "query", |
| 49 "type": "boolean" |
| 50 }, |
| 51 "uploadType": { |
| 52 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
| 53 "location": "query", |
| 54 "type": "string" |
| 55 }, |
| 56 "fields": { |
| 57 "description": "Selector specifying which fields to include in a par
tial response.", |
| 58 "location": "query", |
| 59 "type": "string" |
| 60 }, |
| 61 "$.xgafv": { |
| 62 "description": "V1 error format.", |
| 63 "enum": [ |
| 64 "1", |
| 65 "2" |
| 66 ], |
| 67 "enumDescriptions": [ |
| 68 "v1 error format", |
| 69 "v2 error format" |
| 70 ], |
| 71 "location": "query", |
| 72 "type": "string" |
| 73 }, |
| 74 "callback": { |
| 75 "description": "JSONP", |
| 76 "location": "query", |
| 77 "type": "string" |
| 78 }, |
| 79 "alt": { |
| 80 "default": "json", |
| 81 "description": "Data format for response.", |
| 82 "enum": [ |
| 83 "json", |
| 84 "media", |
| 85 "proto" |
| 86 ], |
| 87 "enumDescriptions": [ |
| 88 "Responses with Content-Type of application/json", |
| 89 "Media download with context-dependent Content-Type", |
| 90 "Responses with Content-Type of application/x-protobuf" |
| 91 ], |
| 92 "location": "query", |
| 93 "type": "string" |
| 94 }, |
| 95 "access_token": { |
| 96 "description": "OAuth access token.", |
| 97 "location": "query", |
| 98 "type": "string" |
| 99 }, |
| 100 "key": { |
| 101 "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.", |
| 102 "location": "query", |
| 103 "type": "string" |
| 104 } |
| 105 }, |
| 106 "protocol": "rest", |
| 107 "resources": { |
| 108 "partners": { |
| 109 "resources": { |
| 110 "devices": { |
| 111 "methods": { |
| 112 "unclaim": { |
| 113 "description": "Unclaim the device identified by dev
ice_id or identifier.", |
| 114 "httpMethod": "POST", |
| 115 "id": "androiddeviceprovisioning.partners.devices.un
claim", |
| 116 "parameterOrder": [ |
| 117 "partnerId" |
| 118 ], |
| 119 "parameters": { |
| 120 "partnerId": { |
| 121 "description": "Id of the partner.", |
| 122 "format": "int64", |
| 123 "location": "path", |
| 124 "pattern": "^[^/]+$", |
| 125 "required": true, |
| 126 "type": "string" |
| 127 } |
| 128 }, |
| 129 "path": "v1/partners/{+partnerId}/devices:unclaim", |
| 130 "request": { |
| 131 "$ref": "UnclaimDeviceRequest" |
| 132 }, |
| 133 "response": { |
| 134 "$ref": "Empty" |
| 135 } |
| 136 }, |
| 137 "findByOwner": { |
| 138 "description": "Find devices by ownership.", |
| 139 "httpMethod": "POST", |
| 140 "id": "androiddeviceprovisioning.partners.devices.fi
ndByOwner", |
| 141 "parameterOrder": [ |
| 142 "partnerId" |
| 143 ], |
| 144 "parameters": { |
| 145 "partnerId": { |
| 146 "description": "id of the partner.", |
| 147 "format": "int64", |
| 148 "location": "path", |
| 149 "pattern": "^[^/]+$", |
| 150 "required": true, |
| 151 "type": "string" |
| 152 } |
| 153 }, |
| 154 "path": "v1/partners/{+partnerId}/devices:findByOwne
r", |
| 155 "request": { |
| 156 "$ref": "FindDevicesByOwnerRequest" |
| 157 }, |
| 158 "response": { |
| 159 "$ref": "FindDevicesByOwnerResponse" |
| 160 } |
| 161 }, |
| 162 "claim": { |
| 163 "description": "Claim the device identified by devic
e identifier.", |
| 164 "httpMethod": "POST", |
| 165 "id": "androiddeviceprovisioning.partners.devices.cl
aim", |
| 166 "parameterOrder": [ |
| 167 "partnerId" |
| 168 ], |
| 169 "parameters": { |
| 170 "partnerId": { |
| 171 "description": "Id of the partner.", |
| 172 "format": "int64", |
| 173 "location": "path", |
| 174 "pattern": "^[^/]+$", |
| 175 "required": true, |
| 176 "type": "string" |
| 177 } |
| 178 }, |
| 179 "path": "v1/partners/{+partnerId}/devices:claim", |
| 180 "request": { |
| 181 "$ref": "ClaimDeviceRequest" |
| 182 }, |
| 183 "response": { |
| 184 "$ref": "ClaimDeviceResponse" |
| 185 } |
| 186 }, |
| 187 "claimAsync": { |
| 188 "description": "Claim devices asynchronously", |
| 189 "httpMethod": "POST", |
| 190 "id": "androiddeviceprovisioning.partners.devices.cl
aimAsync", |
| 191 "parameterOrder": [ |
| 192 "partnerId" |
| 193 ], |
| 194 "parameters": { |
| 195 "partnerId": { |
| 196 "description": "partner id.", |
| 197 "format": "int64", |
| 198 "location": "path", |
| 199 "pattern": "^[^/]+$", |
| 200 "required": true, |
| 201 "type": "string" |
| 202 } |
| 203 }, |
| 204 "path": "v1/partners/{+partnerId}/devices:claimAsync
", |
| 205 "request": { |
| 206 "$ref": "ClaimDevicesRequest" |
| 207 }, |
| 208 "response": { |
| 209 "$ref": "Operation" |
| 210 } |
| 211 }, |
| 212 "findByIdentifier": { |
| 213 "description": "Find devices by device identifier.", |
| 214 "httpMethod": "POST", |
| 215 "id": "androiddeviceprovisioning.partners.devices.fi
ndByIdentifier", |
| 216 "parameterOrder": [ |
| 217 "partnerId" |
| 218 ], |
| 219 "parameters": { |
| 220 "partnerId": { |
| 221 "description": "id of the partner.", |
| 222 "format": "int64", |
| 223 "location": "path", |
| 224 "pattern": "^[^/]+$", |
| 225 "required": true, |
| 226 "type": "string" |
| 227 } |
| 228 }, |
| 229 "path": "v1/partners/{+partnerId}/devices:findByIden
tifier", |
| 230 "request": { |
| 231 "$ref": "FindDevicesByDeviceIdentifierRequest" |
| 232 }, |
| 233 "response": { |
| 234 "$ref": "FindDevicesByDeviceIdentifierResponse" |
| 235 } |
| 236 }, |
| 237 "unclaimAsync": { |
| 238 "description": "Unclaim devices asynchronously", |
| 239 "httpMethod": "POST", |
| 240 "id": "androiddeviceprovisioning.partners.devices.un
claimAsync", |
| 241 "parameterOrder": [ |
| 242 "partnerId" |
| 243 ], |
| 244 "parameters": { |
| 245 "partnerId": { |
| 246 "description": "partner id.", |
| 247 "format": "int64", |
| 248 "location": "path", |
| 249 "pattern": "^[^/]+$", |
| 250 "required": true, |
| 251 "type": "string" |
| 252 } |
| 253 }, |
| 254 "path": "v1/partners/{+partnerId}/devices:unclaimAsy
nc", |
| 255 "request": { |
| 256 "$ref": "UnclaimDevicesRequest" |
| 257 }, |
| 258 "response": { |
| 259 "$ref": "Operation" |
| 260 } |
| 261 }, |
| 262 "metadata": { |
| 263 "description": "Update the metadata", |
| 264 "httpMethod": "POST", |
| 265 "id": "androiddeviceprovisioning.partners.devices.me
tadata", |
| 266 "parameterOrder": [ |
| 267 "metadataOwnerId", |
| 268 "deviceId" |
| 269 ], |
| 270 "parameters": { |
| 271 "metadataOwnerId": { |
| 272 "description": "The owner of the newly set m
etadata. Should be partner id itself.", |
| 273 "format": "int64", |
| 274 "location": "path", |
| 275 "pattern": "^[^/]+$", |
| 276 "required": true, |
| 277 "type": "string" |
| 278 }, |
| 279 "deviceId": { |
| 280 "description": "id of the partner.", |
| 281 "format": "int64", |
| 282 "location": "path", |
| 283 "pattern": "^[^/]+$", |
| 284 "required": true, |
| 285 "type": "string" |
| 286 } |
| 287 }, |
| 288 "path": "v1/partners/{+metadataOwnerId}/devices/{+de
viceId}/metadata", |
| 289 "request": { |
| 290 "$ref": "UpdateDeviceMetadataRequest" |
| 291 }, |
| 292 "response": { |
| 293 "$ref": "DeviceMetadata" |
| 294 } |
| 295 }, |
| 296 "updateMetadataAsync": { |
| 297 "description": "Set metadata in batch asynchronously
.", |
| 298 "httpMethod": "POST", |
| 299 "id": "androiddeviceprovisioning.partners.devices.up
dateMetadataAsync", |
| 300 "parameterOrder": [ |
| 301 "partnerId" |
| 302 ], |
| 303 "parameters": { |
| 304 "partnerId": { |
| 305 "description": "partner id.", |
| 306 "format": "int64", |
| 307 "location": "path", |
| 308 "pattern": "^[^/]+$", |
| 309 "required": true, |
| 310 "type": "string" |
| 311 } |
| 312 }, |
| 313 "path": "v1/partners/{+partnerId}/devices:updateMeta
dataAsync", |
| 314 "request": { |
| 315 "$ref": "UpdateDeviceMetadataInBatchRequest" |
| 316 }, |
| 317 "response": { |
| 318 "$ref": "Operation" |
| 319 } |
| 320 }, |
| 321 "get": { |
| 322 "description": "Get a device", |
| 323 "httpMethod": "GET", |
| 324 "id": "androiddeviceprovisioning.partners.devices.ge
t", |
| 325 "parameterOrder": [ |
| 326 "name" |
| 327 ], |
| 328 "parameters": { |
| 329 "name": { |
| 330 "description": "resource name in 'partners/[
PARTNER_ID]/devices/[DEVICE_ID]'.", |
| 331 "location": "path", |
| 332 "pattern": "^partners/[^/]+/devices/[^/]+$", |
| 333 "required": true, |
| 334 "type": "string" |
| 335 } |
| 336 }, |
| 337 "path": "v1/{+name}", |
| 338 "response": { |
| 339 "$ref": "Device" |
| 340 } |
| 341 } |
| 342 } |
| 343 }, |
| 344 "customers": { |
| 345 "methods": { |
| 346 "list": { |
| 347 "description": "List all the customers that has dele
gates some role to this customer.", |
| 348 "httpMethod": "GET", |
| 349 "id": "androiddeviceprovisioning.partners.customers.
list", |
| 350 "parameterOrder": [ |
| 351 "partnerId" |
| 352 ], |
| 353 "parameters": { |
| 354 "partnerId": { |
| 355 "description": "the id of the partner.", |
| 356 "format": "int64", |
| 357 "location": "path", |
| 358 "pattern": "^[^/]+$", |
| 359 "required": true, |
| 360 "type": "string" |
| 361 } |
| 362 }, |
| 363 "path": "v1/partners/{+partnerId}/customers", |
| 364 "response": { |
| 365 "$ref": "ListCustomersResponse" |
| 366 } |
| 367 } |
| 368 } |
| 369 } |
| 370 } |
| 371 }, |
| 372 "operations": { |
| 373 "methods": { |
| 374 "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.", |
| 376 "httpMethod": "GET", |
| 377 "id": "androiddeviceprovisioning.operations.get", |
| 378 "parameterOrder": [ |
| 379 "name" |
| 380 ], |
| 381 "parameters": { |
| 382 "name": { |
| 383 "description": "The name of the operation resource."
, |
| 384 "location": "path", |
| 385 "pattern": "^operations/.+$", |
| 386 "required": true, |
| 387 "type": "string" |
| 388 } |
| 389 }, |
| 390 "path": "v1/{+name}", |
| 391 "response": { |
| 392 "$ref": "Operation" |
| 393 } |
| 394 } |
| 395 } |
| 396 } |
| 397 }, |
| 398 "revision": "20170722", |
| 399 "rootUrl": "https://androiddeviceprovisioning.googleapis.com/", |
| 400 "schemas": { |
| 401 "Company": { |
| 402 "description": "Company", |
| 403 "id": "Company", |
| 404 "properties": { |
| 405 "companyId": { |
| 406 "description": "company id", |
| 407 "format": "int64", |
| 408 "type": "string" |
| 409 }, |
| 410 "companyName": { |
| 411 "description": "company name", |
| 412 "type": "string" |
| 413 } |
| 414 }, |
| 415 "type": "object" |
| 416 }, |
| 417 "UpdateDeviceMetadataRequest": { |
| 418 "description": "Request to set metadata for a device.", |
| 419 "id": "UpdateDeviceMetadataRequest", |
| 420 "properties": { |
| 421 "deviceMetadata": { |
| 422 "$ref": "DeviceMetadata", |
| 423 "description": "The metdata to set." |
| 424 } |
| 425 }, |
| 426 "type": "object" |
| 427 }, |
| 428 "PartnerUnclaim": { |
| 429 "description": "Identifies one unclaim request.", |
| 430 "id": "PartnerUnclaim", |
| 431 "properties": { |
| 432 "sectionType": { |
| 433 "description": "section type to unclaim.", |
| 434 "enum": [ |
| 435 "SECTION_TYPE_UNSPECIFIED", |
| 436 "SECTION_TYPE_ZERO_TOUCH" |
| 437 ], |
| 438 "enumDescriptions": [ |
| 439 "Unspecified", |
| 440 "Zero touch" |
| 441 ], |
| 442 "type": "string" |
| 443 }, |
| 444 "deviceId": { |
| 445 "description": "device id of the device.", |
| 446 "format": "int64", |
| 447 "type": "string" |
| 448 }, |
| 449 "deviceIdentifier": { |
| 450 "$ref": "DeviceIdentifier", |
| 451 "description": "device identifier of the device." |
| 452 } |
| 453 }, |
| 454 "type": "object" |
| 455 }, |
| 456 "Empty": { |
| 457 "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 `{}`.", |
| 458 "id": "Empty", |
| 459 "properties": {}, |
| 460 "type": "object" |
| 461 }, |
| 462 "FindDevicesByDeviceIdentifierResponse": { |
| 463 "description": "Response containing found devices.", |
| 464 "id": "FindDevicesByDeviceIdentifierResponse", |
| 465 "properties": { |
| 466 "nextPageToken": { |
| 467 "description": "Page token of next page", |
| 468 "type": "string" |
| 469 }, |
| 470 "devices": { |
| 471 "description": "Found devices.", |
| 472 "items": { |
| 473 "$ref": "Device" |
| 474 }, |
| 475 "type": "array" |
| 476 } |
| 477 }, |
| 478 "type": "object" |
| 479 }, |
| 480 "PartnerClaim": { |
| 481 "description": "Identifies one claim request.", |
| 482 "id": "PartnerClaim", |
| 483 "properties": { |
| 484 "deviceMetadata": { |
| 485 "$ref": "DeviceMetadata", |
| 486 "description": "metadata to set at claim." |
| 487 }, |
| 488 "deviceIdentifier": { |
| 489 "$ref": "DeviceIdentifier", |
| 490 "description": "Device identifier of the device." |
| 491 }, |
| 492 "sectionType": { |
| 493 "description": "section type to claim.", |
| 494 "enum": [ |
| 495 "SECTION_TYPE_UNSPECIFIED", |
| 496 "SECTION_TYPE_ZERO_TOUCH" |
| 497 ], |
| 498 "enumDescriptions": [ |
| 499 "Unspecified", |
| 500 "Zero touch" |
| 501 ], |
| 502 "type": "string" |
| 503 }, |
| 504 "customerId": { |
| 505 "description": "customer id to claim for.", |
| 506 "format": "int64", |
| 507 "type": "string" |
| 508 } |
| 509 }, |
| 510 "type": "object" |
| 511 }, |
| 512 "UnclaimDeviceRequest": { |
| 513 "description": "Request message to unclaim a device.", |
| 514 "id": "UnclaimDeviceRequest", |
| 515 "properties": { |
| 516 "deviceId": { |
| 517 "description": "The device id returned by ClaimDevice.", |
| 518 "format": "int64", |
| 519 "type": "string" |
| 520 }, |
| 521 "deviceIdentifier": { |
| 522 "$ref": "DeviceIdentifier", |
| 523 "description": "The device identifier you use when you claim
ed this device." |
| 524 }, |
| 525 "sectionType": { |
| 526 "description": "The section type to unclaim for.", |
| 527 "enum": [ |
| 528 "SECTION_TYPE_UNSPECIFIED", |
| 529 "SECTION_TYPE_ZERO_TOUCH" |
| 530 ], |
| 531 "enumDescriptions": [ |
| 532 "Unspecified", |
| 533 "Zero touch" |
| 534 ], |
| 535 "type": "string" |
| 536 } |
| 537 }, |
| 538 "type": "object" |
| 539 }, |
| 540 "DeviceMetadata": { |
| 541 "description": "metadata", |
| 542 "id": "DeviceMetadata", |
| 543 "properties": { |
| 544 "entries": { |
| 545 "additionalProperties": { |
| 546 "type": "string" |
| 547 }, |
| 548 "description": "Metadata entries", |
| 549 "type": "object" |
| 550 } |
| 551 }, |
| 552 "type": "object" |
| 553 }, |
| 554 "DeviceClaim": { |
| 555 "description": "containing the necessary info about a claim for a pa
rtner.", |
| 556 "id": "DeviceClaim", |
| 557 "properties": { |
| 558 "ownerCompanyId": { |
| 559 "description": "owner id", |
| 560 "format": "int64", |
| 561 "type": "string" |
| 562 }, |
| 563 "sectionType": { |
| 564 "description": "section type.", |
| 565 "enum": [ |
| 566 "SECTION_TYPE_UNSPECIFIED", |
| 567 "SECTION_TYPE_ZERO_TOUCH" |
| 568 ], |
| 569 "enumDescriptions": [ |
| 570 "Unspecified", |
| 571 "Zero touch" |
| 572 ], |
| 573 "type": "string" |
| 574 } |
| 575 }, |
| 576 "type": "object" |
| 577 }, |
| 578 "DevicesLongRunningOperationResponse": { |
| 579 "description": "Long running operation response.", |
| 580 "id": "DevicesLongRunningOperationResponse", |
| 581 "properties": { |
| 582 "successCount": { |
| 583 "description": "Number of succeesfully processed ones.", |
| 584 "format": "int32", |
| 585 "type": "integer" |
| 586 }, |
| 587 "perDeviceStatus": { |
| 588 "description": "processing status for each device.\nOne PerD
eviceStatus per device. The order is the same as in your requests.", |
| 589 "items": { |
| 590 "$ref": "OperationPerDevice" |
| 591 }, |
| 592 "type": "array" |
| 593 } |
| 594 }, |
| 595 "type": "object" |
| 596 }, |
| 597 "PerDeviceStatusInBatch": { |
| 598 "description": "Stores the processing result for each device.", |
| 599 "id": "PerDeviceStatusInBatch", |
| 600 "properties": { |
| 601 "errorMessage": { |
| 602 "description": "Error message", |
| 603 "type": "string" |
| 604 }, |
| 605 "deviceId": { |
| 606 "description": "device id of the device if process succeeds.
", |
| 607 "format": "int64", |
| 608 "type": "string" |
| 609 }, |
| 610 "status": { |
| 611 "description": "Process result.", |
| 612 "enum": [ |
| 613 "SINGLE_DEVICE_STATUS_UNSPECIFIED", |
| 614 "SINGLE_DEVICE_STATUS_UNKNOWN_ERROR", |
| 615 "SINGLE_DEVICE_STATUS_OTHER_ERROR", |
| 616 "SINGLE_DEVICE_STATUS_SUCCESS", |
| 617 "SINGLE_DEVICE_STATUS_PERMISSION_DENIED", |
| 618 "SINGLE_DEVICE_STATUS_INVALID_DEVICE_IDENTIFIER", |
| 619 "SINGLE_DEVICE_STATUS_INVALID_SECTION_TYPE", |
| 620 "SINGLE_DEVICE_STATUS_SECTION_NOT_YOURS" |
| 621 ], |
| 622 "enumDescriptions": [ |
| 623 "Invalid code. Shouldn' be used.", |
| 624 "Unknown error.\nUnknown error is we don't expect it her
e.", |
| 625 "Other error.\nOther error is we know/expect this error,
but not having proper error\ncode yet.", |
| 626 "Success.", |
| 627 "Permission denied", |
| 628 "Invalid device identifier.", |
| 629 "Invalid section type.", |
| 630 "This section is claimed by other company." |
| 631 ], |
| 632 "type": "string" |
| 633 }, |
| 634 "errorIdentifier": { |
| 635 "description": "Error identifier.", |
| 636 "type": "string" |
| 637 } |
| 638 }, |
| 639 "type": "object" |
| 640 }, |
| 641 "FindDevicesByOwnerRequest": { |
| 642 "description": "Request to find devices by customers.", |
| 643 "id": "FindDevicesByOwnerRequest", |
| 644 "properties": { |
| 645 "limit": { |
| 646 "description": "The number of devices to show in the result.
", |
| 647 "format": "int64", |
| 648 "type": "string" |
| 649 }, |
| 650 "sectionType": { |
| 651 "description": "The section type.", |
| 652 "enum": [ |
| 653 "SECTION_TYPE_UNSPECIFIED", |
| 654 "SECTION_TYPE_ZERO_TOUCH" |
| 655 ], |
| 656 "enumDescriptions": [ |
| 657 "Unspecified", |
| 658 "Zero touch" |
| 659 ], |
| 660 "type": "string" |
| 661 }, |
| 662 "pageToken": { |
| 663 "description": "Page token", |
| 664 "type": "string" |
| 665 }, |
| 666 "customerId": { |
| 667 "description": "List of customer ids to search for.", |
| 668 "items": { |
| 669 "format": "int64", |
| 670 "type": "string" |
| 671 }, |
| 672 "type": "array" |
| 673 } |
| 674 }, |
| 675 "type": "object" |
| 676 }, |
| 677 "ClaimDevicesRequest": { |
| 678 "description": "Request to claim devices asynchronously in batch.", |
| 679 "id": "ClaimDevicesRequest", |
| 680 "properties": { |
| 681 "claims": { |
| 682 "description": "list of claims.", |
| 683 "items": { |
| 684 "$ref": "PartnerClaim" |
| 685 }, |
| 686 "type": "array" |
| 687 } |
| 688 }, |
| 689 "type": "object" |
| 690 }, |
| 691 "Operation": { |
| 692 "description": "This resource represents a long-running operation th
at is the result of a\nnetwork API call.", |
| 693 "id": "Operation", |
| 694 "properties": { |
| 695 "done": { |
| 696 "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.", |
| 697 "type": "boolean" |
| 698 }, |
| 699 "response": { |
| 700 "additionalProperties": { |
| 701 "description": "Properties of the object. Contains field
@type with type URL.", |
| 702 "type": "any" |
| 703 }, |
| 704 "description": "This field will contain a `DevicesLongRunnin
gOperationResponse` object if the operation is created by `claimAsync`, `unclaim
Async`, or `updateMetadataAsync`.", |
| 705 "type": "object" |
| 706 }, |
| 707 "name": { |
| 708 "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`
.", |
| 709 "type": "string" |
| 710 }, |
| 711 "error": { |
| 712 "$ref": "Status", |
| 713 "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`." |
| 714 }, |
| 715 "metadata": { |
| 716 "additionalProperties": { |
| 717 "description": "Properties of the object. Contains field
@type with type URL.", |
| 718 "type": "any" |
| 719 }, |
| 720 "description": "This field will contain a `DevicesLongRunnin
gOperationMetadata` object if the operation is created by `claimAsync`, `unclaim
Async`, or `updateMetadataAsync`.", |
| 721 "type": "object" |
| 722 } |
| 723 }, |
| 724 "type": "object" |
| 725 }, |
| 726 "DeviceIdentifier": { |
| 727 "description": "DeviceIdentifiers identifies an unique device.", |
| 728 "id": "DeviceIdentifier", |
| 729 "properties": { |
| 730 "model": { |
| 731 "description": "Model to match android.os.Build.MODEL (requi
red).", |
| 732 "type": "string" |
| 733 }, |
| 734 "imei": { |
| 735 "description": "IMEI (either IMEI or MEID is required).", |
| 736 "type": "string" |
| 737 }, |
| 738 "manufacturer": { |
| 739 "description": "Manufacturer to match android.os.Build.MANUF
ACTURER (required).", |
| 740 "type": "string" |
| 741 }, |
| 742 "meid": { |
| 743 "description": "MEID", |
| 744 "type": "string" |
| 745 }, |
| 746 "serialNumber": { |
| 747 "description": "Serial number (optional)", |
| 748 "type": "string" |
| 749 } |
| 750 }, |
| 751 "type": "object" |
| 752 }, |
| 753 "UnclaimDevicesRequest": { |
| 754 "description": "Request to unclaim devices asynchronously in batch."
, |
| 755 "id": "UnclaimDevicesRequest", |
| 756 "properties": { |
| 757 "unclaims": { |
| 758 "description": "list of unclaims.", |
| 759 "items": { |
| 760 "$ref": "PartnerUnclaim" |
| 761 }, |
| 762 "type": "array" |
| 763 } |
| 764 }, |
| 765 "type": "object" |
| 766 }, |
| 767 "FindDevicesByDeviceIdentifierRequest": { |
| 768 "description": "Request to find devices.", |
| 769 "id": "FindDevicesByDeviceIdentifierRequest", |
| 770 "properties": { |
| 771 "deviceIdentifier": { |
| 772 "$ref": "DeviceIdentifier", |
| 773 "description": "The device identifier to search" |
| 774 }, |
| 775 "pageToken": { |
| 776 "description": "Page token", |
| 777 "type": "string" |
| 778 }, |
| 779 "limit": { |
| 780 "description": "Number of devices to show.", |
| 781 "format": "int64", |
| 782 "type": "string" |
| 783 } |
| 784 }, |
| 785 "type": "object" |
| 786 }, |
| 787 "Status": { |
| 788 "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.", |
| 789 "id": "Status", |
| 790 "properties": { |
| 791 "details": { |
| 792 "description": "A list of messages that carry the error deta
ils. There is a common set of\nmessage types for APIs to use.", |
| 793 "items": { |
| 794 "additionalProperties": { |
| 795 "description": "Properties of the object. Contains f
ield @type with type URL.", |
| 796 "type": "any" |
| 797 }, |
| 798 "type": "object" |
| 799 }, |
| 800 "type": "array" |
| 801 }, |
| 802 "code": { |
| 803 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", |
| 804 "format": "int32", |
| 805 "type": "integer" |
| 806 }, |
| 807 "message": { |
| 808 "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.", |
| 809 "type": "string" |
| 810 } |
| 811 }, |
| 812 "type": "object" |
| 813 }, |
| 814 "OperationPerDevice": { |
| 815 "description": "Operation the server received for every device.", |
| 816 "id": "OperationPerDevice", |
| 817 "properties": { |
| 818 "result": { |
| 819 "$ref": "PerDeviceStatusInBatch", |
| 820 "description": "Processing result for every device." |
| 821 }, |
| 822 "unclaim": { |
| 823 "$ref": "PartnerUnclaim", |
| 824 "description": "Request to unclaim a device." |
| 825 }, |
| 826 "claim": { |
| 827 "$ref": "PartnerClaim", |
| 828 "description": "Request to claim a device." |
| 829 }, |
| 830 "updateMetadata": { |
| 831 "$ref": "UpdateMetadataArguments", |
| 832 "description": "Request to set metadata for a device." |
| 833 } |
| 834 }, |
| 835 "type": "object" |
| 836 }, |
| 837 "FindDevicesByOwnerResponse": { |
| 838 "description": "Response containing found devices.", |
| 839 "id": "FindDevicesByOwnerResponse", |
| 840 "properties": { |
| 841 "devices": { |
| 842 "description": "Devices found.", |
| 843 "items": { |
| 844 "$ref": "Device" |
| 845 }, |
| 846 "type": "array" |
| 847 }, |
| 848 "nextPageToken": { |
| 849 "description": "Page token of next page", |
| 850 "type": "string" |
| 851 } |
| 852 }, |
| 853 "type": "object" |
| 854 }, |
| 855 "ClaimDeviceRequest": { |
| 856 "description": "Request message to claim a device on behalf of a cus
tomer.", |
| 857 "id": "ClaimDeviceRequest", |
| 858 "properties": { |
| 859 "deviceIdentifier": { |
| 860 "$ref": "DeviceIdentifier", |
| 861 "description": "The device identifier of the device to claim
." |
| 862 }, |
| 863 "sectionType": { |
| 864 "description": "Section to claim", |
| 865 "enum": [ |
| 866 "SECTION_TYPE_UNSPECIFIED", |
| 867 "SECTION_TYPE_ZERO_TOUCH" |
| 868 ], |
| 869 "enumDescriptions": [ |
| 870 "Unspecified", |
| 871 "Zero touch" |
| 872 ], |
| 873 "type": "string" |
| 874 }, |
| 875 "customerId": { |
| 876 "description": "The customer to claim for.", |
| 877 "format": "int64", |
| 878 "type": "string" |
| 879 } |
| 880 }, |
| 881 "type": "object" |
| 882 }, |
| 883 "DevicesLongRunningOperationMetadata": { |
| 884 "description": "Long running operation metadata.", |
| 885 "id": "DevicesLongRunningOperationMetadata", |
| 886 "properties": { |
| 887 "devicesCount": { |
| 888 "description": "Number of devices parsed in your requests.", |
| 889 "format": "int32", |
| 890 "type": "integer" |
| 891 }, |
| 892 "processingStatus": { |
| 893 "description": "The overall processing status.", |
| 894 "enum": [ |
| 895 "BATCH_PROCESS_STATUS_UNSPECIFIED", |
| 896 "BATCH_PROCESS_PENDING", |
| 897 "BATCH_PROCESS_IN_PROGRESS", |
| 898 "BATCH_PROCESS_PROCESSED" |
| 899 ], |
| 900 "enumDescriptions": [ |
| 901 "Invalid code. Shouldn't be used.", |
| 902 "Pending", |
| 903 "In progress", |
| 904 "Processed.\nThis doesn't mean all items were processed
sucessfully, you should\ncheck the `response` field for the result of every item
." |
| 905 ], |
| 906 "type": "string" |
| 907 }, |
| 908 "progress": { |
| 909 "description": "Processing progress from 0 to 100.", |
| 910 "format": "int32", |
| 911 "type": "integer" |
| 912 } |
| 913 }, |
| 914 "type": "object" |
| 915 }, |
| 916 "UpdateDeviceMetadataInBatchRequest": { |
| 917 "description": "Request to update device metadata in batch.", |
| 918 "id": "UpdateDeviceMetadataInBatchRequest", |
| 919 "properties": { |
| 920 "updates": { |
| 921 "description": "list of metadata updates.", |
| 922 "items": { |
| 923 "$ref": "UpdateMetadataArguments" |
| 924 }, |
| 925 "type": "array" |
| 926 } |
| 927 }, |
| 928 "type": "object" |
| 929 }, |
| 930 "ClaimDeviceResponse": { |
| 931 "description": "Response message containing device id of the claim."
, |
| 932 "id": "ClaimDeviceResponse", |
| 933 "properties": { |
| 934 "deviceId": { |
| 935 "description": "the device id of the claimed device.", |
| 936 "format": "int64", |
| 937 "type": "string" |
| 938 }, |
| 939 "deviceName": { |
| 940 "description": "the resource name of the device in\n'partner
s/[PARTNER_ID]/devices/[DEVICE_ID]'.", |
| 941 "type": "string" |
| 942 } |
| 943 }, |
| 944 "type": "object" |
| 945 }, |
| 946 "ListCustomersResponse": { |
| 947 "description": "Response message of all customers related to this pa
rtner.", |
| 948 "id": "ListCustomersResponse", |
| 949 "properties": { |
| 950 "customers": { |
| 951 "description": "List of customers related to this partner.", |
| 952 "items": { |
| 953 "$ref": "Company" |
| 954 }, |
| 955 "type": "array" |
| 956 } |
| 957 }, |
| 958 "type": "object" |
| 959 }, |
| 960 "UpdateMetadataArguments": { |
| 961 "description": "Identifies metdata updates to one device.", |
| 962 "id": "UpdateMetadataArguments", |
| 963 "properties": { |
| 964 "deviceMetadata": { |
| 965 "$ref": "DeviceMetadata", |
| 966 "description": "The metadata to update." |
| 967 }, |
| 968 "deviceIdentifier": { |
| 969 "$ref": "DeviceIdentifier", |
| 970 "description": "device identifier." |
| 971 }, |
| 972 "deviceId": { |
| 973 "description": "device id of the device.", |
| 974 "format": "int64", |
| 975 "type": "string" |
| 976 } |
| 977 }, |
| 978 "type": "object" |
| 979 }, |
| 980 "Device": { |
| 981 "description": "Device", |
| 982 "id": "Device", |
| 983 "properties": { |
| 984 "claims": { |
| 985 "description": "claims", |
| 986 "items": { |
| 987 "$ref": "DeviceClaim" |
| 988 }, |
| 989 "type": "array" |
| 990 }, |
| 991 "deviceId": { |
| 992 "description": "Device id", |
| 993 "format": "int64", |
| 994 "type": "string" |
| 995 }, |
| 996 "deviceMetadata": { |
| 997 "$ref": "DeviceMetadata", |
| 998 "description": "Device metadata" |
| 999 }, |
| 1000 "deviceIdentifier": { |
| 1001 "$ref": "DeviceIdentifier", |
| 1002 "description": "Device identifier" |
| 1003 }, |
| 1004 "name": { |
| 1005 "description": "Resource name in 'partners/[PARTNER_ID]/devi
ces/[DEVICE_ID]'.", |
| 1006 "type": "string" |
| 1007 } |
| 1008 }, |
| 1009 "type": "object" |
| 1010 } |
| 1011 }, |
| 1012 "servicePath": "", |
| 1013 "title": "Android Device Provisioning Partner API", |
| 1014 "version": "v1" |
| 1015 } |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 2987103002:
Api-Roll 52: 2017-07-31 (Closed)
