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 tu organización cree y administre plantillas de etiquetas y variables que se integren de forma nativa con Google Tag Manager. Tu organización puede crear una plantilla, publicar el repositorio de plantillas en GitHub y, luego, enviar la plantilla a la Galería de plantillas de la comunidad para que esté disponible para los usuarios de todo el mundo. Estos son algunos de los beneficios para tu organización:

  • Tus clientes podrán agregar y usar tus plantillas con facilidad.
  • Los usuarios de Tag Manager estarán expuestos a la marca de tu organización.
  • Tus clientes podrán implementar tus etiquetas en minutos, no en meses.
  • Puedes publicar actualizaciones de tus plantillas y hacer que estén disponibles automáticamente para tus clientes.

El proceso para enviar una plantilla nueva a la Galería de plantillas de la comunidad incluye estos pasos principales:

  1. Crea tu plantilla.
  2. Prepara los archivos de tu proyecto.
  3. Sube tus archivos a GitHub.
  4. Envía tu plantilla.

Crea tu plantilla

Para comenzar, crea tu plantilla en Google Tag Manager como una plantilla personalizada. Asegúrate de que la plantilla se haya probado minuciosamente, que el contenido de la plantilla siga la Guía de estilo y que tengas un plan o proceso para mantener y actualizar la plantilla en caso de que sea necesario hacerlo en el futuro.

Condiciones del Servicio

Cada envío de plantilla nueva debe aceptar las Condiciones del Servicio de la Galería de plantillas de la comunidad de Google Tag Manager. Para confirmar la aceptación de las Condiciones del Servicio de tu plantilla, haz lo siguiente:

  1. Lee 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 de verificación en la pestaña Información con la etiqueta "Acepto las Condiciones del Servicio de la Galería de plantillas de la comunidad".

Exporta tu plantilla

Una vez que la plantilla esté completa, exporta el archivo de plantilla a tu máquina local y cambia el nombre del archivo a 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 se debe actualizar para agregar una categories entrada.
  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 debe ser solo Apache 2.0.
  4. Agrega un archivo README.md (opcional, pero recomendado).

Agrega categorías a template.tpl

Actualiza tu archivo template.tpl con una entrada categories en la sección INFO y proporciona al menos un valor de categoría pertinente seleccionado de la siguiente tabla. Si es adecuada más de una categoría, puedes proporcionar hasta tres valores de categoría, ordenados de más pertinente a menos pertinente.

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 Analytics
ATRIBUCIÓN Atribución
CHAT Chat
CONVERSIONES Medición de conversiones
DATA_WAREHOUSING Almacenamiento de datos
EMAIL_MARKETING Marketing por correo electrónico
EXPERIMENTACIÓN Experimentos A/B y optimización de contenido
HEAT_MAP Mapas de calor
LEAD_GENERATION Generación de clientes potenciales
MARKETING Marketing
PERSONALIZATION Personalización
REMARKETING Remarketing
PROMOCIONES Ventas y CRM
SESSION_RECORDING Grabaciones de sesiones
SOCIAL Social
ENCUESTA Encuestas
TAG_MANAGEMENT Sistemas de administración de etiquetas
INTERACTIVA Utilidades de Google Tag Manager

metadata.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 incluye los cambios que deseas enviar para la versión inicial de tu plantilla y copia el número SHA. Una forma sencilla de obtener el número SHA en GitHub es ir a una vista de confirmación y hacer clic en el ícono de portapapeles (Ícono de portapapeles). De esta manera, se copiará todo el número SHA en el portapapeles. Pega ese número como el valor de tu 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 que contiene esta versión nueva.
homepage: "https://www.example.com"
documentation: "https://www.example.com/documentation"
versions:
  - sha: 5f02a788b90ae804f86b04aa24af8937e567874a
    changeNotes: Initial release.

Sube archivos 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 indicó anteriormente.

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

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 informarte si encuentran un error.

Envía tu plantilla

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

  1. Asegúrate de haber accedido a GitHub con una cuenta que tenga acceso al repositorio de plantillas que deseas agregar a la Galería.
  2. Ve 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 que se muestra y haz clic en Enviar.

Actualiza tu plantilla

Después de publicar una plantilla, es posible que desees proporcionar actualizaciones de vez en cuando. Se notificará a los usuarios de tu plantilla si hay una actualización de 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 se usará en la galería. Para publicar versiones nuevas, debes agregar el número de cambio (número SHA) a la sección versions de tu archivo metadata.yaml.

  1. Busca la confirmación que incluye los cambios que deseas enviar y copia el número SHA. Una forma sencilla de hacerlo en GitHub es ir a una vista de confirmación y hacer clic en el ícono de portapapeles (Ícono de portapapeles). De esta manera, se copiará todo el número SHA en el portapapeles.
  2. Agrega una entrada sha nueva en la parte superior de la lista versions en metadata.yaml. (Consulta el siguiente ejemplo).
  3. Agrega changeNotes para describir brevemente los cambios que contiene esta versión nueva. Si lo deseas, puedes crear comentarios de varias líneas. (Consulta el siguiente ejemplo).
  4. Confirma el cambio en metadata.yaml, y la actualización aparecerá en la galería, por lo general, en un plazo de 2 a 3 días.

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

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.

Mueve tu repositorio

Si deseas cambiar los propietarios o los nombres de los repositorios, puedes usar el proceso de transferencia de repositorios de GitHub. Se detectará la nueva ubicación, y los usuarios se redireccionarán automáticamente al nuevo repositorio la próxima vez que actualicen la plantilla.

Quita tu plantilla

Para quitar una plantilla de la galería, borra el archivo LICENSE o el archivo metadata.yaml de su repositorio. El sistema de supervisión de la galería detectará este cambio y quitará automáticamente la plantilla.