---
title: "プレビュー検索ウィジェットイベント"
slug: "preview-search-widget-events"
abstract: "エンティティとのやり取りを追跡するために使われるエンティティのペイロードを記述します。"
---
# プレビュー検索ウィジェットイベント

Sitecore Search JS SDK for Reactは、preview searchウィジェットとのユーザーのやり取りを追跡するイベントをトリガーする以下の機能を提供しています。

## trackPreviewSearchClickEvent

この関数はpreview searchコンテナ内のエンティティへのクリックを追跡するwidget click(creating-a-widget-click-event.md "Creating a widget click event") イベントをトリガーします。

名称

種類

概要

*RFKID*

ストリング

必須。  
  
追跡中のウィジェットを特定します。

*エンティティ*

ストリング

必須。  
  
エンティティの種類。  
  
例: content

*ペイロード*

[PreviewSearchPayload](https://doc.sitecore.com/search/ja/developers/search-developer-guide/integrating-using-search-js-data-package/tracking-user-interactions/preview-search-widget-events.html#UUID-1f566ee3-97bc-ebe8-f535-019e0d084927_section-idm1743380786825032)

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

### PreviewSearchPayload

trackPreviewSearchClickEvent関数によってトリガーされるウィジェットクリックイベントでペイロードがディスパッチされます。

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

名称

種類

概要

*アイテム*

[EntityPayload](https://doc.sitecore.com/search/ja/developers/search-developer-guide/integrating-using-search-js-data-package/tracking-user-interactions/preview-search-widget-events.html#UUID-1f566ee3-97bc-ebe8-f535-019e0d084927_UUID-bbb261d8-0615-9e58-fb52-2e075c690e59) 配列

必須。  
  
エンティティをクリックしました。

*インデックス*

番号

必須。  
  
クリックされたエンティティのインデックスです。

*キーワード*

ストリング

フレーズ検索済み。

ストリング

検索を絞り込むクエリ検索式。  
  
例: filetype:pdf。

*modifiedKeyword*

ストリング

結果に反映されたキーワードを修正しました。

*numResults*

番号

取得できる最大結果数。

*totalResults*

番号

検索結果の総数。

*pageSize*

番号

1ページに表示される結果の最大数。

*pageNumber*

番号

結果を掲載した後のウィジェットをホストするページの番号は pageSizeでページ付けされています。

*redirectUrl*

ストリング

検索がリダイレクトされるページのURL。

#### EntityPayload

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

名称

種類

概要

*ID*

番号

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

*entityType*

ストリング

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

*URL*

ストリング

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

*sourceId*

ストリング

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

## trackPreviewSearchSuggestionClickEvent

この機能は、preview searchコンテナ内のキーワードフレーズ、カテゴリ、または提案へのクリックを追跡するwidget click(creating-a-widget-click-event.md "Creating a widget click event") イベントをトリガーします。

名称

種類

概要

*RFKID*

ストリング

必須。  
  
追跡中のウィジェットを特定します。

*ペイロード*

[PreviewSearchSuggestionPayload](https://doc.sitecore.com/search/ja/developers/search-developer-guide/integrating-using-search-js-data-package/tracking-user-interactions/preview-search-widget-events.html#UUID-1f566ee3-97bc-ebe8-f535-019e0d084927_section-idm1743380786835928)

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

### PreviewSearchSuggestionPayload

ウィジェットクリックイベントで、trackPreviewSearchSuggestionClickEvent関数によってペイロードがディスパッチされます。

名称

種類

概要

*フィルター*

[FilterPayload](https://doc.sitecore.com/search/ja/developers/search-developer-guide/integrating-using-search-js-data-package/tracking-user-interactions/preview-search-widget-events.html#UUID-1f566ee3-97bc-ebe8-f535-019e0d084927_section-idm452576511897443383195485037) 配列

必須。  
  
エンティティをクリックしました。

*キーワード*

ストリング

フレーズ検索済み。

*advancedQueryText*

ストリング

検索を絞り込むクエリ検索式。  
  
例: filetype:pdf

*modifiedKeyword*

ストリング

結果に反映されたキーワードを修正しました。

*numResults*

番号

取得できる最大結果数。

*totalResults*

番号

検索結果の総数。

*pageSize*

番号

1ページに表示される結果の最大数。

*pageNumber*

番号

結果を掲載した後のウィジェットをホストするページの番号は pageSizeでページ付けされています。

*redirectUrl*

ストリング

検索がリダイレクトされるページのURL。

#### FilterPayload

ペイロードはフィルターを記述するPreviewSearchSuggestionPayloadオブジェクトでディスパッチされます。

名称

種類

概要

*名称*

ストリング

必須。  
  
Sitecore Search年に作成された提案者の名前。

*価値*

ストリング

その提案の価値が腑に落ちた。

*タイトル*

ストリング

提案者名のUIタイトル。

*displayName*

ストリング

提案の表示名をクリックしました。

*ウリ*

ストリング

提案フィルターのURLがあれば教えてください。