REST Resource: properties.keyEvents

Ressource : KeyEvent

Événement clé dans une propriété Google Analytics.

Représentation JSON
{
  "name": string,
  "eventName": string,
  "createTime": string,
  "deletable": boolean,
  "custom": boolean,
  "countingMethod": enum (CountingMethod),
  "defaultValue": {
    object (DefaultValue)
  }
}
Champs
name

string

Uniquement en sortie. Nom de ressource de cet événement clé. Format: properties/{property}/keyEvents/{keyEvent}

eventName

string

Immuable. Nom de l'événement pour cet événement clé. Exemples : "click", "purchase"

createTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle cet événement clé a été créé dans la propriété.

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".

deletable

boolean

Uniquement en sortie. Si la valeur est "true", cet événement peut être supprimé.

custom

boolean

Uniquement en sortie. Si la valeur est "true", cet événement clé fait référence à un événement personnalisé. Si la valeur est "false", cet événement clé fait référence à un événement par défaut dans GA. Les événements par défaut ont généralement une signification particulière dans GA. Ils sont généralement créés automatiquement par le système GA, mais dans certains cas, ils peuvent être créés par les administrateurs de la propriété. Les événements personnalisés sont pris en compte dans le nombre maximal d'événements clés personnalisés pouvant être créés par propriété.

countingMethod

enum (CountingMethod)

Obligatoire. Méthode de comptabilisation des événements clés pour plusieurs événements au sein d'une session.

defaultValue

object (DefaultValue)

Facultatif. Définit une valeur/devise par défaut pour un événement clé.

CountingMethod

Méthode de comptabilisation des événements clés pour plusieurs événements au sein d'une session.

Enums
COUNTING_METHOD_UNSPECIFIED Méthode de comptabilisation non spécifiée.
ONCE_PER_EVENT Chaque instance d'événement est considérée comme un événement clé.
ONCE_PER_SESSION Une instance d'événement est considérée comme un événement clé au maximum une fois par session et par utilisateur.

DefaultValue

Définit une valeur/devise par défaut pour un événement clé.

Représentation JSON
{
  "numericValue": number,
  "currencyCode": string
}
Champs
numericValue

number

Obligatoire. Cette valeur sera utilisée pour renseigner le paramètre "value" pour toutes les occurrences de cet événement clé (spécifié par eventName) lorsque ce paramètre n'est pas défini.

currencyCode

string

Obligatoire. Lorsqu'aucune devise n'est définie pour une occurrence de cet événement clé (spécifié par eventName), cette devise sera appliquée par défaut. Doit être au format de code de devise ISO 4217.

Pour en savoir plus, consultez https://en.wikipedia.org/wiki/ISO_4217.

Méthodes

create

Crée un événement clé.

delete

Supprime un événement clé.

get

Récupère un seul événement clé.

list

Renvoie une liste d'événements clés dans la propriété parente spécifiée.

patch

Met à jour un événement clé.