Campagnes API

Cet article de référence explique comment générer un campaign_id à inclure dans vos appels API et comment configurer cette campagne.

Les campagnes API sont généralement utilisées pour l’envoi de messages transactionnels. Lors de la création de campagnes API (et non de campagnes déclenchées par l’API), le tableau de bord de Braze n’est utilisé que pour générer un campaign_id, qui vous permet de suivre l’analytique pour les rapports de campagne. Vous pouvez également générer un ID de variante de message, qui est différent pour chaque variante de votre campagne.

Vous enverrez ensuite ces informations à votre équipe de développement pour les utiliser dans la requête API, avec les éléments suivants :

• Contenu de la campagne
• Appartenance à l’audience
• Ressources

Après le début de la campagne, vous pouvez consulter les résultats dans le tableau de bord. Les campagnes API utilisent les API d’envoi de messages de Braze, qui disposent des mêmes options de reporting détaillé et de reciblage que les campagnes créées entièrement via le tableau de bord.

Avertissement

Étant donné que les campagnes API sont généralement transactionnelles, tous les utilisateurs sont éligibles pour les campagnes API, y compris ceux de votre Groupe de contrôle global. Un en-tête de liste de désabonnement en un clic n’est pas ajouté à ces envois. Si vous souhaitez ajouter un en-tête de liste de désabonnement en un clic à toutes les campagnes API, contactez votre gestionnaire de la satisfaction client.

Créer une nouvelle campagne

Allez dans Messaging > Campaigns et sélectionnez Create Campaign, puis sélectionnez API Campaigns. Vous pouvez maintenant passer à la configuration de votre campagne API.

Une campagne déclenchée par l’API est différente d’une campagne API.

Configurer votre campagne

Pour configurer votre campagne, procédez comme suit :

1. Ajoutez un titre descriptif pour pouvoir retrouver les résultats sur la page Campaigns après avoir envoyé vos messages.
2. Cliquez sur Add Message et ajoutez les types de messages qui seront inclus dans votre campagne API. Cela vous permettra de générer un campaign_id et un ID de variante de message, qui diffère pour chaque canal que vous ajoutez.
3. Vous pouvez éventuellement ajouter un événement de conversion pour suivre les conversions des utilisateurs sur une action spécifique ou un objectif de campagne.
4. Cliquez sur Save Campaign et vous êtes prêt à lancer votre campagne API !

Appels API

Après avoir enregistré votre campagne API, incluez les éléments suivants dans votre requête API :

• Les champs campaign_id générés avec votre requête API, comme indiqué dans les endpoints d’envoi de messages.
• Un objet message pour chaque plateforme incluse dans la campagne. Dans l’objet message, renseignez l’ID de variante de message. Cela permet de spécifier que les statistiques doivent être collectées et affichées sous cette variante. Les objets message suivants sont pris en charge : Android, Content Cards, e-mail, iOS, Kindle, SMS/MMS, notification push Web et webhook.