Method: customer.devices.chromeos.issueCommand

デバイスに実行するコマンドを発行します。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
customerId

string

変更不可。Google Workspace アカウントの ID。

deviceId

string

変更不可。ChromeOS デバイスの ID。

リクエスト本文

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

JSON 表現
{
  "commandType": enum (CommandType),
  "payload": string
}
フィールド
commandType

enum (CommandType)

コマンドのタイプ。

payload

string

コマンドのペイロード。コマンドでサポートされている場合にのみ指定します。次のコマンドは、ペイロードの追加をサポートしています。

  • SET_VOLUME: ペイロードは、{ "volume": 50 } 形式の文字列化された JSON オブジェクトです。volume は [0,100] の範囲の整数にする必要があります。
  • DEVICE_START_CRD_SESSION: ペイロードはオプションで、{ "ackedUserPresence": true } 形式の文字列化された JSON オブジェクトです。ackedUserPresence はブール値です。デフォルトでは、ackedUserPresencefalse に設定されています。アクティブなデバイスで Chrome リモート デスクトップ セッションを開始するには、ackedUserPresencetrue に設定します。
  • REBOOT: ペイロードは、{ "user_session_delay_seconds": 300 } 形式の文字列化された JSON オブジェクトです。遅延は [0, 300] の範囲内になければなりません。
  • FETCH_SUPPORT_PACKET: ペイロードはオプションで次の形式の文字列化された JSON オブジェクト: {"supportPacketDetails":{ "issueCaseId": optional_support_case_id_string, "issueDescription": optional_issue_description_string, "requestedDataCollectors": [<comma-separate list of data_collector_enums integer values>]}}
    利用可能な data_collector_enums のリストは次のとおりです: Chrome システム情報(1)、クラッシュ ID(2)
    詳しくは、ヘルプ記事をご覧ください。

レスポンスの本文

コマンドを発行するためのレスポンス。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現
{
  "commandId": string
}
フィールド
commandId

string (int64 format)

発行されたコマンドの一意の ID。コマンド ステータスの取得に使用されます。

承認スコープ

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

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

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