Envoyer un modèle à la galerie de modèles de la communauté

La galerie de modèles de la communauté Google Tag Manager permet à votre entreprise de créer et de gérer des modèles de balises et de variables qui s'intègrent de manière native à Google Tag Manager. Votre organisation peut créer un modèle, publier le dépôt de modèles sur GitHub, puis l'envoyer à la galerie de modèles de la communauté pour le mettre à la disposition des utilisateurs du monde entier. Les avantages pour votre organisation sont les suivants:

  • Vos clients pourront facilement ajouter et utiliser vos modèles.
  • Les utilisateurs de Tag Manager seront exposés à la marque de votre entreprise.
  • Vos clients pourront déployer vos balises en quelques minutes au lieu de plusieurs mois.
  • Vous pouvez publier des mises à jour dans vos modèles et les rendre automatiquement accessibles à vos clients.

Pour ajouter un nouveau modèle à la galerie de modèles de la communauté, procédez comme suit:

  1. Créer votre modèle
  2. Préparer les fichiers de votre projet
  3. Importer des fichiers dans GitHub
  4. Envoyer votre modèle

Créer votre modèle

Pour commencer, créez votre modèle dans Google Tag Manager en tant que modèle personnalisé. Assurez-vous que votre modèle a fait l'objet de tests approfondis, que son contenu respecte le Guide de style, et que vous avez un plan ou un processus permettant de gérer et de mettre à jour votre modèle si nécessaire, le cas échéant.

Conditions d'utilisation

Chaque nouveau modèle doit être conforme aux conditions d'utilisation de la galerie de modèles de la communauté Google Tag Manager. Pour confirmer que vous acceptez les conditions d'utilisation de votre modèle:

  1. Lisez les Conditions d'utilisation de la galerie de modèles de la communauté Google Tag Manager.
  2. Dans l'éditeur de modèles, ouvrez votre modèle pour le modifier et cochez la case sous l'onglet Infos intitulé Accepter les conditions d'utilisation de la galerie de modèles de la communauté.

Exporter votre modèle

Une fois votre modèle terminé, exportez-le sur votre ordinateur local et renommez le fichier template.tpl.

Préparer les fichiers de votre projet

L'étape suivante consiste à préparer votre dépôt pour publication sur GitHub. Chaque dépôt doit contenir les fichiers suivants:

  1. Un fichier de modèle exporté nommé template.tpl. Ce fichier doit être mis à jour pour ajouter une entrée categories.
  2. Un fichier metadata.yaml.
  3. Un fichier LICENSE. Le nom de fichier doit être indiqué en MAJUSCULES et le contenu du fichier de licence doit être uniquement Apache 2.0.
  4. Ajoutez un fichier README.md (facultatif, mais recommandé).

Ajouter des catégories à template.tpl

Mettez à jour votre fichier template.tpl avec une entrée categories dans la section INFO et fournissez au moins une valeur de catégorie pertinente sélectionnée dans le tableau suivant. Si plusieurs catégories sont appropriées, vous pouvez indiquer jusqu'à trois valeurs de catégorie, du plus pertinent au moins pertinent.

Exemple :

___INFO___

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

Tableau des valeurs de catégorie acceptées:

Catégorie Description
PUBLICITÉ Publicité
AFFILIÉ_MARKETING Affiliation
ANALYTICS Données analytiques
ATTRIBUTION Attribution
CHAT Chats
CONVERSIONS Mesure des conversions
MÉTRIQUE_DE_DONNÉES Entreposage de données
MARKETING PAR E-MAIL Marketing par e-mail
TESTS Tests A/B et optimisation du contenu
CHAUD Cartes de densité
GÉNÉRATION DE PROSPECTS Génération de prospects
MARKETING Marketing
PERSONNALISATION Personnalisation
REMARKETING Remarketing
PROMOTIONS Ventes et CRM
ENREGISTREMENT DE LA SESSION Enregistrements de sessions
RÉSEAUX SOCIAUX Réseau social
ENQUÊTE Enquêtes
TAG_GESTION Systèmes de gestion des balises
UTILITÉ Utilitaires Google Tag Manager

du fichier metadata.yaml

Le fichier metadata.yaml contient des informations sur votre modèle, y compris des liens vers la page d'accueil de votre organisation, la documentation du modèle et des informations sur la version. Chaque version est désignée par un numéro de modification, également appelé SHA, qui correspond au numéro de modification associé au commit Git. Le champ changeNotes est facultatif, mais recommandé, pour informer les utilisateurs des modifications incluses dans la version.

Pour configurer votre fichier metadata.yaml :

  1. Ajoutez une entrée homepage. Il doit s'agir d'une URL renvoyant à la page d'accueil de votre organisation.
  2. Ajoutez une entrée pour documentation. Cette URL doit renvoyer vers la documentation de votre modèle.
  3. Dans GitHub, recherchez le commit qui inclut les modifications que vous souhaitez déployer pour votre version initiale de votre modèle, puis copiez le numéro SHA. Un moyen simple d'obtenir le numéro SHA dans GitHub est d'accéder à une vue de commit et de cliquer sur l'icône de presse-papiers (icône de presse-papiers). L'intégralité du numéro SHA sera alors copiée dans votre presse-papiers. Collez ce nombre comme valeur pour votre entrée sha en tant qu'enfant du nœud versions, comme indiqué ci-dessous.
  4. Ajoutez une entrée changeNotes au nœud versions pour décrire brièvement les modifications incluses dans cette nouvelle version.
homepage: "https://www.example.com"
documentation: "https://www.example.com/documentation"
versions:
  - sha: 5f02a788b90ae804f86b04aa24af8937e567874a
    changeNotes: Initial release.

Importer dans GitHub

L'étape suivante consiste à importer vos fichiers sur GitHub. Créez un dépôt GitHub avec la structure et les fichiers appropriés, comme décrit ci-dessus.

Les fichiers de modèle doivent contenir les fichiers * template.tpl, metadata.yaml et LICENSE situés à la racine du dépôt Git. Chaque dépôt Git ne doit contenir qu'un seul fichier template.tpl. Toutes les ressources doivent se trouver sur la branche principale de votre dépôt GitHub. Tout dépôt de modèle qui ne correspond pas à cette structure sera supprimé de la galerie.

Chaque entrée de la galerie de modèles de la communauté renvoie vers la section Problèmes du dépôt GitHub du modèle afin que les utilisateurs puissent vous indiquer s'ils trouvent un bug. Assurez-vous que les problèmes n'ont pas été désactivés pour le dépôt GitHub de votre modèle afin de pouvoir les examiner et les résoudre.

Envoyer votre modèle

Une fois votre dépôt de modèles hébergé sur GitHub, vous pouvez l'envoyer à la galerie de modèles de la communauté. Pour envoyer votre modèle, procédez comme suit:

  1. Assurez-vous d'être connecté à GitHub avec un compte ayant accès au dépôt de modèles que vous souhaitez ajouter à la galerie.
  2. Accédez à la galerie de modèles de la communauté à l'adresse tagmanager.google.com/gallery.
  3. Cliquez sur , puis sélectionnez Envoyer le modèle.
  4. Indiquez l'URL du dépôt dans le champ prévu à cet effet, puis cliquez sur Envoyer.

Mettre à jour votre modèle

Après avoir publié un modèle, vous pouvez le mettre à jour de temps en temps. Les utilisateurs de vos modèles recevront une notification si une mise à jour est disponible, et ils auront la possibilité de mettre à jour le modèle avec la dernière version.

Le fichier metadata.yaml permet de déterminer la version de votre modèle à utiliser dans la galerie. Pour publier de nouvelles versions, vous devez ajouter le numéro de modification (numéro SHA) à la section versions de votre fichier metadata.yaml.

  1. Recherchez le commit qui inclut les modifications que vous souhaitez déployer, puis copiez le numéro SHA. Pour ce faire, un moyen simple de procéder est d'accéder à une vue de commit dans GitHub, puis de cliquer sur l'icône de presse-papiers (icône de presse-papiers). Le numéro SHA en entier sera copié dans votre presse-papiers.
  2. Ajoutez une nouvelle entrée sha en haut de votre liste versions dans metadata.yaml. (voir l'exemple ci-dessous).
  3. Ajoutez changeNotes pour décrire brièvement les modifications apportées dans cette nouvelle version. Si vous le souhaitez, vous pouvez créer des commentaires multilignes. (voir l'exemple ci-dessous).
  4. Si vous validez la modification sous metadata.yaml, votre modification sera visible dans la galerie sous deux à trois jours.

Cet exemple montre comment ajouter des informations sur la nouvelle version, y compris le numéro SHA et les notes de modification:

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.