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

Thư viện mẫu cho cộng đồng 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ý mẫu bằng thẻ và biến có khả năng 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ẫu, xuất bản kho lưu trữ mẫu lên GitHub, sau đó gửi mẫu của bạn vào Thư viện mẫu cho cộng đồng để cung cấp cho người dùng trên toàn thế giới. Các lợi ích đối với tổ chức của bạn bao gồm:

  • Khách hàng sẽ có thể dễ dàng thêm và sử dụng các mẫu của bạn.
  • Người dùng Trình quản lý thẻ sẽ nhìn thấy thương hiệu của tổ chức bạn.
  • Khách hàng 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ể phát hành các bản cập nhật cho mẫu của mình và tự động cung cấp các bản 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 tùy chỉnh. Bạn cần đảm bảo mẫu của mình đã được thử nghiệm kỹ lưỡng, nội dung mẫu tuân thủ Hướng dẫn về quy tắc và bạn đã có kế hoạch hoặc quy trình để duy trì và cập nhật mẫu nếu cần phải xảy ra trong tương lai.

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

Mọi lần gửi mẫu mới phải đồng ý với Đ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. Cách xác nhận thỏa 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 của 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 và chọn hộp trong thẻ Thông tin có nhãn "Đồ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 của bạn

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ộ và đổi tên tệp template.tpl.

Chuẩn bị tệp dự án của bạn

Bước tiếp theo là chuẩn bị kho lưu trữ để phát hành 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 là template.tpl. Bạn phải cập nhật tệp này để thêm mục nhập categories.
  2. Tệp metadata.yaml.
  3. Tệp LICENSE. Tên tệp phải nằm trong TẤT CẢ CHỮ VIẾT HOA và nội dung của tệp giấy phép phải chỉ Apache 2.0.
  4. Thêm một 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

Hãy cập nhật mục template.tpl với mục categories vào mục INFO và cung cấp ít nhất một giá trị danh mục có liên quan được chọn trong bảng sau. Nếu có nhiều danh mục phù hợp, bạn có thể cung cấp tối đa 3 giá trị danh mục, được sắp xếp theo thứ tự từ phù hợp 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 các giá trị danh mục được hỗ trợ:

Danh mục Nội dung mô tả
QUẢNG CÁO Quảng cáo
TIẾP THỊ_PHÁT TIẾP THỊ Tiếp thị liên kết
SỐ LIỆU PHÂN TÍCH Số liệu phân tích
GHI CÔNG Nguồn gốc ghi nhận
TRÒ CHUYỆN Chat (Trò chuyện)
SỐ LƯỢT CHUYỂN ĐỔI Phương thức đo lường lượt chuyển đổi
KHOÁ DỮ LIỆU Lưu trữ dữ liệu
EMAIL_TIẾP THỊ 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
THU HÚT KHÁCH HÀNG TIỀM NĂNG Khả năng tạo khách hàng tiềm năng
TIẾP THỊ Tiếp thị
CÁ NHÂN Hoạt động cá nhân
TIẾP THỊ LẠI Tiếp thị lại
GIẢM GIÁ Bán hàng và CRM
GHI CHẬP PHIÊN Ghi lại phiên
XÃ HỘI Xã hội
KHẢO SÁT Khảo sát
QUẢN LÝ THẺ Hệ thống quản lý thẻ
TIỆN ÍCH 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 đường liên kết đến trang chủ, tài liệu mẫu và thông tin phiên bản của tổ chức bạn. Mỗi phiên bản được biểu thị bằng một số thay đổi, còn được gọi là số SHA, là số thay đổi liên kết với cam kết Git. Trường changeNotes là không bắt buộc, nhưng bạn nên dùng để thông báo cho người dùng về những thay đổi trong phiên bản này.

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

  1. Thêm một mục nhập homepage. Đây phải là một URL trỏ đến trang chủ của tổ chức bạn.
  2. Thêm một mục nhập cho documentation. Đây phải là URL trỏ đến tài liệu cho mẫu của bạn.
  3. Trong GitHub, hãy tìm cam kết bao gồm các thay đổi mà bạn muốn đẩy cho phiên bản ban đầu của mẫu và 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 khay 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 sha của bạn làm nút con của nút versions, như minh hoạ bên dưới.
  4. Thêm một mục changeNotes vào nút versions để mô tả ngắn gọn các thay đổi 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 của bạn 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ư được 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 chính trong kho lưu trữ GitHub. Bất kỳ kho lưu trữ mẫu nào 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 mục Vấn đề trong kho lưu trữ GitHub của mẫu để người dùng có thể thông báo cho bạn nếu họ tìm thấy lỗi. Đảm bảo rằng các vấn đề chưa bị vô hiệu hóa đố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ủa bạn được lưu trữ trên GitHub, bạn có thể tiếp tục gửi mẫu của mình đến Thư viện mẫu cho cộng đồng. Để gửi mẫu, hãy làm theo các bước sau:

  1. Đảm bảo rằng 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

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

Tệp metadata.yaml dùng để xác định phiên bản mẫu nào bạn muốn sử dụng trong thư viện. Để xuất bản 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. Tìm cam kết bao gồm các thay đổi mà bạn muốn đẩy và sao chép số SHA. Bạn có thể dễ dàng thực hiện việc này trong GitHub bằng cách chuyển đến commit view (chế độ xem cam kết) rồi nhấp vào biểu tượng bảng nhớ tạm (biểu tượng khay 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ụ dưới đây.)
  3. Thêm changeNotes để mô tả ngắn gọn các thay đổi trong phiên bản mới này. Bạn có thể tạo các nhận xét nhiều dòng nếu muốn. (Xem ví dụ dưới đây.)
  4. Xác nhận nội dung thay đổi đối với metadata.yaml và nội dung cập nhật của bạn sẽ xuất hiện trong thư viện thường trong vòng 2 đến 3 ngày.

Ví dụ này minh họa cách thêm thông tin phiên bản mới bao gồm 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.