カスタムイベントの作成
独自のストアフロントイベントを作成して業界に固有のデータを収集することで、 イベントプラットフォームを拡張できます。 カスタムイベントを作成して設定すると、そのイベントは Adobe Commerce イベントコレクターに送信されます。
カスタムイベントの処理
カスタムイベントは、Adobe Experience Platformでのみサポートされています。 カスタムデータは、Adobe Commerce ダッシュボードおよび指標トラッカーに転送されません。
custom イベントの場合、コレクターは以下を行います。
identityMapをプライマリ ID としてECIDを追加します- イベントで設定されているセカンダリ ID
emailifidentityMapとして にpersonalEmail.addressを含めます - Edgeに転送する前に、
xdmオブジェクト内でイベント全体をラップします
例：
Adobe Commerce イベント SDKを通じて公開されたカスタムイベント：
mse.publish.custom({
commerce: {
saveForLaters: {
value: 1,
},
},
});
Experience Platform Edgeで：
{
xdm: {
identityMap: {
ECID: [
{
id: 'ecid1234',
primary: true
}
],
email: [
{
id: "runs@safari.ke",
primary: false
}
]
},
commerce: {
saveForLaters: {
value: 1
}
}
}
}
イベントの上書きの処理（カスタム属性）
customContext を含むイベントセットの場合、コレクターが custom context のフィールドからイベントペイロードのフィールドを上書きまたは拡張します。 オーバーライドのユースケースは、開発者が、既にサポートされているイベントでページの他の部分が設定したコンテキストを再利用および拡張する場合です。
イベントの上書きは、Experience Platformへの転送時にのみ適用されます。 これらは、Adobe CommerceおよびSensei analytics イベントには適用されません。 Adobe Commerce イベントコレクター README には、追加情報が記載されています。
productListItems を拡張する場合は、SKU を使用して商品を照合します。 この要件は、product-page-view のイベントには適用されません。使用状況
const mse = window.magentoStorefrontEvents;
mse.publish.productPageView(customCtx);
例 1
次の例では、イベントを公開する際にカスタムコンテキストを追加します。
magentoStorefrontEvents.publish.productPageView({
productListItems: [
{
productCategories: [
{
categoryID: "cat_15",
categoryName: "summer pants",
categoryPath: "pants/mens/summer",
},
],
},
],
});
例 2
次の使用例は、イベントを発行する前にカスタム コンテキストを追加します。
const mse = window.magentoStorefrontEvents;
mse.context.setCustom({
productListItems: [
{
productCategories: [
{
categoryID: "cat_15",
categoryName: "summer pants",
categoryPath: "pants/mens/summer",
},
],
},
],
});
mse.publish.productPageView();
例 3
次の使用例は、発行元のカスタム コンテキストを設定し、Adobe Client Data Layer で既に設定されているカスタム コンテキストを上書きします。
この例では、pageView イベントの フィールドに カスタムページ名 2web.webPageDetails.name が表示されます。
const mse = window.magentoStorefrontEvents;
mse.context.setCustom({
web: {
webPageDetails: {
name: 'Custom Page Name 1'
},
},
});
mse.publish.pageView({
web: {
webPageDetails: {
name: 'Custom Page Name 2'
},
},
});
例 4
この例では、複数の製品を持つ productListItems イベントにカスタムコンテキストを追加します。
const mse = window.magentoStorefrontEvents;
mse.context.setCustom({
productListItems: [
{
SKU: "24-WB01", //Match SKU to override correct product in event payload
productCategory: "Hand Bag", //Custom attribute added to event payload
name: "Strive Handbag (CustomName)" //Override existing attribute with custom value in event payload
},
{
SKU: "24-MB04",
productCategory: "Backpack Bag",
name: "Strive Backpack (CustomName)"
},
],
});
mse.publish.shoppingCartView();
Luma ベースのストア：
Luma ベースのストアは、公開イベントをネイティブに実装するので、customContext を拡張してカスタムデータを設定できます。
例：
mse.context.setCustom({
web: {
webPageDetails: {
name: 'Custom Page Name'
},
},
});