--- title: "Engage.event(type, eventData, extensionData)" slug: "engage-event" abstract: "Sitecore Engage SDK(Sitecore CDP Stream API)のクライアントサイドイベント()機能について説明します。" --- # Engage.event(type, eventData, extensionData) event()関数は以下のいずれかを送ります。 - 標準的なイベント、例えば[ADD](https://doc.sitecore.com/cdp/ja/developers/api/stream-api/sitecore-engage-sdk-reference/objects/event-data-object/add-event.html "ADD event")、[CONFIRM、](https://doc.sitecore.com/cdp/ja/developers/api/stream-api/sitecore-engage-sdk-reference/objects/event-data-object/confirm-event.html "CONFIRM event")[CHECKOUT](https://doc.sitecore.com/cdp/ja/developers/api/stream-api/sitecore-engage-sdk-reference/objects/event-data-object/checkout-event.html "CHECKOUT event")などです。 - カスタム [イベント](https://doc.sitecore.com/cdp/ja/developers/api/stream-api/sitecore-engage-sdk-reference/objects/event-data-object/custom-event.html "Custom event") で、あなたの選んだカスタムデータも用意しています。 サイドバー。標準イベントのパラメータ パラメータ 種類 概要 type ストリング 標準的なイベントの種類。この値をSitecore CDPの予約イベント名のいずれか(例:VIEW、ADD、CONFIRM)に設定すると、そのイベントは標準イベントとなります。 Sitecore CDPが予約したイベント名: - イベント名は "SC\_" - "ADD" - 標準 [的なADD](https://doc.sitecore.com/cdp/ja/developers/api/stream-api/sitecore-engage-sdk-reference/functions/add-event.html) イベント。 - "ADD\_CONSUMERS" - 標準 [ADD\_CONSUMERS](https://doc.sitecore.com/cdp/ja/developers/api/stream-api/sitecore-engage-sdk-reference/functions/add_consumers-event.html) イベント。 - "ADD\_CONTACTS" - 標準 [ADD\_CONTACTS](https://doc.sitecore.com/cdp/ja/developers/api/stream-api/sitecore-engage-sdk-reference/functions/add_contacts-event.html) イベント。 - "CAMPAIGN\_TRACKING" - 内部予約イベント。使用しないでください。 - "CHECKOUT" - 標準 [的なチェックアウト](https://doc.sitecore.com/cdp/ja/developers/api/stream-api/sitecore-engage-sdk-reference/functions/checkout-event.html) イベント。 - "CLEAR\_CART" - 標準 [CLEAR\_CART](https://doc.sitecore.com/cdp/ja/developers/api/stream-api/sitecore-engage-sdk-reference/functions/clear_cart-event.html) イベント。 - "CONFIRM" - 標準 [的なCONFIRM](https://doc.sitecore.com/cdp/ja/developers/api/stream-api/sitecore-engage-sdk-reference/functions/confirm-event.html) イベント。 - "FEEDBACK" - フィードバックイベント。 - "IDENTITY" - 標準 [的な同一イベント](https://doc.sitecore.com/cdp/ja/developers/api/stream-api/sitecore-engage-sdk-reference/functions/identity-event.html) 。 - "INTERACTION" - 内部予約イベント。使用しないでください。 - "ORDER\_CHECKOUT" - 標準 [ORDER\_CHECKOUT](https://doc.sitecore.com/cdp/ja/developers/api/stream-api/sitecore-engage-sdk-reference/functions/order_checkout-event.html) イベント。 - "PAYMENT" - 標準 [的な支払い](https://doc.sitecore.com/cdp/ja/developers/api/stream-api/sitecore-engage-sdk-reference/functions/payment-event.html) イベント。 - "SUBSCRIPTION" - 内部予約イベント。使用しないでください。 - "SEARCH" - 標準 [的なSEARCH](https://doc.sitecore.com/cdp/ja/developers/api/stream-api/sitecore-engage-sdk-reference/functions/search-event.html) イベント。 - "TRACKING" - 内部予約イベント。使用しないでください。 - "VIEW" - 標準 [的なVIEW](https://doc.sitecore.com/cdp/ja/developers/api/stream-api/sitecore-engage-sdk-reference/functions/view-event.html) イベント。 [eventData](https://doc.sitecore.com/cdp/ja/developers/api/stream-api/sitecore-engage-sdk-reference/functions/event-data-object.html) 目的 標準イベントタイプに固有のすべてのイベントデータ、例えば [ADDイベント](https://doc.sitecore.com/cdp/ja/developers/api/stream-api/sitecore-engage-sdk-reference/functions/add-event.html)などです。 [extensionData](https://doc.sitecore.com/cdp/ja/developers/api/stream-api/sitecore-engage-sdk-reference/functions/extension-data-object.html) 任意 目的 最大50のカスタム属性を選べます。 サイドバー。カスタムイベントのパラメータ パラメータ 種類 概要 type ストリング カスタムイベントの名前です。この値を予約された [イベント名](https://doc.sitecore.com/cdp/ja/developers/api/stream-api/sitecore-engage-sdk-reference/functions/engage-event.html#UUID-e9c6adca-cdb1-fc2e-0fb9-6bb373d91db8_para-idm19013416629508402)とは異なるカスタム値に設定すると、Sitecore CDP "CUSTOM\_EVENT\_SEARCH" や "myretailsite:CLICKED\_POPUP"のように、そのイベントはカスタムイベントとなります。 [eventData](https://doc.sitecore.com/cdp/ja/developers/api/stream-api/sitecore-engage-sdk-reference/functions/custom-event.html) 目的 すべてのイベントオブジェクトが含めるべき属性と、イベントオブジェクトが含められる[オプションの属性](https://doc.sitecore.com/cdp/ja/developers/api/stream-api/sitecore-engage-sdk-reference/functions/event-data-object.html#UUID-a7f441ce-7bee-9e1a-8a6c-7f995310e71b_UUID-88d3eb09-6119-a7c1-8d3f-f7a1fedf1447)[が必要でした](https://doc.sitecore.com/cdp/ja/developers/api/stream-api/sitecore-engage-sdk-reference/functions/event-data-object.html#UUID-a7f441ce-7bee-9e1a-8a6c-7f995310e71b_UUID-2cda931f-8a8a-520d-dd7c-fe7fa3c3d597)。 [extensionData](https://doc.sitecore.com/cdp/ja/developers/api/stream-api/sitecore-engage-sdk-reference/functions/extension-data-object.html) 任意 目的 イベントに関するカスタムデータ。 最大50のカスタム属性を選べます。 例5。イベントORDER\_CHECKOUT ::::タブ:::tab{title="2.1"} event()関数を使ってORDER\_CHECKOUTイベントを送信する方法の例を紹介します。eventDataオブジェクトは、この例で[ORDER\_CHECKOUTイベント](https://doc.sitecore.com/cdp/ja/developers/api/stream-api/sitecore-engage-sdk-reference/objects/event-data-object/order_checkout-event.html "ORDER_CHECKOUT event")のイベントタイプに必要なすべての属性を含まなければなりません。 import { engage } from "./engage.js"; // ... const handleOrderCheckoutEvent = async () => { const eventData = { channel: "WEB", currency: "EUR", pointOfSale: "myretailsite/ireland", language: "EN", page: "checkout page", order: { referenceId: "123456", orderedAt: "2026-08-23T16:\`17:16\`.000Z", status: "PURCHASED", currencyCode: "EUR", price: 200, paymentType: "Card", cardType: "Visa", extensions: { name: "ext", key: "default", refundable: true } , orderItems: { type: "MOBILE\_PHONE", referenceId: "REF-123", orderedAt: "2026-08-23T16:\`17:16\`.000Z", status: "PURCHASED", currencyCode: "EUR", price: 200, name: "Mobile phone of type x", productId: "MOBILE\_PHONE\_TYPE\_X", quantity: 1, extensions: { name: "ext", key: "default", phoneColor: "Gold", insurance: false } } } }; const extensionData = { customKey: "customValue" }; await engage.event("ORDER\_CHECKOUT", eventData, extensionData); }; ::::::tab{title="2.0"} 2.0のデータモデルはこの機能をサポートしていません。 ::::::: 例6。ADDイベント こちらはevent() 関数を使ってADDイベントを送信する方法の例です。 eventDataオブジェクトは、この例の[ADDイベント](https://doc.sitecore.com/cdp/ja/developers/api/stream-api/sitecore-engage-sdk-reference/objects/event-data-object/add-event.html "ADD event")に必要なすべての属性を含まなければなりません。 import { engage } from "./engage.js"; // ... const handleClickAddEvent = async () => { const eventData = { channel: "WEB", currency: "EUR", pointOfSale: "myretailsite/ireland", 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 engage.event("ADD", eventData, extensionData); }; 例7。CONFIRMイベント こちらはevent() 関数を使ってCONFIRMイベントを送信する方法の例です。 eventDataオブジェクトは、この例では[CONFIRMイベント](https://doc.sitecore.com/cdp/ja/developers/api/stream-api/sitecore-engage-sdk-reference/objects/event-data-object/confirm-event.html "CONFIRM event")のイベントタイプに必要なすべての属性を含まなければなりません。 import { engage } from "./engage.js"; // ... const handleClickConfirmEvent = async () => { const eventData = { channel: "WEB", currency: "EUR", pointOfSale: "myretailsite/ireland", language: "EN", page: "checkout", product: { item\_id: "SHOES\_8475GHT" } }; const extensionData = { customKey: "customValue" }; await engage.event("CONFIRM", eventData, extensionData); }; 例8。チェックアウトイベント こちらはevent() 関数を使ってCHECKOUTイベントを送信する方法の例です。 eventDataオブジェクトは、この例の[CHECKOUTイベント](https://doc.sitecore.com/cdp/ja/developers/api/stream-api/sitecore-engage-sdk-reference/objects/event-data-object/checkout-event.html "CHECKOUT event")のイベントタイプに必要なすべての属性を含まなければなりません。 import { engage } from "./engage.js"; // ... const handleClickCheckoutEvent = async () => { const eventData = { channel: "WEB", currency: "EUR", pointOfSale: "myretailsite/ireland", language: "EN", page: "home", reference\_id: "MA-490094", status: "PURCHASED" }; const extensionData = { customKey: "customValue" }; await engage.event("CHECKOUT", eventData, extensionData); }; 例9。支払いイベント こちらはevent() 関数を使ってPAYMENT eventを送信する方法の例です。 eventDataオブジェクトは、この例で[PAYMENT event](https://doc.sitecore.com/cdp/ja/developers/api/stream-api/sitecore-engage-sdk-reference/objects/event-data-object/payment-event.html "PAYMENT event")のイベントタイプに必要なすべての属性を含まなければなりません。 import { engage } from "./engage.js"; // ... const handleClickPaymentEvent = async () => { const eventData = { channel: "WEB", currency: "EUR", pointOfSale: "myretailsite/ireland", language: "EN", page: "home", paymentType: "voucher" }; const extensionData = { customKey: "customValue" }; await engage.event("PAYMENT", eventData, extensionData); }; 例10。CLEAR\_CARTイベント こちらはevent() 関数を使ってCLEAR\_CARTイベントを送信する方法の例です。 eventDataオブジェクトは、この例で[CLEAR\_CARTイベント](https://doc.sitecore.com/cdp/ja/developers/api/stream-api/sitecore-engage-sdk-reference/objects/event-data-object/clear_cart-event.html "CLEAR_CART event")に必要なすべての属性を含む必要があります。 import { engage } from "./engage.js"; // ... const handleClickClearCartEvent = async () => { const eventData = { channel: "WEB", currency: "EUR", pointOfSale: "myretailsite/ireland", language: "EN", page: "home" }; const extensionData = { customKey: "customValue" }; await engage.event("CLEAR\_CART", eventData, extensionData); }; 例11。サーチイベント こちらはevent() 関数を使ってSEARCHイベントを送信する方法の例です。 eventDataオブジェクトは、この例の[SEARCHイベント](https://doc.sitecore.com/cdp/ja/developers/api/stream-api/sitecore-engage-sdk-reference/objects/event-data-object/search-event.html "SEARCH event")のイベントタイプに必要なすべての属性を含まなければなりません。 import { engage } from "./engage.js"; // ... const handleSearchEvent = async () => { const eventData = { channel: "WEB", currency: "EUR", pointOfSale: "myretailsite/ireland", language: "EN", page: "search result page", "product\_name": "airSupport", "product\_type": "RUNNERS" }; const extensionData = { customKey: "customValue" }; await engage.event("SEARCH", eventData, extensionData); }; 例12。カスタムイベント こちらはevent() 関数を使ってmyretailsite:CLICKED\_POPUPというカスタムイベントを送信する方法の例です。 eventDataは [イベントデータオブジェクトに必要なすべての属性](https://doc.sitecore.com/cdp/ja/developers/api/stream-api/sitecore-engage-sdk-reference/functions/event-data-object.html#UUID-a7f441ce-7bee-9e1a-8a6c-7f995310e71b_UUID-2cda931f-8a8a-520d-dd7c-fe7fa3c3d597 "Required attributes")を含みます。 extensionDataはカスタムデータです。 import { engage } from "./engage.js"; // ... const handleClick = async () => { const eventData = { channel: "WEB", currency: "EUR", pointOfSale: "myretailsite/ireland", language: "EN", page: "home" }; const extensionData = { customKey: "customValue" }; await engage.event("myretailsite:CLICKED\_POPUP", eventData, extensionData); };