Settingsオブジェクト

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

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

settingsオブジェクトを使用して、Engage SDKを初期化します。設定オブジェクトには、Sitecore CDPインスタンスに関する詳細を含めます。

このEngage SDKは、クライアントおよびサーバーからのCookieの設定をサポートしています。

クライアントからCookieを設定するには、forceServerCookieMode属性をfalseに設定し、設定オブジェクトをEngage.init() 関数に渡す必要があります。
サーバーからCookieを設定するには、forceServerCookieMode属性をtrueに設定し、settingsオブジェクトをクライアント側のEngage.init() 関数とサーバー側のEngage.initServer() 関数に渡す必要があります。

設定オブジェクトには、次の属性が含まれます。

属性	種類	形容	例	必須/オプション
clientKey	糸	クライアントキー。	"ZpHxO9WvLOfQRVPlvo0BqB8YjGYuFfNe"	必須
targetURL	糸	Stream APIターゲットエンドポイント。この値は、Sitecore CDPサーバーの場所によって異なります。	次のいずれかである必要があります。 "https://api-engage-ap.sitecorecloud.io" "https://api-engage-eu.sitecorecloud.io" "https://api-engage-jpe.sitecorecloud.io" "https://api-engage-us.sitecorecloud.io"	必須
includeUTMParameters	ブーリアン	現在のWebページのURLからすべてのUTMパラメータをイベントオブジェクトに追加するかどうかを指定します。デフォルトはtrueです。 trueの場合、UTMパラメーターがVIEWイベントオブジェクトに追加されます。	true又は false	随意
cookieDomain	糸	お客様のCookieドメイン。デフォルトはブラウザが設定するものです。	".myretailsite.com" ".beta.myretailsite.com" "localhost"	随意
cookieExpiryDays	整数	Cookieの有効期限が切れるまでの日数。この値を指定しない場合、Cookieはブラウザーが設定したMax-Ageに従って期限切れになります。	たとえば、Cookieの有効期限が1日で切れるように、値を1に設定します。	随意
cookiePath	糸	Cookieを送信するために、要求されたURLに存在する必要があるURLパス。	N/A	随意
forceServerCookieMode	ブーリアン	Cookieをクライアントから設定するか、サーバーから設定するかを指定します。アプリのサーバー側にアクセスできる場合は、クライアントではなくサーバーからCookieを設定することを選択できます。サーバーからCookieを設定するには、サーバー側とクライアント側の両方で値をtrueに設定します。デフォルトはfalseです。	true又は false	随意
webPersonalization	booleanまたはobject	クライアント側で、Sitecore Personalizeを使用してパーソナライゼーションを実行するかどうかを指定します。この属性は、サーバー側では使用できません。この属性をクライアント側で指定しない場合、または指定して値をfalseに設定した場合、パーソナライゼーションは使用できません。値をtrueまたはオブジェクトに設定する場合は、pointOfSaleも指定する必要があります。値をtrueに設定すると、Webパーソナライゼーションスクリプトはasyncでアプリに読み込まれますが、deferは読み込まれません。スクリプトの読み込みをカスタマイズするには、値をオブジェクトに設定します。オブジェクト内: asyncとdeferをそれぞれasyncScriptLoadingとdeferScriptLoadingを使用してカスタマイズします。これらの属性には、ブール値を設定します。 baseURLOverride属性を使用して、カスタムURLからWebパーソナライゼーションスクリプトを読み込みます。 Stream APIのターゲットエンドポイントがJP Region内にある場合は、baseURLOverrideを次のように設定します。 "https://d2ez8k04aaol9g.cloudfront.net" または、Webパーソナライゼーションスクリプトを読み込むためのカスタムURLをSitecoreから受け取った場合は、baseURLOverrideをそのURLに設定します。デフォルトはfalseです。	Webパーソナライゼーションを有効にします。 true asyncせずにスクリプトをロードします。 { asyncScriptLoading: false } スクリプトをasyncなしでロードしますが、deferでロードします。 { asyncScriptLoading: false, deferScriptLoading: true } Stream APIのターゲットエンドポイントがJP Regionにある場合: { baseURLOverride: "https://d2ez8k04aaol9g.cloudfront.net" } カスタムURLを使用してスクリプトを読み込みます。 { baseURLOverride: "https://..." }	クライアント側では省略可能です。サーバー側では使用できません。
pointOfSale	糸	ブランドとのインタラクションが行われるPOSの名前。クライアント側でwebPersonalization属性を指定し、値をtrueまたはオブジェクトに設定した場合は、pointOfSaleを指定する必要があります。この値は、Sitecore CDPのインスタンスに存在する販売時点情報の名前に設定する必要があります。設定オブジェクトでpointOfSaleを指定しない場合は、すべてのイベントデータオブジェクトで指定する必要があります。	"myretailsite/ireland"	webPersonalization属性を指定した場合は必須です。それ以外の場合は省略可能です。

Engage SDKを初期化し、クライアントからCookieを設定し、Webパーソナライゼーションを使用します。

import { init } from "@sitecore/engage";

const engageSettings = {
  clientKey: "<client_key_PLACEHOLDER>",
  targetURL: "<stream_api_target_endpoint_PLACEHOLDER>",
  pointOfSale: "<point_of_sale_PLACEHOLDER>",
  cookieDomain: "<cookie_domain_PLACEHOLDER>",
  cookieExpiryDays: 365,
  forceServerCookieMode: false,
  webPersonalization: false /* boolean or object. Default: false */
};

const loadEngage = async () => {
  // Load Engage API
  const engage = await init(engageSettings);
};

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