Afficher la traduction d’un canvas
/canvas/translations
Utilisez cet endpoint pour prévisualiser un message traduit pour un Canvas. Pour plus d’informations sur les fonctionnalités de traduction, reportez-vous à la section Locales dans les messages.
Cet endpoint est actuellement en accès anticipé. Contactez votre gestionnaire de compte Braze si vous souhaitez participer à l’accès anticipé.
Conditions préalables
Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation canvas.translations.get.
Limite de débit
Le débit de cet endpoint est limité à 250 000 requêtes par minute.
Paramètres de recherche
| Paramètre | Requis | Type de données | Description |
|---|---|---|---|
workflow_id |
Requis | Chaîne de caractères | L’ID de la toile. |
step_id |
Requis | Chaîne de caractères | L’ID de votre étape du canvas. |
message_variation_id |
Requis | Chaîne de caractères | L’ID de la variation de votre message. |
locale_id |
Facultatif | Chaîne de caractères | L’ID (UUID) de la locale. |
post_launch_draft_version |
Facultatif | Valeur booléenne | Lorsque true renvoie la dernière version provisoire au lieu de la dernière version publiée en ligne/instantanée. La valeur par défaut est false, qui renvoie la dernière version en ligne/en production/instantanée. |
Tous les ID de traduction sont considérés comme des identifiants uniques universels (UUID), qui peuvent être trouvés dans la réponse de l’endpoint GET.
Exemple de demande
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'
Réponse
Quatre réponses de code de statut existent pour cet endpoint : 200, 400, 404 et 429.
Exemple de réponse réussie
Le code de statut 200 pourrait retourner l’en-tête et le corps de réponse suivant.
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"
}
}
]
}
Exemple de réponse échouée
Le code de statut 400 pourrait renvoyer le corps de réponse suivant. Consultez la résolution des problèmes pour plus d’informations concernant les erreurs que vous pourriez rencontrer.
1
2
3
4
5
6
7
{
"errors": [
{
"message": "The provided locale code does not exist."
}
]
}
Modifier cette page sur GitHub