Skip to content

キャンバスの翻訳をリスト

get

/canvases/translations

キャンバスのすべての翻訳を表示するには、このエンドポイントを使用する。

前提条件

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

レート制限

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

パスパラメーター

パラメーター required データ型 説明
canvas_id 必須 string キャンバスのID。
step_id 必須 string キャンバスのステップのID。

リクエスト例

1
2
3

curl --location --request GET 'https://rest.iad-03.braze.com/canvas/translations' \
--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": "zh-HK",
 				"country": "Hong Kong",
 				"language": "Chinese (Traditional)",
			},
			"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": "This message does not support multi-language."
		}
	]
}

トラブルシューティング

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

エラーメッセージ トラブルシューティング
INVALID_CAMPAIGN_ID キャンペーン ID が翻訳するキャンペーンと一致していることを確認します。
INVALID_MESSAGE_VARIATION_ID メッセージIDが正しいことを確認する。
MESSAGE_NOT_FOUND 翻訳するメッセージを確認します。
MULTI_LANGUAGE_NOT_ENABLED ワークスペースの多言語設定がオンになっていない。
MULTI_LANGUAGE_NOT_ENABLED_ON_MESSAGE メールキャンペーンまたはメールが含まれているキャンバスメッセージのみを翻訳できます。
UNSUPPORTED_CHANNEL メールキャンペーン内のメッセージ、またはメールが含まれているキャンバスメッセージのみを翻訳できます。
  GitHub でこのページを編集
「このページはどの程度役に立ちましたか?」
New Stuff!