テンプレートREST API

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

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

テンプレートREST APIを使用すると、Webテンプレートおよび決定テンプレートに対してCRUD操作を実行できます。オファーテンプレートは、Sitecore PersonalizeREST APIでは使用できません。

テンプレートには、次の属性を使用します。

属性	種類	形容	使用例
name	糸	テンプレートの名前。	"Alert bar template"
friendlyId	糸	テンプレートの一意のID。小文字の英数字とアンダースコアのみを使用できます。	"alert_bar_template_1"
type	string enum (大文字)	テンプレートのタイプ。	次のいずれかである必要があります。 "WEB" "DECISION" "CONDITION" "JS_MODULE"
status	string enum (大文字)	テンプレートの現在のステータス。	次のいずれかである必要があります。 "DRAFT" "PUBLISHED"
description	糸	接続の説明。	"Alert bar web template"
render	ブーリアン	WebテンプレートのプレビューをSitecore Personalizeアプリでレンダリングするかどうかを決定します。これをtrueに設定するのは、Webテンプレートがレンダリングできると確信している場合にのみ行ってください。ハンドルバーループを使用するより高度なWebテンプレートでは、これをtrueに設定しないでください。	true, false
defaultTemplate	ブーリアン	これがデフォルトのテンプレートであるかどうかを判断します。テンプレートを作成するときは、この値をfalseに設定する必要があります。	false
customTemplate	ブーリアン	これがカスタムテンプレートであるかどうかを判断します。テンプレートを作成するときは、この値をtrueに設定する必要があります。	true
templateElements 随意	JSONオブジェクトのJSON配列	テンプレートを定義するカスタムHTML、CSS、JavaScript、FreeMarkerコード。コードには、ProductType \| stringなどのテンプレートパラメータを含めることができます。テンプレートのパラメータは、テンプレートのレンダリング時にテンプレート変数の値 ( sneakersなど) に置き換えられます。	該当なし
archived	ブーリアン	フロー定義のアーカイブステータス。	true, false
revisions	JSONオブジェクトのJSON配列	フロー定義のリビジョンの配列。	該当なし
revision	整数	テンプレートリビジョンの連番。	2

オプションのtemplateElements配列オブジェクトを使用すると、HTML、CSS、JavaScript、およびFreeMarkerコードをテンプレートに含めることができます。 templateElementsのオブジェクトには、次の属性を使用します。

属性	種類	形容	使用例
id	string enum (小文字)	template属性に含めるコードの種類。例えば、テンプレートにCSSコードを含めるには、この値を "css"に設定し、template属性でカスタムCSSコードを指定します。	次のいずれかである必要があります。 "html" "css" "js" "freemarker"
template	糸	文字列化されたHTML、CSS、JavaScript、またはFreeMarkerコード。 FreeMarkerコードの場合は、少なくとも開始中括弧と終了中括弧 {}を含める必要があります。	HTMLの: "<div id=\"test\">My test div</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\">My test div</div>"
CSSの: "#test {text-transform: uppercase}"
JavaScriptの: "insertHTMLBefore(\"body\");"
フリーマーカー: "{}"

次に、オブジェクトのtemplateElements配列の例を示します。

"templateElements": [
  {
    "id": "html",
    "template": "<div id=\"test\">My test div</div>"
  },
  {
    "id": "css",
    "template": "#test {text-transform: uppercase}"
  },
  {
    "id": "js",
    "template": "insertHTMLBefore(\"body\");\n\nconst testDiv = document.querySelector(\"#test\");\ntestDiv.insertAdjacentHTML(\"afterbegin\", \"<p>Hello from JavaScript</p>\")"
  },
  {
    "id": "freemarker",
    "template": "{}"
  }
]

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