Gửi mẫu tới Thư viện mẫu cho cộng đồng

Thư viện mẫu cho cộng đồng trong Trình quản lý thẻ của Google cho phép tổ chức của bạn tạo và quản lý các mẫu thẻ và biến được tích hợp sẵn với Trình quản lý thẻ của Google. Tổ chức của bạn có thể xây dựng một mẫu, xuất bản kho lưu trữ mẫu lên GitHub, sau đó gửi mẫu đến Thư viện mẫu cho cộng đồng để cung cấp mẫu cho người dùng trên toàn thế giới. Tổ chức của bạn sẽ được hưởng những lợi ích sau:

  • Khách hàng có thể dễ dàng thêm và sử dụng mẫu của bạn.
  • Người dùng Trình quản lý thẻ sẽ thấy thương hiệu của tổ chức bạn.
  • Khách hàng sẽ có thể triển khai thẻ của bạn trong vòng vài phút, chứ không phải vài tháng.
  • Bạn có thể xuất bản nội dung cập nhật cho mẫu và tự động áp dụng những nội dung cập nhật đó cho khách hàng.

Quy trình gửi mẫu mới đến Thư viện mẫu cho cộng đồng bao gồm các bước chính sau:

  1. Tạo mẫu
  2. Chuẩn bị tệp dự án
  3. Tải tệp lên GitHub
  4. Gửi mẫu của bạn

Tạo mẫu của bạn

Để bắt đầu, hãy tạo mẫu của bạn trong Trình quản lý thẻ của Google dưới dạng mẫu tuỳ chỉnh. Hãy đảm bảo mẫu của bạn đã được thử nghiệm kỹ lưỡng và nội dung mẫu tuân theo Hướng dẫn về kiểu, đồng thời bạn đã có kế hoạch hoặc quy trình về cách duy trì và cập nhật mẫu nếu cần thiết trong tương lai.

Điều khoản dịch vụ

Mọi mẫu mới bạn gửi đều phải đồng ý với Điều khoản dịch vụ của Thư viện mẫu cho cộng đồng trong Trình quản lý thẻ của Google. Cách xác nhận thoả thuận với Điều khoản dịch vụ cho mẫu của bạn:

  1. Đọc Điều khoản dịch vụ của Thư viện mẫu cho cộng đồng Trình quản lý thẻ của Google.
  2. Trong Trình chỉnh sửa mẫu, hãy mở mẫu để chỉnh sửa rồi đánh dấu vào hộp bên dưới thẻ Thông tin có nhãn là "Đồng ý với Điều khoản dịch vụ của Thư viện mẫu cho cộng đồng".

Xuất mẫu

Sau khi mẫu của bạn hoàn tất, hãy xuất tệp mẫu sang máy cục bộ rồi đổi tên tệp template.tpl.

Chuẩn bị tệp dự án

Bước tiếp theo là chuẩn bị kho lưu trữ để xuất bản trên GitHub. Mỗi kho lưu trữ phải chứa các tệp sau:

  1. Tệp mẫu đã xuất có tên template.tpl. Bạn phải cập nhật tệp này để thêm một mục categories.
  2. Tệp metadata.yaml.
  3. Tệp LICENSE. Tên tệp phải ở dạng VIẾT HOA TOÀN BỘ và nội dung của tệp giấy phép chỉ được Apache 2.0.
  4. Thêm tệp README.md (không bắt buộc, nhưng nên dùng).

Thêm danh mục vào template.tpl

Cập nhật tệp template.tpl của bạn với mục nhập categories vào phần INFO và cung cấp ít nhất một giá trị danh mục có liên quan được chọn từ bảng sau. Nếu có nhiều danh mục phù hợp, bạn có thể cung cấp tối đa ba giá trị của danh mục, được sắp xếp theo thứ tự từ liên quan nhất đến ít liên quan nhất.

Ví dụ:

___INFO___

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

Bảng giá trị danh mục được hỗ trợ:

Danh mục Mô tả
QUẢNG CÁO Quảng cáo
AFFILIATE_MARKETING Tiếp thị liên kết
ANALYTICS Số liệu phân tích
GHI CÔNG Phân bổ
TRÒ CHUYỆN Chat (Trò chuyện)
CHUYỂN ĐỔI Đo lường lượt chuyển đổi
DATA_WAREHOUSING Lưu trữ dữ liệu
EMAIL_MARKETING Tiếp thị qua email
THỬ NGHIỆM Thử nghiệm A/B và tối ưu hoá nội dung
HEAT_MAP Bản đồ nhiệt
LEAD_GENERATION Khả năng tạo khách hàng tiềm năng
TIẾP THỊ Tiếp thị
CÁ NHÂN hoá Cá nhân hoá
TIẾP THỊ LẠI Tiếp thị lại
GIẢM GIÁ Bán hàng và CRM
SESSION_RECORDING Bản ghi lại các buổi trình bày
XÃ HỘI Xã hội
SURVEY Khảo sát
TAG_MANAGEMENT Hệ thống quản lý thẻ
KHẢ NĂNG Tiện ích Trình quản lý thẻ của Google

metadata.yaml

Tệp metadata.yaml chứa thông tin về mẫu của bạn, bao gồm cả các đường liên kết đến trang chủ của tổ chức, tài liệu mẫu và thông tin về phiên bản. Mỗi phiên bản được biểu thị bằng một số thay đổi, còn gọi là số SHA, là số thay đổi được liên kết với cam kết Git. Trường changeNotes là trường không bắt buộc nhưng bạn nên nhập để thông báo cho người dùng về những thay đổi có trong phiên bản này.

Cách thiết lập tệp metadata.yaml:

  1. Thêm mục nhập homepage. Đây phải là một URL trỏ đến trang chủ của tổ chức của bạn.
  2. Thêm một mục cho documentation. Đây phải là một URL trỏ đến tài liệu cho mẫu của bạn.
  3. Trong GitHub, hãy tìm lệnh xác nhận bao gồm các thay đổi mà bạn muốn đẩy vào phiên bản đầu tiên của mẫu rồi sao chép số SHA. Một cách dễ dàng để lấy số SHA trong GitHub là chuyển đến chế độ xem cam kết rồi nhấp vào biểu tượng bảng nhớ tạm (biểu tượng bảng nhớ tạm). Thao tác này sẽ sao chép toàn bộ số SHA vào bảng nhớ tạm. Dán số đó làm giá trị cho mục nhập sha dưới dạng phần tử con của nút versions, như minh hoạ dưới đây.
  4. Thêm mục nhập changeNotes vào nút versions để mô tả ngắn gọn những thay đổi có trong phiên bản mới này.
homepage: "https://www.example.com"
documentation: "https://www.example.com/documentation"
versions:
  - sha: 5f02a788b90ae804f86b04aa24af8937e567874a
    changeNotes: Initial release.

Tải lên GitHub

Bước tiếp theo là tải tệp lên GitHub. Tạo một kho lưu trữ GitHub với các tệp và cấu trúc thích hợp như đã nêu ở trên.

Kho lưu trữ mẫu phải có các tệp * template.tpl, metadata.yamlLICENSE ở cấp gốc của kho lưu trữ Git. Mỗi kho lưu trữ Git chỉ nên có một tệp template.tpl. Tất cả tài nguyên phải nằm trên nhánh main (chính) trong kho lưu trữ GitHub của bạn. Mọi kho lưu trữ mẫu không khớp với cấu trúc này sẽ bị xoá khỏi Thư viện.

Mỗi mục trong Thư viện mẫu cho cộng đồng sẽ liên kết đến phần Vấn đề trong kho lưu trữ GitHub của mẫu. Như vậy, người dùng có thể thông báo cho bạn nếu phát hiện thấy lỗi. Hãy đảm bảo rằng bạn chưa vô hiệu hoá các vấn đề đối với kho lưu trữ GitHub của mẫu để bạn có thể xem xét và giải quyết mọi vấn đề phát sinh.

Gửi mẫu của bạn

Sau khi kho lưu trữ mẫu được lưu trữ trên GitHub, bạn có thể tiếp tục gửi mẫu đến Thư viện mẫu cho cộng đồng. Để gửi mẫu của bạn, hãy làm theo các bước sau:

  1. Đảm bảo bạn đăng nhập vào GitHub bằng tài khoản có quyền truy cập vào kho lưu trữ mẫu mà bạn muốn thêm vào Thư viện.
  2. Truy cập vào Thư viện mẫu cho cộng đồng tại tagmanager.google.com/gallery.
  3. Nhấp vào rồi chọn Gửi mẫu.
  4. Cung cấp URL kho lưu trữ trong trường cho sẵn rồi nhấp vào Gửi.

Cập nhật mẫu của bạn

Sau khi xuất bản mẫu, thỉnh thoảng bạn có thể muốn cung cấp bản cập nhật cho mẫu của mình. Người dùng mẫu của bạn sẽ được thông báo nếu có bản cập nhật cho mẫu và có thể cập nhật mẫu lên phiên bản mới nhất.

Tệp metadata.yaml được dùng để xác định phiên bản mẫu sẽ sử dụng trong thư viện. Để phát hành các phiên bản mới, bạn cần thêm số thay đổi (số SHA) vào phần versions của tệp metadata.yaml.

  1. Xác định vị trí cam kết bao gồm các thay đổi mà bạn muốn đẩy lên và sao chép số SHA. Một cách dễ dàng để thực hiện việc này là trong GitHub là chuyển đến chế độ xem cam kết rồi nhấp vào biểu tượng bảng nhớ tạm (biểu tượng bảng nhớ tạm). Thao tác này sẽ sao chép toàn bộ số SHA vào bảng nhớ tạm.
  2. Thêm một mục sha mới vào đầu danh sách versions của bạn trong metadata.yaml. (Xem ví dụ bên dưới.)
  3. Thêm changeNotes để mô tả ngắn gọn những thay đổi có trong phiên bản mới này. Bạn có thể tạo nhận xét nhiều dòng nếu muốn. (Xem ví dụ bên dưới.)
  4. Xác nhận thay đổi với metadata.yaml và nội dung cập nhật của bạn thường sẽ xuất hiện trong thư viện trong vòng 2 đến 3 ngày.

Ví dụ sau minh hoạ cách thêm thông tin phiên bản mới, bao gồm cả số SHA và ghi chú thay đổi:

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.