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

Thư viện mẫu cho cộng đồng của 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ể tạo một mẫu, xuất bản kho lưu trữ mẫu lên GitHub, rồi gửi mẫu đó đến Thư viện mẫu cho cộng đồng để cung cấp 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ủa bạn 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ẽ biết đến thương hiệu của tổ chức bạn.
  • Khách hàng của bạn sẽ có thể triển khai thẻ của bạn trong vòng vài phút, thay vì vài tháng.
  • Bạn có thể xuất bản 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

Tạo mẫu

Để bắt đầu, hãy tạo mẫu trong Trình quản lý thẻ của Google dưới dạng mẫu tuỳ chỉnh. Đảm bảo mẫu của bạn đã được kiểm thử kỹ lưỡng, nội dung của mẫu tuân thủ Hướng dẫn về kiểu 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 làm như vậy trong tương lai.

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

Mọi mẫu mới được 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 của Trình quản lý thẻ của Google. Cách xác nhận rằng bạn đồng ý với Điều khoản dịch vụ cho mẫu của mình:

  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 của bạn để chỉnh sửa rồi đánh dấu vào hộp bên dưới 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

Sau khi mẫu của bạn hoàn tất, hãy xuất tệp mẫu vào máy cục bộ và đổi tên tệp thành 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. Một 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 categories.
  2. Tệp metadata.yaml.
  3. Tệp LICENSE. Tên tệp phải ở DẠNG CHỮ HOA và nội dung của tệp giấy phép chỉ được là Apache 2.0.
  4. Thêm tệp README.md (không bắt buộc nhưng nên làm).

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

Cập nhật tệp template.tpl bằng mục 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 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 phù hợp 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 Trò chuyện
CHUYỂN ĐỔI Đo lường lượt chuyển đổi
DATA_WAREHOUSING Kho 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 Tạo khách hàng tiềm năng
TIẾP THỊ Tiếp thị
PERSONALIZATION Cá nhân hoá
TÁI TIẾP THỊ Tái tiếp thị
DOANH SỐ Bán hàng và quản lý quan hệ khách hàng
SESSION_RECORDING Bản ghi phiên
SOCIAL Xã hội
KHẢO SÁT Khảo sát
TAG_MANAGEMENT Hệ thống quản lý thẻ
TƯƠNG TÁC Tiện ích của 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ả đường liên kết đến trang chủ của tổ chức, tài liệu về mẫu và thông tin phiên 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. Đây là số thay đổi được liên kết với cam kết Git. Trường changeNotes không bắt buộc nhưng nên dùng để thông báo cho người dùng về những thay đổi có trong phiên bản.

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

  1. Thêm mục homepage. Đây phải là URL trỏ đến trang chủ của tổ chức bạn.
  2. Thêm mục cho documentation. Đây phải là URL trỏ đến tài liệu về mẫu của bạn.
  3. Trong GitHub, hãy tìm cam kết có chứa những thay đổi mà bạn muốn đẩy cho phiên bản ban đầu 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 sha dưới dạng phần tử con của nút versions, như minh hoạ bên dưới.
  4. Thêm mục 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 có các tệp và cấu trúc phù hợp như trình bày ở trên.

Kho lưu trữ mẫu phải có các tệp * template.tpl, metadata.yaml và LICENSE ở cấp gốc của kho lưu trữ Git. Mỗi kho lưu trữ Git chỉ được 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. 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 đề của kho lưu trữ GitHub của mẫu để người dùng có thể cho bạn biết nếu họ phát hiện thấy lỗi.

Gửi mẫu

Sau khi kho lưu trữ mẫu của bạn được lưu trữ trên GitHub, bạn có thể tiến hành gửi mẫu đó đế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 bạn đã đăng nhập vào GitHub bằng một 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. Chuyển đến 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 được cung cấp rồi nhấp vào Gửi.

Cập nhật mẫu

Sau khi xuất bản một mẫu, đôi khi bạn có thể muốn 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ẽ nhận được thông báo nếu có bản cập nhật cho mẫu và sẽ 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 nào sẽ 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 có chứa những thay đổi mà bạn muốn đẩy rồi sao chép số SHA. Một cách dễ dàng để làm việc này 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ục sha mới vào đầu danh sách versions 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 đối với metadata.yaml và bản cập nhật của bạn sẽ xuất hiện trong Thư viện, thường là trong vòng 2 đến 3 ngày.

Ví dụ này minh hoạ cách thêm thông tin phiên bản mới, bao gồm cả số SHA và ghi chú về 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.

Di chuyển kho lưu trữ

Nếu muốn thay đổi chủ sở hữu hoặc tên kho lưu trữ, bạn có thể sử dụng quy trình chuyển kho lưu trữ trên GitHub. Vị trí mới sẽ được phát hiện và người dùng sẽ tự động được chuyển đến kho lưu trữ mới vào lần cập nhật mẫu tiếp theo.

Xoá mẫu

Để xoá một mẫu khỏi thư viện, hãy xoá tệp LICENSE hoặc tệp metadata.yaml khỏi kho lưu trữ của mẫu đó. Hệ thống giám sát thư viện sẽ phát hiện thay đổi này và tự động xoá mẫu.