Show Menu
THEMEN×

CGI-Parameter

CGI-Parameter

CGI-Parameter suchen

Es wird Suchformularcode bereitgestellt, den Sie kopieren und in den HTML-Code Ihrer Site einfügen können ( Design > Auto-Complete > Form Source ).
Sie können auch die Parameter festlegen, die entweder im Suchformular selbst oder über ein Skript aufgeführt werden. Zusätzlich zu den unten aufgeführten Parametern können Sie auch die Backend-Suchparameter verwenden, um die Suche zu steuern.
Siehe CGI-Parameter für die Backend-Suche .
Suchanforderungen bestehen aus einer Basis-URL. Die Basis-URL gibt an, nach welchem Konto der Kunde sucht, und eine Reihe von CGI-Parametern (Schlüssel-Wert-Paare), die angeben, wie die gewünschten Suchergebnisse für das zugehörige Konto zurückgegeben werden.
Die Basis-URL ist mit einem bestimmten Konto und einer gestaffelten oder Live-Umgebung verknüpft. Sie können mehrere Aliase für die Basis-URL von Ihrem Kundenbetreuer anfordern. Beispielsweise kann eine Firma namens Megacorp zwei Basis-URLs mit ihrem Konto verknüpft sein: https://search.megacorp.com und https://stage.megacorp.com . Die erste URL durchsucht ihren Liveindex und die zweite URL sucht ihren gestaffelten Index.
Es werden drei Formate von CGI-Parametern unterstützt. Standardmäßig ist Ihr Konto so konfiguriert, dass CGI-Parameter wie im folgenden Beispiel mit einem Semikolon getrennt werden:
https://search.megacorp.com?q=shoes;page=2
Wenn Sie es vorziehen, können Sie Ihren Kundenbetreuer dazu veranlassen, Ihr Konto so zu konfigurieren, dass zur Trennung der CGI-Parameter ein kaufmännisches kaufmännisches kaufmännisches Und verwendet wird, wie im folgenden Beispiel:
https://search.megacorp.com?q=shoes&page=2
Ein drittes Format, das so genannte SEO-Format, wird ebenfalls unterstützt, wenn anstelle des Trennzeichens und Gleichheitszeichens ein Schrägstrich verwendet / wird, wie im folgenden Beispiel dargestellt:
https://search.megacorp.com/q/shoes/page/2
Jedes Mal, wenn das SEO-Format zum Senden einer Anforderung verwendet wird, werden alle Ausgabelinks im gleichen Format zurückgegeben.
Parameter für die geführte Suche
Beispiel
Beschreibung
q
q=string
Gibt die Abfrage-Zeichenfolge für die Suche an. Dieser Parameter wird dem sp_q Backend-Suchparameter zugeordnet. Siehe CGI-Parameter für die Backend-Suche .
q#
q#=string
Facting (Suche innerhalb eines bestimmten Felds) erfolgt über nummerierte q- und x-Parameter. Der Parameter q definiert den Begriff, nach dem Sie in der Facette suchen, wie er durch den entsprechenden Parameter "x"gekennzeichnet ist.
Wenn Sie z. B. zwei Facetten haben, die Größe und Farbe heißen, können Sie z. B. q1=small;x1=size;q2=red;x2=color haben. Dieser Parameter wird den sp_q_exact_# Backend-Suchparametern zugeordnet.
Siehe CGI-Parameter für die Backend-Suche .
x nicht unterstützt#
q#=string
Facting (Suche innerhalb eines bestimmten Felds) erfolgt über nummerierte q- und x-Parameter. Der Parameter q definiert den Begriff, nach dem Sie in der Facette suchen, wie er durch den entsprechenden Parameter "x"gekennzeichnet ist.
Wenn Sie z. B. zwei Facetten haben, die Größe und Farbe heißen, können Sie z. B. q1=small;x1=size;q2=red;x2=color haben. Dieser Parameter wird den sp_x_# Backend-Suchparametern zugeordnet.
Siehe CGI-Parameter für die Backend-Suche .
Erfassung
collection=string
Gibt die für die Suche zu verwendende Sammlung an. Dieser Parameter wird dem sp_k Backend-Suchparameter zugeordnet. Siehe CGI-Parameter für die Backend-Suche .
count
count=number
Gibt die Gesamtanzahl der angezeigten Ergebnisse an. Die Standardeinstellung ist unter Settings > Searching > Searches. . Dieser Parameter wird dem sp_c Backend-Suchparameter zugeordnet. Siehe CGI-Parameter für die Backend-Suche .
Seite
page=number
Gibt die Seite der zurückgegebenen Ergebnisse an.
rank
rank=field
Gibt das Rankenfeld an, das für das statische Rang verwendet werden soll. Das Feld muss ein Feld vom Typ Rang mit einer Relevanz größer als 0 sein. Dieser Parameter wird dem sp_sr Backend-Parameter zugeordnet. Siehe CGI-Parameter für die Backend-Suche .
sortieren
sort=number
Gibt die Sortierreihenfolge an.
"0"ist der Standardwert und wird nach Relevanzwert sortiert; "1" sortiert nach Datum; "-1"wird nicht sortiert. Benutzer können einen Feldnamen für den Wert des sp_s Parameters angeben. So werden die Ergebnisse sp_s=title nach den Werten sortiert, die im Titelfeld enthalten sind. Wenn ein Feldname für den Wert eines sp_s Parameters verwendet wird, werden die Ergebnisse nach diesem Feld sortiert und dann nach Relevanz untergeordnet. To enable this feature, click Settings > Metadata > Definitions. Klicken Sie auf der Seite "Definitionen"auf Add New Field oder klicken Sie auf Edit , um einen bestimmten Feldnamen anzuzeigen. Wählen Sie in der Sorting Dropdown-Liste entweder Ascending oder Descending. Dieser Parameter wird dem sp_s Backend-Suchparameter zugeordnet.
Siehe CGI-Parameter für die #.(../c-appendices/c-cgiparameters.md#reference_582E85C3886740C98FE88CA9DF7918E8).

CGI-Parameter für die Backend-Suche

In der Regel interagieren Kunden mit einer Präsentationsebene namens "Geführte Suche". Theoretisch ist es jedoch möglich, die Ebene der geführten Suche zu überspringen und mit der Backend-Core-Suche direkt mit den auf dieser Seite beschriebenen CGI-Parametern zu interagieren.
Sie können CGI-Parameter für die Backend-Suche in der folgenden Tabelle auswählen:
Unterstützung für einzelne Abfragen
Unterstützung mehrerer Abfragen
Beispiele
Beschreibung
1
sp_a
sp_a= string
Gibt die Kontonummer-Zeichenfolge an. Dieser Parameter ist erforderlich und muss eine gültige Kontonummer-Zeichenfolge sein. Sie finden Ihre Kontonummer unter Einstellungen > Kontooptionen > Kontoeinstellungen .
2
sp_advanced
sp_advanced= 0 or 1
Wenn eine Abfrage gesendet sp_advanced=1 wird, wird der gesamte Code zwischen dem <search-if-advanced> -Tag und dem </search-if-advanced> -Tag in der Suchvorlage für das Suchformular verwendet. Der gesamte Code zwischen dem <search-if-not-advanced> -Tag und dem </search-if-not-advanced> -Tag wird ignoriert. Wenn sp_advanced=0 (oder ein anderer Wert) gesendet wird, wird der Vorlagenblock <search-if-advanced> ignoriert und der Vorlagenblock <search-if-not-advanced> verwendet.
3
sp_c
sp_c= number
Gibt die Gesamtanzahl der anzuzeigenden Ergebnisse an. Die Standardeinstellung ist „10“.
4
sp_context_field
sp_context_field= field
Erfasst Kontextinformationen für das angegebene Feld. Die gesammelten Informationen werden in den Suchergebnissen über das <search-context> template-Tag ausgegeben. Der Standardwert lautet  body .
5
sp_d
sp_d= type
Gibt den Typ der zu durchsuchenden Datumsbereiche an. Mögliche Werte für den Typ sind beliebige, d. h. keine Suche nach Datumsbereichen, benutzerspezifisch, was bedeutet, dass der Wert von verwendet werden sp_date_range sollte, um die zu suchenden Daten und spezifische Daten zu bestimmen, was bedeutet, dass die Werte in sp_start_day , sp_start_month , sp_start_year , sp_end_day und sp_end_month und sp_end_year verwendet werden, um den zu suchenden Datumsbereich zu bestimmen. sp_d ist nur erforderlich, wenn Ihr Suchformular die Option zur Suche entweder nach einem benutzerdefinierten Bereich (als sp_date_range benutzerspezifischen Bereich) oder nach einem bestimmten Beginn- und Enddatumsbereich enthält.
6
sp_d_#
sp_d_#= type
Gibt den Typ der Datumsbereichssuche für die entsprechende sp_q_# Abfrage an. Das Zeichen "#"wird durch eine Zahl zwischen 1 und 16 ersetzt ( sp_d_8 gilt beispielsweise für die nummerierte Abfrage sp_q_8 ).
Sie können einen beliebigen Wert einstellen, d. h. keine Suche nach Datumsbereichen durchführen, benutzerspezifisch. Dies bedeutet, dass der Wert von verwendet type wird, um die zu suchenden Daten und spezifische Daten zu bestimmen. Dies bedeutet, dass die Werte in sp_date_range_# , sp_q_min_day_# , sp_q_min_month_# , sp_q_min_year_# , sp_q_max_day_# und sp_q_max_month_# sp_q_max_year_# zur Bestimmung des Datumsbereichs verwendet werden sollten. Die Verwendung von sp_d_# ist nur erforderlich, wenn Ihr Suchformular die Möglichkeit enthält, entweder nach einem benutzerdefinierten Bereich (in Form von sp_date_range_# ) oder nach einem bestimmten Beginn- und Enddatumsbereich zu suchen.
7
sp_date_range
sp_date_range= number
Gibt einen vordefinierten Datumsbereich an, der auf die Suche angewendet werden soll. Werte größer gleich null geben die Anzahl der Tage an, die vor dem heutigen Tag gesucht werden sollen — — Beispielsweise gibt der Wert "0"den Wert "today"an, der Wert "1"den Wert "today"und "gestern", der Wert "30"den Wert "within the last 30 days"usw.
Werte unter null geben einen benutzerdefinierten Bereich wie folgt an:
-1 = "Keine", genau wie bei Angabe eines Datumsbereichs.
-2 = "Diese Woche", die von Sonntag bis Samstag der aktuellen Woche durchsucht.
-3 = "Letzte Woche", die von Sonntag bis Samstag der Woche vor der aktuellen Woche durchsucht wird.
-4 = "Dieser Monat", der Daten innerhalb des aktuellen Monats durchsucht.
-5 = "Letzter Monat", der Daten innerhalb des Monats vor dem aktuellen Monat durchsucht.
-6 = "Dieses Jahr", das Daten innerhalb des aktuellen Jahres durchsucht.
-7 = "Letztes Jahr", das Daten innerhalb des Jahres vor dem aktuellen Jahr durchsucht.
8
sp_date_range_#
sp_date_range_#= number
Gibt einen vordefinierten Datumsbereich an, der auf die entsprechende sp_q_# Abfrage angewendet werden soll. Das Zeichen "#"wird durch eine Zahl zwischen 1 und 16 ersetzt ( sp_date_range_8 gilt beispielsweise für die nummerierte Abfrage sp_q_8 ).
Werte größer als oder gleich null geben die Anzahl der Tage an, die vor dem heutigen Tag gesucht werden sollen. Beispielsweise gibt der Wert 0 heute an; Der Wert 1 gibt heute und gestern an. Der Wert 30 gibt innerhalb der letzten 30 Tage usw. an.
Werte unter null geben einen benutzerdefinierten Bereich wie folgt an:
-1 = "Keine", genau wie bei Angabe eines Datumsbereichs.
-2 = "Diese Woche", die von Sonntag bis Samstag der aktuellen Woche durchsucht.
-3 = "Letzte Woche", die von Sonntag bis Samstag der Woche vor der aktuellen Woche durchsucht wird.
-4 = "Dieser Monat", der Daten innerhalb des aktuellen Monats durchsucht.
-5 = "Letzter Monat", der Daten innerhalb des Monats vor dem aktuellen Monat durchsucht.
-6 = "Dieses Jahr", das Daten innerhalb des aktuellen Jahres durchsucht.
-7 = "Letztes Jahr", das Daten innerhalb des Jahres vor dem aktuellen Jahr durchsucht.
9
sp_dedupe_field
sp_dedupe_field= fieldname
Gibt ein einzelnes Feld an, in dem die Suchergebnisse dedupliziert werden sollen. Alle Duplikat-Ergebnisse in diesem Feld werden aus den Suchergebnissen entfernt. Wenn beispielsweise sp_dedupe_field=title nur das oberste Ergebnis für einen bestimmten Titel in den Suchergebnissen angezeigt wird (keine zwei Ergebnisse haben identischen Inhalt im Titelfeld). Bei Feldern mit mehreren Werten (Zulassungsliste) wird der gesamte Feldinhalt zum Vergleich verwendet. Es kann nur ein Feld angegeben werden. Ein "table-qualifier"ist im Feldnamen nicht zulässig.
10
sp_e
sp_e= number
Gibt an, dass für alle Wörter aus der Abfrage-Zeichenfolge mit mehr als Zeichen eine automatische Platzhaltererweiterung erfolgen soll. Mit anderen Worten, sp_e=5 gibt an, dass Wörter mit 5 oder mehr Zeichen, wie "Abfrage" oder "Nummer", mit dem Platzhalterzeichen "*"erweitert werden sollten, wodurch die Suche einer Suche nach "Abfrage*"oder "Nummer*"entspricht. Wörter mit weniger Zeichen werden nicht erweitert, sodass eine Suche nach "Wort"keine automatische Platzhaltererweiterung hätte.
11
sp_e_#
sp_e_#= number
Gibt an, dass für alle Wörter aus der entsprechenden Zeichenfolge der sp_q_# Abfrage mit mehr als Zeichen eine automatische Platzhaltererweiterung durchgeführt wird. Mit anderen Worten, sp_e_2=5 gibt an, dass Wörter mit fünf oder mehr Zeichen in der Zeichenfolge der sp_q_2 Abfrage, wie "Abfrage"oder "Nummer", mit dem Platzhalterzeichen " * " erweitert werden sollten, wodurch die Suche einer Suche nach "Abfrage*"oder "Nummer*"entspricht. Wörter mit weniger Zeichen werden nicht erweitert, sodass eine Suche nach "Wort"in sp_q_2 keine automatische Platzhaltererweiterung hätte.
12
sp_end_day, sp_end_month, sp_end_year
sp_end_day= number ,sp_end_month= number , sp_end_year= number
Dieses Wertetriplet gibt den Enddatumsbereich für die Suche an und muss als Satz angegeben werden.
13
sp_f
sp_f= string
Gibt den Zeichensatz der Parameterzeichenfolgen der Abfrage an (z. B. sp_q ). Diese Zeichenfolge muss immer mit dem Zeichensatz der Seite übereinstimmen, die das Suchformular enthält.
14
sp_field_table
sp_field_ table=table: field,field...
Definiert eine logische Datentabelle, die aus den angegebenen Feldern besteht. Beispielsweise würde eine Tabelle mit dem Namen "items"aus den Feldern "color", "size"und "price"wie folgt definiert:
sp_field_table=items:color,size,price
Logische Tabellen sind besonders hilfreich in Verbindung mit Feldern, in denen "Zulassungslisten"aktiviert ist (unter "Einstellungen" > " Metadaten" > " Definitionen" ). Alle CGI-Parameter und Vorlagen-Tags, die einen Feldnamen als Wert annehmen, können optional einen Tabellennamen gefolgt von einem ""angeben. vor dem Feldnamen (z. B. sp_x_1=tablename.fieldname ).
Wenn Sie beispielsweise nach Dokumenten suchen möchten, die ein oder mehrere rote Elemente in der Größe "groß"enthalten (wobei Elemente als parallele Zeilen mit Metadaten dargestellt werden), können Sie Folgendes verwenden:
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">

Ein typisches Beispiel für die Verwendung von CGI-Parametern für die Backend-Suche

Über den folgenden Link wird eine Suche mit "Music"als Abfrage der Suche Beginn und alle Standardparameter verwendet. Beachten Sie, dass die URL zur Lesbarkeit auf zwei Zeilen aufgeteilt ist. In Ihrem HTML-Code sollte sich dieser Link alle in einer Zeile befinden.
<a href="https://search.atomz.com/search/?sp_q=Music&sp_a=sp99999999"> 
Testing...</a>

Dieselben Funktionen werden typischerweise mit einem Formular definiert:
<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>

Normalerweise sollten Sie beim Starten einer Suche Standardparameter verwenden. Auf diese Weise wird die erste Seite angezeigt, sortiert nach Relevanz, und der Kunde kann andere Seiten und andere Optionen auswählen. Wenn das Suchformular auf Ihrer Site Optionen für Sammlungen enthält, geben Sie den Sammlungsnamen als Parameter an.

Ein detailliertes Beispiel für die Verwendung von CGI-Parametern für die Backend-Suche

Die folgenden Formular-Abfragen zeigen die 25 Ergebnisse, die mit dem Ergebnis beginnen 10 . Zusammenfassungen werden nicht angezeigt, die Sortierreihenfolge ist nach Datum geordnet und die Sammlung mit dem Namen support wird verwendet. Es werden nur Dokumente zurückgegeben, die innerhalb der letzten 30 Tage datiert wurden.
<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>