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 en mode natif à Google Tag Manager. Votre organisation peut créer un modèle, publier son dépôt sur GitHub, puis l'envoyer à la galerie de modèles de la communauté pour le mettre à la disposition des utilisateurs du monde entier. Votre organisation bénéficiera des avantages suivants:

• 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 de 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é, 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é testé de manière approfondie, que son contenu respecte le guide de style et que vous disposez d'un plan ou d'un processus pour le gérer et le mettre à jour si nécessaire à l'avenir.

Conditions d'utilisation

Tout nouveau modèle 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, puis 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 vers 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. Fichier de modèle exporté nommé template.tpl. Ce fichier doit être mis à jour pour ajouter une entrée categories.
2. Fichier metadata.yaml.
3. Un fichier LICENSE. Le nom de fichier doit être 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 appropriée sélectionnée dans le tableau suivant. Si plusieurs catégories sont appropriées, vous pouvez en indiquer jusqu'à trois, dans l'ordre 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:

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 associée à 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 redirige vers la documentation de votre modèle.
3. Dans GitHub, recherchez le commit qui inclut les modifications que vous souhaitez pousser pour votre 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, puis cliquez sur l'icône du presse-papiers (). Le numéro SHA complet sera 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 apportées à cette nouvelle version.

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

Importer sur 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 contenir les fichiers * template.tpl, metadata.yaml et LICENSE au niveau 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 dans 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é comporte un lien vers la section Problèmes du dépôt GitHub du modèle afin que les utilisateurs puissent vous en 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 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 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 more_vert, 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 le mettre à jour de temps en temps. Les utilisateurs de votre modèle seront informés de toute mise à jour et pourront passer à 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 pousser, puis copiez le numéro SHA. Pour ce faire, accédez à une vue de commit dans GitHub, puis cliquez sur l'icône du presse-papiers (). Le numéro SHA complet sera alors copié dans le 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 apportées dans cette nouvelle version. Si vous le souhaitez, vous pouvez créer des commentaires multilignes. (Voir l'exemple ci-dessous.)
4. Validez la modification dans metadata.yaml. Votre mise à jour apparaîtra dans la galerie généralement sous deux à trois jours.

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

Déplacer votre dépôt

Si vous souhaitez modifier les propriétaires ou les noms de dépôt, vous pouvez utiliser le processus de transfert de dépôt GitHub. Le nouvel emplacement sera détecté 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 cette modification et supprimera automatiquement le modèle.