関数

ストリームAPI
関数
Engage.event(タイプ, eventData[, extensionData])

Engage.event(タイプ, eventData, extensionData)

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

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

event() 関数は、次のいずれかを送信します。

標準イベント (ADD、CONFIRM、CHECKOUTなど)。
選択したカスタムデータを含むカスタムイベント。

パラメーター	種類	形容
type	糸	標準イベントの種類。この値をSitecore CDP予約イベント名 (VIEW、ADD、CONFIRMなど) のいずれかに設定すると、イベントは標準イベントになります。 Sitecore CDP予約済みイベント名: で始まる任意のイベント名 "SC_" "ADD" - 標準のADDイベント。 "ADD_CONSUMERS" - スタンダードADD_CONSUMERSイベント。 "ADD_CONTACTS" - スタンダードADD_CONTACTSイベント。 "CAMPAIGN_TRACKING" - 内部予約イベント。使用しないでください。 "CHECKOUT" - 標準のCHECKOUTイベント。 "CLEAR_CART" - スタンダードCLEAR_CARTイベント。 "CONFIRM" - 標準のCONFIRMイベント。 "FEEDBACK" - FEEDBACKイベント。 "IDENTITY" - 標準のIDENTITYイベント。 "INTERACTION" - 内部予約イベント。使用しないでください。 "ORDER_CHECKOUT" - スタンダードORDER_CHECKOUTイベント。 "PAYMENT" - 標準のPAYMENTイベント。 "SUBSCRIPTION" - 内部予約イベント。使用しないでください。 "SEARCH" - 標準のSEARCHイベント。 "TRACKING" - 内部予約イベント。使用しないでください。 "VIEW" - 標準のVIEWイベント。
eventData	オブジェクト	標準イベント・タイプに固有のすべてのイベント・データ ( ADDイベントなど)。
extensionData 随意	オブジェクト	最大50個のカスタム属性を選択できます。

パラメーター

種類

形容

type

糸

標準イベントの種類。この値をSitecore CDP予約イベント名 (VIEW、ADD、CONFIRMなど) のいずれかに設定すると、イベントは標準イベントになります。

Sitecore CDP予約済みイベント名:

で始まる任意のイベント名 "SC_"
"ADD" - 標準のADDイベント。
"ADD_CONSUMERS" - スタンダードADD_CONSUMERSイベント。
"ADD_CONTACTS" - スタンダードADD_CONTACTSイベント。
"CAMPAIGN_TRACKING" - 内部予約イベント。使用しないでください。
"CHECKOUT" - 標準のCHECKOUTイベント。
"CLEAR_CART" - スタンダードCLEAR_CARTイベント。
"CONFIRM" - 標準のCONFIRMイベント。
"FEEDBACK" - FEEDBACKイベント。
"IDENTITY" - 標準のIDENTITYイベント。
"INTERACTION" - 内部予約イベント。使用しないでください。
"ORDER_CHECKOUT" - スタンダードORDER_CHECKOUTイベント。
"PAYMENT" - 標準のPAYMENTイベント。
"SUBSCRIPTION" - 内部予約イベント。使用しないでください。
"SEARCH" - 標準のSEARCHイベント。
"TRACKING" - 内部予約イベント。使用しないでください。
"VIEW" - 標準のVIEWイベント。

eventData

オブジェクト

標準イベント・タイプに固有のすべてのイベント・データ ( ADDイベントなど)。

extensionData

随意

オブジェクト

最大50個のカスタム属性を選択できます。

パラメーター	種類	形容
type	糸	カスタムイベントの名前。この値を、"CUSTOM_EVENT_SEARCH" や "myretailsite:CLICKED_POPUP"など、Sitecore CDP予約イベント名とは異なる任意のカスタム値に設定すると、イベントはカスタムイベントになります。
eventData	オブジェクト	Tすべてのイベントオブジェクトに含める必要がある必須属性と、イベントオブジェクトに含めることができるオプションの属性。
extensionData 随意	オブジェクト	イベントに関するカスタムデータ。最大50個のカスタム属性を選択できます。

パラメーター

種類

形容

type

糸

カスタムイベントの名前。この値を、"CUSTOM_EVENT_SEARCH" や "myretailsite:CLICKED_POPUP"など、Sitecore CDP予約イベント名とは異なる任意のカスタム値に設定すると、イベントはカスタムイベントになります。

eventData

オブジェクト

Tすべてのイベントオブジェクトに含める必要がある必須属性と、イベントオブジェクトに含めることができるオプションの属性。

extensionData

随意

オブジェクト

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

最大50個のカスタム属性を選択できます。

Example 5. ORDER_CHECKOUTイベント

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: "2025-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: "2025-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);
};

Example 6. ADD event

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

Example 7. CONFIRM event

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

Example 8. CHECKOUT event

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

Example 9. PAYMENT event

以下は、event() 関数を使用してPAYMENTイベントを送信する方法の例です。 eventDataオブジェクトには、イベント・タイプ(この例ではPAYMENTイベント)に必要なすべての属性が含まれている必要があります。

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

Example 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);
};

Example 11. SEARCH event

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

Example 12. Custom event

次に、event() 関数を使用してmyretailsite:CLICKED_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:CLICKED_POPUP", eventData, extensionData);
};

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