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)

管理者がコマンドを発行したときのタイムスタンプ。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
state

enum (State)

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

string (Timestamp format)

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

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
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_CRD_AVAILABILITY_INFO デバイスにリモートで接続するために使用できる Chrome リモート デスクトップ セッションの利用可能なタイプ（プライベートまたは共有）を取得します。
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)

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

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
errorMessage

string

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

string

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

  • DEVICE_START_CRD_SESSION: ペイロードは、{ "url": url } 形式の文字列化された JSON オブジェクトです。指定された URL は Chrome リモート デスクトップ セッションにリンクしており、コマンドの発行に関連付けられた email のみを使用した認証が必要です。
  • FETCH_CRD_AVAILABILITY_INFO: ペイロードは、{ "deviceIdleTimeInSeconds": number, "userSessionType": string, "remoteSupportAvailability": string, "remoteAccessAvailability": string } 形式の文字列化された JSON オブジェクトです。デバイスへの shared CRD セッションが利用可能な場合、「remoteSupportAvailability」フィールドは「AVAILABLE」に設定されます。デバイスへの private CRD セッションが利用可能な場合、「remoteAccessAvailability」フィールドは「AVAILABLE」に設定されます。

CommandResultType

コマンド結果のタイプ。

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

メソッド

get

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