Objeto de público conectado

Um público conectado é um filtro de público dinâmico que você define inline na sua requisição de API, permitindo direcionar os usuários certos no momento do envio sem precisar criar ou gerenciar segmentos no dashboard da Braze.

Em vez de pré-criar um segmento para cada combinação possível de público, você passa os critérios de filtro diretamente no parâmetro audience da sua chamada de API. A Braze avalia cada usuário em relação a esses critérios em tempo real e entrega a mensagem apenas aos usuários que correspondem. Isso significa que uma única Campaign, Canvas ou definição de mensagem somente via API pode atender a um número ilimitado de variações de público, totalmente orientadas pela sua lógica de negócios.

Como funciona

1. Defina sua mensagem criando uma Campaign disparada por API ou um Canvas no dashboard da Braze, ou defina o conteúdo da mensagem inteiramente inline usando os objetos de mensagem na sua requisição de API. Use propriedades de gatilho ou contexto do Canvas para personalização dinâmica.
2. Chame um endpoint compatível e inclua o parâmetro audience com seus critérios de filtro. Você pode filtrar por atributos personalizados, status de inscrição push, status de inscrição de e-mail e horário do último uso do app.
3. A Braze avalia os filtros no momento do envio, entregando a mensagem apenas aos usuários que correspondem aos seus critérios.

Dica

Um campaign_id não é obrigatório ao usar o parâmetro audience. Os endpoints /messages/send e /messages/schedule/create permitem definir o conteúdo da mensagem inline sem uma Campaign pré-criada. No entanto, se você quiser acompanhar métricas no nível da Campaign (como envios, cliques ou bounces) no dashboard, inclua um campaign_id.

Como o público é definido por requisição, seus sistemas de backend podem disparar mensagens contextualmente relevantes em resposta a qualquer evento de negócios (uma mudança de preço, um alerta meteorológico, uma atualização de placar ao vivo) sem intervenção no dashboard.

Endpoints compatíveis

Você pode usar o objeto de público conectado com o parâmetro audience nos seguintes endpoints:

• /messages/send
• /campaigns/trigger/send
• /canvas/trigger/send
• /messages/schedule/create
• /campaigns/trigger/schedule/create
• /canvas/trigger/schedule/create

Casos de uso

Use públicos conectados para cenários em que seus sistemas de backend detectam um evento e precisam notificar um conjunto de usuários determinado dinamicamente:

Em cada caso, uma única Campaign ou definição de mensagem somente via API lida com todas as variações. Seu backend determina os valores do filtro e os passa na requisição de API, então você não precisa criar um segmento ou uma Campaign separada para cada produto, programa, time ou localização.

Exemplo de requisição

O exemplo a seguir usa o endpoint /campaigns/trigger/send para direcionar usuários que favoritaram um programa específico e estão com opt-in para notificações por push:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
{
  "campaign_id": "YOUR_CAMPAIGN_ID",
  "audience": {
    "AND": [
      {
        "custom_attribute": {
          "custom_attribute_name": "favorite_shows",
          "comparison": "includes_value",
          "value": "Example Show"
        }
      },
      {
        "push_subscription_status": {
          "comparison": "is",
          "value": "opted_in"
        }
      }
    ]
  },
  "trigger_properties": {
    "show_title": "Example Show",
    "episode_title": "Season 3, Episode 1",
    "deep_link": "https://example.com/shows/example-show/s3e1"
  },
  "broadcast": false
}

Corpo do objeto

O objeto de público conectado é composto por um único filtro de público conectado ou por vários filtros de público conectados combinados com os operadores AND e OR.

Exemplo com múltiplos filtros:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "AND":
    [
      Connected Audience Filter,
      {
        "OR" :
          [
            Connected Audience Filter,
            Connected Audience Filter
          ]
      },
      Connected Audience Filter
    ]
}

Filtros de público conectado

Combine múltiplos filtros com os operadores AND e OR para criar um filtro de público conectado.

Filtro de atributo personalizado

Esse filtro permite segmentar com base em um atributo personalizado do usuário. Esses filtros contêm até três campos:

1
2
3
4
5
6
7
8
{
  "custom_attribute":
    {
      "custom_attribute_name": (String) the name of the custom attribute to filter on,
      "comparison": (String) one of the allowed comparisons to make against the provided value,
      "value": (String, Numeric, Boolean) the value to be compared using the provided comparison
    }
}

Comparações permitidas por tipo de dados

O tipo de dados do atributo personalizado determina as comparações válidas para um determinado filtro.

Ressalvas sobre comparação de atributos

Exemplo de atributo personalizado

1
2
3
4
5
6
7
8
{
  "custom_attribute":
    {
      "custom_attribute_name": "eye_color",
      "comparison": "equals",
      "value": "blue"
    }
}

1
2
3
4
5
6
7
8
{
  "custom_attribute":
  {
    "custom_attribute_name": "favorite_foods",
    "comparison": "includes_value",
    "value": "pizza"
  }
}

1
2
3
4
5
6
7
8
{
  "custom_attribute":
  {
    "custom_attribute_name": "last_purchase_time",
    "comparison": "less_than_x_days_ago",
    "value": 2
  }
}

Filtro de inscrição push

Esse filtro permite segmentar com base no status de inscrição push de um usuário.

Corpo do filtro

1
2
3
4
5
6
7
{
  "push_subscription_status":
  {
    "comparison": (String) one of the following allowed comparisons,
    "value": (String) one of the following allowed values
  }
}

• Comparações permitidas: is, is_not
• Valores permitidos: opted_in, subscribed, unsubscribed

Filtro de inscrição de e-mail

Esse filtro permite segmentar com base no status de inscrição de e-mail de um usuário.

Corpo do filtro

1
2
3
4
5
6
7
{
  "email_subscription_status":
  {
    "comparison": (String) one of the following allowed comparisons,
    "value": (String) one of the following allowed values
  }
}

• Comparações permitidas: is, is_not
• Valores permitidos: opted_in, subscribed, unsubscribed

Filtro de último app usado

Esse filtro permite segmentar com base em quando o usuário usou o app pela última vez. Esses filtros contêm dois campos:

Corpo do filtro

1
2
3
4
5
6
7
{
  "last_used_app":
  {
    "comparison": (String) one of the allowed comparisons listed,
    "value": (String) the value to be compared using the provided comparison
  }
}

• Comparações permitidas: after, before
• Valores permitidos: datetime (string ISO 8601)

Considerações

Públicos conectados não podem filtrar usuários por atributos padrão, eventos personalizados, segmentos ou eventos de engajamento com mensagem. Para usar esses filtros, recomendamos incorporá-los em um segmento de público e, em seguida, especificar esse segmento no parâmetro segment_id do endpoint /messages/send. Ao usar outros endpoints, você precisará adicionar o segmento à Campaign disparada por API ou ao Canvas no dashboard da Braze primeiro.