REST Resource: customer.devices.chromeos.commands

リソース: DirectoryChromeosdevicesCommand

デバイスに発行されたコマンドに関する情報。

JSON 表現 
{
  "commandId": string,
  "type": enum (CommandType),
  "issueTime": string,
  "state": enum (State),
  "commandExpireTime": string,
  "commandResult": {
    object (DirectoryChromeosdevicesCommandResult)
  },
  "payload": string
}
フィールド
commandId

string (int64 format)

デバイス コマンドの一意の ID。
type

enum (CommandType)

コマンドのタイプ。
issueTime

string (Timestamp format)

管理者がコマンドを実行した日時。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
state

enum (State)

コマンドの状態を示します。
commandExpireTime

string (Timestamp format)

コマンドが期限切れになる時刻。この時間内にデバイスがコマンドを実行しなかった場合、コマンドは期限切れになります。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
commandResult

object (DirectoryChromeosdevicesCommandResult)

コマンドの実行結果。
payload

string

コマンドで指定されたペイロード（存在する場合）。

CommandType

デバイスが実行する必要があるコマンドのタイプを設定します。

列挙型
COMMAND_TYPE_UNSPECIFIED コマンドタイプが指定されていません。
REBOOT デバイスを再起動します。キオスク デバイス、管理対象ゲスト セッションのデバイス、ChromeOS バージョン 113 以降を搭載した通常のデバイスに発行できます。
TAKE_A_SCREENSHOT デバイスのスクリーンショットを撮影します。デバイスがキオスクモードの場合にのみ使用できます。
SET_VOLUME デバイスの音量を設定します。キオスク デバイスと管理対象ゲスト セッション デバイスにのみ発行できます。
WIPE_USERS デバイスからすべてのユーザーをワイプします。デバイスでこのコマンドを実行すると、ユーザー プロファイルのデータはすべて削除されますが、デバイス ポリシーと登録は保持されます。
REMOTE_POWERWASH パワーウォッシュを実行してデバイスをワイプします。デバイスでこのコマンドを実行すると、ユーザー ポリシー、デバイス ポリシー、登録ポリシーを含むすべてのデータが削除されます。警告: 初期状態にリセットすると、デバイスは出荷時の状態（登録なし）に戻ります。ただし、自動登録または強制登録が適用されている場合は除きます。この操作は元に戻すことができないため、慎重に使用してください。
DEVICE_START_CRD_SESSION Chrome リモート デスクトップ セッションを開始します。
CAPTURE_LOGS キオスク デバイスのシステムログをキャプチャします。ログは、chromeosdevices の deviceFiles フィールドにある downloadUrl リンクからダウンロードできます。
FETCH_SUPPORT_PACKET デバイスからリモートでサポート パケットを取得します。サポート パックは、ChromeOS デバイスのさまざまなシステムログとデバッグデータを含む ZIP アーカイブです。サポート パッケージは、chromeosdevices の deviceFiles フィールドにある downloadURL リンクからダウンロードできます。

州

発行されたコマンドの状態を表します。

列挙型
STATE_UNSPECIFIED コマンドのステータスが指定されていません。
PENDING 期限切れではないコマンドで、クライアントにまだ送信されていないもの。
EXPIRED コマンドが想定時間内にクライアントによって実行されなかった。
CANCELLED PENDING の状態で管理者によってコマンドがキャンセルされた。
SENT_TO_CLIENT コマンドがクライアントに送信されました。
ACKED_BY_CLIENT クライアントがコマンドを受信したことを返信しました。
EXECUTED_BY_CLIENT クライアントがコマンドを正常に（または正常に）実行したかどうか。

DirectoryChromeosdevicesCommandResult

コマンドの実行結果。

JSON 表現 
{
  "result": enum (CommandResultType),
  "executeTime": string,
  "errorMessage": string,
  "commandResultPayload": string
}
フィールド
result

enum (CommandResultType)

コマンドの結果。
executeTime

string (Timestamp format)

コマンドが実行された時刻または実行に失敗した時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
errorMessage

string

コマンドが失敗した理由の簡単な説明を含むエラー メッセージ。コマンドが失敗した場合のみ存在します。
commandResultPayload

string

コマンドの結果のペイロード。次のコマンドはペイロードを返します。

  • DEVICE_START_CRD_SESSION: ペイロードは、{ "url": url } 形式の文字列化された JSON オブジェクトです。URL は Chrome リモート デスクトップ セッションへのリンクを提供します。

CommandResultType

コマンドの結果のタイプ。

列挙型
COMMAND_RESULT_TYPE_UNSPECIFIED コマンドの結果が指定されていません。
IGNORED このコマンドは非推奨として無視されました。
FAILURE コマンドを正常に実行できませんでした。
SUCCESS コマンドが正常に実行されました。

メソッド

get

 デバイスに発行された特定のコマンドのコマンドデータを取得します。