REST Resource: customers.profiles.commands

Ressource: ChromeBrowserProfileCommand

Eine Darstellung eines Remotebefehls für ein Chrome-Browserprofil.

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

string

ID. Format: customers/{customerId}/profiles/{profilePermanentId}/commands/{command_id}

commandType

string

Erforderlich. Typ des Remote-Befehls. Unterstützte Befehle: „clearBrowsingData“ und „extensionUpdateCheck“.

payload

object (Struct format)

Erforderlich. Nutzlast des Remote-Befehls.

Die Nutzlast für den Befehl „clearBrowsingData“ unterstützt: - die Felder „clearCache“ und „clearCookies“ - Werte vom booleschen Typ.

Die Nutzlast für „extensionUpdateCheck“ sollte leer sein.

commandState

enum (CommandState)

Nur Ausgabe. Status des Remote-Befehls.

commandResult

object (CommandResult)

Nur Ausgabe. Ergebnis des Remote-Befehls.

issueTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel der Ausstellung des Remote-Befehls.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"

validDuration

string (Duration format)

Nur Ausgabe. Gültige Dauer des Remote-Befehls.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit „s“. Beispiel: "3.5s".

CommandState

Mögliche Status eines Befehls.

Enums
COMMAND_STATE_UNSPECIFIED Stellt einen nicht angegebenen Befehlsstatus dar.
PENDING Stellt einen Befehl im Status „Ausstehend“ dar.
EXPIRED Stellt einen abgelaufenen Befehl dar.
EXECUTED_BY_CLIENT Stellt einen Befehl dar, der vom Client ausgeführt wurde.

CommandResult

Ergebnis der Ausführung eines Befehls.

JSON-Darstellung
{
  "resultType": enum (CommandResultType),
  "clientExecutionTime": string,
  "resultCode": string
}
Felder
resultType

enum (CommandResultType)

Nur Ausgabe. Ergebnistyp des Remote-Befehls.

clientExecutionTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel der Clientausführung des Remote-Befehls.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"

resultCode

string

Nur Ausgabe. Ergebniscode, der den Typ des Fehlers oder den Erfolg des Befehls angibt.

CommandResultType

Mögliche Ergebnistypen eines Befehls.

Enums
COMMAND_RESULT_TYPE_UNSPECIFIED Stellt ein nicht angegebenes Befehlsergebnis dar.
IGNORED Stellt einen Befehl mit einem ignorierten Ergebnis dar.
FAILURE Stellt einen fehlgeschlagenen Befehl dar.
SUCCESS Stellt einen erfolgreichen Befehl dar.

Methoden

create

Erstellt einen Remotebefehl für ein Chrome-Browserprofil.

get

Ruft einen Remotebefehl für ein Chrome-Browserprofil ab.

list

Listet Remotebefehle eines Chrome-Browserprofils auf.