Publicação do seu gadget

Este documento descreve as diferentes opções de publicação do seu gadget. Se você usa o Editor de gadgets do Google (GGE) para criar e hospedar gadgets, a publicação dos seus gadgets ficará muito mais fácil.

Sumário

  1. Onde posso colocar meu gadget?
  2. Preparação para a publicação
    1. Teste de largura e altura
    2. Aperfeiçoamento do desempenho do gadget
  3. Publicação no diretório de conteúdo do iGoogle
    1. Gerenciamento dos gadgets enviados

Onde posso colocar meu gadget?

Você pode colocar seus gadgets em qualquer um dos seguintes lugares:

  • Em recipientes do OpenSocial que suportam gadgets, como a sandbox do iGoogle e orkut.
  • No Diretório de conteúdo do Google (apenas gadgets antigos). Se você enviar seu gadget ao diretório de conteúdo, ele ficará disponível para um público maior.

Nem todo gadget é adequado a todos os ambientes. Consulte a documentação do seu recipiente para saber detalhes sobre quais recursos são suportados nesse ambiente.

Preparação para a publicação

Você deve testar seu gadget antes de publicá-lo, levando em consideração os requisitos e limitações do ambiente no qual o gadget será executado.

Faça os testes abaixo para todos os gadgets:

  • Tente todas as combinações de valores de UserPref.
  • Execute-o em telas de tamanhos diferentes, desde 800x600 até a maior largura possível. Vincule à extensão de desenvolvedor da web do Firefox, o que facilita o redimensionamento do Firefox para um tamanho específico.
  • Teste seu gadget em diferentes tamanhos, conforme descrito na seção Teste de largura e altura.
  • Teste seu gadget em todos os ambientes onde possa ser executado.
  • Teste seu gadget nos navegadores IE 7, IE 6, Firefox 2.x, Firefox 1.5.x, IE 7, IE 6, Opera 9.x e Safari 2.x.
  • Experimente tamanhos de fonte diferentes:
    • Para alterar o tamanho da fonte no Firefox, selecione Ferramentas > Opções > Conteúdo. Clique em Avançado na seção "Fontes e cores". Altere a configuração de fonte e desmarque ''Páginas podem usar outras fontes".
    • Para alterar o tamanho da fonte no Internet Explorer, selecione Ferramentas > Opções da Internet > Geral. Use as caixas de diálogo Fontes e Acessibilidade para alterar sua configuração de fontes.

Se estiver usando makeRequest(), verifique o que acontece se a fonte de dados estiver inacessível ou retornar um erro. Você pode simular isso alterando o URL temporariamente.

Teste de largura e altura

O dimensionamento de um gadget depende principalmente de onde ele será executado. Consulte a documentação do seu recipiente para obter mais detalhes.

Ao criar e testar seus gadgets, prepare-se para larguras arbitrárias que podem variar de 200 a até mesmo 600 pixels. A largura deve ser ainda maior em determinados gadgets. Como regra geral, crie o gadget para ser exibido adequadamente caso haja mais espaço. Por exemplo, os gadgets de mapas devem preencher suas áreas, os gadgets de imagem devem ficar centralizados no frame e os gadgets de texto devem manter o texto no alto (por exemplo, links do tipo "clique para obter mais detalhes", que normalmente são na parte inferior da página, devem permanecer próximos ao conteúdo, em vez de serem colocados na parte inferior da janela do gadget).

Aperfeiçoamento do desempenho do gadget

Se ao criar um gadget você espera causar tráfego intenso, há etapas que podem ser seguidas para assegurar disponibilidade e um bom desempenho. Procure seguir as dicas desta seção caso seu gadget tenha mais de 200.000 visualizações por dia ou aproximadamente 1 a 2 solicitações por segundo. Mesmo um gadget de 50 KB recebendo 200.000 solicitações por dia consome cerca de 300 GB de largura de banda por mês.

Há motivos diferentes que podem tornar um gadget atraente para muitos usuários. Ele pode simplesmente tornar-se popular no diretório de conteúdo. Ou ainda, ser usado em uma promoção especial ou em publicidade, o que pode causar um excesso de tráfego.

No caso de um gadget de tráfego intenso, sua meta deve ser exibi-lo em 0,25 s (250 milissegundos) ou menos. Use o Firebug (somente Firefox) para calcular o tempo. Uma excelente maneira de ter impacto positivo sobre a experiência do usuário é melhorar a capacidade de resposta do seu gadget. Consulte Otimização para tráfego intenso para obter dicas sobre como otimizar o desempenho do gadget. Para obter dicas sobre gerenciamento, consulte Gerenciamento de tráfego intenso. As orientações gerais de teste também são especialmente importantes para gadgets muito populares.

Otimização para tráfego intenso

Se você acha que seu gadget poderá causar tráfego intenso, siga as orientações abaixo:

  • Evite usar arquivos JavaScript ou CSS externos (arquivos que contêm atributos ''src'' ou ''href'' nas tags HTML), pois isso requer o uso de outra conexão de rede. Em vez disso, coloque seu código JavaScript e CSS dentro das especificações do gadget.
  • Use um gadget type=html. Os gadgets type=url geralmente são exibidos mais lentamente que os gadgets type=html, devido ao desempenho e suporte a cache ruins de outros servidores de hospedagem.
  • Por padrão, o método makeRequest() armazena o conteúdo em cache por aproximadamente 1 a 2 horas. Você pode usar o parâmetro refreshInterval com essas funções para atualizar o cache com mais freqüência. Entretanto, o uso de cache melhora o desempenho do gadget, minimizando o número de solicitações enviadas aos servidores remotos que hospedam o conteúdo. Não solicite um número de atualizações de cache maior que o necessário, pois você reduzirá a porcentagem de solicitações suportadas pelo cache. Para uma discussão mais profunda sobre este tópico, consulte Atualização do cache.
  • Use o Firebug (somente Firefox) para ajustar o desempenho do seu gadget. Para outros navegadores, use o Fiddler.
  • Se possível, evite usar o Google Analytics, pois ele requer uma conexão adicional ao servidor. Em vez do Analytics, use http://www.google.com/ig/directory?url=<gadget-url> para verificar o total semanal de visualizações de página do seu gadget.
  • Especifique a altura e a largura de todas as tags <img> no HTML do gadget. Isso agiliza a exibição do gadget. Se você estiver usando gadgets.io.getProxyUrl() e inserindo o elemento imagem diretamente no DOM, não é necessário definir as propriedades de largura e altura.
  • Em vez de conectar-se diretamente ao seu provedor de hospedagem, use a função gadgets.io.getProxyUrl() para armazenar todas as imagens incorporadas em cache e a função embedCachedFlash() para armazenar o conteúdo Flash em cache. Veja abaixo um exemplo de gadget que carrega as imagens previamente usando gadgets.io.getProxyUrl():

Aqui está um exemplo de gadget que ilustra como usar gadgets.io.getProxyUrl():

<?xml version="1.0" encoding="UTF-8" ?>
<Module>
  <ModulePrefs title="Zombies!" height="350" />
  <Content type="html">
  <![CDATA[
  <div id="zombiecontainer"
    style="text-align:center;">
  </div>
  <script type="text/javascript">
  var counter = 0;

  // Preload the images using gadgets.io.getProxyUrl()
  function load(imageList) {
    var ret = [];
    for (var i = 0, j = imageList.length; i < j; ++i) {
      var img = document.createElement("img");
      img.src = gadgets.io.getProxyUrl(imageList[i]);
      ret.push(img);
    }
    return ret;
  }

  var files = [
    "http://gadget-doc-examples.googlecode.com/svn/trunk/zombie-0.jpg",
    "http://gadget-doc-examples.googlecode.com/svn/trunk/zombie-1.jpg",
    "http://gadget-doc-examples.googlecode.com/svn/trunk/zombie-2.jpg",
    "http://gadget-doc-examples.googlecode.com/svn/trunk/zombie-3.jpg",
    "http://gadget-doc-examples.googlecode.com/svn/trunk/zombie-4.jpg",
    "http://gadget-doc-examples.googlecode.com/svn/trunk/zombie-5.jpg",
    "http://gadget-doc-examples.googlecode.com/svn/trunk/zombie-6.jpg"
  ];

  var images = load(files);
  browse();

  // Browse through photos sequentially. When you get to the end of the array, start over.
  function browse(){
    if (counter == images.length)
    {
      counter = 0;
    }
    document.getElementById("zombiecontainer").innerHTML = "";
    document.getElementById("zombiecontainer").appendChild(images[counter]);
    counter++;
  }

  </script>
  <br />
  <div style="text-align: center;">
    <input type=submit value="Next ->" onClick="browse()">
  </div>
  ]]>
  </Content>
</Module>

Gerenciamento de tráfego intenso

Estas orientações podem ajudá-lo a gerenciar um gadget de alto volume de tráfego:

  • Se estiver recebendo uma grande quantidade de e-mails dos usuários do seu gadget, use o Gmail para configurar filtros e gerenciar o volume. Recomendamos o uso de um endereço no formato <username>.feedback+<gadgetname>@gmail.com na especificação do seu gadget. Isso ajuda a filtrar as mensagens recebidas dos usuários do gadget. O Gmail ignora tudo o que está depois do sinal de mais (+), fazendo com que o endereço de e-mail seja mapeado para <username>.feedback@gmail.com. O Gmail tem um filtro de spams de alta qualidade.
  • Se você enviar seu gadget ao diretório de conteúdo do iGoogle, visite periodicamente a página de descrição do seu gadget para ler os comentários dos usuários. Freqüentemente, os usuários deixam um feedback valioso, fazem solicitações e relatam bugs que encontraram ao usar o gadget. É bom ficar a par de seus comentários e manter contato com eles.

Publicação no diretório de conteúdo do iGoogle

Depois de criar, implementar e testar seu gadget, você pode enviá-lo ao Google para ser publicado no diretório de conteúdo do iGoogle. No momento, esta opção se aplica apenas aos gadgets antigos. Esta seção lista as etapas gerais que você deve seguir ao preparar seu gadget para publicação.

Etapa 1: Defina as preferências do seu gadget.

A Referência lista todos os atributos <ModulePrefs> que podem ser usados para fornecer informações ''meta'' sobre seu gadget. Aqui estão as informações que você deve incluir na especificação do seu gadget:

  • title
  • description. Este atributo é importante para que as pessoas saibam o que seu gadget faz, particularmente se isso não for óbvio.
  • author
  • author_email. Use esse atributo para que o Google e os usuários possam entrar em contato com você. Você pode usar qualquer sistema de e-mail. Evite usar um endereço de e-mail pessoal devido aos spams. Uma boa estratégia é usar um endereço de e-mail com o formato helensmith.feedback+coolgadget@gmail.com na especificação do seu gadget. O Gmail ignora tudo o que está depois do sinal de mais (+), fazendo com que o endereço de e-mail seja mapeado para helensmith.feedback@gmail.com. Crie uma conta do Gmail aqui.
  • screenshot. Esta é uma string que fornece o URL de uma captura de tela do gadget. O URL deve ser bem formado, e não relativo. Esta imagem deve estar em um site público da web não bloqueado por robots.txt. O formato preferido é PNG, embora os formatos GIF e JPG também sejam aceitáveis. As capturas de tela de gadgets devem ter 280 pixels de largura. A altura da captura de tela deve ser a altura ''natural'' do gadget quando em uso. Isso ajuda o usuário a identificar quanto espaço de sua tela será consumido pelo gadget antes de adicioná-lo à sua página. A captura de tela não deve ter nenhum espaço em branco acima da barra de cabeçalho azul do gadget. As capturas de tela devem mostrar apenas o gadget completo, incluindo sua barra de título. Como alternativa, faça uma captura de tela do gadget com a janela de edição aberta. Não redimensione ou corte as capturas de tela. Para manter a qualidade e a consistência, o Google pode fazer suas próprias capturas de tela relativas a um gadget específico.
  • thumbnail. No diretório de conteúdo, as miniaturas permitem que os usuários possam visualizar um gadget. Elas devem captar a funcionalidade principal do gadget sem mostrá-lo totalmente. O valor deste atributo é uma string que fornece o URL da miniatura de um gadget. O URL deve ser bem formado, e não relativo. Esta imagem deve estar em um site público da web não bloqueado por robots.txt. O formato preferido é PNG, embora os formatos GIF e JPG também sejam aceitáveis. As miniaturas devem medir 120x60 pixels. Elas não devem incluir a barra de título.
  • author_location
  • author_affiliation
  • title_url. Use este atributo para vincular o título do seu gadget a uma página HTML externa. Por exemplo, se o gadget for o front end de um serviço, vincule o título do gadget ao site do serviço.
  • directory_title (obrigatório se o título tiver variáveis de substituição de preferências do usuário).

Se você deseja ser incluído na página de autores, adicione estes campos:

  • author_photo. URL para uma foto (o formato preferido é 70x100 PNG, mas JPG/GIF também são suportados).
  • author_aboutme. Um texto sobre si mesmo (tente limitar em aproximadamente 500 caracteres).
  • author_link. Um link para o seu site, blog, etc.
  • author_quote. Uma citação que você queira incluir (tente limitar em aproximadamente 300 caracteres).

Encontre mais informações aqui e um exemplo aqui.

Etapa 2: Verifique se criou um gadget robusto e seguro.

Verifique se codificou seu gadget de maneira a minimizar os riscos de segurança.

Etapa 3: Adicione todas as informações relevantes sobre local.

Você pode usar as tags <Locale> em <ModulePrefs> para especificar os locais suportados pelo seu gadget. Para obter mais informações, consulte ModulePrefs/Locale na referência de XML.

Etapa 4: Facilite o processo de adição do seu gadget.

Para promover o gadget, coloque nele um botão "Adicionar ao Google".

Etapa 5: Envie o gadget ao Google.

Você pode enviar seu gadget ao Google aqui. Você também pode enviar seu gadget ao diretório de conteúdo, clicando em GGE e usando o comando File > Publish (Arquivo > Publicar). Consulte as Perguntas freqüentes para obter uma explicação sobre como encontrar seu gadget no diretório e o que determina sua posição.

Gerenciamento dos gadgets enviados

Caso tenha enviado diversas versões de um gadget em URLs diferentes e queira designar uma versão como a oficial, você pode usar o Issue Tracker do iGoogle para solicitar a alteração.

Voltar ao início