CGIパラメータ

CGIパラメータ

CGIパラメータの検索

サイトのHTMLにコピー&ペーストできる検索フォームコードが用意されています(Design > Auto-Complete > Form Source)。

検索フォームのHTMLコードを.

検索フォーム自体またはスクリプトから、リストに含まれるパラメーターを設定することもできます。 以下に示すパラメーターに加えて、バックエンド検索パラメーターを使用して検索を制御することもできます。

バックエンド検索の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)。

バックエンド検索CGIパラメーター

通常、お客様はガイド付き検索と呼ばれるプレゼンテーションレイヤーとやり取りします。 ただし、理論的には、Guided Searchレイヤーをスキップし、このページで説明するCGIパラメーターを使用してバックエンドのコア検索と直接やり取りすることは可能です。

次の表から、バックエンド検索のCGIパラメーターを選択できます。

単一クエリのサポート

複数クエリのサポート

例

説明

1

sp_a

sp_a= string

アカウント番号の文字列を指定します。 このパラメーターは必須で、有効なアカウント番号文字列である必要があります。 アカウント番号の文字列は、設定 > アカウントオプション > アカウント設定にあります。

2

sp_advanced

sp_advanced= 0 or 1

sp_advanced=1 がクエリと共に送信された場合は、検索テンプレート内の<search-if-advanced> タグと</search-if-advanced> タグの間のすべてのコードが検索フォームに使用されます。 <search-if-not-advanced> タグと</search-if-not-advanced> タグの間のコードはすべて無視されます。 sp_advanced=0 （または他の値）が送信された場合、<search-if-advanced>テンプレートブロックは無視され、<search-if-not-advanced>テンプレートブロックが使用されます。

3

sp_c

sp_c= number

表示する結果の合計数を指定します。 デフォルトは 10 です。

4

sp_context_field

sp_context_field= field

特定のフィールドのコンテキスト情報を収集します。 収集された情報は、<search-context> テンプレートタグを介して検索結果に出力されます。 デフォルト値は body です。

5

sp_d

sp_d= type

実行する日付範囲検索のタイプを指定します。 指定可能な値はany （日付範囲検索を実行しない）、custom （検索する日付の決定にsp_date_range の値を使用することを示す）、特定（sp_start_day 、sp_start_month 、sp_start_year 、sp_end_day 、sp_end_month 、sp_end_year の値を使用）です。 sp_d は、検索フォームに、カスタム範囲(経由 sp_date_range )、または特定の開始と終了日の範囲で検索するオプションが含まれる場合にのみ必要です。

6

sp_d_#

sp_d_#= type

対応するsp_q_# クエリで実行する日付範囲検索のタイプを指定します。 「#」は1 ～ 16の数字に置き換えられます(例えば、sp_d_8 は番号付きクエリsp_q_8 に適用されます)。

type を任意（日付範囲検索を行わない）に設定できます。カスタムはsp_date_range_# の値を検索する日付の決定に使用することを示し、特定はsp_q_min_day_# 、sp_q_min_month_# 、sp_q_min_year_# 、sp_q_max_day_# 、sp_q_max_month_# 、sp_q_max_year_# の値を使用して日付の範囲を決定します。 sp_d_# の使用は、検索フォームにカスタム範囲（sp_date_range_# を介して）、または特定の開始と終了日の範囲で検索するオプションが含まれている場合にのみ必要です。

7

sp_date_range

sp_date_range= number

検索に適用する事前定義の日付範囲を指定します。 0以上の値は、今日より前に検索する日数を指定します。例えば、「0」の値は「today」を、「1」の値は「today and yesterday」を、「30」の値は「within thast 30 days」を示します。

0未満の値は、次のようにカスタム範囲を指定します。

-1 = "なし"（日付範囲なしを指定した場合と同じ）。

-2 = "今週"。現在の週の日曜日から土曜日を検索します。

-3 = "先週"。現在の週の前の週の日曜日から土曜日を検索します。

-4 = "今月"（現在の月内の日付を検索）

-5 = "先月"。現在の月の前の月内の日付を検索します。

-6 = "今年"（現在の年内の日付を検索）

-7 = "昨年"。現在の年の前の年内の日付を検索します。

8

sp_date_range_#

sp_date_range_#= number

対応するsp_q_# クエリに適用する、事前定義の日付範囲を指定します。 「#」は1 ～ 16の数字に置き換えられます(例えば、sp_date_range_8 は番号付きクエリsp_q_8 に適用されます)。

0以上の値は、今日より前に検索する日数を指定します。 例えば、0を指定すると今日が指定されます。値1は今日と昨日を指定します。値を30に設定すると、過去30日以内の期間が指定されます。

0未満の値は、次のようにカスタム範囲を指定します。

-1 = "なし"（日付範囲なしを指定した場合と同じ）。

-2 = "今週"。現在の週の日曜日から土曜日を検索します。

-3 = "先週"。現在の週の前の週の日曜日から土曜日を検索します。

-4 = "今月"（現在の月内の日付を検索）

-5 = "先月"。現在の月の前の月内の日付を検索します。

-6 = "今年"（現在の年内の日付を検索）

-7 = "昨年"。現在の年の前の年内の日付を検索します。

9

sp_dedupe_field

sp_dedupe_field= fieldname

検索結果を重複除外する単一のフィールドを指定します。 そのフィールドの重複結果はすべて検索結果から削除されます。 例えばsp_dedupe_field=title の場合、特定のタイトルの最上位の結果のみが検索結果に表示されます（2つの結果に同じタイトルフィールドのコンテンツは表示されません）。 複数値(許可リスト)タイプのフィールドの場合は、フィールドの内容全体が比較に使用されます。 1つのフィールドのみを指定できます。 フィールド名に「table-qualifier」は使用できません。

10

sp_e

sp_e= number

数字を超える文字を含むクエリ文字列の任意の単語に対して、自動ワイルドカード拡張を行うように指定します。 つまり、sp_e=5 は、「クエリ」や「数値」のように5文字以上の単語をワイルドカード文字「*」で展開し、「クエリ*」や「数値*」と同じ検索にすることを指定します。 文字数の少ない単語は拡張されないので、「word」を検索しても、ワイルドカードによる自動拡張は行われません。

11

sp_e_#

sp_e_#= number

対応するsp_q_# クエリ文字列の単語が数字を超える場合に、その単語に対して自動ワイルドカード拡張を行うように指定します。 つまり、sp_e_2=5 は、sp_q_2 クエリ文字列に5文字以上含まれる単語(「クエリ」や「数値」など)を、ワイルドカード文字「* 」で展開するように指定し、「クエリ*」や「数値*」の検索と同じ検索にします。 文字数の少ない単語は拡張されないので、sp_q_2 内の「word」を検索しても、ワイルドカードの自動拡張は行われません。

12

sp_end_day、sp_end_month、sp_end_year

sp_end_day= number,sp_end_month= number, sp_end_year= number

この3項目の値は、検索の終了日の範囲を指定し、セットとして指定する必要があります。

13

sp_f

sp_f= string

クエリパラメーター文字列の文字セットを指定します（sp_q など）。 この文字列は、検索フォームが含まれるページの文字セットと常に一致する必要があります。

14

sp_field_table

sp_field_ table=table: field,field...

指定したフィールドから成る論理データテーブルを定義します。 例えば、「color」、「size」、「price」の各フィールドから成る「items」という名前のテーブルは、次のように定義されます。

sp_field_table=items:color,size,price

論理テーブルは、(設定 > メタデータ > 許可リストの下)「定義」がオンになっているフィールドと組み合わせる場合に最も役立ちます。 フィールド名を値として使用するすべてのCGIパラメーターとテンプレートタグでは、必要に応じてテーブル名の後に「。」を付けて指定できます。 をフィールド名の前（例：sp_x_1=tablename.fieldname ）に置き換えます。

例えば、サイズが「large」の1つ以上の「red」ドキュメントを含むアイテム（アイテムがメタデータの平行な行として表される）を検索するには、次を使用します。

sp_q_exact_1=red&sp_x_1=items.color& sp_q_exact_2=large&sp_x_2=items.size&sp_field_table=items:color,size,price

15

sp_i

sp_i=1 sp_i=2

sp_k= string

sp_l= string

sp_q string

sp_literal= 0 or 1

sp_literal=1

sp_literal=0

sp_m= number

sp_n= number

sp_not_found_page= url

sp_p= any/all/phrase

any all phrase

phrase all sp_p

sp_p

sp_p_#= any/all/phrase

sp_q_# sp_p_8 sp_q_8 any all phrase

all phrase sp_p_# any

sp_pt= exact/equivalent/compatible

exact equivalent compatible sp_p exact sp_p all phrase equivalent sp_pt compatible

sp_pt_#= exact/equivalent/compatible

sp_q_# sp_p_8 sp_q_8 exact equivalent exact compatible sp_p_# exact sp_p_# equivalent sp_pt_# compatible

sp_q= string

sp_q_#= text

sp_q_# sp_q_1 sp_q_16

Search for: <input type="text" name="sp_q" value="great"> Search for: <input type="text" name="sp_q_1" value="books">

sp_q_day= integer value

sp_q_month= integer value

sp_q_year= integer value

sp_q_day_#= integer value

sp_q_month_#= integer value

sp_q_year_#= integer value

sp_q_day sp_q_month sp_q_year sp_q

# sp_q_day_6 sp_q_6

PublishDate

<input type="hidden" name="sp_x_1" value="PublishDate"> Search for: <input type="text" name="sp_q" value="orange">On : <input type="text" name="sp_q_day_1" size="2" value="1"> Day<input type="text" name="sp_q_month_1" size="2" value="1"> Month <input type="text" name="sp_q_year_1" size="4" value="2000"> Year 

sp_q_location=latitude/longitude OR areacode OR zipcode

sp_q_location_#= latitude/longitude OR areacode OR zipcode

sp_q_location sp_q_location_# #

sp_q_max_relevant_distance= value

sp_q_max_relevant_distance_#= value

sp_q_max_relevant_distance sp_q_max_relevant_distance_# #

sp_q_max_relevant_distance

sp_q_max_relevant_distance_#

sp_q_min_day=integer value

sp_q_min_month=integer value

sp_q_min_year=integer value

sp_q_max_day=integer value

sp_q_max_month=integer value

sp_q_max_year=integer value

sp_q_min_day_#=integer value

sp_q_min_month_#=integer value

sp_q_min_year_#=integer value

sp_q_max_day_#=integer value

sp_q_max_month_#=integer value

sp_q_max_year_#=integer value

sp_q_min_day sp_q_min_month sp_q_min_year sp_q_max_day sp_q_max_month sp_q

# sp_q_min_day_6 sp_q_6

PublishDate

<input type="hidden" name="sp_x_1" value="PublishDate">Search for: <input type="text" name="sp_q" value="orange">Between: <input type="text" name="sp_q_min_day_1" size="2" value="1"> Start Day<input type="text" name="sp_q_min_month_1" size="2" value="1"> Start Month <input type="text" name="sp_q_min_year_1" size="4" value="2000"> Start Year And: <input type="text" name="sp_q_max_day_1" size="2" value="31"> End Day <input type="text" name="sp_q_max_month_1" size="2" value="12"> End Month <input type="text" name="sp_q_max_year_1" size="4" value="2000"> End Year

sp_q_min= value

sp_q_max= value

sp_q_min_#= value

sp_q_max_#= value

sp_q_exact_#=value

sp_q_min sp_q_max sp_q_exact sp_q

# sp_q_min_8 sp_q_8

sp_q_exact_# sp_q_min_# sp_q_max_# sp_q_exact_# sp_q_min_# sp_q_max_#

sp_q_min_# sp_q_max_# sp_q_exact_# ...&sp_q_exact_1=green|red&sp_x_1=color

sp_q_nocp= 1 or 0

sp_q_nocp_#= 1 or 0

0

1

sp_q_nocp sp_q # sp_q_nocp_8 sp_q_8

sp_q_required= 1 or 0 or -1

sp_q_required_#= 1 or 0 or -1

sp_q_required sp_q

# sp_q_required_8 sp_q_8

<input type="hidden" name="sp_x_1" value="platform"> Search for: <input type="text" name="sp_q" value="calc"> Exclude: <input type="text" name="sp_q_1" value="mac win all"> <input type="hidden" name="sp_q_required_1" value="-1">

sp_redirect_ if_one_result= 0 or 1

sp_referrer= url

ro

sp_ro=body:10

sp_ro=body:9|title:9

sp_ro=title:10 title sp_ro sp_ro

sp_s= number

sp_s sp_s=title sp_s

sp_s

<input type="hidden" name="sp_s" value="artist"> <input type="hidden" name="sp_s" value="album"> <input type="hidden" name="sp_s" value="track"> Search for: <input type="text" name="sp_q" value="Music Search">

sp_field_table

sp_sr= field

sp_sr

sp_sr <input type="hidden" name="sp_sr" value="">

sp_sfvl_field= string

search-field-value-list

sp_sfvl_field

search-field-value-list

dynamic-facet-field-count dynamic-facet-field-count

sp_sfvl_df_count dynamic-facet-field-count sp_sfvl_df_count sp_sfvl_df_count

sp_sfvl_df_count sp_sfvl_df_include sp_sfvl_df_include sp_sfvl_df_count

sp_staged= 0 or 1

sp_staged=1

sp_start_day= number

sp_start_month= number

sp_start_year= number

sp_suggest_q= number

sp_suggest_q sp_q[_#]

sp_suggest_q sp_q

sp_suggest_q=1 sp_q_1

sp_t= string

sp_trace= 0 or 1

sp_stage=1

sp_w= sound-alike-enable

sp_w_control=sound-alike-control

sp_w_control

sp_w_control=0 sp_w

<input type=hidden name="sp_w_control" value="0"><input type=checkbox name="sp_w" value="exact">No Sound-Alike matching

sp_w_control=1 sp_w

<input type=hidden name="sp_w_control" value="1"><input type=checkbox name="sp_w" value="alike">Sound-Alike matching

sp_w_control sp_w

sp_x= field

sp_q sp_x

sp_x

sp_x=any sp_x

sp_x

<input type="hidden" name="sp_x" value="title"><input type="hidden" name="sp_x" value="author">Search for: <input type="text" name="sp_q" value="Great Books">

sp_x_#= field-name

sp_q_# # sp_x_8

sp_x_#

Search for: <input type="text" name="sp_q" value="great"><input type="hidden" name="sp_x_1" value="author">Search only documents written by: <input type="text" name="sp_q_1" value="Fitzgerald">

sp_x sp_x_#

<input type="hidden" name="sp_x_1" value="body"><input type="hidden" name="sp_x_1" value="keys">Search for: <input type="text" name="sp_q_1" value="flower">

バックエンド検索CGIパラメータの一般的な使用例

次のリンククエリは、検索クエリとして「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>

通常、検索を開始する際は、デフォルトのパラメーターを使用する必要があります。 これにより、最初のページが関連性順に表示され、顧客が他のページや他のオプションを選択できるようになります。 サイトの検索フォームにコレクションのオプションが含まれる場合は、コレクション名をパラメーターとして渡します。

バックエンド検索CGIパラメータの詳しい使用例

次のフォームクエリには、結果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>

このページ