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, publier le dépôt de modèles sur GitHub, puis envoyer votre modèle à la galerie de modèles de la communauté pour le rendre disponible aux utilisateurs du monde entier. Voici les avantages pour votre organisation :

• Vos clients pourront facilement ajouter et utiliser vos modèles.
• Les utilisateurs de Tag Manager seront exposés à la marque de votre organisation.
• Vos clients pourront déployer vos balises en quelques minutes, et non en plusieurs mois.
• Vous pouvez publier des mises à jour pour vos modèles et les mettre automatiquement à la disposition de vos clients.

Pour envoyer un nouveau modèle à la galerie de modèles de la communauté, vous devez suivre les étapes principales suivantes :

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é testé de manière approfondie, que son contenu respecte le Guide de style et que vous avez prévu un plan ou un processus pour le maintenir et le mettre à jour si nécessaire à l'avenir.

Conditions d'utilisation

Chaque nouveau modèle envoyé doit respecter 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. 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 Accepter les conditions d'utilisation de la galerie de modèles de la communauté sous 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 template.tpl.

Préparer les fichiers de votre projet

L'étape suivante consiste à préparer votre dépôt pour la 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 en MAJUSCULES et le contenu du fichier de licence doit uniquement être Apache 2.0.
4. Ajoutez un fichier README.md (facultatif, mais recommandé).

Remarque : Utilisez le dépôt de modèles exemples sur GitHub comme modèle. Copiez le fichier LICENSE du modèle d'exemple dans votre projet pour vous assurer qu'il ne contient aucune erreur. Veillez également à modifier la ligne de copyright en remplaçant Copyright [yyyy] [name of copyright owner] par le texte approprié. Remplacez yyyy par l'année du copyright et [name of copyright owner] par le nom du titulaire des droits d'auteur.

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 conviennent, vous pouvez fournir jusqu'à trois valeurs de catégorie, classées de la plus pertinente à la moins pertinente.

Remarque : Les valeurs de l'entrée categories doivent être mises en forme sous forme de tableau.

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 de densité
LEAD_GENERATION	Génération de prospects
MARKETING	Marketing
PERSONALIZATION	Personnalisation
REMARKETING	Remarketing
DES VENTES	Ventes et CRM
SESSION_RECORDING	Enregistrements de sessions
RÉSEAUX SOCIAUX	Réseau social
ENQUÊTE	Enquêtes
TAG_MANAGEMENT	Systèmes de gestion de balises
UTILITÉ	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 des 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 pointant vers la documentation de votre modèle.
3. Dans GitHub, recherchez le commit qui inclut 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 en forme de presse-papiers (). Le numéro SHA complet sera copié 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 contenues dans cette nouvelle version.

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

Important : sha et changeNotes doivent être alignés comme indiqué dans l'exemple de code ci-dessus.

Remarque : La valeur sha doit faire référence au fichier template.tpl spécifique que vous souhaitez publier. N'oubliez pas de mettre à jour correctement cette valeur à chaque nouvelle version.

Importer sur GitHub

L'étape suivante consiste à importer vos fichiers dans 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 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 comporter 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é renvoie à la section Problèmes du dépôt GitHub du modèle. Les utilisateurs peuvent ainsi vous signaler les bugs qu'ils rencontrent.

Important : Assurez-vous que l'option Problèmes n'a pas été désactivée pour le dépôt GitHub de votre modèle et que les notifications par e-mail sont activées. Vous pourrez ainsi être informé de tout problème survenant lors de l'examen du modèle.

Envoyer votre modèle

Une fois votre dépôt de modèles hébergé sur GitHub, vous pouvez envoyer votre modèle à 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

Une fois que vous avez publié un modèle, vous pouvez souhaiter le mettre à jour de temps en temps. Les utilisateurs de votre modèle seront avertis si une mise à jour est disponible et pourront installer la dernière version du modèle.

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 transférer, puis copiez le numéro SHA. Pour ce faire facilement dans GitHub, accédez à une vue de commit et cliquez sur l'icône en forme de presse-papiers (). L'intégralité du numéro SHA sera alors copiée dans votre presse-papiers.
2. Ajoutez une 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 contenues dans cette nouvelle version. Vous pouvez créer des commentaires multilignes, si vous le souhaitez. (Voir l'exemple ci-dessous.)
4. Validez la modification apportée à metadata.yaml. Votre mise à jour apparaîtra dans la galerie sous deux à trois jours.

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

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.

Important : Chaque version publiée du modèle doit être incluse dans la section versions, classée par ordre chronologique inverse (de la plus récente à la plus ancienne).

Remarque : Il n'est pas nécessaire d'inclure chaque commit incrémentiel en tant que modification de version dans la galerie de modèles de la communauté. Par exemple, si vous apportez des modifications incrémentielles dans les commits 1, 2 et 3, et que la version finale correspond au commit 4, vous ne devez avoir qu'une seule entrée pour le commit 4, qui inclut toutes les modifications des commits 1, 2 et 3.

Déplacer votre dépôt

Si vous souhaitez changer de propriétaire ou de nom de dépôt, vous pouvez utiliser la procédure de transfert de dépôt GitHub. La nouvelle position sera détectée et les utilisateurs seront automatiquement redirigés vers le nouveau dépôt la prochaine fois qu'ils mettront à jour le modèle.

Supprimer votre modèle

Pour supprimer un modèle de la galerie, supprimez le fichier LICENSE ou le fichier metadata.yaml de son dépôt. Le système de surveillance de la galerie détectera ce changement et supprimera automatiquement le modèle.