Este documento vai ajudar você a conhecer a API JSON Custom Search e como usá-la.
Antes de começar
Criar um Mecanismo de Pesquisa Programável
Ao chamar a API, o usuário envia solicitações para uma instância existente do
Mecanismo de Pesquisa Programável. Portanto, antes de usar a API, crie uma no Painel de controle . Siga o tutorial para saber mais sobre as diferentes opções de configuração. Depois de criado, o ID do mecanismo de pesquisa pode ser encontrado na seção Básica da página Visão geral. Esse é o parâmetro cx usado pela API.
Identificar seu aplicativo para o Google com a chave de API
A API Custom Search JSON exige o uso de uma chave de API. Uma chave de API é uma maneira de identificar seu cliente para o Google.
Depois que você tiver uma chave de API, seu aplicativo poderá anexar o parâmetro de consulta key=yourAPIKey a todos os URLs de solicitação. É seguro incorporar a chave de API a URLs. Não é necessário codificá-la.
Visão geral da API
Operações de API
Há apenas um método para invocar na API JSON Custom Search:
| Operação | Descrição | Mapeamento HTTP REST |
|---|---|---|
| list | Retorna os resultados da pesquisa solicitados de um Mecanismo de Pesquisa Programável. | GET |
Modelo de dados de API
O resultado de uma consulta de pesquisa para a API Custom Search JSON é um objeto JSON que inclui três tipos de dados:
- Metadados que descrevem a pesquisa solicitada (e possivelmente solicitações de pesquisas relacionadas)
- Metadados que descrevem o Mecanismo de Pesquisa Programável
- Resultados da pesquisa
Consulte a seção "Dados de resposta" em Como usar REST para mais detalhes.
O modelo de dados é baseado na Especificação do OpenSearch 1.1. Além das propriedades padrão do OpenSearch, a API Custom Search JSON define duas propriedades personalizadas e duas funções de consulta personalizadas:
- Propriedades personalizadas
cx: o identificador do Mecanismo de Pesquisa Programável.safe: uma descrição do nível de pesquisa segura para filtrar os resultados retornados.
- Funções de consulta personalizadas
nextPage: uma função que indica que a consulta pode ser usada para acessar a próxima página lógica de resultados, se houver.previousPage: uma função que indica que a consulta pode ser usada para acessar a página lógica anterior de resultados, se houver.
Testar
Para conhecer a API e ver o que ela pode fazer sem escrever código, acesse a ferramenta"Testar esta API".
Para uma descrição completa dos parâmetros, acesse a referência cse.list.
Para saber como usar a API por solicitações HTTP, continue em Usar REST.