Skip to content

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.

Envoyez 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.

Créer une nouvelle campagne

Accédez à 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, effectuez les étapes suivantes :

  1. Ajoutez un titre descriptif afin de pouvoir retrouver les résultats sur la page des campagnes après l’envoi de vos messages.
  2. Sélectionnez Add Message et ajoutez les types de messages inclus dans votre campagne API. Cela vous permet de générer un campaign_id et un ID de variante de message, qui diffère pour chaque canal que vous incluez.
  3. Vous pouvez éventuellement ajouter un événement de conversion pour suivre les conversions des utilisateurs sur une action ou un objectif de campagne spécifique.
  4. Sélectionnez Save Campaign pour 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, fournissez l’ID de variante du message. Cela indique 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.

Ajouter la liste de désabonnement en un clic aux campagnes API

Par défaut, Braze n’ajoute pas l’en-tête de liste de désabonnement en un clic aux campagnes API. Vous pouvez ajouter cet en-tête à des envois individuels de campagnes API en incluant l’étiquette Liquid {{${set_user_to_one_click_list_unsubscribe}}} dans le champ des en-têtes d’e-mail de votre requête API.

Pour respecter la norme RFC 8058 relative à la liste de désabonnement en un clic, incluez les en-têtes List-Unsubscribe et List-Unsubscribe-Post dans votre requête API :

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

{
  "external_user_ids": ["user_id"],
  "messages": {
    "email": {
      "app_id": "your_app_id",
      "subject": "Your Subject",
      "from": "Sender Name <[email protected]>",
      "body": "<p>Email body content</p>",
      "headers": {
        "List-Unsubscribe": "<{{${set_user_to_one_click_list_unsubscribe}}}>",
        "List-Unsubscribe-Post": "List-Unsubscribe=One-Click"
      }
    }
  }
}

Ajouter des pièces jointes aux e-mails

Pour ajouter des pièces jointes aux e-mails d’une campagne API, incluez un tableau attachments dans l’objet e-mail. Vous pouvez référencer un modèle d’e-mail créé dans l’éditeur par glisser-déposer ou l’éditeur HTML en fournissant son email_template_id dans l’objet e-mail, puis ajouter des pièces jointes via l’appel API.

Pour plus de détails sur les pièces jointes, les limites de taille et les bonnes pratiques, consultez Exemple d’objet e-mail avec pièce jointe.
New Stuff!