將範本提交到社群範本庫

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 檔案。檔案名稱必須全部大寫，且授權檔案的內容只能 阿帕契 2.0。
  4. 新增 README.md 檔案 (選用，但建議使用)。

在「template.tpl」中新增類別

將 categories 項目更新為 INFO 區段的 template.tpl 檔案，並提供至少一個下表中選取的相關類別值。如果多個類別適當，您最多可提供三個類別值，並依照關聯性由高至低排序。

範例：

___INFO___

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

支援的類別值表：

類別 說明
廣告 廣告
AFFILIATE_MARKETING 聯盟行銷
數據分析 數據分析
姓名標示 歸因
聊天室 即時通訊
轉換 轉換評估
DATA_WAREHOUSING 資料倉儲
EMAIL_MARKETING 電子郵件行銷
實驗 A/B 實驗和內容最佳化
HEAT_MAP 熱視圖
LEAD_GENERATION 產生待開發客戶
行銷 行銷
個人化 個人化
再行銷 再行銷
銷售 銷售與客戶關係管理
SESSION_RECORDING 課程錄影
SOCIAL 社群媒體
問卷調查 問卷調查
TAG_MANAGEMENT 代碼管理系統
便利 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 存放區的主要分支版本中。凡是與這個結構不符的範本存放區都會從資源庫中移除。

社群範本庫中的每個項目都會連結至範本 GitHub 存放區的「問題」部分，讓使用者在發現錯誤時通知您。請確認範本的 GitHub 存放區並未停用任何問題，以便查看及解決所有產生的問題。

提交範本

範本存放區由 GitHub 代管後，您就可以繼續將範本提交至社群範本庫。如要提交範本，請按照下列步驟操作：

  1. 請務必登入 GitHub 的帳戶，可以存取您要新增至範本庫的範本存放區。
  2. 前往 tagmanager.google.com/gallery 的社群範本庫。
  3. 按一下 ，然後選取「提交範本」。
  4. 在提供的欄位中提供「存放區網址」，然後按一下「提交」。

更新範本

發布範本之後，您可能需要不時為範本提供更新內容。範本使用者會在範本有更新時收到通知，可以選擇將範本更新為最新版本。

metadata.yaml 檔案是用來決定範本庫中要使用哪個版本的範本。如要發布新版本，您必須在 metadata.yaml 檔案的「versions」部分中加入變更編號 (SHA 號碼)。

  1. 找出包含您要推送的變更的修訂版本，然後複製 SHA 號碼。在 GitHub 中，最簡單的方法是前往修訂版本檢視畫面，然後按一下剪貼簿圖示 (剪貼簿圖示)。這麼做會將整個 SHA 號碼複製到剪貼簿。
  2. 將新的 sha 項目新增至 metadata.yaml 的 versions 清單頂端。(請參閱下方的範例)。
  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.