サイトのHTMLにコピー&ペーストできる検索フォームコードが用意されています(Design > Auto-Complete > Form Source)。
検索フォーム自体またはスクリプトから、リストに含まれるパラメーターを設定することもできます。 以下に示すパラメーターに加えて、バックエンド検索パラメーターを使用して検索を制御することもできます。
バックエンド検索のCGIパラメーターを参照してください。
検索リクエストはベースURLで構成されます。 ベースURLは、顧客が検索しているアカウントを示し、関連するアカウントに対して目的の検索結果を返す方法を示すCGIパラメーターのセット(キーと値のペア)が示されます。
ベースURLは、特定のアカウントと、ステージングされた環境またはライブアカウントに関連付けられます。 アカウントマネージャーから、ベースURLの複数のエイリアスをリクエストできます。 例えば、Megacorpという会社のアカウントに2つのベースURLが関連付けられているとします。https://search.megacorp.com
とhttps://stage.megacorp.com
。 前者のURLはライブインデックスを検索し、後者のURLはステージングされたインデックスを検索します。
3つの形式のCGIパラメーターがサポートされています。 デフォルトでは、次の例のように、CGIパラメーターをセミコロンで区切るようにアカウントが設定されています。
https://search.megacorp.com?q=shoes;page=2
必要に応じて、アカウントマネージャーに、CGIパラメーターを区切るアンパサンドを使用するようにアカウントを設定してもらうことができます。次に例を示します。
https://search.megacorp.com?q=shoes&page=2
3つ目の形式(SEO形式)もサポートされています。この形式では、次の例のように、区切り文字の代わりにスラッシュ/
が使用され、等号が使用されます。
https://search.megacorp.com/q/shoes/page/2
SEO形式を使用してリクエストが送信されると、すべての出力リンクは同じ形式で返されます。
ガイド付き検索パラメーター | 例 | 説明 |
---|---|---|
q | q=string |
検索のクエリ文字列を指定します。 このパラメーターはsp_q バックエンド検索パラメーターにマップされます。 バックエンド検索のCGIパラメーターを参照してください。 |
q# | q#=string |
ファセット設定(特定のフィールド内での検索)は、番号付きのqとxのパラメータを使って行います。 qパラメーターは、対応する番号付きxパラメーターで示されるように、ファセットで検索する用語を定義します。 例えば、sizeとcolorという名前の2つのファセットがある場合、q1=small;x1=size;q2=red;x2=colorのように指定できます。このパラメーターは sp_q_exact_# バックエンド検索パラメーターに対応付けられます。 「 バックエンド検索CGIパラメーター」を参照してください。 |
x# | q#=string |
ファセット設定(特定のフィールド内での検索)は、番号付きのqとxのパラメータを使って行います。 qパラメーターは、対応する番号付きxパラメーターで示されるように、ファセットで検索する用語を定義します。 例えば、sizeとcolorという名前の2つのファセットがある場合、q1=small;x1=size;q2=red;x2=colorのように指定できます。このパラメーターは sp_x_# バックエンド検索パラメーターに対応付けられます。 「 バックエンド検索CGIパラメーター」を参照してください。 |
コレクション | collection=string |
検索に使用するコレクションを指定します。 このパラメーターはsp_k バックエンド検索パラメーターにマップされます。 バックエンド検索のCGIパラメーターを参照してください。 |
count | count=number |
表示する結果の合計数を指定します。 デフォルトは、Settings > Searching > Searchesで定義されています。. このパラメーターはsp_c バックエンド検索パラメーターにマップされます。 バックエンド検索のCGIパラメーターを参照してください。 |
page | page=number |
返される結果のページを指定します。 |
ランク | rank=field |
静的なランクに使用するランクフィールドを指定します。 フィールドは、0より大きい関連性を持つ「ランク」タイプのフィールドである必要があります。 このパラメーターはsp_sr バックエンドパラメーターにマップされます。 バックエンド検索のCGIパラメーターを参照してください。 |
並べ替え | sort=number |
並べ替え順を指定します。 「0」はデフォルトで、関連性スコアで並べ替えられます。「1」は日付で並べ替えます。「 —1」は並べ替えを行いません。ユーザーは、 sp_s パラメーターの値のフィールド名を指定できます。 例えば、sp_s=title は、タイトルフィールドに含まれる値に従って結果を並べ替えます。 sp_s パラメーターの値にフィールド名を使用すると、結果はそのフィールドで並べ替えられ、関連性の高い順で並べ替えられます。 この機能を有効にするには、Settings > Metadata > Definitionsをクリックします。 定義ページで、「Add New Field」をクリックするか、「Edit」をクリックして特定のフィールド名を指定します。 Sortingドロップダウンリストで、AscendingまたはDescendingを選択します。 このパラメーターはsp_s バックエンド検索パラメーターにマップされます。 「 [バックエンド検索CGIパラメーター]」を参照してください。(/docs/search-promote/using/appendices/c-cgiparameters.html?lang=ja#reference_582E85C3886740C98FE88CA9DF7918E8)。 |
通常、お客様はガイド付き検索と呼ばれるプレゼンテーションレイヤーとやり取りします。 ただし、理論的には、Guided Searchレイヤーをスキップし、このページで説明するCGIパラメーターを使用してバックエンドのコア検索と直接やり取りすることは可能です。
次の表から、バックエンド検索のCGIパラメーターを選択できます。
単一クエリのサポート |
複数クエリのサポート |
例 |
説明 |
|
---|---|---|---|---|
1 |
sp_a |
|
|
アカウント番号の文字列を指定します。 このパラメーターは必須で、有効なアカウント番号文字列である必要があります。 アカウント番号の文字列は、設定 > アカウントオプション > アカウント設定にあります。 |
2 |
sp_advanced |
|
|
|
3 |
sp_c |
|
|
表示する結果の合計数を指定します。 デフォルトは 10 です。 |
4 |
sp_context_field |
|
|
特定のフィールドのコンテキスト情報を収集します。 収集された情報は、 |
5 |
sp_d |
|
|
実行する日付範囲検索のタイプを指定します。 指定可能な値はany (日付範囲検索を実行しない)、custom (検索する日付の決定に |
6 |
|
sp_d_# |
|
対応する
|
7 |
sp_date_range |
|
|
検索に適用する事前定義の日付範囲を指定します。 0以上の値は、今日より前に検索する日数を指定します。例えば、「0」の値は「today」を、「1」の値は「today and yesterday」を、「30」の値は「within thast 30 days」を示します。 0未満の値は、次のようにカスタム範囲を指定します。 -1 = "なし"(日付範囲なしを指定した場合と同じ)。 -2 = "今週"。現在の週の日曜日から土曜日を検索します。 -3 = "先週"。現在の週の前の週の日曜日から土曜日を検索します。 -4 = "今月"(現在の月内の日付を検索) -5 = "先月"。現在の月の前の月内の日付を検索します。 -6 = "今年"(現在の年内の日付を検索) -7 = "昨年"。現在の年の前の年内の日付を検索します。 |
8 |
|
sp_date_range_# |
|
対応する 0以上の値は、今日より前に検索する日数を指定します。 例えば、0を指定すると今日が指定されます。値1は今日と昨日を指定します。値を30に設定すると、過去30日以内の期間が指定されます。 0未満の値は、次のようにカスタム範囲を指定します。 -1 = "なし"(日付範囲なしを指定した場合と同じ)。 -2 = "今週"。現在の週の日曜日から土曜日を検索します。 -3 = "先週"。現在の週の前の週の日曜日から土曜日を検索します。 -4 = "今月"(現在の月内の日付を検索) -5 = "先月"。現在の月の前の月内の日付を検索します。 -6 = "今年"(現在の年内の日付を検索) -7 = "昨年"。現在の年の前の年内の日付を検索します。 |
9 |
sp_dedupe_field |
|
|
検索結果を重複除外する単一のフィールドを指定します。 そのフィールドの重複結果はすべて検索結果から削除されます。 例えば |
10 |
sp_e |
|
|
数字を超える文字を含むクエリ文字列の任意の単語に対して、自動ワイルドカード拡張を行うように指定します。 つまり、 |
11 |
|
sp_e_# |
|
対応する |
12 |
sp_end_day、sp_end_month、sp_end_year |
|
|
この3項目の値は、検索の終了日の範囲を指定し、セットとして指定する必要があります。 |
13 |
sp_f |
|
|
クエリパラメーター文字列の文字セットを指定します( |
14 |
sp_field_table |
|
|
指定したフィールドから成る論理データテーブルを定義します。 例えば、「color」、「size」、「price」の各フィールドから成る「items」という名前のテーブルは、次のように定義されます。 論理テーブルは、(設定 > メタデータ > 許可リストの下)「定義」がオンになっているフィールドと組み合わせる場合に最も役立ちます。 フィールド名を値として使用するすべてのCGIパラメーターとテンプレートタグでは、必要に応じてテーブル名の後に「。」を付けて指定できます。 をフィールド名の前(例: 例えば、サイズが「large」の1つ以上の「red」ドキュメントを含むアイテム(アイテムがメタデータの平行な行として表される)を検索するには、次を使用します。 |
15 |
sp_i |
|
|
|
| ||||
|
| |||
|
| |||
| ||||
| ||||
| ||||
|
| |||
|
| |||
|
| |||
|
| |||
| ||||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
| ||||
| ||||
| ||||
|
| |||
|
| |||
|
| |||
| ||||
| ||||
|
| |||
| ||||
|
| |||
| ||||
|
| |||
| sp_w_control
| |||
|
| |||
|
|
次のリンククエリは、検索クエリとして「Music」を使用して検索を開始し、すべてのデフォルトパラメータを使用します。 URLは読みやすくするために2行に分割されます。 HTMLでは、このリンクはすべて1行に記述する必要があります。
<a href="https://search.atomz.com/search/?sp_q=Music&sp_a=sp99999999">
Testing...</a>
同じ機能は、フォームにより一般的に定義されます。
<form action="https://search.atomz.com/search/">
<input size=12 name="sp_q" value="Music"><br>
<input type=hidden name="sp_a" value="sp99999999">
<input type=submit value="Search"><br>
</form>
通常、検索を開始する際は、デフォルトのパラメーターを使用する必要があります。 これにより、最初のページが関連性順に表示され、顧客が他のページや他のオプションを選択できるようになります。 サイトの検索フォームにコレクションのオプションが含まれる場合は、コレクション名をパラメーターとして渡します。
次のフォームクエリには、結果10
から始まる25
結果が表示されます。 概要が表示されず、並べ替え順が日付順になり、support
という名前のコレクションが使用されます。 過去30日以内の日付のドキュメントのみが返されます。
<form action="https://search.atomz.com/search/">
<input size=12 name="sp_q"><br>
<input type=hidden name="sp_a" value="sp99999999">
<input type=submit value="Search"><br>
<input type=hidden name=sp_n value=10>
<input type=hidden name=sp_c value=25>
<input type=hidden name=sp_m value=0>
<input type=hidden name=sp_s value=1>
<input type=hidden name=sp_k value="support">
<input type=hidden name=sp_date_range value=30>
</form>