Atributos padrão

Atributos padrão são campos predefinidos que a Braze reconhece em todos os perfis de usuário. Use esta página como referência rápida para o nome do campo, o tipo de dados e o formato esperado de cada atributo padrão.

Atributos padrão (às vezes chamados de atributos default ou chaves reservadas) são diferentes dos atributos personalizados, que são exclusivos do seu negócio. Quando você envia dados para a Braze com um dos nomes de campo listados nesta página, a Braze armazena o valor no campo de perfil predefinido em vez de criar um novo atributo personalizado.

Você pode definir atributos padrão por qualquer um destes métodos:

• O SDK da Braze
• O objeto de atributos de usuário no endpoint /users/track
• Importação de CSV
• Ingestão de dados na nuvem

Importante

Os nomes dos atributos padrão diferenciam maiúsculas de minúsculas. Sempre use letras minúsculas (por exemplo, first_name, não First_Name). Se a grafia ou capitalização não corresponder exatamente, a Braze armazena o valor como um atributo personalizado.

Identificadores

Os identificadores dizem à Braze qual perfil de usuário atualizar ou criar. Toda requisição de API e linha de CSV deve incluir pelo menos um identificador. Para detalhes sobre como escolher o correto, consulte Resolução de identificadores.

Campos de perfil

Esses campos capturam dados demográficos, de contato e de localidade sobre os seus usuários.

Inscrição e consentimento

Esses campos gerenciam como um usuário recebe mensagens em diferentes canais. A atualização deles não conta para o seu uso de pontos de dados.

Para obter detalhes sobre a configuração de grupos de inscrições, consulte Grupos de inscrições.

Sessões e engajamento

Esses campos capturam quando o usuário usou o app pela primeira ou última vez. O SDK os registra automaticamente; normalmente, você só os define por meio de API ou CSV ao migrar de outra plataforma.

Tokens por push

Use esses campos ao migrar tokens por push de outra plataforma. Após integrar o SDK da Braze, os tokens por push são capturados automaticamente. Para orientações sobre migração, consulte Migrando tokens por push.

Perfil social

Esses campos armazenam dados de integrações com redes sociais.

Exemplo de API

A requisição a seguir define atributos padrão em dois usuários por meio do endpoint /users/track.

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
27
28
29
30
31
32
33

POST https://YOUR_REST_API_URL/users/track
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
  "attributes": [
    {
      "external_id": "user1",
      "first_name": "Alex",
      "last_name": "Doe",
      "email": "[email protected]",
      "country": "US",
      "language": "en",
      "time_zone": "America/New_York",
      "dob": "1988-02-14",
      "email_subscribe": "opted_in"
    },
    {
      "external_id": "user2",
      "first_name": "Alex",
      "phone": "+14155552671",
      "current_location": {
        "longitude": -73.991443,
        "latitude": 40.753824
      },
      "subscription_groups": [
        {
          "subscription_group_id": "abc-123",
          "subscription_state": "subscribed"
        }
      ]
    }
  ]
}

Para ver o contrato completo da API, consulte o Objeto de atributos do usuário.

Exemplo de CSV

O CSV a seguir atualiza atributos padrão para dois usuários. Os cabeçalhos das colunas devem corresponder exatamente aos nomes dos campos neste artigo. Cabeçalhos que não correspondem (por exemplo, First_name em vez de first_name) são importados como atributos personalizados.

1
2
3

external_id,first_name,last_name,email,country,language,dob,email_subscribe
user1,Jane,Doe,[email protected],US,en,1988-02-14,opted_in
user2,Alex,Smith,[email protected],GB,en,1992-09-30,subscribed

Não é possível definir alguns atributos padrão por meio da importação de CSV. Você deve enviar arrays, tokens por push e objetos aninhados pela API ou pela ingestão de dados na nuvem. Para ver a lista completa de campos compatíveis com CSV e as etapas de importação, consulte Atributos padrão.

Considerações

Tenha em mente estes pontos ao trabalhar com atributos padrão:

• Os nomes dos campos diferenciam maiúsculas de minúsculas. Sempre use letras minúsculas. Um cabeçalho ou chave que não corresponda exatamente ao nome de um atributo padrão será tratado como um atributo personalizado.
• A captura automática do SDK é suprimida quando você define valores por API ou CSV. Quando você define country ou language por API ou CSV, a Braze para de capturar automaticamente esses campos do SDK para esse usuário.
• null remove um valor. Defina um atributo padrão como null para removê-lo do perfil. Alguns campos, incluindo external_id e user_alias, não podem ser removidos após serem definidos.
• Valores em branco no CSV não sobrescrevem. Uma célula em branco em uma importação de CSV mantém o valor existente no perfil. Para limpar um valor, use a API.
• Os fusos horários usam UTC como padrão. Strings de data sem um deslocamento são interpretadas como meia-noite UTC e exibidas no fuso horário do seu espaço de trabalho. Para especificar um fuso horário, adicione um deslocamento UTC (por exemplo, 2024-11-10T18:00:00-05:00).

Páginas relacionadas

• Objeto de atributos de usuárioContrato completo da API para o objeto de atributos.
• Endpoint /users/trackEndpoint REST para criar e atualizar perfis de usuário.
• Definir atributos de usuárioMétodos do SDK para definir atributos padrão e personalizados.
• Importação por CSVFaça upload de atributos padrão por meio de um arquivo CSV.
• Atributos personalizadosDefina atributos exclusivos para o seu negócio.
• Tipos de dadosReferência de tipos de dados compatíveis.