Parametri CGI

Parametri CGI

Cerca parametri CGI

Il codice del modulo di ricerca viene fornito per copiare e incollare nell’HTML del sito ( Design > Auto-Complete > Form Source).

Vedere Copia del codice HTML del modulo di ricerca in….

È inoltre possibile impostare i parametri elencati nel modulo di ricerca stesso o da uno script. Oltre ai parametri elencati di seguito è possibile utilizzare i parametri di ricerca di back-end per controllare la ricerca.

Consulta Parametri CGI di ricerca back-end.

Le richieste di ricerca sono costituite da un URL di base. L’URL di base indica l’account ricercato dal cliente e un set di parametri CGI (coppie chiave-valore) che indicano come restituire i risultati di ricerca desiderati per l’account associato.

L’URL di base è associato a un account specifico e a un ambiente in staging o live. Puoi richiedere più alias per l'URL di base dal tuo account manager. Ad esempio, una società chiamata Megacorp può avere due URL di base associati al suo account: https://search.megacorp.com e https://stage.megacorp.com. L’URL precedente cerca il loro indice live e l’URL successivo cerca il loro indice di staging.

Sono supportati tre formati di parametri CGI. Per impostazione predefinita, il tuo account è configurato per separare i parametri CGI con un punto e virgola come nell’esempio seguente:

https://search.megacorp.com?q=shoes;page=2

Se lo desideri, puoi chiedere al tuo account manager di configurare il tuo account in modo che utilizzi il e commerciale per separare i parametri CGI come nell'esempio seguente:

https://search.megacorp.com?q=shoes&page=2

È inoltre supportato un terzo formato, denominato formato SEO, in cui viene utilizzata una barra / al posto del separatore e un segno di uguale come nell’esempio seguente:

https://search.megacorp.com/q/shoes/page/2

Ogni volta che il formato SEO viene utilizzato per inviare una richiesta, tutti i collegamenti di output vengono restituiti nello stesso formato.

Parametro di ricerca guidato Esempio Descrizione
q q=string Specifica la stringa di query per la ricerca. Questo parametro viene mappato sul parametro di ricerca di back-end sp_q . Consulta Parametri CGI di ricerca back-end.
q# q#=string L’impostazione della faccia (ricerca all’interno di un dato campo) viene eseguita tramite i parametri q e x numerati. Il parametro q definisce il termine che stai cercando nel facet come indicato dal parametro x corrispondente.
Ad esempio, se hai due facet denominati dimensione e colore, puoi avere qualcosa come q1=small;x1=size;q2=red;x2=color. Questo parametro viene mappato sui parametri di ricerca di back-end sp_q_exact_# .
Consulta Parametri CGI di ricerca back-end.
x# q#=string L’impostazione della faccia (ricerca all’interno di un dato campo) viene eseguita tramite i parametri q e x numerati. Il parametro q definisce il termine che stai cercando nel facet come indicato dal parametro x corrispondente.
Ad esempio, se hai due facet denominati dimensione e colore, puoi avere qualcosa come q1=small;x1=size;q2=red;x2=color. Questo parametro viene mappato sui parametri di ricerca di back-end sp_x_# .
Consulta Parametri CGI di ricerca back-end.
raccolta collection=string Specifica la raccolta da utilizzare per la ricerca. Questo parametro viene mappato sul parametro di ricerca di back-end sp_k . Consulta Parametri CGI di ricerca back-end.
count count=number Specifica il conteggio totale dei risultati visualizzati. Il valore predefinito è definito in Settings > Searching > Searches. . Questo parametro viene mappato sul parametro di ricerca di back-end sp_c . Consulta Parametri CGI di ricerca back-end.
page page=number Specifica la pagina dei risultati restituiti.
rango rank=field Specifica il campo di classificazione da utilizzare per la classificazione statica. Il campo deve essere un campo di tipo Rank con rilevanza superiore a 0. Questo parametro viene mappato sul parametro di backend sp_sr . Consulta Parametri CGI di ricerca back-end.
sort sort=number Specifica l'ordinamento.
"0" è l’impostazione predefinita e ordinata in base al punteggio di pertinenza; "1" ordinamenti per data; "-1" non effettua l'ordinamento. Gli utenti possono specificare un nome di campo per il valore del parametro sp_s . Ad esempio, sp_s=title ordina i risultati in base ai valori contenuti nel campo titolo. Quando un nome di campo viene utilizzato per il valore di un parametro sp_s, i risultati vengono ordinati in base a tale campo e quindi suddivisi per rilevanza. Per abilitare questa funzione, fai clic su Settings > Metadata > Definitions. Nella pagina Definizioni fare clic su Add New Field o fare clic su Edit per un nome di campo specifico. Nell’elenco a discesa Sorting , seleziona Ascending o Descending. Questo parametro viene mappato sul parametro di ricerca di back-end sp_s .
Consulta [Parametri CGI di ricerca back-end].(/docs/search-promote/using/appendices/c-cgiparameters.html?lang=it#reference_582E85C3886740C98FE88CA9DF7918E8).

Parametri CGI di ricerca back-end

In genere i clienti interagiscono con un livello di presentazione denominato Ricerca guidata. Tuttavia, è teoricamente possibile saltare il livello di ricerca guidata e interagire con la ricerca di base di back-end direttamente utilizzando i parametri CGI descritti in questa pagina.

Puoi selezionare i parametri CGI di ricerca back-end nella tabella seguente:

Supporto di singole query

Supporto di più query

Esempi

Descrizione

1

sp_a

sp_a= string

Specifica la stringa del numero di account. Questo parametro è obbligatorio e deve essere una stringa di numero di account valida. Puoi trovare la stringa del numero di account in Impostazioni > Opzioni account > Impostazioni account .

2

sp_advanced

sp_advanced= 0 or 1

Se sp_advanced=1 viene inviato con una query, per il modulo di ricerca viene utilizzato tutto il codice compreso tra il tag <search-if-advanced> e il tag </search-if-advanced> nel modello di ricerca. Tutto il codice compreso tra il tag <search-if-not-advanced> e il tag </search-if-not-advanced> viene ignorato. Se viene inviato sp_advanced=0 (o qualsiasi altro valore), il blocco del modello <search-if-advanced> viene ignorato e viene utilizzato il blocco del modello <search-if-not-advanced> .

3

sp_c

sp_c= number

Specifica il conteggio totale dei risultati da visualizzare. Il valore predefinito è 10.

4

sp_context_field

sp_context_field= field

Raccoglie informazioni contestuali per il campo specificato. Le informazioni raccolte vengono inviate nei risultati della ricerca tramite il tag modello <search-context> . Il valore predefinito è body .

5

sp_d

sp_d= type

Specifica il tipo di intervallo di date da eseguire. I valori possibili per il tipo sono any, il che significa che non esegue ricerche nell’intervallo di date, custom, che indica che il valore di sp_date_range deve essere utilizzato per determinare le date da cercare, e specifici, che indica che i valori in sp_start_day , sp_start_month , sp_start_year , sp_end_day , sp_end_month e sp_end_year vengono utilizzati per determinare l’intervallo di date da cercare. sp_d è richiesto solo se il modulo di ricerca contiene l’opzione per eseguire ricerche in base a un intervallo personalizzato (tramite sp_date_range ) o in base a un intervallo di date di inizio e fine specifico.

6

sp_d_#

sp_d_#= type

Specifica il tipo di intervallo di date da eseguire per la query sp_q_# corrispondente. Il "#" viene sostituito da un numero compreso tra 1 e 16 (ad esempio, sp_d_8 , si applica alla query numerata sp_q_8 ).

È possibile impostare type su qualsiasi, il che significa che non esegue ricerche per intervalli di date, personalizzato, che indica che il valore di sp_date_range_# viene utilizzato per determinare le date da cercare, e specifico, che indica che i valori in sp_q_min_day_# , sp_q_min_month_# , sp_q_min_year_# , sp_q_max_day_# , sp_q_max_month_# e sp_q_max_year_# devono essere utilizzati per determinare l’intervallo di date. L’utilizzo di sp_d_# è richiesto solo se il modulo di ricerca contiene l’opzione per la ricerca in base a un intervallo personalizzato (tramite sp_date_range_# ) o in base a un intervallo di date di inizio e fine specifico.

7

sp_date_range

sp_date_range= number

Specifica un intervallo di date predefinito da applicare alla ricerca. Valori maggiori o uguali a zero specificano il numero di giorni da cercare prima della data odierna — ad esempio, un valore di "0" specifica "oggi", un valore di "1" specifica "oggi e ieri", un valore di "30" specifica "entro gli ultimi 30 giorni" e così via.

I valori inferiori a zero specificano un intervallo personalizzato come segue:

-1 = "None", come se non si specificasse alcun intervallo di date.

-2 = "Questa settimana", che cerca da domenica a sabato della settimana corrente.

-3 = "Ultima settimana", che cerca da domenica a sabato della settimana precedente alla settimana corrente.

-4 = "Questo mese", che cerca le date entro il mese corrente.

-5 = "Ultimo mese", che esegue una ricerca nelle date entro il mese precedente il mese corrente.

-6 = "Quest'anno", che cerca le date entro l'anno corrente.

-7 = "Ultimo anno", che cerca le date entro l'anno precedente l'anno corrente.

8

sp_date_range_#

sp_date_range_#= number

Specifica un intervallo di date predefinito da applicare alla query sp_q_# corrispondente. Il "#" viene sostituito da un numero compreso tra 1 e 16 (ad esempio, sp_date_range_8 , si applica alla query numerata sp_q_8 ).

Valori maggiori o uguali a zero specificano il numero di giorni in cui eseguire la ricerca prima della data odierna. Ad esempio, un valore pari a 0 specifica oggi; un valore pari a 1 indica oggi e ieri; un valore di 30 specifica negli ultimi 30 giorni e così via.

I valori inferiori a zero specificano un intervallo personalizzato come segue:

-1 = "None", come se non si specificasse alcun intervallo di date.

-2 = "Questa settimana", che cerca da domenica a sabato della settimana corrente.

-3 = "Ultima settimana", che cerca da domenica a sabato della settimana precedente alla settimana corrente.

-4 = "Questo mese", che cerca le date entro il mese corrente.

-5 = "Ultimo mese", che esegue una ricerca nelle date entro il mese precedente il mese corrente.

-6 = "Quest'anno", che cerca le date entro l'anno corrente.

-7 = "Ultimo anno", che cerca le date entro l'anno precedente l'anno corrente.

9

sp_dedupe_field

sp_dedupe_field= fieldname

Specifica un singolo campo su cui duplicare i risultati della ricerca. Tutti i risultati duplicati in quel campo vengono rimossi dai risultati della ricerca. Ad esempio, se per sp_dedupe_field=title nei risultati di ricerca viene visualizzato solo il risultato superiore per un determinato titolo (nessun risultato avrà lo stesso contenuto del campo titolo). Per i campi di tipo con più valori (ad elenco consentiti), per il confronto viene utilizzato l’intero contenuto del campo. È possibile specificare un solo campo. Un "qualificatore tabella" non è consentito nel nome del campo.

10

sp_e

sp_e= number

Specifica che l'espansione automatica dei caratteri jolly deve essere eseguita per qualsiasi parola della stringa query con più di caratteri numerici. In altre parole, sp_e=5 specifica che le parole con 5 o più caratteri, come "query" o "number", devono essere espanse con il carattere jolly '*', rendendo la ricerca equivalente a una ricerca per "query*" o "number*". Le parole con un numero inferiore di caratteri non vengono espanse, pertanto la ricerca di "parola" non avrebbe un’espansione automatica dei caratteri jolly.

11

sp_e_#

sp_e_#= number

Specifica che l'espansione automatica dei caratteri jolly ha luogo per qualsiasi parola della stringa di query sp_q_# corrispondente con più di caratteri numerici. In altre parole, sp_e_2=5 specifica che le parole con cinque o più caratteri nella stringa di query sp_q_2 , come "query" o "number", devono essere espanse con il carattere jolly ' * ', rendendo la ricerca equivalente a una ricerca per "query*" o "number*". Le parole con un numero inferiore di caratteri non vengono espanse, pertanto la ricerca di "parola" in sp_q_2 non avrebbe un’espansione automatica dei caratteri jolly.

12

sp_end_day, sp_end_month, sp_end_year

sp_end_day= number,sp_end_month= number, sp_end_year= number

Questo triplo di valori specifica l’intervallo di date di fine della ricerca e deve essere fornito come set.

13

sp_f

sp_f= string

Specifica il set di caratteri delle stringhe del parametro di query (ad esempio sp_q ). Questa stringa deve sempre corrispondere al set di caratteri della pagina contenente il modulo di ricerca.

14

sp_field_table

sp_field_ table=table: field,field...

Definisce una tabella di dati logica costituita dai campi specificati. Ad esempio, una tabella denominata "elementi" costituita dai campi "colore", "dimensione" e "prezzo" verrebbe definita come segue:

sp_field_table=items:color,size,price

Le tabelle logiche sono più utili in combinazione con i campi che hanno selezionato "Elenchi consentiti" (in Impostazioni > Metadati > Definizioni ). Tutti i parametri CGI e i tag modello che utilizzano un nome di campo come valore possono facoltativamente specificare un nome di tabella seguito da un "". prima del nome del campo (ad esempio, sp_x_1=tablename.fieldname ).

Ad esempio, per eseguire una ricerca per i documenti che contengono uno o più elementi "rossi" di dimensioni "grandi" (dove gli elementi sono rappresentati come righe parallele di metadati), è possibile utilizzare quanto segue:

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">

Esempio tipico di utilizzo dei parametri CGI di ricerca back-end

Le seguenti query di collegamento avviano una ricerca utilizzando "Musica" come query di ricerca e utilizzano tutti i parametri predefiniti. Per garantire la leggibilità, l’URL è suddiviso in due righe. Nel tuo HTML, questo collegamento dovrebbe essere tutti su una riga.

<a href="https://search.atomz.com/search/?sp_q=Music&sp_a=sp99999999"> 
Testing...</a>

La stessa funzionalità è definita più in genere con un modulo:

<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>

In genere, quando si avvia una ricerca è consigliabile utilizzare i parametri predefiniti. In questo modo, viene visualizzata la prima pagina, ordinata in base alla pertinenza, e consente al cliente di scegliere altre pagine e altre opzioni. Se il modulo di ricerca sul sito include opzioni per le raccolte, passa il nome della raccolta come parametro.

Un esempio dettagliato sull'utilizzo dei parametri CGI di ricerca back-end

Le seguenti query del modulo visualizzano i risultati 25 a partire dal risultato 10. I riepiloghi non vengono visualizzati, l’ordinamento è in base alla data e viene utilizzata la raccolta denominata support. Vengono restituiti solo i documenti datati negli ultimi 30 giorni.

<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>

In questa pagina