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

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

POST /v3/templates/process

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

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

少なくとも、要求本文で次の必須属性を指定する必要があります。

属性	種類	形容	使用例
templates	JSONオブジェクトのJSON配列	テンプレートを定義するカスタムHTML、CSS、JavaScript、FreeMarkerコード。	該当なし
templateVariables	オブジェクト	テンプレート変数とそれに対応する値。	{ "Name": "John", "ProductType": "sneakers" }

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

属性	種類	形容	使用例
id	string enum (小文字)	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</div>" CSSの: "#test {text-transform: uppercase}" JavaScriptの: "insertHTMLBefore(\"body\");" フリーマーカー: "{}"

属性

種類

形容

使用例

string enum (小文字)

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</div>"
CSSの: "#test {text-transform: uppercase}"
JavaScriptの: "insertHTMLBefore(\"body\");"
フリーマーカー: "{}"

リクエストには、テンプレートパラメータ(ProductType | stringなど)とテンプレート変数値(ProductTypeのsneakersなど)を含めます。

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

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

{
    "templates": [
        {
            "id": "html",
            "template": "<title>Hi, John!</title>\n<content>This week, our sneakers are on sale!<content>"
        },
        {
            "id": "css",
            "template": "title {text-transform: uppercase}"
        }
    ]
}

この記事を改善するための提案がある場合は、お知らせください!

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

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