Tipos de identificadores API

Esta guía de referencia aborda los distintos tipos de identificadores de API que se pueden encontrar en el panel de control de Braze, su finalidad, dónde se pueden encontrar y cómo se suelen utilizar. Para obtener información sobre las claves de la API REST o las claves de la API del espacio de trabajo, consulte la descripción general de la API.

Los siguientes identificadores pueden utilizarse para acceder a su plantilla, Canvas, campaña, segmento, envío o tarjeta desde la API externa Braze. Todos los mensajes deben seguir la codificación UTF-8.

Identificador de la aplicación

El identificador de aplicación o app_id es un parámetro que asocia la actividad con una aplicación específica en su espacio de trabajo. Designa con qué aplicación del espacio de trabajo estás interactuando. Por ejemplo, tendrás un app_id para tu aplicación para iOS, un app_id para tu aplicación para Android y un app_id para tu integración web. En Braze, es posible que tenga varias aplicaciones para la misma plataforma en los distintos tipos de plataformas compatibles con Braze.

¿Dónde puedo encontrarlo?

Hay dos maneras de localizar tu app_id:

• identificadores de la aplicación
• configuración de la aplicación

¿Para qué sirve?

Los identificadores de aplicación en Braze se utilizan al integrar el SDK y también se utilizan para hacer referencia a una aplicación específica en las llamadas a la API REST. Con app_id puedes hacer muchas cosas, como extraer datos de un evento personalizado que se haya producido para una aplicación concreta, recuperar estadísticas de desinstalación, estadísticas de nuevos usuarios, estadísticas de DAU y estadísticas de inicio de sesión para una aplicación concreta.

Múltiples identificadores de aplicaciones

Durante la configuración del SDK, el caso de uso más común para múltiples identificadores de aplicaciones es separar esos identificadores para las variantes de compilación de depuración y lanzamiento.

Para cambiar fácilmente entre varios identificadores de aplicaciones en sus compilaciones, recomendamos crear un archivo braze.xml independiente para cada variante de compilación relevante. Una variante de fabricación es una combinación del tipo de fabricación y la variante de producto. Por defecto, un nuevo proyecto Android está configurado con los tipos de compilación debug y release y sin sabores de producto.

Para cada variante de compilación relevante, crea un nuevo braze.xml para ella en src/<build variant name>/res/values/:

1
2
3
4
<?xml version="1.0" encoding="utf-8"?>
<resources>
<string name="com_braze_api_key">{YOUR_BUILD_VARIANT_API_KEY}</string>
</resources>

Cuando se compile la variante de compilación, utilizará el nuevo identificador.

Identificador de plantilla

Un identificador de plantilla o ID de plantilla es una clave aleatoria generada por Braze para una plantilla determinada dentro del cuadro de mandos. Los ID de plantilla son únicos para cada plantilla y pueden utilizarse para hacer referencia a las plantillas a través de la API.

Las plantillas son ideales si su empresa contrata sus diseños HTML para campañas. Una vez creadas las plantillas, dispondrá de una plantilla que no es específica de una campaña, sino que puede aplicarse a una serie de campañas, como un boletín de noticias.

¿Dónde puedo encontrarlo?

Puede encontrar el ID de su plantilla de dos maneras:

• plantillas
• claves de api

¿Para qué sirve?

• Actualización de plantillas a través de la API
• Obtener información sobre una plantilla específica

Identificador del lienzo

Un identificador de lienzo o Canvas ID es una clave aleatoria generada por Braze para un lienzo determinado dentro del panel de control. Los ID de lienzo son exclusivos de cada lienzo y pueden utilizarse para hacer referencia a lienzos a través de la API.

Ten en cuenta que, si tienes un Canvas con variantes, existe un ID de Canvas general, así como IDs de Canvas de variantes individuales anidados bajo el Canvas principal.

¿Dónde puedo encontrarlo?

Puedes encontrar tu Canvas ID en el panel de control. Vaya a Mensajería > Lienzo y seleccione un Lienzo preexistente. Si el lienzo que desea no existe todavía, cree uno y guárdelo. En la parte inferior de una página individual de Canvas, haga clic en Analizar variantes. Aparecerá una ventana con el identificador de la API Canvas situado en la parte inferior.

¿Para qué sirve?

• Seguimiento analítico de un mensaje específico
• Obtenga estadísticas agregadas de alto nivel sobre el rendimiento de Canvas
• Obtener detalles sobre un lienzo concreto
• Con Currents para aportar datos a nivel de usuario para un enfoque más amplio de los Canvas
• Con entrega de disparadores API para recopilar estadísticas de mensajes transaccionales.

Identificador de campaña

Un identificador de campaña o ID de campaña es una clave aleatoria generada por Braze para una campaña determinada dentro del cuadro de mandos. Los ID de campaña son exclusivos de cada campaña y pueden utilizarse para hacer referencia a las campañas a través de la API.

Ten en cuenta que, si tienes una campaña con variantes, hay tanto un ID de campaña general como ID de campaña de variantes individuales anidados bajo la campaña principal.

¿Dónde puedo encontrarlo?

Puede encontrar el ID de su campaña de dos maneras:

• campañas
• claves de api

¿Para qué sirve?

• Seguimiento analítico de un mensaje específico
• Obtén estadísticas agregadas de alto nivel sobre el rendimiento de la campaña
• Obtener detalles sobre una campaña concreta
• Con Currents para aportar datos a nivel de usuario y tener una visión más amplia de las campañas.
• Con entrega activada por API para recopilar estadísticas de mensajes transaccionales.
• Para buscar una campaña específica en la página Campañas utilizando el filtro api_id:YOUR_API_ID

Identificador de segmento

Un identificador de segmento o ID de segmento es una clave aleatoria generada por Braze para un segmento determinado dentro del cuadro de mandos. Los ID de segmento son exclusivos de cada segmento y pueden utilizarse para hacer referencia a los segmentos a través de la API.

¿Dónde puedo encontrarlo?

Puedes encontrar tu ID de segmento de dos maneras:

• segmentos
• claves de api

¿Para qué sirve?

• Obtener detalles sobre un segmento específico
• Recuperar análisis de un segmento específico
• Tira de cuántas veces se ha registrado un evento personalizado para un segmento concreto
• Especificar y enviar una campaña a los miembros de un segmento desde la API

Identificador de la tarjeta

Un identificador de tarjeta o ID de tarjeta es una clave aleatoria generada por Braze para una determinada tarjeta de noticias dentro del cuadro de mandos. Los ID de tarjeta son exclusivos de cada tarjeta de noticias y pueden utilizarse para hacer referencia a las tarjetas a través de la API.

¿Dónde puedo encontrarlo?

Puede encontrar su tarjeta de identificación de dos maneras:

• canal de noticias
• claves de api

¿Para qué sirve?

• Recuperar información relevante de una tarjeta
• Seguimiento de los eventos relacionados con las tarjetas de contenido y el compromiso

Enviar identificador

Un identificador de envío, o ID de envío, es una clave generada por Braze o creada por usted para un envío de mensaje determinado bajo la cual debe realizarse el seguimiento de los análisis. El identificador de envío le permite recuperar los análisis de una instancia específica de una campaña enviada a través del punto final/sends/data_series .

¿Dónde puedo encontrarlo?

Las campañas activadas por API y API que se envían como difusión generarán automáticamente un identificador de envío si no se proporciona un identificador de envío. Si deseas especificar tu propio identificador de envío, primero tendrás que crear uno a través del punto final/sends/id/create . El identificador debe tener todos los caracteres ASCII y una longitud máxima de 64 caracteres. Puede reutilizar un identificador de envío en varios envíos de la misma campaña si desea agrupar los análisis de esos envíos.

¿Para qué sirve?

Envíe y siga el rendimiento de los mensajes mediante programación, sin necesidad de crear campañas para cada envío.

Identificador del grupo de suscripción

Un identificador de grupo de suscripción, o ID de grupo de suscripción, es una clave generada por Braze para un grupo de suscripción determinado. Los ID son únicos para cada grupo de suscripción y pueden utilizarse para hacer referencia a los grupos de suscripción a través de la API.

¿Dónde puedo encontrarlo?

Vaya a Audiencia > Suscripciones y copie el ID que aparece junto al grupo de suscripción correspondiente.

¿Para qué sirve?

• Listar los grupos de suscripción de un usuario
• Obtener el estado del grupo de suscripción de un usuario
• Actualizar el estado del grupo de suscripción de un usuario