Method: partners.devices.claim
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
מצהירה על מכשיר מסוים של הלקוח ומוסיפה אותו להרשמה דרך הארגון. אם לקוח אחר כבר תבע בעלות על המכשיר, השיחה תחזיר הודעת שגיאה.
בקשת HTTP
POST https://androiddeviceprovisioning.googleapis.com/v1/partners/{partnerId}/devices:claim
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
| פרמטרים |
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
זה שינוי אופציונלי. חובה וניתן להגדיר רק למכשירי ChromeOS.
|
שדה איחוד 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 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-25 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-25 (שעון UTC)."],[[["\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)."]]
