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 が使用する共通のメッセージ タイプのセットがあります。

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

ChangeChromeOsDeviceStatusSucceeded

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

ChromeOS デバイスが正常にステータス変更された場合のレスポンス。