注意:此开发者网站正在向 developers.google.com/tag-platform 迁移,2021 年 9 月 30 日起将会进行重定向

模板样式指南

本样式指南旨在帮助您决定如何为社区模板库准备模板,它是按照 Google Material Design 撰写原则编制的。简言之,这些原则包括:

  • 简洁
  • 内容简单直接
  • 明确解决用户问题
  • 传递基本的详细信息
  • 适合各种阅读水平
  • 秉持人性化理念:面向人类(而非机器人)而撰写

请遵循这些准则,确保所有模板均具有一致的外观和风格,并帮助用户了解如何使用您的模板。

信息

这些准则适用于模板编辑器的信息标签页中的项。

名称

模板名称会在跟踪代码管理器界面和社区模板库中展示给跟踪代码管理器用户。它显示在模板详情页面的顶部,还会在模板以列表形式显示时出现。

  • 请将您的公司/组织名称与模板的功能名称组合使用,组织名称在前,后跟模板名称。
  • 采用词首字母大写形式。
  • 使用描述功能的字词。
  • 避免在模板名称中使用“Official”一词,除非您获得了相关组织的授权。

示例:MyCompany Conversion Measurement Tag、MyCompany Campaign ID Variable

说明

模板说明是对模板的说明,作为模板功能的简短摘要显示在详情页面上。

  • 使用简明扼要的句子描述模板的功能。
  • 明确说明您的模板为用户带来的优势。例如:“Example.com Audience Builder 模板可助您利用网站访问者构建新的受众群体列表”
  • 避免使用行话。
  • 添加指向其他信息、文档和支持服务的链接。

图标

跟踪代码管理器和社区模板库中列出的模板图标采用的是缩略图表示形式,

  • 使用的是 PNG、JPEG 或 GIF 图片格式。
  • 图片应为方形,至少为 48 像素 x 48 像素,且不超过 96 像素 x 96 像素。
  • 文件必须小于 50 KB。
  • 避免使用官方公司徽标,除非您获得了相关组织的授权。
  • 字段
  • 使用模板编辑器的“字段”标签页添加文本输入和复选框等表单元素。

字段

这些样式准则适用于模板编辑器的字段标签页。

参数名称

这是字段在模板编辑器中的名称,但并非面向用户显示的名称。(请参阅显示名称。)名称应描述所用数据的类型。参数名称应采用 lowerCamelCase 格式。示例:userName、customerID、shoppingCartValue。

字段标签

字段标签包括显示名称字段、复选框文本和相关项。

  • 采用句首字母大写形式。
  • 越短越好。
  • 客观描述。
  • 使用常用字词。

帮助文本

帮助文本是以提示形式呈现的信息性内容,可帮助用户在模板字段中输入有效值。请尽可能提供输入内容示例,并描述模板字段的使用方式或提供某些值时的效果。

  • 采用句首字母大写形式。
  • 简洁,但秉持人性化理念。可以使用缩写,并以第二人称(您)撰写。
  • 支持的字段类型
  • 可以使用基本 HTML 格式。示例:<strong><em>

支持的字段类型

类型
说明
文本输入 文本输入。如果模板参数为此类型,则其值是一个可引用变量的字符串。跟踪代码管理器界面中呈现的文本输入微件可以是单行文本字段,也可以是多行输入。
下拉菜单 下拉菜单,只能选择其中的一项作为模板参数的值。除非有充分的理由,否则请按字母顺序列出各项。
复选框 复选框输入。如果模板参数为此类型,则其值将为布尔值:如果选中,则为 true;如果未选中,则为 false。
单选按钮 单选输入。此类型的模板参数会在跟踪代码管理器界面中显示一个选项列表,用户只能选择其中一项作为模板参数的值。
简单表格 简单的表格输入。表格中的每个单元格均可就地修改,并且每个单元格只能为两种类型之一:文本输入或下拉菜单。如果模板参数为此类型,则其值将为对象数组:每个对象均可以对某一行进行编码、对象中的每个键必须是其中一个列名,并且对象中的每个值均为对应单元格的值。