1. JSSサービスとAPI

JSSトラッキングAPI

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

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

JSSは、JSS追跡モジュールを通じて 、Headless Services Trackerのクライアント側実装を提供します。JSS追跡モジュールは、追跡サービス (TS) の軽量ラッパーであり、シンプルなpromiseベースのAPIとTypeScriptタイピングのサポートを提供して使いやすくします。

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

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

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

メモ

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

イベントの種類

JSS Tracking APIを使用して、イベント、ゴール、結果、キャンペーン、ページ/ルートビューを追跡できます。

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

偶数タイプ

イベントのプロパティ

GoalInstance

 
{
    goalId: "<goal ID>"
}

OutcomeInstance

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

PageViewInstance

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

CampaignInstance

 
{
    campaignId: "<campaign ID>"
}

EventInstance

 
{
    eventId: "<event-value>"
}

ページビューの追跡

トラッキングAPIは、任意のページビューイベントの追跡をサポートしているため、キャッシュされたルートやカスタムルートなど、Layout Serviceリクエストを伴わないルート変更の追跡に役立ちます。

ページビューを追跡するときは、次の点に注意してください。

  • レイアウトサービスへのリクエストは、デフォルトでページビューを追跡します。これを無効にするには、Layout Serviceリクエストのクエリ文字列にtracking=falseを追加します (JSSアプリのRestLayoutService SAPクラスで設定可能)。Layout Serviceのトラッキングを無効にすることは、JSS Tracking APIを使用してすべてのページトラッキングを処理する場合に意味があります。

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

制限

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