コミュニティ テンプレート ギャラリーにテンプレートを送信する

Google タグ マネージャーのコミュニティ テンプレート ギャラリーでは、Google タグ マネージャーにネイティブに統合されるタグ テンプレートおよび変数テンプレートを作成し、管理することができます。まずはテンプレートを作成し、テンプレート リポジトリを GitHub に公開して、コミュニティ テンプレート ギャラリーにテンプレートを送信すれば、世界中のユーザーにテンプレートを提供することができます。これには、次のようなメリットがあります。

  • ユーザーは簡単にテンプレートを追加し使用できます。
  • タグ マネージャーのユーザーに、お客様の会社のブランドについて知ってもらうことができます。
  • ユーザーは、数か月かかっていたタグの実装を数分で完了できるようになります。
  • テンプレートのアップデートを公開すると、ユーザーに自動的に通知が送信されます。

コミュニティ テンプレート ギャラリーに新しいテンプレートを送信する主なステップは以下のとおりです。

  1. テンプレートを作成する
  2. プロジェクト ファイルを準備する
  3. GitHub にファイルをアップロードする
  4. テンプレートを送信する

テンプレートを作成する

最初のステップは、Google タグ マネージャーでカスタム テンプレートとしてテンプレートを作成することです。作成したテンプレートは徹底的にテストし、テンプレートのコンテンツがスタイルガイドに準拠していることを確認します。加えて、テンプレートのメンテナンスと、必要に応じてアップデートを行うためのプランも早急に策定する必要があります。

利用規約

新しいテンプレートを送信する際には、毎回必ず Google タグ マネージャーのコミュニティ テンプレート ギャラリー利用規約に同意する必要があります。利用規約に同意する手順は以下のとおりです。

  1. Google タグ マネージャーのコミュニティ テンプレート ギャラリー利用規約を読みます。
  2. テンプレート エディタでテンプレートを開き、[情報] タブにある [コミュニティ テンプレート ギャラリーの利用規約に同意] チェックボックスをオンにします。

テンプレートをエクスポートする

テンプレートが完成したら、テンプレート ファイルをローカルマシンにエクスポートし、ファイル名を template.tpl に変更します。

プロジェクト ファイルを準備する

次のステップとして、GitHub で公開するリポジトリを準備します。各リポジトリには、次のファイルを含める必要があります。

  1. エクスポートされたテンプレート ファイル（名前は template.tpl）。このファイルは、categories エントリを追加して更新する必要があります。
  2. metadata.yaml ファイル。
  3. LICENSE ファイル。ファイル名はすべて大文字にします。ライセンス ファイルの内容は、すべて Apache 2.0 に基づくものとします。
  4. README.md ファイル（省略することもできますが、追加することが推奨されています）。

template.tpl にカテゴリを追加する

template.tpl ファイルの INFO セクションに categories エントリを追加し、次の表から選択した関連するカテゴリの値を 1 つ以上指定してください。複数のカテゴリに該当する場合は、最大 3 つのカテゴリの値を指定できます（カテゴリは関連性の高い方から順に並べてください）。

例:

___INFO___

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

サポートされているカテゴリ値の表:

カテゴリ 説明
ADVERTISING 広告
AFFILIATE_MARKETING アフィリエイト マーケティング
ANALYTICS アナリティクス
ATTRIBUTION アトリビューション
CHAT チャット
CONVERSIONS コンバージョンの測定
DATA_WAREHOUSING データ ウェアハウジング
EMAIL_MARKETING メール マーケティング
EXPERIMENTATION A/B テストとコンテンツの最適化
HEAT_MAP ヒートマップ
LEAD_GENERATION 見込み顧客の発掘
MARKETING マーケティング
PERSONALIZATION カスタマイズ
REMARKETING リマーケティング
SALES 販売と CRM
SESSION_RECORDING セッションの録画
SOCIAL ソーシャル
SURVEY サーベイ
TAG_MANAGEMENT タグ管理システム
UTILITY Google タグ マネージャーのユーティリティ

metadata.yaml

metadata.yaml ファイルには、会社のホームページへのリンク、テンプレートのドキュメント、バージョン情報など、テンプレートに関する情報を含めます。各バージョンは変更番号（SHA 番号とも呼ばれる）で表されます。この変更番号は、Git commit に関連付けられます。changeNotes フィールドは省略可能ですが、バージョンに含まれる変更箇所をユーザーに通知するために使用することが推奨されています。

metadata.yaml ファイルを設定する手順は以下のとおりです。

  1. homepage エントリを追加します。自社のホームページを指す URL を指定します。
  2. documentation エントリを追加します。テンプレートのドキュメントを参照する URL を指定します。
  3. GitHub で、テンプレートの初期バージョンに適用する変更を含む commit を探し、SHA 番号をコピーします。GitHub のコミットビューに移動し、クリップボード アイコン（クリップボード アイコン）をクリックすると、簡単に SHA 番号をクリップボードにコピーできます。コピーした数値を versions ノードの子である sha エントリに貼り付けます（以下の例を参照）。
  4. versions ノードに changeNotes エントリを追加し、新しいバージョンで導入する変更点について簡単に説明します。
homepage: "https://www.example.com"
documentation: "https://www.example.com/documentation"
versions:
  - sha: 5f02a788b90ae804f86b04aa24af8937e567874a
    changeNotes: Initial release.

GitHub にアップロードする

次のステップでは、ファイルを GitHub にアップロードします。上記の説明に沿って準備した適切な構造のファイルをアップロードして、GitHub リポジトリを作成します。

テンプレート リポジトリには、Git リポジトリのルートレベルに配置するファイル*（template.tpl、metadata.yaml、および LICENSE）がなければなりません。各 Git リポジトリに含められる template.tpl ファイルは 1 つのみです。すべてのリソースは GitHub リポジトリのメインのブランチにある必要があります。注: この構造に一致しないテンプレート リポジトリはギャラリーから削除されます。

コミュニティ テンプレート ギャラリーからは、テンプレートの GitHub リポジトリにある [Issues] セクションにアクセスすることができます。バグを発見したユーザーは、ここから報告を行うことができます。問題の発生を確認し対処できるようにするため、テンプレートの GitHub リポジトリで Issue が無効になっていないことを確認してください。

テンプレートを送信する

GitHub でテンプレート リポジトリがホストされたら、テンプレートをコミュニティ テンプレート ギャラリーに送信することができます。テンプレートを送信する手順は以下のとおりです。

  1. テンプレート リポジトリにアクセス可能なアカウントで GitHub にログインしていることを確認します。
  2. コミュニティ テンプレート ギャラリー（tagmanager.google.com/gallery）に移動します。
  3. [] をクリックして [テンプレートを送信] を選択します。
  4. 表示される欄にリポジトリの URL を入力し、[送信] をクリックします。

テンプレートをアップデートする

テンプレートを公開した後も、テンプレートのアップデートを随時配信することができます。テンプレートのアップデートがリリースされると、テンプレートのユーザーに通知が送信されます。ユーザーは、テンプレートを最新バージョンに更新するかどうか選択することができます。

metadata.yaml ファイルは、ギャラリーで使用するテンプレートのバージョンを確認するのに使用されます。新しいバージョンを公開する場合は、変更番号（SHA 番号）を metadata.yaml ファイルの versions セクションに追加してください。

  1. プッシュする変更を含む commit を見つけ、SHA 番号をコピーします。GitHub のコミットビューに移動し、クリップボード アイコン（クリップボード アイコン）をクリックすると、簡単に SHA 番号をクリップボードにコピーできます。
  2. metadata.yaml の versions リストの一番上に、新しい sha エントリを追加します（下記の例をご覧ください）。
  3. changeNotes を追加して、この新しいバージョンに含まれる変更について簡単に説明します。必要に応じて、複数行のコメントを作成できます（下記の例をご覧ください）。
  4. metadata.yaml に変更を commit すると、通常 2～3 日以内にギャラリーにアップデートが表示されます。

以下の例は、SHA 番号、変更点などの新しいバージョン情報を追加する方法を示しています。

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.

リポジトリを移動する

オーナーまたはリポジトリ名を変更する場合は、GitHub リポジトリの移行プロセスを使用できます。新しい場所が検出され、ユーザーが次回テンプレートを更新するときに、新しいリポジトリに自動的に転送されます。

テンプレートを削除する

ギャラリーからテンプレートを削除するには、リポジトリから LICENSE ファイルまたは metadata.yaml ファイルを削除します。ギャラリー モニタリング システムは、この変更を検出してテンプレートを自動的に削除します。