- Solicitação HTTP
- Parâmetros de consulta
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- Faça um teste
Retorna metadados sobre a pesquisa realizada, metadados sobre o mecanismo usado na pesquisa e os resultados da pesquisa. Usa um pequeno conjunto de padrões de URL.
Solicitação HTTP
GET https://customsearch.googleapis.com/customsearch/v1/siterestrict
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de consulta
| Parâmetros | |
|---|---|
| c2coff | 
 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: 
 | 
| cr | 
 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: 
 Consulte a página Valores de parâmetros de país para ver uma lista de valores válidos para esse parâmetro. | 
| cx | 
 O ID do Mecanismo de Pesquisa Programável a ser usado na solicitação. | 
| dateRestrict | 
 Restringe os resultados a URLs com base na data. Os valores aceitos são: 
 | 
| exactTerms | 
 Identifica uma frase que todos os documentos nos resultados da pesquisa precisam conter. | 
| excludeTerms | 
 Identifica uma palavra ou frase que não deve aparecer em nenhum documento nos resultados da pesquisa. | 
| fileType | 
 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 | 
 Controla a ativação ou desativação do filtro de conteúdo duplicado. 
 Os valores aceitos são: 
 | 
| gl | 
 Geolocalização do usuário final. 
 | 
| googlehost | 
 Obsoleto. Use o parâmetro  O domínio local do Google (por exemplo, google.com.br, google.de ou google.fr) que será usado para realizar a pesquisa. | 
| highRange | 
 Especifica o valor final de um intervalo de pesquisa. 
 | 
| hl | 
 Define o idioma da interface do usuário. 
 | 
| hq | 
 Anexa os termos de consulta especificados à consulta, como se eles fossem combinados com um operador lógico AND. | 
| imgColorType | 
 Retorna imagens em preto e branco, em escala de cinza, transparentes ou coloridas. Os valores aceitos são: 
 | 
| imgDominantColor | 
 Retorna imagens de uma cor dominante específica. Os valores aceitos são: 
 | 
| imgSize | 
 Retorna imagens de um tamanho especificado. Os valores aceitos são: 
 | 
| imgType | 
 Retorna imagens de um tipo. Os valores aceitos são: 
 | 
| linkSite | 
 Especifica que todos os resultados da pesquisa devem conter um link para um URL específico. | 
| lowRange | 
 Especifica o valor inicial de um intervalo de pesquisa. Use  | 
| lr | 
 Restringe a pesquisa a documentos escritos em um idioma específico (por exemplo,  Os valores aceitos são: 
 | 
| num | 
 Número de resultados da pesquisa a serem retornados. 
 | 
| orTerms | 
 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 | 
 Consulta | 
| relatedSite | 
 Obsoleto. | 
| rights | 
 Filtros com base no licenciamento. Os valores aceitos incluem:  | 
| safe | 
 Nível de segurança da pesquisa. Os valores aceitos são: 
 | 
| searchType | 
 Especifica o tipo de pesquisa:  Os valores aceitos são: 
 | 
| siteSearch | 
 Especifica um determinado site que sempre deve ser incluído ou excluído dos resultados (consulte o parâmetro  | 
| siteSearchFilter | 
 Controla a inclusão ou exclusão dos resultados do site nomeado no parâmetro  Os valores aceitos são: 
 | 
| sort | 
 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 | 
 O índice do primeiro resultado a ser retornado. O número padrão de resultados por página é 10. Portanto,  | 
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.