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 Braze, su finalidad, dónde encontrarlos y cómo se suelen utilizar. Para obtener información sobre las claves de API REST o las claves de API del espacio de trabajo, consulta el resumen de la API.
Los siguientes identificadores pueden utilizarse para acceder a tu plantilla, Canvas, Campaign o Segment desde la API externa de 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 tu espacio de trabajo. Designa con qué aplicación del espacio de trabajo estás interactuando. Por ejemplo, puedes tener un app_id para tu aplicación iOS, un app_id para tu aplicación Android y un app_id para tu integración web. En Braze, es posible que tengas varias aplicaciones para la misma plataforma en los distintos tipos de plataformas que Braze admite.
¿Dónde puedo encontrarlo?
Hay dos maneras de localizar tu app_id:
Ve a Configuración > API e identificadores > Identificadores de aplicación. Tu clave de API para cada aplicación aparece en la columna Identificador.
Ve a Configuración > Configuración de la aplicación. Tu clave de API aparece junto al campo Clave de API en la sección de configuración.
¿Para qué sirve?
Los identificadores de aplicación en Braze se utilizan al integrar el SDK y también para hacer referencia a una aplicación específica en las llamadas a la REST API. Con el 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.
A veces puede que se te pida un app_id pero no estés trabajando con una aplicación, porque es un campo heredado específico de una plataforma concreta. Puedes omitir este campo incluyendo cualquier cadena de caracteres como marcador de posición de este parámetro obligatorio.
Múltiples identificadores de aplicación
Durante la configuración del SDK, el caso de uso más común para múltiples identificadores de aplicación es separar esos identificadores para las variantes de compilación de depuración y lanzamiento.
Para cambiar fácilmente entre varios identificadores de aplicación en tus compilaciones, te recomendamos crear un archivo braze.xml distinto para cada variante de compilación relevante. Una variante de compilación es una combinación del tipo de compilació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 variantes de producto.
Para cada variante de compilación relevante, crea un nuevo braze.xml 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 compila la variante de compilación, utiliza 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 dashboard. 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 tu empresa externaliza los diseños HTML para Campaigns. Una vez construidas las plantillas, tienes una plantilla que no es específica de una Campaign, sino que puede aplicarse a una serie de Campaigns, como un boletín de noticias.
¿Dónde puedo encontrarlo?
Puedes encontrar el ID de tu plantilla de dos maneras:
Ve a Plantillas, selecciona una página de plantilla y luego selecciona una plantilla preexistente. Si la plantilla que deseas aún no existe, crea una y guárdala. En la parte inferior de la página de la plantilla individual, puedes encontrar el identificador de tu plantilla.
Ve a Configuración > API e identificadores. Aquí, Braze ofrece una búsqueda de Identificadores de API adicionales donde puedes buscar identificadores específicos.
¿Para qué sirve?
- Actualizar plantillas mediante la API
- Obtener información sobre una plantilla específica
Identificador de Canvas
Un identificador de Canvas o Canvas ID es una clave aleatoria generada por Braze para un Canvas determinado dentro del dashboard. Los Canvas ID son únicos para cada Canvas y pueden utilizarse para hacer referencia a Canvas a través de la API.
Ten en cuenta que si tienes un Canvas con variantes, existe un Canvas ID general, así como Canvas ID de variantes individuales anidados bajo el Canvas principal.
¿Dónde puedo encontrarlo?
Puedes encontrar tu Canvas ID en el dashboard. Ve a Mensajería > Canvas y selecciona un Canvas preexistente. Si el Canvas que deseas no existe todavía, crea uno y guárdalo. En la parte inferior de una página individual de Canvas, haz clic en Analyze Variants. Aparecerá una ventana con el identificador de API de Canvas en la parte inferior.
¿Para qué sirve?
- Seguimiento de análisis de un mensaje específico
- Obtener estadísticas agregadas de alto nivel sobre el rendimiento de Canvas
- Obtener detalles sobre un Canvas concreto
- Con Currents para aportar datos a nivel de usuario y tener una visión más amplia de los Canvas
- Con entrega desencadenada por API para recopilar estadísticas de mensajes transaccionales
Identificador de Campaign
Un identificador de Campaign o ID de Campaign es una clave aleatoria generada por Braze para una Campaign determinada dentro del dashboard. Los ID de Campaign son únicos para cada Campaign y pueden utilizarse para hacer referencia a Campaigns a través de la API.
Ten en cuenta que, si tienes una Campaign con variantes, hay tanto un ID de Campaign general como ID de Campaign de variantes individuales anidados bajo la Campaign principal.
¿Dónde puedo encontrarlo?
Puedes encontrar tu ID de Campaign de dos maneras:
Ve a Mensajería > Campaigns y selecciona una Campaign preexistente. Si la Campaign que deseas no existe todavía, crea una y guárdala. En la parte inferior de la página de cada Campaign, puedes encontrar tu Campaign API Identifier.
Ve a Configuración > API e identificadores. Aquí, Braze ofrece una búsqueda de Identificadores de API adicionales donde puedes buscar identificadores específicos.
¿Para qué sirve?
- Seguimiento de análisis de un mensaje específico
- Obtener estadísticas agregadas de alto nivel sobre el rendimiento de Campaign
- Obtener detalles sobre una Campaign concreta
- Con Currents para aportar datos a nivel de usuario y tener una visión más amplia de las Campaigns
- Con entrega desencadenada por API para recopilar estadísticas de mensajes transaccionales
- Para buscar una Campaign específica en la página Campaigns utilizando el filtro
api_id:YOUR_API_ID
Identificador de Segment
Un identificador de Segment o ID de Segment es una clave aleatoria generada por Braze para un Segment determinado dentro del dashboard. Los ID de Segment son únicos para cada Segment y pueden utilizarse para hacer referencia a Segments a través de la API.
¿Dónde puedo encontrarlo?
Puedes encontrar el ID de tu Segment de dos maneras:
Ve a Audiencia > Segments y selecciona un Segment preexistente. Si el Segment que deseas no existe todavía, crea uno y guárdalo. En la parte inferior de la página del Segment individual, puedes encontrar el identificador de tu Segment.
Ve a Configuración > API e identificadores. Aquí, Braze ofrece una búsqueda de Identificadores de API adicionales donde puedes buscar identificadores específicos.
¿Para qué sirve?
- Obtener detalles sobre un Segment específico
- Recuperar análisis de un Segment específico
- Consultar cuántas veces se ha registrado un evento personalizado para un Segment concreto
- Especificar y enviar una Campaign a los miembros de un Segment desde la API
Identificador de envío
Un identificador de envío, o ID de envío, es una clave generada por Braze o creada por ti para un envío de mensaje determinado bajo la cual se realiza el seguimiento de los análisis. El identificador de envío te permite recuperar los análisis de una instancia específica de un envío de Campaign a través del punto de conexión /sends/data_series.
¿Dónde puedo encontrarlo?
Las Campaigns desencadenadas por API que se envían como difusión generan automáticamente un identificador de envío si no se proporciona uno. Si quieres especificar tu propio identificador de envío, primero debes crear uno a través del punto de conexión /sends/id/create. El identificador debe contener solo caracteres ASCII y tener una longitud máxima de 64 caracteres. Puedes reutilizar un identificador de envío en varios envíos de la misma Campaign si deseas agrupar los análisis de esos envíos.
¿Para qué sirve?
Enviar y hacer seguimiento del rendimiento de los mensajes de forma programática, sin necesidad de crear Campaigns 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?
Ve a Audiencia > Suscripciones y copia 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