將範本提交到社群範本庫

使用 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...
}

支援的類別值表格：

類別 說明
廣告 廣告
AFFILIATE_MARKETING 聯盟行銷
數據分析 數據分析
姓名標示 歸因
聊天室 即時通訊
轉換次數 轉換評估
DATA_WAREHOUSING 資料倉儲
EMAIL_MARKETING 電子郵件行銷
實驗 A/B 實驗和內容最佳化
HEAT_MAP 熱視圖
LEAD_GENERATION 待開發客戶產生
行銷 行銷
個人化 個人化
再行銷 再行銷
銷售 銷售與客戶關係管理
SESSION_RECORDING 課程錄影
社交 社群媒體
SURVEY 問卷調查
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. 將 changeNotes 項目新增至 versions 節點，以簡要說明這個新版本包含的變更。
，瞭解如何調查及移除這項存取權。 
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. 按一下 ，然後選取「Submit Template」。
  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.