キャンバスの翻訳を表示する
get
/canvas/translations/?locale_id={locale_id}
このエンドポイントを使用して、翻訳されたメッセージを表示し、このメッセージがユーザーにとってどのように見えるかを確認する。
important:
API 経由でキャンバスに翻訳されたメッセージを表示することは、現在、早期アクセスの段階です。早期アクセスへの参加に興味がある方は、Brazeのアカウントマネージャーに連絡を。
前提条件
このエンドポイントを使用するには、canvas.translations.get
権限を持つ API キーが必要です。
レート制限
このエンドポイントには、1時間あたり250,000リクエストというレート制限がある。
パスパラメーター
パラメーター | required | データ型 | 説明 |
---|---|---|---|
canvas_id |
必須 | string | キャンバスのID。 |
message_variation_id |
必須 | string | メッセージバリエーションのID。 |
locale_id |
必須 | string | ロケールのID。 |
リクエスト例
1
2
3
curl --location --request GET 'https://rest.iad-03.braze.com/canvas/translations/?locale_id={locale_id}' \
--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
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
"translations": [
{
"locale": {
"name": "es-MX",
"country": "Mexico",
"language": "Spanish",
},
"translation_map": {
"id_0": "Hello",
"id_1": "My name is Jacky",
"id_2": "Where is the library?"
}
}
]
}
エラー応答例
ステータスコード400
は、次の応答本文を返す可能性があります。遭遇する可能性のあるエラーの詳細については、「トラブルシューティング」を参照のこと。
1
2
3
4
5
6
7
{
"errors": [
{
"message": "Invalid locale ID"
}
]
}
トラブルシューティング
以下の表は、返される可能性のあるエラーと、それに関連するトラブルシューティングの手順を示したものである。
エラーメッセージ | トラブルシューティング |
---|---|
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!