JSS Tracking API

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

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

JSS は、JSS 追跡モジュールを介して、ヘッドレス サービス トラッカーのクライアント側実装を提供します。JSS 追跡モジュールは、Tracking Service (TS) の軽量ラッパーであり、単純なプロミス ベースの API と TypeScript の型付けをサポートしており、簡単に使用することができるようになっています。

追跡モジュールは、@sitecore-jss/sitecore-jss NPM パッケージのサブモジュールです。次のようにインポートします。

RequestResponse
import { trackingApi } from '@sitecore-jss/sitecore-jss/tracking

Tracking API には TypeScript の型付けが付属しているため、VS Code などの TypeScript 対応エディターを使用する場合は、注釈付きのコード補完が利用できます。

注記

Tracking API は、サーバー側のレンダリング中に自動的に無効になり、クライアント側で再ハイドレートされたときの二重カウントを回避します。

イベント タイプ

JSS Tracking API を使用すると、イベント、目標、成果、キャンペーン、ページ/ルートビューを追跡できます。

JSS Tracking API は、次のイベント タイプ インターフェイスを提供します。

イベント タイプ

イベント プロパティ

GoalInstance

RequestResponse
{
    goalId: "<goal ID>"
}

OutcomeInstance

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

PageViewInstance

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

CampaignInstance

RequestResponse
{
    campaignId: "<campaign ID>"
}

EventInstance

RequestResponse
{
    eventId: "<event-value>"
}

ページ ビューの追跡

Tracking API は、任意のページ ビュー イベントの追跡をサポートします。これは、キャッシュされたルートやカスタム ルートなど、レイアウト サービス要求を伴わないルート変更を追跡する場合に便利です。

ページ ビューをトラッキングする場合は、次の点に注意してください。

  • レイアウト サービスへの要求では、既定でページ ビューが追跡されます。これを無効にするには、レイアウト サービス要求のクエリ文字列に tracking=false を追加します (JSS アプリの RestLayoutService クラスを使用して設定できます)。JSS Tracking API を使用してすべてのページの追跡を処理する場合は、レイアウト サービス追跡を無効にすることを推奨します。

  • ページ ビュー イベントを追跡するには、追跡対象の URL が任意であっても、Sitecore アイテム ID が必要です。アイテム ベース以外のルートを追跡する場合は、追跡する代理アイテムを作成する必要があります。

制限事項

何かフィードバックはありますか?

この記事を改善するための提案がある場合は、