將範本提交至社群範本庫

透過集合功能整理內容 你可以依據偏好儲存及分類內容。

有了 Google 代碼管理工具社群範本庫,貴機構就能建立及管理代碼,以及可原生整合 Google 代碼管理工具的變數範本。貴機構可以建立範本、將範本存放區發布到 GitHub,然後將範本提交至社群範本庫,以便讓全球使用者存取。貴機構的優點包括:

  • 這樣一來,客戶就能輕鬆新增及使用範本。
  • 貴機構的使用者將能看到這個代碼管理工具使用者。
  • 客戶可在幾分鐘內部署您的代碼,而非數個月。
  • 您可以為範本發布更新,並讓系統自動取得這些更新。

將新範本提交至社群範本庫的步驟如下:

  1. 建立範本
  2. 備妥專案檔案
  3. 將檔案上傳至 GitHub
  4. 提交範本

建立範本

首先,在 Google 代碼管理工具中建立範本做為自訂範本。請確定範本已進行全面測試,而且範本的內容符合樣式指南,而且您應在計畫日後執行維護和更新作業。

服務條款

每次提交新範本時,都必須同意 Google 代碼管理工具社群範本庫的服務條款。如要確認範本的範本服務條款,請按照下列步驟操作:

  1. 請參閱《Google 代碼管理工具社群範本庫服務條款》。
  2. 在範本編輯器中開啟範本以進行編輯,並勾選「Info」(資訊) 分頁標籤下方的「同意《社群範本庫》服務條款》中的方塊。

匯出範本

範本完成後,將範本檔案匯出到本機電腦上,並重新命名 template.tpl 檔案。

準備專案檔案

下一步是準備存放區,以便在 GitHub 上發布。每個存放區都應包含下列檔案:

  1. 已匯出的範本檔案,名稱為 template.tpl。這個檔案必須更新才能新增 categories 項目。
  2. metadata.yaml 檔案。
  3. LICENSE 檔案。檔案名稱必須採用全大寫字母,且授權檔案的內容只能Apache 2.0
  4. 新增 README.md 檔案 (選用,但建議使用)。

在「template.tpl」中新增類別

INFO 區段中更新 template.tpl 檔案,並加入 categories 項目,並提供至少一個表格值 (請見下表)。如果有多個類別,您可以提供最多三個類別值,並依關聯性由高至低排序。

範例:

___INFO___

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

支援的類別值表格:

類別 說明
廣告 廣告
成人行銷 聯盟行銷
數據分析 數據分析
姓名標示 歸因
聊天室 留言
轉換 轉換評估
資料範圍 資料倉儲
電子郵件行銷 電子郵件行銷
實驗 A/B 實驗和內容最佳化
HEAT_MAP 熱視圖
待開發客戶產生 待開發客戶產生
行銷 行銷
個人化 個人化
再行銷 再行銷
特賣 銷售與客戶關係管理
課程錄影 工作階段錄影
社交 社群媒體
調查 問卷調查
代碼管理 代碼管理系統
公用程式 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.tplmetadata.yamlLICENSE。每個 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. 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.