Tipos de identificadores da API

Este guia de referência aborda os diferentes tipos de identificadores de API que podem ser encontrados no dashboard da Braze, sua finalidade, onde você pode encontrá-los e como eles são normalmente usados. Para obter informações sobre as chaves da API REST ou as chaves da API do espaço de trabalho, consulte a visão geral da API.

Os seguintes identificadores podem ser usados para acessar seu modelo, canva, campanha ou segmento da API externa do Braze. Todas as mensagens devem seguir a codificação UTF-8.

Identificador do app

O identificador de aplicativo ou app_id é um parâmetro que associa a atividade a um app específico em seu espaço de trabalho. Ele designa com qual app dentro do espaço de trabalho você está interagindo. Por exemplo, você verá que terá um app_id para seu app para iOS, um app_id para seu app para Android e um app_id para sua integração na Web. No Braze, você pode descobrir que tem vários apps para a mesma plataforma nos vários tipos de plataforma suportados pelo Braze.

Onde posso encontrá-lo?

Há duas maneiras de localizar seu app_id:

• identificadores de app
• configurações do app

Para que ele pode ser usado?

Os identificadores de aplicativos no Braze são usados na integração do SDK e também são usados para fazer referência a um aplicativo específico nas chamadas da API REST. Com o app_id, é possível fazer muitas coisas, como extrair dados de um evento personalizado que ocorreu em um determinado app, recuperar estatísticas de desinstalação, estatísticas de novos usuários, estatísticas de DAU e estatísticas de início de sessão de um determinado app.

Vários identificadores de app

Durante a configuração do SDK, o caso de uso mais comum para vários identificadores de app é separar esses identificadores para variantes de compilação de depuração e lançamento.

Para alternar facilmente entre vários identificadores de app em suas compilações, recomendamos criar um arquivo braze.xml separado para cada variante de build relevante. Uma variante de compilação é uma combinação de tipo de compilação e sabor do produto. Por padrão, um novo projeto Android é configurado com debug e release tipos de build e sem sabores de produto.

Para cada variante de compilação relevante, crie um novo braze.xml para ela em 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>

Quando a variante de compilação for compilada, ela usará o novo identificador.

Identificador do modelo

Um identificador de modelo ou ID de modelo é uma chave aleatória gerada pelo Braze para um determinado modelo dentro do dashboard. Os IDs de modelo são exclusivos para cada modelo e podem ser usados para fazer referência a modelos por meio da API.

Modelos são ótimos se sua empresa contrata seus designs HTML para campanhas. Depois que os modelos foram construídos, você agora tem um modelo que não é específico para uma campanha, mas pode ser aplicado a uma série de campanhas, como um boletim informativo.

Onde posso encontrá-lo?

Você pode encontrar seu ID de modelo de duas maneiras:

• modelos
• chaves de api

Para que ele pode ser usado?

• Atualizar modelos usando a API
• Obter informações sobre um modelo específico

Identificador de tela

Um identificador canva ou ID de canva é uma chave aleatória gerada pelo Braze para um determinado canva dentro do dashboard. As IDs do Canvas são exclusivas para cada Canvas e podem ser usadas para fazer referência a Canvases por meio da API.

Tenha em mente que se você tiver um canva que possui variantes, existe um ID de canva geral, bem como IDs de canva de variantes individuais aninhados sob o canva principal.

Onde posso encontrá-lo?

Você pode encontrar seu ID do canva no dashboard. Acesse Envio de mensagens > Canvas e selecione um Canvas pré-existente. Se o canva que você deseja ainda não existir, crie um e salve-o. Na parte inferior de uma página individual do Canvas, clique em Analyze Variants (Analisar variantes). Uma janela é exibida com o identificador da API do Canva localizado na parte inferior.

Para que ele pode ser usado?

• Rastreamento da análise de dados em uma mensagem específica
• Obtenha estatísticas agregadas de alto nível sobre a performance do Canva
• Obter detalhes sobre um Canva específico
• Com o Currents para trazer dados de nível de usuário para uma abordagem “mais ampla” do Canvas
• Com entrega acionada por API para coletar estatísticas para mensagens transacionais

Identificador de campanha

Um identificador campanha ou ID de campanha é uma chave aleatória gerada pelo Braze para uma determinada campanha dentro do dashboard. Os IDs de campanha são exclusivos para cada campanha e podem ser usados para fazer referência a campanhas por meio da API.

Tenha em mente que, se você tiver uma campanha que possui variantes, há tanto um ID de campanha geral quanto IDs de campanha de variantes individuais aninhados sob a campanha principal.

Onde posso encontrá-lo?

Você pode encontrar seu ID de campanha de duas maneiras:

• campanhas
• chaves de api

Para que ele pode ser usado?

• Rastreamento da análise de dados em uma mensagem específica
• Obtenha estatísticas agregadas de alto nível sobre a performance da campanha
• Obter detalhes sobre uma campanha específica
• Com o Currents para trazer dados de usuários para uma abordagem “mais ampla” das campanhas
• Com entrega acionada por API para coletar estatísticas para mensagens transacionais
• Para pesquisar uma campanha específica na página Campaigns usando o filtro api_id:YOUR_API_ID

Identificador de segmento

Um identificador segmento ou ID de segmento é uma chave aleatória gerada pelo Braze para um determinado segmento dentro do dashboard. As IDs de segmento são exclusivas para cada segmento e podem ser usadas para fazer referência a segmentos por meio da API.

Onde posso encontrá-lo?

Você pode encontrar seu ID de segmento de duas maneiras:

• segmentos
• chaves de api

Para que ele pode ser usado?

• Obter detalhes sobre um segmento específico
• Recuperar análises de dados de um segmento específico
• Puxe quantas vezes um evento personalizado foi registrado para um segmento específico
• Especifique e envie uma campanha para membros de um segmento a partir da API

Enviar identificador

Um identificador de envio, ou ID de envio, é uma chave gerada pelo Braze ou criada por você para um determinado envio de mensagens sob a qual a análise de dados deve ser rastreada. O identificador de envio permite que você obtenha análises de dados para uma instância específica de uma campanha enviada por meio do endpoint/sends/data_series .

Onde posso encontrá-lo?

As campanhas disparadas por API e API que são enviadas como um broadcast gerarão automaticamente um identificador de envio se um identificador de envio não for fornecido. Se você quiser especificar seu próprio identificador de envio, primeiro terá de criar um por meio do endpoint/sends/id/create . O identificador precisa conter todos os caracteres ASCII e ter no máximo 64 caracteres. Você pode reutilizar um identificador de envio em vários envios da mesma campanha se quiser agrupar a análise desses envios.

Para que ele pode ser usado?

Envie e rastreie a performance das mensagens de forma programática, sem a criação de campanhas para cada envio.

Identificador do grupo de inscrições

Um identificador de grupo de inscrições, ou ID de grupo de inscrições, é uma chave gerada pelo Braze para um determinado grupo de inscrições. Os IDs são exclusivos para cada grupo de inscrições e podem ser usados para fazer referência a grupos de inscrições por meio da API.

Onde posso encontrá-lo?

Acesse Público > Inscrições e copie a ID ao lado do respectivo grupo de inscrições.

Para que ele pode ser usado?

• Listar os grupos de inscrições de um usuário
• Obter o status do grupo de inscrições de um usuário
• Atualizar o status do grupo de inscrições de um usuário