---
title: "ファネルイベント"
slug: "funnel-events"
abstract: "エンティティとのやり取りを追跡するために使われるエンティティのペイロードを記述します。"
---
# ファネルイベント

Sitecore Search JS SDK for Reactは、訪問者が商品をカートやウィッシュリストに追加したり、注文を完了したりすると発信される以下のファネルイベントを提供します。

汎用[trackAddEvent](https://doc.sitecore.com/search/ja/developers/search-js-sdk-for-react/js-sdk-reference/events/funnel-events.html#UUID-88685583-0537-261a-44ce-a7b4ecae5c57_N1691595838083 "trackAddEvent")およびtrackRemoveEventを使って、あらゆる種類のコンバージョンファネルへのエンティティの追加・削除を追跡できます。両イベントともEntityPayloadオブジェクトの配列を受け取ります。

> !注特に記載がない限り、すべての属性は任意です。

## trackAddEvent

トラックはコンバージョンファネルイベントに追加されます。訪問者がコンバージョンファネルにエンティティを追加すると、トラックが送信されます。

> !注このイベントは詳細に送信してください。SDKはこの動作がいつ起きているかを推測できません。

名称

種類

概要

価値

entity

ストリング

必須。  
  
エンティティの種類。

content

name

ストリング

必須。  
  
変換アクションの種類を説明します。

bookmark  
  
review  
  
compare  
  
cart  
  
wishlist  
  
like  
  
upvote  
  
download  
  
order\_confirm

payload

AddEventPayload

必須。  
  
ペイロードはイベントと共に発送されました。

\-

### AddEventPayload

ペイロードはtrackAddEventと共に発送されました。

名称

種類

概要

items

array< EntityPayload >

必須。  
  
エンティティのペイロード配列

actionSubtype

ストリング

*転換*

review

ReviewEventModel

customAttributes

糸Record<、any>

このオブジェクトにはカスタム属性の名前、値のペアが含まれています。

#### EntityPayload

このペイロードはエンティティを記述します。エンティティとのやり取りを追跡したい場合、すべてのイベントでこのペイロードタイプを使いましょう。

名称

種類

概要

*ID*

番号

必須。  
  
エンティティのID。

*entityType*

ストリング

必須。  
  
エンティティの名前。

*URL*

ストリング

エンティティのページのURL。通常はエンティティの詳細ページです。  
  
提供されていない場合、SDKはページのURLを使用します。

*sourceId*

ストリング

コネクターによって割り当てられたエンティティの送信元のID。

#### ReviewEventModel

このペイロードはレビューを記述しています。

名称

種類

概要

id

ストリング

必須。

rating

番号

表示範囲内の評価の数値。

comment

ストリング

コメント欄に訪問者が入力したテキスト(表示されている場合)です。

## trackRemoveEvent

トラックはコンバージョンファネルから除去イベントを行います。これはビジターがコンバージョンファネルからエンティティを削除する際に送信されます。

> !注このイベントは詳細に送信してください。SDKはこの動作がいつ起きているかを推測できません。

名称

種類

概要

価値

entity

ストリング

必須。  
  
エンティティの種類。

content

name

ストリング

必須。  
  
エンティティが削除され、イベントによって追跡されるコンバージョンファネルの名前。

bookmark,  
  
review  
  
compare  
  
wishlist  
  
like  
  
cart

payload

RemoveEventPayload

必須。  
  
ペイロードはイベントと共に発送されました。

\-

### RemoveEventPayload

ペイロードはtrackRemoveEventと共に発送されました。

名称

種類

概要

items

array< EntityPayload >

必須。  
  
エンティティのペイロード配列

actionSubtype

ストリング

*転換*

review

ReviewEventModel

#### ReviewEventModel

このペイロードはレビューを記述しています。

名称

種類

概要

id

ストリング

必須。

rating

番号

表示範囲内の評価の数値。

comment

ストリング

コメント欄に訪問者が入力したテキスト(表示されている場合)です。

#### EntityPayload

このペイロードはエンティティを記述します。エンティティとのやり取りを追跡したい場合、すべてのイベントでこのペイロードタイプを使いましょう。

名称

種類

概要

*ID*

番号

必須。  
  
エンティティのID。

*entityType*

ストリング

必須。  
  
エンティティの名前。

*URL*

ストリング

エンティティのページのURL。通常はエンティティの詳細ページです。  
  
提供されていない場合、SDKはページのURLを使用します。

*sourceId*

ストリング

コネクターによって割り当てられたエンティティの送信元のID。