Integração com RudderStack
O RudderStack é uma plataforma de dados de clientes que coleta eventos dos seus aplicativos, sites, servidores e data warehouses e os encaminha para outras ferramentas. Com o destino Pushwoosh no RudderStack, os dados que você já coleta lá chegam à Pushwoosh sem código extra no seu aplicativo:
- Eventos track se tornam eventos da Pushwoosh. Use-os para criar segmentos e para iniciar ou ramificar customer journeys.
- Traits de identify se tornam tags específicas do usuário. Use-as para segmentar e personalizar notificações push, mensagens in-app e e-mails.
Antes de começar
Anchor link toO destino associa todos os dados pelo User ID, então verifique primeiro estes pré-requisitos:
- O SDK da Pushwoosh está integrado ao seu aplicativo.
- Seu aplicativo chama
setUserIdcom o mesmo valor que o RudderStack envia comouserId. A Pushwoosh vincula os eventos e traits recebidos aos usuários por esse valor. - O dispositivo de cada usuário está registrado com esse User ID antes que o RudderStack envie chamadas
identifypara o usuário. Traits de um User ID que a Pushwoosh ainda não conhece são descartados. - Você tem acesso a Settings → API Access na Pushwoosh para criar um token de API.
- Você tem um workspace do RudderStack com pelo menos uma fonte que envia chamadas
trackouidentify.
Configurar o destino Pushwoosh no RudderStack
Anchor link toA configuração tem duas partes: você obtém dois valores na Pushwoosh e depois cria o destino no RudderStack.
Obter o código do aplicativo e um Device API token
Anchor link toO RudderStack precisa de dois valores para enviar dados ao seu aplicativo: o código do aplicativo e um Device API token.
- Na Pushwoosh, abra o aplicativo para o qual deseja enviar dados.
- Copie o código do aplicativo. Ele aparece abaixo do nome do aplicativo no canto superior esquerdo e tem o formato
XXXXX-XXXXX. - Vá para Settings → API Access e clique em Generate New Token.
- Em Token type, escolha
device. - Em Name, insira um nome para o token, por exemplo
RudderStack. - Clique em Generate.
- Na lista de tokens, clique no menu de três pontos ao lado do novo token e escolha Edit token….
- Em Applications, selecione o aplicativo da etapa 1 e clique em Save.
- Copie o valor do token na lista de tokens.
Um Device API token é suficiente para o destino. Você não precisa de um Server API token.
Adicionar o destino no RudderStack
Anchor link toO destino Pushwoosh conecta suas fontes do RudderStack ao seu aplicativo da Pushwoosh.
- No painel do RudderStack, vá para Collect → Destinations.
- Clique em New destination.
- Selecione Pushwoosh na lista.
- Insira um nome para o destino e clique em Continue.
- Selecione as fontes que deseja enviar para a Pushwoosh.
- Em Application Code, cole o código do aplicativo.
- Em API Token, cole o Device API token.
- Conclua a configuração para salvar o destino.
O RudderStack envia os dados para a Pushwoosh a partir dos próprios servidores (cloud mode), para cada tipo de fonte compatível com o destino.
Para a parte da configuração no RudderStack, consulte o guia do destino Pushwoosh na documentação do RudderStack.
Quais dados o RudderStack envia para a Pushwoosh
Anchor link toO destino é compatível com dois tipos de chamada, track e identify. O RudderStack rejeita qualquer outro tipo de chamada, como page, screen, group ou alias, para este destino.
Toda chamada deve ter um userId. O RudderStack não envia chamadas sem ele, porque a Pushwoosh não consegue atribuir uma chamada anônima a um usuário.
Chamadas track se tornam eventos da Pushwoosh
Anchor link toCada chamada track se torna um evento da Pushwoosh com o mesmo nome do evento do RudderStack:
| Campo do RudderStack | Pushwoosh |
|---|---|
event | Nome do evento |
properties | Atributos do evento |
userId | User ID |
timestamp (ou originalTimestamp) | Horário do evento |
context.device.id | Device ID, se houver |
context.device.type ou context.os.name | Plataforma: android; ios para iOS, iPadOS, watchOS e tvOS; web para qualquer outro valor ou nenhum valor |
Se o evento ou um atributo ainda não existir no aplicativo, a Pushwoosh o cria automaticamente.
A Pushwoosh descarta o evento inteiro nestes casos. Nenhum erro é retornado, então o RudderStack informa o evento como entregue:
- A chamada tem mais de 100 propriedades.
- O valor de uma propriedade tem mais de 10 KB.
- O nome do evento tem mais de 255 caracteres.
- O evento é novo, e seu nome tem mais de 128 caracteres ou contém caracteres de controle.
Um evento mantém até 100 atributos. Quando um evento já tem 100 atributos conhecidos, a Pushwoosh continua registrando novas chamadas, mas novos nomes de propriedades não são adicionados como atributos.
Objetos aninhados em properties chegam como strings JSON, e propriedades com valor null são descartadas.
Chamadas identify se tornam tags específicas do usuário
Anchor link toCada chamada identify define seus traits como tags do usuário com o userId informado. Os traits vêm de traits, ou de context.traits quando traits está vazio.
- Apenas tags específicas do usuário são gravadas. Se a criação automática de tags estiver ativada para sua conta, um trait com um novo nome cria uma tag específica do usuário. Se já existir uma tag General com o mesmo nome, a Pushwoosh ignora esse trait sem erro.
- O valor deve corresponder ao tipo da tag. Se uma tag já existir e o valor do trait não se encaixar no tipo dela, como texto para uma tag Integer, a Pushwoosh ignora esse trait sem erro.
- O usuário já deve existir na Pushwoosh. As tags são aplicadas apenas se o SDK da Pushwoosh tiver registrado um dispositivo com
setUserIddefinido para o mesmouserId. Traits de um usuário desconhecido são descartados sem erro. - Traits de identidade e contato não são copiados para tags.
email,phone,firstName,lastName,name,address,id,userIdeanonymousIdnunca são enviados como tags. Uma chamadaidentifyque tem apenas esses traits falha comNo traits left to send as Pushwoosh tags. - Um valor vazio limpa a tag. Um trait com uma string vazia ou uma lista vazia exclui o valor atual dessa tag para o usuário.
- Objetos aninhados chegam como strings JSON. Traits com valor
nullsão descartados.
O que o destino não faz
Anchor link toO destino envia apenas dados de track e identify. Estas tarefas ficam fora dele:
- Ele não registra dispositivos nem endereços de e-mail. Os dispositivos vêm do SDK da Pushwoosh.
- Ele não exclui usuários. Solicitações de exclusão de usuários do RudderStack não são compatíveis com este destino.
Verificar se a integração funciona
Anchor link toDepois de salvar o destino, envie uma chamada track e uma identify de teste a partir de uma fonte com um userId que já tenha um dispositivo na Pushwoosh.
- Eventos: na Pushwoosh, vá para Audience → Events, abra o evento e verifique se ele foi contabilizado.
- Tags: vá para Audience → User Explorer, encontre o usuário pelo User ID e verifique os valores das tags.
Os erros de entrega de cada chamada são exibidos na visualização Live Events do destino no RudderStack.
Solução de problemas
Anchor link toEncontre a mensagem de erro que o RudderStack mostra para o destino em Live Events para ver a causa e a correção.
Chamadas track falham com unauthorized
Anchor link toO token de API não corresponde ao código do aplicativo. Verifique se o token pertence à mesma conta da Pushwoosh que o aplicativo.
Chamadas identify não verificam o token, então continuam funcionando com um token errado. Use uma chamada track para testar o token.
Chamadas falham com application not found ou application code is not valid
Anchor link toO código do aplicativo está errado ou a conta não está hospedada em app.pushwoosh.com. Chamadas track falham com application not found, e chamadas identify falham com application code is not valid. Verifique o código no Pushwoosh Control Panel. Se o código estiver correto, entre em contato com seu Customer Success Manager ou com o suporte.
Chamadas falham com Missing required value from userId
Anchor link toA chamada não tem userId. Chamadas anônimas não são enviadas para a Pushwoosh. Chame identify na sua fonte do RudderStack depois que o usuário fizer login, para que as chamadas seguintes incluam o userId.
Chamadas falham com Invalid enum value
Anchor link toO tipo de chamada não é track nem identify. A Pushwoosh aceita apenas esses dois tipos. Não conecte fontes que enviam apenas chamadas page, screen, group ou alias, ou ignore esses erros.
Chamadas identify falham com No traits left to send as Pushwoosh tags
Anchor link toTodos os traits da chamada são traits de identidade ou contato, como email ou phone, que nunca são copiados para tags. Adicione pelo menos um outro trait ou ignore a chamada.
Chamadas identify funcionam, mas as tags não aparecem
Anchor link toVerifique estes itens na ordem:
- Um dispositivo com este User ID está registrado na Pushwoosh. Procure o usuário em Audience → User Explorer.
- O aplicativo chama
setUserIdexatamente com o mesmo valor que o RudderStack envia comouserId. - A tag com este nome é User-specific. Um trait para uma tag General existente é ignorado. Altere o escopo da tag ou renomeie o trait.
- O valor do trait corresponde ao tipo da tag existente.
- O trait não é um dos traits de identidade ou contato que nunca são copiados, como
emailouphone.