REST Resource: customers.profiles.commands

資源：ChromeBrowserProfileCommand

Chrome 瀏覽器設定檔的遠端指令表示法。

JSON 表示法 
{
  "name": string,
  "commandType": string,
  "payload": {
    object
  },
  "commandState": enum (CommandState),
  "commandResult": {
    object (CommandResult)
  },
  "issueTime": string,
  "validDuration": string
}
欄位
name

string

ID。格式：customers/{customerId}/profiles/{profilePermanentId}/commands/{command_id}
commandType

string

必填。遠端指令類型。支援的指令：「clearBrowsingData」和「extensionUpdateCheck」。
payload

object (Struct format)

必填。遠端指令的酬載。

「clearBrowsingData」指令的酬載支援：-「clearCache」和「clearCookies」欄位 - 布林類型的值。

「extensionUpdateCheck」的酬載應為空白。
commandState

enum (CommandState)

僅供輸出。遠端指令的狀態。
commandResult

object (CommandResult)

僅供輸出。遠端指令的結果。
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"。
validDuration

string (Duration format)

僅供輸出。遠端指令的有效時間長度。

時間長度以秒為單位，最多可有 9 個小數位數，並應以「s」結尾，例如："3.5s"。

CommandState

指令的可能狀態。

列舉
COMMAND_STATE_UNSPECIFIED 代表未指定的指令狀態。
PENDING 代表處於待處理狀態的指令。
EXPIRED 代表已過期的指令。
EXECUTED_BY_CLIENT 表示用戶端執行的指令。

CommandResult

執行指令的結果。

JSON 表示法 
{
  "resultType": enum (CommandResultType),
  "clientExecutionTime": string,
  "resultCode": string
}
欄位
resultType

enum (CommandResultType)

僅供輸出。遠端指令的結果類型。
clientExecutionTime

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"。
resultCode

string

僅供輸出。結果代碼，指出指令的錯誤類型或是否成功。

CommandResultType

指令可能傳回的結果類型。

列舉
COMMAND_RESULT_TYPE_UNSPECIFIED 代表未指定的指令結果。
IGNORED 代表結果遭到忽略的指令。
FAILURE 代表失敗的指令。
SUCCESS 代表成功執行的指令。

方法

create

 建立 Chrome 瀏覽器設定檔遠端指令。

get

 取得 Chrome 瀏覽器設定檔遠端指令。

list

 列出 Chrome 瀏覽器設定檔的遠端指令。