Enviar um modelo para a Galeria de modelos da comunidade

Com a Galeria de modelos da comunidade do Gerenciador de tags do Google, sua organização pode criar e gerenciar modelos de tags e variáveis que se integram de forma nativa ao Gerenciador de tags. É possível criar um modelo, publicar o repositório de modelos no GitHub e, depois, enviar o modelo à Galeria de modelos da comunidade para disponibilizá-lo aos usuários de todo o mundo. Estes são alguns dos benefícios à sua organização:

• Os clientes poderão adicionar e usar os modelos com facilidade.
• Os usuários do Gerenciador de tags serão expostos à marca da sua organização.
• Os clientes poderão implantar suas tags em questão de minutos, e não meses.
• Você pode publicar atualizações nos modelos e disponibilizá-las automaticamente aos clientes.

O processo para enviar um novo modelo à Galeria de modelos da comunidade envolve estas etapas principais:

1. Criar um modelo
2. Preparar os arquivos do projeto
3. Fazer upload dos arquivos para o GitHub
4. Enviar um modelo

Criar um modelo

Para começar, crie seu modelo no Gerenciador de tags do Google como um modelo personalizado. Verifique se ele foi totalmente testado, se o conteúdo dele segue o Guia de estilo e se você tem um plano ou processo para manter e atualizar o modelo, caso isso seja necessário no futuro.

Termos de Serviço

A cada novo envio de modelo, é preciso concordar com os Termos de Serviço da Galeria de modelos da comunidade do Gerenciador de tags do Google. Para confirmar que você aceita os Termos de Serviço do seu modelo, faça o seguinte:

1. Leia os Termos de Serviço da Galeria de modelos da comunidade do Gerenciador de tags do Google.
2. No editor de modelos, abra seu modelo para edição e marque a caixa na guia Informações denominada Concordo com os Termos de Serviço da Galeria de modelos da comunidade.

Exportar um modelo

Quando terminar, exporte o modelo para sua máquina local e renomeie o arquivo template.tpl.

Preparar os arquivos do projeto

A próxima etapa é preparar seu repositório para publicação no GitHub. Cada repositório precisa conter os seguintes arquivos:

1. Um arquivo de modelo exportado denominado template.tpl. Você precisa atualizá-lo para adicionar uma entrada categories.
2. Um arquivo metadata.yaml.
3. Um arquivo LICENSE. O nome do arquivo precisa estar em LETRAS MAIÚSCULAS, e o conteúdo do arquivo de licença precisa estar apenas em Apache 2.0.
4. Adicione um arquivo README.md (opcional, mas recomendado).

Observação: use o repositório de modelo de amostra no GitHub como modelo. Copie o arquivo LICENSE do modelo de amostra no seu projeto para garantir que não há erros no conteúdo e atualize a seção "Copyright [yyyy] [name of copyright owner]" da linha de direitos autorais na versão de exemplo. Substitua yyyy pelo ano do copyright e [name of copyright owner] pelo nome do proprietário dos direitos autorais.

Adicionar categorias a template.tpl

Atualize seu arquivo template.tpl com uma entrada categories para a seção INFO e disponibilize pelo menos um valor de categoria relevante da tabela a seguir. Se mais de uma categoria for apropriada, você poderá informar até três valores, ordenados do mais relevante para o menos relevante.

Observação: os valores da entrada categories precisam ser formatados como uma matriz.

Exemplo:

___INFO___

{
  "displayName": "Example Template",
  "categories": ["AFFILIATE_MARKETING", "ADVERTISING"],
  // additional template properties, etc...
}

Tabela de valores de categoria compatíveis:

Categoria	Descrição
ADVERTISING	Publicidade
AFFILIATE_MARKETING	Marketing de afiliados
ANALYTICS	Análise
ATTRIBUTION	Atribuição
CHAT	Chat
CONVERSIONS	Avaliação de conversões
DATA_WAREHOUSING	Armazenamento de dados
EMAIL_MARKETING	Marketing por e-mail
EXPERIMENTATION	Experimentos A/B e otimização de conteúdo
HEAT_MAP	Mapas de calor
LEAD_GENERATION	Geração de leads
MARKETING	Marketing
PERSONALIZATION	Personalização
REMARKETING	Remarketing
SALES	Vendas e CRM
SESSION_RECORDING	Gravações da sessão
SOCIAL	Redes sociais
SURVEY	Pesquisas
TAG_MANAGEMENT	Sistemas de gerenciamento de tag
UTILITY	Utilitários do Gerenciador de tags do Google

metadata.yaml

O arquivo metadata.yaml contém informações sobre o modelo, incluindo links para a página inicial da sua organização, a documentação do modelo e as informações da versão. Cada versão é indicada por um número de alteração, também conhecido como número SHA, que é o número de mudança associado à confirmação do Git. O campo changeNotes é opcional, mas recomendado, para informar seus usuários sobre as alterações incluídas na versão.

Para configurar seu arquivo metadata.yaml, faça o seguinte:

1. Adicione uma entrada homepage. Ela precisa ser um URL que direcione para a página inicial da sua organização.
2. Inclua uma entrada em documentation. Precisa ser um URL que direcione para a documentação do seu modelo.
3. No GitHub, encontre a confirmação que inclui as alterações que você gostaria de enviar para a versão inicial do seu modelo e copie o número SHA. Uma maneira fácil de descobrir esse número no GitHub é acessar a visualização de uma confirmação e clicar no ícone da área de transferência (). Isso copiará todo o número SHA para a área de transferência. Cole esse número no valor da sua entrada sha como filho do nó versions, conforme mostrado abaixo.
4. Adicione uma entrada changeNotes ao nó versions para descrever brevemente as mudanças dessa nova versão.

homepage: "https://www.example.com"
documentation: "https://www.example.com/documentation"
versions:
  - sha: 5f02a788b90ae804f86b04aa24af8937e567874a
    changeNotes: Initial release.

Importante: sha e changeNotes precisam estar alinhados como ilustrado no código de exemplo acima.

Observação: o valor sha precisa fazer referência ao arquivo template.tpl específico que você quer publicar. Atualize esse valor corretamente a cada nova versão.

Fazer upload para o GitHub

A próxima etapa é fazer o upload dos seus arquivos para o GitHub. Crie um repositório do GitHub com os arquivos e a estrutura adequados, como descrito acima.

Os repositórios de modelos precisam ter os arquivos * template.tpl, metadata.yaml e LICENSE no nível raiz do repositório do Git. Cada Repositório Git pode ter apenas um arquivo template.tpl. Todos os recursos precisam estar na ramificação mestre no seu repositório do GitHub. Os repositórios de modelos que não corresponderem a essa estrutura serão removidos da Galeria.

Cada entrada na Galeria de modelos da comunidade levará à seção Problemas (link em inglês) do repositório do GitHub do modelo, para que os usuários possam informar bugs. Verifique se os problemas não foram desativados no repositório do GitHub do seu modelo para que você possa analisar e resolver as questões que surgirem.

Enviar um modelo

Quando seu repositório de modelos estiver hospedado no GitHub, você poderá enviar o modelo para a Galeria de modelos da comunidade. Para fazer isso, siga estas etapas:

1. Acesse o GitHub com uma conta que tenha acesso ao repositório de modelos que você quer adicionar à Galeria.
2. Acesse a Galeria de modelos da comunidade em tagmanager.google.com/gallery.
3. Clique em e selecione Enviar modelo.
4. Informe o URL do repositório no campo disponível e clique em Enviar.

Atualizar um modelo

Depois de publicar um modelo, é recomendável atualizá-lo periodicamente. Os usuários do modelo serão notificados se houver uma atualização e poderão atualizar o modelo para a versão mais recente.

O arquivo metadata.yaml é usado para determinar qual versão do seu modelo será usada na galeria. Para publicar novas versões, adicione o número de mudança (número SHA) à seção versions do arquivo metadata.yaml.

1. Localize a confirmação que inclui as alterações que você quer enviar e copie o número SHA. Uma maneira fácil de fazer isso no GitHub é acessar uma visualização de confirmação e clicar no ícone da área de transferência (). Assim, todo o número SHA será copiado para a área de transferência.
2. Adicione uma nova entrada sha à parte superior da sua lista versions em metadata.yaml, conforme o exemplo abaixo.
3. Insira changeNotes para descrever brevemente as alterações dessa nova versão. Se quiser, você pode criar comentários com várias linhas, conforme o exemplo abaixo.
4. Confirme a mudança em metadata.yaml, e sua atualização aparecerá na galeria em dois ou três dias.

Este exemplo demonstra como adicionar novas informações de versão, incluindo o número SHA, e alterar notas:

homepage: "https://www.example.com"
documentation: "https://www.example.com/documentation"
versions:
  # Latest version
  - sha: 5f02a788b90ae804f86b04aa24af8937e567874c
    changeNotes: |2
      Fix bug with the whatsamajig.
      Improve menu options.
      Update API calls.
  # Older versions
  - sha: 5f02a788b90ae804f86b04aa24af8937e567874b
    changeNotes: Adds eject button.
  - sha: 5f02a788b90ae804f86b04aa24af8937e567874a
    changeNotes: Initial release.

Importante: cada versão publicada do modelo precisa ser incluída na seção versions, em ordem cronológica reversa (da mais recente para a mais antiga).

Observação: nem toda confirmação incremental precisa ser incluída como uma mudança de versão na Galeria de modelos da comunidade. Por exemplo, se você fizer mudanças incrementais nas confirmações 1, 2 e 3, e a versão final for a confirmação 4, será preciso ter apenas uma entrada para a confirmação 4 que inclui todas as mudanças de 1, 2 e 3.