Method: customer.devices.chromeos.issueCommand

發送指令供裝置執行。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
customerId

string

不可變更。Google Workspace 帳戶的 ID。
deviceId

string

不可變更。ChromeOS 裝置的 ID。

要求主體

要求主體會包含結構如下的資料：

JSON 表示法 
{
  "commandType": enum (CommandType),
  "payload": string
}
欄位
commandType

enum (CommandType)

指令類型。
payload

string

指令的酬載，僅在指令支援時提供。下列指令支援新增酬載：

  • SET_VOLUME：酬載是字串化的 JSON 物件，格式為：{ "volume": 50 }。音量必須是介於 [0,100] 的整數。
  • DEVICE_START_CRD_SESSION：酬載可選擇性地為字串化的 JSON 物件，格式為：{ "ackedUserPresence": true, "crdSessionType": string }。ackedUserPresence 為布林值。根據預設，ackedUserPresence 會設為 false。如要為有效裝置啟動 Chrome 遠端桌面工作階段，請將 ackedUserPresence 設為 true。crdSessionType只能從 private (授予遠端管理員 ChromeOS 裝置的專屬控制權) 或 shared (允許管理員和本機使用者共用 ChromeOS 裝置的控制權) 值中選取。如未設定，crdSessionType 預設為 shared。您可以使用 FETCH_CRD_AVAILABILITY_INFO 指令，判斷裝置上可用的工作階段類型。
  • REBOOT：酬載是字串化的 JSON 物件，格式為：{ "user_session_delay_seconds": 300 }。user_session_delay_seconds 是指使用者登入後，裝置重新啟動前等待的秒數。必須是 [0,300] 範圍內的整數。如果重新啟動時沒有酬載，預設延遲時間為 0。注意：只有在實際使用者 (包括訪客) 登入時，系統才會套用這項設定。如果裝置處於登入畫面或 Kiosk 模式，系統不會採用這個值，裝置會立即重新啟動。
  • FETCH_SUPPORT_PACKET：酬載內容 (選用) 為字串化的 JSON 物件，格式如下：{"supportPacketDetails":{ "issueCaseId": optional_support_case_id_string, "issueDescription": optional_issue_description_string, "requestedDataCollectors": [<comma-separated list of data_collector_enums integer values>]}}
    可用的 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 藍牙 (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

詳情請參閱授權指南。