Search results widget events
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
Sitecore Search JS SDK for Reactは、検索結果ウィジェットとのインタラクションを追跡するためのイベントを提供します。
特に明記されていない限り、すべての属性はオプションです。
trackSearchResultsClickEntityEvent
検索結果コンテナ内のエンティティのクリックを追跡します。
このイベントは、Search UIコンポーネントを使用していない場合にのみ発生します。
|
名前 |
種類 |
形容 |
|---|---|---|
|
rfkId |
糸 |
必須。 追跡されているウィジェットを識別します。 |
|
entity |
糸 |
必須。 エンティティのタイプ。 例: content |
|
payload |
SearchResultsClickEntityPayload |
必須。 イベントと共にディスパッチされたペイロード。 |
SearchResultsClickEntityPayload (英語)
ペイロードはtrackSearchResultsClickEntityEvent.
|
名前 |
種類 |
形容 |
|---|---|---|
|
items |
array< EntityPayload > |
必須。 クリックされたエンティティ。 |
|
index |
数 |
必須。 クリックされたエンティティのインデックス。 |
|
keyword |
糸 |
検索されたフレーズ。 |
|
advancedQueryText |
糸 |
クエリ検索式を使用して、検索を絞り込みます。 例: filetype:pdf |
|
modifiedKeyword |
糸 |
結果で返された変更されたキーワード。 |
|
numResults |
数 |
取得する結果の最大数。 |
|
totalResults |
数 |
検索によって特定された結果の総数 |
|
pageSize |
数 |
1つのWebページに表示される結果の最大数。 |
|
pageNumber |
数 |
pageSizeを使用してページ分割された後のウィジェットをホストしているページの番号 |
|
redirectUrl |
糸 |
検索がリダイレクトされるページのURL。 |
EntityPayload
このペイロードはエンティティを記述します。このペイロードタイプは、エンティティとのインタラクションを追跡する場合に、すべてのイベントで使用します。
|
名前 |
種類 |
形容 |
|---|---|---|
|
id |
数 |
必須。 エンティティのID |
|
entityType |
糸 |
必須。 エンティティの名前 |
|
url |
糸 |
エンティティ ページのURL。通常、エンティティの詳細ページ。 指定されていない場合、SDKはページのURLを使用します。 |
|
sourceId |
糸 |
コネクタによって割り当てられたエンティティのソースのID。 |
trackSearchResultsFacetClickEvent
検索結果ウィジェット内のファセットのクリックまたは選択を追跡します。
このイベントは、Search UIコンポーネントを使用していない場合にのみ発生します。
|
名前 |
種類 |
形容 |
|---|---|---|
|
rfkId |
糸 |
必須。 追跡されているウィジェットを識別します。 |
|
entity |
糸 |
必須。 エンティティの種類 |
|
payload |
SearchResultsFacetPayload |
必須。 イベントと共にディスパッチされたペイロード。 |
SearchResultsファセットペイロード
ペイロードはtrackSearchResultsFacetClickEvent.
|
名前 |
種類 |
形容 |
|---|---|---|
|
filters |
array< FacetPayload > |
必須。 クリックされたエンティティ。 |
|
index |
数 |
必須。 クリックされたエンティティのインデックス。 |
|
keyword |
糸 |
検索されたフレーズ。 |
|
advancedQueryText |
糸 |
クエリ検索式を使用して、検索を絞り込みます。 例: filetype:pdf |
|
modifiedKeyword |
糸 |
結果で返された変更されたキーワード。 |
|
numResults |
数 |
取得する結果の最大数。 |
|
totalResults |
数 |
検索によって特定された結果の総数 |
|
pageSize |
数 |
1つのWebページに表示される結果の最大数。 |
|
pageNumber |
数 |
pageSizeを使用してページ分割された後のウィジェットをホストしているページの番号 |
|
redirectUrl |
糸 |
検索がリダイレクトされるページのURL。 |
ファセットペイロード
このペイロード オブジェクトは、ファセットを記述します。
|
引数 |
種類 |
形容 |
|---|---|---|
|
facetId |
糸 |
必須。 ファセットのID |
|
facetTitle |
糸 |
必須。 ファセットのタイトル。 |
|
facetIndex |
数 |
検索結果で受信したfacetsのリスト内のファセットのインデックス。 |
|
facetValueId |
糸 |
ファセット値のID。 |
|
valueIndex |
糸 |
検索結果で受信したファセット値のリスト内のファセット値のインデックス。 |
|
startValue |
糸 |
範囲内の開始値または最小値。 |
|
endValue |
糸 |
範囲内の終了値または最大値。 |
|
facetValue |
糸 |
ファセットの値 |