Method: partners.devices.claimAsync
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
reivindica um lote de dispositivos para um cliente de forma assíncrona. Adiciona os dispositivos ao registro sem toque. Para saber mais, leia Operações em lote de longa duração.
Solicitação HTTP
POST https://androiddeviceprovisioning.googleapis.com/v1/partners/{partnerId}/devices:claimAsync
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros |
partnerId |
string (int64 format)
Obrigatório. O ID do parceiro revendedor.
|
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
Representação JSON |
{
"claims": [
{
object (PartnerClaim )
}
]
} |
Campos |
claims[] |
object (PartnerClaim )
Obrigatório. Uma lista de reivindicações de dispositivos.
|
Corpo da resposta
Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Operation
.
Escopos de autorização
Requer o seguinte escopo OAuth:
https://www.googleapis.com/auth/androidworkprovisioning
Para mais informações, consulte a Visão geral do OAuth 2.0.
PartnerClaim
Identifica uma solicitação de reivindicação.
Representação JSON |
{
"deviceIdentifier": {
object (DeviceIdentifier )
},
"sectionType": enum (DeviceProvisioningSectionType ),
"deviceMetadata": {
object (DeviceMetadata )
},
"preProvisioningToken": string,
// Union field customer can be only one of the following:
"customerId": string,
"googleWorkspaceCustomerId": string
// End of list of possible types for union field customer .
} |
Campos |
deviceIdentifier |
object (DeviceIdentifier )
Obrigatório. Obrigatório. Identificador do dispositivo.
|
sectionType |
enum (DeviceProvisioningSectionType )
Obrigatório. O tipo de seção do registro de provisionamento do dispositivo.
|
deviceMetadata |
object (DeviceMetadata )
Obrigatório. Os metadados a serem anexados ao dispositivo na reivindicação.
|
preProvisioningToken |
string
Opcional. Precisa e só pode ser definido para dispositivos Chrome OS.
|
Campo de união customer . Obrigatório. O cliente para quem o dispositivo está sendo reivindicado. customer pode ser apenas de um dos tipos a seguir: |
customerId |
string (int64 format)
O ID do cliente para quem o dispositivo está sendo reivindicado.
|
googleWorkspaceCustomerId |
string
O ID de cliente do Google Workspace.
|
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-25 UTC.
[null,null,["Última atualização 2025-07-25 UTC."],[[["\u003cp\u003eThis endpoint \u003ccode\u003ePOST https://androiddeviceprovisioning.googleapis.com/v1/partners/{partnerId}/devices:claimAsync\u003c/code\u003e enables partners to asynchronously claim a batch of devices for a customer, adding them to zero-touch enrollment.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires a \u003ccode\u003epartnerId\u003c/code\u003e path parameter, which is the reseller partner's ID, and a request body with a list of device claims within the \u003ccode\u003eclaims\u003c/code\u003e field.\u003c/p\u003e\n"],["\u003cp\u003eEach device claim is identified by a \u003ccode\u003ePartnerClaim\u003c/code\u003e object, which contains the \u003ccode\u003edeviceIdentifier\u003c/code\u003e, \u003ccode\u003esectionType\u003c/code\u003e, \u003ccode\u003edeviceMetadata\u003c/code\u003e, and a customer identifier in the form of \u003ccode\u003ecustomerId\u003c/code\u003e or \u003ccode\u003egoogleWorkspaceCustomerId\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ePartnerClaim\u003c/code\u003e object optionally includes a \u003ccode\u003epreProvisioningToken\u003c/code\u003e and is required to complete the request.\u003c/p\u003e\n"],["\u003cp\u003eA successful request returns an \u003ccode\u003eOperation\u003c/code\u003e object, indicating that the long-running operation has been initiated.\u003c/p\u003e\n"]]],["This outlines how to claim devices for a customer asynchronously via the Android zero-touch enrollment API. Use a `POST` request to `https://androiddeviceprovisioning.googleapis.com/v1/partners/{partnerId}/devices:claimAsync`, providing the required `partnerId`. The request body, structured in JSON, includes a list of device `claims` with each claim containing the `deviceIdentifier`, `sectionType`, `deviceMetadata`, and the required customer's ID (`customerId` or `googleWorkspaceCustomerId`). The `preProvisioningToken` field is required only for ChromeOS devices. The response body contains an `Operation`.\n"],null,["# Method: partners.devices.claimAsync\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization Scopes](#body.aspect)\n- [PartnerClaim](#PartnerClaim)\n - [JSON representation](#PartnerClaim.SCHEMA_REPRESENTATION)\n\nClaims a batch of devices for a customer asynchronously. Adds the devices to zero-touch enrollment. To learn more, read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations).\n\n### HTTP request\n\n`POST https://androiddeviceprovisioning.googleapis.com/v1/partners/{partnerId}/devices:claimAsync`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------------|\n| `partnerId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Required. The ID of the reseller partner. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"claims\": [ { object (/zero-touch/reference/reseller/rest/v1/partners.devices/claimAsync#PartnerClaim) } ] } ``` |\n\n| Fields ||\n|------------|-------------------------------------------------------------------------------------------------------------------------------------------------|\n| `claims[]` | `object (`[PartnerClaim](/zero-touch/reference/reseller/rest/v1/partners.devices/claimAsync#PartnerClaim)`)` Required. A list of device claims. |\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/zero-touch/reference/reseller/rest/v1/operations#Operation).\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/androidworkprovisioning`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2).\n\nPartnerClaim\n------------\n\nIdentifies one claim request.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"deviceIdentifier\": { object (/zero-touch/reference/reseller/rest/v1/partners.devices#DeviceIdentifier) }, \"sectionType\": enum (/zero-touch/reference/reseller/rest/v1/partners.devices#DeviceProvisioningSectionType), \"deviceMetadata\": { object (/zero-touch/reference/reseller/rest/v1/partners.devices#DeviceMetadata) }, \"preProvisioningToken\": string, // Union field `customer` can be only one of the following: \"customerId\": string, \"googleWorkspaceCustomerId\": string // End of list of possible types for union field `customer`. } ``` |\n\n| Fields ||\n|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `deviceIdentifier` | `object (`[DeviceIdentifier](/zero-touch/reference/reseller/rest/v1/partners.devices#DeviceIdentifier)`)` Required. Required. Device identifier of the device. |\n| `sectionType` | `enum (`[DeviceProvisioningSectionType](/zero-touch/reference/reseller/rest/v1/partners.devices#DeviceProvisioningSectionType)`)` Required. The section type of the device's provisioning record. |\n| `deviceMetadata` | `object (`[DeviceMetadata](/zero-touch/reference/reseller/rest/v1/partners.devices#DeviceMetadata)`)` Required. The metadata to attach to the device at claim. |\n| `preProvisioningToken` | `string` Optional. Must and can only be set for Chrome OS devices. |\n| Union field `customer`. Required. The customer for whom the device is being claimed. `customer` can be only one of the following: ||\n| `customerId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The ID of the customer for whom the device is being claimed. |\n| `googleWorkspaceCustomerId` | `string` The Google Workspace customer ID. |"]]