Enregistrer les analyses
Lors de la création d’une interface utilisateur personnalisée pour les Content Cards, vous devez enregistrer manuellement les données analytiques telles que les impressions, les clics et les rejets, car cela n’est géré automatiquement que pour les modèles de cartes par défaut. L’enregistrement de ces événements fait partie intégrante de l’intégration des Content Cards et est essentiel pour garantir l’exactitude des rapports et de la facturation des campagnes. Pour ce faire, alimentez votre interface utilisateur personnalisée avec les données provenant des modèles de données Braze, puis enregistrez manuellement les événements. Une fois que vous avez compris comment enregistrer les analyses, vous pouvez découvrir les façons courantes dont les clients de Braze créent des Content Cards personnalisées.
Enregistrer les analyses
Lorsque vous implémentez vos Content Cards personnalisées, vous pouvez analyser les objets des cartes de contenu et extraire leurs données utiles, telles que title, cardDescription et imageUrl. Vous pouvez ensuite utiliser les données du modèle résultant pour alimenter votre interface utilisateur personnalisée.
Pour obtenir les modèles de données des cartes de contenu, abonnez-vous aux mises à jour des cartes de contenu. Deux propriétés méritent une attention particulière :
id: Représente la chaîne de caractères de l’ID de la carte de contenu. Il s’agit de l’identifiant unique utilisé pour enregistrer les analyses des Content Cards personnalisées.extras: Englobe toutes les paires clé-valeur du tableau de bord de Braze.
Toutes les propriétés autres que id et extras sont facultatives pour l’analyse des Content Cards personnalisées. Pour plus d’informations sur le modèle de données, consultez l’article sur l’intégration de chaque plateforme : Android, iOS, Web.
Enregistrez une fonction de rappel pour vous abonner aux mises à jour lorsque les cartes sont actualisées.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
import * as braze from "@braze/web-sdk";
braze.subscribeToContentCardsUpdates((updates) => {
const cards = updates.cards;
// For example:
cards.forEach(card => {
if (card.isControl) {
// Do not display the control card, but remember to call `logContentCardImpressions([card])`
}
else if (card instanceof braze.ClassicCard || card instanceof braze.CaptionedImage) {
// Use `card.title`, `card.imageUrl`, etc.
}
else if (card instanceof braze.ImageOnly) {
// Use `card.imageUrl`, etc.
}
})
});
braze.openSession();
Les Content Cards ne seront actualisées au démarrage de la session que si une demande d’abonnement est appelée avant openSession(). Vous pouvez également choisir d’actualiser manuellement le flux.
Étape 1 : Créer une variable privée pour l’utilisateur abonné
Pour vous abonner aux mises à jour des cartes, commencez par déclarer une variable privée dans votre classe personnalisée, qui contiendra votre abonné :
1
2
// subscriber variable
private IEventSubscriber<ContentCardsUpdatedEvent> mContentCardsUpdatedSubscriber;
Étape 2 : S’abonner aux mises à jour
Ensuite, ajoutez le code suivant pour vous abonner aux mises à jour des Content Cards de Braze, généralement à l’intérieur de la méthode Activity.onCreate() de votre activité personnalisée de Content Cards :
1
2
3
4
5
6
7
8
9
10
11
12
13
// Remove the previous subscriber before rebuilding a new one with our new activity.
Braze.getInstance(context).removeSingleSubscription(mContentCardsUpdatedSubscriber, ContentCardsUpdatedEvent.class);
mContentCardsUpdatedSubscriber = new IEventSubscriber<ContentCardsUpdatedEvent>() {
@Override
public void trigger(ContentCardsUpdatedEvent event) {
// List of all Content Cards
List<Card> allCards = event.getAllCards();
// Your logic below
}
};
Braze.getInstance(context).subscribeToContentCardsUpdates(mContentCardsUpdatedSubscriber);
Braze.getInstance(context).requestContentCardsRefresh();
Étape 3 : Se désabonner
Nous vous recommandons également de vous désabonner lorsque votre activité personnalisée n’est plus visible. Ajoutez le code suivant à la méthode de cycle de vie onDestroy() de votre activité :
1
Braze.getInstance(context).removeSingleSubscription(mContentCardsUpdatedSubscriber, ContentCardsUpdatedEvent.class);
Étape 1 : Créer une variable privée pour l’utilisateur abonné
Pour vous abonner aux mises à jour des cartes, commencez par déclarer une variable privée dans votre classe personnalisée, qui contiendra votre abonné :
1
private var contentCardsUpdatedSubscriber: IEventSubscriber<ContentCardsUpdatedEvent>? = null
Étape 2 : S’abonner aux mises à jour
Ensuite, ajoutez le code suivant pour vous abonner aux mises à jour des Content Cards de Braze, généralement à l’intérieur de la méthode Activity.onCreate() de votre activité personnalisée de Content Cards :
1
2
3
4
5
6
7
8
9
10
// Remove the previous subscriber before rebuilding a new one with our new activity.
Braze.getInstance(context).removeSingleSubscription(contentCardsUpdatedSubscriber, ContentCardsUpdatedEvent::class.java)
contentCardsUpdatedSubscriber = IEventSubscriber { event ->
// List of all Content Cards
val allCards = event.allCards
// Your logic below
}
Braze.getInstance(context).subscribeToContentCardsUpdates(contentCardsUpdatedSubscriber)
Braze.getInstance(context).requestContentCardsRefresh(true)
Étape 3 : Se désabonner
Nous vous recommandons également de vous désabonner lorsque votre activité personnalisée n’est plus visible. Ajoutez le code suivant à la méthode de cycle de vie onDestroy() de votre activité :
1
Braze.getInstance(context).removeSingleSubscription(contentCardsUpdatedSubscriber, ContentCardsUpdatedEvent::class.java)
Pour accéder au modèle de données des Content Cards, appelez contentCards.cards sur votre instance braze.
1
let cards: [Braze.ContentCard] = AppDelegate.braze?.contentCards.cards
Vous pouvez également gérer un abonnement pour observer les changements dans vos Content Cards. Deux approches sont possibles :
- Gérer un objet annulable ; ou
- Gérer un
AsyncStream.
Annulable
1
2
3
4
5
6
// This subscription is maintained through a Braze cancellable, which will observe for changes until the subscription is cancelled.
// You must keep a strong reference to the cancellable to keep the subscription active.
// The subscription is canceled either when the cancellable is deinitialized or when you call its `.cancel()` method.
let cancellable = AppDelegate.braze?.contentCards.subscribeToUpdates { [weak self] contentCards in
// Implement your completion handler to respond to updates in `contentCards`.
}
AsyncStream
1
let stream: AsyncStream<[Braze.ContentCard]> = AppDelegate.braze?.contentCards.cardsStream
1
NSArray<BRZContentCardRaw *> *contentCards = AppDelegate.braze.contentCards.cards;
Si vous souhaitez gérer un abonnement à vos cartes de contenu, vous pouvez appeler subscribeToUpdates :
1
2
3
4
// This subscription is maintained through Braze cancellable, which will continue to observe for changes until the subscription is cancelled.
BRZCancellable *cancellable = [self.braze.contentCards subscribeToUpdates:^(NSArray<BRZContentCardRaw *> *contentCards) {
// Implement your completion handler to respond to updates in `contentCards`.
}];
Pour obtenir les données des Content Cards, utilisez la méthode getContentCards :
1
2
3
import Braze from "@braze/react-native-sdk";
const cards = await Braze.getContentCards();
Pour être informé des mises à jour, abonnez-vous aux événements de mise à jour des Content Cards :
1
2
3
4
5
6
7
8
9
10
const subscription = Braze.addListener(Braze.Events.CONTENT_CARDS_UPDATED, (update) => {
const cards = update.cards;
cards.forEach(card => {
if (card.isControl) {
// Do not display the control card, but remember to log an impression
} else {
// Use card.title, card.cardDescription, card.image, etc.
}
});
});
Pour demander une actualisation manuelle des Content Cards depuis les serveurs Braze :
1
Braze.requestContentCardsRefresh();
Pour obtenir des Content Cards mises en cache sans requête réseau :
1
const cachedCards = await Braze.getCachedContentCards();
Enregistrer les événements
L’enregistrement d’indicateurs utiles, tels que les impressions, les clics et les rejets, est simple et rapide. Définissez un écouteur de clic personnalisé pour traiter manuellement ces analyses.
Enregistrez les événements d’impression lorsque les cartes sont vues par les utilisateurs avec logContentCardImpressions :
1
2
3
import * as braze from "@braze/web-sdk";
braze.logContentCardImpressions([card1, card2, card3]);
Enregistrez les événements de clic lorsque les utilisateurs interagissent avec une carte avec logContentCardClick :
1
2
3
import * as braze from "@braze/web-sdk";
braze.logContentCardClick(card);
Le BrazeManager peut faire référence aux dépendances du SDK Braze, telles que la liste d’objets Content Cards, afin d’obtenir l’objet Card permettant d’appeler les méthodes de journalisation Braze. Utilisez la classe de base ContentCardable pour référencer et fournir facilement des données au BrazeManager.
Pour enregistrer une impression ou un clic sur une carte, appelez respectivement Card.logClick() ou Card.logImpression().
Vous pouvez enregistrer manuellement une carte de contenu ou la définir comme « rejetée » dans Braze pour une carte particulière avec isDismissed. Si une carte est déjà marquée comme rejetée, elle ne peut pas être marquée comme rejetée à nouveau.
Pour créer un écouteur de clic personnalisé, créez une classe qui implémente IContentCardsActionListener et enregistrez-la avec BrazeContentCardsManager. Implémentez la méthode onContentCardClicked(), qui sera appelée lorsque l’utilisateur cliquera sur une Content Card. Ensuite, indiquez à Braze d’utiliser votre écouteur de clic pour les Content Cards.
Par exemple :
1
2
3
4
5
6
7
8
9
10
11
BrazeContentCardsManager.getInstance().setContentCardsActionListener(new IContentCardsActionListener() {
@Override
public boolean onContentCardClicked(Context context, Card card, IAction cardAction) {
return false;
}
@Override
public void onContentCardDismissed(Context context, Card card) {
}
});
Par exemple :
1
2
3
4
5
6
7
8
9
BrazeContentCardsManager.getInstance().contentCardsActionListener = object : IContentCardsActionListener {
override fun onContentCardClicked(context: Context, card: Card, cardAction: IAction): Boolean {
return false
}
override fun onContentCardDismissed(context: Context, card: Card) {
}
}
Pour gérer la variante de contrôle des Content Cards dans votre interface utilisateur personnalisée, transmettez votre objet com.braze.models.cards.Card, puis appelez la méthode logImpression comme vous le feriez avec n’importe quel autre type de Content Card. L’objet enregistrera implicitement une impression de contrôle pour informer nos analyses du moment où un utilisateur aurait vu la carte de contrôle.
Implémentez le protocole BrazeContentCardUIViewControllerDelegate et définissez votre objet délégué comme la propriété delegate de votre BrazeContentCardUI.ViewController. Ce délégué se chargera de transmettre les données de votre objet personnalisé à Braze pour qu’elles soient enregistrées. Pour un exemple, consultez le tutoriel sur l’interface utilisateur des Content Cards.
1
2
3
4
5
6
7
8
9
10
11
12
// Set the delegate when creating the Content Cards controller
contentCardsController.delegate = delegate
// Method to implement in delegate
func contentCard(
_ controller: BrazeContentCardUI.ViewController,
shouldProcess clickAction: Braze.ContentCard.ClickAction,
card: Braze.ContentCard
) -> Bool {
// Intercept the content card click action here.
return true
}
1
2
3
4
5
6
7
8
9
10
// Set the delegate when creating the Content Cards controller
contentCardsController.delegate = delegate;
// Method to implement in delegate
- (BOOL)contentCardController:(BRZContentCardUIViewController *)controller
shouldProcess:(NSURL *)url
card:(BRZContentCardRaw *)card {
// Intercept the content card click action here.
return YES;
}
Pour gérer la variante de contrôle des Content Cards dans votre interface utilisateur personnalisée, transmettez votre objet Braze.ContentCard.Control, puis appelez la méthode logImpression comme vous le feriez avec n’importe quel autre type de Content Card. L’objet enregistrera implicitement une impression de contrôle pour informer nos analyses du moment où un utilisateur aurait vu la carte de contrôle.
Enregistrez les événements d’impression lorsque les cartes sont consultées par les utilisateurs :
1
Braze.logContentCardImpression(card.id);
Enregistrez les événements de clic lorsque les utilisateurs interagissent avec une carte :
1
Braze.logContentCardClicked(card.id);
Enregistrez les événements de rejet lorsqu’un utilisateur rejette une carte :
1
Braze.logContentCardDismissed(card.id);
Gérer le comportement au clic
Lorsqu’un utilisateur clique sur une Content Card dans un flux personnalisé, le comportement au clic (comme la navigation vers une URL, la création d’un lien profond ou l’enregistrement d’un événement personnalisé) n’est pas géré automatiquement. Utilisez handleBrazeAction pour traiter l’URL de la carte et exécuter l’action au clic configurée, y compris les actions Braze (URLs brazeActions://).
1
2
3
4
5
6
7
8
9
10
11
12
import * as braze from "@braze/web-sdk";
// In your card click handler
function onCardClick(card) {
// Log the click
braze.logContentCardClick(card);
// Handle the on-click behavior
if (card.url) {
braze.handleBrazeAction(card.url);
}
}
| Paramètre | Description |
|---|---|
url |
Une URL valide, ou une URL d’action Braze valide avec le schéma brazeActions://. |
openLinkInNewTab |
(Facultatif) Indique si l’URL doit s’ouvrir dans un nouvel onglet. Par défaut : false. |
Si vous n’appelez pas handleBrazeAction(), les comportements au clic configurés dans le tableau de bord de Braze (tels que « Enregistrer un événement personnalisé » ou « Naviguer vers une URL ») ne s’exécuteront pas pour les cartes affichées dans un flux personnalisé.
Le comportement au clic est géré automatiquement par l’interface utilisateur par défaut des Content Cards. Pour les implémentations personnalisées, utilisez l’interface IContentCardsActionListener décrite dans la section Enregistrer les analyses ci-dessus.
Le comportement au clic est géré automatiquement par l’interface utilisateur par défaut des Content Cards. Pour les implémentations personnalisées, utilisez le protocole BrazeContentCardUIViewControllerDelegate décrit dans la section Enregistrer les analyses ci-dessus.
Modifier cette page sur GitHub