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)

出力専用。リモート コマンドの有効な期間。

s で終わる小数 9 桁までの秒単位の期間。例: "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 ブラウザ プロファイルのリモート コマンドを一覧表示します。