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 organisation 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, le publier sur GitHub, puis l'envoyer dans la galerie de modèles de la communauté pour le mettre à la disposition des utilisateurs du monde entier. Voici quelques-uns des avantages dont votre organisation peut bénéficier:

  • Vos clients pourront ajouter et utiliser facilement 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, et non en quelques mois.
  • Vous pouvez publier des modifications dans vos modèles et les rendre automatiquement disponibles pour vos clients.

Pour envoyer 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 vos fichiers sur 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 été minutieusement testé, que son contenu respecte le Guide de style, et que vous avez mis en place un plan ou un processus de gestion et de mise à jour de votre modèle, le cas échéant.

Conditions d'utilisation

Pour chaque envoi de modèle, vous devez accepter les 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. Consultez 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, puis cochez la case Accepter les conditions d'utilisation de la galerie de modèles de la communauté dans l'onglet Infos.

Exporter votre modèle

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

Préparer les fichiers de votre projet

L'étape suivante consiste à préparer le dépôt en vue de sa 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 du fichier doit être EN MAJUSCULES et le fichier de licence doit contenir 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 vous semblent appropriées, vous pouvez en indiquer jusqu'à trois, classées de la plus pertinente à la moins pertinente.

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é
AFFILIATE_MARKETING Affiliation
ANALYTICS Analytics
ATTRIBUTION Attribution
CHAT Chat
CONVERSIONS Mesure des conversions
DATA_WAREHOUSING Entreposage de données
EMAIL_MARKETING Marketing par e-mail
EXPÉRIMENTATION Tests A/B et optimisation du contenu
HEAT_MAP Cartes thermiques
LEAD_GENERATION Génération de prospects
MARKETING Marketing
PERSONNALISATION Personnalisation
REMARKETING Remarketing
VENTES Ventes et CRM
SESSION_RECORDING Enregistrements de sessions
RÉSEAUX SOCIAUX Réseau social
SURVEY Enquêtes
TAG_MANAGEMENT Systèmes de gestion de balises
EFFICACITÉ Utilitaires Google Tag Manager

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 les informations sur la version. Chaque version est désignée par un numéro de modification, également appelé numéro SHA, qui correspond au numéro de modification associé au commit Git. Le champ changeNotes est facultatif, mais recommandé, pour informer vos 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 qui pointe vers la page d'accueil de votre organisation.
  2. Ajoutez une entrée pour documentation. Il doit s'agir d'une URL qui renvoie vers la documentation de votre modèle.
  3. Dans GitHub, recherchez le commit contenant les modifications que vous souhaitez appliquer à la version initiale de votre modèle, puis copiez le numéro SHA. Pour obtenir facilement le numéro SHA dans GitHub, accédez à une vue de commit et cliquez sur l'icône du presse-papiers (icône Presse-papiers). Le numéro SHA complet est alors copié dans le presse-papiers. Collez ce nombre comme valeur de 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 contenues 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 les fichiers et la structure appropriés, comme indiqué ci-dessus.

Les dépôts de modèles doivent comporter les fichiers * template.tpl, metadata.yaml et LICENSE qui se trouvent à 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èles qui ne correspond pas à cette structure sera supprimé de la galerie.

Chaque entrée de la galerie de modèles de la communauté renverra vers la section Problèmes du dépôt GitHub du modèle afin que les utilisateurs puissent vous informer 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 que vous puissiez examiner et résoudre les problèmes éventuels.

Envoyer votre modèle

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

  1. Vérifiez que vous êtes bien 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 votre modèle recevront une notification en cas de mise à jour. Ils auront la possibilité de mettre à jour le modèle en installant 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 contenant les modifications que vous souhaitez transférer et copiez le numéro SHA. Pour ce faire, un moyen simple consiste à accéder à une vue de commit dans GitHub et à cliquer sur l'icône du presse-papiers (icône Presse-papiers). Le numéro SHA complet est alors copié dans le presse-papiers.
  2. Ajoutez une nouvelle entrée sha en haut de votre liste versions dans metadata.yaml. (voir l'exemple ci-dessous).
  3. Ajout de changeNotes pour décrire brièvement les modifications contenues dans cette nouvelle version. Si vous le souhaitez, vous pouvez créer des commentaires multilignes. (voir l'exemple ci-dessous).
  4. Validez la modification sur metadata.yaml. Elle apparaîtra généralement dans la galerie sous deux à trois jours.

Cet exemple montre comment ajouter des informations de 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.