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éthode logCustomEvent 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 l'étiquette d'action Braze. Les paramètres inclus sont le « type d'étiquette » (événement personnalisé), le « nom de l'é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');

Utilisez la méthode du plugin Braze cordova :

1

BrazePlugin.logCustomEvent("YOUR_EVENT_NAME");

L’API logCustomEvent accepte :

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

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

Pour plus de détails sur l’implémentation, consultez 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 à une localisation. requestImmediateDataFlush garantit 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 de type string, numeric, boolean, des objets Date, des tableaux ou des objets JSON imbriqués.

Pour ajouter des propriétés de métadonnées, 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,
});

Enregistrez des événements personnalisés 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 exemple :

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, consultez :

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

Trois vérifications importantes vous permettront de vous assurer que les propriétés de vos événements personnalisés sont enregistrées comme prévu :

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

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 d’é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 d’événement sont bien suivies, vous pouvez afficher toutes les propriétés d’événement depuis la page Événements personnalisés.

  1. Accédez à Paramètres des données > Événements personnalisés.
  2. Localisez votre événement personnalisé dans la liste.
  3. Pour votre événement, sélectionnez 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, suivez 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 soient transmises.
  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.

Résolution des problèmes liés aux événements personnalisés

Utilisez ces scénarios pour résoudre les problèmes d’enregistrement des événements personnalisés sur les différents SDK.

Vérifier le déclencheur de l’événement personnalisé

Si un événement personnalisé n’apparaît pas, il est possible que l’action suivie dans votre application ne corresponde pas à l’action que vous testez.

  • Confirmez avec votre équipe de développement quelle action de l’application déclenche l’événement personnalisé.
  • Vérifiez s’il existe des chemins de code obsolètes après les mises à jour du SDK, comme des références à appboy au lieu de braze.

Les événements personnalisés sont enregistrés sur un profil anonyme

Si vous n’identifiez pas un utilisateur avant d’enregistrer un événement personnalisé, Braze peut associer cet événement à un profil anonyme.

  • Appelez changeUser() avant d’exécuter l’événement personnalisé afin que Braze l’enregistre sur un profil utilisateur identifié.
  • Testez avec un utilisateur test identifié, puis consultez le journal des événements utilisateurs.

Vérifier la configuration de l’enregistrement des événements personnalisés

Si les événements personnalisés n’apparaissent pas comme prévu, confirmez que votre équipe de développement a bien implémenté l’enregistrement des événements personnalisés pour la bonne action de l’application.

  • Demandez à votre équipe de développement de vérifier que l’événement est correctement enregistré et déclenché par l’action utilisateur attendue.
  • Lorsque votre équipe ouvre un ticket auprès de l’assistance Braze, incluez les journaux détaillés et les extraits de code pertinents.
  • Si votre application utilise Swift ou Android, votre équipe de développement peut utiliser les conditions préalables du débogueur SDK pour générer des journaux détaillés.
  • Si votre équipe de développement ne parvient pas à identifier le problème, ouvrez un ticket auprès de l’assistance Braze.
Github   Modifier cette page sur GitHub
New Stuff!