キャンバスの翻訳を表示する
get
/canvas/translations/?locale_id={locale_id}
このエンドポイントを使用して、キャンバスの翻訳されたメッセージをプレビューします。
important:
このエンドポイントは現在早期アクセス中である。早期アクセスへの参加に興味がある方は、Brazeのアカウントマネージャーに連絡を。
前提条件
このエンドポイントを使用するには、API キーとcanvas.translations.get
の権限が必要です。
レート制限
クエリーパラメーター
パラメータ | required | データ型 | 説明 |
---|---|---|---|
workflow_id |
必須 | string | キャンバスの ID。 |
step_id |
必須 | 文字列 | キャンバスのステップのID。 |
message_variation_id |
必須 | 文字列 | メッセージバリエーションのID。 |
locale_id |
必須 | 文字列 | ロケールのID。 |
すべての翻訳IDは、ユニバーサルユニーク識別子(UUID)とみなされ、多言語サポート設定またはリクエストレスポンスで見つけることができる。
リクエスト例
1
2
3
curl --location --request GET 'https://rest.iad-03.braze.com/canvas/translations/?locale_id={locale_uuid}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
応答
このエンドポイントには、200
、400
、404
、429
という 4 つのステータスコードの応答があります。
成功応答の例
ステータスコード 200
は、次の応答ヘッダーと本文を返す可能性があります。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
"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"
}
}
]
}
エラー応答例
ステータスコード 400
は、次の応答本文を返す可能性があります。遭遇する可能性のあるエラーの詳細については、「トラブルシューティング」を参照のこと。
1
2
3
4
5
6
7
{
"errors": [
{
"message": "The provided locale code does not exist."
}
]
}
トラブルシューティング
以下の表は、返される可能性のあるエラーと、それに関連するトラブルシューティングの手順を示したものである。
エラーメッセージ | トラブルシューティング |
---|---|
INVALID_CAMPAIGN_ID |
キャンペーン ID が翻訳するキャンペーンと一致していることを確認します。 |
INVALID_LOCALE_ID |
メッセージ翻訳にロケール ID が存在することを確認します。 |
INVALID_MESSAGE_VARIATION_ID |
メッセージIDが正しいことを確認する。 |
MESSAGE_NOT_FOUND |
メッセージが翻訳されていることを確認します。 |
LOCALE_NOT_FOUND |
多言語設定にロケールが存在することを確認します。 |
MULTI_LANGUAGE_NOT_ENABLED |
ワークスペースの多言語設定がオンになっていない。 |
MULTI_LANGUAGE_NOT_ENABLED_ON_MESSAGE |
メール、プッシュ、アプリ内メッセージキャンペーン、またはメールを含むキャンバスメッセージのみを翻訳できます。 |
UNSUPPORTED_CHANNEL |
メール、プッシュ、またはアプリ内メッセージキャンペーンまたはキャンバスメッセージのみを翻訳できます。 |
New Stuff!