Objet événement

Cet article explique les différents composants d’un objet événement, comment vous pouvez l’utiliser et des exemples dont vous pouvez vous inspirer.

Qu’est-ce qu’un objet événement ?

Un objet événement est un objet transmis via l’API lorsqu’un événement spécifique se produit. Les objets événement sont contenus dans un tableau d’événements. Chaque objet événement du tableau représente une occurrence unique d’un événement personnalisé par un utilisateur particulier à la valeur temporelle désignée. L’objet événement possède de nombreux champs différents qui vous permettent de personnaliser en définissant et en utilisant des propriétés d’événement dans les messages, la collecte de données et la personnalisation.

Pour les étapes de configuration des événements personnalisés pour une plateforme spécifique, consultez le guide d’intégration de plateforme dans le guide du développeur. Consultez l’article correspondant en fonction de votre plateforme :

• Android
• iOS
• Web

Corps de l’objet

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
  // One of "external_id" or "user_alias" or "braze_id" or "email" or "phone" is required
  "external_id" : (optional, string) External user ID,
  "user_alias" : (optional, User Alias Object) User alias object,
  "braze_id" : (optional, string) Braze user identifier,
  "email": (optional, string) User email address,
  "phone": (optional, string) User phone number,
  "app_id" : (optional, string) see App Identifier,
  "name" : (required, string) the name of the event,
  "time" : (required, datetime as string in ISO 8601 or in `yyyy-MM-dd'T'HH:mm:ss:SSSZ` format),
  "properties" : (optional, Properties Object) properties of the event
  // Setting this flag to true will put the API in "Update Only" mode.
  // When using a "user_alias", "Update Only" mode is always true.
  "_update_existing_only" : (optional, boolean)
  // See following notes regarding anonymous push token imports
}

Remarque

Les événements avec des horodatages dans le futur utilisent par défaut l’heure actuelle. Cela garantit que les événements personnalisés sont enregistrés avec un horodatage précis.

• ID utilisateur externe
• Identifiant d’application
• Code temporel ISO 8601

Remarque

Certaines paires d’identifiants ne peuvent pas être utilisées ensemble dans une même requête. Lorsque email et phone sont tous deux fournis, email a la priorité sur phone. Pour plus de détails, consultez Résolution des identifiants.

Mettre à jour uniquement les profils existants

Pour mettre à jour uniquement les profils utilisateur existants dans Braze, vous devez transmettre la clé _update_existing_only avec la valeur true dans le corps de votre requête. Si cette valeur est omise, Braze créera un nouveau profil utilisateur si l’external_id n’existe pas déjà.

Remarque

Si vous créez un profil utilisateur alias uniquement via l’endpoint /users/track, _update_existing_only doit être défini sur false. Si cette valeur est omise, le profil alias uniquement ne sera pas créé.

Objet de propriétés d’événement

Les événements personnalisés et les achats peuvent avoir des propriétés d’événement. Les valeurs de « properties » doivent être un objet dont les clés sont les noms des propriétés et les valeurs sont les valeurs des propriétés. Les noms de propriétés doivent être des chaînes de caractères non vides de 255 caractères ou moins, sans signe dollar ($) en début de chaîne.

Les valeurs de propriétés peuvent être de l’un des types de données suivants :

Les objets de propriétés d’événement contenant des valeurs de type tableau ou objet peuvent avoir un payload de propriétés d’événement allant jusqu’à 100 Ko.

Clés réservées

Les clés suivantes sont réservées et ne peuvent pas être utilisées comme propriétés d’événement personnalisé :

• time
• event_name

Important

L’utilisation de clés réservées comme noms de propriétés d’événement personnalisé entraînera des erreurs d’API lors de l’envoi de requêtes vers l’endpoint /users/track.

Persistance des propriétés d’événement

Les propriétés d’événement sont conçues pour le filtrage et la personnalisation Liquid dans les messages déclenchés par leurs événements parents. Par défaut, elles ne sont pas conservées sur le profil utilisateur Braze. Pour utiliser les valeurs de propriétés d’événement dans la segmentation, consultez la section événements personnalisés, qui détaille les différentes approches pour stocker les valeurs de propriétés d’événement à long terme.

Exemple de requête d’événement

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
POST https://YOUR_REST_API_URL/users/track
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
  "events" : [
    {
      "external_id" : "user1",
      "app_id" : "your-app-id",
      "name" : "watched_trailer",
      "time" : "2013-07-16T19:20:30+01:00"
    },
    {
      "external_id" : "user1",
      "app_id" : "your-app-id",
      "name" : "rented_movie",
      "time" : "2013-07-16T19:20:45+01:00",
      "properties": {
        "movie": "The Sad Egg",
        "director": "Alex Smith"
      }
    },
    {
      "user_alias" : { "alias_name" : "device123", "alias_label" : "my_device_identifier"},
      "app_id" : "your-app-id",
      "name" : "watched_trailer",
      "time" : "2013-07-16T19:20:50+01:00"
    }
  ]
}

• Wiki sur le code temporel ISO 8601

Objets d’événement

En utilisant l’exemple fourni, nous pouvons voir qu’une personne a récemment regardé une bande-annonce, puis a loué un film. Bien que nous ne puissions pas accéder à une Campaign et segmenter les utilisateurs en fonction de ces propriétés, nous pouvons les utiliser de manière stratégique sous la forme d’un reçu, pour envoyer un message personnalisé via un canal en utilisant Liquid. Par exemple : « Bonjour Alex, merci d’avoir loué The Sad Egg de Alex Smith, voici quelques films recommandés en fonction de votre location… »