Method: customer.devices.chromeos.batchChangeStatus

ChromeOS デバイスのバッチのステータスを変更します。ChromeOS デバイスの状態の変更について詳しくは、ChromeOS デバイスの修理、用途変更、廃棄をご覧ください。

HTTP リクエスト

POST https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/devices/chromeos:batchChangeStatus

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
customerId

string

必須。Google Workspace アカウントの不変 ID。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "deviceIds": [
    string
  ],
  "changeChromeOsDeviceStatusAction": enum (ChangeChromeOsDeviceStatusAction),
  "deprovisionReason": enum (DeprovisionReason)
}
フィールド
deviceIds[]

string

必須。変更する ChromeOS デバイスの ID のリスト。最大 50 個。
changeChromeOsDeviceStatusAction

enum (ChangeChromeOsDeviceStatusAction)

必須。ChromeOS デバイスのステータスを変更するために、デバイスに対して行う操作。
deprovisionReason

enum (DeprovisionReason)

省略可。デバイスのプロビジョニング解除の理由。changeChromeOsDeviceStatusAction が CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DEPROVISION に設定されている場合は、指定する必要があります。それ以外の場合は、このフィールドを省略します。

レスポンスの本文

ChromeOS デバイスのバッチのステータスを変更した際のレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "changeChromeOsDeviceStatusResults": [
    {
      object (ChangeChromeOsDeviceStatusResult)
    }
  ]
}
フィールド
changeChromeOsDeviceStatusResults[]

object (ChangeChromeOsDeviceStatusResult)

リクエストで指定された各 ChromeOS デバイスの結果。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/admin.directory.device.chromeos

詳しくは、認可ガイドをご覧ください。

ChangeChromeOsDeviceStatusAction

ChromeOS デバイスのステータスを変更するために実行するアクション。

列挙型
CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_UNSPECIFIED デフォルト値。値は使用されません。
CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DEPROVISION ChromeOS デバイスのプロビジョニングを解除します。組織内で使用されなくなった ChromeOS デバイスがある場合は、デプロビジョニングして管理対象から外す必要があります。デバイスをデプロビジョニングすると、そのデバイス上のすべてのポリシーとデバイスレベルのプリンタが削除され、デバイスをキオスクとして使用できなくなります。デバイスに関連付けられているアップグレードによっては、この操作によりライセンスがライセンス プールに戻され、別のデバイスでライセンスを使用できる場合があります。
CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DISABLE ChromeOS デバイスを無効にします。このアクションは、ユーザーがデバイスを紛失または盗難にあった場合に使用します。このアクションを使用すると、デバイスは引き続き管理対象となるためポリシーが適用されますが、誰も使用できなくなります。デバイスに関連付けられているアップグレードによっては、この操作によりライセンスがライセンス プールに戻され、別のデバイスでライセンスを使用できる場合があります。
CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_REENABLE 無効にした ChromeOS デバイスを再度有効にして使用できるようにします。デバイスが紛失しなくなったか、回収されたら、デバイスを再度有効にします。これにより、デバイスを再び使用できるようになります。デバイスに関連付けられているアップグレードによっては、ライセンス プールから 1 つのライセンスが消費される場合があります。つまり、使用可能なライセンスが不足している場合、オペレーションは失敗します。

ChangeChromeOsDeviceStatusResult

ステータスの変更オペレーションに対する 1 台の ChromeOS デバイスの結果。

JSON 表現 
{
  "deviceId": string,

  // Union field result can be only one of the following:
  "error": {
    object (Status)
  },
  "response": {
    object (ChangeChromeOsDeviceStatusSucceeded)
  }
  // End of list of possible types for union field result.
}
フィールド
deviceId

string

ChromeOS デバイスの一意の ID。

共用体フィールド result。

result は次のいずれかになります。
error

object (Status)

失敗した場合のオペレーションのエラー結果。
response

object (ChangeChromeOsDeviceStatusSucceeded)

デバイスのステータスが正常に変更された。

ステータス

Status 型は、REST API や RPC API など、さまざまなプログラミング環境に適した論理エラーモデルを定義します。gRPC により使用されます。各 Status メッセージには、エラーコード、エラー メッセージ、エラーの詳細という 3 種類のデータが含まれます。

このエラーモデルと操作方法について詳しくは、API 設計ガイドをご覧ください。

JSON 表現 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
フィールド
code

integer

ステータス コード。google.rpc.Code の列挙値である必要があります。
message

string

デベロッパー向けのエラー メッセージ。英語で記述します。ユーザー向けのエラー メッセージは、ローカライズして google.rpc.Status.details フィールドで送信するか、クライアントでローカライズする必要があります。
details[]

object

エラーの詳細を保持するメッセージのリスト。API が使用する共通のメッセージ タイプのセットがあります。

任意のデータ型のフィールドを含むオブジェクト。追加フィールドの "@type" には、その型を識別する URI が含まれます。例: { "id": 1234, "@type": "types.example.com/standard/id" }

ChangeChromeOsDeviceStatusSucceeded

この型にはフィールドがありません。

ChromeOS デバイスのステータスの変更が正常に完了したことを示すレスポンス。