Skip to content

Ver tradução para um Canvas

get

/canvas/translations

Use este endpoint para pré-visualizar uma mensagem traduzida para um Canvas. Consulte Locais em mensagens para saber mais sobre os recursos de tradução.

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 taxa de 250.000 solicitações por minuto.

Parâmetros de consulta

Parâmetro Obrigatória Tipo de dados Descrição
workflow_id Obrigatória String O ID do Canvas.
step_id Obrigatória String O ID da sua etapa do Canvas.
message_variation_id Obrigatória String O ID da sua variação de mensagem.
locale_id Opcional String O ID (UUID) da localização.
post_launch_draft_version Opcional booleano Quando true, retorna a versão mais recente do rascunho em vez da versão publicada mais recente. O padrão é false, retornando a versão publicada mais recente.

Exemplo de solicitação

1
2
3

curl --location --request GET 'https://rest.iad-03.braze.com/canvas/translations/?workflow_id={workflow_id}&step_id={step_id}&message_variation_id={message_variation_id}&locale_id={locale_uuid}&post_launch_draft_version=true' \
--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 poderia 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

{
    "translations": [
        {
            "translation_map": {
                "id_0": "¡Hola!",
                "id_1": "Me llamo Jacky",
                "id_2": "¿Dónde está la biblioteca?"
            },
            "locale": {
                "uuid": "c7c12345-te35-1234-5678-abcdefa99r3f",
                "name": "es-MX",
                "country": "MX",
                "language": "es",
                "locale_key": "es-mx"
            }
        }
    ]
}

Exemplo de resposta de erro

O código de status 400 poderia retornar o seguinte corpo de resposta. Consulte Solução de problemas para obter mais informações sobre os erros que você pode encontrar.

1
2
3
4
5
6
7

{
	"errors": [
		{
			"message": "The provided locale code does not exist."
		}
	]
}
New Stuff!