1. サービスとAPI

追跡サービス

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

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

Headless Servicesが提供するTracking Serviceは、クライアント側の動作に基づいてSitecore分析イベントをxDBにプッシュできる分析追跡REST APIです。デフォルトでは、イベント、ゴール、結果、キャンペーン、ページ/ルートビューのトラッキングをサポートしており、高度なトラッキングニーズに合わせて拡張できます。

セットアップ

トラッキング サービスはインストールされますが、Sitecoreヘッドレス サービスのインストール時にdisabled by defaultされます。

Trackerを有効にするには、次のように、設定パッチファイルでSitecore.JSS.TrackerServiceEnabled設定をtrueに設定します。

<configuration>
  <sitecore>
    <settings>
      <setting name="Sitecore.JSS.TrackerServiceEnabled" value="true" />
    </settings>
  </sitecore>
</configuration>

トラッカーは、他のサービスと同様にSSC APIキー を利用します。APIキーは、トラッカーのCORSサポートを有効にするのに役立ちます。アプリごとに1つのAPIキーを使用することをお勧めしますが、すべてのサービスに同じAPIキーを使用することもできます。

イベントの追跡

エンドポイント /sitecore/api/jss/track/event?sc_apikey=keyを使用してイベントを追跡できます。

エンドポイントは、JSONペイロードを含むPOSTリクエストを受け入れます。

次の表は、追跡できるイベントのタイプと、トラッキングサービスエンドポイントに送信する必要があるペイロードを示しています。

イベントの種類

ペイロード

ゴール

{
    "goalId": "<goal ID>"
}

結果

{
    "outcomeId": "<goal ID>", 
    "currencyCode": "<currency code>",
    "monetaryValue": "<monetary value>"
}

ページイベント

{
    "pageId": "<page ID>",
    "url": "<page URL>"
}

キャンペーン

{
    "campaignId": "<campaign ID>"
}

出来事

{
    "eventId": "<event-value>"
}
先端

JSSアプリケーションを開発する場合は、JSSトラッキングAPIを使用できます。

連絡先および追跡データのインデックス作成と表示

トラッキングコードによってプッシュされたデータは、エクスペリエンスプロファイルで確認できます。

デフォルトでは、Sitecoreは匿名のコンタクト データをインデックス化しないため、識別されていないユーザーのデータはエクスペリエンス プロファイルに含まれません。テスト結果をより効率的に表示するために、匿名連絡先のインデックス作成を有効にすることができます。

大事な

本番環境での匿名連絡先のインデックス作成はお勧めしません。

Tracker Serviceは、すぐに 使用できる連絡先の識別 をサポートしていませんが、拡張できます。

Sitecoreは、ユーザー セッションの終了前に追跡データをエクスペリエンス プロファイルに保存またはインデックス化しません。ユーザー・セッションを終了するには、エンドポイント /sitecore/api/jss/track/flushを呼び出します。

トラッカーの拡張

トラッカーはトラッキングデータの導管であり、必要に応じて拡張します。App_Config\Sitecore\JavaScriptServices\Sitecore.JavaScriptServices.Tracker.configで定義されているtrackEventパイプラインは、受信追跡要求の処理を担当します。

構成パッチを使用して、新しいパイプライン プロセッサまたは交換されたパイプライン プロセッサを含めることができます。

プロセッサはSitecore.JavaScriptServices.Tracker.Pipelines.TrackEvent<T>から派生させる必要があります。ここで、Tは受信JSONを逆シリアル化するためのC# 型です。

パイプライン プロセッサ メソッドではTrackEvent次のことを行う必要があります。

  • 着信要求を処理できない場合は、戻ります。他のアクションを行わずにパイプライン プロセッサに戻ると、パイプラインが再開されます (次のプロセッサに進みます)。

  • 受信要求を処理できる場合は、args.HasBeenTracked() を呼び出し、パイプラインを中止します。パイプラインを中止すると、一部のアクションが既に実行されている可能性があるため、それ以上の処理が停止します。

  • 要求の処理canがエラーが発生した場合は、args.ReportError() を呼び出して戻ります。

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