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

変更不可。Chrome OS デバイスの ID。

リクエストの本文

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

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

enum (CommandType)

コマンドのタイプ。

payload

string

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

  • SET_VOLUME: ペイロードは、{ "volume": 50 } 形式の文字列化された JSON オブジェクトです。音量は [0,100] の範囲の整数である必要があります。
  • DEVICE_START_CRD_SESSION: ペイロードは、{ "ackedUserPresence": true, "crdSessionType": string } という形式の文字列化された JSON オブジェクトです。ackedUserPresence はブール値です。デフォルトでは、ackedUserPresencefalse に設定されています。アクティブなデバイスの Chrome リモート デスクトップ セッションを開始するには、ackedUserPresencetrue に設定します。crdSessionType は、private(リモート管理者に ChromeOS デバイスの排他的な制御を許可する)または shared(管理者とローカル ユーザーが ChromeOS デバイスの制御を共有できるようにする)の値からのみ選択できます。設定しない場合、crdSessionType はデフォルトで shared になります。FETCH_CRD_AVAILABILITY_INFO コマンドを使用して、デバイスで使用可能なセッション タイプを特定できます。
  • REBOOT: ペイロードは、{ "user_session_delay_seconds": 300 } の形式の文字列化された JSON オブジェクトです。user_session_delay_seconds は、ユーザーがログインしている場合にデバイスを再起動するまでの待機時間(秒単位)です。[0,300] の範囲の整数にする必要があります。再起動のペイロードがない場合、デフォルトの遅延は 0 です。注: これは、ゲストを含む実際のユーザーがログインしている場合にのみ適用されます。デバイスがログイン画面またはキオスクモードの場合、この値は無視され、デバイスはすぐに再起動します。
  • FETCH_SUPPORT_PACKET: ペイロードは、必要に応じて、{"supportPacketDetails":{ "issueCaseId": optional_support_case_id_string, "issueDescription": optional_issue_description_string, "requestedDataCollectors": [<data_collector_enums 整数値のカンマ区切りリスト>]}} 形式の文字列化された JSON オブジェクトです。
    使用可能な data_collector_enums のリストは次のとおりです。Chrome システム情報(1)、クラッシュ ID(2)、メモリの詳細(3)、UI 階層(4)、追加の ChromeOS プラットフォーム ログ(5)、デバイス イベント(6)、Intel WiFi NIC デバッグ ダンプ(7)、タッチ イベント(8)、Lacros(9)、Lacros システム情報(10)、ChromeOS Flex ログ(11)、DBus の詳細(12)、ChromeOS ネットワーク ルート(13)、ChromeOS Shill(接続マネージャー)ログ(14)、ポリシー(15)、ChromeOS システムの状態とログ(16)、ChromeOS システムログ(17)、ChromeOS Chrome ユーザーログ(18)、ChromeOS Bluetooth(19)、ChromeOS 接続された入力デバイス(20)、ChromeOS トラフィック カウンタ(21)、ChromeOS 仮想キーボード(22)、ChromeOS ネットワークの健全性(23)。
    詳しくは、ヘルプ記事をご覧ください。

レスポンスの本文

コマンド発行のレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

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

string (int64 format)

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

認可スコープ

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

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

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