Skip to content

Objeto del evento

Este artículo explica los distintos componentes de un objeto evento, cómo puedes utilizarlo y ejemplos en los que inspirarte.

¿Qué es un objeto de evento?

Un objeto de evento es un objeto que se pasa a través de la API cuando ocurre un evento específico. Los objetos de evento se alojan en una matriz de eventos. Cada objeto de evento en la matriz de eventos representa una única ocurrencia de un evento personalizado por parte de un usuario particular en el valor de tiempo designado. El objeto de evento tiene muchos campos diferentes que te permiten personalizar configurando y utilizando propiedades del evento en mensajes, recopilación de datos y personalización.

Para conocer los pasos sobre cómo configurar eventos personalizados para una plataforma específica, consulta la Guía de integración de plataforma en la Guía del desarrollador. Consulta el artículo correspondiente según tu plataforma:

Cuerpo del objeto

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

{
  // One of "external_id" or "user_alias" or "braze_id" or "email" or "phone" is required
  "external_id" : (optional, string) External user ID,
  "user_alias" : (optional, User Alias Object) User alias object,
  "braze_id" : (optional, string) Braze user identifier,
  "email": (optional, string) User email address,
  "phone": (optional, string) User phone number,
  "app_id" : (optional, string) see App Identifier,
  "name" : (required, string) the name of the event,
  "time" : (required, datetime as string in ISO 8601 or in `yyyy-MM-dd'T'HH:mm:ss:SSSZ` format),
  "properties" : (optional, Properties Object) properties of the event
  // Setting this flag to true will put the API in "Update Only" mode.
  // When using a "user_alias", "Update Only" mode is always true.
  "_update_existing_only" : (optional, boolean)
  // See following notes regarding anonymous push token imports
}

Actualizar solo perfiles existentes

Para actualizar solo perfiles de usuario existentes en Braze, debes pasar la clave _update_existing_only con un valor de true dentro del cuerpo de tu solicitud. Si se omite este valor, Braze creará un nuevo perfil de usuario si el external_id aún no existe.

Objeto de propiedades del evento

Los eventos personalizados y las compras pueden tener propiedades del evento. Los valores de “properties” deben ser un objeto donde las claves son los nombres de las propiedades y los valores son los valores de las propiedades. Los nombres de las propiedades deben ser cadenas no vacías de 255 caracteres o menos, sin signos de dólar ($) al inicio.

Los valores de las propiedades pueden ser cualquiera de los siguientes tipos de datos:

Tipo de datos Descripción
Números Como enteros o flotantes
Booleanos true o false
Fechas y horas Deben tener formato de cadenas en el formato ISO 8601 o en cualquiera de los siguientes formatos:
- yyyy-MM-ddTHH:mm:ss:SSSZ
- yyyy-MM-ddTHH:mm:ss
- yyyy-MM-dd HH:mm:ss
- yyyy-MM-dd
- MM/dd/yyyy
- ddd MM dd HH:mm:ss.TZD YYYY

No se admiten dentro de arrays.

Ten en cuenta que “T” es un designador de hora, no un marcador de posición, y no debe cambiarse ni eliminarse.

Los atributos de hora sin zona horaria se establecerán de forma predeterminada a medianoche UTC (y se mostrarán en el panel como el equivalente de medianoche UTC en la zona horaria de la empresa).

Los eventos con marcas de tiempo en el futuro se establecerán de forma predeterminada a la hora actual.
Cadenas 255 caracteres o menos.
Arrays Los arrays no pueden incluir fechas y horas.
Objetos Los objetos se ingieren como cadenas.

Los objetos de propiedades del evento que contienen valores de array u objeto pueden tener una carga útil de propiedades del evento de hasta 100 KB.

Claves reservadas

Las siguientes claves están reservadas y no pueden utilizarse como propiedades de eventos personalizados:

  • time
  • event_name

Persistencia de propiedades del evento

Las propiedades del evento están diseñadas para el filtrado y la personalización con Liquid en mensajes desencadenados por sus eventos principales. De forma predeterminada, no se persisten en el perfil de usuario de Braze. Para usar valores de propiedades del evento en la segmentación, consulta eventos personalizados, donde se detallan los distintos enfoques para almacenar valores de propiedades del evento a largo plazo.

Ejemplo de solicitud de evento

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

POST https://YOUR_REST_API_URL/users/track
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
  "events" : [
    {
      "external_id" : "user1",
      "app_id" : "your-app-id",
      "name" : "watched_trailer",
      "time" : "2013-07-16T19:20:30+01:00"
    },
    {
      "external_id" : "user1",
      "app_id" : "your-app-id",
      "name" : "rented_movie",
      "time" : "2013-07-16T19:20:45+01:00",
      "properties": {
        "movie": "The Sad Egg",
        "director": "Alex Smith"
      }
    },
    {
      "user_alias" : { "alias_name" : "device123", "alias_label" : "my_device_identifier"},
      "app_id" : "your-app-id",
      "name" : "watched_trailer",
      "time" : "2013-07-16T19:20:50+01:00"
    }
  ]
}

Objetos de evento

Usando el ejemplo proporcionado, podemos ver que alguien vio un tráiler recientemente y luego alquiló una película. Aunque no podemos entrar en una Campaign y segmentar a los usuarios según estas propiedades, podemos usarlas estratégicamente en forma de recibo, para enviar un mensaje personalizado a través de un canal usando Liquid. Por ejemplo, “Hola Alex, gracias por alquilar The Sad Egg de Alex Smith, aquí tienes algunas películas recomendadas basadas en tu alquiler…”
New Stuff!