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)

必要欄位。必要欄位。要認領的裝置 ID。

sectionType

enum (DeviceProvisioningSectionType)

必要欄位。裝置佈建記錄的區段類型。

deviceMetadata

object (DeviceMetadata)

選填欄位,要附加到裝置上的中繼資料。

preProvisioningToken

string

選填欄位,只能針對 Chrome 作業系統裝置進行設定。

聯集欄位 customer。必要欄位。領取裝置的客戶。customer 只能是下列其中一項:
customerId

string (int64 format)

領取裝置的客戶 ID。

googleWorkspaceCustomerId

string

Google Workspace 客戶 ID。

回應主體

如果成功,回應主體即會包含具有以下結構的資料:

含有聲明裝置 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 總覽