Method: partners.devices.claim
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
为客户认领设备并将其添加到零触摸注册。如果该设备已被其他客户声明,则调用将返回错误。
HTTP 请求
POST https://androiddeviceprovisioning.googleapis.com/v1/partners/{partnerId}/devices:claim
网址采用 gRPC 转码语法。
路径参数
参数 |
partnerId |
string (int64 format)
必需。转销商合作伙伴的 ID。
|
请求正文
请求正文中包含结构如下的数据:
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 .
} |
字段 |
deviceIdentifier |
object (DeviceIdentifier )
必需。必需。要声明所有权的设备的标识符。
|
sectionType |
enum (DeviceProvisioningSectionType )
必需。设备配置记录所属的部分类型。
|
deviceMetadata |
object (DeviceMetadata )
可选。要附加到设备的元数据。
|
preProvisioningToken |
string
可选。必须且只能为 ChromeOS 设备设置。
|
联合字段 customer 。必需。声明设备所有权的客户。customer 只能是下列其中一项: |
customerId |
string (int64 format)
声明设备所有权的客户的 ID。
|
googleWorkspaceCustomerId |
string
Google Workspace 客户 ID。
|
响应正文
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
{
"deviceId": string,
"deviceName": string
} |
字段 |
deviceId |
string (int64 format)
已声明所有权的设备的 ID。
|
deviceName |
string
设备的资源名称,格式为 partners/[PARTNER_ID]/devices/[DEVICE_ID] 。
|
授权范围
需要以下 OAuth 范围:
https://www.googleapis.com/auth/androidworkprovisioning
如需了解详情,请参阅 OAuth 2.0 概览。
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-07-25。
[null,null,["最后更新时间 (UTC):2025-07-25。"],[[["\u003cp\u003eThis endpoint claims a device for a customer, adding it to zero-touch enrollment, and returns an error if the device is already claimed by another customer.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request to claim a device is a POST request to \u003ccode\u003ehttps://androiddeviceprovisioning.googleapis.com/v1/partners/{partnerId}/devices:claim\u003c/code\u003e, requiring the reseller partner's ID in the path parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must include the \u003ccode\u003edeviceIdentifier\u003c/code\u003e, \u003ccode\u003esectionType\u003c/code\u003e, and the customer's ID (\u003ccode\u003ecustomerId\u003c/code\u003e or \u003ccode\u003egoogleWorkspaceCustomerId\u003c/code\u003e), along with optional fields such as \u003ccode\u003edeviceMetadata\u003c/code\u003e and \u003ccode\u003epreProvisioningToken\u003c/code\u003e for Chrome OS devices.\u003c/p\u003e\n"],["\u003cp\u003eA successful response contains the \u003ccode\u003edeviceId\u003c/code\u003e of the claimed device and its resource name in the format \u003ccode\u003epartners/[PARTNER_ID]/devices/[DEVICE_ID]\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThis action requires the OAuth scope \u003ccode\u003ehttps://www.googleapis.com/auth/androidworkprovisioning\u003c/code\u003e for authorization.\u003c/p\u003e\n"]]],["This describes claiming a device for a customer via a `POST` request to `https://androiddeviceprovisioning.googleapis.com/v1/partners/{partnerId}/devices:claim`. The request requires a `partnerId` and a body specifying the `deviceIdentifier`, `sectionType`, and the customer using either `customerId` or `googleWorkspaceCustomerId`. Optional fields include `deviceMetadata` and `preProvisioningToken`. A successful response includes the claimed `deviceId` and `deviceName`. The operation requires the `https://www.googleapis.com/auth/androidworkprovisioning` OAuth scope.\n"],null,["# Method: partners.devices.claim\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 - [JSON representation](#body.ClaimDeviceResponse.SCHEMA_REPRESENTATION)\n- [Authorization Scopes](#body.aspect)\n\nClaims a device for a customer and adds it to zero-touch enrollment. If the device is already claimed by another customer, the call returns an error.\n\n### HTTP request\n\n`POST https://androiddeviceprovisioning.googleapis.com/v1/partners/{partnerId}/devices:claim`\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| ``` { \"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. The device identifier of the device to claim. |\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)`)` Optional. The metadata to attach to the device. |\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. |\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\nResponse message containing device id of the claim.\n\n| JSON representation |\n|------------------------------------------------------|\n| ``` { \"deviceId\": string, \"deviceName\": string } ``` |\n\n| Fields ||\n|--------------|--------------------------------------------------------------------------------------------------------------------------|\n| `deviceId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The device ID of the claimed device. |\n| `deviceName` | `string` The resource name of the device in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. |\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)."]]