REST Resource: customers.profiles.commands

Resource: ChromeBrowserProfileCommand

A representation of a remote command for a Chrome browser profile.

JSON representation
 { 
 "name" 
 : 
 string 
 , 
 "commandType" 
 : 
 string 
 , 
 "payload" 
 : 
 { 
 object 
 } 
 , 
 "commandState" 
 : 
 enum (  CommandState 
 
) 
 , 
 "commandResult" 
 : 
 { 
 object (  CommandResult 
 
) 
 } 
 , 
 "issueTime" 
 : 
 string 
 , 
 "validDuration" 
 : 
 string 
 } 
Fields
name

string

Identifier. Format: customers/{customer_id}/profiles/{profilePermanentId}/commands/{command_id}

commandType

string

Required. Type of the remote command. The only supported commandType is "clearBrowsingData".

payload

object ( Struct format)

Required. Payload of the remote command. The payload for "clearBrowsingData" command supports: - fields "clearCache" and "clearCookies" - values of boolean type.

commandState

enum ( CommandState )

Output only. State of the remote command.

commandResult

object ( CommandResult )

Output only. Result of the remote command.

issueTime

string ( Timestamp format)

Output only. Timestamp of the issurance of the remote command.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

validDuration

string ( Duration format)

Output only. Valid duration of the remote command.

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

CommandState

Possible states of a command.

Enums
COMMAND_STATE_UNSPECIFIED Represents an unspecified command state.
PENDING Represents a command in a pending state.
EXPIRED Represents a command that has expired.
EXECUTED_BY_CLIENT Represents a command that has been executed by the client.

CommandResult

Result of the execution of a command.

JSON representation
 { 
 "resultType" 
 : 
 enum (  CommandResultType 
 
) 
 , 
 "clientExecutionTime" 
 : 
 string 
 , 
 "resultCode" 
 : 
 string 
 } 
Fields
resultType

enum ( CommandResultType )

Output only. Result type of the remote command.

clientExecutionTime

string ( Timestamp format)

Output only. Timestamp of the client execution of the remote command.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

resultCode

string

Output only. Result code that indicates the type of error or success of the command.

CommandResultType

Possible types of result of a command.

Enums
COMMAND_RESULT_TYPE_UNSPECIFIED Represents an unspecified command result.
IGNORED Represents a command with an ignored result.
FAILURE Represents a failed command.
SUCCESS Represents a succeeded command.

Methods

create

Creates a Chrome browser profile remote command.

get

Gets a Chrome browser profile remote command.

list

Lists remote commands of a Chrome browser profile.
Create a Mobile Website
View Site in Mobile | Classic
Share by: