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 Power wash を実行してデバイスをワイプします。デバイスでこのコマンドを実行すると、ユーザー ポリシー、デバイス ポリシー、登録ポリシーなど、すべてのデータが削除されます。警告: 強制登録または自動登録の対象である場合を除き、この処理を行うと、デバイスは出荷時の状態（登録なし）に戻ります。この操作は元に戻せないため、慎重に使用してください。
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

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