Skip to main content
Sitecore Documentation
  • Learn
  • Downloads
  • Changelog
  • Roadmap
CDPCloud Portal
Sitecore CDP Developer Documentation
  • Sitecore CDPでの開発
  1. 機能
  1. Sitecore CDP Developer Documentation
  2. ストリームAPI

Engage.event(type, eventData, extensionData)

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

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

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

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

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

パラメータ

種類

概要

type

ストリング

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

、ADD、CONFIRM)に設定すると、そのイベントは標準イベントとなります。

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イベントなどです。

extensionData

任意

目的

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

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

パラメータ

種類

概要

type

ストリング

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

_POPUP"のように、そのイベントはカスタムイベントとなります。

eventData

目的

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

extensionData

任意

目的

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

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

例5。イベントORDER_CHECKOUT

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

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

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

`.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
`.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); };

2.0のデータモデルはこの機能をサポートしていません。

例6。ADDイベント

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

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イベントのイベントタイプに必要なすべての属性を含まなければなりません。

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イベントのイベントタイプに必要なすべての属性を含まなければなりません。

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のイベントタイプに必要なすべての属性を含まなければなりません。

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イベントに必要なすべての属性を含む必要があります。

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イベントのイベントタイプに必要なすべての属性を含まなければなりません。

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

_POPUPというカスタムイベントを送信する方法の例です。 eventDataは イベントデータオブジェクトに必要なすべての属性を含みます。 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

_POPUP", eventData, extensionData); };

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

© Copyright , Sitecore A/S or a Sitecore affiliated company.
All rights reserved.

Privacy policySitecore Trust CenterTerms of use
CDPCloud Portal