Method: partners.devices.claim
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
دستگاهی را برای مشتری ادعا می کند و آن را به ثبت نام بدون لمس اضافه می کند. اگر دستگاه قبلاً توسط مشتری دیگری ادعا شده باشد، تماس با خطا مواجه می شود.
درخواست HTTP
POST https://androiddeviceprovisioning.googleapis.com/v1/partners/{partnerId}/devices:claim
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
| پارامترها |
|---|
partnerId | string ( int64 format) مورد نیاز. شناسه شریک فروشنده. |
درخواست بدن
بدنه درخواست حاوی داده هایی با ساختار زیر است:
| نمایندگی 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 اختیاری. باید و فقط برای دستگاه های دارای سیستم عامل Chrome تنظیم شود. |
customer میدان اتحادیه مورد نیاز. مشتری که دستگاه برای او ادعا شده است. customer فقط می تواند یکی از موارد زیر باشد: |
customerId | string ( int64 format) شناسه مشتری که دستگاه برای او ادعا شده است. |
googleWorkspaceCustomerId | string شناسه مشتری Google Workspace. |
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
پیام پاسخ حاوی شناسه دستگاه ادعا.
| نمایندگی JSON |
|---|
{
"deviceId": string,
"deviceName": string
} |
| فیلدها |
|---|
deviceId | string ( int64 format) شناسه دستگاه دستگاه مورد ادعا. |
deviceName | string نام منبع دستگاه در قالب partners/[PARTNER_ID]/devices/[DEVICE_ID] . |
محدوده مجوز
به محدوده OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/androidworkprovisioning
برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 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)."]]
