Extensibilidade do provedor de pesquisa no Internet Explorer

Artigo
02/01/2010

Novidade no Windows Internet Explorer 8

Com o Internet Explorer 7 a caixa Pesquisa Instantânea começou a fornecer um recurso de Preenchimento Automático para que os usuários pudessem procurar termos de pesquisa semelhantes aos usados em pesquisas anteriores. O Internet Explorer 7 também permite que os usuários adicionem vários provedores de pesquisa. Os aprimoramentos na pesquisa do Internet Explorer 8 concentram-se em melhorar de forma significativa o menu suspenso da caixa Pesquisa Instantânea e do suporte a sugestões de pesquisa para ajudar os usuários a fazer pesquisas.

Este tópico destina-se a dois públicos-alvo: os usuários finais e os desenvolvedores de sites. A primeira parte deste tópico concentra-se em ajudar os usuários finais a instalar e gerenciar provedores de pesquisa e a usar um provedor de pesquisa para localizar o que desejam. A segunda parte concentra-se nos desenvolvedores de sites, mostrando como elevar um provedor de pesquisa e como usar sugestões de pesquisa para melhorar a experiência de um usuário com seu provedor de pesquisa.

Este tópico discute os seguintes assuntos:

Recursos de pesquisa para usuários finais
- Adicionando provedores de pesquisa
- Gerenciando provedores de pesquisa
- Pesquisando com meus provedores de pesquisa favoritos
- Dicas e truques
Recursos de pesquisa para desenvolvedores da Web
- Criando um arquivo de descrição do OpenSearch
- Promovendo provedores de pesquisa
- Oferecendo sugestões de pesquisa
- Obtendo dimensões para o menu Sugestões de Pesquisa
- Identificando referenciadores de pesquisa
- Localizando sugestões de pesquisa
- Comentários
Tópicos relacionados

Recursos de pesquisa para usuários finais

O recurso Pesquisa Instantânea do Internet Explorer 8 permite que o usuário final adicione provedores de pesquisa favoritos e rapidamente alterne entre provedores durante uma pesquisa. O Internet Explorer 8 oferece suporte a sugestões de pesquisa a fim de ajudar os usuários a iniciar consultas de pesquisa melhores. Os provedores de pesquisa também podem fornecer respostas instantâneas a consultas. Além de usar a caixa Pesquisa Instantânea, os usuários podem acessar todos os seus provedores de pesquisa por meio do menu Aceleradores. Esses recursos foram desenvolvidos para melhorar a experiência de pesquisa e aumentar a produtividade dos usuários finais.

Esta seção aborda os seguintes tópicos:

Adicionando provedores de pesquisa
Gerenciando provedores de pesquisa
Pesquisando com meus provedores de pesquisa favoritos
Dicas e truques

Adicionando provedores de pesquisa

A caixa Pesquisa Instantânea no canto superior direito da janela do navegador Internet Explorer 7 e Internet Explorer 8 substituiu o Assistente do Windows Search (ou Painel de Pesquisa). Antes de usar um provedor de pesquisa específico, você deve adicionar o provedor à sua lista. Para adicionar um provedor de pesquisa, navegue até o site do provedor. Há duas maneiras de instalar um provedor de pesquisa.

Primeiro, você pode clicar em um link ou um botão exibido pelo site de provedor para adicioná-lo como um provedor de pesquisa à sua lista. Ao clicar no link ou no botão, a caixa de diálogo Adicionar Provedor de Pesquisa é exibida para que você possa confirmar sua seleção.

Figura 1. Caixa de diálogo Adicionar Provedor de Pesquisa.

Se esse provedor de pesquisa específico já tiver sido instalado, será exibida uma caixa de diálogo com essa informação ou com opções para atualizar o provedor. Por exemplo, o provedor de pesquisa poderá oferecer sugestões de pesquisa que não oferecia antes.

A segunda maneira de adicionar um provedor de pesquisa é por meio de descoberta. Depois de a página da Web do provedor ser carregada, a seta suspensa da caixa Pesquisa Instantânea fica laranja, indicando que um provedor de pesquisa pode ser instalado.

Figura 2. Seta suspensa laranja da caixa Pesquisa Instantânea.

Ao clicar na seta suspensa laranja, é exibida uma lista de provedores de pesquisa instalados e outras opções disponíveis. Um ícone dourado é exibido à esquerda do nome do provedor de pesquisa descoberto pelo Internet Explorer 8. Ao clicar na opção Adicionar Provedores de Pesquisa, uma lista de provedores disponíveis é exibida. A imagem a seguir mostra as opções do Live Search: Produtos, Imagens e Vídeos.

Figura 3. Menu Adicionar Provedor de Pesquisa mostrando provedores de pesquisa e opções de pesquisa.

Observação Para ajudá-lo a começar, há uma lista de provedores disponível na Galeria do Internet Explorer. Essa galeria pode ser acessada a qualquer momento escolhendo a opção Localizar Mais Provedores... na seta suspensa da caixa Pesquisa Instantânea; conforme mostrado na Figura 3.

Adicionando seu próprio provedor de pesquisa

Mesmo que o seu provedor de pesquisa não ofereça uma maneira direta para você adicioná-lo como um provedor de pesquisa, é possível adicioná-lo manualmente. Siga as instruções na página do Guia do Windows Search 9 (a página pode estar em inglês) para criar seu próprio provedor de pesquisa. Observe que esse widget adiciona o provedor apenas como um provedor de pesquisa sem sugestões de pesquisa. Se você souber que o provedor oferece sugestões de pesquisa, use o site do provedor de pesquisa para adicioná-lo.

Gerenciando provedores de pesquisa

O número máximo de provedores de pesquisa que você pode instalar é 200, o que pode ser difícil de gerenciar. Para gerenciar seus provedores de pesquisa no Internet Explorer 8, clique na seta suspensa da caixa Pesquisa Instantânea e em Gerenciar Provedores de Pesquisa. Você pode reorganizar provedores, alterar o status padrão e remover um provedor, conforme mostrado na imagem a seguir.

Figura 4. Caixa de diálogo Gerenciar Complementos do Internet Explorer.

Para alterar os atributos de um provedor de pesquisa, clique no nome de provedor, faça suas alterações e clique em Fechar.

Observação Não é possível remover o provedor Padrão atual. Para removê-lo, você deve definir outro provedor com o status Padrão. Para fazer isso, abra a caixa de diálogo Gerenciar Provedores de Pesquisa, clique em outro provedor e clique no botão Definir como padrão. Em seguida, clique no provedor que deseja remover e clique em Remover.

Pesquisando com meus provedores de pesquisa favoritos

Para realizar uma pesquisa, digite o termo de pesquisa na caixa Pesquisa Instantânea. Embora estivesse familiarizado com essa caixa no Internet Explorer 7, você notará melhorias significativas na maneira como pode fazer pesquisas no Internet Explorer 8.

Depois de clicar na caixa Pesquisa Instantânea, um menu de seleção rápida é exibido. Esse menu exibe tantos ícones de provedores de pesquisa quanto o permitido pela largura de caixa Pesquisa Instantânea, facilitando a alternância entre provedores. Para visualizar mais provedores de pesquisa no menu de seleção rápida, redimensione a caixa Pesquisa Instantânea. Você pode usar o mesmo termo para pesquisar nesses provedores sem ter de navegar no site de cada provedor.

Figura 5. O menu de seleção rápida.

Depois de inserir seu termo de pesquisa, pressione ENTER para usar o provedor de pesquisa atual ou selecione um provedor no menu de seleção rápida para realizar a pesquisa. Se o provedor de pesquisa que você utiliza oferecer suporte a sugestões de pesquisa, as sugestões de pesquisa serão exibidas conforme você digita. Por exemplo, se procurar por "Xbox" usando o Live Search, você poderá ver a lista de sugestões a seguir.

Figura 6. Menu suspenso Sugestões do Live Search.

A parte superior do menu de sugestões é a seção Preenchimento Automático, que mostra as pesquisas recentes que correspondem ao seu termo de pesquisa atual. A segunda parte do menu de sugestões é a seção Sugestões, que lista sugestões de pesquisa fornecidas pelo provedor de pesquisa atual. A terceira parte do menu de sugestões é a seção Histórico, que lista sites visitados anteriormente mostrando títulos e URLs de sites que correspondem ao termo de pesquisa atual. Os termos correspondentes são realçados. Você pode selecionar um termo correspondente para pesquisar. O menu de seleção rápida é exibido na parte inferior do menu para o acesso rápido aos seus principais provedores de pesquisa.

O Internet Explorer 8 permite que os provedores de pesquisa exibam sugestões visuais. Os provedores de pesquisa podem fornecer uma imagem e um texto pequenos, ou apenas uma imagem, que podem ser combinados com sugestões de texto comuns. A imagem a seguir mostra sugestões visuais e de texto para o termo "Xbox".

Figura 7. Sugestões de pesquisa visual e de texto para Xbox

Além disso, um provedor de pesquisa pode oferecer respostas instantâneas para seu termo de pesquisa. Com as respostas instantâneas, o seu provedor pode levá-lo diretamente às informações que você está procurando, em vez de a uma página de resultados de pesquisa. Isso pode tornar sua pesquisa mais eficiente.

Pesquisar usando Aceleradores

O conceito de Aceleradores é novo no Internet Explorer 8. Os Aceleradores permitem que você acesso provedores de serviços em qualquer lugar na página. Sempre que você adicionar um provedor de pesquisa à sua lista, o Internet Explorer 8 automaticamente o converterá em um Acelerador. Para usar esse recurso, realce o texto que deseja procurar e clique no ícone Aceleradores Cc848862.ie8_accelerators_icon(en-us,VS.85).gif exibido. Uma lista condensada dos serviços Web que você possui instalados é exibida. Dentre eles está o seu provedor de pesquisa padrão. Para usar um provedor de pesquisa diferente, clique em Mais Aceleradores. A imagem a seguir mostra o menu Mais Aceleradores expandido.

Figura 8. O menu Mais Aceleradores mostrando os serviços Web disponíveis.

Outro benefício de um Acelerador é a capacidade de visualizar resultados da pesquisa. Se o seu provedor de pesquisa oferecer suporte à visualização de pesquisa, você poderá simplesmente selecionar algum texto em uma página da Web, clicar no ícone do Acelerador, passar o mouse sobre o nome de seu provedor de pesquisa (talvez seja necessário abrir a lista Mais Aceleradores para localizá-lo) e uma janela de visualização será exibida com os resultados da pesquisa das palavras que você selecionou. Isso torna a pesquisa mais rápida e conveniente usando seus provedores de pesquisa instalados. Para saber mais sobre Aceleradores, consulte o artigo Guia do Desenvolvedor de Aceleradores OpenService (a página pode estar em inglês).

Localizar nesta Página

O recurso Localizar nesta Página é outra melhoria na experiência do usuário no Internet Explorer 8. Para iniciar uma pesquisa, clique na opção Localizar à direita do menu de seleção rápida ou use a tecla de atalho CTRL+F. O recurso Localizar nesta Página pesquisa a página atual usando os termos da caixa Pesquisa Instantânea. Conforme ilustrado pela captura de tela a seguir, todas as correspondências na página são realçadas e o primeiro termo correspondente é selecionado. O número de correspondências na página também é exibido.

Figura 9: O recurso Localizar nesta Página

Dicas e truques

Estes são alguns outros recursos e dicas que não foram abordados acima.

O histórico de pesquisas pode ser excluído. Você pode excluir termos de pesquisa anteriores e páginas de histórico da lista Histórico. Isso é útil quando você não deseja que os termos digitados incorretamente sejam exibidos na seção Preenchimento Automático. Enquanto você digita na Barra de endereços ou na caixa Pesquisa Instantânea, sugestões de pesquisa são exibidas juntamente com sugestões de Preenchimento Automático e Histórico. Ao passar o mouse sobre o item que deseja excluir da lista de Preenchimento Automático ou de Histórico, um X é exibido ao lado do item, conforme mostrado na imagem a seguir. Clique no X para excluir o item da lista.

Figura 10. Excluindo um item da lista Histórico
Você pode iniciar uma pesquisa a partir da Barra de endereços. Ao usar a Barra de endereços, seu provedor de pesquisa atual será usado para fornecer sugestões de pesquisa; entretanto, a pesquisa será executada por seu provedor de pesquisa padrão. Para iniciar uma pesquisa a partir da Barra de endereços, inicie a pesquisa com um ? seguido pelo termo de pesquisa. Por exemplo, para realizar uma pesquisa por xbox, digite ? xbox. Se o seu provedor de pesquisa atual fornecer sugestões de pesquisa para xbox, elas serão exibidas em uma lista. A seleção de um termo ou o pressionamento de ENTER executará a pesquisa usando o seu provedor de pesquisa padrão.
A caixa Pesquisa Instantânea pode ser redimensionada. Para redimensionar a caixa Pesquisa Instantânea, mova o ponteiro para a borda esquerda da caixa. Quando o ponteiro horizontal for exibido, arraste a caixa Pesquisa Instantânea para redimensioná-la.

Recursos de pesquisa para desenvolvedores da Web

Os sites agora podem anunciar provedores de pesquisa para que os usuários possam executar pesquisas diretamente do cromado do Internet Explorer, sem ter de primeiro navegar até um site específico. O provedor de pesquisa padrão também é usado para executar pesquisas a partir da Barra de endereços. A primeira etapa da promoção de seu provedor de pesquisa no Internet Explorer 8 é permitir que os usuários instalem seu site como um provedor de pesquisa na caixa de pesquisa. Para fazer isso, são necessárias duas etapas. A primeira etapa é criar um arquivo de descrição do OpenSearch Link da World Wide Web (a página pode estar em inglês) para o seu provedor de pesquisa e a segunda etapa é expor o arquivo de descrição em seu site para que os usuários possam instalá-lo.

Esta seção concentra-se em ajudar os desenvolvedores a compreender e aproveitar os recursos de pesquisa do Internet Explorer 8 a fim de melhorar a experiência de pesquisa do usuário. Esta seção aborda os seguintes tópicos:

Criando um arquivo de descrição do OpenSearch
Promovendo provedores de pesquisa
Oferecendo sugestões de pesquisa
Obtendo dimensões para o menu Sugestões de Pesquisa
Identificando referenciadores de pesquisa
Localizando sugestões de pesquisa
Comentários

Criando um arquivo de descrição do OpenSearch

Antes de promover seus serviços e fornecer aos usuários opções para instalar o provedor de pesquisa, você deve criar um arquivo de descrição do OpenSearch Link da World Wide Web (a página pode estar em inglês). Os arquivos de descrição do OpenSearch são pequenos arquivos XML que descrevem o seu provedor de pesquisa para o Internet Explorer 8. A tabela a seguir descreve os valores no arquivo de descrição do OpenSearch.

Valor	Descrição
ShortName (obrigatório)	Esse é o nome do provedor de pesquisa que é exibido na caixa Pesquisa Instantânea quando o seu provedor é selecionado.
URL (obrigatório)	A URL para consultas de pesquisa básica em seu provedor de pesquisa. Ela deve ser uma URL absoluta.
Image (opcional)	Ponteiro para um arquivo favicon de seu provedor de pesquisa em seu site. Esse ícone é exibido ao lado do nome do provedor na caixa Pesquisa Instantânea. O ícone deve ser um arquivo de ícone de atalho válido, caso contrário um ícone genérico será utilizado. Para obter mais informações sobre como criar um favicon, consulte a seção sobre criação de ícones no formato correto do artigo sobre como adicionar um ícone de atalho a uma página da Web (a página pode estar em inglês).
Suggestions URL (JSON) (opcional)	Essa é a URL da qual as sugestões de JSON (JavaScript Object Notation) podem ser recuperadas.
Suggestions URL (XML) (opcional)	Essa é a URL da qual as sugestões com base em XML podem ser recuperadas.
PreviewUrl (opcional)	URL para exibir os resultados em uma janela de visualização do Acelerador.

O exemplo a seguir de arquivo de descrição do OpenSearch define o tipo de serviço de pesquisa que você pretende oferecer.

<?xml version="1.0" encoding="UTF-8"?>
<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/" xmlns:ie="https://schemas.microsoft.com/Search/2008/">
	<ShortName>My Custom Search</ShortName>
	<Image height="16" width="16" type="image/icon">http://example.com/example.ico</Image>
	<Url type="text/html" template="http://example.com/search.aspx?q={searchTerms}&amp;source=IE"/>   
	<Url type="application/x-suggestions+json" template="http://suggestions.example.com/search.aspx?q={searchTerms}"/>
	<Url type="application/x-suggestions+xml" template="http://suggestions.example.com/search.aspx?q={searchTerms}"/>
	<ie:PreviewUrl type="text/html" template="http://suggestions.example.com/search.aspx?q={searchTerms}"/>
</OpenSearchDescription>

Todos os arquivos de descrição do OpenSearch devem incluir o nome do provedor de pesquisa e a URL de pesquisa. Sem esses elementos, o Internet Explorer 8 não pode instalar o seu provedor de pesquisa. Todas as URLs de pesquisa devem conter "{searchTerms}" em algum lugar da sequência de consulta. Quando o Internet Explorer 8 navega até esse provedor para obter os resultados da pesquisa, "{searchTerms}" é substituído pela sequência da consulta que o usuário digitou na caixa Pesquisa Instantânea. Você deve incluir um ícone dentro do arquivo de descrição do OpenSearch. Se o Internet Explorer 8 não conseguir localizar um ícone especificado pelo atributo "Image", ele usará um ícone genérico Ícone genérico de provedor de pesquisa para representar seu provedor de pesquisa no menu de seleção rápida.

Uma maneira rápida de gerar um arquivo de descrição do OpenSearch é usar um widget do Guia do Windows Search para criar seu próprio arquivo XML. Siga as instruções no widget e, em seguida, clique no link Exibir XML da etapa 5. O widget cria uma sintaxe XML semelhante ao trecho de código anterior. Salve a saída em um arquivo XML e carregue o arquivo em seu servidor Web. Certifique-se de que tenha um arquivo XML válido e de que os caracteres "&" em sua URL estejam codificados.

Observação O widget apenas gera um arquivo XML básico que você pode usar e personalizar. Entretanto, ele não gera nenhum ícone ou URL de sugestão. Você mesmo deve adicionar esses elementos.

Adicionando sugestões de pesquisa em arquivos de descrição do OpenSearch

No Internet Explorer 8, os provedores de pesquisa podem oferecer sugestões aos usuários. Ao usar as sugestões de pesquisa, os usuários podem criar termos de pesquisa melhores e localizar mais rapidamente o que estão procurando. Para oferecer sugestões de pesquisa para os formatos JSON e XML, adicione os elementos a seguir ao seu arquivo de descrição.

<Url type="application/x-suggestions+json" template="http://suggestions.example.com/search.aspx?q={searchTerms}"/>
<Url type="application/x-suggestions+xml" template="http://suggestions.example.com/search.aspx?q={searchTerms}"/>

Ao incluir elementos de URL adicionais, verifique se o tipo "text/html" está listado primeiro. Isso possibilita a compatibilidade com versões anteriores. Os outros tipos podem seguir qualquer ordem. Por padrão, o Internet Explorer usa a URL de "text/html" como a URL de pesquisa genérica quando as sugestões de pesquisa não estiverem disponíveis ou não tiverem suporte em versões anteriores. Entretanto, quando as URLs de XML e JSON existirem, o Internet Explorer 8 usará a URL de sugestões de XML.

Observação Se os usuários tiverem adicionado seu provedor de pesquisa antes de ele oferecer suporte a sugestões, eles deverão adicionar seu provedor de pesquisa novamente. O Internet Explorer 8 detectará que o seu provedor de pesquisa já foi instalado, mas agora ele oferece sugestões. A caixa de diálogo Adicionar Provedor de Pesquisa exibirá um botão Atualizar Provedor e habilitará a caixa de seleção de sugestão de pesquisa.

Oferecendo suporte a visualizações de pesquisa

Todos os provedores de pesquisa instalados são automaticamente convertidos em Aceleradores. Como os Aceleradores oferecem suporte a visualizações, isso permite que você também ofereça suporte a visualizações de pesquisa adicionando um PreviewUrl em seu arquivo de descrição do OpenSearch conforme mostrado a seguir.

<ie:PreviewUrl type="text/html" template="http://suggestions.example.com/search.aspx?q={searchTerms}/>

Com a adição desse elemento em seu arquivo de descrição do OpenSearch, você pode fornecer uma exibição leve da página de resultados da pesquisa. A visualização é exibida em uma janela de 320 x 240 quando o usuário seleciona algum texto em uma página da Web, clica no ícone de Aceleradores e passa o mouse sobre o nome do seu provedor de pesquisa. Para obter mais informações sobre Aceleradores e o recurso Visualização, consulte o artigo Guia do Desenvolvedor de Aceleradores OpenService (a página pode estar em inglês).

Observação O ie:PreviewUrl está usando o namespace fornecido por declarações de namespace do Internet Explorer. Ao usar esse recurso, certifique-se de que essa declaração esteja definida em sua marca OpenSearchDescription: xmlns:ie="https://schemas.microsoft.com/Search/2008/".

Promovendo provedores de pesquisa

Depois de criar seu arquivo de descrição do OpenSearch, você pode promover seus serviços aos usuários. Há duas maneiras principais de promover provedores de pesquisa. A primeira opção é fornecer a seus usuários um link ou um botão que aponte para o seu arquivo de descrição. Os usuários precisarão executar uma ação para instalar o seu provedor. A segunda opção é tornar o seu provedor detectável. Isso exige uma linha de código na parte superior de sua página da Web e permite que o Internet Explorer 8 detecte seu provedor enquanto os usuários navegam em seu site.

O código a seguir adiciona um provedor de pesquisa quando um usuário clica em um link.

<a href="#"
   onclick="window.external.AddSearchProvider('http://www.example.com/provider.xml')"
   >Add Search Provider Example</a>

O código chama o método AddSearchProvider. O método AddSearchProvider está disponível no objeto externo da janela. Quando você executa esse código a partir de uma página HTML no Internet Explorer 8, a caixa de diálogo Adicionar Provedor de Pesquisa é exibida.

Tornando o provedor de pesquisa detectável

A segunda maneira de promover um provedor de pesquisa é tornando-o detectável. A especificação do OpenSearch descreve como anunciar provedores de pesquisa adicionando um elemento de link no cabeçalho da página da Web. O código a seguir habilita o Internet Explorer 8 a descobrir o seu provedor de pesquisa.

<link title="My Provider" rel="search"
   type="application/opensearchdescription+xml"
   href="http://www.example.com/provider.xml">

O atributo rel deve ser "search" e type deve ser "application/opensearchdescription+xml". O valor de title é exibido no menu suspenso da caixa Pesquisa Instantânea. O atributo href contém uma URL absoluta ou relativa que especifica o local do arquivo de descrição do OpenSearch.

Quando a página é carregada no Internet Explorer 8, a seta suspensa da caixa Pesquisa Instantânea fica laranja para indicar que novos provedores de pesquisa foram adicionados ao menu suspenso. Os três provedores de pesquisa detectáveis mais recentes são listados; eles devem ser instalados para que provedores adicionais possam ser incluídos na lista. Quando o usuário navega até outro domínio, os provedores de pesquisa descobertos anteriormente são removidos. Os usuários podem experimentar novos provedores antes de adicioná-los em suas listas. Quando um usuário decide instalar um provedor de pesquisa, a caixa de diálogo Adicionar Provedor de Pesquisa é exibida.

Oferecendo sugestões de pesquisa

Usando o formato de sugestões JSON
Usando o formato de sugestões XML
Oferecendo_sugestões_visuais
Tratamento_de_erros_de_resposta

A partir do Internet Explorer 8, a caixa Pesquisa Instantânea oferece suporte a sugestões de pesquisa. Com as sugestões de pesquisa, enquanto o usuário digita na caixa de pesquisa, o Internet Explorer 8 pode enviar solicitações ao seu provedor de pesquisa com a sequência de consulta atual e você pode fornecer sugestões que podem permitir que o usuário crie um termo de pesquisa melhor. O Internet Explorer 8 oferece suporte a dois formatos de sugestões de pesquisa: JSON e XML. O formato JSON habilita sugestões de pesquisa com base em texto que podem ser aumentadas com descrições e URL. O formato XML habilita todo o conteúdo disponível em sugestões JSON, além de suporte a sugestões visuais e títulos de seção. Mais detalhes sobre o formato de sugestões de pesquisa XML podem ser encontrados no artigo sobre especificação do formato de sugestões de pesquisa XML (a página pode estar em inglês).

Observação Esta seção aborda apenas a formatação de respostas de sugestões individuais. Para oferecer suporte completo a sugestões de pesquisa, você deve gerar essas sugestões e fornecer as sugestões corretas a cada solicitação. Considerando que essa parte de sugestões com suporte é exclusiva de cada provedor, ela não é abordada aqui.

Usando o formato de sugestões JSON

As sugestões de pesquisa JSON são retornadas como uma matriz de matrizes do Microsoft JScript. A matriz contém quatro valores:

Valor	Descrição
Query string (obrigatório)	O termo de pesquisa solicitado. Se o navegador tiver solicitado sugestões para "xbox", a sequência da consulta será "xbox". O retorno da sequência de consulta na matriz assegura que as sugestões retornadas sejam para o termo de pesquisa solicitado.
Completions array (obrigatório)	As sugestões para a sequência de consulta determinada.
Descriptions array (opcional)	Sequências alternativas que fornecem informações ou contexto adicionais sobre uma determinada conclusão.
Query URLs array (opcional)	Uma lista de URLs a serem usadas se o usuário selecionar uma determinada sugestão. Isso funciona como uma resposta instantânea ao termo de pesquisa levando o usuário à URL, em vez de para uma página de resultados de pesquisa.

Uma resposta JSON deve retornar a sequência de consulta e as sugestões de pesquisa na matriz de conclusões. O exemplo a seguir é uma resposta JSON simples na qual as descrições e as URLs de consulta são omitidas.

["xbox",
	["Xbox 360", "Xbox cheats", "Xbox 360 games"]]

Observação No máximo dez sugestões de pesquisa são exibidas de cada vez. A adição de descrições, visuais e seções limita o número de sugestões que pode ser fornecido. É importante enviar as sugestões mais relevantes no início da matriz de conclusões.

Para ajudar os usuários a criar termos de pesquisa melhores, as descrições podem ser oferecidas juntamente com as sugestões. Uma URL de consulta pode ser fornecida como uma forma de uma resposta instantânea. Quando uma URL de consulta é fornecida e o usuário clica nessa sugestão, o Internet Explorer 8 leva o usuário diretamente àquela URL de consulta, em vez de a uma página de resultados de pesquisa. O exemplo a seguir mostra uma resposta JSON detalhada.

["xbox",
	["Xbox 360", "Xbox cheats", "Xbox 360 games"], 
	["The official Xbox website from Microsoft", "Codes and walkthroughs", "Games and accessories"],	
	["https://www.xbox.com","http://www.example.com/xboxcheatcodes.aspx", "http://www.example.com/games"]]

Nessa resposta JSON, a primeira sugestão de pesquisa consiste nos seguintes elementos:

Primeiro elemento na primeira matriz ("Xbox 360")
Primeiro elemento na segunda matriz ("O site oficial do Xbox da Microsoft")
Primeiro elemento na terceira matriz ("https://www.xbox.com").

A resposta acima gera os seguintes resultados:

Sugestões de pesquisa JSON.
Figura 11. Sugestões de pesquisa JSON

Usando o formato de sugestões XML

A resposta JSON acima pode ser representada no formato de sugestões XML, conforme mostrado no exemplo a seguir. Esse exemplo contém a mesma resposta de sugestões das sugestões JSON acima e gera exatamente o mesmo resultado.

<?xml version="1.0"?>
<SearchSuggestion xmlns="https://schemas.microsoft.com/Search/2008/suggestions">
    <Query>xbox</Query>
    <Section>
	<Item>
		<Text>Xbox 360</Text>
		<Description>The official Xbox website from Microsoft</Description>
		<Url>http://www.xbox.com</Url>
	</Item>
	<Item>
		<Text>Xbox cheats</Text>
		<Description>Codes and walkthroughs</Description>
		<Url>http://www.example.com/xboxcheatcodes.aspx</Url>
	</Item>
	<Item>
		<Text>Xbox 360 games</Text>
		<Description>Games and accessories</Description>
		<Url>http://www.example.com/games</Url>
	</Item>
    </Section>
</SearchSuggestion>

O formato de sugestão JSON não permite que títulos de seção sejam especificados no menu de sugestão. No Internet Explorer 8, o título de seção será o nome de seu provedor de pesquisa mais a palavra "Sugestões". Por exemplo, se o nome de seu provedor de pesquisa for "Pesquisas de João", suas sugestões serão intituladas "Sugestões de Pesquisas de João". No exemplo a seguir, o nome do provedor de pesquisa é "Minha Pesquisa Personalizada" e o título é exibido como "Sugestões de Minha Pesquisa Personalizada". Se você desejar organizar suas sugestões em várias seções, use o formato de sugestões XML. Além de títulos de seção, o formato de sugestões XML oferece suporte a sugestões visuais. Mais detalhes sobre o formato de sugestões de pesquisa XML podem ser encontrados no artigo sobre especificação do formato de sugestões de pesquisa XML (a página pode estar em inglês).

As sugestões de pesquisa XML oferecem suporte aos mesmos recursos das sugestões de pesquisa JSON e a recursos adicionais que não estão disponíveis no formato JSON. Esses recursos adicionais incluem o seguinte:

Personalizar o título da seção de sugestões.
Dividir sugestões entre vários separadores de seção.
Incluir sugestões visuais.

Para personalizar títulos de seção, você pode adicionar um atributo "title" ao elemento Section ou adicionar um Separador. Os separadores podem ou não ter um título. O exemplo a seguir adiciona um separador "Minhas Sugestões de Texto" e outro separador sem um título.

<?xml version="1.0"?>
<SearchSuggestion xmlns="https://schemas.microsoft.com/Search/2008/suggestions">
    <Query>xbox</Query>
    <Section>
	<Separator title="My Text Suggestions"/>
	<Item>
		<Text>Xbox 360</Text>
		<Description>The official Xbox website from Microsoft</Description>
 		<Url>http://www.xbox.com</Url>
	</Item>
	<Item>
		<Text>Xbox cheats</Text>
		<Description>Codes and walkthroughs</Description>
		<Url>http://www.example.com/xboxcheatcodes.aspx</Url>
	</Item>
	<Item>
		<Text>Xbox 360 games</Text>
		<Description>Games and accessories</Description>
		<Url>http://www.example.com/games</Url>
	</Item>
	<Separator />
	<Item>
		<Text>xbox 360 lowest price</Text>
	</Item>
	<Item>
		<Text>xbox 360 news</Text>
	</Item>
    </Section>
</SearchSuggestion>

O código acima gera o seguinte resultado.

Figura 12. Sugestões de pesquisa XML com título personalizado e separadores de seção

Oferecendo sugestões visuais

As sugestões de pesquisa geralmente consistem em sugestões de texto ou em termos relacionados que os usuários podem desejar pesquisar. No Internet Explorer 8, o conceito de uma sugestão de pesquisa foi expandido para incluir uma sequência de consulta, um link ou uma sugestão visual. Uma sugestão visual inclui uma imagem. O seu provedor de pesquisa pode fornecer uma imagem com texto ou apenas uma imagem como uma sugestão de pesquisa para o termo de pesquisa do usuário. Para adicionar uma sugestão visual à sua resposta, adicione um elemento Image no elemento Item dessa sugestão. Certifique-se também de especificar as dimensões de largura e altura da imagem. Por exemplo, para oferecer uma sugestão visual para o termo "Xbox", você pode retornar o seguinte:

 <Separator title="My Visual Suggestions" />
  <Item>
  	<Text>Xbox 360 Game Consoles</Text>
  	<Description>Game console systems and packages at a great deal.</Description>
  	<Image source="http://www.example.com/xboxconsole.jpg" alt="Xbox 360 Consoles" width="75" height="75"/> 
  	<Url>http://www.example.com/</Url>
  </Item>
  <Item>
  	<Text>Xbox 360 Wireless Controller</Text> 
  	<Image source="http://www.example.com/xboxcontroller.jpg" alt="Xbox 360 Wireless Controller" width="75" height="75"/> 
  </Item>
  <Item>
  	<Text>Xbox 360 Live Games</Text> 
  	<Image source="http://www.example.com/live.jpg" alt="Xbox 360 Live Games" width="75" height="75"/> 
  	<Url>http://www.example.com/games.aspx?q="Xbox 360"</Url> 
  </Item>

O código acima gera os seguintes resultados.

Sugestões visuais para Xbox.
Figura 13. Sugestões visuais para Xbox

Esse exemplo fornece uma URL com duas das sugestões. O Internet Explorer 8 leva o usuário diretamente à página especificada pela URL. Se a URL não for fornecida, o valor do elemento Text ("Controlador sem fio do Xbox 360") será usado como o termo de pesquisa. Se desejar fornecer uma sugestão visual sem texto ou descrição, você deverá fornecer uma URL para que o Internet Explorer 8 saiba para onde enviar o usuário.

Por padrão, se você incluir texto com uma imagem, o texto será centralizado verticalmente ao lado da imagem. Ao definir o valor do atributo align como "top", "middle" ou "bottom", você poderá especificar o alinhamento do texto do elemento Text e do elemento Description relativo à imagem.

Para alinhar seu texto, adicione o atributo align à seu elemento image. O exemplo a seguir define o atributo align como "top".

<Image source="http://www.example.com/xboxconsole.jpg" alt="Xbox 360 Consoles" width="75" height="75" align="top"/>

Tratamento de erros de resposta

Quando fornece sugestões de pesquisa, podem haver termos para os quais você talvez não tenha nenhuma sugestão ou talvez não seja possível reconhecer o termo de pesquisa. Nesse caso, você ainda deve retornar uma resposta XML válida; caso contrário, os seus usuários receberão uma mensagem informando que ocorreu um erro. Para evitar essa mensagem, envie uma resposta XML válida quando você não tiver nenhuma sugestão para o termo de pesquisa. O trecho de código a seguir envia uma resposta sem nenhuma sugestão para o termo de pesquisa xbox. Essa resposta mostrará uma mensagem informando que não há resultados.

<?xml version="1.0"?>
<SearchSuggestion xmlns="https://schemas.microsoft.com/Search/2008/suggestions">
    <Query>xbox</Query>
</SearchSuggestion>

Para uma resposta JSON, retorne o seguinte:

 ["xbox"]

Além de não ter nenhuma sugestão para um termo de pesquisa, é possível ter casos em que você sabe que a sugestão existe, mas continua recebendo a mensagem de erro. Nesse caso, verifique a solicitação de codificação. Por padrão, os termos de pesquisa são codificados usando UTF-8 no método de solicitação HTTP GET. Isso significa que se o usuário digitar qualquer caractere acentuado, os caracteres serão codificados em um ASCII (texto) equivalente. Por exemplo, se o seu termo de pesquisa for café, o termo enviado a você será q=caf%c3%a9, onde o caractere "é" acentuado é codificado em um ASCII equivalente de %c3%a9.

Observação Os provedores de pesquisa devem usar o método de solicitação HTTP GET; o método de solicitação POST não tem suporte.

Você deve incluir a altura e a largura de sua imagem quando fornecer uma sugestão visual. Se você não incluir esses valores, o Internet Explorer 8 alocará um espaço padrão para a imagem e dimensionará a imagem para se ajustar dentro desse espaço. Nesse caso, a quantidade de espaço padrão é o equivalente vertical de uma linha de texto.

A caixa Pesquisa Instantânea pode ser redimensionada e, por isso, as dimensões do menu suspenso de sugestões de pesquisa podem variar. Para descobrir as dimensões do menu de sugestões de pesquisa, você pode adicionar parâmetros à URL de descrição do OpenSearch que retornem o tamanho do menu suspenso de sugestões de pesquisa. Os parâmetros disponíveis incluem o seguinte.

Parâmetro	Descrição
{maxWidth}	A largura do menu suspenso, em pixels.
{sectionHeight}	A altura de toda a seção de sugestões.
{rowHeight}	A altura de uma única linha de texto, que é equivalente a uma linha de texto.

O exemplo a seguir mostra esses parâmetros adicionados à URL do arquivo de descrição do OpenSearch.

<Url type="application/x-suggestions+xml" 
	template="http://suggestions.example.com/search.aspx?q={searchTerms}&amp;
	maxwidth={maxWidth}&amp;rowheight={rowHeight}&amp;sectionHeight={sectionHeight}" 
/>

A imagem a seguir identifica a área de cada parâmetro.

Figura 14. Parâmetros do menu de sugestões de pesquisa

Identificando referenciadores de pesquisa

Desde o Internet Explorer 7, é oferecido suporte à extensão de referenciador do OpenSearch Link da World Wide Web . Quando o usuário inicia uma pesquisa, o Internet Explorer adiciona um atributo de referenciador à consulta de pesquisa que indica se a pesquisa foi iniciada pela caixa Pesquisa Instantânea ou pela Barra de endereços. Se a pesquisa tiver sido iniciada pela caixa Pesquisa Instantânea, o atributo de referenciador será definido como IE-SearchBox. Se a pesquisa tiver sido iniciada pela Barra de endereços, por meio de um favorito ou por digitação direta, o atributo de referenciador será definido como IE-Address.

Localizando sugestões de pesquisa

Se você fornecer os seus serviços em vários idiomas, poderá determinar quais sugestões localizadas enviar adicionando o atributo "{Language}" em sua sequência de consulta. O exemplo a seguir mostra como receber informações de idioma do usuário a fim de fornecer solicitações localizadas:

<Url type="application/x-suggestions+xml" 
	template="http://suggestions.example.com/search.aspx?
	q={searchTerms}&amp;language={Language}" 
/>

Quando o Internet Explorer solicitar sugestões, "{Language}" será substituído pelo idioma aceito pelo Internet Explorer, que é definido de acordo com a localidade do sistema do usuário. A localidade do sistema do usuário pode ser definida no Painel de Controle e nas configurações de idioma do Internet Explorer, na caixa de diálogo Opções da Internet.

Observação Consulte a seção "Tratamento de erros de resposta" acima para obter mais informações sobre a codificação de caracteres que pode afetar suas respostas de localidade.

Comentários

Lembre-se sempre das diretrizes a seguir.

Um site não pode iniciar automaticamente a caixa de diálogo Adicionar Provedor de Pesquisa. Ela é bloqueada da mesma maneira que um bloqueador de pop-ups bloqueia sites e só pode ser iniciada como o resultado direto da ação de um usuário.
Os títulos devem ser curtos; o ideal é que eles tenham até 16 caracteres. Essa sequência é usada pela caixa Pesquisa Instantânea. Se o título for maior do que a caixa de pesquisa, ele poderá ser cortado.
O título na marca de link deve ser o mesmo título usado pelo arquivo de descrição XML. Essas cadeias de caracteres devem ser correspondentes para que a detecção de pesquisa reconheça que um provedor foi instalado a fim de que a seta suspensa da caixa Pesquisa Instantânea não fique laranja ou um provedor instalado não se inclua na lista de provedores descobertos.
Quando um usuário restaura as configurações padrão do Internet Explorer, todos os provedores de pesquisa personalizados são removidos.
Se estiver usando scripts para adicionar um provedor, talvez você também queira chamar o método auxiliar IsSearchProviderInstalled para verificar se o seu provedor já foi instalado.
Ao criar arquivos de descrição, certifique-se de que o arquivo seja de sintaxe XML válida, todos os caracteres em suas cadeias de caracteres estejam codificados e que todos os caracteres "&" tenham sido alterados para "&".
Como os usuários podem redimensionar a caixa Pesquisa Instantânea, você pode consultar o Internet Explorer 8 para retornar as dimensões da caixa suspensa de sugestões de pesquisa adicionando parâmetros na URL de seu arquivo de descrição XML.

Tópicos relacionados

Especificação do formato de sugestões de pesquisa XML (a página pode estar em inglês)
AddSearchProvider
IsSearchProviderInstalled (a página pode estar em inglês)
Guia do Windows Search
Descrição do OpenSearch (a página pode estar em inglês)

Compartilhar via