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 da 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 da Braze.

Sincronização de gatilhos do canva

Etapas para início rápido

Se você já está familiarizado com o CDI da Braze, 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 de ID externo ou alias de usuário são aceitos. E-mails e números de telefone não são identificadores aceitos.
• Apenas usuários existentes da Braze podem ser sincronizados. Não é possível criar novos usuários.
• properties substitui a coluna payload. 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 Canvas Triggers ao criar uma nova sincronização.

Usando gatilhos do Canvas

Etapa 1: Configurar fonte de dados para gatilhos do Canvas

• snowflake
• redshift
• bigquery
• databricks
• fabric
• file storage

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)
);

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;

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)
 );

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;

1
CREATE SCHEMA BRAZE-CLOUD-PRODUCTION.INGESTION;

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
);

1
CREATE SCHEMA BRAZE-CLOUD-PRODUCTION.INGESTION;

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
);

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 2: Configure seu Canvas de destino

1. Configure o seu Canvas de destino para gatilhos do 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.
2. Após selecionar o tipo de programação de entrega disparada pela API, continue com a configuração do Canvas e crie seu Canvas. Os canvas podem variar desde o envio simples de uma única mensagem até fluxos de trabalho complexos com várias etapas.
3. Nas etapas do Canvas, use as propriedades de entrada do Canvas 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\}\}\}.
4. 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:

1. Na Braze, acesse Configurações de dados > Ingestão de dados na nuvem.
2. Configure a conexão inserindo os detalhes da conexão (ou reutilize as credenciais existentes) e a tabela de origem da Etapa 1.
3. Dê um nome à integração.
4. Selecione o tipo de dados Canvas Triggers.
5. Escolha o seu Canvas de destino (da Etapa 2).
6. Escolha uma frequência de sincronização.
7. Configure as preferências de notificação.
8. Selecione Testar conexão para confirmar se tudo funciona conforme o esperado. Se estiver conectando ao Snowflake, primeiro adicione a chave pública exibida no dashboard ao usuário criado para a Braze se conectar ao Snowflake. Para concluir esta etapa, você precisará de acesso SECURITYADMIN ou superior no Snowflake.
9. Salve a sincronização para começar a sincronizar os gatilhos do Canvas.

Quando a sincronização for executada, os usuários da sua tabela de origem começarão a entrar no Canvas. 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.

Considerações

Os gatilhos do CDI Canvas utilizam o limite de taxa da sua API REST para /canvas/trigger/send. Se você estiver usando esse endpoint simultaneamente com os gatilhos CDI Canvas e sua integração de API REST, espere que o uso combinado seja contabilizado no seu limite de taxa.

Enquanto os gatilhos do CDI Canvas estiverem em acesso antecipado, considere os seguintes detalhes:

• Até 5 sincronizações ativas de gatilhos 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 Canvas quando:
    • Sincronizar mais de 3,75 milhões de usuários por execução de sincronização.
    • Usar gatilhos do CDI Canvas quando já estiver saturando o limite de taxa da sua API REST para /canvas/trigger/send.