プレビューテンプレートコード

POST /v3/templates/process

このエンドポイントでは、テンプレートパラメータを含む テンプレートコードを テストできます。テンプレートパラメータは動的なプレースホルダーで、テンプレートをレンダリングするとテンプレート変数の値に置き換えられます。

リクエストでは、テンプレートのパラメータと変数の値の両方を含めます。レスポンスでは、テンプレートの変数値を含む全コードが返されます。

最低限、リクエスト文に以下の必要な属性を記載する必要があります:

属性

種類

概要

例

templates

JSON JSONオブジェクトの配列

テンプレートを定義するカスタムHTML、CSS、JavaScript、FreeMarkerコード。

"mys3cr3tstr1ingforauth1!x"

templateVariables

目的

テンプレート変数とそれに対応する値を。

{ "Name": "John", "ProductType": "sneakers" }

templates配列のオブジェクトには、以下の属性を使用します。

属性

種類

概要

例

id

文字列エナック(小文字)

template属性に含まれるコードの種類です。

例えば、テンプレートにCSSコードを含めるには、この値を "css"に設定し、 template 属性でカスタムCSSコードを指定します。

以下のいずれかでなければなりません:

• "html"
• "css"
• "js"
• "freemarker"

template

ストリング

ストリング化されたHTML、CSS、JavaScript、またはFreeMarkerコード。

FreeMarkerコードでは、最低限開頭と閉じるカーリーブラケット {}を含める必要があります。

• HTML: "<div id=\"test\">Our best ProductType | string on sale"
• CSS: "#test {text-transform: uppercase}"
• JavaScript: "insertHTMLBefore(\"body\");"
• FreeMarker: "{}"

リクエストにはテンプレートパラメータ、例えばProductType | stringやテンプレート変数の値を含みます。 sneakers例えば、ProductType:

curl -X POST '/v3/templates/process' \ -H 'Authorization: Bearer ' \ -H 'Accept: application/json' \ --data-raw ' { "templates": { "id": "html", "template": "\nThis week, our ProductType | string are on sale!" }, { "id": "css", "template": "title {text-transform: Style | string}" } , "templateVariables": { "Name": "John", "ProductType": "sneakers", "Style": "uppercase" } }'

応答では、テンプレートの変数値を含むテンプレートコード全体が返されます。例えば、John、sneakers、uppercase:

{ "templates": { "id": "html", "template": "\nThis week, our sneakers are on sale!" }, { "id": "css", "template": "title {text-transform: uppercase}" }

}