Method: cse.list

Retorna metadados sobre a pesquisa realizada, metadados sobre o mecanismo usado na pesquisa e os resultados da pesquisa.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de consulta

Parâmetros
c2coff

string

Ativa ou desativa a Pesquisa em chinês simplificado e tradicional.

O valor padrão desse parâmetro é 0 (zero), o que significa que o recurso está ativado. Os valores compatíveis são:

  • 1: desativado

  • 0: ativado (padrão)
cr

string

Restringe os resultados da pesquisa a documentos originários de um país específico. É possível usar operadores booleanos no valor do parâmetro "cr".

A Pesquisa Google determina o país de um documento analisando o seguinte:

  • o domínio de nível superior (TLD) do URL do documento

  • a localização geográfica do endereço IP do servidor da Web

Consulte a página Valores de parâmetros de país para ver uma lista de valores válidos para esse parâmetro.
cx

string

O ID do Mecanismo de Pesquisa Programável a ser usado na solicitação.
dateRestrict

string

Restringe os resultados a URLs com base na data. Os valores aceitos são:

  • d[number]: solicita resultados do número especificado de dias anteriores.

  • w[number]: solicita resultados do número especificado de semanas anteriores.

  • m[number]: solicita resultados do número especificado de meses anteriores.

  • y[number]: solicita resultados do número especificado de anos anteriores.
exactTerms

string

Identifica uma frase que todos os documentos nos resultados da pesquisa precisam conter.
excludeTerms

string

Identifica uma palavra ou frase que não deve aparecer em nenhum documento nos resultados da pesquisa.
fileType

string

Restringe os resultados a arquivos de uma extensão especificada. Uma lista dos tipos de arquivo indexáveis pelo Google pode ser encontrada na Central de Ajuda do Search Console.
filter

string

Controla a ativação ou desativação do filtro de conteúdo duplicado.

  • Consulte Filtragem automática para mais informações sobre os filtros de resultados da pesquisa do Google. A filtragem de agrupamento de hosts se aplica apenas a pesquisas em vários sites.

  • Por padrão, o Google aplica filtros a todos os resultados da pesquisa para melhorar a qualidade deles.

Os valores aceitos são:

  • 0: desativa o filtro de conteúdo duplicado.

  • 1: ativa o filtro de conteúdo duplicado.
gl

string

Geolocalização do usuário final.

  • O valor do parâmetro gl é um código do país com duas letras. O parâmetro gl otimiza os resultados da pesquisa cujo país de origem corresponde ao valor do parâmetro. Consulte uma lista de valores válidos na página Códigos de países.

  • A especificação de um valor de parâmetro gl deve gerar resultados mais relevantes. Isso se aplica especialmente a clientes internacionais e, de maneira ainda mais específica, aos clientes de países de língua inglesa que não sejam os Estados Unidos.
googlehost

string

Obsoleto. Use o parâmetro gl para um efeito semelhante.

O domínio local do Google (por exemplo, google.com.br, google.de ou google.fr) que será usado para realizar a pesquisa.
highRange

string

Especifica o valor final de um intervalo de pesquisa.

  • Use lowRange e highRange para anexar um intervalo de pesquisa inclusivo de lowRange...highRange à consulta.
hl

string

Define o idioma da interface do usuário.
hq

string

Anexa os termos de consulta especificados à consulta, como se eles fossem combinados com um operador lógico AND.
imgColorType

enum (ImgColorType)

Retorna imagens em preto e branco, em escala de cinza, transparentes ou coloridas. Os valores aceitos são:

  • "color"

  • "gray"

  • "mono": preto e branco

  • "trans": plano de fundo transparente
imgDominantColor

enum (ImgDominantColor)

Retorna imagens de uma cor dominante específica. Os valores aceitos são:

  • "black"

  • "blue"

  • "brown"

  • "gray"

  • "green"

  • "orange"

  • "pink"

  • "purple"

  • "red"

  • "teal"

  • "white"

  • "yellow"
imgSize

enum (ImgSize)

Retorna imagens de um tamanho especificado. Os valores aceitos são:

  • "huge"

  • "icon"

  • "large"

  • "medium"

  • "small"

  • "xlarge"

  • "xxlarge"
imgType

enum (ImgType)

Retorna imagens de um tipo. Os valores aceitos são:

  • "clipart"

  • "face"

  • "lineart"

  • "stock"

  • "photo"

  • "animated"
lowRange

string

Especifica o valor inicial de um intervalo de pesquisa. Use lowRange e highRange para anexar um intervalo de pesquisa inclusivo de lowRange...highRange à consulta.
lr

string

Restringe a pesquisa a documentos escritos em um idioma específico (por exemplo, lr=lang_ja).

Os valores aceitos são:

  • "lang_ar": árabe

  • "lang_bg": búlgaro

  • "lang_ca": catalão

  • "lang_cs": tcheco

  • "lang_da": dinamarquês

  • "lang_de": alemão

  • "lang_el": grego

  • "lang_en": inglês

  • "lang_es": espanhol

  • "lang_et": estoniano

  • "lang_fi": finlandês

  • "lang_fr": francês

  • "lang_hr": croata

  • "lang_hu": húngaro

  • "lang_id": indonésio

  • "lang_is": islandês

  • "lang_it": italiano

  • "lang_iw": hebraico

  • "lang_ja": japonês

  • "lang_ko": coreano

  • "lang_lt": lituano

  • "lang_lv": letão

  • "lang_nl": holandês

  • "lang_no": norueguês

  • "lang_pl": polonês

  • "lang_pt": português

  • "lang_ro": romeno

  • "lang_ru": russo

  • "lang_sk": eslovaco

  • "lang_sl": esloveno

  • "lang_sr": sérvio

  • "lang_sv": sueco

  • "lang_tr": turco

  • "lang_zh-CN": chinês (simplificado)

  • "lang_zh-TW": chinês (tradicional)
num

integer

Número de resultados da pesquisa a serem retornados.

  • Os valores válidos são números inteiros entre 1 e 10, inclusive.
orTerms

string

Fornece termos de pesquisa adicionais a serem verificados em um documento, em que cada documento nos resultados da pesquisa precisa conter pelo menos um dos termos de pesquisa adicionais.
q

string

Consulta
relatedSite
(deprecated)

string

Obsoleto.
rights

string

Filtros com base no licenciamento. Os valores aceitos incluem: cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived e uma combinação deles. Confira as combinações típicas.
safe

enum (Safe)

Nível de segurança da pesquisa. Os valores aceitos são:

  • "active": ativa a filtragem do SafeSearch.

  • "off": desativa a filtragem do SafeSearch. (padrão)
searchType

enum (SearchType)

Especifica o tipo de pesquisa: image. Se não for especificado, os resultados ficarão limitados a páginas da Web.

Os valores aceitos são:

  • "image": pesquisa de imagens personalizadas.
siteSearchFilter

enum (SiteSearchFilter)

Controla a inclusão ou exclusão dos resultados do site nomeado no parâmetro siteSearch.

Os valores aceitos são:

  • "e": excluir

  • "i": incluir
sort

string

A expressão de classificação a ser aplicada aos resultados. O parâmetro de classificação especifica que os resultados sejam classificados de acordo com a expressão especificada, ou seja, por data. Exemplo: sort=date.
start

integer (uint32 format)

O índice do primeiro resultado a ser retornado. O número padrão de resultados por página é 10. Portanto, &start=11 começaria no topo da segunda página de resultados. Observação: a API JSON nunca vai retornar mais de 100 resultados, mesmo que mais de 100 documentos correspondam à consulta. Portanto, definir a soma de start + num como um número maior que 100 gera um erro. Observe também que o valor máximo para num é 10.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Search.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte a Visão geral do OAuth 2.0.