Passer au contenu

Cette page a été traduite automatiquement et peut contenir des inexactitudes. Pour signaler une erreur de traduction, utilisez le module de commentaires en bas de la table des matières, à droite de la page.

Personnalisation sans copie à l’aide de CDI

Découvrez comment synchroniser les déclencheurs Canvas à l’aide de CDI pour une personnalisation sans copie. Cette fonctionnalité accède aux informations spécifiques à l’utilisateur depuis votre solution de stockage de données et les transmet à un Canvas de destination. Les étapes du Canvas peuvent éventuellement inclure des champs de personnalisation qui ne sont pas conservés dans les profils utilisateurs Braze.

Synchronisation des déclencheurs Canvas

Étapes de démarrage rapide

Si vous connaissez déjà Braze CDI, notez que la configuration d’une synchronisation de déclencheurs Canvas suit de près le processus des intégrations CDI de données utilisateur, avec les réserves suivantes :

Seuls les identifiants par ID externe ou alias d’utilisateur sont pris en charge. Les adresses e-mail et les numéros de téléphone ne sont pas des identifiants pris en charge.
Seuls les utilisateurs Braze existants peuvent être synchronisés. Il n’est pas possible de créer de nouveaux utilisateurs.
properties remplace la colonne payload. Il s’agit d’une chaîne JSON des champs que vous souhaitez utiliser comme propriétés d’entrée Canvas pour la personnalisation.

Pour commencer, sélectionnez le type de données Canvas Triggers lors de la création d’une nouvelle synchronisation.

Utiliser les déclencheurs Canvas

Étape 1 : Configurer la source de données pour les déclencheurs Canvas

Étape 1.1 : Configurer votre table source dans Snowflake

Vous pouvez utiliser les noms de l’exemple suivant ou choisir vos propres noms de base de données, de schéma et de table. Vous pouvez également utiliser une vue ou une vue matérialisée au lieu d’une table.

CREATE DATABASE BRAZE_CLOUD_PRODUCTION;
CREATE SCHEMA BRAZE_CLOUD_PRODUCTION.INGESTION;
CREATE OR REPLACE TABLE BRAZE_CLOUD_PRODUCTION.INGESTION.CANVAS_TRIGGERS_SYNC (
     UPDATED_AT TIMESTAMP_NTZ(9) NOT NULL DEFAULT SYSDATE(),
     --at least one of external_id or alias_name and alias_label is required
     EXTERNAL_ID VARCHAR(16777216),
     --if using user alias, both alias_name and alias_label are required
     ALIAS_LABEL VARCHAR(16777216),
     ALIAS_NAME VARCHAR(16777216),
     PROPERTIES VARCHAR(16777216)
);

Vous pouvez nommer la base de données, le schéma et la table comme vous le souhaitez, mais les noms de colonnes doivent correspondre à la définition précédente.

UPDATED_AT : L’heure à laquelle cette ligne a été mise à jour ou ajoutée à la table. Braze synchronise les lignes dont la valeur UPDATED_AT est postérieure à la dernière valeur synchronisée. Les lignes situées exactement à l’horodatage limite peuvent être resynchronisées si de nouvelles lignes partagent le même horodatage.
Soit external_id, soit alias_name et alias_label comme colonne d’identifiant utilisateur. Ces colonnes identifient les utilisateurs pour lesquels vous souhaitez déclencher l’envoi de messages Canvas.
- EXTERNAL_ID : Identifie l’utilisateur à faire entrer dans le Canvas. Cette valeur doit correspondre à la valeur external_id utilisée dans Braze.
- ALIAS_NAME et ALIAS_LABEL : Ces colonnes créent un objet alias d’utilisateur. alias_name doit être un identifiant unique, et alias_label spécifie le type d’alias. Les utilisateurs peuvent avoir plusieurs alias avec différentes étiquettes, mais un seul alias_name par alias_label.
PROPERTIES : Une chaîne JSON de champs à rendre disponibles en tant que propriétés de personnalisation dans votre Canvas. Elle doit contenir des informations spécifiques à l’utilisateur.

Remarque

Les propriétés ne sont pas requises pour chaque ligne ou utilisateur. Cependant, les valeurs des propriétés doivent être une chaîne JSON valide. Saisissez une chaîne {} vide s’il n’y a pas de propriétés pour la ligne.

Étape 1.2 : Configurer les identifiants

Configurez un rôle, un entrepôt et un utilisateur, puis accordez les permissions appropriées. Si vous disposez déjà d’identifiants provenant d’une synchronisation existante, vous pouvez les réutiliser, mais assurez-vous d’étendre l’accès à la table source des déclencheurs Canvas.

CREATE ROLE BRAZE_INGESTION_ROLE;

GRANT USAGE ON DATABASE BRAZE_CLOUD_PRODUCTION TO ROLE BRAZE_INGESTION_ROLE;
GRANT USAGE ON SCHEMA BRAZE_CLOUD_PRODUCTION.INGESTION TO ROLE BRAZE_INGESTION_ROLE;
GRANT SELECT ON TABLE BRAZE_CLOUD_PRODUCTION.INGESTION.CANVAS_TRIGGERS_SYNC TO ROLE BRAZE_INGESTION_ROLE;

CREATE WAREHOUSE BRAZE_INGESTION_WAREHOUSE;
GRANT USAGE ON WAREHOUSE BRAZE_INGESTION_WAREHOUSE TO ROLE BRAZE_INGESTION_ROLE;

CREATE USER BRAZE_INGESTION_USER;
GRANT ROLE BRAZE_INGESTION_ROLE TO USER BRAZE_INGESTION_USER;

Étape 1.3 : Configurer les politiques réseau

Si votre compte dispose de politiques réseau, ajoutez les adresses IP de Braze à la liste autorisée pour permettre la connexion au service CDI. Pour la liste des adresses IP, consultez Ingestion de données cloud.

Étape 1.1 : Configurer votre table source dans Redshift

CREATE DATABASE BRAZE_CLOUD_PRODUCTION;
CREATE SCHEMA BRAZE_CLOUD_PRODUCTION.INGESTION;
CREATE TABLE BRAZE_CLOUD_PRODUCTION.INGESTION.CANVAS_TRIGGERS_SYNC (
    updated_at timestamptz default sysdate not null,
    --at least one of external_id or alias_name and alias_label is required
    external_id varchar not null,.
    --if using user alias, both alias_name and alias_label are required
    alias_label varchar,
    alias_name varchar,
    properties varchar(max)
 );

Vous pouvez nommer la base de données, le schéma et la table comme vous le souhaitez, mais les noms de colonnes doivent correspondre à la définition précédente.

UPDATED_AT : L’heure à laquelle cette ligne a été mise à jour ou ajoutée à la table. Braze synchronise les lignes dont la valeur UPDATED_AT est postérieure à la dernière valeur synchronisée. Les lignes situées exactement à l’horodatage limite peuvent être resynchronisées si de nouvelles lignes partagent le même horodatage.
Soit external_id, soit alias_name et alias_label comme colonne d’identifiant utilisateur. Ces colonnes identifient les utilisateurs pour lesquels vous souhaitez déclencher l’envoi de messages Canvas.
- EXTERNAL_ID : Identifie l’utilisateur à faire entrer dans le Canvas. Cette valeur doit correspondre à la valeur external_id utilisée dans Braze.
- ALIAS_NAME et ALIAS_LABEL : Ces colonnes créent un objet alias d’utilisateur. alias_name doit être un identifiant unique, et alias_label spécifie le type d’alias. Les utilisateurs peuvent avoir plusieurs alias avec différentes étiquettes, mais un seul alias_name par alias_label.
PROPERTIES : Une chaîne JSON de champs à rendre disponibles en tant que propriétés de personnalisation dans votre Canvas. Elle doit contenir des informations spécifiques à l’utilisateur.

Remarque

Étape 1.2 : Configurer les identifiants

CREATE USER braze_user PASSWORD '{password}';
GRANT USAGE ON SCHEMA BRAZE_CLOUD_PRODUCTION.INGESTION to braze_user;
GRANT SELECT ON TABLE CANVAS_TRIGGERS_SYNC TO braze_user;

Étape 1.3 : Configurer les politiques réseau

Étape 1.1 : Créer un nouveau projet ou jeu de données pour votre table source (optionnel)

CREATE SCHEMA BRAZE-CLOUD-PRODUCTION.INGESTION;

Étape 1.2 : Configurer votre table source dans BigQuery

Référez-vous aux éléments suivants lors de la création de votre table source :

Nom du champ	Type	Obligatoire ?
`UPDATED_AT`	Timestamp	Oui
`PROPERTIES`	JSON	Oui
`EXTERNAL_ID`	STRING	NULLABLE
`ALIAS_NAME`	STRING	NULLABLE
`ALIAS_LABEL`	STRING	NULLABLE

Remarque

CREATE TABLE `BRAZE-CLOUD-PRODUCTION.INGESTION.CANVAS_TRIGGERS_SYNC`
(
  updated_at TIMESTAMP DEFAULT current_timestamp,
  --At least one of external_id or alias_name and alias_label is required
  external_id STRING,
  --If using user alias, both alias_name and alias_label are required
  alias_name STRING,
  alias_label STRING,
  properties JSON
);

Étape 1.3 : Configurer les identifiants

Créez un utilisateur et accordez les permissions. Si vous disposez déjà d’identifiants provenant d’une autre synchronisation, vous pouvez les réutiliser tant qu’ils ont accès à la table des déclencheurs Canvas.

Permission	Objectif
BigQuery Connection User	Permet à Braze de se connecter.
BigQuery User	Permet à Braze d’exécuter des requêtes, de lire les métadonnées et de lister les tables.
BigQuery Data Viewer	Permet à Braze de visualiser les jeux de données et leur contenu.
BigQuery Job User	Permet à Braze d’exécuter des tâches.

Après avoir accordé les permissions, configurez la méthode d’authentification de Braze en tant que compte de service :

Workload Identity Federation : Liez le principal Braze au compte de service, afin de ne pas avoir à créer de clé. Pour les étapes, consultez Configurer Google Cloud pour Workload Identity Federation.

Clé de compte de service : Générez une clé JSON. Consultez Créer et supprimer des clés pour les instructions. Vous la téléverserez dans le tableau de bord de Braze ultérieurement.

Étape 1.4 : Configurer les politiques réseau

Étape 1.1 : Créer un catalogue ou un schéma pour votre table source

CREATE SCHEMA BRAZE-CLOUD-PRODUCTION.INGESTION;

Étape 1.2 : Configurer votre table source dans Databricks

Référez-vous aux éléments suivants lors de la création de votre table source :

Nom du champ	Type	Obligatoire
`UPDATED_AT`	Timestamp	Oui
`PROPERTIES`	JSON	Oui
`EXTERNAL_ID`	STRING	NULLABLE
`ALIAS_NAME`	STRING	NULLABLE
`ALIAS_LABEL`	STRING	NULLABLE

Vous pouvez nommer le schéma et la table comme vous le souhaitez, mais les noms de colonnes doivent correspondre à la définition précédente.

UPDATED_AT : L’heure à laquelle cette ligne a été mise à jour ou ajoutée à la table. Braze synchronise les lignes dont la valeur UPDATED_AT est postérieure à la dernière valeur synchronisée. Les lignes situées exactement à l’horodatage limite peuvent être resynchronisées si de nouvelles lignes partagent le même horodatage.
Soit external_id, soit alias_name et alias_label comme colonne d’identifiant utilisateur. Ces colonnes identifient les utilisateurs pour lesquels vous souhaitez déclencher l’envoi de messages Canvas.
- EXTERNAL_ID : Identifie l’utilisateur à faire entrer dans le Canvas. Cette valeur doit correspondre à la valeur external_id utilisée dans Braze.
- ALIAS_NAME et ALIAS_LABEL : Ces colonnes créent un objet alias d’utilisateur. alias_name doit être un identifiant unique, et alias_label spécifie le type d’alias. Les utilisateurs peuvent avoir plusieurs alias avec différentes étiquettes, mais un seul alias_name par alias_label.
PROPERTIES : Une chaîne ou une structure de champs à rendre disponibles en tant que propriétés de personnalisation dans votre Canvas. Elle doit contenir des informations spécifiques à l’utilisateur.

Remarque

Les propriétés ne sont pas requises pour chaque ligne ou utilisateur. Cependant, les valeurs des propriétés doivent être des chaînes JSON valides. Saisissez une chaîne {} vide s’il n’y a pas de propriétés pour la ligne.

CREATE TABLE `BRAZE-CLOUD-PRODUCTION.INGESTION.USERS_ATTRIBUTES_SYNC`
(
  updated_at TIMESTAMP DEFAULT current_timestamp(),
  --At least one of external_id or alias_name and alias_label is required
  external_id STRING,
  --If using user alias, both alias_name and alias_label are required
  alias_name STRING,
  alias_label STRING,
  properties STRING, STRUCT, or MAP
);

Étape 1.3 : Configurer les identifiants

Créez un principal de service avec des identifiants OAuth machine-à-machine (M2M) (recommandé), ou un jeton d’accès personnel. Si vous disposez déjà d’identifiants provenant d’une autre synchronisation, vous pouvez les réutiliser tant qu’ils ont accès à la table des déclencheurs Canvas.

OAuth M2M : Créez un principal de service, générez un secret client, accordez au principal de service la permission Can use sur votre entrepôt SQL, puis accordez-lui le droit SELECT sur la table des déclencheurs Canvas. Pour les étapes, consultez Créer des identifiants pour Braze.

Jeton d’accès personnel :

Sélectionnez votre nom d’utilisateur, puis sélectionnez User Settings.
Dans l’onglet Access tokens, sélectionnez Generate new token.
Ajoutez un commentaire pour identifier le jeton, par exemple « Braze CDI ».
Laissez le champ Lifetime (days) vide pour une durée illimitée, puis sélectionnez Generate.
Copiez et enregistrez le jeton en lieu sûr pour l’utiliser dans le tableau de bord de Braze.

Étape 1.4 : Configurer les politiques réseau

Étape 1.1 : Configurer votre table source dans Fabric

CREATE OR ALTER TABLE [warehouse].[schema].[CDI_table_name]
(
  UPDATED_AT DATETIME2(6) NOT NULL,
  PROPERTIES VARCHAR NOT NULL,
  --at least one of external_id or alias_name and alias_label is required
  EXTERNAL_ID VARCHAR,
  --if using user alias, both alias_name and alias_label are required
  ALIAS_NAME VARCHAR,
  ALIAS_LABEL VARCHAR
)
GO

Étape 1.2 : Configurer les identifiants

Créez un principal de service et accordez les permissions. Si vous disposez déjà d’identifiants provenant d’une autre synchronisation, vous pouvez les réutiliser — assurez-vous simplement qu’ils ont accès à la table des comptes.

Étape 1.3 : Configurer les politiques réseau

Pour synchroniser les déclencheurs Canvas à partir du stockage de fichiers, créez un fichier source avec les champs suivants.

Champ	Obligatoire	Description
`EXTERNAL_ID`	Oui, l’un des deux : `external_id` ou `alias_name` et `alias_label`	Identifie l’utilisateur que vous souhaitez mettre à jour. Cette valeur doit correspondre à la valeur `external_id` utilisée dans Braze.
`ALIAS_NAME` et `ALIAS_LABEL`	Oui, l’un des deux : `external_id` ou `alias_name` et `alias_label`	Ces deux colonnes créent un objet alias d’utilisateur. `alias_name` doit être un identifiant unique, et `alias_label` spécifie le type d’alias. Les utilisateurs peuvent avoir plusieurs alias avec différentes étiquettes, mais un seul `alias_name` par `alias_label`.
`PROPERTIES`	Oui	Chaîne JSON de champs à rendre disponibles en tant que propriétés de personnalisation dans votre Canvas. Elle doit contenir des informations spécifiques à l’utilisateur.

Conseil

Les noms de fichiers doivent respecter les règles AWS et être uniques. Ajoutez des horodatages pour garantir l’unicité. Pour en savoir plus sur la synchronisation Amazon S3, consultez Intégrations de stockage de fichiers.

Étape 2 : Configurer votre Canvas de destination

Configurez votre Canvas de destination pour les déclencheurs Canvas. Créez un nouveau Canvas ou sélectionnez un Canvas existant déclenché par API. Consultez Types de planification d’entrée pour savoir comment créer un Canvas avec un type de planification de réception déclenchée par API.
Après avoir sélectionné le type de planification de réception déclenchée par API, poursuivez la configuration et construisez votre Canvas. Les Canvas peuvent aller de simples envois de messages uniques à des workflows clients complexes comportant plusieurs étapes.
Au sein de vos étapes Canvas, utilisez les propriétés d’entrée Canvas pour personnaliser les messages avec les champs de propriétés que vous prévoyez de synchroniser depuis votre table source.
- Par exemple, si à l’étape 1 vous avez instrumenté un champ de propriétés pour account_balance, vous utiliseriez le modèle Liquid suivant pour personnaliser votre message : \{\{canvas_entry_properties.\$\{account_balance\}\}\}.
Après avoir construit votre Canvas, lancez-le et passez à l’étape 3.

Étape 3 : Créer votre synchronisation zero copy

Une fois la configuration de votre source terminée et votre Canvas de destination lancé, créez une nouvelle synchronisation de données :

Dans Braze, accédez à Data Settings > Cloud Data Ingestion.
Configurez la connexion en saisissant les détails de connexion (ou en réutilisant des identifiants existants) et la table source de l’étape 1.
Donnez un nom à l’intégration.
Sélectionnez le type de données Canvas triggers.
Choisissez votre Canvas de destination (depuis l’étape 2).
Choisissez une fréquence de synchronisation.
Configurez les préférences de notification.
Sélectionnez Test Connection pour confirmer que tout fonctionne comme prévu. Si vous vous connectez à Snowflake, ajoutez d’abord la clé publique affichée sur le tableau de bord à l’utilisateur créé pour que Braze se connecte à Snowflake. Pour effectuer cette étape, vous aurez besoin d’un accès SECURITYADMIN ou supérieur dans Snowflake.
Enregistrez la synchronisation pour commencer à synchroniser les déclencheurs Canvas.

Lorsque la synchronisation s’exécute, les utilisateurs de votre table source commencent à entrer dans le Canvas. Utilisez l’analyse Canvas et la page des journaux de synchronisation de l’ingestion de données cloud pour surveiller les performances.

Conseil

Passez en revue l’ensemble de votre configuration (du comportement de synchronisation à la configuration du Canvas) pour éviter les envois inattendus. Les paramètres Canvas tels que la limitation du débit, la limite de fréquence et les filtres de segmentation peuvent affiner davantage la réception des messages.

Nous recommandons d’effectuer un essai avec une audience restreinte ou de test avant de mettre en œuvre des cas d’usage en production.

Points à prendre en compte

Les déclencheurs Canvas CDI utilisent votre limite de débit de la REST API pour /canvas/trigger/send. Si vous utilisez cet endpoint simultanément avec les déclencheurs Canvas CDI et votre intégration REST API, attendez-vous à ce que l’utilisation combinée soit comptabilisée dans votre limite de débit.

Chaque exécution de synchronisation fait entrer les utilisateurs dans leur Canvas de destination respectif à un taux maximal d’environ 3,75 millions d’utilisateurs par heure. Prévoyez des temps d’entrée plus longs entre la source et le Canvas dans les cas suivants :

Synchronisation de plus de 3,75 millions d’utilisateurs par exécution de synchronisation.
Utilisation des déclencheurs Canvas CDI alors que vous saturez déjà la limite de débit de votre REST API pour /canvas/trigger/send.

Points à prendre en compte concernant le CDI zero copy lorsque l’archivage des messages est activé :

Les résultats de la table sont temporairement stockés dans Braze pendant le traitement. Ils sont également exportés vers Snowflake pendant 30 jours afin que vous puissiez voir exactement ce qui a été synchronisé.
Les messages archivés ne sont enregistrés nulle part dans Braze. Les copies sont envoyées pour être stockées exclusivement dans votre stockage configuré.
Lors de l’utilisation du CDI zero copy avec les déclencheurs Canvas, Braze ne conserve pas de sauvegarde des résultats de requête provenant de l’entrepôt de données et aucune donnée n’est copiée dans le profil utilisateur.
Les propriétés de contexte Canvas peuvent être journalisées dans les systèmes internes pendant une durée maximale de 30 jours.

New Stuff!