キャンバスの翻訳を表示する

このエンドポイントを使用して、翻訳されたメッセージを表示し、このメッセージがユーザーにとってどのように見えるかを確認する。

前提条件

このエンドポイントを使用するには、API キーとcanvas.translations.getの権限が必要です。

レート制限

このエンドポイントには、1時間あたり250,000リクエストというレート制限がある。

パスパラメーター

すべての翻訳IDは、ユニバーサルユニーク識別子（UUID）とみなされ、多言語サポート設定またはリクエストレスポンスで見つけることができる。

例のリクエスト

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

トラブルシューティング

以下の表は、返される可能性のあるエラーと、それに関連するトラブルシューティングの手順を示したものである。