JSSトラッキングAPI
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
Headless Services Trackerのクライアント側実装は@sitecore-jss/sitecore-jss-trackingNPMパッケージです。このパッケージはTracking Service(TS)を軽量に包み込むラッパーで、シンプルな約束ベースのAPIとTypeScript型付けのサポートを提供し、使いやすくしています。
Tracking APIにはTypeScript型付けが付属しているため、VS CodeのようなTypeScript対応エディタを使っていれば、注釈付きコード補完が可能です。
!注Tracking APIはサーバー側レンダリング中に自動的に無効化し、クライアント側で再処理された際の重複カウントを回避します。
イベントの種類
JSS Tracking APIを使ってイベント、目標、成果、キャンペーン、ページ/ルートビューを追跡できます。
JSSトラッキングAPIは以下のイベントタイプのインターフェースを提供します:
- 偶数タイプ
- GoalInstance:
{
goalId: "
- OutcomeInstance:
{
outcomeId: "
- PageViewInstance:
{
pageId: "
- CampaignInstance:
{
campaignId: "
- EventInstance:
{
eventId: "
ページビューの追跡
トラッキングAPIは任意のページビューイベントの追跡をサポートしており、キャッシュルートやカスタムルートなど、レイアウトサービスリクエストを伴わないルート変更の追跡に役立ちます。
ページビューを追跡する際には、以下の点を念頭に置いてください:
- レイアウトサービスへのリクエストはデフォルトでページビューを追跡します。レイアウトサービスのリクエストクエリ文字列に tracking=false を追加することで無効にできます(JSSアプリの RestLayoutService クラスで設定可能)。JSSのトラッキングAPIですべてのページトラッキングを処理したい場合は、レイアウトサービスのトラッキングを無効にするのが理にかなっているかもしれません。
- ページビューイベントは、追跡するURLが任意であっても、追跡するためにSitecoreのアイテムIDが必要です。アイテムベースでないルートを追跡する場合は、追跡対象の代理アイテムを作成する必要があります。
制限
JSSトラッキングAPIには以下の制限があります:
- JSSアプリケーションは JSSが提供するRESTレイアウトAPIを使用する必要があります。
- 追跡データは直接Sitecoreサービスに提出されるため、 切断モードでJSS追跡APIを使うことはできません。
- グローバルクッキーやセッションクッキーが生成されなければ、JSSのトラッキングAPIは動作しません。
!重要Sitecore 10.0.1以降、SitecoreはすべてのクッキーにデフォルトでSecureフラグを設定します。これは、接続モードやヘッドレスモードでJSSのローカル開発に影響を与えることがあります。なぜなら、アプリケーションがHTTPSで動作していない場合、プロキシされたSitecoreクッキー(分析クッキーを含む)はブラウザによって拒否されるため、訪問が追跡されず、コンテンツがパーソナライズされない場合があります。これを回避するために、以下のいずれかの方法があります:
ノードサーバーを改変したり、ローカルリバースプロキシを使ったり、ngrokのようなサービスを利用したりして、ローカル環境でHTTPSを有効にしてください。開発用にコンテナでSitecoreを実行する場合は、そのdocker-compose環境で提供されているTraefikリバースプロキシを利用できます。
Sitecore Web.configを次のように変換します:
httpCookies構成では、requireSSLをfalseに、sameSiteをUnspecifiedに設定します。
sessionState構成では、cookieSameSiteをUnspecifiedに設定します。
本番環境での回避策は推奨しません。