Resposta a uma solicitação de pesquisa personalizada.
Representação JSON |
---|
{ "kind": string, "url": { "type": string, "template": string }, "queries": { "previousPage": [ { "title": string, "totalResults": string, "searchTerms": string, "count": integer, "startIndex": integer, "startPage": integer, "language": string, "inputEncoding": string, "outputEncoding": string, "safe": string, "cx": string, "sort": string, "filter": string, "gl": string, "cr": string, "googleHost": string, "disableCnTwTranslation": string, "hq": string, "hl": string, "siteSearch": string, "siteSearchFilter": string, "exactTerms": string, "excludeTerms": string, "linkSite": string, "orTerms": string, "relatedSite": string, "dateRestrict": string, "lowRange": string, "highRange": string, "fileType": string, "rights": string, "searchType": string, "imgSize": string, "imgType": string, "imgColorType": string, "imgDominantColor": string } ], "request": [ { "title": string, "totalResults": string, "searchTerms": string, "count": integer, "startIndex": integer, "startPage": integer, "language": string, "inputEncoding": string, "outputEncoding": string, "safe": string, "cx": string, "sort": string, "filter": string, "gl": string, "cr": string, "googleHost": string, "disableCnTwTranslation": string, "hq": string, "hl": string, "siteSearch": string, "siteSearchFilter": string, "exactTerms": string, "excludeTerms": string, "linkSite": string, "orTerms": string, "relatedSite": string, "dateRestrict": string, "lowRange": string, "highRange": string, "fileType": string, "rights": string, "searchType": string, "imgSize": string, "imgType": string, "imgColorType": string, "imgDominantColor": string } ], "nextPage": [ { "title": string, "totalResults": string, "searchTerms": string, "count": integer, "startIndex": integer, "startPage": integer, "language": string, "inputEncoding": string, "outputEncoding": string, "safe": string, "cx": string, "sort": string, "filter": string, "gl": string, "cr": string, "googleHost": string, "disableCnTwTranslation": string, "hq": string, "hl": string, "siteSearch": string, "siteSearchFilter": string, "exactTerms": string, "excludeTerms": string, "linkSite": string, "orTerms": string, "relatedSite": string, "dateRestrict": string, "lowRange": string, "highRange": string, "fileType": string, "rights": string, "searchType": string, "imgSize": string, "imgType": string, "imgColorType": string, "imgDominantColor": string } ] }, "promotions": [ { object ( |
Campos | |
---|---|
kind |
Identificador exclusivo para o tipo de objeto atual. Para esta API, é customsearch#search. |
url |
O elemento de URL do OpenSearch que define o modelo para esta API. |
url.type |
O tipo MIME do modelo de URL do OpenSearch para a API JSON da Pesquisa personalizada. |
url.template |
O modelo OpenSearch real para essa API. |
queries |
Contém um ou mais conjuntos de metadados de consulta, reunidos por nome de função. Os possíveis nomes dos papéis incluem |
queries.previousPage[] |
Metadados que representam a página anterior de resultados, se aplicável. |
queries.previousPage[].title |
Descrição da consulta. |
queries.previousPage[].totalResults |
Número estimado do total de resultados da pesquisa. Pode não ser exata. |
queries.previousPage[].searchTerms |
Os termos de pesquisa digitados pelo usuário. |
queries.previousPage[].count |
Número de resultados de pesquisa mostrados no conjunto. |
queries.previousPage[].startIndex |
O índice do conjunto atual de resultados de pesquisa em relação ao conjunto total de resultados, sendo que o índice do primeiro resultado é 1. |
queries.previousPage[].startPage |
O número da página desse conjunto de resultados, em que o tamanho da página é definido pela propriedade |
queries.previousPage[].language |
O idioma dos resultados de pesquisa. |
queries.previousPage[].inputEncoding |
A codificação de caracteres suportada para os resultados de pesquisa. |
queries.previousPage[].outputEncoding |
A codificação de caracteres suportada para os resultados da pesquisa. |
queries.previousPage[].safe |
Especifica o nível do SafeSearch usado para filtrar resultados adultos. Esta é uma propriedade personalizada não definida na especificação do OpenSearch. Estes são os valores de parâmetro válidos:
|
queries.previousPage[].cx |
O identificador de um mecanismo criado usando o Painel de controle do Mecanismo de Pesquisa Programável. Essa é uma propriedade personalizada não definida na especificação do OpenSearch. Esse parâmetro é obrigatório. |
queries.previousPage[].sort |
Especifica que os resultados precisam ser classificados de acordo com a expressão especificada. Por exemplo, classificar por data. |
queries.previousPage[].filter |
Ativa ou desativa a filtragem automática dos resultados da pesquisa do Google. Consulte Filtragem automática para mais informações sobre os filtros de resultados da pesquisa do Google. Os valores válidos para esse parâmetro são:
Observação: por padrão, o Google aplica filtros a todos os resultados da pesquisa para melhorar a qualidade deles. |
queries.previousPage[].gl |
Otimiza os resultados da pesquisa cujo país de origem corresponde ao valor do parâmetro. Consulte uma lista de valores válidos em Códigos de países. A especificação de um valor de parâmetro |
queries.previousPage[].cr |
Restringe os resultados da pesquisa a documentos originários de um país específico. Você pode usar operadores booleanos no valor do parâmetro O Google WebSearch determina o país de um documento analisando o seguinte:
Consulte Valores de parâmetro de país (cr) para ver uma lista de valores válidos para esse parâmetro. |
queries.previousPage[].googleHost |
Especifica o domínio do Google (por exemplo, google.com, google.de ou google.fr) ao qual a pesquisa deve ser limitada. |
queries.previousPage[].disableCnTwTranslation |
Ativa ou desativa o recurso Pesquisa em chinês simplificado e tradicional. Os valores compatíveis são:
|
queries.previousPage[].hq |
Anexa os termos de consulta especificados à consulta, como se eles fossem combinados com um operador lógico |
queries.previousPage[].hl |
Especifica o idioma (idioma do host) da interface do usuário. Definir explicitamente esse parâmetro melhora o desempenho e a qualidade dos resultados da pesquisa. Consulte a seção Idiomas de interface de Internacionalização de consultas e apresentação de resultados para mais informações e a seção Idiomas de interface compatíveis para uma lista de idiomas compatíveis. |
queries.previousPage[].siteSearch |
Restringe os resultados a URLs de um site especificado. |
queries.previousPage[].siteSearchFilter |
Especifica se é necessário incluir ou excluir resultados do site nomeado no parâmetro
|
queries.previousPage[].exactTerms |
Identifica uma frase que todos os documentos nos resultados da pesquisa precisam conter. |
queries.previousPage[].excludeTerms |
Identifica uma palavra ou frase que não deve aparecer em nenhum documento nos resultados da pesquisa. |
queries.previousPage[].linkSite |
Especifica que todos os resultados devem conter um link para um URL específico. |
queries.previousPage[].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. Você também pode usar o termo de consulta OU booleano para esse tipo de consulta. |
queries.previousPage[].relatedSite |
Especifica que todos os resultados da pesquisa precisam ser páginas relacionadas ao URL especificado. O valor do parâmetro deve ser um URL. |
queries.previousPage[].dateRestrict |
Restringe os resultados a URLs com base na data. Os valores aceitos são:
|
queries.previousPage[].lowRange |
Especifica o valor inicial de um intervalo de pesquisa. Use |
queries.previousPage[].highRange |
Especifica o valor final de um intervalo de pesquisa. Use |
queries.previousPage[].fileType |
Restringe os resultados a arquivos de uma extensão especificada. Os tipos de arquivo aceitos pelo Google incluem:
Outros tipos de arquivo podem ser adicionados no futuro. Encontre uma lista atualizada nas perguntas frequentes sobre tipos de arquivos do Google. |
queries.previousPage[].rights |
Filtros com base no licenciamento. Os valores aceitos são:
|
queries.previousPage[].searchType |
Os valores permitidos são |
queries.previousPage[].imgSize |
Restringe os resultados a imagens de um tamanho especificado. Os valores compatíveis são:
|
queries.previousPage[].imgType |
Restringe os resultados a imagens de um tipo especificado. Os valores compatíveis são:
|
queries.previousPage[].imgColorType |
Restringe os resultados a imagens de um tipo de cor especificado. Os valores aceitos são:
|
queries.previousPage[].imgDominantColor |
Restringe os resultados a imagens com uma cor dominante específica. Os valores compatíveis são:
|
queries.request[] |
Metadados que representam a solicitação atual. |
queries.request[].title |
Descrição da consulta. |
queries.request[].totalResults |
Número estimado do total de resultados da pesquisa. Pode não ser exata. |
queries.request[].searchTerms |
Os termos de pesquisa digitados pelo usuário. |
queries.request[].count |
Número de resultados de pesquisa mostrados no conjunto. |
queries.request[].startIndex |
O índice do conjunto atual de resultados de pesquisa em relação ao conjunto total de resultados, sendo que o índice do primeiro resultado é 1. |
queries.request[].startPage |
O número da página desse conjunto de resultados, em que o tamanho da página é definido pela propriedade |
queries.request[].language |
O idioma dos resultados de pesquisa. |
queries.request[].inputEncoding |
A codificação de caracteres suportada para os resultados de pesquisa. |
queries.request[].outputEncoding |
A codificação de caracteres suportada para os resultados da pesquisa. |
queries.request[].safe |
Especifica o nível do SafeSearch usado para filtrar resultados adultos. Esta é uma propriedade personalizada não definida na especificação do OpenSearch. Estes são os valores de parâmetro válidos:
|
queries.request[].cx |
O identificador de um mecanismo criado usando o Painel de controle do Mecanismo de Pesquisa Programável. Essa é uma propriedade personalizada não definida na especificação do OpenSearch. Esse parâmetro é obrigatório. |
queries.request[].sort |
Especifica que os resultados precisam ser classificados de acordo com a expressão especificada. Por exemplo, classificar por data. |
queries.request[].filter |
Ativa ou desativa a filtragem automática dos resultados da pesquisa do Google. Consulte Filtragem automática para mais informações sobre os filtros de resultados da pesquisa do Google. Os valores válidos para esse parâmetro são:
Observação: por padrão, o Google aplica filtros a todos os resultados da pesquisa para melhorar a qualidade deles. |
queries.request[].gl |
Otimiza os resultados da pesquisa cujo país de origem corresponde ao valor do parâmetro. Consulte uma lista de valores válidos em Códigos de países. A especificação de um valor de parâmetro |
queries.request[].cr |
Restringe os resultados da pesquisa a documentos originários de um país específico. Você pode usar operadores booleanos no valor do parâmetro O Google WebSearch determina o país de um documento analisando o seguinte:
Consulte Valores de parâmetro de país (cr) para ver uma lista de valores válidos para esse parâmetro. |
queries.request[].googleHost |
Especifica o domínio do Google (por exemplo, google.com, google.de ou google.fr) ao qual a pesquisa deve ser limitada. |
queries.request[].disableCnTwTranslation |
Ativa ou desativa o recurso Pesquisa em chinês simplificado e tradicional. Os valores compatíveis são:
|
queries.request[].hq |
Anexa os termos de consulta especificados à consulta, como se eles fossem combinados com um operador lógico |
queries.request[].hl |
Especifica o idioma (idioma do host) da interface do usuário. Definir explicitamente esse parâmetro melhora o desempenho e a qualidade dos resultados da pesquisa. Consulte a seção Idiomas de interface de Internacionalização de consultas e apresentação de resultados para mais informações e a seção Idiomas de interface compatíveis para uma lista de idiomas compatíveis. |
queries.request[].siteSearch |
Restringe os resultados a URLs de um site especificado. |
queries.request[].siteSearchFilter |
Especifica se é necessário incluir ou excluir resultados do site nomeado no parâmetro
|
queries.request[].exactTerms |
Identifica uma frase que todos os documentos nos resultados da pesquisa precisam conter. |
queries.request[].excludeTerms |
Identifica uma palavra ou frase que não deve aparecer em nenhum documento nos resultados da pesquisa. |
queries.request[].linkSite |
Especifica que todos os resultados devem conter um link para um URL específico. |
queries.request[].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. Você também pode usar o termo de consulta OU booleano para esse tipo de consulta. |
queries.request[].relatedSite |
Especifica que todos os resultados da pesquisa precisam ser páginas relacionadas ao URL especificado. O valor do parâmetro deve ser um URL. |
queries.request[].dateRestrict |
Restringe os resultados a URLs com base na data. Os valores aceitos são:
|
queries.request[].lowRange |
Especifica o valor inicial de um intervalo de pesquisa. Use |
queries.request[].highRange |
Especifica o valor final de um intervalo de pesquisa. Use |
queries.request[].fileType |
Restringe os resultados a arquivos de uma extensão especificada. Os tipos de arquivo aceitos pelo Google incluem:
Outros tipos de arquivo podem ser adicionados no futuro. Encontre uma lista atualizada nas perguntas frequentes sobre tipos de arquivos do Google. |
queries.request[].rights |
Filtros com base no licenciamento. Os valores aceitos são:
|
queries.request[].searchType |
Os valores permitidos são |
queries.request[].imgSize |
Restringe os resultados a imagens de um tamanho especificado. Os valores compatíveis são:
|
queries.request[].imgType |
Restringe os resultados a imagens de um tipo especificado. Os valores compatíveis são:
|
queries.request[].imgColorType |
Restringe os resultados a imagens de um tipo de cor especificado. Os valores aceitos são:
|
queries.request[].imgDominantColor |
Restringe os resultados a imagens com uma cor dominante específica. Os valores compatíveis são:
|
queries.nextPage[] |
Metadados que representam a próxima página de resultados, se aplicável. |
queries.nextPage[].title |
Descrição da consulta. |
queries.nextPage[].totalResults |
Número estimado do total de resultados da pesquisa. Pode não ser exata. |
queries.nextPage[].searchTerms |
Os termos de pesquisa digitados pelo usuário. |
queries.nextPage[].count |
Número de resultados de pesquisa mostrados no conjunto. |
queries.nextPage[].startIndex |
O índice do conjunto atual de resultados de pesquisa em relação ao conjunto total de resultados, sendo que o índice do primeiro resultado é 1. |
queries.nextPage[].startPage |
O número da página desse conjunto de resultados, em que o tamanho da página é definido pela propriedade |
queries.nextPage[].language |
O idioma dos resultados de pesquisa. |
queries.nextPage[].inputEncoding |
A codificação de caracteres suportada para os resultados de pesquisa. |
queries.nextPage[].outputEncoding |
A codificação de caracteres suportada para os resultados da pesquisa. |
queries.nextPage[].safe |
Especifica o nível do SafeSearch usado para filtrar resultados adultos. Esta é uma propriedade personalizada não definida na especificação do OpenSearch. Estes são os valores de parâmetro válidos:
|
queries.nextPage[].cx |
O identificador de um mecanismo criado usando o Painel de controle do Mecanismo de Pesquisa Programável. Essa é uma propriedade personalizada não definida na especificação do OpenSearch. Esse parâmetro é obrigatório. |
queries.nextPage[].sort |
Especifica que os resultados precisam ser classificados de acordo com a expressão especificada. Por exemplo, classificar por data. |
queries.nextPage[].filter |
Ativa ou desativa a filtragem automática dos resultados da pesquisa do Google. Consulte Filtragem automática para mais informações sobre os filtros de resultados da pesquisa do Google. Os valores válidos para esse parâmetro são:
Observação: por padrão, o Google aplica filtros a todos os resultados da pesquisa para melhorar a qualidade deles. |
queries.nextPage[].gl |
Otimiza os resultados da pesquisa cujo país de origem corresponde ao valor do parâmetro. Consulte uma lista de valores válidos em Códigos de países. A especificação de um valor de parâmetro |
queries.nextPage[].cr |
Restringe os resultados da pesquisa a documentos originários de um país específico. Você pode usar operadores booleanos no valor do parâmetro O Google WebSearch determina o país de um documento analisando o seguinte:
Consulte Valores de parâmetro de país (cr) para ver uma lista de valores válidos para esse parâmetro. |
queries.nextPage[].googleHost |
Especifica o domínio do Google (por exemplo, google.com, google.de ou google.fr) ao qual a pesquisa deve ser limitada. |
queries.nextPage[].disableCnTwTranslation |
Ativa ou desativa o recurso Pesquisa em chinês simplificado e tradicional. Os valores compatíveis são:
|
queries.nextPage[].hq |
Anexa os termos de consulta especificados à consulta, como se eles fossem combinados com um operador lógico |
queries.nextPage[].hl |
Especifica o idioma (idioma do host) da interface do usuário. Definir explicitamente esse parâmetro melhora o desempenho e a qualidade dos resultados da pesquisa. Consulte a seção Idiomas de interface de Internacionalização de consultas e apresentação de resultados para mais informações e a seção Idiomas de interface compatíveis para uma lista de idiomas compatíveis. |
queries.nextPage[].siteSearch |
Restringe os resultados a URLs de um site especificado. |
queries.nextPage[].siteSearchFilter |
Especifica se é necessário incluir ou excluir resultados do site nomeado no parâmetro
|
queries.nextPage[].exactTerms |
Identifica uma frase que todos os documentos nos resultados da pesquisa precisam conter. |
queries.nextPage[].excludeTerms |
Identifica uma palavra ou frase que não deve aparecer em nenhum documento nos resultados da pesquisa. |
queries.nextPage[].linkSite |
Especifica que todos os resultados devem conter um link para um URL específico. |
queries.nextPage[].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. Você também pode usar o termo de consulta OU booleano para esse tipo de consulta. |
queries.nextPage[].relatedSite |
Especifica que todos os resultados da pesquisa precisam ser páginas relacionadas ao URL especificado. O valor do parâmetro deve ser um URL. |
queries.nextPage[].dateRestrict |
Restringe os resultados a URLs com base na data. Os valores aceitos são:
|
queries.nextPage[].lowRange |
Especifica o valor inicial de um intervalo de pesquisa. Use |
queries.nextPage[].highRange |
Especifica o valor final de um intervalo de pesquisa. Use |
queries.nextPage[].fileType |
Restringe os resultados a arquivos de uma extensão especificada. Os tipos de arquivo aceitos pelo Google incluem:
Outros tipos de arquivo podem ser adicionados no futuro. Encontre uma lista atualizada nas perguntas frequentes sobre tipos de arquivos do Google. |
queries.nextPage[].rights |
Filtros com base no licenciamento. Os valores aceitos são:
|
queries.nextPage[].searchType |
Os valores permitidos são |
queries.nextPage[].imgSize |
Restringe os resultados a imagens de um tamanho especificado. Os valores compatíveis são:
|
queries.nextPage[].imgType |
Restringe os resultados a imagens de um tipo especificado. Os valores compatíveis são:
|
queries.nextPage[].imgColorType |
Restringe os resultados a imagens de um tipo de cor especificado. Os valores aceitos são:
|
queries.nextPage[].imgDominantColor |
Restringe os resultados a imagens com uma cor dominante específica. Os valores compatíveis são:
|
promotions[] |
O conjunto de promoções. Presente apenas se os arquivos de configuração do mecanismo de pesquisa personalizado definirem promoções para a consulta em questão. |
context |
Metadados e refinamentos associados ao mecanismo de pesquisa especificado, incluindo:
|
searchInformation |
Metadados sobre essa pesquisa, incluindo o tempo da pesquisa e o total de resultados. |
searchInformation.searchTime |
O tempo que o servidor levou para retornar os resultados da pesquisa. |
searchInformation.formattedSearchTime |
O tempo que o servidor leva para retornar resultados da pesquisa, formatado de acordo com o estilo da localidade. |
searchInformation.totalResults |
O número total de resultados da pesquisa retornados pela consulta. |
searchInformation.formattedTotalResults |
O número total de resultados da pesquisa, formatados de acordo com o estilo da localidade. |
spelling |
Encapsula uma consulta corrigida. |
spelling.correctedQuery |
A consulta corrigida. |
spelling.htmlCorrectedQuery |
A consulta corrigida, formatada em HTML. |
items[] |
O conjunto atual de resultados de pesquisa personalizados. |
Promoção
Resultado da promoção.
Representação JSON |
---|
{ "title": string, "htmlTitle": string, "link": string, "displayLink": string, "bodyLines": [ { "title": string, "htmlTitle": string, "url": string, "link": string } ], "image": { "source": string, "width": integer, "height": integer } } |
Campos | |
---|---|
title |
O título da promoção. |
htmlTitle |
Título da promoção, em HTML. |
link |
URL da promoção. |
displayLink |
Uma versão resumida do URL do resultado da pesquisa, por exemplo, www.example.com. |
bodyLines[] |
Uma matriz de objetos em bloco para esta promoção. |
bodyLines[].title |
O texto do objeto em bloco, se houver texto. |
bodyLines[].htmlTitle |
O texto do objeto em bloco em HTML, se houver texto. |
bodyLines[].url |
O URL do link do objeto em bloco, se houver. |
bodyLines[].link |
O texto âncora do link do objeto em bloco, se houver um link. |
image |
Imagem associada a esta promoção, se houver. |
image.source |
URL da imagem desse link da promoção. |
image.width |
Largura da imagem em pixels. |
image.height |
Altura da imagem em pixels. |
Resultado
Um resultado de pesquisa personalizado.
Representação JSON |
---|
{ "kind": string, "title": string, "htmlTitle": string, "link": string, "displayLink": string, "snippet": string, "htmlSnippet": string, "cacheId": string, "formattedUrl": string, "htmlFormattedUrl": string, "pagemap": { object }, "mime": string, "fileFormat": string, "image": { "contextLink": string, "height": integer, "width": integer, "byteSize": integer, "thumbnailLink": string, "thumbnailHeight": integer, "thumbnailWidth": integer }, "labels": [ { "name": string, "displayName": string, "label_with_op": string } ] } |
Campos | |
---|---|
kind |
O identificador exclusivo para o tipo de objeto atual. Para esta API, é |
title |
O título do resultado de pesquisa, em texto sem formatação. |
htmlTitle |
O título do resultado de pesquisa, em HTML. |
link |
O URL completo para o qual o resultado da pesquisa está apontando, por exemplo, http://www.example.com/foo/bar. |
displayLink |
Uma versão resumida do URL do resultado da pesquisa, por exemplo, www.example.com. |
snippet |
O snippet do resultado de pesquisa, em texto sem formatação. |
htmlSnippet |
O snippet do resultado de pesquisa, em HTML. |
cacheId |
Indica o ID da versão em cache do Google do resultado da pesquisa. |
formattedUrl |
O URL exibido após o snippet de cada resultado de pesquisa. |
htmlFormattedUrl |
O URL formatado em HTML exibido após o snippet de cada resultado de pesquisa. |
pagemap |
Contém informações de PageMap para o resultado da pesquisa. |
mime |
O tipo MIME do resultado da pesquisa. |
fileFormat |
O formato do arquivo do resultado da pesquisa. |
image |
Encapsula todas as informações sobre uma imagem retornada nos resultados da pesquisa. |
image.contextLink |
Um URL que aponta para a página da Web que hospeda a imagem. |
image.height |
A altura da imagem em pixels. |
image.width |
A largura da imagem em pixels. |
image.byteSize |
O tamanho da imagem em bytes. |
image.thumbnailLink |
Um URL para a imagem em miniatura. |
image.thumbnailHeight |
A altura da imagem em miniatura, em pixels. |
image.thumbnailWidth |
A largura da imagem em miniatura, em pixels. |
labels[] |
Encapsula todas as informações sobre marcadores de refinamento. |
labels[].name |
O nome de um marcador de refinamento, que pode ser usado para refinar pesquisas. Não exiba isso na interface do usuário. Em vez disso, use displayName. |
labels[].displayName |
O nome de exibição de um rótulo de refinamento. Esse é o nome que deve ser exibido na interface do usuário. |
labels[].label_with_op |
Rótulo de refinamento e a operação de refinamento associada. |