Ver tradução para uma canva
/canvas/translations/?locale_id={locale_id}
Use este endpoint para visualizar uma mensagem traduzida e ver como essa mensagem aparece para um usuário.
A visualização de uma mensagem traduzida para uma canva via API está atualmente em acesso antecipado. Entre em contato com o gerente da sua conta Braze se estiver interessado em participar do acesso antecipado.
Pré-requisitos
Para usar esse endpoint, você precisará de uma chave de API com a permissão canvas.translations.get
.
Limite de taxa
Esse endpoint tem um limite de frequência de 250.000 solicitações por hora.
Parâmetros da jornada
Parâmetro | Obrigatória | Tipo de dados | Descrição |
---|---|---|---|
step_id |
Obrigatória | String | O ID de sua etapa do canva. |
message_variation_id |
Obrigatória | String | O ID para a sua variação de mensagem. |
locale_id |
Obrigatória | String | O ID do local. |
Nota todos os IDs de tradução são considerados identificadores únicos universais (UUIDs), que podem ser encontrados em Suporte Multilíngue configurações ou na resposta da solicitação.
Exemplo de solicitação
1
2
3
curl --location --request GET 'https://rest.iad-03.braze.com/canvas/translations/?locale_id={locale_id}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
Resposta
Há quatro respostas de código de status para esse endpoint: 200
, 400
, 404
, e 429
.
Exemplo de resposta bem-sucedida
O código de status 200
pode retornar o seguinte cabeçalho e corpo de resposta.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
"translations": [
{
"locale": {
"name": "es-MX",
"country": "Mexico",
"language": "Spanish",
},
"translation_map": {
"id_0": "Hello",
"id_1": "My name is Jacky",
"id_2": "Where is the library?"
}
}
]
}
Exemplo de resposta de erro
O código de status 400
pode retornar o seguinte corpo de resposta. Consulte Resolução de problemas para saber mais sobre os erros que você pode encontrar.
1
2
3
4
5
6
7
{
"errors": [
{
"message": "Invalid locale ID"
}
]
}
Solução de problemas
A tabela a seguir lista os possíveis erros retornados e suas etapas de solução de problemas associadas.
Mensagem de erro | Solução de problemas |
---|---|
INVALID_CAMPAIGN_ID |
Confirme se o ID da campanha corresponde à campanha que você está traduzindo. |
INVALID_LOCALE_ID |
Confirme se o seu ID de localidade existe na sua tradução. |
INVALID_MESSAGE_VARIATION_ID |
Confirme que seu ID de mensagem está correto. |
MESSAGE_NOT_FOUND |
Verifique se a mensagem a ser traduzida está correta. |
LOCALE_NOT_FOUND |
Confirme se o local existe em suas configurações multilíngues. |
MULTI_LANGUAGE_NOT_ENABLED |
As configurações multilíngues não estão ativadas para o seu espaço de trabalho. |
MULTI_LANGUAGE_NOT_ENABLED_ON_MESSAGE |
Somente as campanhas de e-mail ou as mensagens de canva com e-mails podem ser traduzidas. |
UNSUPPORTED_CHANNEL |
Somente mensagens em campanhas de mensagens ou mensagens de canvas com e-mails podem ser traduzidas. |