REST Resource: customers.profiles.commands

Ressource : ChromeBrowserProfileCommand

Représentation d'une commande à distance pour un profil de navigateur Chrome.

Représentation JSON
{
  "name": string,
  "commandType": string,
  "payload": {
    object
  },
  "commandState": enum (CommandState),
  "commandResult": {
    object (CommandResult)
  },
  "issueTime": string,
  "validDuration": string
}
Champs
name

string

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

commandType

string

Obligatoire. Type de la commande à distance. Commandes acceptées : "clearBrowsingData" et "extensionUpdateCheck".

payload

object (Struct format)

Obligatoire. Charge utile de la commande à distance.

La charge utile de la commande "clearBrowsingData" accepte les champs "clearCache" et "clearCookies" avec des valeurs de type booléen.

La charge utile de "extensionUpdateCheck" doit être vide.

commandState

enum (CommandState)

Uniquement en sortie. État de la commande à distance.

commandResult

object (CommandResult)

Uniquement en sortie. Résultat de la commande à distance.

issueTime

string (Timestamp format)

Uniquement en sortie. Code temporel de l'émission de la commande à distance.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

validDuration

string (Duration format)

Uniquement en sortie. Durée de validité de la commande à distance.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"

CommandState

États possibles d'une commande.

Enums
COMMAND_STATE_UNSPECIFIED Représente un état de commande non spécifié.
PENDING Représente une commande en attente.
EXPIRED Représente une commande qui a expiré.
EXECUTED_BY_CLIENT Représente une commande exécutée par le client.

CommandResult

Résultat de l'exécution d'une commande.

Représentation JSON
{
  "resultType": enum (CommandResultType),
  "clientExecutionTime": string,
  "resultCode": string
}
Champs
resultType

enum (CommandResultType)

Uniquement en sortie. Type de résultat de la commande à distance.

clientExecutionTime

string (Timestamp format)

Uniquement en sortie. Code temporel de l'exécution de la commande à distance par le client.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

resultCode

string

Uniquement en sortie. Code de résultat indiquant le type d'erreur ou le succès de la commande.

CommandResultType

Types de résultats possibles d'une commande.

Enums
COMMAND_RESULT_TYPE_UNSPECIFIED Représente un résultat de commande non spécifié.
IGNORED Représente une commande dont le résultat est ignoré.
FAILURE Représente une commande ayant échoué.
SUCCESS Représente une commande réussie.

Méthodes

create

Crée une commande à distance pour un profil de navigateur Chrome.

get

Récupère une commande à distance pour un profil de navigateur Chrome.

list

Liste les commandes à distance d'un profil de navigateur Chrome.