Skip to content

Übersetzung für ein Canvas anzeigen

get

/canvas/translations

Verwenden Sie diesen Endpunkt, um eine Vorschau einer übersetzten Nachricht für ein Canvas anzuzeigen. Weitere Informationen zu Übersetzungsfeatures finden Sie unter Locales in Nachrichten.

Voraussetzungen

Um diesen Endpunkt zu verwenden, benötigen Sie einen API-Schlüssel mit der Berechtigung canvas.translations.get.

Rate-Limit

Dieser Endpunkt hat ein Rate-Limit von 250.000 Anfragen pro Minute.

Abfrageparameter

Parameter Erforderlich Datentyp Beschreibung
workflow_id Erforderlich String Die ID des Canvas.
step_id Erforderlich String Die ID Ihres Canvas-Schritts.
message_variation_id Erforderlich String Die ID Ihrer Nachrichtenvariante.
locale_id Optional String Die ID (UUID) der Locale.
post_launch_draft_version Optional Boolescher Wert Wenn true, wird die neueste Entwurfsversion anstelle der zuletzt veröffentlichten Live-Version zurückgegeben. Standardmäßig false, wodurch die aktuellste Live-Version zurückgegeben wird.

Beispielanfrage

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'

Antwort

Es gibt vier Statuscode-Antworten für diesen Endpunkt: 200, 400, 404 und 429.

Beispiel für eine erfolgreiche Antwort

Der Statuscode 200 könnte den folgenden Antwort-Header und -Body zurückgeben.

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

Beispiel für eine Fehlerantwort

Der Statuscode 400 könnte den folgenden Antworttext zurückgeben. Unter Fehlerbehebung finden Sie weitere Informationen zu Fehlern, die auftreten können.

1
2
3
4
5
6
7

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