カスタムイベントのトリガー

ページイベントの変換

Version:

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

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

このトピックでは、トラッカーからトリガーされた汎用イベントまたはページイベントを、xConnectに保存する前にカスタムイベントに変換する方法について説明します。

メモ

xConnectでは、汎用イベントとページイベントは区別されません。ページイベント定義アイテムは /sitecore/system/Settings/Analytics/Page Eventsにあり、一般的なイベント定義アイテムは /sitecore/system/Marketing Control Panel/Eventsにあります。

カスタム・イベント・モデルの作成

図のようにカスタム・イベント・モデルを作成します。この例では、組み込みの 'Print' ページイベントを使用します。カスタムイベントの作成の詳細については、xConnectのドキュメントを参照してください。

using Sitecore.XConnect;
using System;

namespace Documentation
{
    public class PrintEvent : Event
    {
        public static Guid PrintID = Guid.Parse("{CD52B756-21B4-4028-8BA5-E981B8A96F95}");

        public PrintEvent(DateTime timestamp) : base(PrintID, timestamp) { }

        public Orientation Orientation { get; set; }
    }

    public enum Orientation
    {
        Unknown = 0,
        Landscape = 1,
        Potrait = 2
    }
}

イベント変換プロセッサを作成する

ConvertPageEventDataToEventBaseを継承するパイプラインプロセッサを作成します。
示されているように、CreateEventとCanProcessPageEventDataを実装します。このハンドラーは、OrientationがCustomValuesディクショナリに格納されていることを前提としています。

using Sitecore.Analytics.Model;
using Sitecore.Analytics.XConnect.DataAccess.Pipelines.ConvertToXConnectEventPipeline;
using Sitecore.Framework.Conditions;
using Sitecore.XConnect;

namespace Documentation
{
    public class ConvertPrintEvent : ConvertPageEventDataToEventBase
    {
        protected override bool CanProcessPageEventData(PageEventData pageEventData)
        {
            Condition.Requires(pageEventData, nameof(pageEventData)).IsNotNull();

            if (pageEventData.PageEventDefinitionId == PrintEvent.PrintID)
            {
                return true;
            }

            return false;
        }

        // Create new print event from pageEventData
        // All base Event properties are mapped automatically
        protected override Event CreateEvent(PageEventData pageEventData)
        {
            PrintEvent printEvent = new PrintEvent(pageEventData.DateTime);

            var orientation = (Orientation)pageEventData.CustomValues["Orientation"]; // Store 'Orientation' as a constant somewhere and use when triggering event

            printEvent.Orientation = orientation;

            return printEvent;
        }
    }
}

イベント変換プロセッサの登録

MyBrand.CustomEvents.configという名前の新しい構成ファイルを作成し、次に示すようにハンドラーにパッチを適用します。

大事な

次に示すように、プロセッサは、最終的なイベントハンドラーの前にパッチを適用する必要があります。

<?xml version="1.0" encoding="utf-8" ?>
<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/">
    <sitecore>
        <pipelines>
        <convertToXConnectEvent>
            <processor patch:before="processor[@type='Sitecore.Analytics.XConnect.DataAccess.Pipelines.ConvertToXConnectEventPipeline.ConvertPageEventDataToEvent, Sitecore.Analytics.XConnect']" type="Documentation.ConvertPrintEvent, Documentation"/>
        </convertToXConnectEvent>
        </pipelines>
    </sitecore>
</configuration>

イベントをトリガーする

イベント変換パイプラインプロセッサが想定するカスタムデータを使用してイベントをトリガーします。

var ev = Sitecore.Analytics.Tracker.MarketingDefinitions.PageEvents[PrintEvent.PrintID];

if (ev != null)
{
    var pageData = new Sitecore.Analytics.Data.PageEventData(ev.Alias, ev.Id);

    pageData.CustomValues.Add("Orientation", Orientation.Potrait);

    Sitecore.Analytics.Tracker.Current.CurrentPage.Register(pageData);
}

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