Skip to content

Objetos aninhados em eventos personalizados

Esta página aborda como enviar dados JSON aninhados como propriedades de eventos personalizados e compras, e como usar esses objetos aninhados no envio de mensagens.

Você pode usar objetos aninhados — objetos que estão dentro de outro objeto — para enviar dados JSON aninhados como propriedades de eventos personalizados e compras. Esses dados aninhados podem ser usados para criar modelos de informações personalizadas em mensagens, disparar envios de mensagens e segmentar usuários.

Considerações

  • Dados aninhados são compatíveis com eventos personalizados e eventos de compra, mas não com outros tipos de evento.
  • Objetos de propriedades de evento que contêm valores de array ou objeto podem ter uma carga útil de propriedade de evento de até 100 KB.
  • Esquemas de propriedades de evento não podem ser gerados para eventos de compra.
  • Esquemas de propriedades de evento são gerados por amostragem de eventos personalizados das últimas 24 horas.

Versões mínimas do SDK

As seguintes versões do SDK são compatíveis com objetos aninhados:

Etapa 1: Gerar um esquema

Você pode acessar os dados aninhados no seu evento personalizado gerando um esquema para cada evento com propriedades de evento aninhadas. Para gerar um esquema:

  1. Acesse Configurações de dados > Eventos personalizados.
  2. Selecione Gerenciar propriedades para os eventos com propriedades aninhadas.
  3. Selecione o botão para gerar o esquema. Para visualizar o esquema, selecione o botão de mais .

Se novas propriedades forem enviadas no futuro, elas não estarão no esquema até que ele seja regenerado. Os esquemas podem ser regenerados a cada 24 horas.

Etapa 2: Usar o objeto aninhado

Você pode referenciar os dados aninhados durante a segmentação e personalização. Um esquema não é obrigatório. Consulte as seções a seguir para exemplos de uso:

Corpo da requisição de API

A seguir, um exemplo de /users/track com um evento personalizado “Created Playlist”. Depois que uma playlist for criada, capture as propriedades da playlist enviando:

  • Uma requisição de API que lista “songs” como uma propriedade
  • Um array das propriedades aninhadas das músicas
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
...
"properties": {
  "songs": [
    {
      "title": "Smells Like Teen Spirit",
      "artist": "Nirvana",
      "album": {
        "name": "Nevermind",
        "yearReleased": "1991"
      }
    },
    {
      "title": "While My Guitar Gently Weeps",
      "artist": "the Beatles",
      "album": {
        "name": "The Beatles",
        "yearReleased": "1968"
      }
    }
  ]
}
...

A seguir, um exemplo de /users/track com um evento personalizado “Ordered”. Depois que um pedido for concluído, capture as propriedades desse pedido enviando:

  • Uma requisição de API que lista r_details como uma propriedade
  • As propriedades aninhadas desse pedido
1
2
3
4
5
6
7
8
9
10
11
12
...
"properties": {
  "r_details": {
    "name": "SandwichEmperor",
    "identifier": "12345678",
    "location" : {
      "city": "Montclair",
      "state": "NJ"
    }
  }
}
...

Modelos Liquid

A seguir, veja como criar um modelo Liquid que referencia as propriedades aninhadas solicitadas na requisição de API anterior.

Modelo em Liquid em uma mensagem disparada pelo evento “Created Playlist”:

{{event_properties.${songs}[0].album.name}}: “Nevermind”
{{event_properties.${songs}[1].title}}: “While My Guitar Gently Weeps”

Modelo em Liquid em uma mensagem disparada pelo evento “Ordered”:

{{event_properties.${r_details}.location.city}}: “Montclair”

Disparo de mensagens

Para usar essas propriedades para disparar uma campanha, selecione seu evento personalizado ou compra e adicione um filtro de Propriedade aninhada. O disparo de mensagens ainda não é compatível com mensagens no app, mas as propriedades aninhadas na personalização Liquid nas mensagens ainda serão exibidas.

Disparando uma campanha com propriedades aninhadas do evento “Created Playlist”:

Um usuário escolhendo uma propriedade aninhada para filtros de propriedade em um evento personalizado.

A condição de disparo songs[].album.yearReleased “is” “1968” corresponderá a um evento em que qualquer uma das músicas tenha um álbum lançado em 1968. Usamos a notação de colchetes [] para percorrer arrays e fazemos a correspondência se qualquer item no array percorrido corresponder à propriedade do evento.

Disparando uma campanha com propriedades aninhadas do evento “Ordered”:

Um usuário adicionando o filtro de propriedade r_details.name is SandwichEmperor para um evento personalizado.

r_details.name: “SandwichEmperor”
r_details.location.city: “Montclair”

Segmentação

Para segmentar usuários com base em propriedades de evento aninhadas, você deve usar Extensões de segmento. Depois de gerar um esquema, o explorador de objetos aninhados será exibido na seção de segmentação.

A segmentação usa a mesma notação do disparo (consulte Disparo de mensagens).

Para editar ou criar Extensões de segmento, você precisará da permissão “Editar segmentos”.

Personalização

Usando o modal Adicionar personalização, selecione Propriedades avançadas de evento como o tipo de personalização. Isso permite adicionar propriedades de evento aninhadas depois que um esquema for gerado.

Testando objetos aninhados em mensagens

A ferramenta Pré-visualização e teste do dashboard não permite adicionar dados simulados para objetos aninhados ou atributos personalizados aninhados. Para testar mensagens que referenciam dados aninhados por meio de Liquid, você pode pré-visualizar mensagens com atributos aninhados como um usuário existente que possua esse atributo aninhado, ou pré-visualizar mensagens com propriedades de evento personalizado lançando uma campanha ativa para usuários teste.

Atributos personalizados aninhados

  1. Importe os atributos aninhados para o perfil do usuário teste por meio da API.
  2. Na sua campanha ou Canvas, acesse Pré-visualização e teste.
  3. Selecione Pré-visualizar como usuário e pesquise o usuário teste. O Liquid será resolvido usando os atributos aninhados reais no perfil desse usuário.

Propriedades de evento aninhadas

As propriedades de evento aninhadas não podem ser pré-visualizadas no dashboard porque exigem um disparo de evento ao vivo. Para testar:

  1. Crie uma campanha ou etapa do Canvas que tenha como alvo apenas seus usuários teste e seja disparada pelo (ou referencie o) evento personalizado com propriedades aninhadas.
  2. Lance a campanha para seu público de teste.
  3. Registre o evento personalizado com a carga útil do objeto aninhado no perfil do seu usuário teste (usando a API ou o SDK).
  4. Verifique se a mensagem é renderizada corretamente com os valores das propriedades aninhadas.

Perguntas frequentes

O uso de objetos aninhados registra pontos de dados adicionais?

Não há mudança na forma como registramos pontos de dados com a adição dessa funcionalidade. A segmentação baseada em objetos aninhados usa Extensões de segmento, que não consomem pontos de dados adicionais.

Quantos dados aninhados podem ser enviados?

Se uma ou mais propriedades do evento contiverem dados aninhados, a carga útil máxima para todas as propriedades combinadas em um evento é de 100 KB. Qualquer requisição acima desse limite de tamanho será rejeitada.

New Stuff!