Skip to content

Ver la traducción de un Canvas

get

/canvas/translations

Utiliza este endpoint para obtener una vista previa de un mensaje traducido para un Canvas. Consulta Locales en los mensajes para obtener más información sobre las características de traducción.

Requisitos previos

Para utilizar este endpoint, necesitarás una clave de API con el permiso canvas.translations.get.

Límite de velocidad

Este endpoint tiene un límite de velocidad de 250 000 solicitudes por minuto.

Parámetros de consulta

Parámetro Obligatorio Tipo de datos Descripción
workflow_id Obligatorio Cadena El ID del Canvas.
step_id Obligatorio Cadena El ID de tu paso en Canvas.
message_variation_id Obligatorio Cadena El ID de tu variación de mensaje.
locale_id Opcional Cadena El ID (UUID) de la configuración regional.
post_launch_draft_version Opcional Booleano Cuando es true, devuelve la última versión de borrador en lugar de la última versión publicada en vivo. El valor predeterminado es false, que devuelve la última versión en vivo.

Ejemplo de solicitud

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'

Respuesta

Hay cuatro respuestas de código de estado para este endpoint: 200, 400, 404 y 429.

Ejemplo de respuesta correcta

El código de estado 200 podría devolver el siguiente encabezado y cuerpo de respuesta.

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"
            }
        }
    ]
}

Ejemplo de respuesta de error

El código de estado 400 podría devolver el siguiente cuerpo de respuesta. Consulta Solución de problemas para obtener más información sobre los errores que puedes encontrar.

1
2
3
4
5
6
7

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