Cómo enviar una plantilla a la Galería de plantillas de la comunidad

La Galería de plantillas de la comunidad de Google Tag Manager permite que su organización cree y administre plantillas de etiquetas y variables que se integran de forma nativa en Google Tag Manager. Tu organización puede crear una plantilla, publicar el repositorio de plantillas en GitHub y, luego, enviarla a la Galería de plantillas de la comunidad para ponerla a disposición de usuarios de todo el mundo. Los beneficios para tu organización incluyen lo siguiente:

  • Sus clientes podrán agregar y usar sus plantillas fácilmente.
  • Los usuarios de Tag Manager estarán expuestos a la marca de tu organización.
  • Sus clientes podrán implementar sus etiquetas en cuestión de minutos, no de meses.
  • Puede publicar actualizaciones en sus plantillas y hacer que estén disponibles automáticamente para sus clientes.

El proceso para enviar una nueva plantilla a la galería de la plantilla de la comunidad implica los siguientes pasos principales:

  1. Cree su plantilla
  2. Prepara los archivos de tu proyecto
  3. Sube tus archivos a GitHub
  4. Cómo enviar su plantilla

Cree su plantilla

Para comenzar, cree su plantilla en Google Tag Manager como una plantilla personalizada. Asegúrate de que tu plantilla se haya probado exhaustivamente, de que su contenido cumpla con la Guía de estilo y de tener un plan o proceso implementado para saber cómo mantener y actualizar tu plantilla en caso de que necesites hacerlo en el futuro.

Condiciones del Servicio

Cada plantilla nueva que envíes debe aceptar las Condiciones del servicio de la Galería de plantillas de la comunidad de Google Tag Manager. Para confirmar que aceptas las Condiciones del Servicio de tu plantilla, sigue estos pasos:

  1. Consulte las Condiciones del Servicio de la Galería de plantillas de la comunidad de Google Tag Manager.
  2. En el editor de plantillas, abre tu plantilla para editarla y marca la casilla debajo de la pestaña Información con la etiqueta "Aceptar las Condiciones del Servicio de la Galería de plantillas de la comunidad".

Exporta tu plantilla

Una vez que su plantilla esté completa, exporte el archivo de plantilla a su máquina local y cambie el nombre del archivo template.tpl.

Prepara los archivos de tu proyecto

El siguiente paso es preparar tu repositorio para publicarlo en GitHub. Cada repositorio debe contener los siguientes archivos:

  1. Un archivo de plantilla exportado llamado template.tpl Este archivo debe actualizarse para agregar una entrada categories.
  2. Un archivo metadata.yaml
  3. Un archivo LICENSE El nombre del archivo debe estar en MAYÚSCULAS y el contenido del archivo de licencia solo debe ser Apache 2.0.
  4. Agrega un archivo README.md (opcional, pero recomendado).

Agregar categorías a template.tpl

Actualiza el archivo template.tpl con una entrada categories a la sección INFO y proporciona al menos un valor de categoría relevante seleccionado de la siguiente tabla. Si corresponde más de una categoría, puede proporcionar hasta tres valores de categoría, ordenados de la más relevante a la menos relevante.

Ejemplo:

___INFO___

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

Tabla de valores de categoría admitidos:

Categoría Descripción
PUBLICIDAD Publicidad
AFFILIATE_MARKETING Marketing de afiliación
ANALYTICS Shorts
ATRIBUCIÓN Atribución
CHAT Chat
CONVERSIONES Medición de conversiones
ALMACENAMIENTO DE DATOS Almacenamiento de datos
CORREO ELECTRÓNICO DE MARKETING Marketing por correo electrónico
EXPERIMENTACIÓN Experimentos A/B y optimización de contenido
MAPA CALOR Mapas de calor
GENERACIÓN DE CLIENTES POTENCIALES Generación de clientes potenciales
MARKETING Marketing
PERSONALIZACIÓN Personalización
REMARKETING Remarketing
PROMOCIONES Ventas y CRM
SESSION_RECORDING Grabaciones de sesiones
REDES SOCIALES Social
ENCUESTA Encuestas
TAG_MANAGEMENT Sistemas de administración de etiquetas
UTILIDAD Utilidades del Administrador de etiquetas de Google

metadatos.yaml

El archivo metadata.yaml contiene información sobre tu plantilla, incluidos vínculos a la página principal de tu organización, la documentación de la plantilla y la información de la versión. Cada versión se indica con un número de cambio, también conocido como número SHA, que es el número de cambio asociado con la confirmación de Git. El campo changeNotes es opcional, pero se recomienda para informar a los usuarios sobre los cambios incluidos en la versión.

Para configurar el archivo metadata.yaml, haz lo siguiente:

  1. Agrega una entrada homepage. Debe ser una URL que dirija a la página principal de tu organización.
  2. Agrega una entrada para documentation. Debe ser una URL que dirija a la documentación de tu plantilla.
  3. En GitHub, busca la confirmación que incluya los cambios que deseas enviar para tu versión inicial de la plantilla y copia el número SHA. Una forma fácil de obtener el número SHA en GitHub es ir a una vista de confirmación y hacer clic en el ícono del portapapeles (ícono del portapapeles). Esto copiará el número SHA completo en tu portapapeles. Pega ese número como valor para la entrada sha como elemento secundario del nodo versions, como se muestra a continuación.
  4. Agrega una entrada changeNotes al nodo versions para describir brevemente los cambios incluidos en esta versión nueva.
homepage: "https://www.example.com"
documentation: "https://www.example.com/documentation"
versions:
  - sha: 5f02a788b90ae804f86b04aa24af8937e567874a
    changeNotes: Initial release.

Subir a GitHub

El siguiente paso es subir tus archivos a GitHub. Crea un repositorio de GitHub con los archivos y la estructura adecuados como se describe anteriormente.

Los repositorios de plantillas deben tener los archivos * template.tpl, metadata.yaml y LICENSE en el nivel raíz del repositorio de Git. Cada repositorio de Git debe tener solo un archivo template.tpl. Todos los recursos deben estar en la rama principal de tu repositorio de GitHub. Se quitará de la galería cualquier repositorio de plantillas que no coincida con esta estructura.

Cada entrada de la Galería de plantillas de la comunidad se vinculará a la sección Problemas del repositorio de GitHub de la plantilla para que los usuarios puedan avisarte si encuentran un error. Asegúrate de que no se hayan inhabilitado los problemas para el repositorio de GitHub de tu plantilla a fin de que puedas revisar y solucionar cualquier problema que surja.

Envía tu plantilla

Una vez que tu repositorio de plantillas esté alojado en GitHub, podrás enviar tu plantilla a la galería de plantillas de la comunidad. Para enviar la plantilla, sigue estos pasos:

  1. Asegúrate de acceder a GitHub con una cuenta que tenga acceso al repositorio de plantillas que deseas agregar a la galería.
  2. Vaya a la Galería de plantillas de la comunidad en tagmanager.google.com/gallery.
  3. Haz clic en y selecciona Enviar plantilla.
  4. Proporciona la URL del repositorio en el campo proporcionado y haz clic en Enviar.

Actualizar la plantilla

Una vez que hayas publicado una plantilla, es posible que quieras actualizarla de vez en cuando. Los usuarios de su plantilla recibirán una notificación si se actualiza la plantilla y tendrán la opción de actualizarla a la versión más reciente.

El archivo metadata.yaml se usa para determinar qué versión de tu plantilla usar en la galería. Para publicar versiones nuevas, debes agregar el número de cambio (número SHA) a la sección versions del archivo metadata.yaml.

  1. Ubica la confirmación que incluye los cambios que deseas enviar y copia el número de SHA. Una forma fácil de hacerlo es en GitHub. Para ello, ve a una vista de confirmación y haz clic en el ícono del portapapeles (ícono del portapapeles). De esta forma, se copiará el número de SHA completo en el portapapeles.
  2. Agrega una nueva entrada de sha a la parte superior de tu lista de versions en metadata.yaml. (Consulta el ejemplo a continuación).
  3. Agrega changeNotes para describir brevemente los cambios que incluye esta versión nueva. Si lo deseas, puedes crear comentarios de varias líneas. (Consulta el ejemplo a continuación).
  4. Confirma el cambio en metadata.yaml y tu actualización aparecerá en la galería en un plazo aproximado de 2 a 3 días.

En este ejemplo, se muestra cómo agregar información de la versión nueva, incluido el número de SHA y las notas de cambio:

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.