--- title: "プレビュー検索ウィジェットイベント" slug: "preview-search-widget-events" abstract: "エンティティとのやり取りを追跡するために使われるエンティティのペイロードを記述します。" --- # プレビュー検索ウィジェットイベント Sitecore Search JS SDK for Reactは、preview searchウィジェットとの相互作用を追跡するための以下のイベントを提供します。 > !注特に記載がない限り、すべての属性は任意です。 ## trackPreviewSearchClickEvent preview searchコンテナ内のエンティティへのクリックを追跡します。 > !注Search UIコンポーネントを使っていない場合にのみこのイベントを起動してください。 名称 種類 概要 rfkid ストリング 必須。 追跡中のウィジェットを特定します。 entity ストリング 必須。 エンティティの種類。 例: content payload PreviewSearchPayload 必須。 ペイロードはイベントと共に発送されました。 ### PreviewSearchPayload ペイロードはtrackPreviewSearchClickEventと共に発送されました。 名称 種類 概要 items array< EntityPayload > 必須。 エンティティをクリックしました。 index 番号 必須。 クリックされたエンティティのインデックスです。 keyword ストリング フレーズ検索済み。 advancedQueryText ストリング 検索を絞り込むクエリ検索式。 例: filetype:pdf modifiedKeyword ストリング 結果に反映されたキーワードを修正しました。 numResults 番号 取得できる最大結果数。 totalResults 番号 検索で特定された結果の総数 pageSize 番号 1ページに表示される結果の最大数。 pageNumber 番号 結果がページ付けされた後のウィジェットをホストするページの番号はpageSize redirectUrl ストリング 検索がリダイレクトされるページのURL。 #### EntityPayload このペイロードはエンティティを記述します。エンティティとのやり取りを追跡したい場合、すべてのイベントでこのペイロードタイプを使いましょう。 名称 種類 概要 *ID* 番号 必須。 エンティティのID。 *entityType* ストリング 必須。 エンティティの名前。 *URL* ストリング エンティティのページのURL。通常はエンティティの詳細ページです。 提供されていない場合、SDKはページのURLを使用します。 *sourceId* ストリング コネクターによって割り当てられたエンティティの送信元のID。 ## trackPreviewSearchSuggestionClickEvent preview searchコンテナ内のキーワード、カテゴリ、または提案のクリックを追跡します。 > !注Search UIコンポーネントを使っていない場合にのみこのイベントを起動してください。 名称 種類 概要 rfkid ストリング 必須。 追跡中のウィジェットを特定します。 payload PreviewSearchSuggestionPayload 必須。 ペイロードはイベントと共に発送されました。 ### PreviewSearchSuggestionPayload ペイロードはtrackPreviewSearchSuggestionClickEventと共に発送されました。 名称 種類 概要 filters array< FilterPayload > 必須。 エンティティをクリックしました。 keyword ストリング フレーズ検索済み。 advancedQueryText ストリング 検索を絞り込むクエリ検索式。 例: filetype:pdf modifiedKeyword ストリング 結果に反映されたキーワードを修正しました。 numResults 番号 取得できる最大結果数。 totalResults 番号 検索で特定された結果の総数 pageSize 番号 1ページに表示される結果の最大数。 pageNumber 番号 結果がページ付けされた後のウィジェットをホストするページの番号はpageSize redirectUrl ストリング 検索がリダイレクトされるページのURL。 #### FilterPayload ペイロードはフィルターを記述します。 名称 種類 概要 name ストリング 必須。 Sitecore Search年に作成された提案者の名前。 value ストリング その提案の価値が腑に落ちた。 title ストリング 提案者名のUIタイトル。 displayName ストリング 提案の表示名をクリックしました。 uri ストリング 提案フィルターのURLがあれば教えてください。