Method: cse.siterestrict.list

Muestra metadatos sobre la búsqueda realizada, los metadatos del motor utilizado para la búsqueda y los resultados. Usa un conjunto pequeño de patrones de URL.

Solicitud HTTP

GET https://customsearch.googleapis.com/customsearch/v1/siterestrict

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de consulta

Parámetros
c2coff

string

Habilita o inhabilita la Búsqueda en chino tradicional y simplificado.

El valor predeterminado de este parámetro es 0 (cero), lo que significa que la función está habilitada. Los valores admitidos son los que se detallan a continuación:

  • 1: Inhabilitado

  • 0: Habilitado (predeterminado)

cr

string

Restringe los resultados de la búsqueda a los documentos que se originan en un país en particular. Puedes usar operadores booleanos en el valor del parámetro cr.

Para determinar el país de un documento, la Búsqueda de Google analiza lo siguiente:

  • El dominio de nivel superior (TLD) de la URL del documento

  • la ubicación geográfica de la dirección IP del servidor web

Consulta la página Valores de parámetros de país a fin de obtener una lista de valores válidos para este parámetro.

cx

string

El ID del Motor de Búsqueda Programable que se usará en esta solicitud.

dateRestrict

string

Restringe los resultados a las URLs según la fecha. Entre los valores admitidos, se incluyen los siguientes:

  • d[number]: Solicita resultados de la cantidad especificada de días anteriores.

  • w[number]: Solicita resultados de la cantidad especificada de semanas anteriores.

  • m[number]: Solicita resultados de la cantidad especificada de meses anteriores.

  • y[number]: Solicita resultados de la cantidad especificada de años anteriores.

exactTerms

string

Identifica una frase que deben contener todos los documentos de los resultados de búsqueda.

excludeTerms

string

Identifica una palabra o frase que no debería aparecer en ningún documento de los resultados de la búsqueda.

fileType

string

Restringe los resultados a los archivos de una extensión especificada. Puedes encontrar una lista de los tipos de archivos indexables por Google en el Centro de ayuda de Search Console.

filter

string

Controla la activación o desactivación del filtro de contenido duplicado.

  • Consulta Filtrado automático para obtener más información acerca de los filtros de resultados de búsqueda de Google. Ten en cuenta que el filtrado de agrupamiento del host se aplica solo a las búsquedas de varios sitios.

  • De forma predeterminada, Google filtra todos los resultados de la búsqueda para mejorar su calidad.

Los valores aceptables son:

  • 0: Desactiva el filtro de contenido duplicado.

  • 1: Activa el filtro de contenido duplicado.

gl

string

Ubicación geográfica del usuario final

  • El valor del parámetro gl es un código de país de dos letras. El parámetro gl potencia los resultados de la búsqueda cuyo país de origen coincide con el valor del parámetro. Consulta la página Códigos de país para obtener una lista de los valores válidos.

  • Especificar un valor del parámetro gl debería generar resultados más relevantes. Esto se aplica especialmente a los clientes internacionales y, más específicamente, a los clientes de países de habla inglesa que no sean Estados Unidos.

googlehost

string

Obsoleto.. Usa el parámetro gl para obtener un efecto similar.

Indica el dominio local de Google (por ejemplo, google.com, google.de o google.fr) que se usará para realizar la búsqueda.

highRange

string

Especifica el valor final de un rango de búsqueda.

  • Usa lowRange y highRange para agregar un rango de búsqueda inclusivo de lowRange...highRange a la consulta.
hl

string

Establece el idioma de la interfaz de usuario.

hq

string

Agrega los términos especificados a la consulta, como si se combinaran con un operador lógico AND.

imgColorType

enum (ImgColorType)

Muestra imágenes en blanco y negro, en escala de grises, transparentes o en color. Los valores aceptables son:

  • "color"

  • "gray"

  • "mono": blanco y negro

  • "trans": fondo transparente

imgDominantColor

enum (ImgDominantColor)

Muestra imágenes de un color dominante específico. Los valores aceptables son:

  • "black"

  • "blue"

  • "brown"

  • "gray"

  • "green"

  • "orange"

  • "pink"

  • "purple"

  • "red"

  • "teal"

  • "white"

  • "yellow"

imgSize

enum (ImgSize)

Muestra imágenes de un tamaño especificado. Los valores aceptables son:

  • "huge"

  • "icon"

  • "large"

  • "medium"

  • "small"

  • "xlarge"

  • "xxlarge"

imgType

enum (ImgType)

Muestra imágenes de un tipo. Los valores aceptables son:

  • "clipart"

  • "face"

  • "lineart"

  • "stock"

  • "photo"

  • "animated"

lowRange

string

Especifica el valor inicial para un rango de búsqueda. Usa lowRange y highRange para agregar un rango de búsqueda inclusivo de lowRange...highRange a la consulta.

lr

string

Restringe la búsqueda a los documentos escritos en un idioma en particular (p.ej., lr=lang_ja).

Los valores aceptables son:

  • "lang_ar": Árabe

  • "lang_bg": Búlgaro

  • "lang_ca": Catalán

  • "lang_cs": Checo

  • "lang_da": Danés

  • "lang_de": Alemán

  • "lang_el": Griego

  • "lang_en": inglés

  • "lang_es": Español

  • "lang_et": Estonio

  • "lang_fi": Finés

  • "lang_fr": Francés

  • "lang_hr": Croata

  • "lang_hu": Húngaro

  • "lang_id": Indonesio

  • "lang_is": Islandés

  • "lang_it": Italiano

  • "lang_iw": Hebreo

  • "lang_ja": Japonés

  • "lang_ko": Coreano

  • "lang_lt": Lituano

  • "lang_lv": Letón

  • "lang_nl": Holandés

  • "lang_no": Noruego

  • "lang_pl":

  • "lang_pt": portugués

  • "lang_ro": Rumano

  • "lang_ru": Ruso

  • "lang_sk": Eslovaco

  • "lang_sl": Esloveno

  • "lang_sr": Serbio

  • "lang_sv": Sueco

  • "lang_tr": Turco

  • "lang_zh-CN": Chino (simplificado)

  • "lang_zh-TW": Chino (tradicional)

num

integer

Cantidad de resultados de la búsqueda que se mostrarán.

  • Los valores válidos son números enteros entre 1 y 10, inclusive.
orTerms

string

Proporciona términos de búsqueda adicionales para buscar en un documento, en el que cada documento de los resultados de la búsqueda debe contener al menos uno de los términos de búsqueda adicionales.

q

string

Consulta

relatedSite
(deprecated)

string

Ya no está disponible.

rights

string

Filtros basados en licencias. Entre los valores admitidos, se incluyen cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived y combinaciones de estos. Consulta las combinaciones típicas.

safe

enum (Safe)

Nivel de seguridad de búsqueda. Los valores aceptables son:

  • "active": Habilita el filtro SafeSearch.

  • "off": Inhabilita el filtro SafeSearch. (predeterminado)

searchType

enum (SearchType)

Especifica el tipo de búsqueda: image. Si no se especifica, los resultados se limitan a páginas web.

Los valores aceptables son:

  • "image": búsqueda con imágenes personalizadas
siteSearchFilter

enum (SiteSearchFilter)

Controla si se incluyen o se excluyen resultados del sitio que se menciona en el parámetro siteSearch.

Los valores aceptables son:

  • "e": excluir

  • "i": incluir

sort

string

La expresión de orden que se aplica a los resultados. El parámetro ordenar especifica que los resultados se ordenarán de acuerdo con la expresión especificada, es decir, se ordenarán por fecha. Ejemplo: sort=date.

start

integer (uint32 format)

El índice del primer resultado que se muestra. La cantidad predeterminada de resultados por página es 10, por lo que &start=11 comenzará en la parte superior de la segunda página de resultados. Nota: La API de JSON nunca mostrará más de 100 resultados, incluso si más de 100 documentos coinciden con la consulta, por lo que establecer la suma de start + num en un número superior a 100 producirá un error. Además, ten en cuenta que el valor máximo de num es 10.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Search.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/cse

Para obtener más información, consulta la Descripción general de OAuth 2.0.