Meus favoritos | Inglês | Fazer login

Referência de Classe

A API AJAX de pesquisa do Google é uma API JavaScript implementada nas classes descritas a seguir.

Atualizamos esta documentação para usar o carregador da API AJAX. Este carregador facilita o uso de diversas APIs AJAX do Google na mesma página, unificando os namespaces entre elas. Você não precisa alterar seu código se não quiser: ele não será interrompido, e o namespace antigo continuará funcionando. Esperamos que você escolha fazer a transição para o novo carregador e o novo namespace, pois eles continuarão sendo usados nas próximas APIs AJAX.

Marque para exibir a nomenclatura da classe e o esquema de namespace antigos (exemplo, GwebSearch, GlocalSearch etc.)

Sumário

O controle de pesquisa

GSearchControlgoogle.search.SearchControl

Uma instância de GSearchControlgoogle.search.SearchControl representa um único controle de pesquisa em uma página. Cada controle de pesquisa gerencia a apresentação do objeto de interface de usuário e do mecanismo de pesquisa para um conjunto selecionado de objetos de pesquisa (objetos que implementam a interface GSearch google.search.Search).

GSearchControlgoogle.search.SearchControl - Construtor

Construtor Descrição

GSearchControl()google.search.SearchControl()

Cria um novo objeto de controle de pesquisa. O objeto de controle de pesquisa é um recipiente para as pesquisas, objetos que implementam a interface GSearchgoogle.search.Search. O objeto de controle de pesquisa não fica operacional até ter pelo menos uma pesquisa filho. Um controle de pesquisa é conectado a um recipiente html através do método .draw(). Não é possível adicionar objetos de pesquisa a um controle de pesquisa depois que o método draw() () é chamado.

A ordem esperada da operação é:

  • sc = new GSearchControl()google.search.SearchControl();
  • sc.addSearcher();
  • sc.draw();

Depois que essas etapas ocorrem, o controle de pesquisa fica ativo e pronto para começar a realizar pesquisas.

GSearchControlgoogle.search.SearchControl - Métodos

Método Descrição

.addSearcher(searcher, opt_options?)

Este método adiciona um objeto de pesquisa ao controle de pesquisa. Depois de adicionado, o controle de pesquisa coordenará as atividades da pesquisa. Ele coordena a execução de pesquisas, lida com os eventos relacionados de conclusão da pesquisa, fornece uma localização para a apresentação dos resultados e fornece uma IU para "manter" ou "recortar" os resultados de pesquisa.

O método aceita um objeto GsearcherOptionsgoogle.search.SearchOptions opcional, que é usado para especificar diversas opções específicas à pesquisa:

  • searcher - fornece um objeto de pesquisa
  • opt_options - se especificada, fornece opções de configuração para esta pesquisa
  • retorna - n/d

.draw(element, opt_drawOptions?)

Este método é a etapa final necessária para ativar um objeto de controle de pesquisa. Ele pode ser chamado somente depois de todas as pesquisas serem adicionadas ao controle de pesquisa. Quando chamado, este método produz a interface de usuário, recipientes dos resultados de pesquisa para cada pesquisa configurada e define os diversos vínculos necessários para coordenar pesquisas paralelas entre todas as pesquisas.

O método requer que o originador da chamada forneça um elemento html de bloco, normalmente um elemento div dentro do qual o controle realizará o desenho. O controle opera melhor quando tiver pelo menos 300px de largura, e pode ser levemente reduzido para aproximadamente 250px.

O estilo padrão da interface de usuário é um estilo linear, onde as entradas de controle estão no alto, seguidas por um conjunto linear de resultados empilhados. Como opção, o originador da chamada pode solicitar uma interface de usuário com guias, que funciona bem quando o uso vertical de espaço for caro.

  • element - fornece um elemento html de bloco que funciona como recipiente do controle
  • opt_drawOptions - se especificada, fornece um objeto GdrawOptionsgoogle.search.DrawOptions que pode ser usado para especificar o modo de desenho linear ou com guias. O objeto também pode ser usado para fornecer o controle de pesquisa com um elemento de entrada de texto, que deve ser usado para capturar termos de consulta. Se não for especificado, o modo de desenho linear é assumido e o controle aloca e gerencia seu próprio elemento de entrada de texto.
  • retorna - n/d

.setTimeoutInterval(timeoutInterval)

Quando um aplicativo fornece seu próprio controle de entrada e solicita que o controle de pesquisa o use, o controle usa um temporizador de entrada para determinar quando deverá executar uma pesquisa. Um temporizador é inicializado cada vez que o usuário digita algo na área de entrada de texto dos controles de pesquisa. A pesquisa é solicitada quando o temporizador é executado. Use esta API para programar a espera entre a última tecla digitada e o início de uma pesquisa. Observação: O valor padrão do controle é GSearchControlgoogle.search.SearchControl.TIMEOUT_MEDIUM (cerca de 500 ms).

  • timeoutInterval - fornece o valor para o método timeoutInterval, o período de tempo entre a última tecla digitada e a execução de uma pesquisa resultante. Os valores válidos incluem:
    • GSearchControlgoogle.search.SearchControl.TIMEOUT_SHORT - usado para especificar uma demora bem curta de aproximadamente 350 ms.
    • GSearchControlgoogle.search.SearchControl.TIMEOUT_MEDIUM - usado para especificar uma demora média de aproximadamente 500 ms.
    • GSearchControlgoogle.search.SearchControl.TIMEOUT_LONG - usado para especificar uma demora longa de aproximadamente 700 ms.
  • retorna - n/d

.execute(opt_query?)

Este método faz com que o controle de pesquisa inicie uma sequência de pesquisas paralelas entre todas as pesquisas configuradas no controle. Se o argumento opt_query for fornecido, seu valor é colocado dentro da caixa de entrada de texto dos controles de pesquisa e torna-se a expressão da pesquisa paralela. Caso contrário, é usado o valor atual da caixa de entrada de texto do controle de pesquisa. Observação: Este método permite que os aplicativos automatizem partes do controle de pesquisa. Por exemplo, um aplicativo pode optar por iniciar uma pesquisa automaticamente sempre que o usuário passar o mouse sobre uma palavra ou frase, ou fizer outro gesto específico ao aplicativo.

Como efeito colateral dessa chamada, é exibido o conjunto atual de resultados de pesquisa. Além disso, os resultados de pesquisa armazenados dentro de cada um dos objetos pesquisa são limpos.

  • opt_query - fornece uma expressão opcional de pesquisa usada pela pesquisa resultante. Se não for especificado, é usada a expressão de pesquisa presente na caixa de entrada de texto do controle de pesquisa.
  • retorna - n/d

.setOnKeepCallback(object, method, opt_keepLabel?)

Este método é usado para informar ao controle de pesquisa que o originador da chamada deseja ser notificado quando um usuário selecionar um dos resultados gerenciados pelo controle de pesquisa para copiá-lo. Se este método não for chamado, o usuário não receberá a oportunidade de copiar os resultados da pesquisa. Se o método for chamado, cada resultado de pesquisa será anotado com um link de texto exibido abaixo do resultado da pesquisa. Clicar neste link faz com que o método especificado do objeto especificado seja chamado, passando um objeto GResultgoogle.search.Result associado ao resultado da pesquisa. Este método permite que o originador da chamada especifique um valor de marcador de texto integrado definido pelo sistema, que convida o usuário a copiar o resultado ou a especificar um marcador mais significativo para o aplicativo da chamada. Ao usar os marcadores definidos pelo sistema, o valor é traduzido automaticamente para o idioma no qual está sendo executado o restante do controle.

  • object - fornece um objeto de nível de aplicativo que define o contexto no qual o método especificado será chamado.
  • method - fornece o método a ser chamado. Por exemplo, se este método for chamado como .setOnKeepCallback(foo, MyObject.prototype.myKeephandler), quando um usuário clicar no marcador keep, uma chamada para foo.myKeephandler() será realizada.
  • opt_keepLabel - fornece um marcador de texto opcional que fica abaixo de cada resultado de pesquisa e, ao ser clicado, inicia um retorno de chamada ao objeto/método especificado. Os valores válidos incluem:
    • GSearchControlgoogle.search.SearchControl.KEEP_LABEL_SAVE - o valor do marcador é "save"
    • GSearchControlgoogle.search.SearchControl.KEEP_LABEL_KEEP - o valor do marcador é "keep"
    • GSearchControlgoogle.search.SearchControl.KEEP_LABEL_INCLUDE - o valor do marcador é "include"
    • GSearchControlgoogle.search.SearchControl.KEEP_LABEL_COPY- o valor do marcador é "copy"
    • GSearchControlgoogle.search.SearchControl.KEEP_LABEL_BLANK - é usado um valor de marcador vazio, que funciona bem quando você deseja obter apenas o gráfico da cópia (selecionável através de css)
    • Qualquer outro valor - o valor passado torna-se o marcador. O originador da chamada é responsável pela localização.
  • retorna - n/d

.setResultSetSize(switchTo)

Este método é chamado para selecionar o número de resultados retornados por cada uma das pesquisas. Observe que este método não utiliza escalas. Ele utiliza uma enumeração que indica um pequeno número de resultados ou um grande número de resultados. No futuro, este método pode ser aprimorado para suportar conjuntos de resultados de porte médio e muito grande. Nos aplicativos de exemplo, você provavelmente viu o controle de ajuste mais/menos no início do controle de pesquisa. Este método é usado por esse controle de ajuste.

  • switchTo - fornece uma enumeração indicando o número desejado de resultados de pesquisa a ser retornado para cada pesquisa configurada. Os valores válidos incluem:
    • GSearchgoogle.search.Search.LARGE_RESULTSET - solicita um grande número de resultados (normalmente 8 resultados)
    • GSearchgoogle.search.Search.SMALL_RESULTSET - solicita um pequeno número de resultados (normalmente 4 resultados)
  • retorna - n/d

.cancelSearch()

Este método é usado para informar ao controle de pesquisa que este deve ignorar todas as conclusões de resultado de pesquisa recebidas. O estado interno usado por este método é reset, para permitir pesquisas novas sempre que uma nova pesquisa for solicitada. Este método tem a finalidade de ajudar os aplicativos a lidar com a intermitência de IU que pode ocorrer quando a entrada lenta dispara pesquisas inadvertidamente. Ao usar este método cada vez que for detectada uma entrada, as pesquisas anteriores baseadas em entradas parciais podem ser ignoradas facilmente.

  • retorna - n/d

.clearAllResults()

Este método é usado para remover todos os resultados de pesquisa do controle de pesquisa.

  • retorna - n/d

.setLinkTarget(linkTarget)

Este método é chamado para definir o destino do link, usado com os links incorporados nos resultados da pesquisa. O valor padrão é GSearchgoogle.search.Search.LINK_TARGET_BLANK, que especifica que os links serão abertos em uma nova janela do navegador. Quando este método é chamado, é estabelecida uma configuração de destino de link por todo o controle de pesquisa. Isso afeta todas as pesquisas conectadas ao controle de pesquisa, bem como todas as pesquisas adicionadas subsequentemente ao controle.

  • linkTarget - fornece o frame de destino dentro do qual os links devem ser abertos. São valores válidos:
    • GSearchgoogle.search.Search.LINK_TARGET_BLANK - os links serão abertos em uma nova janela, por ex., <A href=... target=_blank ...>
    • GSearchgoogle.search.Search.LINK_TARGET_SELF - os links serão abertos na mesma janela e frame, por ex., <A href=...target=_self ...>
    • GSearchgoogle.search.Search.LINK_TARGET_TOP - os links serão abertos no primeiro frame, por ex., <A href=...target=_top ...>
    • GSearchgoogle.search.Search.LINK_TARGET_PARENT - os links serão abertos no primeiro frame ou substituirão o frame atual, por ex.,<A href=... target=_parent ...>
    • anything-else - os links serão abertos no frame ou na janela especificada, por ex., <A href=... target=anything-else ...>
  • retorna - n/d

.setSearchCompleteCallback(object, method)

Este método é usado para informar ao controle de pesquisa que o originador da chamada deseja ser notificado quando uma pesquisa for concluída. A granularidade desta chamada está no nível de pesquisa e NÃO no nível do controle de pesquisa. Isso significa que, se seu controle de pesquisa contém 5 pesquisas e você executar uma pesquisa, o retorno de chamada será chamado a cada pesquisa concluída. Além disso, nem todas as pesquisas serão concluídas. Portanto, tenha cuidado para não criar armadilhas de código ao supor que ocorrerá uma única conclusão para cada pesquisa.

  • object - fornece um objeto de nível de aplicativo que define o contexto no qual o método especificado será chamado.
  • method - fornece o método a ser chamado. Por exemplo, se este método for chamado como .setSearchCompleteCallback(foo, MyObject.prototype.mySearchComplete), quando uma pesquisa for concluída, uma chamada para foo.mySearchComplete(searchControl, searcher) será realizada. O primeiro argumento do retorno de chamada, searchControl, fornece o controle de pesquisa, e o segundo argumento, searcher, fornece o objeto de pesquisa que acabou de concluir uma pesquisa.
  • retorna - n/d

.setSearchStartingCallback(object, method)

Este método é usado para informar ao controle de pesquisa que o originador da chamada deseja ser notificado antes de uma pesquisa ser iniciada. A granularidade desta chamada está no nível de pesquisa e NÃO no nível do controle de pesquisa. Isso significa que, se seu controle de pesquisa contém 5 pesquisas e você executar uma pesquisa, o método será chamado a cada vez que for informado que uma pesquisa deve ser iniciada.

  • object - fornece um objeto de nível de aplicativo que define o contexto no qual o método especificado será chamado.
  • method - fornece o método a ser chamado. Por exemplo, se este método for chamado como .setSearchStartingCallback(foo, MyObject.prototype.mySearchStarting), quando uma pesquisa for iniciada, uma chamada para foo.mySearchStarting(searchControl, searcher, query) será realizada. O primeiro argumento do retorno de chamada, searchControl, fornece o controle da pesquisa; o segundo argumento, searcher, fornece a pesquisa que está prestes a ser iniciada, e o terceiro argumento, query, fornece a consulta.
  • retorna - n/d

.setNoResultsString(str)

Normalmente, o slot da pesquisa no controle de pesquisa é deixado vazio quando uma pesquisa não produz resultados. Este método permite que o originador da chamada especifique uma string que fornece um "resultado" padrão. O sistema contém o valor GSearchControlgoogle.search.SearchControl.NO_RESULTS_DEFAULT_STRING, que você pode usar. Esta á uma string localizada que significa "Sem resultados" em todos os locais suportados.

  • str - fornece um valor de string usado quando uma pesquisa não obtém resultados.
  • retorna - n/d

GSearchControlgoogle.search.SearchControl - Métodos estáticos

Método estático Descrição

.inlineCurrentStyle(node, opt_deep?)

Esta função auxiliar é usada para clonar o estilo calculado atual para o nó html especificado (ou árvore, se opt_deep for especificado) e inserir o estilo atual no nó. Esta função é útil em algumas situações, principalmente em conjunto com um manipulador on keep, onde o aplicativo deseja preservar um conjunto de estilos html enquanto passa um conteúdo html de um aplicativo para outro, onde o aplicativo receptor não possui a folha de estilo associada. O exemplo mais simples deste cenário é o caso de um aplicativo de e-mail usando a API AJAX de pesquisa do Google para permitir que os usuários recortem resultados de pesquisa e os colem em uma janela de composição de mensagem, a partir da qual serão enviados como html para outro usuário. Em alguns casos, o aplicativo de e-mail do destinatário não terá conhecimento da API AJAX de pesquisa do Google e, portanto, normalmente não terá sua folha de estilo. Para resolver isso, fornecemos este método para que o aplicativo originador do e-mail possa inserir os estilos atuais, para que o destinatário possa ler a mensagem com total fidelidade.

  • node - fornece um nó html cujo estilo deve ser incluído
  • opt_deep - se especificado, a operação de inclusão é recursiva, inserindo os estilos do nó atual e de seus descendentes.
  • retorna - n/d

Observação: Este método não está implementado no momento no navegador Safari.

GSearchControl google.search.SearchControl - Propriedades públicas

Este objeto não utiliza nenhuma propriedade pública.

GSearchForm google.search.SearchForm

Os aplicativos que usam objetos em formato independente, em vez de usarem apenas objetos , frequentemente terão que capturar e processar solicitações de pesquisa geradas pelo usuário.GSearchControlgoogle.search.SearchControl o GSearchFormgoogle.search.SearchForm() () é um objeto leve, cuja finalidade de uso é exatamente este caso. Ele fornece um elemento de entrada de texto, um botão de pesquisa, um botão opcional Limpar e toda a aplicação de marca padrão aos aplicativos.

GSearchFormgoogle.search.SearchForm - Construtor

Construtor Descrição

GSearchFormgoogle.search.SearchForm(enableClear, element)

Cria um novo objeto de formulário de pesquisa. O objeto de formulário de pesquisa fornece elementos de interface de usuário, métodos, propriedades e retornos de chamada criados para permitir que os aplicativos controlem uma coleção de objetos GSearchgoogle.search.Search(). A interface e os recursos do usuário correspondem ao que está disponível para aplicativos que usam o GSearchControlgoogle.search.SearchControl()) (na verdade, o GSearchControlgoogle.search.SearchControl() é baseado internamente neste objeto.

A ordem esperada da operação é:

  • sf = new GSearchFormgoogle.search.SearchForm(true/false, container);
  • sf.setOnSubmitCallback(object, method);
  • Opcional - sf.setOnClearCallback(object, method);

Depois que estas etapas ocorrem, o formulário de pesquisa fica ativo e pronto para começar a receber e processar entradas do usuário.

O método aceita um argumento enableClear obrigatório, além de um argumento element obrigatório

  • enableClear - quando true, o formulário de pesquisa deve conter um botão Limpar. Caso contrário, o botão Limpar não é criado
  • element - fornece o nó HTML que deve funcionar como um recipiente deste formulário

GSearchFormgoogle.search.SearchForm - Métodos

Método Descrição

.setOnSubmitCallback(object, method)

Este método registra uma combinação objeto/método chamada quando o formulário de pesquisa é "enviado". Este evento ocorre quando o usuário clica no botão Pesquisar ou quando o usuário tecla Enter enquanto o ponteiro está sobre o elemento de entrada de texto. Quando isso ocorre, o objeto especificado torna-se o objeto ativo e o método especificado é chamado. O argumento passado ao método é este formulário de pesquisa.

A aparência típica de um método é:

App.prototype.onSubmit = function(form) {
  if (form.input.value) {
    this.localSearcher.execute(form.input.value);
  }
  return false;
}
                

No exemplo acima, o formulário de pesquisa é passado ao método e este retorna false, indicando que processou o evento de envio.

  • object - fornece um objeto de nível de aplicativo que define o contexto no qual o método especificado será chamado.
  • method - fornece o método a ser chamado. O método recebe uma referência a este formulário e deve retornar false.

.setOnClearCallback(object, method)

Este método registra uma combinação objeto/método chamada quando o botão Limpar do formulário de pesquisa é pressionado. É um erro chamar este método caso o formulário de pesquisa seja criado sem um botão Limpar. Quando isso ocorre, o objeto especificado torna-se o objeto ativo e o método especificado é chamado. O argumento passado ao método é este formulário de pesquisa.

A aparência típica de um método é:

App.prototype.onClear = function(form) {
  this.myClearFunction();
  return false;
}
                

No exemplo acima, o formulário de pesquisa é passado ao método e este retorna false, indicando que processou o evento Limpar.

  • object - fornece um objeto de nível de aplicativo que define o contexto no qual o método especificado será chamado.
  • method - fornece o método a ser chamado. O método recebe uma referência a este formulário e deve retornar false.

.execute(opt_string?)

Este método permite que um aplicativo "envie" o formulário. Isso envolve, opcionalmente, configurar o elemento de entrada de texto do formulário e, em seguida, chamar o método de retorno de chamada registrado no envio, estabelecido com o .setOnSubmitCallback().

  • opt_string - se estiver presente, fornece um valor de string que é colocado no elemento de entrada de texto do formulário antes de chamar o método de retorno de chamada no envio.
  • retorna - n/d

GSearchFormgoogle.search.SearchForm - Métodos

Este objeto não utiliza nenhum método estático.

GSearchFormgoogle.search.SearchForm - Propriedades públicas

A coleção de propriedades públicas a seguir é utilizada por google.search.SearchForm.

Propriedade Descrição

.input

Esta propriedade é o elemento de entrada de texto do formulário. Os aplicativos podem ler e gravar esta propriedade livremente. No uso típico em um manipulador de retorno de chamada no envio, um aplicativo lê e processa a string form.input.value, normalmente chamando .execute() em uma pesquisa sob o seu controle.

.userDefinedCell

A estrutura interna do formulário de pesquisa é um par de tabelas HTML. A tabela superior contém o elemento de entrada de texto, o botão de pesquisa localizado e um botão Limpar opcional. A tabela inferior contém uma célula livre específica ao aplicativo, a célula da esquerda na tabela, além de um conjunto de marca do Google, incluindo texto e imagem, alinhado à direita. Esta propriedade, a .userDefinedCell, é o nó DOM da célula da tabela criada para o conteúdo específico ao aplicativo. Um aplicativo pode usar este espaço para depositar informações próximo ao formulário de pesquisa e alinhadas com a marca padrão do Google.

Pesquisas

GSearchgoogle.search.Search

Uma instância da classe GSearchgoogle.search.Search fornece a capacidade de executar pesquisas e receber resultados de um serviço de pesquisa específico. Este objeto não é usado diretamente. É uma classe básica herdada das pesquisas específicas ao serviço. Os métodos e propriedades descritos abaixo se aplicam a todos os objetos herdados desta classe básica. Cada um desses objetos também pode fornecer interfaces adicionais.

O uso esperado deste objeto é em conjunto com o GSearchControlgoogle.search.SearchControl, onde o controle de pesquisa fornece a interface de usuário e a coordenação. Dito isso, é totalmente aceitável usar este objeto de maneira independente. Nesse caso, evite compartilhar a mesma instância de um objeto de pesquisa entre a lógica do seu aplicativo e um objeto de controle de pesquisa.

GSearchgoogle.search.Search - Construtor

Construtor Descrição

GSearchgoogle.search.Search()

Cria um novo de objeto pesquisa. Observação: Como esta é uma classe básica, provavelmente os aplicativos não farão uso direto deste construtor. Em vez disso, eles usarão o construtor como efeito colateral da criação de um objeto pesquisa específico ao serviço (por ex., GwebSearchgoogle.search.WebSearch).

GSearchgoogle.search.Search - Métodos

Método Descrição

.setResultSetSize(indicator)

Este método é chamado para selecionar o número de resultados retornados por esta pesquisa específica. Observe que este método não utiliza escalas. Ele utiliza uma enumeração que indica um pequeno número de resultados ou um grande número de resultados. No futuro, este método pode ser aprimorado para suportar conjuntos de resultados de porte médio e muito grande.

  • indicator - fornece uma enumeração que indica o número desejado de resultados de pesquisa que devem ser retornados. Os valores válidos incluem:
    • GSearchgoogle.search.Search.LARGE_RESULTSET - solicita um grande número de resultados (normalmente 8 resultados)
    • GSearchgoogle.search.Search.SMALL_RESULTSET - solicita um pequeno número de resultados (normalmente 4 resultados)
  • retorna - n/d

.getResultSetSize()

Este método retorna o tamanho atual do conjunto de resultados, o valor estabelecido pelo método anterior.

  • retorna uma enumeração que indica o número atual de resultados de pesquisa que devem ser retornados. Os valores válidos incluem:
    • GSearchgoogle.search.Search.LARGE_RESULTSET - grande número de resultados (normalmente 8 resultados)
    • GSearchgoogle.search.Search.SMALL_RESULTSET - pequeno número de resultados (normalmente 4 resultados)

.clearResults()

Quando uma pesquisa é concluída com sucesso, o objeto de pesquisa retém uma coleção de resultados de pesquisa que descreve a saída de uma pesquisa específica. Este método é usado para restaurar a pesquisa, limpando todos os resultados. Este método é chamado implicitamente antes da execução de uma nova pesquisa.

  • retorna - n/d

.execute(query)

Este método é chamado para iniciar uma nova pesquisa. O argumento query fornece o termo da pesquisa. Quando a pesquisa é concluída, o objeto é preenchido com o conjunto de resultados correspondente e o manipulador registrado de conclusão da pesquisa é chamado.

  • query - fornece o termo de consulta usado para realizar a pesquisa
  • retorna - n/d

.setSearchCompleteCallback(object, method, opt_arguments?)

Este método é usado para registrar um objeto e um método para notificar a conclusão de uma pesquisa. Opcionalmente, os aplicativos podem passar um argumento de contexto através do opt_arguments, que em seguida é passado ao método especificado.

  • object - fornece um objeto de nível de aplicativo que define o contexto no qual o método especificado será chamado.
  • method - fornece o método a ser chamado. Por exemplo, se este método for chamado como .setSearchCompleteCallback(foo, MyObject.prototype.mySearchCompleteHandler), quando uma pesquisa realizada neste mecanismo de pesquisa for concluída, uma chamada para foo.mySearchCompleteHandler(opt_arguments?) será realizada.
  • retorna - n/d

.setUserDefinedLabel(label)

Este método é usado para configurar um marcador definido pelo usuário, que deve ser usado quando esta pesquisa for adicionada a um controle de pesquisa. Ao chamar esta função, o marcador definido pelo usuário especificado será usado no cabeçalho ou na guia da seção de resultados em vez dos marcadores padrão integrados. O uso esperado é em conjunto com a pesquisa restrita ao site, onde é apropriado que os aplicativos indiquem que programaram restrições, através da alteração do marcador.

  • label - fornece um marcador definido pelo usuário que substitui "Web", "Blog" etc. no cabeçalho da seção de resultados.
  • retorna - n/d

.setUserDefinedClassSuffix(classSuffix)

Este método é usado para especificar um sufixo de classe definido pelo usuário para a seção de resultados de pesquisa e para a coleção de resultados de pesquisa produzida por esta pesquisa no controle de pesquisa. A motivação deste método é permitir que os aplicativos definam estilos exclusivos para os resultados e o cabeçalho de um conjunto específico de resultados de pesquisa. Supondo que este método seja chamado com o valor "siteSearch", a classe gsc-resultsRoot-siteSearch será aplicada ao elemento DIV, que contém o cabeçalho e os resultados associados a esta pesquisa. Isso é adicional à classe gsc-resultsRoot genérica.

  • classSuffix - fornece um sufixo de classe definido pelo usuário, que é anexado à classe gsc-resultsRoot-. Esta classe é adicionada ao elemento DIV, que contém o cabeçalho e os resultados associados a esta pesquisa.
  • retorna - n/d

.setLinkTarget(linkTarget)

Este método é chamado para definir o destino do link, usado com os links incorporados nos resultados da pesquisa. O valor padrão é GSearchgoogle.search.Search.LINK_TARGET_BLANK, que especifica que os links serão abertos em uma nova janela do navegador. Quando uma pesquisa é adicionada a um controle de pesquisa, o controle faz uma chamada implícita ao método usando a configuração atual de link de destino do controle de pesquisa. Isso significa que, caso seu aplicativo necessite de uma pesquisa que opere com uma configuração de link de destino diferente daquela estabelecida pelo controle de pesquisa, você deverá chamar este método após adicionar a pesquisa ao controle de pesquisa.

  • linkTarget - fornece o frame de destino dentro do qual os links devem ser abertos. São valores válidos:
    • GSearchgoogle.search.Search.LINK_TARGET_BLANK - os links serão abertos em uma nova janela, por ex., <A href=... target=_blank ...>
    • GSearchgoogle.search.Search.LINK_TARGET_SELF - os links serão abertos na mesma janela e frame, por ex., <A href=...target=_self ...>
    • GSearchgoogle.search.Search.LINK_TARGET_TOP - os links serão abertos no primeiro frame, por ex., <A href=...target=_top ...>
    • GSearchgoogle.search.Search.LINK_TARGET_PARENT - os links serão abertos no primeiro frame ou substituirão o frame atual, por ex.,<A href=... target=_parent ...>
    • anything-else - os links serão abertos no frame ou na janela especificada, por ex., <A href=... target=anything-else ...>
  • retorna - n/d

.setNoHtmlGeneration()

Há algumas vezes em que seu aplicativo não usa o controle de pesquisa, mas apenas um pequeno conjunto de propriedades de um resultado de pesquisa que são exibidas em um formato altamente personalizado. Quando esse for o caso, há uma pequena otimização disponível para o seu aplicativo. A pesquisa pode ser programada para NÃO gerar uma propriedade .html, deixando somente as propriedades básicas válidas em um resultado.

  • n/a - sem argumentos de entrada
  • retorna - n/d

.getAttribution()

Para algumas classes de pesquisa (por ex., GlocalSearchgoogle.search.LocalSearch()), é obrigatório exibir a atribuição ao lado do conjunto de resultados de pesquisa. Ao usar o controle de pesquisa, a atribuição é incluída na lógica do controle de pesquisa "gratuitamente". Se você estiver usando uma pesquisa básica, cabe a você capturar e apresentar a atribuição apropriada. Este método tem a finalidade de fornecer um nó de atribuição (ou nulo, se não for necessária uma atribuição), que você pode exibir apropriadamente.

A exibição da atribuição é obrigatória somente com a exibição ativa de um conjunto de resultados imediatamente após uma pesquisa. O snippet a seguir demonstra um uso simples desta API.

var attribution = GlocalSearchgoogle.search.LocalSearch.getAttribution();
if (attribution) {
  var el = document.getElementById("searchwell");
  el.appendChild(attribution);
}
                

  • n/a - sem argumentos de entrada
  • retorna - non-null : Atribuição obrigatória. O valor retornado é um nó HTML que deve ser adicionado à sua página, em algum local próximo ao conjunto atual de resultados de pesquisa.
  • retorna - null : atribuição não é obrigatória

.setQueryAddition(term)

Este método permite que o originador da chamada defina (ou limpe) um termo de consulta adicional opcional, anexado a todas as consultas que passam pela pesquisa. Os aplicativos normalmente o usam para fornecer resultados alternativos com ligeiras variações em relação ao termo original. Por exemplo, se uma pesquisa for baseada no GwebSearchgoogle.search.WebSearch(), chamar esta função como search.setQueryAddition("filetype:pdf"); e executar uma consulta por "google" resultará na seguinte consulta "google filetype:pdf". Ao usar esta API, recomendamos o uso de .setUserDefinedLabel(), para que você possa indicar para seus usuários que suas consultas foram modificadas. Este é o mesmo conselho geral dado ao usar .setSiteRestriction(). Para obter mais informações, consulte nosso exemplo.

  • term - fornece uma expressão que é anexada a cada consulta que passa por esta pesquisa (não é necessário fornecer um espaço). Quando o valor do termo é "", o efeito desta API é cancelado e as consultas não são modificadas.
  • retorna - n/d

.createResultHtml(result)

Este método permite que o originador da chamada crie ou gere novamente a propriedade .html do resultado especificado. Às vezes, isso é necessário quando o originador da chamada usou .setNoHtmlGeneration() anteriormente, ou quando está recarregando um objeto de resultado do seu próprio sistema de armazenamento.

  • result - fornece um objeto de resultado. Sua propriedade .html será excluída e gerada novamente como um resultado desta chamada. Se o resultado não contém uma propriedade .html, esta será criada.
  • retorna - n/d

.gotoPage(page)

Depois de concluída a pesquisa, a propriedade cursor poderá se tornar visível na opção de pesquisa. Esta é uma função do número de resultados de pesquisa disponíveis, bem como dos recursos da pesquisa usada. Se a propriedade cursor estiver presente, este método permitirá obter outro pacote de resultados de pesquisa. Os aplicativos especificam a página, usando o argumento page. Em seguida, este valor é usado para indexar a matriz cursor.pages, que finalmente será usada para calcular o valor do argumento &start& do URL.

  • page - fornece o número da página dos resultados desejados pelo aplicativo. Este valor é um intervalo verificado em relação à propriedade .cursor.pages e nenhuma operação será executada caso a página esteja fora do intervalo, ou se a pesquisa utilizada não tiver a propriedade cursor.
  • retorna - n/d

GSearchgoogle.search.Search - Métodos estáticos

Método estático Descrição

.scaleImage(width, height, imageScaler, opt_img)

Este método é uma função auxiliar estática que pode ser usada para redimensionar uma imagem proporcionalmente. Você passa a largura e a altura da imagem atual, além do objeto imageScaler (contendo as propriedades .width e .height). A função calcula e retorna um objeto imageScaler redimensionado proporcionalmente. Você pode usar as propriedades .height e .width deste objeto para criar um elemento de imagem.

Internamente, o objeto GvideoSearchgoogle.search.VideoSearch define um redimensionador de imagem e o utiliza para dimensionar as miniaturas. Ele é designado para manter a proporção 4 x 3 e é definido como mostrado abaixo.

// imageScaling defaults 4x3 100x75 image
this.imageScaler = {width:100,height:75};
                

Ao criar o elemento img em miniatura, ele calcula a altura e a largura proporcionais da imagem da miniatura, como mostrado abaixo:

// scale the thumbnail image using the searcher's .imageScaler.
// By default this is a 4x3 100x75 image,
// but its settable using .setVideoResultsTbHeight as well
var scaled = GSearchgoogle.search.Search.scaleImage(result.tbWidth,
                                result.tbHeight,  this.imageScaler);

// scaled.height and scaled.width now contain
// the values needed to proportionally scale the thumbnail
                

  • width - a largura original da imagem
  • height - a altura original da imagem
  • imageScaler - um objeto imageScaler que especifica em suas propriedades .height e .width a caixa altura/largura desejada na qual a imagem deve ser encaixada.
  • opt_img - fornece um objeto img opcional. Se especificado, suas propriedades .height e .width são definidas por esta chamada.
  • retorna - um objeto imageScaler cujas propriedades .height e .width contêm as dimensões da imagem redimensionada proporcionalmente

.getBranding(opt_element?, opt_orientation?)

Este método é uma função auxiliar estática que retorna um nó HTML DOM da marca "powered by Google" ao aplicativo e, opcionalmente, o conecta ao documento como o único filho do elemento opcional especificado. A finalidade deste método é assegurar ao aplicativo uma maneira simples de atender aos requisitos de marca em situações nas quais o uso do formulário de pesquisa no GSearchControlgoogle.search.SearchControl ou no GSearchFormgoogle.search.SearchForm não é apropriado ao seu aplicativo.

Por padrão, o nó da marca tem orientação horizontal e funciona bem sob um formulário de pesquisa, acima ou abaixo de uma coleção de resultados etc. Em alguns casos, é necessária uma orientação vertical da marca. Como exemplo, imagine uma Barra de vídeo com orientação vertical. Nesse caso, como as necessidades da marca são muito estreitas, é necessária uma orientação vertical da marca (veja a marca "powered by Google" na parte inferior da Barra de vídeo). Como padrão, esta API fornece orientação horizontal, mas você pode solicitar facilmente a orientação vertical no aplicativo.

  • opt_element - um argumento opcional que, se fornecido, especifica o nó HTML DOM que será preenchido com um elemento da marca "powered by Google".
  • opt_orientation - um argumento opcional que, se fornecido, especifica a orientação do nó da marca. Os valores válidos incluem:
    • GSearchgoogle.search.Search.HORIZONTAL_BRANDING - solicita orientação horizontal
    • GSearchgoogle.search.Search.VERTICAL_BRANDING - solicita orientação vertical
  • retorna - um nó HTML DOM da marca "powered by Google" que pode ser incluído ou clonado no documento.

.setOnLoadCallback(handler)

Este método é uma função auxiliar estática que registra a função do manipulador especificado a ser chamada quando o documento que contém esta chamada é carregado. A documentação anterior recomendava o uso do atributo onload do elemento body (por ex., <body onload="OnLoad()">). Embora esta seja uma boa maneira de operar quando você tem controle completo da página e de todo o código carregado por ela, este método pode causar problemas com alguns tempos de execução, que destroem seu manipulador body.onload. O método setOnLoadCallback() não tem esse problema, sendo portanto a forma recomendada para registrar um retorno de chamada que chama seu código quando o documento é carregado (um determinado momento em que as APIs AJAX de pesquisa do Google estejam completamente carregadas e prontas para uso).

  • handler - uma função obrigatória que será chamada quando o documento que a contém for carregado e quando a API estiver pronta para uso.
  • retorna - n/d

GSearchgoogle.search.Search - Métodos

A coleção de propriedades públicas abaixo é utilizada por todos os objetos que implementam esta interface. A menos que indicado em contrário, estas propriedades são somente para leitura.

Propriedade Descrição

.results[]

Esta propriedade contém uma matriz de objetos de resultado de pesquisa, um para cada resultado. Esta propriedade é apagada cada vez que uma pesquisa é executada, e a matriz é preenchida cada vez que uma pesquisa é concluída. Se não houver resultados a relatar, a propriedade .length desta matriz será definida como 0.

.cursor

Esta propriedade opcional está presente quando uma pesquisa é concluída com sucesso. Quando presente, a propriedade especifica como um aplicativo pode solicitar resultados de pesquisa adicionais para o termo de consulta atual, a contagem estimada de resultados, a página atual e o url que pode ser usado para apontar para uma página de resultados de pesquisa hospedada no Google. A propriedade tem a estrutura abaixo:

  • .pages[]- fornece uma matriz usada por .gotoPage() para recuperar um pacote de resultados. Cada entrada da matriz é um objeto com a seguinte estrutura:
    • .start - fornece o valor que será usado no argumento &start& do URL para solicitar um pacote de resultados
    • .label - fornece um marcador de texto associado à entrada, por ex., "1", "2", "3" ou "4"
  • .estimatedResultCount - fornece o número estimado de resultados que correspondem à consulta atual. Este valor não necessariamente corresponde ao valor semelhante visível nas propriedades de pesquisa do Google.com.
  • .currentPageIndex - fornece o índice à matriz pages do conjunto atual de resultados.
  • .moreResultsUrl - fornece um url para uma página de pesquisa hospedada no Google contendo resultados de pesquisa adicionais.

Observação: O número máximo de páginas de resultado tem base no tipo da pesquisa. A pesquisa local suporta 4 páginas (ou um máximo de 32 resultados no total) e as outras pesquisas (Pesquisa de blogs do Google, Pesquisa de Livros do Google, Pesquisa de imagens do Google, Pesquisa de notícias do Google, Pesquisa de patentes do Google, Pesquisa de vídeos do Google e Pesquisa na web do Google) suportam 8 páginas (máximo de 64 resultados no total).

GwebSearchgoogle.search.WebSearch

Este objeto implementa a interface GSearchgoogle.search.Search sobre o serviço Pesquisa na web do Google. Quando a pesquisa é concluída, ele fornece uma coleção de objetos GwebResult.

GwebSearchgoogle.search.WebSearch - Construtor

Construtor Descrição

GwebSearchgoogle.search.WebSearch()

O construtor é usado para criar uma instância de um objeto de pesquisa para fornecer resultados de pesquisa a partir do serviço Pesquisa na web do Google.

GwebSearchgoogle.search.WebSearch - Construtor

Método Descrição

.setSiteRestriction(site, opt_refinement, opt_moreResultsTemplate)

Este método é usado para restringir o conjunto de resultados de pesquisa da web retornados por esta pesquisa. Para restringir a pesquisa ao site www.amazon.com, basta chamar este método e passar o valor "www.amazon.com". Para limpar as restrições de site, passe o valor null. O snippet a seguir demonstra isso, configurando uma restrição para "amazon.com". Um exemplo mais completo pode ser encontrado no Exemplo de restrições de site.

var siteSearch = new GwebSearchgoogle.search.WebSearch();
siteSearch.setSiteRestriction("amazon.com");
                

Este método também permite que o originador da chamada restrinja as pesquisas a um mecanismo de pesquisa personalizado do Google. Em vez de especificar um caminho de URL para este método, passe o ID do mecanismo de pesquisa personalizado. O snippet abaixo demonstra como configurar uma restrição de site para um mecanismo de pesquisa personalizado cujo id é 000455696194071821846:reviews. Um exemplo mais completo está disponível em Mecanismo de pesquisa personalizado do Google.

var siteSearch = new GwebSearchgoogle.search.WebSearch();
siteSearch.setSiteRestriction("000455696194071821846:reviews");
                

Quando usado desta forma, pode ser fornecido um refinamento do mecanismo de pesquisa personalizado opcional através de opt_refinement. Usando esse mecanismo, você pode restringir o site a um subconjunto de seu mecanismo de pesquisa. O valor especificado em opt_refinement deve corresponder a um marcador de refinamento do mecanismo de pesquisa personalizado, associado ao mecanismo de pesquisa especificado (veja o snippet de código abaixo). Um exemplo mais completo pode ser encontrado no Exemplo de pesquisa de currículo.

var cseId = "017576662512468239146:omuauf_lfve";
var siteSearch = new GwebSearchgoogle.search.WebSearch();
siteSearch.setSiteRestriction(cseId, "Lectures");
                

Os mecanismos de pesquisa personalizados frequentemente incluem uma página personalizada de resultados de pesquisa. Para suportar esse recurso, você pode fornecer um valor opt_moreResultsTemplate opcional quando as restrições de site do mecanismo de pesquisa personalizado estiverem em vigor. Isso especifica um modelo de URL que será usado para gerar o link "Mais resultados" na parte inferior de um conjunto de resultados de pesquisa. O modelo do URL deve incluir uma variável "__QUERY__" e "__HL__". Ao gerar o link "Mais resultados", o sistema substituirá essas variáveis pelo termo atual de consulta e pelo idioma da IU. Este exemplo demonstra o uso deste mecanismo para a guia principal, localizada à esquerda: Exemplo de pesquisa de currículo.

A última adição aos mecanismos de pesquisa personalizado é o recurso que permite usar Mecanismos de pesquisa personalizados vinculados. Para isso, o argumento site foi ampliado para suportar todas as opções e modos listados acima, além do novo modo de especificação de uma restrição de site com objeto anônimo. Quando o argumentoo site for um objeto, uma das propriedades abaixo poderá estar presente (listada em ordem de prioridade, o que significa que, se você fornecer diversas propriedades, a primeira que testarmos na ordem listada abaixo será escolhida):

  • siteUrl - A pesquisa é baseada no URL fornecido
  • cseId - A pesquisa é baseada no ID do mecanismo personalizado de pesquisa fornecido, por ex., 000455696194071821846:reviews)
  • crefUrl - A pesquisa é baseada no mecanismo personalizado de pesquisa vinculado, para o qual o URL fornecido aponta. Para obter mais detalhes, veja este exemplo.

Quando cseId ou crefUrl for especificado, pode ser fornecido um refinamento do mecanismo de pesquisa personalizado opcional através de opt_refinement. Usando esse mecanismo, você pode restringir o site a um subconjunto de seu mecanismo de pesquisa. O valor especificado em opt_refinement deve corresponder a um marcador de refinamento do mecanismo de pesquisa personalizado, associado ao mecanismo de pesquisa especificado (veja o snippet de código abaixo).

searcher = new google.search.WebSearch();
searcher.setSiteRestriction(
  {
    crefUrl : "http://www.google.com/cse/samples/vegetarian.xml"
  },
  "recipes");
                
  • site - fornece uma configuração de restrição de site na forma de um URL parcial (por ex., "www.amazon.com", "google.com" etc.), ou de um ID de mecanismo de pesquisa personalizado (por ex., "000455696194071821846:reviews", "000455696194071821846:shopping" etc.) Como alternativa, pode conter um objeto anônimo como descrito acima.
  • opt_refinement - quando site refere-se a um mecanismo de pesquisa personalizado, o valor deste argumento opcional especifica um refinamento do mecanismo de pesquisa personalizado
  • opt_moreResultsTemplate - quando site refere-se a um mecanismo de pesquisa personalizado, o valor deste argumento opcional especifica um modelo de URL que será usado para construir o link "Mais resultados", que aparece abaixo de um conjunto de resultados de pesquisa no controle de pesquisa. O modelo do URL deve incluir uma variável "__QUERY__" e "__HL__". Ao gerar o link "Mais resultados", o sistema substituirá essas variáveis pelo termo atual de consulta e pelo idioma da IU.
  • retorna - n/d

.setRestriction(type, opt_value)

Este método é usado para especificar ou limpar uma restrição do conjunto de resultados retornado por esta pesquisa. Para estabelecer uma restrição, você deve fornecer type e opt_value e ambos devem ser válidos. Para limpar uma restrição, forneça um valor válido para type e especifique null para o valor de opt_value, ou não o forneça. No momento, esta API suporta os tipos de restrição abaixo:

  • GSearchgoogle.search.Search.RESTRICT_SAFESEARCH - Quando especificado como o valor de type, os resultados da pesquisa na web são restritos às imagens com base no valor do safesearch. Os valores opcionais válidos para este tipo são:
    • GSearchgoogle.search.Search.SAFESEARCH_STRICT - aplica filtragem rígida tanto para texto quanto para imagens explícitas (o comportamento padrão)
    • GSearchgoogle.search.Search.SAFESEARCH_MODERATE - aplica filtragem de imagens explícitas
    • GSearchgoogle.search.Search.SAFESEARCH_OFF - não aplica filtragem SafeSearch
    O snippet de código a seguir demonstra como desativar a filtragem do SafeSearch.
    var searcher = new google.search.WebSearch();
    searcher.setRestriction(google.search.Search.RESTRICT_SAFESEARCH,
                            google.search.Search.SAFESEARCH_OFF);
  • GSearchgoogle.search.Search.RESTRICT_EXTENDED_ARGS Novo! - Quando isso é especificado, o valor é um objeto contendo os pares de valor de nome nos quais o nome pode ser lr ou filter e o valor para cada um é o valor associado ao argumento cgi conforme documentado abaixo.

    Por exemplo, a seguinte sequência de código restringe uma pesquisa na web à Alemanha e desativa o filtro de conteúdo duplicado

    searcher = new google.search.WebSearch()
    searcher.setRestriction(google.search.Search.RESTRICT_EXTENDED_ARGS,
                            { "lr" : "lang_de", "filter" : "0"});

GlocalSearchgoogle.search.LocalSearch

Este objeto implementa a interface GSearchgoogle.search.Search sobre o serviço Pesquisa local do Google. Quando a pesquisa é concluída, ele fornece uma coleção de objetos GlocalResult.

Este objeto tem a finalidade de produzir resultados de pesquisa relacionados a uma região geográfica. O objeto fornece uma API que permite que os aplicativos delimitem esta região geográfica, fornecendo uma string de local (cidade/estado, um CEP, um endereço); fornecendo um objeto GLatLnggoogle.maps.LatLng() (consulte o Google Maps), ou fornecendo um objeto GMap2google.maps.Map2() (consulte o Google Maps). A interface recomendável é GLatLnggoogle.maps.LatLng() ou GMap2google.maps.Map2(). Você pode ter percebido nos exemplos a presença de um controle "set location" (definir local) na pilha de resultados da pesquisa local. Esta IU é implementada através da coordenação entre o controle de pesquisa e este objeto. O mapa projetado através do controle de pesquisa abrange todos os resultados de pesquisa e seu valor inicial (ponto central) é estabelecido através da programação deste objeto. O controle de pesquisa não mantém preferências no ponto central. Esta é uma responsabilidade do aplicativo que usa esta API.

Observação: Se não for especificada uma localização, este objeto abrange os resultados da pesquisa da área de São Francisco, Califórnia. Um padrão mais elaborado está sendo considerado, para levar em consideração a região geográfica do usuário.

GlocalSearchgoogle.search.LocalSearch - Construtor

Construtor Descrição

GlocalSearchgoogle.search.LocalSearch()

O construtor é usado para criar uma instância de um objeto de pesquisa para fornecer resultados de pesquisa a partir do serviço Pesquisa local do Google.

GlocalSearchgoogle.search.LocalSearch - Construtor

Método Descrição

.setCenterPoint(location)

Este método estabelece um ponto central que é usado para delimitar os resultados de pesquisa. Ele aceita uma única variante, que pode ser uma string, um GMap2google.maps.Map2 ou GLatLnggoogle.maps.LatLng No caso da string, é realizada uma tentativa de converter a string em GLatLnggoogle.maps.LatLng.

  • location - fornece uma designação do ponto central usado para delimitar pesquisas locais. este argumento é uma variante e pode especificar:
    • um GMap2google.maps.Map2, o que é observado pela presença da propriedade getCenter(). Quando for esse o caso, o ponto central do mapa especificado é capturado e usado para delimitar os resultados da pesquisa.
    • um GLatLnggoogle.maps.LatLng, o que é observado pela presença de uma propriedade x. Quando for esse o caso, o valor deste ponto é capturado e usado como ponto central para delimitar as pesquisas locais.
    • um string que especifica um endereço por nome. Quando esse argumento é apresentado, as pesquisas são delimitadas como se o usuário tivesse realizado uma Pesquisa local do Google e especificado a localização próxima como parte da expressão de sua pesquisa. Observação: A localização da string é convertida em GLatLnggoogle.maps.LatLng de forma assíncrona. Assim, se esse método for usado, as pesquisas serão realizadas com base nessa localização, depois da operação de geocodificação ser concluída com sucesso.
  • retorna - n/d

.setAddressLookupMode(mode)

O comportamento padrão desta pesquisa é misturar os resultados da pesquisa de endereços (por ex., NY, NY) aos resultados da pesquisa local. Há situações onde esta abordagem misturada não é o comportamento desejado. Por exemplo, suponha que o centro da pesquisa seja em Santa Barbara, CA e o usuário esteja pesquisando o termo "Cava". Com os resultados misturados, o primeiro resultado da pesquisa é um endereço que corresponde a "Cava Close, Aberdeen City, AB15 UK". O segundo resultado é "Cava Restaurant & Bar". Usando este método, os aplicativos podem desativar e ativar a pesquisa de endereços, produzindo resultados estritamente de pesquisa, ou resultados de consulta de endereços misturados aos resultados de pesquisa. Nesse caso, se a consulta de endereço fosse desativada, o primeiro resultado seria "Cava Restaurant & Bar".

  • mode - fornece o modo de consulta de endereço desejado:
    • GlocalSearchgoogle.search.LocalSearch.ADDRESS_LOOKUP_DISABLED - Desativa a consulta de endereço e produz somente resultados de pesquisa.
    • GlocalSearchgoogle.search.LocalSearch.ADDRESS_LOOKUP_ENABLED - Ativa a consulta de endereço, produzindo resultados mistos. Este é o padrão.
  • retorna - n/d

.setRestriction(type, opt_value)

Este método é usado para especificar ou limpar uma restrição do conjunto de resultados retornado por esta pesquisa. Para estabelecer uma restrição, você deve fornecer type e opt_value e ambos devem ser válidos. Para limpar uma restrição, forneça um valor válido para type e especifique null para o valor de opt_value, ou não o forneça.

No momento, esta API suporta os tipos de restrição abaixo:

  • GSearchgoogle.search.Search.RESTRICT_TYPE - Quando isso é especificado como o valor de type, fornecendo um opt_value de:
    • GlocalSearchgoogle.search.LocalSearch.TYPE_BLENDED_RESULT - retorna uma combinação dos resultados KML e das listas e geocódigos normais e locais.
    • GlocalSearchgoogle.search.LocalSearch.TYPE_KMLONLY_RESULTS - retorna apenas os resultados KML e os resultados de geocódigo.
    • GlocalSearchgoogle.search.LocalSearch.TYPE_LOCALONLY_RESULTS - retorna apenas os resultados LOCAIS de lista e de geocódigo (observação: este é o comportamento padrão e é idêntico ao comportamento histórico da API).

Esse método aceita os seguintes argumentos:

  • type - fornece o tipo de restrição a ser estabelecido:
    • GSearchgoogle.search.Search.RESTRICT_TYPE
  • opt_value - fornece o valor do tipo de restrição especificado. Se o valor for null, a restrição especificada é apagada e o comportamento padrão é restaurado. Caso contrário, o valor deverá ser válido em relação ao valor de type. Nesse caso, ele estabelecerá uma restrição. Veja acima.

GlocalSearchgoogle.search.LocalSearch - Métodos estáticos

Método estático Descrição

.resizeStaticMapUrl(result, height, width, opt_zoom?)

Esta função auxiliar tem a finalidade de redimensionar a imagem associada à propriedade staticMapUrl do resultado especificado. Quando a pesquisa é concluída, esta propriedade é substituída por um novo valor que representa a imagem estática do mapa redimensionada. Um parâmetro opcional de zoom pode ser passado, permitindo que o tamanho e o nível de zoom sejam manipulados por este método. O tamanho padrão de uma imagem estática de mapa é 150px x 100px, com um nível moderado de zoom de GlocalSearchgoogle.search.LocalSearch.STATIC_MAP_ZOOM_DEFAULT. O exemplo Painel de mapa estático demonstra como usar este método (veja o snippet abaixo).

var img = document.createElement("img");
google.search.LocalSearch.resizeStaticMapUrl(result, 80, 120);
img.src = result.staticMapUrl;
img.title = result.titleNoFormatting;
                

  • result - fornece o objeto result, cuja imagem de mapa estática será redimensionada. Quando a pesquisa é concluída, a propriedade staticMapUrl deste objeto result é modificada.
  • height - fornece a altura, em pixels, da nova imagem. A altura padrão é 100 pixels.
  • width - fornece a largura, em pixels, da nova imagem. A largura padrão é 150 pixels.
  • opt_zoom - fornece um nível de zoom opcional ao mapa. Se não for especificado um nível de zoom, o valor não é alterado e o padrão é GlocalSearchgoogle.search.LocalSearch.STATIC_MAP_ZOOM_DEFAULT. Os valores válidos incluem de GlocalSearchgoogle.search.LocalSearch.STATIC_MAP_ZOOM_CLOSEST a GlocalSearchgoogle.search.LocalSearch.STATIC_MAP_ZOOM_FARTHEST.
  • retorna - o novo valor de staticMapUrl é retornado.

.computeStaticMapUrl(results, height, width, opt_zoom?)

Esta função auxiliar tem a finalidade de criar uma imagem de mapa estática com a coleção de pontos fornecida pelo originador da chamada. Os pontos podem estar na forma de uma coleção de objetos de resultado de pesquisa, uma coleção de objetos contendo uma .lat numérica e a propriedade .lng ou uma coleção de objetos GLatLnggoogle.maps.LatLng. Apenas os primeiros objetos GlocalSearchgoogle.search.LocalSearch.STATIC_MAP_MAX_POINTS são considerados para inclusão. O exemplo Painel de mapa estático demonstra como usar este método. Neste exemplo, é criado um mapa estático a partir de uma coleção de localizações no norte da Europa. Este mapa padrão é mostrado quando não houver resultados de pesquisa. Quando uma pesquisa é concluída, uma nova imagem de mapa é calculada com a coleção dos resultados da pesquisa.

// demonstrate computeStaticMapUrl with simple point array
this.worldPointsUrl = google.search.LocalSearch.computeStaticMapUrl(
                        worldPoints,350, 400);
document.getElementById("resultsImg").src =
                        this.worldPointsUrl;
...
var worldPoints = [
  { lat : 48.8565, lng : 2.3509 },      // paris
  { lat : 52.5238, lng : 13.4119},      // berlin
  { lat : 52.3738, lng : 4.8909},       // amsterdam
  { lat : 55.676294, lng : 12.568115},  // copenhagen
  { lat : 60.160791, lng : 24.952548},  // helsinki
  { lat : 59.332725, lng : 18.064454},  // stockholm
  { lat : 59.913820, lng : 10.738741}   // oslo
];
                

  • results - fornece uma matriz de objetos a serem indicados na imagem estática do mapa.
  • height - fornece a altura, em pixels, da nova imagem.
  • width - fornece a largura, em pixels, da nova imagem.
  • opt_zoom - fornece um nível de zoom opcional ao mapa. Se não for especificado um nível de zoom, o sistema calculará um nível de zoom apropriado. Se fornecido, os valores válidos incluem: GlocalSearchgoogle.search.LocalSearch.STATIC_MAP_ZOOM_CLOSEST a GlocalSearchgoogle.search.LocalSearch.STATIC_MAP_ZOOM_FARTHEST.
  • retorna - o url do mapa estático para esta coleção de pontos.

GvideoSearchgoogle.search.VideoSearch

Este objeto implementa a interface GSearchgoogle.search.Search sobre o serviço Pesquisa de vídeos do Google. Quando a pesquisa é concluída, ele fornece uma coleção de objetos GvideoResult.

É importante observar que esta pesquisa é desenvolvida para acessar o YouTube e o Google Video. Na maior parte dos casos, as diferenças no formato do resultado e do reprodutor são mínimas. Em alguns casos, os aplicativos, por meio de predicados de consulta especializados, podem acessar diretamente os Canais do YouTube e os Feeds especiais. Os seguintes predicados de consulta apenas para YouTube são suportados

Predicados de consulta do YouTube

Predicado Descrição
ytchannel:name-of-channel expression?

O predicado ytchannel: permite que o seu aplicativo execute uma pesquisa e obtenha apenas resultados de vídeos do canal especificado. Por exemplo, uma expressão de pesquisa de ytchannel:BarackObamadotcomretornará uma coleção de vídeos do Canal do YouTube BarackObamadotcom. Ao fornecer uma expressão opcional e adicional logo após a diretiva ytchannel, seu aplicativo pode pesquisar a expressão dentro do canal selecionado, por exemplo, ytchannel:BarackObamadotcom oil.

ytfeed:top_rated[.this_week | .this_month | .all_time]

O predicado ytfeed:top_rated permite que o seu aplicativo execute uma pesquisa e obtenha apenas resultados de vídeos do Feed do YouTube "melhor classificação". Ao usar o qualificador .this_week, .this_month ou .all_time, o feed é limitado ao período especificado. Como o predicado ytchannel:, o predicado ytfeed: suporta a pesquisa dentro de um feed por exemplo, ytfeed:top_rated.this_week news.

ytfeed:{most_viewed, recently_featured}[this_week | .this_month | .all_time]

Os predicados ytfeed:most_viewed e ytfeed:recently_featured são quase idênticos ao ytfeed:top_rated. A diferença é que eles são direcionados a feeds especiais diferentes no YouTube.

GvideoSearchgoogle.search.VideoSearch - Construtor

Construtor Descrição

GvideoSearchgoogle.search.VideoSearch()

O construtor é usado para criar uma instância de um objeto de pesquisa para fornecer resultados de pesquisa a partir do serviço Pesquisa na web do Google.

GvideoSearchgoogle.search.VideoSearch - Construtor

Método Descrição

.setResultOrder(orderBy)

O comportamento padrão desta pesquisa é retornar resultados em ordem de relevância. Em alguns casos, é útil ver os resultados ordenados por data. Este método pode ser usado para alterar a ordem dos resultados.

  • orderBy - fornece a ordem de resultados desejada:
    • GSearchgoogle.search.Search.ORDER_BY_RELEVANCE - Este é o padrão e indica que os resultados devem ser retornados em ordem de relevância.
    • GSearchgoogle.search.Search.ORDER_BY_DATE - Este valor indica que os resultados devem ser retornados em ordem de data de publicação.
  • retorna - n/d

GblogSearchgoogle.search.BlogSearch

Este objeto implementa a interface GSearchgoogle.search.Search sobre o serviço Pesquisa de blogs do Google. Quando a pesquisa é concluída, ele fornece uma coleção de objetos GblogResultgoogle.search.BlogResult.

GblogSearchgoogle.search.BlogSearch - Construtor

Construtor Descrição

GblogSearchgoogle.search.BlogSearch()

O construtor é usado para criar uma instância de um objeto de pesquisa para fornecer resultados de pesquisa a partir do serviço Pesquisa de blogs do Google.

GblogSearchgoogle.search.BlogSearch - Construtor

Método Descrição

.setSiteRestriction(site)

Este método é usado para restringir o conjunto de resultados de pesquisa em blogs retornados por esta pesquisa. Para restringir os resultados a todos os resultados de blogs do blogspot.com, basta chamar este método com o valor "blogspot.com". Para restringir os resultados ao blog Nintendo DS no Live Journal, basta chamá-lo com "http://community.livejournal.com/nintendo_ds/". Para limpar as restrições de site, passe o valor null.

  • site - fornece uma configuração de restrição de site por ex., "blogspot.com", "http://community.livejournal.com/nintendo_ds/" etc.
  • retorna - n/d

.setResultOrder(orderBy)

O comportamento padrão desta pesquisa é retornar resultados em ordem de relevância. Em alguns casos, é útil ver os resultados ordenados por data. Este método pode ser usado para alterar a ordem dos resultados.

  • orderBy - fornece a ordem de resultados desejada:
    • GSearchgoogle.search.Search.ORDER_BY_RELEVANCE - Este é o padrão e indica que os resultados devem ser retornados em ordem de relevância.
    • GSearchgoogle.search.Search.ORDER_BY_DATE - Este valor indica que os resultados devem ser retornados em ordem de data de publicação.
  • retorna - n/d

GnewsSearchgoogle.search.NewsSearch

Este objeto implementa a interface GSearchgoogle.search.Search sobre o serviço Pesquisa de notícias do Google. Quando a pesquisa é concluída, ele fornece uma coleção de objetos GnewsSearchgoogle.search.NewsResult.

GnewsSearchgoogle.search.NewsSearch - Construtor

Construtor Descrição

GnewsSearchgoogle.search.NewsSearch()

O construtor é usado para criar uma instância de um objeto de pesquisa para fornecer resultados de pesquisa a partir do serviço Pesquisa de notícias do Google.

GnewsSearchgoogle.search.NewsSearch - Construtor

Método Descrição

.setSiteRestriction(site)

Este método é usado para restringir o conjunto de resultados de pesquisa de notícias retornados por esta pesquisa. Para restringir os resultados a todos os resultados do Seattle Times, basta chamar este método com o valor "Seattle Times". Para restringir os resultados a resultados da CNN, basta fazer a chamada com "CNN". O padrão é separar o título da origem das notícias com espaços ou com o caractere de sublinhado (por ex., "_"). Para limpar as restrições de site, passe o valor null.

  • site - fornece uma configuração de restrição de site por ex., "Seattle Times", "CNN" etc.
  • retorna - n/d

.setResultOrder(orderBy)

O comportamento padrão desta pesquisa é retornar resultados em ordem de relevância. Em alguns casos, é útil ver os resultados ordenados por data. Este método pode ser usado para alterar a ordem dos resultados.

  • orderBy - fornece a ordem de resultados desejada:
    • GSearchgoogle.search.Search.ORDER_BY_RELEVANCE - Este é o padrão e indica que os resultados devem ser retornados em ordem de relevância.
    • GSearchgoogle.search.Search.ORDER_BY_DATE - Este valor indica que os resultados devem ser retornados em ordem de data de publicação.
  • retorna - n/d

.setRestriction(type, value)

Este método é usado para restringir o conjunto de resultados da pesquisa de notícias retornado por essa pesquisa além das restrições normais do site. O primeiro argumento, type, especifica o tipo de restrição desejada e, assim, o valor é específico do tipo. Um valor null sempre apaga a restrição selecionada.

  • type - fornece o tipo de restrição. O único valor suportado no momento é GSearchgoogle.search.Search.RESTRICT_EXTENDED_ARGS
  • value - fornece o valor da restrição ou null para apagar a restrição. Com um type de GSearchgoogle.search.Search.RESTRICT_EXTENDED_ARGS, este argumento especifica um objeto contendo pares de valores de nome nos quais o nome pode ser um dos geo, qsid, topic, or ned e o valor de cada um é o valor associado ao argumento cgi, conforme documentado abaixo.

    Por exemplo, a sequência de código a seguir restringe uma pesquisa de notícias ao tópico de negócios, na edição alemã do Google Notícias.

    searcher = new google.search.NewsSearch()
    searcher.setRestriction(google.search.Search.RESTRICT_EXTENDED_ARGS,
                            { "topic" : "b", "ned" : "de"});
                      

  • retorna - n/d

GbookSearchgoogle.search.BookSearch (experimental)

Este objeto implementa a interface GSearchgoogle.search.Search sobre o serviço Pesquisa de Livros do Google. Quando a pesquisa é concluída, ele fornece uma coleção de objetos GbookResult.

GbookSearchgoogle.search.BookSearch - Construtor

Construtor Descrição

GbookSearchgoogle.search.BookSearch()

O construtor é usado para criar uma instância de um objeto de pesquisa para fornecer resultados de pesquisa a partir do serviço Pesquisa de Livros do Google.

GbookSearchgoogle.search.BookSearch - Construtor

Método Descrição

.setRestriction(type, opt_value)

Este método é usado para especificar ou limpar uma restrição do conjunto de resultados retornado por esta pesquisa. Para estabelecer uma restrição, você deve fornecer type e opt_value e ambos devem ser válidos. Para limpar uma restrição, forneça um valor válido para type e especifique null para o valor de opt_value, ou não o forneça.

No momento, esta API suporta os tipos de restrição abaixo:

  • GSearchgoogle.search.Search.RESTRICT_TYPE - Quando especificado como o valor de type, o fornecimento de um opt_value de GbookSearchgoogle.search.BookSearch.TYPE_FULL_VIEW_BOOKS, restringe os resultados para somente "Livros de visualização completa". Fornecer o valor GbookSearchgoogle.search.BookSearch.TYPE_ALL_BOOKS permite que a pesquisa retorne todos os livros. Este é o padrão e o comportamento tem efeito quando a restrição GSearchgoogle.search.Search.RESTRICT_TYPE é removida.
  • GSearchgoogle.search.BookSearch.USER_LIST - Quando especificado como o valor de type, o valor de opt_value é usado para especificar uma biblioteca de usuário. As consultas são restritas somente aos livros presentes nesta biblioteca. Fornecer o valor null remove esta restrição, permitindo que as pesquisas vejam todos os livros de todas as bibliotecas. Este é o comportamento padrão.

  • type - fornece o tipo de restrição a ser estabelecido:
    • GSearchgoogle.search.Search.RESTRICT_TYPE
    • GSearchgoogle.search.BookSearch.USER_LIST
  • opt_value - fornece o valor do tipo de restrição especificado. Se o valor for nulo, a restrição especificada será removida. Caso contrário, o valor deverá ser válido em relação ao valor de type. Nesse caso, ele estabelecerá uma restrição. Veja acima.

GimageSearchgoogle.search.ImageSearch

Este objeto implementa a interface GSearchgoogle.search.Search sobre o serviço Pesquisa de imagens do Google. Quando a pesquisa é concluída, ela fornece uma coleção de objetos GimageSearchgoogle.search.ImageSearch. Observação: Os resultados podem ser restringidos ao arquivo de fotos LIFE incluindo source:life como parte da consulta (experimental).

GimageSearchgoogle.search.ImageSearch - Construtor

Construtor Descrição

GimageSearchgoogle.search.ImageSearch()

O construtor é usado para criar uma instância de um objeto de pesquisa para fornecer resultados de pesquisa a partir do serviço Pesquisa de imagens do Google.

GimageSearchgoogle.search.ImageSearch - Construtor

Método Descrição

.setRestriction(type, opt_value)

Este método é usado para especificar ou limpar uma restrição do conjunto de resultados retornado por esta pesquisa. Para estabelecer uma restrição, você deve fornecer type e opt_value e ambos devem ser válidos. Para limpar uma restrição, forneça um valor válido para type e especifique null para o valor de opt_value, ou não forneça o argumento opt_value

No momento, esta API suporta os tipos de restrição abaixo:

  • GSearchgoogle.search.Search.RESTRICT_SAFESEARCH - Quando especificado como o valor de type, os resultados da pesquisa de imagens são restritos às imagens com base no valor do SafeSearch. Os valores opcionais válidos para este tipo são:
    • GSearchgoogle.search.Search.SAFESEARCH_STRICT - aplica filtragem rígida tanto para texto quanto para imagens explícitas
    • GSearchgoogle.search.Search.SAFESEARCH_MODERATE - aplica filtragem de imagens explícitas (o comportamento padrão)
    • GSearchgoogle.search.Search.SAFESEARCH_OFF - não aplica filtragem SafeSearch
    O snippet de código a seguir demonstra como desativar a filtragem do SafeSearch.
    var searcher = new google.search.ImageSearch();
    searcher.setRestriction(google.search.Search.RESTRICT_SAFESEARCH,
                            google.search.Search.SAFESEARCH_OFF);
                    
  • GimageSearchgoogle.search.ImageSearch.RESTRICT_IMAGESIZE - Quando especificado como o valor de type, os resultados da pesquisa de imagens são restritos às imagens com determinadas dimensões em pixels. Os valores opcionais válidos para este tipo são:
    • GimageSearchgoogle.search.ImageSearch.IMAGESIZE_SMALL - restringe a imagens pequenas e ícones
    • GimageSearchgoogle.search.ImageSearch.IMAGESIZE_MEDIUM - restringe a imagens coloridas
    • GimageSearchgoogle.search.ImageSearch.IMAGESIZE_LARGE - restringe a imagens grandes
    • GimageSearchgoogle.search.ImageSearch.IMAGESIZE_EXTRA_LARGE - restringe a imagens muito grandes
    O snippet de código a seguir demonstra como recuperar somente imagens em tamanho de ícone.
    var searcher = new google.search.ImageSearch();
    searcher.setRestriction(google.search.ImageSearch.RESTRICT_IMAGESIZE,
                            google.search.ImageSearch.IMAGESIZE_SMALL);
                    
  • GimageSearchgoogle.search.ImageSearch.RESTRICT_COLORIZATION - Quando especificado como o valor de type, os resultados da pesquisa de imagens são restritos às imagens com determinadas cores. Os valores opcionais válidos para este tipo são:
    • GimageSearchgoogle.search.ImageSearch.COLORIZATION_GRAYSCALE - restringe a imagens em tons de cinza
    • GimageSearchgoogle.search.ImageSearch.COLORIZATION_COLOR - restringe a imagens coloridas
    O snippet de código a seguir demonstra como recuperar somente imagens em tons de cinza.
    var searcher = new google.search.ImageSearch();
    searcher.setRestriction(google.search.ImageSearch.RESTRICT_COLORIZATION,
                            google.search.ImageSearch.COLORIZATION_GRAYSCALE);
                    
  • GimageSearchgoogle.search.ImageSearch.RESTRICT_COLORFILTER (experimental)Novo! - Quando especificado como o valor de type, os resultados da pesquisa de imagem são filtrados com base na cor selecionada. Os valores opcionais válidos para este tipo são:
    • GimageSearchgoogle.search.ImageSearch.COLOR_BLACK
    • GimageSearchgoogle.search.ImageSearch.COLOR_BLUE
    • GimageSearchgoogle.search.ImageSearch.COLOR_BROWN
    • GimageSearchgoogle.search.ImageSearch.COLOR_GRAY
    • GimageSearchgoogle.search.ImageSearch.COLOR_GREEN
    • GimageSearchgoogle.search.ImageSearch.COLOR_ORANGE
    • GimageSearchgoogle.search.ImageSearch.COLOR_PINK
    • GimageSearchgoogle.search.ImageSearch.COLOR_PURPLE
    • GimageSearchgoogle.search.ImageSearch.COLOR_RED
    • GimageSearchgoogle.search.ImageSearch.COLOR_TEAL
    • GimageSearchgoogle.search.ImageSearch.COLOR_WHITE
    • GimageSearchgoogle.search.ImageSearch.COLOR_YELLOW
    O seguinte snippet de código demonstra como filtrar na cor vermelha.
    var searcher = new google.search.ImageSearch();
    searcher.setRestriction(google.search.ImageSearch.RESTRICT_COLORFILTER,
                            google.search.ImageSearch.COLOR_RED);
                    
  • GimageSearchgoogle.search.ImageSearch.RESTRICT_FILETYPE - Quando especificado como o valor de type, os resultados da pesquisa de imagens ficam restritos às imagens com determinado tipo de arquivo, por ex., JPG. Os valores opcionais válidos para este tipo são:
    • GimageSearchgoogle.search.ImageSearch.FILETYPE_JPG - restringe a imagens jpeg apenas
    • GimageSearchgoogle.search.ImageSearch.FILETYPE_PNG - restringe a imagens png apenas
    • GimageSearchgoogle.search.ImageSearch.FILETYPE_GIF - restringe a imagens gif apenas
    • GimageSearchgoogle.search.ImageSearch.FILETYPE_BMP - restringe a imagens bmp apenas
    O snippet de código a seguir demonstra como recuperar somente imagens do tipo PNG.
    var searcher = new google.search.ImageSearch();
    searcher.setRestriction(google.search.ImageSearch.RESTRICT_FILETYPE,
                            google.search.ImageSearch.FILETYPE_PNG);
                    
  • GimageSearchgoogle.search.ImageSearch.RESTRICT_IMAGETYPE(experimental) - Quando especificado como o valor de type, os resultados da pesquisa de imagem são restritos às imagens de determinados tipos. Os valores opcionais válidos para este tipo são:
    • GimageSearchgoogle.search.ImageSearch.IMAGETYPE_FACES - restringe a imagens com rostos
    • GimageSearchgoogle.search.ImageSearch.IMAGETYPE_PHOTO - restrito a fotos
    • GimageSearchgoogle.search.ImageSearch.IMAGETYPE_CLIPART - restrito a imagens clipart
    • GimageSearchgoogle.search.ImageSearch.IMAGETYPE_LINEART - restrito a imagens de desenhos lineares
    O snippet de código a seguir demonstra como recuperar somente imagens com rostos.
    var searcher = new google.search.ImageSearch();
    searcher.setRestriction(google.search.ImageSearch.RESTRICT_IMAGETYPE,
                            google.search.ImageSearch.IMAGETYPE_FACES);
                    
Assim, para um exemplo ligeiramente mais completo, o snippet a seguir demonstra como realizar uma pesquisa, se você quisesse procurar imagens do rosto da Carmen Electra em tons de cinza somente do tipo jpg.
var searcher = new google.search.ImageSearch();
searcher.setRestriction(google.search.ImageSearch.RESTRICT_IMAGETYPE,
                        google.search.ImageSearch.IMAGETYPE_FACES);
searcher.setRestriction(google.search.ImageSearch.RESTRICT_FILETYPE,
                        google.search.ImageSearch.FILETYPE_JPG);
searcher.setRestriction(google.search.ImageSearch.RESTRICT_COLORIZATION,
                        google.search.ImageSearch.COLORIZATION_GRAYSCALE);
searcher.execute('Carmen Electra');
                

.setSiteRestriction(site)

Este método é usado para restringir o conjunto de resultados de pesquisa de imagens retornados por esta pesquisa. Para restringir a pesquisa ao site www.photobucket.com, basta chamar este método e passar o valor "www.photobucket.com". Para limpar as restrições de site, passe o valor null. O snippet a seguir demonstra isso, configurando uma restrição para "photobucket.com". Observação: Essa restrição pode restringir os resultados às imagens encontradas nas páginas no URL determinado e/ou às imagens com o URL determinado.

var siteSearch = new GimageSearchgoogle.search.ImageSearch();
siteSearch.setSiteRestriction("photobucket.com");
                

GpatentSearchgoogle.search.PatentSearch

Este objeto implementa a interface GSearchgoogle.search.Search sobre o serviço Pesquisa de patentes do Google. Quando a pesquisa é concluída, ele fornece uma coleção de objetos GpatentResultgoogle.search.PatentResult.

GpatentSearchgoogle.search.PatentSearch - Construtor

Construtor Descrição

GpatentSearchgoogle.search.PatentSearch()

O construtor é usado para criar uma instância de um objeto de pesquisa para fornecer resultados de pesquisa do serviço Pesquisa de patentes do Google.

GpatentSearchgoogle.search.PatentSearch - Métodos

Método Descrição

.setRestriction(type, opt_value)

Este método é usado para especificar ou limpar uma restrição do conjunto de resultados retornado por esta pesquisa. Para estabelecer uma restrição, você deve fornecer type e opt_value e ambos devem ser válidos. Para limpar uma restrição, forneça um valor válido para type e especifique null para o valor de opt_value, ou não o forneça.

No momento, esta API suporta os tipos de restrição abaixo:

  • GSearchgoogle.search.Search.RESTRICT_TYPE - Quando especificado como o valor de type, o fornecimento de um opt_value de GpatentSearchgoogle.search.PatentSearch.TYPE_ISSUED_PATENTS restringe os resultados apenas às patentes já emitidas. O fornecimento de um valor de GpatentSearchgoogle.search.PatentSearch.TYPE_APPLICATIONS permite que a pesquisa retorne patentes solicitadas, mas não emitidas. E por fim, o fornecimento de um valor de GpatentSearchgoogle.search.PatentSearch.TYPE_ANY_STATUS permite à pesquisa uma combinação de patentes solicitadas e emitidas. Este é o padrão e o comportamento tem efeito quando a restrição GSearchgoogle.search.Search.RESTRICT_TYPE é removida.

  • type - fornece o tipo de restrição a ser estabelecido:
    • GSearchgoogle.search.Search.RESTRICT_TYPE
  • opt_value - fornece o valor do tipo de restrição especificado. Se o valor for nulo, a restrição especificada será removida. Caso contrário, o valor deverá ser válido em relação ao valor de type. Nesse caso, ele estabelecerá uma restrição. Veja acima.

.setResultOrder(orderBy)

O comportamento padrão desta pesquisa é retornar resultados em ordem de relevância. Em alguns casos, é útil ver os resultados ordenados por data. Este método pode ser usado para alterar a ordem dos resultados.

  • orderBy - fornece a ordem de resultados desejada:
    • GSearchgoogle.search.Search.ORDER_BY_RELEVANCE - Este é o padrão e indica que os resultados devem ser retornados em ordem de relevância.
    • GSearchgoogle.search.Search.ORDER_BY_DATE - Este valor indica que os resultados devem ser retornados em ordem applicationDate usando datas em ordem decrescente, sendo que a patente mais recente é o primeiro resultado da pesquisa.
    • GSearchgoogle.search.Search.ORDER_BY_ASCENDING_DATE - Este valor indica que os resultados devem ser retornados em ordem applicationDate usando datas em ordem crescente, sendo que a patente mais antiga é o primeiro resultado da pesquisa.
  • retorna - n/d

Objetos de resultado

Os objetos de resultado são produzidos usando codificação JSON das solicitações de pesquisa do servidor. Como resultado, escolhemos não implementar objetos Javascript formais. Em vez disso, criamos dinamicamente estes objetos a partir de seu formulário serializado. Embora não haja uma implementação formal dos objetos, estes existem, e nós os documentamos como se houvesse uma implementação Javascript por trás. O impacto de tudo isso é mínimo. Isso significa apenas que não há um construtor nomeado. Para cada resultado, é como se o sistema chamasse new Object() e continuasse a definir propriedades formais nesse objeto. Os resultados são documentados abaixo, com base em suas propriedades.

Para todos os objetos, há duas propriedades comuns:

  • .GsearchResultClass - especifica o tipo de resultado.
  • .html - fornece a raiz de um elemento HTML que pode ser clonado e anexado em algum lugar da hierarquia DOM do aplicativo.

Estilo do resultado

A propriedade .html discutida acima é criada tendo em mente o uso de estilos CSS. Como resultado, cada pedaço de informação semântica é colocado em marcações HTML com um conjunto apropriado de marcadores de classe. Isso permite usar esse HTML em conjunto com suas próprias regras personalizadas de CSS, que definem o estilo do HTML segundo suas necessidades.

Como você verá nas seções abaixo, cada resultado de pesquisa é inserido em um elemento div marcado com uma classe genérica de resultado de pesquisa, a gs-result, e com uma classe específica ao tipo de resultado, por exemplo, gs-webResultgs-localResult etc. Essa estrutura permite definir facilmente regras CSS genéricas aplicadas a todos os resultados, bem como regras específicas a um determinado tipo de resultado.

Além dessa estrutura, quando um resultado é gerenciado pelo GSearchControlgoogle.search.SearchControl, cada resultado é inserido em um elemento div marcado com uma classe genérica de resultado de controle de pesquisa, a gsc-result, e uma classe específica ao tipo de resultado, por ex. gsc-webResultgsc-localResult etc. Cada seção de resultados é inserida em um elemento div marcado com uma classe genérica de resultado de controle de pesquisa (gsc-results) e uma classe específica ao tipo de resultado, por ex., gsc-webResultgsc-localResult etc.

O resultado final dessa estrutura é o esqueleto a seguir:

<!-- A collection of web search results in the search control -->
<div class="gsc-results gsc-webResult">

  <!-- A single web result in the search control -->
  <div class="gsc-result gsc-webResult">

    <!-- A single web result, full structure defined below -->
    <div class="gs-result gs-webResult"></div>
  </div>
  ...
</div>

<!-- Similar pattern for local, blog, etc. -->
<div class="gsc-results gsc-localResult"></div>
<div class="gsc-results gsc-blogResult"></div>
      

Objeto result - Propriedades comuns

Propriedade comum Descrição

.GsearchResultClass

Indica o "tipo" de resultado.

  • GwebSearchgoogle.search.WebSearch.RESULT_CLASS - indica GwebResult
  • GlocalSearchgoogle.search.LocalSearch.RESULT_CLASS - indica GlocalResult
  • GvideoSearchgoogle.search.VideoSearch.RESULT_CLASS - indica GvideoResult
  • GblogSearchgoogle.search.BlogSearch.RESULT_CLASS - indica GblogResult
  • GnewsSearchgoogle.search.NewsSearch.RESULT_CLASS - indica GnewsResult
  • GbookSearchgoogle.search.BookSearch.RESULT_CLASS - indica GbookResult
  • GimageSearchgoogle.search.ImageSearch.RESULT_CLASS - indica GimageResult
  • GpatentSearchgoogle.search.PatentSearch.RESULT_CLASS - indica GpatentResult

.html

Fornece a raiz de um elemento HTML que pode ser clonado e anexado em algum lugar da hierarquia DOM do aplicativo. Supomos que esta será a principal propriedade com a qual os aplicativos se preocuparão e que a interação típica envolverá a clonagem deste nó e sua colocação em uma hierarquia DOM. Supomos que eles usem css para controlar os estilos em que elementos são exibidos. Por exemplo, supomos que o fragmento abaixo será comum a todos os aplicativos que desejam copiar e colar resultados de pesquisa obtidos pela API AJAX de pesquisa do Google.

// clone the .html node from the result
var node = result.html.cloneNode(true);

// attach the node into my dom
container.appendChild(node);

GwebResult

Este objeto é produzido pelo objeto GwebSearchgoogle.search.WebSearch. Ele está disponível na matriz .results[] do objeto.

Este objeto é indicado por um valor .GsearchResultClass de GwebSearchgoogle.search.WebSearch.RESULT_CLASS.

GwebResult - Propriedades

Além das propriedades comuns descritas acima, estão disponíveis as seguintes propriedades específicas ao objeto.

Propriedade Descrição

.unescapedUrl

Fornece o URL básico do resultado.

.url

Fornece uma versão do URL descrito acima com códigos de escape.

.visibleUrl

Fornece uma versão mais curta do URL associado ao resultado. Exibido normalmente em verde, com um protocolo e o caminho removidos.

.title

Fornece o valor do título do resultado.

.titleNoFormatting

Fornece o título, mas diferentemente de .title, o markup html desta propriedade (por exemplo, <b>, <i> etc.) é removido.

.content

Fornece um pequeno snippet de informações da página associada ao resultado da pesquisa.

.cacheUrl

Fornece um URL para a versão em cache no Google da página responsável por produzir este resultado. Esta propriedade pode ser nula, indicando que não há uma versão em cache. Também pode estar desatualizada, nos casos em que o resultado da pesquisa foi salvo e o cache ficou desatualizado desde então. Para obter o melhor resultado, esta propriedade não deve mantida.

Estrutura CSS GwebResult

O fragmento de HTML abaixo ilustra a estrutura de uma propriedade .html dos resultados de uma Pesquisa na web. A finalidade desta estrutura é mostrar os principais componentes estruturais, para que você possa alterar o estilo e a exibição de um resultado. Por exemplo, se desejar suprimir o "snippet", use uma regra CSS #mycontrol .gs-webResult .gs-snippet { display : none; }#.

<div class="gs-result gs-webResult">

  <!-- Note, a.gs-title can have embedded HTML
  // so make sure to account for this in your rules.
  // For instance, to change the title color to red,
  // use a rule like this:
  // a.gs-title, a.gs-title * { color : red; }
  -->
  <div class="gs-title">
    <a class="gs-title"></a>
  </div>
  <div class="gs-snippet"></div>

  <!-- The default CSS rule has the -short URL visible and
   // the -long URL hidden.
   //
   // If you want to reverse this, use a rule like:
   // #mycontrol .gs-webResult .gs-visibleUrl-short { display:none; }
   // #mycontrol .gs-webResult .gs-visibleUrl-long { display:block; }
  -->
  <div class="gs-visibleUrl gs-visibleUrl-short"></div>
  <div class="gs-visibleUrl gs-visibleUrl-long"></div>
</div>
        

GlocalResult

Este objeto é produzido pelo objeto GlocalSearchgoogle.search.LocalSearch. Ele está disponível na matriz .results[] do objeto.

Este objeto é indicado por um valor .GsearchResultClass de GlocalSearchgoogle.search.LocalSearch.RESULT_CLASS.

GlocalResult - Propriedades

Além das propriedades comuns descritas acima, estão disponíveis as seguintes propriedades específicas ao objeto.

Propriedade Descrição

.title

Fornece o título do resultado. Em alguns casos, o título e o streetAddress são iguais. Isso normalmente ocorre quando o termo da pesquisa é um endereço, como 1231 Lisa Lane, Los Altos, CA.

.titleNoFormatting

Fornece o título, mas diferentemente de .title, o markup html desta propriedade (por exemplo, <b>, <i> etc.) é removido.

.url

Fornece um url para uma página de detalhes do Google Maps associada ao resultado da pesquisa.

.lat

Fornece o valor da latitude do resultado. Pode ser usado para construir um GPoint usando o seguinte snippet de código:
p = new GPoint(parseFloat(result.lng), parseFloat(result.lat));

.lng

Fornece o valor da longitude do resultado. Pode ser usado para construir um GPoint usando o seguinte snippet de código:
p = new GPoint(parseFloat(result.lng), parseFloat(result.lat));

.streetAddress

Fornece o endereço completo do resultado especificado. Observação: Em alguns casos, esta propriedade pode ser definida como "" se o resultado não tiver um endereço conhecido.

.city

Fornece o nome da cidade do resultado. Observação: Em alguns casos, esta propriedade pode ser definida como "".

.region

Fornece um nome de região do resultado (por ex., nos EUA, normalmente é uma abreviação de estado. Em outras regiões pode ser uma província etc.) Observação: Em alguns casos, esta propriedade pode ser definida como "".

.country

Fornece o nome do país do resultado. Observação: Em alguns casos, esta propriedade pode ser definida como "".

.phoneNumbers[]

Fornece uma matriz de objetos de número de telefone na qual cada objeto contém uma propriedade .type e uma propriedade .number. O valor da propriedade .type pode ser "main", "fax", "mobile", "data" ou "".

.addressLines[]

Fornece uma matriz com as linhas de endereço de correspondência para este resultado, por exemplo: ["1600 Amphitheatre Pky", "Mountain View, CA 94043"] ou ["Via del Corso, 330", "00186 Roma (RM), Italy"]. Para renderizar corretamente um endereço associado a um resultado, use a propriedade .html do resultado diretamente ou itere esta matriz e exiba uma addressLine por vez.

.ddUrl

Fornece um url que pode ser usado para fornecer orientações para motoristas a partir do centro do conjunto de resultados da pesquisa até este resultado da pesquisa. Em alguns casos, esta propriedade pode estar ausente ou nula. Sempre insira o acesso dentro de um teste de if (result.ddUrl && result.ddUrl != null).

.ddUrlToHere

Fornece um url que pode ser usado para fornecer orientações para motoristas a partir de uma localização especificada pelo usuário até este resultado da pesquisa. Em alguns casos, esta propriedade pode estar ausente ou nula. Sempre insira o acesso dentro de um teste de if (result.ddUrlToHere && result.ddUrlToHere != null).

.ddUrlFromHere

Fornece um url que pode ser usado para fornecer orientações para motoristas a partir deste resultado da pesquisa até uma localização especificada pelo usuário. Em alguns casos, esta propriedade pode estar ausente ou nula. Sempre insira o acesso dentro de um teste de if (result.ddUrlFromHere && result.ddUrlFromHere != null).

.staticMapUrl

Fornece um url para uma representação de imagem estática de mapa do resultado atual. A imagem tem 150px de largura por 100px de altura, com um único marcador representando a localização atual. O uso recomendável é para criar um hiperlink desta imagem usando a propriedade url. A imagem pode ser redimensionada com o GlocalSearchgoogle.search.LocalSearch.resizeStaticMapUrl(). O exemplo Painel de mapa estático demonstra como usar esta propriedade.

.listingType

Esta propriedade indica o tipo deste resultado, que pode ser "local", no caso de uma lista de empresas locais ou resultado de geocódigo, ou "kml", no caso de uma lista KML.

.content

Para resultados "kml", esta propriedade contém um snippet de conteúdo associado ao resultado KML. Para resultados "locais", esta propriedade é a string vazia.

Estrutura CSS GlocalResult

O fragmento de HTML abaixo ilustra a estrutura de uma propriedade .html dos resultados de uma Pesquisa local. A finalidade desta estrutura é mostrar os principais componentes estruturais, para que você possa alterar o estilo e a exibição de um resultado. Por exemplo, se desejar suprimir o "address", use uma regra CSS #mycontrol .gs-localResult .gs-address { display : none; }#.

<div class="gs-result gs-localResult">

  <!-- Note, a.gs-title can have embedded HTML
  // so make sure to account for this in your rules.
  // For instance, to change the title color to red,
  // use a rule like this:
  // a.gs-title, a.gs-title * { color : red; }
  -->
  <div class="gs-title">
    <a class="gs-title"></a>
  </div>

  <!-- Note, ONLY present for "kml" results -->
  <div class="gs-snippet"></div>

  <div class="gs-address">
    <div class="gs-street"></div>
    <div class="gs-city"></div>
    <div class="gs-region"></div>
    <div class="gs-country"></div>
  </div>
  <div class="gs-phone"></div>

  <!-- This element provides driving directions from
  // the center point location to this result. This
  // is the default setting.
  -->
  <div class="gs-directions">
    <a class="gs-directions"></a>
  </div>


  <!-- This element provides driving directions to/from the search result
  // with the user supplying the starting/ending point (based on the link
  // they clicked on). This is an alternate link. If you want this behavior
  // instead of the default, use a set of rules similar to this:
  //
  //  #mycontrol .gs-directions { display : none; }
  //  #mycontrol .gs-directions-to-from { display : block; }
  //
  // Directions here are provided in the form of:
  //
  // Get directions: To here - From here
  -->
  <div class="gs-directions-to-from">
    <div class="gs-label"></div>
    <div class="gs-secondary-link">
      <a class="gs-secondary-link"></a>
    </div>
    <div class="gs-spacer"></div>
    <div class="gs-secondary-link">
      <a class="gs-secondary-link"></a>
    </div>
  </div>
</div>
        

GvideoResult

Este objeto é produzido pelo objeto GvideoSearchgoogle.search.VideoSearch. Ele está disponível na matriz .results[] do objeto.

Este objeto é indicado por um valor .GsearchResultClass de GvideoSearchgoogle.search.VideoSearch.RESULT_CLASS.

GvideoResult - Propriedades

Além das propriedades comuns descritas acima, estão disponíveis as seguintes propriedades específicas ao objeto.

Propriedade Descrição

.title

Fornece o título do resultado de vídeo.

.titleNoFormatting

Fornece o título, mas diferentemente de .title, o markup html desta propriedade (por exemplo, <b>, <i> etc.) é removido.

.content

Fornece uma descrição do videoclipe na forma de um snippet.

.url

Fornece o url de uma versão do resultado de vídeo para reprodução.

.published

Fornece a data de publicação do vídeo (formato rfc-822).

.publisher

Fornece o nome de quem publicou o vídeo, normalmente exibido em verde abaixo da miniatura do vídeo, de forma semelhante ao tratamento usado para o visibleUrl nos outros objetos de resultado de pesquisa.

.duration

A duração aproximada do vídeo em segundos.

.tbWidth

Fornece a largura da miniatura do vídeo em pixels.

.tbHeight

Fornece a altura da miniatura do vídeo em pixels.

.tbUrl

Fornece o url de uma imagem em miniatura, que representa o vídeo visualmente.

.playUrl

Se estiver presente, fornece o url da versão do vídeo em flash, que pode ser reproduzida dentro da sua página. Para reproduzir este vídeo, basta criar um elemento <embed> em sua página, usando este valor como o atributo src e usando application/x-shockwave-flash como o atributo type. Se desejar que o vídeo seja reproduzido imediatamente, anexe &autoPlay=true& ao url.

.author

Se estiver presente, esta propriedade fornece o nome de usuário do YouTube do criador do vídeo.

.viewCount

Se estiver presente, esta propriedade fornece uma contagem das reproduções deste vídeo.

.rating

Se estiver presente, esta propriedade fornece a classificação do vídeo em uma escala de 1 a 5.

Estrutura CSS GvideoResult

O fragmento de HTML abaixo ilustra a estrutura de uma propriedade .html dos resultados de uma Pesquisa de vídeos. A finalidade desta estrutura é mostrar os principais componentes estruturais, para que você possa alterar o estilo e a exibição de um resultado. Por exemplo, se desejar suprimir o "snippet", use uma regra CSS #mycontrol .gs-videoResult .gs-snippet { display : none; }#.

<div class="gs-result gs-videoResult">

  <table>
    <tr>

      <!-- The Result's Thumbnail image is sitting in this column -->
      <td class="gs-image-box">
        <div class="gs-image-box">
          <a class="gs-image">
            <img class="gs-image"></img>
          </a>
        </div>
      </td>

      <!-- The Result's Text based result data is sitting in this column -->
      <td class="gs-text-box">
        <div class="gs-text-box">
          <!-- Note, a.gs-title can have embedded HTML
          // so make sure to account for this in your rules.
          // For instance, to change the title color to red,
          // use a rule like this:
          // a.gs-title, a.gs-title * { color : red; }
          -->
          <div class="gs-title">
            <a class="gs-title"></a>
          </div>
          <div class="gs-snippet"></div>
          <div class="gs-publishedDate"></div>
          <div class="gs-publisher">
            <a class="gs-publisher"></a>
          </div>
        </div>
      </td>
    </tr>
  </table>
</div>
        

GblogResult

Este objeto é produzido pelo objeto GblogSearchgoogle.search.BlogSearch. Ele está disponível na matriz .results[] do objeto.

Este objeto é indicado por um valor .GsearchResultClass de GblogSearchgoogle.search.BlogSearch.RESULT_CLASS.

GblogResult - Propriedades

Além das propriedades comuns descritas acima, estão disponíveis as seguintes propriedades específicas ao objeto.

Propriedade Descrição

.title

Fornece o título da postagem de blog retornada como resultado da pesquisa.

.titleNoFormatting

Fornece o título, mas diferentemente de .title, o markup html desta propriedade (por exemplo, <b>, <i> etc.) é removido.

.postUrl

Fornece o URL da postagem de blog mencionada neste resultado de pesquisa.

.content

Fornece um snippet do conteúdo da postagem de blog associado a este resultado de pesquisa.

.author

Fornece o nome do autor da postagem de blog.

.blogUrl

Fornece o URL do blog que contém a postagem. Normalmente, este URL é exibido em verde abaixo do resultado da pesquisa em blogs e apresenta um link para o blog.

.publishedDate

Fornece a data de publicação (formato rfc-822) da postagem de blog mencionada neste resultado de pesquisa.

Estrutura CSS GblogResult

O fragmento de HTML abaixo ilustra a estrutura de uma propriedade .html dos resultados de uma Pesquisa de blogs. A finalidade desta estrutura é mostrar os principais componentes estruturais, para que você possa alterar o estilo e a exibição de um resultado. Por exemplo, se desejar suprimir o "snippet", use uma regra CSS #mycontrol .gs-blogResult .gs-snippet { display : none; }#.

<div class="gs-result gs-blogResult">

  <!-- Note, a.gs-title can have embedded HTML
  // so make sure to account for this in your rules.
  // For instance, to change the title color to red,
  // use a rule like this:
  // a.gs-title, a.gs-title * { color : red; }
  -->
  <div class="gs-title">
    <a class="gs-title"></a>
  </div>

  <!-- The default CSS rule enables the relative
  // published date while a result is sitting in
  // a search control, and an absolute published date
  // if the result is outside of the control. Using your
  // own CSS rule, you can select whichever date form
  // works best for your pages.
  -->
  <div class="gs-publishedDate"></div>
  <div class="gs-relativePublishedDate"></div>

  <div class="gs-snippet"></div>
  <div class="gs-visibleUrl">
    <a class="gs-visibleUrl"></a>
  </div>
</div>
        

GnewsResult

Este objeto é produzido pelo objeto GnewsSearchgoogle.search.NewsSearch. Ele está disponível na matriz .results[] do objeto.

Este objeto é indicado por um valor .GsearchResultClass de GnewsSearchgoogle.search.NewsSearch.RESULT_CLASS.

GnewsResult - Propriedades

Além das propriedades comuns descritas acima, estão disponíveis as seguintes propriedades específicas ao objeto.

Propriedade Descrição

.title

Fornece o título da notícia retornada como resultado da pesquisa.

.titleNoFormatting

Fornece o título, mas diferentemente de .title, o markup html desta propriedade (por exemplo, <b>, <i> etc.) é removido.

.unescapedUrl

Fornece o URL básico do resultado.

.url

Fornece uma versão do URL descrito acima com códigos de escape.

.clusterUrl

Quando um resultado de notícia possui um conjunto de artigos relacionados, este URL fica disponível e não é nulo. Nessa situação, o URL aponta para uma página que aponta para todos os artigos relacionados.

.content

Fornece um snippet do conteúdo da notícia associado a este resultado de pesquisa.

.publisher

Fornece o nome do editor da notícia.

.location

Contém a localização da notícia. Esta é uma lista de locais em ordem do mais para o menos específico, onde os componentes são separados por ",". Pode haver apenas um elemento na lista. Um valor típico para esta propriedade é "Edinburgh,Scotland,UK" ou talvez "USA".

.publishedDate

Fornece a data de publicação (formato rfc-822) da notícia mencionada neste resultado de pesquisa.

.relatedStories[]

Esta propriedade é opcional. Ela aparece em um resultado somente quando a notícia também tiver um conjunto de artigos relacionados. Nesse caso, a matriz relatedStories[] estará presente. Cada elemento dentro da matriz contém o subconjunto de propriedades abaixo, cujo significado é conforme descrito acima:

  • .title
  • .titleNoFormatting
  • .unescapedUrl
  • .url
  • .publisher
  • .location
  • .publishedDate

.image{}

Esta propriedade é opcional. Aparece em um resultado apenas quando o sistema tiver determinado que há uma boa imagem que representa o cluster de artigos relacionados a esse resultado. É importante observar que a imagem se relaciona ao cluster dos artigos, não apenas ao artigo que age como o artigo principal para este resultado. Por isso, é muito importante que sua interface do usuário relacionada não represente inadequadamente a imagem. Você sempre deve exibir a fonte de notícias dos artigos e da imagem, pois elas são normalmente diferentes. Você perceberá que, no Google Notícias, a imagem é exibida na lateral com a atribuição total para a fonte e com um hiperlink para o artigo associado à imagem, não o artigo associado ao resultado atual.

Esta propriedade é opcional. Nem sempre está presente. É melhor verificar .image == undefined antes de interagir com a propriedade. Quando a propriedade está presente, contém as seguintes subpropriedades:

  • .title - fornece o título do artigo associado à imagem.
  • .titleNoFormatting - o mesmo mencionado acima, mas sem a formatação HTML.
  • .url - fornece o URL desta imagem da forma como é encontrado no artigo.
  • .originalContextUrl - fornece o URL do artigo que contém essa imagem. A imagem, quando exibida, normalmente apresenta um vínculo por meio desse URL.
  • .publisher - fornece o editor do artigo que contém a imagem. A interface de usuário sugerida deve exibir isso abaixo ou próximo da imagem, vinculado por hiperlink pela propriedade .url acima.
  • .tbUrl - fornece o URL de uma miniatura da imagem.
  • .tbWidth - fornece a largura da imagem mencionada acima. O tamanho padrão desta imagem é de 80 pixels de largura e 50 pixels de altura.
  • .tbHeight - fornece a altura da imagem mencionada acima. O tamanho padrão desta imagem é de 80 pixels de largura e 50 pixels de altura.

.language

Esta propriedade é opcional. Quando presente, indica o idioma da notícia.

GnewsResult (todas as citações) - Propriedades

Quando sua solicitação de pesquisa de notícias usa o argumento qsid para solicitar citações. O formato de resultado padrão é alterado para incluir propriedades específicas das citações. Além das propriedades comuns descritas acima, estão disponíveis as seguintes propriedades específicas ao objeto.

Propriedade Descrição

.GsearchResultClass

Um valor de GnewsSearch.quote indica que esse resultado contém propriedades relacionada à citação, não propriedades padrão de resultado de notícias. As propriedades definidas para esses dois formatos de resultado são muito diferentes, por isso é aconselhável prestar muita atenção a essa propriedade em todas as combinações de consultas de notícias padrão ou baseadas em citações.

.unescapedUrl

Fornece o URL básico do resultado.

.url

Fornece uma versão do URL descrito acima com códigos de escape.

.author

Fornece o nome da pessoa a qual a citação é atribuída.

.content

Fornece um snippet de conteúdo da notícia que inclui as citações.

.publisher

Fornece o nome do editor da notícia.

Estrutura CSS GnewsResult

O fragmento de HTML abaixo ilustra a estrutura de uma propriedade .html dos resultados de uma Pesquisa de notícias. A finalidade desta estrutura é mostrar os principais componentes estruturais, para que você possa alterar o estilo e a exibição de um resultado. Por exemplo, se desejar suprimir o "snippet", use uma regra CSS #mycontrol .gs-newsResult .gs-snippet { display : none; }#.

<div class="gs-result gs-newsResult">

  <!-- Note, a.gs-title can have embedded HTML
  // so make sure to account for this in your rules.
  // For instance, to change the title color to red,
  // use a rule like this:
  // a.gs-title, a.gs-title * { color : red; }
  -->
  <div class="gs-title">
    <a class="gs-title"></a>
  </div>
  <div class="gs-publisher"></div>

  <!-- The default CSS rule enables the relative
  // published date while a result is sitting in
  // a search control, and an absolute published date
  // if the result is outside of the control. Using your
  // own CSS rule, you can select whichever date form
  // works best for your pages.
  -->
  <div class="gs-publishedDate"></div>
  <div class="gs-relativePublishedDate"></div>

  <div class="gs-snippet"></div>

  <!-- If a result is related to other
  // articles, this element is present.
  -->
  <div class="gs-clusterUrl">
    <a class="gs-clusterUrl"></a>
  </div>
</div>
        

GbookResult (experimental)

Este objeto é produzido pelo objeto GbookSearchgoogle.search.BookSearch. Ele está disponível na matriz .results[] do objeto.

Este objeto é indicado por um valor .GsearchResultClass de GbookSearchgoogle.search.BookSearch.RESULT_CLASS.

GbookResult - Propriedades

Além das propriedades comuns descritas acima, estão disponíveis as seguintes propriedades específicas ao objeto.

Propriedade Descrição

.title

Fornece o título do livro.

.titleNoFormatting

Fornece o título, mas diferentemente de .title, o markup html desta propriedade (por exemplo, <b>, <i> etc.) é removido.

.unescapedUrl

Fornece o URL básico do resultado.

.url

Fornece uma versão do URL descrito acima com códigos de escape.

.authors

Fornece a lista de autores do livro.

.bookId

Fornece o identificador associado ao livro. Normalmente, é o ISBN.

.publishedYear

Fornece o ano de publicação do livro.

.pageCount

Fornece o número de páginas do livro.

.thumbnailHtml

Fornece um nó DOM HTML que representa uma imagem em miniatura da capa do livro. Observação: Se você desejar usar esta propriedade corretamente, é necessário clonar o nó (por ex., var cover = res.thumbnailHtml.cloneNode(true);). Além disso, se a geração de HTML tiver sido suprimida (usando.setNoHtmlGeneration()), esta propriedade não estará disponível.

Estrutura CSS GbookResult

O fragmento de HTML abaixo ilustra a estrutura de uma propriedade .html dos resultados de uma Pesquisa de Livros. A finalidade desta estrutura é mostrar os principais componentes estruturais, para que você possa alterar o estilo e a exibição de um resultado. Por exemplo, se desejar usar o estilo negrito para "page count", use uma regra CSS #mycontrol .gs-bookResult .gs-pageCount { font-weight : bold; }#.

<div class="gs-result gs-bookResult">

  <table>
    <tr>

      <!-- The Result's Thumbnail image is sitting in this column -->
      <td class="gs-image-box">

        <!-- Applying your own styles to gs-row1/* and .gs-row2
        // should be avoided. This structure is going to change.
        // All you can really count on is a.gs-image/*.
        -->
        <div class="gs-image-box gs-book-image-box">

          <!-- the page components -->
          <div class="gs-row1">
            <img class="gs-pages"></img>
            <img class="gs-page-edge"></img>
          </div>

          <!-- the hyperlinked thumbnail -->
          <div class="gs-row2">
            <a class="gs-image">
              <img class="gs-image"></img>
            </a>
          </div>
        </div>
      </td>

      <!-- The Result's Text based result data is sitting in this column -->
      <td class="gs-text-box">
        <div class="gs-text-box">
          <!-- Note, a.gs-title can have embedded HTML
          // so make sure to account for this in your rules.
          // For instance, to change the title color to red,
          // use a rule like this:
          // a.gs-title, a.gs-title * { color : red; }
          -->
          <div class="gs-title">
            <a class="gs-title"></a>
          </div>
          <div class="gs-author"></div>
          <div class="gs-publishedDate"></div>
          <div class="gs-pageCount"></div>
          <div class="gs-visibleUrl">
            <a class="gs-visibleUrl"></a>
          </div>
        </div>
      </td>
    </tr>
  </table>
</div>
        

GimageResult

Este objeto é produzido pelo objeto GimageSearchgoogle.search.ImageSearch. Ele está disponível na matriz .results[] do objeto.

Este objeto é indicado por um valor .GsearchResultClass de GimageSearchgoogle.search.ImageSearch.RESULT_CLASS.

GimageResult - Propriedades

Além das propriedades comuns descritas acima, estão disponíveis as seguintes propriedades específicas ao objeto.

Propriedade Descrição

.title

Fornece o título da imagem, normalmente o nome de arquivo.

.titleNoFormatting

Fornece o título, mas diferentemente de .title, o markup html desta propriedade (por exemplo, <b>, <i> etc.) é removido.

.unescapedUrl

Fornece o URL básico da imagem.

.url

Fornece uma versão do URL descrito acima com códigos de escape.

.visibleUrl

Fornece uma versão reduzida do URL associado ao resultado, normalmente exibido em verde e sem um protocolo e um caminho.

.originalContextUrl

Fornece o URL da página que contém a imagem.

.width

Fornece a largura da imagem em pixels.

.height

Fornece a altura da imagem em pixels.

.tbWidth

Fornece a largura da miniatura da imagem em pixels.

.tbHeight

Fornece a altura da miniatura da imagem em pixels.

.tbUrl

Fornece o url da imagem em miniatura.

.content

Fornece um pequeno snippet de informações da página associada ao resultado da pesquisa.

.contentNoFormatting

Fornece as mesmas informações que .content, mas sem a formatação HTML.

Estrutura CSS GimageResult

O fragmento de HTML abaixo ilustra a estrutura de uma propriedade .html dos resultados de uma Pesquisa de imagens. A finalidade desta estrutura é mostrar os principais componentes estruturais, para que você possa alterar o estilo e a exibição de um resultado. Por exemplo, se desejar usar o estilo negrito para "image size as", use uma regra CSS #mycontrol .gs-imageResult .gs-size { font-weight : bold; }#.

<div class="gs-result gs-imageResult">
  <div class="gs-image-box">
    <!-- img is hyperlinked to the original content url -->
    <a class="gs-image">
      <!-- Note explicit sizing is set during thumbnail scaling -->
      <img class="gs-image"/>
    </a>
  </div>
  <div class="gs-text-box">
    <div class="gs-snippet"></div>
    <div class="gs-size"></div>
    <div class="gs-visibleUrl"></div>
  </div>
</div>
        

GpatentResult

Este objeto é produzido pelo objeto GpatentSearchgoogle.search.PatentSearch. Ele está disponível na matriz .results[] do objeto.

Este objeto é indicado por um valor .GsearchResultClass de GpatentSearchgoogle.search.PatentSearch.RESULT_CLASS.

GpatentResult - Propriedades

Além das propriedades comuns descritas acima, estão disponíveis as seguintes propriedades específicas ao objeto.

Propriedade Descrição

.title

Fornece o título do resultado de patente.

.titleNoFormatting

Fornece o título, mas diferentemente de .title, o markup html desta propriedade (por exemplo, <b>, <i> etc.) é removido.

.content

Fornece uma descrição do estilo do snippet da patente.

.unescapedUrl

Fornece o URL básico do resultado.

.url

Fornece uma versão do URL descrito acima com códigos de escape.

.applicationDate

Fornece a data do preenchimento da inscrição da patente (formato rfc-822).

.patentNumber

Fornece o número de patente das patentes emitidas e o número da inscrição para patentes solicitadas, mas ainda não emitidas.

.patentStatus

Fornece o status da patente que pode ser "filed" para patentes solicitadas, mas não emitidas, ou "issued" para patentes emitidas.

.assignee

Fornece o procurador da patente.

.tbUrl

Fornece o URL de uma imagem em miniatura, que representa a patente visualmente.

Estrutura CSS GpatentResult

O fragmento de HTML abaixo ilustra a estrutura de uma propriedade .html dos resultados da Pesquisa de patentes do Google. A finalidade desta estrutura é mostrar os principais componentes estruturais, para que você possa alterar o estilo e a exibição de um resultado. Por exemplo, se desejar suprimir o "snippet", use uma regra CSS #mycontrol .gs-patentResult .gs-snippet { display : none; }#.

<div class="gs-result gs-patentResult">

  <table>
    <tr>

      <!-- The Result's Thumbnail image is sitting in this column -->
      <td class="gs-image-box">
        <div class="gs-image-box">
          <a class="gs-image">
            <img class="gs-image"></img>
          </a>
        </div>
      </td>

      <!-- The Result's Text based result data is sitting in this column -->
      <td class="gs-text-box">
        <div class="gs-text-box">
          <!-- Note, a.gs-title can have embedded HTML
          // so make sure to account for this in your rules.
          // For instance, to change the title color to red,
          // use a rule like this:
          // a.gs-title, a.gs-title * { color : red; }
          -->
          <div class="gs-title">
            <a class="gs-title"></a>
          </div>
          <div class="gs-patent-info gs-metadata">
            <div class="gs-patent-number"></div>
            <div class="gs-publishedDate"></div>
            <div class="gs-author"></div>
          </div>

          <div class="gs-snippet"></div>
        </div>
      </td>
    </tr>
  </table>
</div>
        

Flash e outros ambientes que não são de Javascript

Para os desenvolvedores de Flash e desenvolvedores que precisam acessar a API AJAX de pesquisa a partir de outros ambientes sem Javascript, a API oferece uma interface RESTful simples. Em todos os casos, GET é o método suportado e o formato de resposta é um conjunto de resultados codificado JSON com códigos de status incorporados. Os aplicativos que usam esta interface devem obedecer a todos os termos de uso existentes. Você deve ter atenção especial quanto a se identificar corretamente em suas solicitações. Os aplicativos sempre DEVEM incluir um cabeçalho de referência http em suas solicitações. Além disso, pedimos que cada solicitação contenha uma chave de API válida, mas isso não é obrigatório. Ao fornecer uma chave, seu aplicativo nos fornece um mecanismo secundário de identificação. Isso é útil para o caso de ser necessário entrar em contato com você para corrigir algum problema. Obtenha mais informações sobre a utilidade de ter uma chave de API

Assim como a interface JavaScript principal, esta interface é oferecida por meio de um URL uniforme que contém uma mistura de argumentos CGI padrão e específicos da pesquisa. Seu aplicativo pode usar uma pilha HTTP de sua própria escolha. Os únicos requisitos são que você deve ser capaz de construir apropriadamente um URL com todos os argumentos CGI necessários, deve enviar um cabeçalho de referência http identificando precisamente seu aplicativo e deve processar a resposta codificada JSON.

Endereço URL básico padrão

Cada extremidade da pesquisa é acessada através de um URL padrão. A tabela a seguir indica o URL usado para acessar cada serviço.

Pesquisa URL básico
Pesquisa na web http://ajax.googleapis.com/ajax/services/search/web
Pesquisa local http://ajax.googleapis.com/ajax/services/search/local
Pesquisa de vídeos http://ajax.googleapis.com/ajax/services/search/video
Pesquisa de blogs http://ajax.googleapis.com/ajax/services/search/blogs
Pesquisa de notícias http://ajax.googleapis.com/ajax/services/search/news
Pesquisa de Livros http://ajax.googleapis.com/ajax/services/search/books
Pesquisa de imagens http://ajax.googleapis.com/ajax/services/search/images
Pesquisa de patentes http://ajax.googleapis.com/ajax/services/search/patentNovo!

Argumentos padrão de URL

Cada solicitação contém uma mistura de argumentos padrão de URL e um conjunto opcional de argumentos específicos à pesquisa. Esta seção descreve os argumentos padrão uniformizados em todas as pesquisas e que transmitem informações semânticas virtualmente idênticas para cada pesquisa. Em alguns casos, o uso de um argumento é opcional. Isso é indicado por um sinal ?a o lado do nome do argumento. Em todos os casos, o valor do argumento CGI deve estar devidamente seguido dos códigos de escape (por ex., através da função equivalente do método JavaScript encodeURIComponent()).

A tabela a seguir lista os argumentos padrão de URL. Há seções adicionais abaixo destacando os argumentos específicos da pesquisa.

Argumento Exemplo Descrição
q q=Paris%20Hilton Este argumento fornece a consulta ou expressão de pesquisa passada à pesquisa.
v v=1.0 Este argumento fornece o número da versão do protocolo. O único valor válido no momento é 1.0.
rsz? rsz=small Este argumento opcional fornece o número de resultados que o aplicativo deseja receber. O valor small indica um conjunto de resultados pequeno, ou 4 resultados. O valor large indica um conjunto de resultados grande, ou 8 resultados. Se este argumento não for fornecido, o valor small é assumido.
hl? hl=fr Este argumento opcional fornece o idioma do host do aplicativo que está realizando a solicitação. Se este argumento não estiver presente, o sistema escolhe um valor com base no valor do cabeçalho http Accept-Language. Se este cabeçalho não estiver presente, será usado o valor en.
key? key=your-key Este argumento opcional fornece a chave do aplicativo. Se especificado, ele deve ser uma chave válida associada ao site, validada pelo cabeçalho de referência passado. A vantagem de fornecer uma chave é a possibilidade de identificarmos e entrarmos em contato com você, caso ocorra algo de errado com seu aplicativo. Sem uma chave, também tomaremos as mesmas medidas apropriadas, mas não poderemos entrar em contato com você. Definitivamente, é melhor para você informar uma chave.
início? start=4 Este argumento opcional fornece o parâmetro start-index do primeiro resultado da pesquisa. Cada resposta bem-sucedida contém um objeto cursor (veja abaixo) que inclui uma matriz de pages. A propriedade start de uma página pode ser usada como valor válido para este argumento. Para referência, veja a amostra de um objeto de cursor descrita abaixo:
"cursor": {
  "pages": [
    { "start": "0", "label": 1 },
    { "start": "4", "label": 2 },
    { "start": "8", "label": 3 },
    { "start": "12","label": 4 } ],
  "estimatedResultCount": "48758",
  "currentPageIndex": 0,
  "moreResultsUrl": "http://www.google.com/search..."
}
      
callback? callback=foo Este argumento opcional altera o formato de resposta padrão. Quando fornecido, em vez de produzir um objeto codificado JSON simples, o sistema produz uma resposta de chamada de função JavaScript onde o valor de callback especifica o nome da função chamada na resposta.
callbackFunction(
  {"responseData" : {
      "results" : [],
      "cursor" : {}
    },
    "responseDetails" : null | string-on-error,
    "responseStatus" : 200 | error-code
});
      
context? context=bar Este argumento opcional está relacionado ao argumento context. Quando ambos são fornecidos, o valor de context altera o formato de resposta normal associado ao callback. O novo formato é:
callbackFunction(
  contextValue,    // the context arg value
  responseObject,  // the collection of results and cursor
  responseStatus,  // 200 on success, non-200 on failure
  errorDetails)    // error string for non-200 response
      

Formato de resposta padrão

Como discutido rapidamente na seção anterior, há duas variações principais do formato de resposta. Quando os argumentos callback e context não são fornecidos, o formato de resposta é um objeto JSON simples:

{
  "responseData" : {
    "results" : [],
    "cursor" : {}
  },
  "responseDetails" : null | string-on-error,
  "responseStatus" : 200 | error-code
}

No fragmento JSON acima, a propriedade responseData contém uma matriz results e um cursor opcional. Eles são semântica e estruturalmente idênticos aos resultados retornados por meio da camada JavaScript Searchers. A propriedade responseStatus contém o valor 200 para sucesso e um código de status de erro http diferente de 200 para falha. Se houver uma falha, a propriedade responseDetails contém uma string de diagnóstico.

Ao usar o argumento callback, os aplicativos podem facilmente solicitar um retorno de chamada do JavaScript:

callback({
  "responseData" : {
    "results" : [],
    "cursor" : {}
  },
  "responseDetails" : null | string-on-error,
  "responseStatus" : 200 | error-code
});

Se o aplicativo fornecer ambos os argumentos callback e context , a resposta é codificada como uma chamada de procedimento JavaScript. Neste modo de operação, o valor de callback torna-se o destino da chamada do procedimento; o valor de context é passado como o primeiro argumento; o valor de responseData acima é passado como o segundo argumento; o status da resposta é passado como o terceiro argumento, e o argumento final é null ou uma string de diagnóstico.

foo('bar',{
 "results": [
  {
   "GsearchResultClass": "GwebSearch",
   "unescapedUrl": "http://en.wikipedia.org/wiki/Paris_Hilton",
   "url": "http://en.wikipedia.org/wiki/Paris_Hilton",
   "visibleUrl": "en.wikipedia.org",
   "cacheUrl": "http://www.google.com/search?q\u003dcache:TwrPfhd22hYJ:en.wikipedia.org",
   "title": "\u003cb\u003eParis Hilton\u003c/b\u003e - Wikipedia, the free encyclopedia",
   "titleNoFormatting": "Paris Hilton - Wikipedia, the free encyclopedia",
   "content": "In 2006, she released her debut album \u003cb\u003eParis\u003c/b\u003e..."
  },
  {
   "GsearchResultClass": "GwebSearch",
   "unescapedUrl": "http://www.imdb.com/name/nm0385296/",
   "url": "http://www.imdb.com/name/nm0385296/",
   "visibleUrl": "www.imdb.com",
   "cacheUrl": "http://www.google.com/search?q\u003dcache:1i34KkqnsooJ:www.imdb.com",
   "title": "\u003cb\u003eParis Hilton\u003c/b\u003e",
   "titleNoFormatting": "Paris Hilton",
   "content": "Self: Zoolander. Socialite \u003cb\u003eParis Hilton\u003c/b\u003e was..."
  },
  ...
 ],
 "cursor": {
  "pages": [
   { "start": "0", "label": 1 },
   { "start": "4", "label": 2 },
   { "start": "8", "label": 3 },
   { "start": "12","label": 4 }
  ],
  "estimatedResultCount": "59600000",
  "currentPageIndex": 0,
  "moreResultsUrl": "http://www.google.com/search?oe\u003dutf8..."
 }
}
, 200, null)

Argumentos específicos à pesquisa na web

O sistema da Pesquisa na web suporta diversos argumentos opcionais listados abaixo:

Argumento Descrição
cx? Este argumento opcional fornece o ID exclusivo do Mecanismo de pesquisa personalizado, que deve ser usado para esta solicitação (por exemplo, cx=000455696194071821846:reviews).
cref? Este argumento opcional fornece o URL de uma especificação vinculada do Mecanismo de pesquisa personalizado, que deve ser usado para atender a esta solicitação (por exemplo, cref=http%3A%2F%2Fwww.google.com%2Fcse%2Fsamples%2Fvegetarian.xml).
safe? Este argumento opcional fornece o nível de segurança da pesquisa, que pode ser:
  • safe=active - ativa o nível mais elevado da filtragem SafeSearch
  • safe=moderate - ativa o nível moderado da filtragem SafeSearch (padrão)
  • safe=off - desativa a filtragem SafeSearch
lr? Este argumento opcional permite que o originador da chamada restrinja a pesquisa aos documentos escritos em um idioma específico (por exemplo, lr=lang_ja). Esta lista contém o conjunto de valores permitidos.
filter? Novo! Esse argumento opcional controla a ativação ou desativação do filtro de conteúdo duplicado:
  • filter=0 - Desativa o filtro de conteúdo duplicado
  • filter=1 - Ativa o filtro de conteúdo duplicado (padrão)

Argumentos específicos da Pesquisa local

O sistema da Pesquisa local suporta diversos argumentos opcionais listados abaixo:

Argumento Descrição
sll? Este argumento opcional fornece o ponto central de pesquisa para uma pesquisa local. Seu valor é um par de coordenadas latitude/longitude separado por vírgulas, por ex., sll=48.8565,2.3509.
sspn? Este argumento opcional fornece uma caixa delimitadora à qual a pesquisa local deve ser relacionada. Ao usar o Google Maps, o valor sspn pode ser calculado usando: myMap.getBounds().toSpan().toUrlValue(); ( por exemplo, sspn=0.065169,0.194149).
mrt? Este argumento opcional especifica em qual tipo de lista o usuário está interessado. Os valores válidos incluem:
  • blended - solicitar KML, listas de empresas locais e resultados de geocódigo
  • kmlonly - solicitar KML e resultados de geocódigo
  • localonly - solicitar listas de negócios locais e resultados de geocódigo
Se este argumento não for fornecido, o valor padrão localonly será usado.

Argumentos específicos da Pesquisa de vídeos

O sistema da Pesquisa de vídeos suporta diversos argumentos opcionais listados abaixo:

Argumento Descrição
scoring? Este argumento opcional informa ao sistema da pesquisa de vídeos como ordenar os resultados. Os resultados podem ser ordenados por relevância (padrão) ou por data. Para selecionar a ordem por relevância, não forneça este argumento. Para selecionar a ordenação por data, defina scoring como scoring=d.

Argumentos específicos da Pesquisa de blogs

O sistema da Pesquisa de blogs suporta diversos argumentos opcionais listados abaixo:

Argumento Descrição
scoring? Este argumento opcional informa ao sistema da pesquisa de blogs como ordenar os resultados. Os resultados podem ser ordenados por relevância (padrão) ou por data. Para selecionar a ordem por relevância, não forneça este argumento. Para selecionar a ordenação por data, defina scoring como scoring=d.

Argumentos específicos da Pesquisa de notícias

O sistema da Pesquisa de notícias suporta diversos argumentos opcionais listados abaixo:

Argumento Descrição
scoring? Este argumento opcional informa ao sistema da pesquisa de notícias como ordenar os resultados. Os resultados podem ser ordenados por relevância (padrão) ou por data. Para selecionar a ordem por relevância, não forneça este argumento. Para selecionar a ordenação por data, defina scoring como scoring=d.
geo? Este argumento opcional informa ao sistema da pesquisa de notícias que os resultados de pesquisa devem ser limitados a uma localização específica. Com este argumento presente, o argumento da consulta (q) torna-se opcional. Este é um recurso bem novo e a cobertura das consultas com delimitação local é um pouco limitada. Você deve fornecer uma cidade, estado, país ou CEP, como em geo=Santa%20Barbara ou geo=British%20Columbia ou geo=Peru ou geo=93108.
qsid? Esse argumento opcional informa ao sistema de pesquisa de notícias para limitar os resultados da pesquisa de modo a incluir apenas resultados do tipo citação (em vez dos resultados com estilo de artigos de notícias clássicos). Com este argumento presente, o argumento da consulta (q) torna-se opcional. O valor deste argumento designa uma pessoa proeminente, cujas as citações foram reconhecidas e classificadas pelo serviço de pesquisa do Google Notícias. Por exemplo, Barack Obama tem um valor qsid de tPjE5CDNzMicmM e John McCain tem um valor de lE61RnznhxvadM. Este é um recurso muito novo e, no momento, ainda não temos um bom mecanismo de pesquisa ou de detecção para esses valores qsid.
topic? Este argumento opcional solicita que o sistema de pesquisa de notícias limite os resultados da pesquisa de acordo com um tópico específico. O valor do argumento especifica o tópico na edição atual ou selecionada:
  • h - especifica o tópico das principais manchetes
  • w - especifica o tópico mundo
  • b - especifica o tópico negócios
  • n - especifica o tópico país
  • t - especifica o tópico ciência e tecnologia
  • el - especifica o tópico eleições
  • p - especifica o tópico política
  • e - especifica o tópico entretenimento
  • s - especifica o tópico esportes
  • m - especifica o tópico saúde
A seleção de um tópico pode ser usada com ou sem uma consulta. Quando usada sem uma consulta, todo o tópico é fornecido (sujeito a &rsz) e, quando usado com uma consulta, a consulta é analisada com base no tópico especificado.

Os tópicos podem variar um pouco de acordo com a edição. Por exemplo, nas edições africanas como Namíbia ou Zimbábue (&ned=en_na, &ned=en_zw), o tópico af está disponível e representa o tópico Africano. No geral, se você estiver exibindo uma edição do Google Notícias e vir um tópico interessante, clique no cabeçalho do tópico e veja o argumento &topic na barra de endereço do navegador.

ned? Este argumento opcional informa ao sistema de pesquisa de notícias de qual edição de notícias obter os resultados. Os valores incluem:
  • us - especifica a edição americana
  • uk - especifica a edição britânica
  • fr_ca - especifica edição em francês do Canadá
  • etc.
A melhor maneira de entender o conjunto disponível de edições é observar os links de edição na parte inferior do Google Notícias. Após clicar em uma edição, observe o valor do argumento &ned na barra de endereços do navegador.

Argumentos específicos da Pesquisa de Livros do Google (experimental)

O sistema da Pesquisa de Livros suporta diversos argumentos opcionais listados abaixo:

Argumento Descrição
as_brr? Este argumento opcional informa ao sistema da Pesquisa de Livros que a pesquisa de livros deve ser restringida aos livros com visualização completa ou aberta a todos os livros. O valor as_brr=1 restringe a pesquisa a apenas os livros que podem ser visualizados totalmente. O padrão é todos os livros, e isso é indicado pela não especificação deste argumento.
as_list? Este argumento opcional informa ao sistema da pesquisa de livros que a pesquisa deve ser restringida à biblioteca definida pelo usuário especificada.

Argumentos específicos da Pesquisa de imagens

O sistema da Pesquisa de imagens do Google suporta diversos argumentos opcionais listados abaixo. Além disso, os resultados podem ser restringidos ao arquivo de fotos LIFE incluindo source:life como parte da consulta, como em q=source%3Alife+query+terms (experimental).

Argumento Descrição
safe? Este argumento opcional fornece o nível de segurança da pesquisa, que pode ser:
  • safe=active - ativa o nível mais elevado da filtragem SafeSearch
  • safe=moderate - ativa o nível moderado da filtragem SafeSearch (padrão)
  • safe=off - desativa a filtragem SafeSearch
imgsz? Este argumento opcional informa ao sistema de pesquisa de imagens que a pesquisa deve ser restringida às imagens com o tamanho especificado, que pode ser:
  • imgsz=icon - restringe a imagens pequenas
  • imgsz=small|medium|large|xlarge - restringe a imagens coloridas
  • imgsz=xxlarge - restringe a imagens grandes
  • imgsz=huge - restringe a imagens muito grandes
imgc? Este argumento opcional informa ao sistema de pesquisa de imagens que a pesquisa deve ser restringida às imagens com as cores especificadas, que podem ser:
  • imgc=gray - restringe a imagens em tons de cinza
  • imgc=color - restringe a imagens coloridas
imgcolor?Novo!
(experimental)
Este argumento opcional informa ao sistema da pesquisa de imagens que a pesquisa deve ser filtrada às imagens da cor especificada:
  • imgcolor=black
  • imgcolor=blue
  • imgcolor=brown
  • imgcolor=gray
  • imgcolor=green
  • imgcolor=orange
  • imgcolor=pink
  • imgcolor=purple
  • imgcolor=red
  • imgcolor=teal
  • imgcolor=white
  • imgcolor=yellow
imgtype?
(experimental)
Este argumento opcional informa ao sistema da pesquisa de imagens que a pesquisa deve ser restringida às imagens do tipo especificado:
  • imgtype=face - restringe a imagens de rostos
  • imgtype=photo - restringe a fotos
  • imgtype=clipart - restringe a imagens clipart
  • imgtype=lineart - restringe a imagens de desenhos lineares
as_filetype? Este argumento opcional informa ao sistema de pesquisa de imagens que a pesquisa deve ser restringida às imagens do tipo de arquivo especificado, que pode ser:
  • as_filetype=jpg - restringe a imagens de rostos
  • as_filetype=png - restringe a imagens png
  • as_filetype=gif - restringe a imagens gif
  • as_filetype=bmp - restringe a imagens bmp
as_sitesearch? Este argumento opcional informa ao sistema da pesquisa de imagens que a pesquisa deve ser restringida às imagens dentro do domínio especificado, por ex., as_sitesearch=photobucket.com. Observação: Essa restrição pode restringir os resultados às imagens encontradas nas páginas no URL determinado e/ou às imagens com o URL determinado.

Argumentos específicos da Pesquisa de patentes do Google

O sistema da Pesquisa de patentes suporta diversos argumentos opcionais listados abaixo:

Argumento Descrição
as_psrg? Este argumento opcional informa ao sistema da pesquisa de patentes que a pesquisa deve ser restringida APENAS às patentes emitidas, ignorando todas as patentes apenas solicitadas. Quando especificado, esse valor deve ser 1, como em &as_psrg=1
as_psra? Este argumento opcional informa ao sistema da pesquisa de patentes que a pesquisa deve ser restringida APENAS às patentes que foram apenas solicitadas, ignorando todas as patentes emitidas. Quando especificado, esse valor deve ser 1, como em &as_psrg=1
scoring? Este argumento opcional informa ao sistema da pesquisa de patentes como ordenar os resultados. Os resultados podem ser ordenados por relevância (padrão) ou por data. Para selecionar a ordem por relevância, não forneça este argumento. Para selecionar a ordem de acordo com datas decrescentes, na qual o resultado mais atual é o primeiro, defina o a pontuação como scoring=d. Para selecionar a ordem de acordo com datas crescentes, na qual o resultado mais antigo é o primeiro, defina a pontuação como scoring=ad.

Opções de pesquisa e desenho

GsearcherOptionsgoogle.search.SearcherOptions - Construtor

Ao adicionar uma pesquisa ao controle de pesquisa, o objeto GsearcherOptionsgoogle.search.SearcherOptions pode ser especificado. Se for especificado, fornecerá diversas opções usadas para controlar determinados aspectos da pesquisa relacionada. Este objeto é implementado principalmente como um pacote de propriedades, conectado a uma determinada classe de pesquisa. Algumas de suas propriedades se aplicam uniformemente a todas as pesquisas, enquanto outras se aplicam apenas a tipos específicos. É o aplicativo que deve usá-lo apropriadamente, definindo as opções corretas e usando-as da maneira apropriada.

Este objeto permite que o originador da chamada controle o modo de expansão padrão (ou seja, como os resultados de pesquisa são exibidos nas seções da pesquisa quando a pesquisa é concluída), no qual os resultados de pesquisa da página web e diversas opções específicas da pesquisa são exibidas. O fragmento a seguir demonstra como usar a classe correspondente para definir as opções da pesquisa.

// create a searcher options object
// set up for open expansion mode
// load a searcher with these options
var options = new GsearcherOptionsgoogle.search.SearcherOptions();
options.setExpandMode(GSearchControlgoogle.search.SearchControl.EXPAND_MODE_OPEN);
searchControl.addSearcher(new GwebSearchgoogle.search.WebSearch(), options);
        

Depois que um objeto de opções de pesquisa é usado em uma chamada .addSearcher(), a alteração de suas propriedades tem efeito indefinido. O uso esperado é que haja a definição de um objeto options, que ele seja utilizado na adição de uma pesquisa e que nunca mais seja alterado.

GsearcherOptionsgoogle.search.SearcherOptions - Construtor

Construtor Descrição

GsearcherOptionsgoogle.search.SearcherOptions()

O construtor é usado para criar uma instância de um objeto options de pesquisa. Este objeto fornece diversas configurações usadas pelo controle da pesquisa.

GsearcherOptionsgoogle.search.SearcherOptions - Construtor

Método Descrição

.setExpandMode(expandMode)

Este método é usado para comunicar à pesquisa o modo de expansão desejado para os resultados quando a pesquisa for concluída.

  • expandMode - fornece o modo de expansão para a seção associada de resultados de pesquisa. Os valores válidos incluem:
    • GSearchControlgoogle.search.SearchControl.EXPAND_MODE_CLOSED - A seção de resultados é fechada, não exibindo resultados. Ao clicar no controle, o usuário pode "abrir" a seção de resultados para ver todos os resultados retornados pela pesquisa atual.
    • GSearchControlgoogle.search.SearchControl.EXPAND_MODE_OPEN - A seção de resultados é aberta, exibindo todos resultados.
    • GSearchControlgoogle.search.SearchControl.EXPAND_MODE_PARTIAL - A seção de resultados fica parcialmente aberta, mostrando uma pequena parte dos resultados. Normalmente, isso significa que um único resultado é exibido.
  • retorna - n/d

.setRoot(element)

Este método é usado para instruir o controle de pesquisa a desenhar os resultados da pesquisa associada no elemento recipiente fornecido, em vez de desenhar no recipiente padrão alocado durante a execução do método .draw() dos controles de pesquisa.

  • element - Fornece um elemento recipiente html, normalmente um elemento div, que o controle de pesquisa deve usar como recipiente para os resultados da pesquisa associada.
  • retorna - n/d

.setVideoResultsTbHeight(height)

Este método permite que o originador da chamada especifique um fator de dimensionamento padrão alternativo, aplicado aos resultados de pesquisas de vídeos quando são exibidos pelo controle de pesquisa. A altura fornecida também afeta a largura resultante do vídeo. O sistema mantém uma proporção de 4x3 para vídeos, de modo que a largura resultante do vídeo seja a altura * 1,33. O resultado é um objeto imageScaler (consulte GSearchgoogle.search.Search.scaleImage). O uso desta função afeta a regra CSS .gs-videoResult td div.gs-image-box. dentro do gsearch.css. Portanto, ao ajustar o tamanho de vídeos, faça alterações compatíveis com a substituição dessa regra.

  • height - fornece a altura máxima, em pixels, de dimensionamento da miniatura do vídeo, antes de ser renderizada pelo controle de pesquisa. A API determina o valor máximo de 100px.
  • retorna - n/d

.setImageResultsTbHeight(height)

Este método permite que o originador da chamada especifique um fator de dimensionamento padrão alternativo, aplicado a resultados de pesquisa de imagens quando são exibidos pelo controle de pesquisa. A altura fornecida também afeta a largura resultante da imagem. O sistema mantém uma proporção de 4x3 para as imagens. Portanto, a largura resultante da imagem é a altura * 1,33. O resultado é um objeto imageScaler (consulte GSearch.scaleImage). O uso desta função afeta a regra CSS .gs-imageResult (propriedade width), bem como a regra CSS .gs-imageResult .gs-image-box (propriedade height). As dimensões padrão da imagem são 112 x 84, daí as regras CSS serem 114 x 86 (2 px a mais para levar em consideração uma borda de 1 px). Ao ajustar o tamanho de imagens, faça alterações compatíveis com a substituição dessas regras.

  • height - fornece a altura máxima, em pixels, de dimensionamento da miniatura da imagem, antes de ser renderizada pelo controle de pesquisa. A API determina o valor máximo de 100px.
  • retorna - n/d

.setNoResultsString(str)

Normalmente, o slot da pesquisa no controle de pesquisa é deixado vazio quando uma pesquisa não produz resultados. Este método permite que o originador da chamada especifique uma string que fornece um "resultado" padrão. O sistema contém o valor GSearchControlgoogle.search.SearchControl.NO_RESULTS_DEFAULT_STRING, que você pode usar. Esta á uma string localizada que significa "Sem resultados" em todos os locais suportados.

  • str - fornece um valor de string usado quando uma pesquisa não obtém resultados.
  • retorna - n/d

GdrawOptions google.search.DrawOptions

Ao solicitar que um controle de pesquisa realize um desenho, é necessário especificar um recipiente no qual o controle irá desenhar. Além deste parâmetro obrigatório, o método .draw() do controle de pesquisa também aceita um objeto GdrawOptionsgoogle.search.DrawOptions opcional. Este objeto permite que o aplicativo solicite um layout linear ou com guias (linear é o padrão). Além disso, este objeto permite que o aplicativo solicite que o "formulário de pesquisa" (isto é, o elemento de entrada, botão, controles etc.). associado à pesquisa seja desacoplado do conjunto de resultados de pesquisa. Para isso, use o método .setSearchFormRoot() e forneça um recipiente para hospedar o formulário de pesquisa.

Em um modo mais avançado que o descrito acima, este objeto permite que os aplicativos solicitem que o controle de pesquisa não crie um formulário de pesquisa e, em vez disso, use um elemento de entrada de texto fornecido pelo aplicativo. Quando esta opção é especificada, o controle de pesquisa assume o controle do elemento de entrada, capturando eventos onkeyup e onpaste. A lista de eventos capturada pelo controle poderá mudar com o tempo. Ao entregar um elemento de entrada ao controle de pesquisa, o aplicativo simplesmente assume a responsabilidade pelo posicionamento do elemento, bem como pelo estilo. Quando o elemento de entrada tiver sido entregue ao controle, o aplicativo não deve interagir com o elemento de nenhuma outra maneira que não seja para ler seu valor, se necessário.

O fragmento a seguir demonstra como usar este objeto para solicitar que o controle de pesquisa realize seu desenho no modo "com guias".

// create a drawOptions object
var drawOptions = new GdrawOptionsgoogle.search.DrawOptions();
drawOptions.setDrawMode(GSearchControlgoogle.search.SearchControl.DRAW_MODE_TABBED);
searchControl.draw(element, drawOptions);
        

O fragmento a seguir demonstra como usar este objeto para solicitar que o formulário de pesquisa seja desacoplado do conjunto de resultados de pesquisa.

...
<div id="searchForm">Loading...</div>
...
var searchFormElement = document.getElementById("searchForm");
var drawOptions = new GdrawOptionsgoogle.search.DrawOptions();
drawOptions.setSearchFormRoot(searchFormElement);
searchControl.draw(element, drawOptions);
        

GdrawOptions - Construtor

Construtor Descrição

GdrawOptionsgoogle.search.DrawOptions()

O construtor é usado para criar uma instância de um objeto de opções de desenho. Este objeto fornece diversas configurações usadas pelo controle de pesquisa durante a fase de desenho. Especificamente, ele fornece controle sobre o modo com guias em vez do modo linear, além de fornecer ao aplicativo uma maneira de entregar um elemento de entrada ao controle de pesquisa. O padrão de um objeto de opções de desenho recém-construído é o modo linear, com o elemento de entrada de texto pertencendo/sendo criado pelo controle de pesquisa.

GdrawOptionsgoogle.search.DrawOptions - Métodos

Método Descrição

.setInput(inputElement)

Este método é usado para entregar um elemento de entrada ao controle de pesquisa. Em vez de criar seu próprio elemento de entrada de texto para capturar as consultas da pesquisa, o controle usará este elemento de entrada fornecido pelo aplicativo.

Quando esta opção é especificada, o controle de pesquisa assume o controle do elemento de entrada, captura onkeyup e onpaste eventos. A lista de eventos capturada pelo controle poderá mudar com o tempo. Ao entregar um elemento de entrada ao controle de pesquisa, o aplicativo simplesmente assume a responsabilidade pelo posicionamento do elemento, bem como pelo estilo. Quando o elemento de entrada tiver sido entregue ao controle, o aplicativo não deve interagir com o elemento de nenhuma outra maneira que não seja para ler seu valor, se necessário.

  • inputElement - fornece um elemento de entrada que deve ser usado pelo controle de pesquisa.
  • retorna - n/d

.setDrawMode(drawMode)

Este método é usado para instruir o controle de pesquisa a desenhar os resultados no modo "com guias" ou "linear".

  • drawMode - o valor GSearchControlgoogle.search.SearchControl.DRAW_MODE_LINEAR é usado para especificar o modo de desenho linear. O valor GSearchControlgoogle.search.SearchControl.DRAW_MODE_TABBED é usado para especificar o modo de desenho com guias.
  • retorna - n/d

.setSearchFormRoot(element)

Este método é usado para indicar que você deseja que o formulário de pesquisa seja colocado neste recipiente DOM especificado por "element", em vez de ser colocado em sua localização padrão, isto é, próximo aos resultados de pesquisa.

Ver exemplo (searchformroot.html)

  • element - fornece um recipiente dentro do qual o formulário de pesquisa será colocado.
  • retorna - n/d

GXXX - Propriedades

A coleção de propriedades públicas a seguir é utilizada por este objeto. A menos que indicado em contrário, estas propriedades são somente para leitura.

Propriedade Descrição

.property

Descrição

.property

Descrição

.property

Descrição

.property

Descrição

GXXX

Descrição

GXXX - Construtor

Construtor Descrição

GXXX()

Descrição

GXXX - Métodos

Método Descrição

.method()

descrição

  • arg - fornece um
  • retorna - n/d

.method()

descrição

  • arg - fornece um
  • retorna - n/d

.method()

descrição

  • arg - fornece um
  • retorna - n/d

.method()

descrição

  • arg - fornece um
  • retorna - n/d