Personalização sem cópia usando CDI
Aprenda a sincronizar gatilhos do Canvas usando CDI para personalização sem cópia. Esse recurso acessa informações específicas do usuário a partir de sua solução de armazenamento de dados e as transmite para um Canvas de destino. As etapas do canva podem incluir, opcionalmente, campos de personalização que não são mantidos nos perfis de usuário do Braze.
CDI Canvas triggers está atualmente em acesso antecipado. Entre em contato com seu gerente de conta Braze se estiver interessado em participar do acesso antecipado.
Sincronização de gatilhos do canva
Etapas para início rápido
Se você já está familiarizado com o Braze CDI, observe que a configuração para uma sincronização de gatilho do Canvas segue de perto o processo para integrações CDI de dados de usuários, com as seguintes ressalvas:
- Apenas identificadores externos de ID ou apelidos de usuário são suportados. E-mails e números de telefone não são identificadores aceitos.
- Apenas usuários existentes do Braze podem ser sincronizados. Não é possível criar novos usuários.
propertiessubstitui apayloadcoluna. Esta é uma string JSON dos campos que você deseja usar como propriedades de entrada do canva para personalização.
Para começar, selecione o tipo de dados Gatilhos do Canvas ao criar uma nova sincronização.
Usando gatilhos do Canvas
Etapa 1: Configurar fonte de dados para acionadores do Canva
Etapa 1.1: Configure sua tabela de origem no Snowflake
Você pode usar os nomes no exemplo a seguir ou escolher seus próprios nomes de banco de dados, esquema e tabela. Você também pode usar uma visão ou uma visão materializada em vez de uma tabela.
1
2
3
4
5
6
7
8
9
10
11
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)
);
Você pode nomear o banco de dados, o esquema e a tabela como desejar, mas os nomes das colunas devem corresponder à definição anterior.
UPDATED_AT: A hora em que esta linha foi atualizada ou adicionada à tabela. Apenas as linhas adicionadas ou atualizadas desde a última sincronização serão sincronizadas.- Ou
external_idoualias_nameealias_labelcomo coluna de identificador do usuário. Estes identificam os usuários para os quais você deseja disparar o envio de mensagens do Canvas.EXTERNAL_ID: Identifica o usuário para entrar no Canva. Esse valor deve corresponder ao valorexternal_idusado no Braze.ALIAS_NAMEeALIAS_LABEL: Essas colunas criam um objeto de alias de usuário.alias_nameDeve ser um identificador exclusivo ealias_labelespecifica o tipo de alias. Os usuários podem ter vários aliases com rótulos diferentes, mas apenas umalias_nameporalias_label.
PROPERTIES: Uma string JSON de campos para disponibilizar como propriedades de personalização no seu canva. Isso deve conter informações específicas do usuário.
As propriedades não são necessárias para todas as linhas ou usuários. No entanto, os valores das propriedades devem ser uma string JSON válida. Insira uma string {}vazia se não houver propriedades para a linha.
Etapa 1.2: Configurar credenciais
Configure uma função, um armazém e um usuário, e conceda as permissões adequadas. Se você já possui credenciais de uma sincronização existente, pode reutilizá-las, mas certifique-se de estender o acesso à tabela de origem dos gatilhos do canva.
1
2
3
4
5
6
7
8
9
10
11
12
13
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;
Etapa 1.3: Configurar políticas de rede
Se sua conta tiver políticas de rede, inclua os IPs da Braze na lista de permissões para ativar a conexão do serviço CDI. Para obter a lista de IPs, consulte Ingestão de dados na nuvem.
Etapa 1.1: Configure sua tabela de origem no Redshift
Você pode usar os nomes no exemplo a seguir ou escolher seus próprios nomes de banco de dados, esquema e tabela. Você também pode usar uma visão ou uma visão materializada em vez de uma tabela.
1
2
3
4
5
6
7
8
9
10
11
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)
);
Você pode nomear o banco de dados, o esquema e a tabela como desejar, mas os nomes das colunas devem corresponder à definição anterior.
UPDATED_AT: A hora em que esta linha foi atualizada ou adicionada à tabela. Apenas as linhas adicionadas ou atualizadas desde a última sincronização serão sincronizadas.- Ou
external_idoualias_nameealias_labelcomo coluna de identificador do usuário. Estes identificam os usuários para os quais você deseja disparar o envio de mensagens do Canvas.EXTERNAL_ID: Identifica o usuário para entrar no Canva. Esse valor deve corresponder ao valorexternal_idusado no Braze.ALIAS_NAMEeALIAS_LABEL: Essas colunas criam um objeto de alias de usuário.alias_nameDeve ser um identificador exclusivo ealias_labelespecifica o tipo de alias. Os usuários podem ter vários aliases com rótulos diferentes, mas apenas umalias_nameporalias_label.
PROPERTIES: Uma string JSON de campos para disponibilizar como propriedades de personalização no seu canva. Isso deve conter informações específicas do usuário.
As propriedades não são necessárias para todas as linhas ou usuários. No entanto, os valores das propriedades devem ser uma string JSON válida. Insira uma string {}vazia se não houver propriedades para a linha.
Etapa 1.2: Configurar credenciais
Configure uma função, um armazém e um usuário e conceda as permissões adequadas. Se você já possui credenciais de uma sincronização existente, pode reutilizá-las, mas certifique-se de estender o acesso à tabela de origem dos gatilhos do canva.
1
2
3
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;
Etapa 1.3: Configurar políticas de rede
Se sua conta tiver políticas de rede, inclua os IPs da Braze na lista de permissões para ativar a conexão do serviço CDI. Para obter a lista de IPs, consulte Ingestão de dados na nuvem.
Etapa 1.1: Crie um novo projeto ou conjunto de dados para sua tabela de origem (opcional)
1
CREATE SCHEMA BRAZE-CLOUD-PRODUCTION.INGESTION;
Etapa 1.2: Configure sua tabela de origem no BigQuery
Consulte o seguinte ao criar sua tabela de origem:
| Nome do campo | Tipo | Necessário? |
|---|---|---|
UPDATED_AT |
Data e hora | Sim |
PROPERTIES |
JSON | Sim |
EXTERNAL_ID |
STRING | NULLABLE |
ALIAS_NAME |
STRING | NULLABLE |
ALIAS_LABEL |
STRING | NULLABLE |
As propriedades não são necessárias para todas as linhas ou usuários. No entanto, os valores das propriedades devem ser uma string JSON válida. Insira uma string {}vazia se não houver propriedades para a linha.
1
2
3
4
5
6
7
8
9
10
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
);
Etapa 1.3: Configurar credenciais
Crie um usuário e conceda permissões. Se você já possui credenciais de outra sincronização, pode reutilizá-las, desde que tenham acesso à tabela de gatilhos do canva.
| Permissão | Finalidade |
|---|---|
| Usuário da conexão BigQuery | Permite que o Braze se conecte. |
| Usuário do BigQuery | Permite que o Braze execute consultas, leia metadados e liste tabelas. |
| Visualizador de dados do BigQuery | Permite que a Braze visualize conjuntos de dados e conteúdos. |
| Usuário de tarefa do BigQuery | Permite que o Braze execute tarefas. |
Após conceder as permissões, gere uma chave JSON. Consulte Criar e excluir chaves para obter instruções. Você fará o upload posteriormente no dashboard do Braze.
Etapa 1.4: Configurar políticas de rede
Se sua conta tiver políticas de rede, inclua os IPs da Braze na lista de permissões para ativar a conexão do serviço CDI. Para obter a lista de IPs, consulte Ingestão de dados na nuvem.
Etapa 1.1: Crie um catálogo ou esquema para sua tabela de origem.
1
CREATE SCHEMA BRAZE-CLOUD-PRODUCTION.INGESTION;
Etapa 1.2: Configure sua tabela de origem no Databricks
Consulte o seguinte ao criar sua tabela de origem:
| Nome do campo | Tipo | Obrigatória |
|---|---|---|
UPDATED_AT |
Data e hora | Sim |
PROPERTIES |
JSON | Sim |
EXTERNAL_ID |
STRING | NULLABLE |
ALIAS_NAME |
STRING | NULLABLE |
ALIAS_LABEL |
STRING | NULLABLE |
Você pode nomear o esquema e a tabela como desejar, mas os nomes das colunas devem corresponder à definição anterior.
UPDATED_AT: A hora em que esta linha foi atualizada ou adicionada à tabela. Apenas as linhas adicionadas ou atualizadas desde a última sincronização serão sincronizadas.- Ou
external_idoualias_nameealias_labelcomo coluna de identificador do usuário. Estes identificam os usuários para os quais você deseja disparar o envio de mensagens do Canvas.EXTERNAL_ID: Identifica o usuário para entrar no Canva. Esse valor deve corresponder ao valorexternal_idusado no Braze.ALIAS_NAMEeALIAS_LABEL: Essas colunas criam um objeto de alias de usuário.alias_nameDeve ser um identificador exclusivo ealias_labelespecifica o tipo de alias. Os usuários podem ter vários aliases com rótulos diferentes, mas apenas umalias_nameporalias_label.
PROPERTIES: Uma string ou estrutura de campos para disponibilizar como propriedades de personalização no seu canva. Isso deve conter informações específicas do usuário.
As propriedades não são necessárias para todas as linhas ou usuários. No entanto, os valores das propriedades devem ser strings JSON válidas. Insira uma string {}vazia se não houver propriedades para a linha.
1
2
3
4
5
6
7
8
9
10
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
);
Etapa 1.3: Configurar credenciais
Crie um token de acesso pessoal no Databricks:
- Selecione seu nome de usuário e, em seguida, selecione Configurações do usuário.
- Na guia Tokens de acesso, selecione Gerar novo token.
- Adicione um comentário para identificar o token, como “Braze CDI”.
- Deixe o campo Válido por (dias) em branco para que não haja expiração e selecione Gerar.
- Copie e salve o token com segurança para uso no dashboard do Braze.
Etapa 1.4: Configurar políticas de rede
Se sua conta tiver políticas de rede, inclua os IPs da Braze na lista de permissões para ativar a conexão do serviço CDI. Para obter a lista de IPs, consulte Ingestão de dados na nuvem.
Etapa 1.1: Configure sua tabela de origem no Fabric
1
2
3
4
5
6
7
8
9
10
11
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
Etapa 1.2: Configurar credenciais
Crie uma entidade de serviço e conceda permissões. Se você já possui credenciais de outra sincronização, pode reutilizá-las — apenas certifique-se de que elas tenham acesso à tabela de contas.
Etapa 1.3: Configurar políticas de rede
Se sua conta tiver políticas de rede, inclua os IPs da Braze na lista de permissões para ativar a conexão do serviço CDI. Para obter a lista de IPs, consulte Ingestão de dados na nuvem.
Para sincronizar os gatilhos do Canva a partir do armazenamento de arquivos, crie um arquivo de origem com os seguintes campos.
| Campo | Obrigatória | Descrição |
|---|---|---|
EXTERNAL_ID |
Sim, um dosexternal_id ou alias_name, e alias_label |
Isso identifica o usuário que você deseja atualizar. Esse valor deve corresponder ao valor external_id usado no Braze. |
ALIAS_NAME e ALIAS_LABEL |
Sim, um dosexternal_id oualias_name e alias_label |
Essas duas colunas criam um objeto de alias de usuário.alias_name deve ser um identificador exclusivo ealias_label especifica o tipo de alias. Os usuários podem ter vários aliases com rótulos diferentes, mas apenas umalias_namepor alias_label. |
PROPERTIES |
Sim | String JSON de campos a serem disponibilizados como propriedades de personalização no seu canva. Isso deve conter informações específicas do usuário. |
Os nomes dos arquivos devem seguir as regras da AWS e ser únicos. Adicione carimbos de data/hora para ajudar a garantir a exclusividade. Para obter mais informações sobre a sincronização do Amazon S3, consulte Integrações de armazenamento de arquivos.
Etapa 2: Configure seu destino no Canva
- Configure o seu destino Canvas para acionadores Canvas. Crie um novo ou selecione um Canvas disparado por API existente. Consulte Tipos de programação de entrada para obter instruções sobre como criar um canva com um tipo de programação de entrega disparado pela API.
- Após selecionar o tipo de programação de entrega disparada pela API, continue com a configuração do Canvas e crie seu Canvas. As canvas podem variar desde o envio simples de uma única mensagem até fluxos de trabalho complexos do cliente com várias etapas.
- Nas etapas do canva, use as propriedades de entrada do canva para personalizar mensagens com campos de propriedades que você planeja sincronizar da sua tabela de origem.
- Por exemplo, se na Etapa 1 você instrumentou um campo de propriedades para
account_balance, você usaria o seguinte modelo Liquid para personalizar sua mensagem:\{\{canvas_entry_properties.\$\{account_balance\}\}\}.
- Por exemplo, se na Etapa 1 você instrumentou um campo de propriedades para
- Depois de criar seu Canvas, inicie-o e prossiga para a Etapa 3.
Etapa 3: Crie sua sincronização sem cópia
Com a configuração da fonte concluída e o Canvas de destino iniciado, crie uma nova sincronização de dados:
- No Braze, acesse Configurações de dados > Ingestão de dados na nuvem.
- Configure uma conexão inserindo os detalhes da conexão (ou reutilize as credenciais existentes) e a tabela de origem da Etapa 1.
- Dê um nome à integração.
- Selecione o tipo de dados Gatilhos do Canva.
- Escolha o seu destino Canvas (da Etapa 2).
- Escolha uma frequência de sincronização.
- Configure as preferências de notificação.
- Selecione Testar conexão para confirmar se tudo funciona conforme o esperado. Se estiver conectando-se ao Snowflake, primeiro adicione a chave pública exibida no dashboard ao usuário criado para o Braze se conectar ao Snowflake. Para concluir esta etapa, você precisará de acesso SECURITYADMIN ou superior no Snowflake.
- Salve a sincronização para começar a sincronizar os gatilhos do Canva.
Quando a sincronização for executada, os usuários da sua tabela de origem começarão a entrar no Canva. Use a análise de dados do Canvas e a página de registros de sincronização da ingestão de dados na nuvem para monitorar a performance.
Revise toda a sua configuração (desde o comportamento de sincronização até a configuração do canva) para evitar envios inesperados. As configurações do Canvas, como limite de frequência, limite de taxa e filtros de segmentação, podem refinar ainda mais a entrega de mensagens.
Recomendamos realizar um teste com um público pequeno ou experimental antes de implementar casos de uso em produção.
Considerações
Os gatilhos do CDI Canvas utilizam o limite de frequência da sua API REST para /canvas/trigger/send. Se você estiver usando este endpoint simultaneamente com gatilhos CDI Canvas e sua integração REST API, espere que o uso combinado seja contabilizado em seu limite de frequência.
Embora os gatilhos do CDI Canvas estejam em acesso antecipado, considere os seguintes detalhes:
- Até 5 sincronizações ativas do Canvas por espaço de trabalho
- Cada execução de sincronização inserirá os usuários em seu respectivo Canvas de destino a uma taxa máxima de aproximadamente 3,75 milhões de usuários por hora.
- Esteja preparado para tempos de entrada mais longos da fonte para o canva quando:
- Sincronização de mais de 3,75 milhões de usuários por execução de sincronização.
- Usando gatilhos do CDI Canvas para disparar quando já estiver saturando o limite de frequência da sua API REST para
/canvas/trigger/send.
- Esteja preparado para tempos de entrada mais longos da fonte para o canva quando:
Editar esta página no GitHub