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/{customer_id}/profiles/{profilePermanentId}/commands/{command_id}

commandType

string

必要欄位。遙控器指令的類型。唯一支援的 commandType 是「clearBrowsingData」。

payload

object (Struct format)

必要欄位。遠端指令的酬載。「clearBrowsingData」指令的酬載支援:- 「clearCache」和「clearCookies」欄位 - 布林值類型的值。

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 瀏覽器設定檔的遠端指令。