設定オブジェクト
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
settingsオブジェクトを使ってEngage SDKを初期化してください。設定オブジェクトには、Sitecore CDPインスタンスの詳細を入れます。
Engage SDKはクライアントとサーバーの両方からクッキーを設定することをサポートしています。
- クライアントからクッキーを設定するには、 forceServerCookieMode 属性を false に設定し、settingsオブジェクトを Engage.init() 関数に渡す必要があります。
- サーバーからクッキーを設定するには、 forceServerCookieMode 属性を true に設定し、設定オブジェクトをクライアント側の Engage.init() 関数とサーバー側の Engage.initServer() 関数に渡す必要があります。
settingsオブジェクトには以下の属性が含まれています:
属性
種類
概要
例
必須/任意
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
ブール値
現在のウェブページのURLからイベントオブジェクトにすべての UTMパラメータ を追加するかどうかを指定します。
デフォルトは trueです。
trueの場合、UTMパラメータがVIEWイベントオブジェクトに追加されます。
true または false
オプション
cookieDomain
ストリング
あなたの クッキードメイン。
デフォルトはブラウザが設定したものです。
- ".myretailsite.com"
- ".beta.myretailsite.com"
- "localhost"
オプション
cookieExpiryDays
整数
クッキーの有効期限までの日数です。
この値を指定しなければ、ブラウザが設定したクッキーの期限 Max-Age が期限切れになります。
例えば、クッキーの有効期限が1日で切れるように値を 1 に設定します。
オプション
cookiePath
ストリング
クッキーを送信するために要求されたURL内に存在しなければならないURLパス。
N/A
オプション
forceServerCookieMode
ブール値
クライアントからクッキーを設定するかサーバーから設定するかを指定します。
サーバー側にアクセスできる場合は、クライアントではなくサーバーからクッキーを設定することができます。
サーバー側からクッキーを設定するには、サーバー側とクライアント側の両方で値を true に設定してください。
デフォルトは falseです。
true または false
オプション
webPersonalization
ブール値またはオブジェクト
クライアント側では、Sitecore Personalizeでパーソナライズを実行するかどうかを指定してください。この属性はサーバー側では利用できません。
クライアント側でこの属性を指定しなかったり、指定して値を falseに設定した場合、パーソナライズは利用できません。
値を true または オブジェクトに設定した場合、pointOfSaleも指定しなければなりません。
値を trueに設定すると、ウェブパーソナライゼーションスクリプトがアプリに async は含まれて読み込みますが、 deferは含まれません。
スクリプトの読み込みは、値をオブジェクトに設定することでカスタマイズできます。対象物の中:
-
asyncとdeferをそれぞれasyncScriptLoadingとdeferScriptLoadingでカスタマイズできます。これらの属性にはブール値を設定します。
-
baseURLOverride属性を使ってカスタムURLからウェブパーソナライゼーションスクリプトを読み込みます。
ストリーム APIターゲットエンドポイント が JPリージョンにある場合は、 baseURLOverride を以下に設定してください:
"https://d2ez8k04aaol9g.cloudfront.net"
あるいは、SitecoreからカスタムURLを受け取ってウェブパーソナライゼーションスクリプトを読み込む場合は、 baseURLOverride そのURLに設定してください。
デフォルトは falseです。
- ウェブのパーソナライズを有効にする:
true - asyncせずにスクリプトを読み込む:
{ asyncScriptLoading: false } - asyncなしでスクリプトを読み込みdefer:
{ asyncScriptLoading: false, deferScriptLoading: true } - もしあなたのStream APIターゲットエンドポイントが JP地域にある場合:
{ baseURLOverride: "https://d2ez8k04aaol9g.cloudfront.net" } - カスタムURLを使ってスクリプトを読み込みます:
{ baseURLOverride: "https://..." }
クライアント側では任意です。
サーバー側では利用できません。
pointOfSale
ストリング
クライアント側で webPersonalization 属性を指定し、値を true またはオブジェクトに設定した場合、 pointOfSaleを指定します。
この値は、あなたのSitecore CDPインスタンス内に存在する販売時点名に設定する必要があります。
設定オブジェクトで pointOfSale を指定していない場合は、すべての イベントデータオブジェクトで指定しなければなりません。
"myretailsite/ireland"
webPersonalization属性を指定した場合は必須です。それ以外は任意です。
Engage SDKを初期化し、クライアントからクッキーを設定し、ウェブパーソナライゼーションを活用してください:
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); };