Parámetros CGI

Parámetros CGI

Buscar parámetros CGI

Se proporciona código de formulario de búsqueda que puede copiar y pegar en el HTML del sitio ( Design > Auto-Complete > Form Source).

Consulte Copia del código HTML del formulario de búsqueda en el….

También puede definir los parámetros que se enumeran en el propio formulario de búsqueda o desde una secuencia de comandos. Además de los parámetros que se enumeran a continuación, también puede utilizar los parámetros de búsqueda back-end para controlar la búsqueda.

Consulte Parámetros CGI de búsqueda back-end.

Las solicitudes de búsqueda constan de una dirección URL base. La dirección URL base indica qué cuenta está buscando el cliente y un conjunto de parámetros CGI (pares clave-valor) que indican cómo devolver los resultados de búsqueda deseados para la cuenta asociada.

La dirección URL base está asociada a una cuenta específica y a un entorno de ensayo o lanzamiento. El administrador de cuentas puede solicitar varios alias para la URL base. Por ejemplo, una empresa llamada Megacorp puede tener dos direcciones URL base asociadas a su cuenta: https://search.megacorp.com y https://stage.megacorp.com. La URL anterior busca su índice activo y la segunda URL busca su índice por etapas.

Se admiten tres formatos de parámetros CGI. De forma predeterminada, su cuenta está configurada para separar los parámetros CGI con un punto y coma, como en el siguiente ejemplo:

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

Si lo prefiere, puede hacer que su administrador de cuentas configure su cuenta para que utilice el símbolo & para separar los parámetros CGI como en el siguiente ejemplo:

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

También se admite un tercer formato, denominado formato SEO, en el que se utiliza una barra diagonal / en lugar del separador y el signo igual como en el siguiente ejemplo:

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

Cada vez que se utiliza el formato SEO para enviar una solicitud, todos los vínculos de salida se devuelven en el mismo formato.

Parámetro de búsqueda guiada Ejemplo Descripción
q q=string Especifica la cadena de consulta para la búsqueda. Este parámetro se asigna al parámetro de búsqueda back-end sp_q . Consulte Parámetros CGI de búsqueda back-end.
q# q#=string La faceta (búsqueda dentro de un campo determinado) se realiza mediante parámetros q y x numerados. El parámetro q define el término que está buscando en la faceta como se indica en el parámetro x numerado correspondiente.
Por ejemplo, si tiene dos facetas con nombres tamaño y color, puede tener algo como q1=pequeño;x1=tamaño;q2=rojo;x2=color. Este parámetro se asigna a los parámetros de búsqueda back-end sp_q_exact_#.
Consulte Parámetros CGI de búsqueda back-end.
x# q#=string La faceta (búsqueda dentro de un campo determinado) se realiza mediante parámetros q y x numerados. El parámetro q define el término que está buscando en la faceta como se indica en el parámetro x numerado correspondiente.
Por ejemplo, si tiene dos facetas con nombres tamaño y color, puede tener algo como q1=pequeño;x1=tamaño;q2=rojo;x2=color. Este parámetro se asigna a los parámetros de búsqueda back-end sp_x_#.
Consulte Parámetros CGI de búsqueda back-end.
colección collection=string Especifica la colección que se usará para la búsqueda. Este parámetro se asigna al parámetro de búsqueda back-end sp_k . Consulte Parámetros CGI de búsqueda back-end.
count count=number Especifica el recuento total de resultados que se muestran. El valor predeterminado se define en Settings > Searching > Searches. . Este parámetro se asigna al parámetro de búsqueda back-end sp_c . Consulte Parámetros CGI de búsqueda back-end.
página page=number Especifica la página de resultados que se devuelven.
rank rank=field Especifica el campo de clasificación que se utilizará para la clasificación estática. El campo debe ser un campo de tipo Clasificación con relevancia buena a 0. Este parámetro se asigna al parámetro back-end sp_sr . Consulte Parámetros CGI de búsqueda back-end.
sort sort=number Especifica el orden.
"0" es el valor predeterminado y se ordena por puntuación de relevancia; "1" se clasifica por fecha; "-1" no se ordena. Los usuarios pueden especificar un nombre de campo para el valor del parámetro sp_s. Por ejemplo, sp_s=title ordena los resultados según los valores contenidos en el campo de título. Cuando se utiliza un nombre de campo para el valor de un parámetro sp_s , los resultados se ordenan por ese campo y luego se subordenan por relevancia. Para habilitar esta función, haga clic en Settings > Metadata > Definitions. En la página Definiciones , haga clic Add New Field o haga clic Edit para un nombre de campo determinado. En la lista desplegable Sorting, seleccione Ascending o Descending. Este parámetro se asigna al parámetro de búsqueda back-end sp_s .
Consulte [Parámetros CGI de búsqueda back-end].(/docs/search-promote/using/appendices/c-cgiparameters.html?lang=es#reference_582E85C3886740C98FE88CA9DF7918E8).

Parámetros CGI de búsqueda back-end

Normalmente, los clientes interactúan con una capa de presentación denominada Búsqueda guiada. Sin embargo, teóricamente es posible omitir la capa Búsqueda guiada e interactuar con la búsqueda principal del servidor directamente utilizando los parámetros CGI que se describen en esta página.

Puede seleccionar parámetros CGI de búsqueda backend de la siguiente tabla:

Compatibilidad con una sola consulta

Compatibilidad con múltiples consultas

Ejemplos

Descripción

1

sp_a

sp_a= string

Especifica la cadena del número de cuenta. Este parámetro es obligatorio y debe ser una cadena de número de cuenta válida. Puede encontrar la cadena del número de cuenta en Configuración > Opciones de cuenta > Configuración de cuenta .

2

sp_advanced

sp_advanced= 0 or 1

Si sp_advanced=1 se envía con una consulta, todo el código entre la etiqueta <search-if-advanced> y la etiqueta </search-if-advanced> en la plantilla de búsqueda se utiliza para el formulario de búsqueda. Se ignorará todo el código entre la etiqueta <search-if-not-advanced> y la etiqueta </search-if-not-advanced> . Si se envía sp_advanced=0 (o cualquier otro valor), se ignora el bloque de plantilla <search-if-advanced> y se utiliza el bloque de plantilla <search-if-not-advanced> .

3

sp_c

sp_c= number

Especifica el recuento total de resultados que se van a mostrar. El valor predeterminado es 10.

4

sp_context_field

sp_context_field= field

Recopila información contextual para el campo dado. La información recopilada se muestra en los resultados de búsqueda mediante la etiqueta de plantilla <search-context> . El valor predeterminado es body .

5

sp_d

sp_d= type

Especifica el tipo de búsqueda de intervalo de fechas que se va a realizar. Los valores posibles de tipo son cualquiera, lo que significa que no realice búsquedas de intervalos de fechas, personalizadas, lo que indica que el valor de sp_date_range debe utilizarse para determinar las fechas de búsqueda y específicas, lo que indica que los valores de sp_start_day , sp_start_month , sp_start_year , sp_end_day , sp_end_month y sp_end_year se utilizan para determinar el intervalo de fechas que se buscará. sp_d solo es necesario si el formulario de búsqueda contiene la opción de buscar por un intervalo personalizado (a modo de sp_date_range ) o por un intervalo de fechas de inicio y finalización específico.

6

sp_d_#

sp_d_#= type

Especifica el tipo de intervalo de fechas que se busca para la consulta sp_q_# correspondiente. El "#" se sustituye por un número entre 1 y 16 (por ejemplo, sp_d_8 , se aplica a la consulta numerada sp_q_8 ).

Puede establecer type en cualquier, lo que significa que no realice búsquedas de intervalos de fechas personalizadas, lo que indica que el valor de sp_date_range_# se utiliza para determinar las fechas de búsqueda y específico, lo que indica que los valores de sp_q_min_day_# , sp_q_min_month_# , sp_q_min_year_# , sp_q_max_day_# , sp_q_max_month_# y sp_q_max_year_# deben utilizarse para determinar el intervalo de fechas. El uso de sp_d_# solo es necesario si el formulario de búsqueda contiene la opción de buscar por un intervalo personalizado (mediante sp_date_range_# ) o por un intervalo de fechas de inicio y finalización específico.

7

sp_date_range

sp_date_range= number

Especifica un intervalo de fechas predefinido que se aplicará a la búsqueda. Los valores buenos que son iguales o iguales a cero especifican el número de días que se buscarán antes de hoy; por ejemplo, un valor de "0" especifica "hoy", un valor de "1" especifica "hoy y ayer", un valor de "30" especifica "en los últimos 30 días", etc.

Los valores por debajo de cero especifican un intervalo personalizado de la siguiente manera:

-1 = "Ninguno", del mismo modo que se especifica sin intervalo de fechas.

-2 = "Esta semana", que busca de domingo a sábado de la semana actual.

-3 = "Última semana", que busca de domingo a sábado de la semana anterior a la semana actual.

-4 = "Este mes", que busca fechas dentro del mes actual.

-5 = "Último mes", que busca fechas dentro del mes anterior al mes actual.

-6 = "Este año", que busca fechas dentro del año actual.

-7 = "Último año", que busca fechas dentro del año anterior al año actual.

8

sp_date_range_#

sp_date_range_#= number

Especifica un intervalo de fechas predefinido para aplicar a la consulta sp_q_# correspondiente. El "#" se sustituye por un número entre 1 y 16 (por ejemplo, sp_date_range_8 , se aplica a la consulta numerada sp_q_8 ).

Los valores buenos o iguales a cero especifican la cantidad de días que se buscarán antes de hoy. Por ejemplo, un valor de 0 especifica hoy; un valor de 1 especifica hoy y ayer; un valor de 30 especifica en los últimos 30 días, etc.

Los valores por debajo de cero especifican un intervalo personalizado de la siguiente manera:

-1 = "Ninguno", del mismo modo que se especifica sin intervalo de fechas.

-2 = "Esta semana", que busca de domingo a sábado de la semana actual.

-3 = "Última semana", que busca de domingo a sábado de la semana anterior a la semana actual.

-4 = "Este mes", que busca fechas dentro del mes actual.

-5 = "Último mes", que busca fechas dentro del mes anterior al mes actual.

-6 = "Este año", que busca fechas dentro del año actual.

-7 = "Último año", que busca fechas dentro del año anterior al año actual.

9

sp_dedupe_field

sp_dedupe_field= fieldname

Especifica un solo campo en el que se van a desduplicar los resultados de búsqueda. Todos los resultados duplicados en ese campo se eliminan de los resultados de búsqueda. Por ejemplo, si para sp_dedupe_field=title , solo se muestra el resultado superior de un título determinado en los resultados de búsqueda (no hay dos resultados que tengan un contenido de campo de título idéntico). Para los campos de tipo multivalor (lista de permitidos), se utiliza todo el contenido del campo para la comparación. Solo se puede especificar un campo. No se permite un "calificador de tabla" en el nombre del campo.

10

sp_e

sp_e= number

Especifica que la expansión automática de caracteres comodín debe realizarse para cualquier palabra de la cadena de consulta con más de caracteres numéricos. En otras palabras, sp_e=5 especifica que las palabras con 5 o más caracteres, como "consulta" o "número", deben expandirse con el carácter comodín '*', lo que hace que la búsqueda sea equivalente a la búsqueda de "consulta*" o "número*". Las palabras con menos caracteres no se expanden, por lo que la búsqueda de "palabra" no tendría expansión automática de caracteres comodín.

11

sp_e_#

sp_e_#= number

Especifica que la expansión automática de caracteres comodín tiene lugar para cualquier palabra de la cadena de consulta sp_q_# correspondiente con más de caracteres numéricos. En otras palabras, sp_e_2=5 especifica que las palabras con cinco o más caracteres en la cadena de consulta sp_q_2 , como "consulta" o "número", deben expandirse con el carácter comodín ' * ', lo que hace que la búsqueda sea equivalente a la búsqueda de "consulta*" o "número*". Las palabras con menos caracteres no se expanden, por lo que una búsqueda de "palabra" en sp_q_2 no tendría expansión automática de comodín.

12

sp_end_day, sp_end_month, sp_end_year

sp_end_day= number,sp_end_month= number, sp_end_year= number

Este triplete de valores especifica el intervalo de fechas de finalización de la búsqueda y debe proporcionarse como un conjunto.

13

sp_f

sp_f= string

Especifica el conjunto de caracteres de las cadenas de parámetros de consulta (como sp_q ). Esta cadena siempre debe coincidir con el conjunto de caracteres de la página que contiene el formulario de búsqueda.

14

sp_field_table

sp_field_ table=table: field,field...

Define una tabla de datos lógica que consta de los campos dados. Por ejemplo, una tabla denominada "elementos" que consta de los campos "color", "tamaño" y "precio" se definiría de la siguiente manera:

sp_field_table=items:color,size,price

Las tablas lógicas son más útiles junto con los campos que tienen activada la opción "Listas de permitidos" (en Configuración > Metadatos > Definiciones ). Todos los parámetros de CGI y las etiquetas de plantilla que toman un nombre de campo como valor pueden especificar opcionalmente un nombre de tabla seguido de "." antes del nombre del campo (por ejemplo, sp_x_1=tablename.fieldname ).

Por ejemplo, para realizar una búsqueda de documentos que contengan uno o más elementos "rojos" de tamaño "grande" (donde los elementos se representan como filas paralelas de metadatos), puede utilizar lo siguiente:

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

Un ejemplo típico del uso de parámetros CGI de búsqueda back-end

Las siguientes consultas de vínculos inician una búsqueda utilizando "Música" como consulta de búsqueda y utilizan todos los parámetros predeterminados. Tenga en cuenta que la dirección URL está dividida en dos líneas para facilitar la lectura. En su HTML, este vínculo debe estar en una línea.

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

La misma funcionalidad se define más generalmente con un formulario:

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

Normalmente, se deben usar parámetros predeterminados al iniciar una búsqueda. De este modo, se muestra la primera página, se ordena por relevancia y permite al cliente elegir otras páginas y otras opciones. Si el formulario de búsqueda del sitio incluye opciones para las colecciones, pase el nombre de la colección como parámetro.

Un ejemplo detallado del uso de parámetros CGI de búsqueda back-end

Las siguientes consultas de formulario muestran 25 resultados que comienzan por el resultado 10. No se muestran los resúmenes, el criterio de ordenación es por fecha y se utiliza la colección denominada support. Solo se devuelven los documentos con fecha de los últimos 30 días.

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

En esta página