EngageServer.event(type, eventData, req, extensionData)

!注これは サーバーサイドトラッキングの実装に使われるサーバーサイド関数です。もしクライアント側トラッキングを実装したい場合は、クライアント側の機能を使いましょう。

event()関数は以下のいずれかを送ります。

• 標準的なイベント、例えばADD、CONFIRM、CHECKOUTなどです。
• カスタム イベント で、あなたの選んだカスタムデータも用意しています。

サイドバー。標準イベントのパラメータ

パラメータ

種類

概要

type

ストリング

標準的なイベントの種類。この値をSitecore CDPの予約イベント名のいずれか(例

Sitecore CDPが予約したイベント名:

• イベント名は "SC_"
• "ADD" - 標準 的なADD イベント。
• "ADD_CONSUMERS" - 標準 ADD_CONSUMERS イベント。
• "ADD_CONTACTS" - 標準 ADD_CONTACTS イベント。
• "CAMPAIGN_TRACKING" - 内部予約イベント。使用しないでください。
• "CHECKOUT" - 標準 的なチェックアウト イベント。
• "CLEAR_CART" - 標準 CLEAR_CART イベント。
• "CONFIRM" - 標準 的なCONFIRM イベント。
• "FEEDBACK" - フィードバックイベント。
• "IDENTITY" - 標準 的な同一イベント 。
• "INTERACTION" - 内部予約イベント。使用しないでください。
• "ORDER_CHECKOUT" - 標準 ORDER_CHECKOUT イベント。
• "PAYMENT" - 標準 的な支払い イベント。
• "SUBSCRIPTION" - 内部予約イベント。使用しないでください。
• "SEARCH" - 標準 的なSEARCH イベント。
• "TRACKING" - 内部予約イベント。使用しないでください。
• "VIEW" - 標準 的なVIEW イベント。

eventData

目的

標準イベントタイプに固有のすべてのイベントデータ、例えば ADDイベントなどです。

req

目的

HTTPリクエストです。

extensionData

任意

目的

イベントに関するカスタムデータ。

最大50のカスタム属性を選べます。

サイドバー。カスタムイベントのパラメータ

パラメータ

種類

概要

type

ストリング

カスタムイベントの名前です。この値を予約された イベント名とは異なるカスタム値に設定すると、Sitecore CDP "CUSTOM_EVENT_SEARCH" や "myretailsite

eventData

目的

すべてのイベントオブジェクトが含めるべき属性と、イベントオブジェクトが含められるオプションの属性が必要でした。

req

目的

HTTPリクエストです。

extensionData

任意

目的

最大50のカスタム属性を選べます。

例15。イベントORDER_CHECKOUT

::::タブ:::tab{title="2.1"}

event()関数を使ってORDER_CHECKOUTイベントを送信する方法の例を紹介します。eventDataオブジェクトは、この例でORDER_CHECKOUTイベントのイベントタイプに必要なすべての属性を含まなければなりません。

export async function middleware(req) { const res = NextResponse.next();

// Load Engage API const engageSettings = { clientKey: "<client_key_PLACEHOLDER>", targetURL: "<stream_api_target_endpoint_PLACEHOLDER>", pointOfSale: "<point_of_sale_PLACEHOLDER>" };

const engageServer = await initServer(engageSettings);

// Send ORDER_CHECKOUT event const eventData = { channel: "WEB", currency: "EUR", pointOfSale: "myretailsite/ireland", language: "EN", page: "checkout page", order: { referenceId: "123456", orderedAt: "2026-08-23T16:`17

}

} };

const extensionData = { customKey: "customValue" };

await engageServer.event("ORDER_CHECKOUT", eventData, req, extensionData); return res; };

例16。ADDイベント

こちらはevent() 関数を使ってADDイベントを送信する方法の例です。 eventDataオブジェクトは、この例のADDイベントに必要なすべての属性を含まなければなりません。

export async function middleware(req) { const res = NextResponse.next();

// Load Engage API const engageSettings = { clientKey: "<client_key_PLACEHOLDER>", targetURL: "<stream_api_target_endpoint_PLACEHOLDER>", pointOfSale: "<point_of_sale_PLACEHOLDER>" };

const engageServer = await initServer(engageSettings);

// Send ADD event const eventData = { channel: "WEB", currency: "EUR", language: "EN", page: "products", product: { name: "GHT 84 Lace Sneaker", type: "FOOTWEAR", item_id: "SHOES_8475GHT", productId: "example_product_id", referenceId: "MA-490094", orderedAt: new Date().toISOString(), quantity: 1, price: 7.99, currency: "EUR", originalPrice: 7.79, originalCurrencyCode: "USD" } };

const extensionData = { customKey: "customValue" };

await engageServer.event("ADD", eventData, req, extensionData); return res; };

例17。CONFIRMイベント

こちらはevent() 関数を使ってCONFIRMイベントを送信する方法の例です。 eventDataオブジェクトは、この例ではCONFIRMイベントのイベントタイプに必要なすべての属性を含まなければなりません。

export async function middleware(req) { const res = NextResponse.next();

// Load Engage API const engageSettings = { clientKey: "<client_key_PLACEHOLDER>", targetURL: "<stream_api_target_endpoint_PLACEHOLDER>", pointOfSale: "<point_of_sale_PLACEHOLDER>" };

const engageServer = await initServer(engageSettings);

// Send CONFIRM event const eventData = { channel: "WEB", currency: "EUR", language: "EN", page: "checkout", product: { item_id: "SHOES_8475GHT" }

};

const extensionData = { customKey: "customValue" };

await engageServer.event("CONFIRM", eventData, req, extensionData); return res; };

例18。チェックアウトイベント

こちらはevent() 関数を使ってCHECKOUTイベントを送信する方法の例です。 eventDataオブジェクトは、この例のCHECKOUTイベントのイベントタイプに必要なすべての属性を含まなければなりません。

export async function middleware(req) { const res = NextResponse.next();

// Load Engage API const engageSettings = { clientKey: "<client_key_PLACEHOLDER>", targetURL: "<stream_api_target_endpoint_PLACEHOLDER>", pointOfSale: "<point_of_sale_PLACEHOLDER>" };

const engageServer = await initServer(engageSettings);

// Send CHECKOUT event const eventData = { channel: "WEB", currency: "EUR", language: "EN", page: "home", reference_id: "MA-490094", status: "PURCHASED" };

const extensionData = { customKey: "customValue" };

await engageServer.event("CHECKOUT", eventData, req, extensionData); return res; };

例19。支払いイベント

こちらはevent() 関数を使ってPAYMENT eventを送信する方法の例です。 eventDataオブジェクトは、この例でPAYMENT eventのイベントタイプに必要なすべての属性を含まなければなりません。

export async function middleware(req) { const res = NextResponse.next();

// Load Engage API const engageSettings = { clientKey: "<client_key_PLACEHOLDER>", targetURL: "<stream_api_target_endpoint_PLACEHOLDER>", pointOfSale: "<point_of_sale_PLACEHOLDER>" };

const engageServer = await initServer(engageSettings);

// Send PAYMENT event const eventData = { channel: "WEB", currency: "EUR", language: "EN", page: "home", paymentType: "voucher" };

const extensionData = { customKey: "customValue" };

await engageServer.event("PAYMENT", eventData, req, extensionData); return res; };

例20。CLEAR_CARTイベント

こちらはevent() 関数を使ってCLEAR_CARTイベントを送信する方法の例です。 eventDataオブジェクトは、この例でCLEAR_CARTイベントに必要なすべての属性を含む必要があります。

export async function middleware(req) { const res = NextResponse.next();

// Load Engage API const engageSettings = { clientKey: "<client_key_PLACEHOLDER>", targetURL: "<stream_api_target_endpoint_PLACEHOLDER>", pointOfSale: "<point_of_sale_PLACEHOLDER>" };

const engageServer = await initServer(engageSettings);

// Send CLEAR_CART event const eventData = { channel: "WEB", currency: "EUR", language: "EN", page: "home" };

const extensionData = { customKey: "customValue" };

await engageServer.event("CLEAR_CART", eventData, req, extensionData); return res; };

例21。サーチイベント

こちらはevent() 関数を使ってSEARCHイベントを送信する方法の例です。 eventDataオブジェクトは、この例のSEARCHイベントのイベントタイプに必要なすべての属性を含まなければなりません。

export async function middleware(req) { const res = NextResponse.next();

// Load Engage API const engageSettings = { clientKey: "<client_key_PLACEHOLDER>", targetURL: "<stream_api_target_endpoint_PLACEHOLDER>", pointOfSale: "<point_of_sale_PLACEHOLDER>" };

const engageServer = await initServer(engageSettings);

// Send SEARCH event const eventData = { channel: "WEB", currency: "EUR", language: "EN", page: "search result page", "product_name": "airSupport", "product_type": "RUNNERS" };

const extensionData = { customKey: "customValue" };

await engageServer.event("SEARCH", eventData, req, extensionData); return res; };

例22。カスタムイベント

こちらはevent() 関数を使ってmyretailsite

export async function middleware(req) { const res = NextResponse.next();

// Load Engage API const engageSettings = { clientKey: "<client_key_PLACEHOLDER>", targetURL: "<stream_api_target_endpoint_PLACEHOLDER>", pointOfSale: "<point_of_sale_PLACEHOLDER>" };

const engageServer = await initServer(engageSettings);

// Send custom event const eventData = { channel: "WEB", currency: "EUR", language: "EN", page: "search result page" };

const extensionData = { customKey: "customValue" };

await engageServer.event("myretailsite