向社区模板库提交模板

借助 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 文件，将 categories 条目添加到 INFO 部分即可，并提供至少一个从下表中选择的相关类别值。如果有多个类别适用，则您最多可以提供三个类别值，并将这些值按相关性从高到低排序。

示例：

___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 销售和客户关系管理
SESSION_RECORDING 会话录制
SOCIAL 社交
SURVEY 问卷调查
TAG_MANAGEMENT 跟踪代码管理系统
UTILITY Google 跟踪代码管理器实用程序

metadata.yaml

metadata.yaml 文件包含您的模板的相关信息，包括指向您所在组织的首页、模板文档以及版本信息的链接。每个版本都由一个更改编号（也称为 SHA 编号）表示，它是与 Git 提交相关联的更改编号。changeNotes 字段为可选字段，但建议您填写此字段，以向您的用户传达该版本中包含的更改。

要设置您的 metadata.yaml 文件，请执行以下操作：

  1. 添加一个条目 homepage。此条目应为指向您所在组织的首页的网址。
  2. 添加一个 documentation 条目。此条目应为指向模板文档的网址。
  3. 在 GitHub 中，找到要为模板初始版本推送的包含更改的提交内容，并复制 SHA 编号。要在 GitHub 中获取 SHA 编号，一种简单方式是转到提交视图，然后点击剪贴板图标 (剪贴板图标)。此操作会将整个 SHA 编号复制到您的剪贴板。将该编号粘贴为您的 sha 条目的值，以作为 versions 节点的子级，如下所示。
  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 文件。所有资源都必须位于 GitHub 代码库中的 main 分支上。任何与此结构不一致的模板代码库都将从模板库中移除。

社区模板库中的每个条目都会链接到该模板的 GitHub 代码库的问题部分，以便用户能够在发现错误时通知您。请确保您的模板的 GitHub 代码库未停用这个“问题”部分，以便您查看并解决出现的任何问题。

提交模板

在 GitHub 上托管您的模板代码库后，您可以继续将模板提交到社区模板库。要提交模板，请按以下步骤操作：

  1. 确保您用来登录 GitHub 的帐号有权访问您要添加到模板库的模板代码库。
  2. 转到社区模板库，网址为 tagmanager.google.com/gallery。
  3. 点击 并选择提交模板。
  4. 在提供的字段中输入代码库网址，然后点击提交。

更新模板

发布模板后，您可能需要不时更新您的模板。如果模板有可用更新，您的模板用户会收到通知，并可以选择将模板更新为最新版本。

metadata.yaml 文件用于确定要在模板库中使用哪版模板。要发布新版本，您需要将更改编号（SHA 编号）添加到您的 metadata.yaml 文件的 versions 部分。

  1. 找到包含要推送的更改的提交内容，然后复制 SHA 编号。要在 GitHub 中实现此目标，一种简单方式是转到提交视图，然后点击剪贴板图标 (剪贴板图标)。此操作会将整个 SHA 编号复制到您的剪贴板。
  2. 在 metadata.yaml 中的 versions 列表顶部添加一个新的 sha 条目。（请参阅下面的示例。）
  3. 添加 changeNotes，以简要描述这个新版本中包含的更改。如果需要，您可以创建多行注释。（请参阅下面的示例。）
  4. 将更改提交到 metadata.yaml，您的更新通常会在 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.