Skip to content

Consigner un événement personnalisé

Découvrez comment enregistrer des événements personnalisés via le SDK de Braze.

Enregistrement d’un événement personnalisé

Pour enregistrer un événement personnalisé, utilisez la méthode d’enregistrement des événements suivante.

Pour une implémentation standard du SDK Web, vous pouvez utiliser la méthode suivante :

1
braze.logCustomEvent("YOUR_EVENT_NAME");

Si vous souhaitez utiliser Google Tag Manager à la place, vous pouvez utiliser le type d’étiquette Custom Event pour appeler la méthodelogCustomEvent et envoyer des événements personnalisés à Braze, en incluant éventuellement des propriétés d’événement personnalisées. Pour ce faire :

  1. Saisissez le nom de l’événement en utilisant une variable ou en tapant un nom d’événement.
  2. Utilisez le bouton Ajouter une ligne pour ajouter des propriétés d’événement.

Une boîte de dialogue affichant les paramètres de configuration de la balise d’action de Braze. Les paramètres inclus sont le « type de balise » (événement personnalisé), « nom d’événement » (clic de bouton) et les « propriétés de l’événement ».

Pour les versions natives d’Android, vous pouvez utiliser la méthode suivante :

1
Braze.getInstance(context).logCustomEvent(YOUR_EVENT_NAME);
1
Braze.getInstance(context).logCustomEvent(YOUR_EVENT_NAME)
1
AppDelegate.braze?.logCustomEvent(name: "YOUR_EVENT_NAME")
1
[AppDelegate.braze logCustomEvent:@"YOUR_EVENT_NAME"];
1
braze.logCustomEvent('YOUR_EVENT_NAME');

Veuillez utiliser la méthode du plugin Braze Cordova :

1
BrazePlugin.logCustomEvent("YOUR_EVENT_NAME");

L’APIlogCustomEvent accepte :

  • eventName (chaîne de caractères obligatoire) : Veuillez utiliser jusqu’à 255 caractères. Veuillez ne pas commencer le nom par $. Veuillez utiliser des caractères alphanumériques et des signes de ponctuation.
  • eventProperties (objet facultatif) : Veuillez ajouter des paires clé-valeur pour les métadonnées de l’événement. Veuillez utiliser des clés comportant jusqu’à 255 caractères et ne commencez pas les clés par $.

Pour les valeurs de propriété, veuillez utiliserstring(jusqu’à 255 caractères), numeric,boolean , des tableaux d’objets ou des objets JSON imbriqués.

Pour plus de détails sur la mise en œuvre, veuillez consulter le code source du SDK Braze Cordova :

Si vous avez intégré des balises Infillion dans votre application Android, vous pouvez éventuellement utiliser visit.getPlace() pour enregistrer des événements spécifiques à l’emplacement/localisation. requestImmediateDataFlush vérifie que votre événement sera enregistré même si votre application est en arrière-plan.

1
2
Braze.getInstance(context).logCustomEvent("Entered " + visit.getPlace());
Braze.getInstance(context).requestImmediateDataFlush();
1
2
Braze.getInstance(context).logCustomEvent("Entered " + visit.getPlace())
Braze.getInstance(context).requestImmediateDataFlush()
1
Braze.logCustomEvent("YOUR_EVENT_NAME");
1
m.Braze.logEvent("YOUR_EVENT_NAME")
1
AppboyBinding.LogCustomEvent("YOUR_EVENT_NAME");

Ajouter des propriétés de métadonnées

Lorsque vous enregistrez un événement personnalisé, vous avez la possibilité d’ajouter des métadonnées à cet événement en transmettant un objet de propriétés avec l’événement. Les propriétés sont définies comme des paires clé-valeur. Les clés sont des chaînes de caractères et les valeurs peuvent être des objetsDatestring, des tableauxnumeric ou des objetsboolean JSON imbriqués.

Pour ajouter des propriétés d’événement, utilisez la méthode d’enregistrement des événements suivante.

1
2
3
4
5
6
7
8
9
10
braze.logCustomEvent("YOUR-EVENT-NAME", {
  you: "can", 
  pass: false, 
  orNumbers: 42,
  orDates: new Date(),
  or: ["any", "array", "here"],
  andEven: {
     deeply: ["nested", "json"]
  }
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
Braze.logCustomEvent("YOUR-EVENT-NAME",
    new BrazeProperties(new JSONObject()
        .put("you", "can")
        .put("pass", false)
        .put("orNumbers", 42)
        .put("orDates", new Date())
        .put("or", new JSONArray()
            .put("any")
            .put("array")
            .put("here"))
        .put("andEven", new JSONObject()
            .put("deeply", new JSONArray()
                .put("nested")
                .put("json"))
        )
));
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
Braze.logCustomEvent("YOUR-EVENT-NAME",
    BrazeProperties(JSONObject()
        .put("you", "can")
        .put("pass", false)
        .put("orNumbers", 42)
        .put("orDates", Date())
        .put("or", JSONArray()
            .put("any")
            .put("array")
            .put("here"))
        .put("andEven", JSONObject()
            .put("deeply", JSONArray()
                .put("nested")
                .put("json"))
        )
))
1
2
3
4
5
6
7
8
9
10
11
12
13
AppDelegate.braze?.logCustomEvent(
  name: "YOUR-EVENT-NAME",
  properties: [
    "you": "can",
    "pass": false,
    "orNumbers": 42,
    "orDates": Date(),
    "or": ["any", "array", "here"],
    "andEven": [
      "deeply": ["nested", "json"]
    ]
  ]
)
1
2
3
4
5
6
7
8
9
10
11
[AppDelegate.braze logCustomEvent:@"YOUR-EVENT-NAME"
                       properties:@{
  @"you": @"can",
  @"pass": @(NO),
  @"orNumbers": @42,
  @"orDates": [NSDate date],
  @"or": @[@"any", @"array", @"here"],
  @"andEven": @{
    @"deeply": @[@"nested", @"json"]
  }
}];
1
2
3
4
5
braze.logCustomEvent('custom_event_with_properties', properties: {
    'key1': 'value1',
    'key2': ['value2', 'value3'],
    'key3': false,
});

Enregistrer des custom events avec un objet de propriétés :

1
2
3
4
5
var properties = {};
properties["key1"] = "value1";
properties["key2"] = ["value2", "value3"];
properties["key3"] = false;
BrazePlugin.logCustomEvent("YOUR-EVENT-NAME", properties);

Vous pouvez également transmettre des propriétés en ligne :

1
2
3
4
BrazePlugin.logCustomEvent("YOUR-EVENT-NAME", {
  "key": "value",
  "amount": 42,
});

L’application exemple officielle Cordova comprend des propriétés de type chaîne de caractères, numérique, booléen, tableau et objet imbriqué :

Extrait du projet type :

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
var properties = {};
properties["One"] = "That's the Way of the World";
properties["Two"] = "After the Love Has Gone";
properties["Three"] = "Can't Hide Love";
BrazePlugin.logCustomEvent("cordovaCustomEventWithProperties", properties);
BrazePlugin.logCustomEvent("cordovaCustomEventWithoutProperties");
BrazePlugin.logCustomEvent("cordovaCustomEventWithFloatProperties", {
  "Cart Value": 4.95,
  "Cart Item Name": "Spicy Chicken Bites 5 pack"
});
BrazePlugin.logCustomEvent("cordovaCustomEventWithNestedProperties", {
  "array key": [1, "2", false],
  "object key": {
    "k1": "1",
    "k2": 2,
    "k3": false,
  },
  "deep key": {
    "key": [1, "2", true]
  }
});

Pour plus d’informations sur l’API et le pont natif, veuillez consulter :

1
2
3
4
5
Braze.logCustomEvent("custom_event_with_properties", {
    key1: "value1",
    key2: ["value2", "value3"],
    key3: false,
});
1
m.Braze.logEvent("YOUR_EVENT_NAME", {"stringPropKey" : "stringPropValue", "intPropKey" : Integer intPropValue})
1
AppboyBinding.LogCustomEvent("event name", properties(Dictionary<string, object>));

Bonnes pratiques

Il est important de procéder à trois vérifications afin que les propriétés d’événement de votre événement personnalisé soient enregistrées comme prévu :

Plusieurs propriétés peuvent être consignées chaque fois qu’un événement personnalisé est journalisé.

Vérifier les événements

Vérifiez auprès de vos développeurs quelles propriétés d’événement sont suivies. Gardez à l’esprit que toutes les propriétés de l’événement sont sensibles à la casse. Pour plus d’informations sur le suivi des événements personnalisés, consultez ces articles en fonction de votre plateforme :

Vérifier le journal

Pour confirmer que les propriétés de l’événement sont bien suivies, vous pouvez afficher toutes les propriétés de l’événement à partir de la page Événements personnalisés.

  1. Sélectionnez Paramètres des données > Événements personnalisés.
  2. Emplacement/localisation de votre événement personnalisé dans la liste.
  3. Pour votre événement, veuillez sélectionner « Gérer les propriétés » afin d’afficher les noms des propriétés associées à un événement.

Vérifier les valeurs

Après avoir ajouté votre utilisateur en tant qu’utilisateur test, veuillez suivre ces étapes pour vérifier vos valeurs :

  1. Exécutez l’événement personnalisé dans l’application.
  2. Attendez environ 10 secondes pour que les données se déversent.
  3. Actualisez le journal des événements utilisateurs pour afficher l’événement personnalisé et la valeur de la propriété d’événement qui lui a été transmise.
New Stuff!