テンプレート スタイルガイド

このスタイルガイドでは、コミュニティ テンプレート ギャラリーで公開するテンプレートを作成する際のガイドラインについて説明します。このスタイルガイドは、Google マテリアル デザインのライティング原則に基づいています。基本原則は以下のとおりです。

  • 簡潔であること
  • シンプルかつ直接的であること
  • 人称を適切に使い分けること
  • 重要なポイントが伝わるようにすること
  • あらゆる読解レベルのユーザーが理解できること
  • 機械的でなく、親しみやすいトーンを使用すること

これらのガイドラインを遵守することで、テンプレートのデザインに一貫性を持たせ、ユーザーにとって使いやすいテンプレートを作成することができます。

情報

以下のガイドラインは、テンプレート エディタの [情報] タブの項目に適用されます。

名前

テンプレートの名前は、タグ マネージャーのユーザー インターフェースとコミュニティ テンプレート ギャラリーのテンプレート詳細ページの上部、およびテンプレートの一覧に表示されます。

  • 「会社名 テンプレート名」のように、会社名(または組織名)とテンプレートの機能名を併記します。
  • 語頭を大文字にします(アルファベットの場合)。
  • 用途が一目でわかる名前を付けます。
  • 関連団体の許可を得ているのでない限り、テンプレート名に「公式」という語は使用しないでください。

例: MyCompany コンバージョン測定タグ、MyCompany キャンペーン ID 変数

説明

テンプレートの説明とは、詳細ページに表示されるテンプレートの機能の概要です。

  • テンプレートで何ができるかを、わかりやすく簡潔に説明します。
  • テンプレートを使用するメリットが明快に伝わるようにします。たとえば、「Example.com オーディエンス ビルダーを使用すると、ウェブサイトを訪れるユーザーのデータを基に新しいオーディエンス リストを作成できます」と記載できます。
  • 専門用語は使わないようにします。
  • 詳細情報、ドキュメント、サポートへのリンクを含めます。

アイコン

タグ マネージャーとコミュニティ テンプレート ギャラリーのテンプレートの一覧には、テンプレートのアイコンがサムネイルとして表示されます。

  • 画像形式には PNG、JPEG、GIF を使用します。
  • 画像はスクエア形式で、48×48 ピクセル以上、96×96 ピクセル以下である必要があります。
  • ファイルサイズは 50 KB 未満である必要があります。
  • 公式の企業ロゴは、関連団体の許可がない限り使用しないでください。
  • フィールド
  • テンプレート エディタの [項目] タブを使用して、テキスト入力、チェックボックスなどのフォーム要素を追加します。

フィールド

以下のガイドラインは、テンプレート エディタの [項目] タブに適用されます。

パラメータ名

テンプレート エディタに表示される項目の名前です。これはユーザーに表示される名前とは異なりますどのようなデータを扱うパラメータなのかが、わかるような名前を付けます。パラメータ名は lowerCamelCase の形式にします。例: userName、customerID、shoppingCartValue

項目のラベル

項目のラベルには、表示名、チェックボックスのテキスト、関連アイテムなどが含まれます。

  • 文頭を大文字にします(アルファベットの場合)。
  • できる限り短くします。
  • わかりやすいラベルを付けます。
  • 専門用語は使用しません。

ヘルプテキスト

ヘルプテキストとは、テンプレートの項目に入力できる有効な値についてユーザーにヒントを提供するため、ツールチップとして表示される情報コンテンツです。可能であれば入力例を示して、その項目がどのように使用されるか、指定した値がどのように適用されるかを説明します。

  • 文頭を大文字にします(アルファベットの場合)。
  • 簡潔、かつ親しみやすいトーンを使用します。短縮形、二人称(you)を使用することもできます。
  • サポートされている項目のタイプ
  • 簡易 HTML の形式を使用できます(例: <strong><em>)。

サポートされている項目のタイプ

タイプ
説明
テキスト入力 テキスト入力。このタイプのテンプレート パラメータの値は文字列になります。変数を参照する場合もあります。タグ マネージャーのユーザー インターフェースに表示されるテキスト入力ウィジェットでは、1 行または複数行のテキスト項目になります。
プルダウン メニュー プルダウン メニューからの選択。ユーザーは 1 つの値のみをテンプレート パラメータの値として選択できます。特に理由がなければ、選択肢はアルファベット順にリストしてください。
チェックボックス チェックボックスの入力。このタイプのテンプレート パラメータの値は、ブール値になります。オンの場合は true、オフの場合は false です。
ラジオボタン ラジオ入力。このタイプのテンプレート パラメータは、タグ マネージャーのユーザー インターフェースに選択肢のリストを表示します。ユーザーは 1 つの値のみをテンプレート パラメータの値として選択できます。
シンプルな表 シンプルな表の入力。セルごとに編集が可能です。各セルは、テキスト入力かプルダウン メニューからの選択のいずれかの形式になります。このタイプのテンプレート パラメータの値は、オブジェクトの配列になります。各オブジェクトは行をエンコードします。オブジェクトの各キーはいずれかの列名、オブジェクトの各値は対応するセルの値になります。