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 integran de forma nativa con 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 que esté disponible para usuarios de todo el mundo. Entre los beneficios para tu organización, se incluyen los siguientes:

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

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

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

Crea tu plantilla

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

Condiciones del Servicio

Cada vez que se envíe una nueva plantilla, se deben 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, 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 debajo de la pestaña Información etiquetada como "Aceptar las Condiciones del Servicio de la Galería de Plantillas de la Comunidad".

Exporta tu plantilla

Una vez que completes la plantilla, export el archivo a tu máquina local y cámbiale el nombre 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 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 debe ser solo Apache 2.0.
4. Agrega un archivo README.md (opcional, pero recomendado).

Nota: Usa el repositorio de plantillas de ejemplo en GitHub como modelo. Copia el archivo LICENSE de la plantilla de ejemplo en tu proyecto para asegurarte de que no haya errores en el contenido y actualiza la línea de derechos de autor donde dice “Copyright [yyyy] [name of copyright owner]”. en la versión de muestra. Reemplaza yyyy por el año de los derechos de autor y [name of copyright owner] por el nombre del propietario de los derechos de autor.

Agregar categorías a template.tpl

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

Nota: Los valores de la entrada categories deben tener el formato de un array.

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 del contenido
HEAT_MAP	Mapas de calor
LEAD_GENERATION	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 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 de 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 de SHA. Una manera fácil de obtener el número de SHA en GitHub es ir a una vista de confirmación y hacer clic en el ícono del portapapeles (). Esta acción copiará el número SHA completo en el portapapeles. Pega ese número como el valor de tu entrada de 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 contenidos en esta nueva versión.

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

Importante: sha y changeNotes deben estar alineados como se muestra en el ejemplo de código anterior.

Nota: El valor sha debe hacer referencia al archivo template.tpl específico que deseas publicar. No olvides actualizar este valor correctamente con cada versión nueva.

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 describió 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 debe tener solo 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 eliminará de la galería.

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

Envía tu plantilla

Una vez que tu repositorio de plantillas esté alojado en GitHub, puedes proceder a 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 proporcionado y haz clic en Enviar.

Actualiza tu plantilla

Una vez que hayas publicado una plantilla, es posible que quieras actualizarla periódicamente. Los usuarios de tu plantilla recibirán una notificación si hay una actualización en 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 de 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 manera fácil de hacerlo es en GitHub. Para ello, ve a una vista de confirmación y haz clic en el ícono del portapapeles (). Esta acción copiará el número 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 siguiente ejemplo).
3. Se agregó changeNotes para describir brevemente los cambios contenidos en esta nueva versión. Si lo deseas, puedes crear comentarios de varias líneas. (Consulta el siguiente ejemplo).
4. Confirma el cambio en metadata.yaml y tu 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, incluido el número de SHA y las notas de cambios:

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: Todas las versiones publicadas de la plantilla deben incluirse en la sección versions en orden cronológico inverso (de la más reciente a la más antigua).

Nota: No todas las confirmaciones incrementales deben incluirse como un cambio de versión en la Galería de plantillas de la comunidad. Por ejemplo, si realizas cambios incrementales en las confirmaciones 1, 2 y 3, y la versión final es la confirmación 4, deberías tener solo una entrada para la confirmación 4 que incluya todos los cambios de las confirmaciones 1, 2 y 3.