SXA 検索サービス

概要

SXA 検索 API のパラメーターとその使用方法について詳しく説明します。

SXA 検索サービスは、検索コンポーネントによって使用されるエンドポイントです。SXA ツールボックスから利用できるほとんどの検索コンポーネントは、エンドポイントからのデータを消費します。このトピックでは、SXA 検索 API のパラメーターとその目的について説明します。

定義されたサイトごとに、SXA 検索サービスは次のエンドポイント URL を持つルートを登録します。

結果エンドポイントは検索を実行し、結果を返します。次のパラメーターを使用できます。

クエリ パラメーター

説明

値の例

q

クエリ - 指定された単語を含む結果を返します。

Renderings

v

バリアント - 結果をレンダリングするために使用されるバリアント定義アイテムの ID。

{A907975A-8C25-4433-A8ED-02B5FC1EBA29}

s

スコープ - 事前定義されたフィルタリングを提供するスコープ定義アイテムの ID。

{A907975A-8C25-4433-A8ED-02B5FC1EBA29}

l

言語 - 検索結果に含める言語バージョン。

en|pl

en,pl

o

並べ替え - 指定されたファセットに基づいて結果を並べ替えます。

Title,Descending

e

オフセット - 返された結果から指定された量の要素を除外します。

30

p

ページ サイズ - 指定された量のページを返します。デフォルト値は 20 です。

20

g

地理位置情報 - 空間検索に使用される地理位置情報の緯度と経度。

55.676098|12.568337

sc_site

Sitecore サイト - コンテキスト サイトの名前。

showcase

itemid

アイテム ID - 現在のコンテキスト アイテム ID。

{A907975A-8C25-4433-A8ED-02B5FC1EBA29}

sig

署名 - 検索結果の署名。

my_signature_search

次に例を示します。

https://sxa94_003432/playground/sxa/search/results/?s={BAFF04C0-7332-4B72-A108-EE9814C62F16}&itemid={81003E8D-4232-433D-849E-6CA9574B5BD1}&v={2CA6BDE6-69BC-4D2A-AC6B-6DD88E300CF9}&p=20&o=Title,Ascending

ファセット サービスは、その名前に基づいてファセットを検索します。次のパラメーターを使用できます。

クエリ パラメーター

説明

値の例

q

クエリ - 検索するユーザー文字列入力。

Renderings

s

スコープ - 事前定義されたフィルタリングを提供するスコープ定義アイテムの ID。

{A907975A-8C25-4433-A8ED-02B5FC1EBA29}

f

ファセット - 返すファセット アイテム名。

更新日、タグ

l

言語 - 検索結果に含める言語バージョン。

en|pl

g

地理位置情報 - 空間検索に使用される地理位置情報の緯度と経度

55.676098|12.568337

sig

署名 - 検索結果の署名

my_signature_search

次に例を示します。

https://sxa94_003432/playground/sxa/search/facets/?f=movie%20type,movie%20rated,movie%20genre&s={BAFF04C0-7332-4B72-A108-EE9814C62F16}&itemid={81003E8D-4232-433D-849E-6CA9574B5BD1}

デフォルトでは、検索要求とファセット要求のキャッシュは無効になっています。Sitecore.XA.Feature.Search.config ファイルで設定を更新できます。

SXA-search-service-enable.png