Show Menu
SUJETS×

Paramètres CGI

Paramètres CGI

Paramètres CGI de recherche

Le code du formulaire de recherche est fourni et vous pouvez le copier et le coller dans le code HTML de votre site ( Design > Auto-Complete > Form Source ).
Vous pouvez également définir les paramètres répertoriés dans le formulaire de recherche lui-même ou à partir d’un script. Outre les paramètres répertoriés ci-dessous, vous pouvez également utiliser les paramètres de recherche d’arrière-plan pour contrôler la recherche.
Voir Paramètres CGI de recherche dorsale.
Les requêtes de recherche se composent d’une URL de base. L’URL de base indique le compte que le client recherche et un ensemble de paramètres CGI (paires clé-valeur) qui indiquent comment renvoyer les résultats de recherche souhaités pour le compte associé.
L’URL de base est associée à un compte spécifique et à un environnement intermédiaire ou actif. Vous pouvez demander plusieurs alias pour l’URL de base à votre gestionnaire de compte. Par exemple, une société appelée Megacorp peut avoir deux URL de base associées à son compte : https://search.megacorp.com et https://stage.megacorp.com . La première URL recherche leur index actif et la seconde l’index intermédiaire.
Trois formats de paramètres CGI sont pris en charge. Par défaut, votre compte est configuré pour séparer les paramètres CGI par un point-virgule, comme dans l’exemple suivant :
https://search.megacorp.com?q=shoes;page=2
Si vous préférez, votre gestionnaire de compte peut configurer votre compte pour qu’il utilise des esperluettes afin de séparer les paramètres CGI, comme dans l’exemple suivant :
https://search.megacorp.com?q=shoes&page=2
Un troisième format, appelé format d’optimisation du référencement, est également pris en charge lorsqu’une barre oblique / est utilisée à la place du séparateur et du signe égal, comme dans l’exemple suivant :
https://search.megacorp.com/q/shoes/page/2
Chaque fois que le format d’optimisation du référencement est utilisé pour envoyer une requête, tous les liens de sortie sont renvoyés au même format.
Paramètre de recherche guidée
Exemple
Description
q
q=string
Indique la chaîne de requête pour la recherche. Ce paramètre correspond au paramètre de recherche principal. sp_q Voir Paramètres CGI de recherche dorsale.
q#
q#=string
Le facettage (recherche dans un champ donné) se fait au moyen des paramètres q et x numérotés. Le paramètre q définit le terme que vous recherchez dans la facette, comme indiqué par le paramètre x numéroté correspondant.
Par exemple, si vous avez deux facettes nommées taille et couleur, vous pouvez avoir un élément du type q1=small;x1=size;q2=red;x2=color. Ce paramètre correspond aux paramètres de recherche sp_q_exact_# principaux.
Voir Paramètres CGI de recherche dorsale.
x#
q#=string
Le facettage (recherche dans un champ donné) se fait au moyen des paramètres q et x numérotés. Le paramètre q définit le terme que vous recherchez dans la facette, comme indiqué par le paramètre x numéroté correspondant.
Par exemple, si vous avez deux facettes nommées taille et couleur, vous pouvez avoir un élément du type q1=small;x1=size;q2=red;x2=color. Ce paramètre correspond aux paramètres de recherche sp_x_# principaux.
Voir Paramètres CGI de recherche dorsale.
collecte
collection=string
Indique la collection à utiliser pour la recherche. Ce paramètre correspond au paramètre de recherche principal. sp_k Voir Paramètres CGI de recherche dorsale.
count
count=number
Indique le nombre total de résultats affichés. La valeur par défaut est définie dans Settings > Searching > Searches. . Ce paramètre correspond au paramètre de recherche principal. sp_c Voir Paramètres CGI de recherche dorsale.
page
page=number
Indique la page des résultats qui sont renvoyés.
rang
rank=field
Indique le champ de classement à utiliser pour le classement statique. Le champ doit être un champ de type Classement dont la pertinence est supérieure à 0. Ce paramètre correspond au paramètre sp_sr principal. Voir Paramètres CGI de recherche dorsale.
sort
sort=number
Indique l’ordre de tri.
"0" est la valeur par défaut et est triée par score de pertinence ; "1" est classé par date ; "-1" n’est pas trié. Les utilisateurs peuvent spécifier un nom de champ pour la valeur du sp_s paramètre. Par exemple, sp_s=title trie les résultats en fonction des valeurs contenues dans le champ de titre. Lorsqu’un nom de champ est utilisé pour la valeur d’un sp_s paramètre, les résultats sont triés par ce champ, puis subtriés par pertinence. To enable this feature, click Settings > Metadata > Definitions. Dans la page Définitions, cliquez sur Add New Field ou sur Edit un nom de champ particulier. Dans la liste Sorting déroulante, sélectionnez Ascending ou Descending. Ce paramètre correspond au paramètre de recherche principal. sp_s
Voir Paramètres #dorsale.(../c-appendices/c-cgiparameters.md#reference_582E85C3886740C98FE88CA9DF7918E8).

Paramètres CGI de recherche en arrière-plan

En règle générale, les clients interagissent avec une couche de présentation appelée Recherche guidée. Cependant, il est théoriquement possible d’ignorer le calque Recherche guidée et d’interagir avec la recherche principale principale en utilisant directement les paramètres CGI décrits sur cette page.
Vous pouvez sélectionner les paramètres CGI de recherche principale dans le tableau suivant :
Prise en charge d’une seule requête
Prise en charge de plusieurs requêtes
Exemples
Description
1
sp_a
sp_a= string
Indique la chaîne du numéro de compte. Ce paramètre est obligatoire et doit être une chaîne de numéro de compte valide. Vous pouvez trouver la chaîne de votre numéro de compte sous Paramètres > Options de compte > Paramètres du compte .
2
sp_advanced
sp_advanced= 0 or 1
Si sp_advanced=1 est envoyé avec une requête, tout le code entre la <search-if-advanced> balise et la </search-if-advanced> balise dans le modèle de recherche est utilisé pour le formulaire de recherche. Tout le code entre la <search-if-not-advanced> balise et la </search-if-not-advanced> balise est ignoré. Si sp_advanced=0 (ou toute autre valeur) est envoyée, le bloc de modèle <search-if-advanced> est ignoré et le bloc de modèle <search-if-not-advanced> est utilisé.
3
sp_c
sp_c= number
Indique le nombre total de résultats à afficher. La valeur par défaut est de 10.
4
sp_context_field
sp_context_field= field
Collecte des informations contextuelles pour le champ donné. Les informations collectées sont générées dans les résultats de la recherche par le biais de la balise de <search-context> modèle. La valeur par défaut est body .
5
sp_d
sp_d= type
Indique le type de plage de dates à effectuer lors de la recherche. Les valeurs possibles pour le type sont toutes, ce qui signifie ne pas effectuer de recherche de plage de dates, personnalisées, ce qui indique que la valeur de sp_date_range doit être utilisée pour déterminer les dates à rechercher, et spécifiques, ce qui indique que les valeurs dans sp_start_day , sp_start_month , sp_start_year , sp_end_day , sp_end_month et sp_end_year est utilisé pour déterminer la plage de dates à rechercher. sp_d n’est requise que si votre formulaire de recherche contient l’option de recherche selon une plage personnalisée (par exemple sp_date_range ) ou selon un début et une plage de dates de fin spécifiques.
6
sp_d_#
sp_d_#= type
Indique le type de plage de dates à effectuer pour la sp_q_# requête correspondante. Le "#" est remplacé par un nombre compris entre 1 et 16 (par exemple, sp_d_8 s’applique à la requête numérotée sp_q_8 ).
Vous pouvez définir type sur n’importe quelle valeur, ce qui signifie qu’il n’est pas nécessaire d’effectuer une recherche de plage de dates, personnalisée, ce qui indique que la valeur de sp_date_range_# est utilisée pour déterminer les dates à rechercher, et spécifique, ce qui indique que les valeurs sp_q_min_day_# , sp_q_min_month_# sp_q_min_year_# , sp_q_max_day_# sp_q_max_month_# et doivent être utilisées pour déterminer la plage de dates. sp_q_max_year_# L’utilisation de sp_d_# est obligatoire uniquement si votre formulaire de recherche contient l’option de recherche selon une plage personnalisée (par sp_date_range_# exemple) ou selon un début et une plage de dates de fin spécifiques.
7
sp_date_range
sp_date_range= number
Spécifie une plage de dates prédéfinie à appliquer à la recherche. Les valeurs supérieures ou égales à zéro spécifient le nombre de jours à rechercher avant aujourd’hui. Par exemple, la valeur "0" indique "aujourd’hui", la valeur "1" indique "aujourd’hui et hier", la valeur "30" indique "au cours des 30 derniers jours", etc.
Les valeurs inférieures à zéro définissent une plage personnalisée comme suit :
-1 = "Aucun", la même chose que de ne spécifier aucune plage de dates.
-2 = "Cette semaine", qui effectue une recherche du dimanche au samedi de la semaine en cours.
-3 = "Semaine dernière", qui effectue une recherche du dimanche au samedi de la semaine précédant la semaine en cours.
-4 = "Ce mois-ci", qui recherche les dates du mois en cours.
-5 = "Dernier mois", qui recherche les dates du mois précédant le mois en cours.
-6 = "Cette année", qui recherche les dates de l’année en cours.
-7 = "L’année dernière", qui recherche les dates de l’année précédant l’année en cours.
8
sp_date_range_#
sp_date_range_#= number
Spécifie une plage de dates prédéfinie à appliquer à la sp_q_# requête correspondante. Le "#" est remplacé par un nombre compris entre 1 et 16 (par exemple, sp_date_range_8 s’applique à la requête numérotée sp_q_8 ).
Les valeurs supérieures ou égales à zéro spécifient le nombre de jours de recherche avant aujourd’hui. Par exemple, une valeur de 0 indique aujourd’hui ; une valeur de 1 indique aujourd’hui et hier ; une valeur de 30 indique les 30 derniers jours, etc.
Les valeurs inférieures à zéro définissent une plage personnalisée comme suit :
-1 = "Aucun", la même chose que de ne spécifier aucune plage de dates.
-2 = "Cette semaine", qui effectue une recherche du dimanche au samedi de la semaine en cours.
-3 = "Semaine dernière", qui effectue une recherche du dimanche au samedi de la semaine précédant la semaine en cours.
-4 = "Ce mois-ci", qui recherche les dates du mois en cours.
-5 = "Dernier mois", qui recherche les dates du mois précédant le mois en cours.
-6 = "Cette année", qui recherche les dates de l’année en cours.
-7 = "L’année dernière", qui recherche les dates de l’année précédant l’année en cours.
9
sp_dedupe_field
sp_dedupe_field= fieldname
Indique un champ unique sur lequel dédupliquer les résultats de la recherche. Tous les résultats de duplicata de ce champ sont supprimés des résultats de la recherche. Par exemple, si, pour sp_dedupe_field=title un titre donné, seul le résultat supérieur s’affiche dans les résultats de la recherche (aucun des deux résultats n’a le même contenu de champ de titre). Pour les champs de type à plusieurs valeurs (liste autorisée), le contenu entier du champ est utilisé pour la comparaison. Un seul champ peut être spécifié. Un "qualificateur de table" n'est pas autorisé dans le nom du champ.
10
sp_e
sp_e= number
Indique que l’extension automatique des caractères génériques doit avoir lieu pour tout mot de la chaîne de requête contenant plus de plusieurs caractères numériques. En d’autres termes, sp_e=5 indique que les mots de 5 caractères ou plus, tels que "requête" ou "nombre", doivent être développés avec le caractère générique "*", ce qui rend la recherche équivalente à une recherche de "requête*" ou "nombre*". Les mots comportant moins de caractères ne sont pas développés, de sorte qu’une recherche de "mot" ne peut pas être automatiquement étendue.
11
sp_e_#
sp_e_#= number
Indique que l’extension automatique des caractères génériques a lieu pour tout mot de la chaîne de sp_q_# requête correspondante contenant plus de plusieurs caractères numériques. En d’autres termes, sp_e_2=5 indique que les mots contenant cinq caractères ou plus dans la chaîne de sp_q_2 requête, tels que "requête" ou "nombre", doivent être développés avec le caractère générique " * ", ce qui rend la recherche équivalente à une recherche de "requête*" ou "nombre*". Les mots comportant moins de caractères ne sont pas développés, de sorte qu’une recherche de "mot" dans sp_q_2 ne peut pas être automatiquement développée.
12
sp_end_day, sp_end_month, sp_end_year
sp_end_day= number ,sp_end_month= number , sp_end_year= number
Ce triplet de valeurs spécifie la plage de dates de fin de la recherche et doit être fourni sous forme de jeu.
13
sp_f
sp_f= string
Indique le jeu de caractères des chaînes de paramètres de requête (par exemple sp_q ). Cette chaîne doit toujours correspondre au jeu de caractères de la page qui contient le formulaire de recherche.
14
sp_field_table
sp_field_ table=table: field,field...
Définit un tableau de données logique composé des champs donnés. Par exemple, un tableau nommé "articles" composé des champs "couleur", "taille" et "prix" serait défini comme suit :
sp_field_table=items:color,size,price
Les tableaux logiques sont particulièrement utiles en conjonction avec les champs dont les "Listes autorisées" sont cochées (sous Paramètres > Métadonnées > Définitions ). Tous les paramètres CGI et les balises de modèle qui utilisent un nom de champ comme valeur peuvent éventuellement spécifier un nom de table suivi d’un "". avant le nom du champ (par exemple, sp_x_1=tablename.fieldname ).
Par exemple, pour rechercher des documents contenant un ou plusieurs éléments "rouges" de taille "large" (où les éléments sont représentés sous forme de lignes parallèles de métadonnées), vous pouvez utiliser les éléments suivants :
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">

Exemple typique d'utilisation des paramètres CGI de recherche principale

Les requêtes de liens suivantes début une recherche en utilisant "Musique" comme requête de recherche et utilisent tous les paramètres par défaut. Notez que l’URL est fractionnée sur deux lignes pour plus de lisibilité. Dans votre code HTML, ce lien doit tous se trouver sur une seule ligne.
<a href="https://search.atomz.com/search/?sp_q=Music&sp_a=sp99999999"> 
Testing...</a>

La même fonctionnalité est généralement définie avec un formulaire :
<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>

En règle générale, vous devez utiliser des paramètres par défaut lorsque vous lancez une recherche. Ainsi, la première page est affichée, triée par pertinence, et permet au client de choisir d'autres pages et d'autres options. Si le formulaire de recherche de votre site comporte des options pour les collections, transmettez le nom de la collection en tant que paramètre.

Exemple détaillé de l’utilisation des paramètres CGI de recherche principale

Les requêtes de formulaire suivantes affichent 25 les résultats en commençant par le résultat 10 . Les résumés ne s’affichent pas, l’ordre de tri est par date et la collection nommée support est utilisée. Seuls les documents datés au cours des 30 derniers jours sont renvoyés.
<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>