Pular para o conteúdo principal
Esta página faz parte de Aplicativo de exemplo: uma integração completa do OneSignal, que acompanha um aplicativo real do início ao fim. O aplicativo é o Clean Beans, uma escala de limpeza para casas compartilhadas, construído com Expo (React Native) e um backend Supabase. Todo domingo, cada casa recebe um email com o resumo da semana: sessões, tarefas, minutos, um ranking e os números de cada pessoa.
O email do relatório semanal do Clean Beans

O relatório semanal: totais da casa, sua própria semana e o ranking.

O problema interessante é a personalização. Todos de uma casa veem o mesmo ranking, mas cada pessoa deve ver o próprio nome e as próprias estatísticas. Enviar uma solicitação por pessoa funcionaria, mas há uma forma melhor.

Uma solicitação por casa, personalizada por pessoa \

A função envia uma solicitação por casa. Ela passa todos os dados em custom_data, incluindo um objeto users indexado pelo External ID. O template então escolhe a entrada certa para a pessoa para quem está sendo renderizado.
supabase/functions/weekly-report/index.ts
No template, uma linha de Liquid seleciona os dados do destinatário atual.
email-templates/weekly-report.html
A partir daí, user contém as estatísticas dessa pessoa, e tudo o que é lido diretamente de message.custom_data é compartilhado pela casa.
email-templates/weekly-report.html
O segundo exemplo de Liquid foi simplificado a partir do template para mostrar a lógica sem a marcação da tabela.

Ficar dentro do limite de tamanho \

O custom_data para email é limitado a 10 KB. Uma casa grande poderia ultrapassar isso, então a função mede o payload e reduz o ranking se necessário.
supabase/functions/weekly-report/index.ts

Agendamento e preferências \

Um agendamento semanal chama a função todo domingo às 09:00 UTC, usando o mesmo padrão de pg_cron dos lembretes push, com a expressão 0 9 * * 0. Só são incluídos os usuários com Weekly Email Summary ativado. Configuração do painel. Em Messages > Templates, crie um template de email, cole o HTML e copie o ID do template para os segredos do seu backend. O custom_data só funciona com um template, então template_id é obrigatório.

A alternativa: Data Feeds \

Há uma segunda forma de colocar dados por pessoa em um email, e o Clean Beans optou por não usá-la. Vale a pena entendê-la, porque para alguns aplicativos ela é a melhor opção. Com custom_data, seu backend envia os dados ao OneSignal no momento do envio. Com um Data Feed, o OneSignal busca os dados na sua API no momento em que cada email é enviado. O envio em si é iniciado por uma Journey, não pelo seu backend.
Os exemplos desta subseção são ilustrativos. Eles mostram como o relatório semanal teria sido criado com um Data Feed. Não foram retirados do aplicativo.
Veja como o relatório semanal teria funcionado.
1

Expor um endpoint que retorna a semana de uma pessoa

Uma função de backend recebe um ID de usuário e retorna em JSON as estatísticas desse usuário e o ranking da casa dele.
Response from your API
2

Criar o Data Feed no painel

Em Settings > Data feeds, dê um alias ao feed e aponte-o para o endpoint. A URL e os cabeçalhos aceitam Liquid, então o External ID do destinatário pode ser passado.
Data Feed configuration
3

Anexar o feed ao template de email e ler a partir dele

No template, os valores vêm de data_feed, seguido do alias.
Email template
4

Enviar a partir de uma Journey recorrente

Uma Journey com uma janela de horário no domingo de manhã como primeira etapa, e uma regra de reentrada, envia o template toda semana. Nenhum código de agendamento ou envio fica no seu backend.

Qual usar \

Escolha custom_data quando seu backend já é quem decide enviar. Esse é o caso do relatório semanal. O backend roda em um agendamento, sabe quais casas deram opt-in e tem todos os números em mãos, então passar os dados não custa nada a mais. Uma solicitação cobre uma casa inteira, não há endpoint a proteger e uma falha aparece nos seus próprios logs. O preço é que o momento e o público ficam no código, e o payload tem um limite de tamanho fixo. Escolha um Data Feed quando o envio pertence a uma Journey. Uma Journey decide sozinha quando enviar uma mensagem a alguém, dias depois de um evento ou quando uma condição de espera é atendida, e seu backend não está lá para fornecer os dados nesse momento. Um Data Feed preenche essa lacuna, e permite que quem cuida das mensagens mude o agendamento, adicione uma ramificação ou teste variantes sem um deploy. O preço é que sua API é chamada uma vez por destinatário e deve responder em cerca de um quarto de segundo, cada template só pode usar um feed e uma chamada com falha significa que a pessoa silenciosamente não recebe nada. Para o Clean Beans, os fatores decisivos foram simples. O backend já tinha os dados e o agendamento, o ranking é compartilhado por uma casa, então uma solicitação é muito mais barata do que uma chamada por pessoa, e as preferências ficam armazenadas no banco de dados do aplicativo, onde o backend pode verificá-las diretamente.

Personalizar com custom_data

Limites de tamanho e padrões de acesso com Liquid.

Data feeds

Traga dados em tempo real para emails e SMS de Journeys.

Usar a sintaxe Liquid

Filtros, loops e condições.