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

  • 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ẽ thấy 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, chứ không phải vài tháng.
  • Bạn có thể phát hành nội dung cập nhật cho mẫu và tự động cung cấp các nội dung cập nhật đó cho khách hàng.

Quy trình gửi mẫu mới vào 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 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 tra kỹ lưỡng, nội dung của mẫu tuân theo 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 thiết 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 Trình quản lý thẻ của Google. Để xác nhận sự đồng ý 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 chọn 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 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ộ 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ữ để phát hành 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ột mục categories.
  2. Một tệp metadata.yaml.
  3. Một tệp LICENSE. Tên tệp phải CHỮ VIẾT HOA và nội dung của tệp giấy phép chỉ Apache 2.0.
  4. Thêm một 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 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 3 giá trị cho 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 Nội dung 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)
SỐ LƯỢT 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 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 phiên
SOCIAL Xã hội
KHẢO SÁT Khảo sát
TAG_MANAGEMENT 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á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 gọi là số SHA). Đây là số thay đổi được liên kết với cam kết Git. Bạn không bắt buộc phải sử dụng trường changeNotes, nhưng bạn nên dùng trường này để thông báo cho người dùng về các thay đổi có trong phiên bản.

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

  1. Thêm một mục 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 cam kết bao gồm các thay đổi mà bạn muốn đẩy lên phiên bản mẫu ban đầu rồi sao chép số SHA. Một cách dễ dàng để lấy số SHA trong GitHub là truy cập vào 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 các tệp của bạn 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.yamlLICENSE ở 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 đề 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 phát hiện lỗi. Hãy đảm bảo rằng các vấn đề chưa được tắt đố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 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 vào 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 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 cho sẵn và nhấp vào Gửi.

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

Sau khi xuất bản mẫu, có thể bạn nên thỉnh thoảng mới cập nhật được cho mẫu đó. 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 đối với mẫu và sẽ có lựa 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 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. Tìm cam kết bao gồm các thay đổi mà bạn muốn đẩy rồi sao chép số SHA. Bạn có thể dễ dàng thực hiện việc này trong GitHub. Hãy truy cập vào 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 nhập sha mới vào đầu danh sách versions trong metadata.yaml. (Xem ví dụ dưới đây.)
  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ụ dưới đây.)
  4. Cam kết thay đổ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 từ 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ú 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.