Yêu cầu về Trình kết nối đối tác

Xem phần Tổng quan về việc xuất bản để hiểu các lợi ích và mức độ cam kết cần thiết khi phát hành trình kết nối. Để xuất bản Trình kết nối đối tác, trình kết nối của bạn phải đáp ứng tất cả các yêu cầu được mô tả bên dưới.

Apps Script

Trước khi gửi trình kết nối để được xem xét, hãy hoàn thành các bước sau trong Apps Script:

  1. Chia sẻ quyền xem của dự án Apps Script với những nội dung sau:
  2. Tạo quy trình triển khai có tên là Production rồi cập nhật quá trình triển khai Production lên phiên bản mã mà bạn định phát hành.
  3. Xác nhận rằng bạn đã cập nhật quá trình triển khai Production lên phiên bản mã mà bạn muốn chúng tôi xem xét.
  4. Xác nhận rằng tệp kê khai hiển thị trong Apps Script. Ở bên trái, hãy nhấp vào biểu tượng Cài đặt dự án . Chọn hộp đánh dấu Hiển thị tệp kê khai "appsscript.json" trong trình chỉnh sửa.

Tệp kê khai

Đưa nội dung sau vào tệp kê khai của trình kết nối và xác nhận rằng dự án Apps Script của bạn được định cấu hình để hiển thị tệp kê khai appsscript.json trong trình chỉnh sửa.

Xem tài liệu tham khảo về tệp kê khai Trình kết nối cộng đồng để biết thêm thông tin.

dataStudio

  1. description sẽ cung cấp thông tin và hướng dẫn để hiểu rõ cơ bản về trình kết nối cũng như cách sử dụng trình kết nối đó. Chúng tôi sẽ từ chối trình kết nối có nội dung mô tả không rõ ràng và không đầy đủ.
  2. addOnUrl phải là một trang được lưu trữ riêng về trình kết nối, tốt nhất là được lưu trữ trên miền của riêng bạn. Trang phải bao gồm những nội dung sau:
    • Chính sách quyền riêng tư và Điều khoản sử dụng hoặc một đường liên kết đến nội dung này, trên cùng một miền với addOnUrl.
    • Thông tin chi tiết mà người dùng cần biết để sử dụng trình kết nối của bạn.
    • Đường liên kết đăng ký, nếu bắt buộc phải có tài khoản để sử dụng trình kết nối của bạn.
    • Nội dung tốt nhất được lưu trữ trên miền của bạn. Không được phép lưu trữ trên https://sites.google.com/.
    • Xem các trang ví dụ về các đối tác hiện tại: Phễu, Supermetrics, CallRail.
  3. supportUrl phải là một trang được lưu trữ để nhận hỗ trợ cho trình kết nối của bạn. Không được sử dụng đường liên kết gửi email hoặc gửi thư.
  4. logoUrl phải trỏ đến một hình ảnh tĩnh được lưu trữ thuộc quyền kiểm soát của bạn. Bạn không thể sử dụng hình ảnh do các dịch vụ của Google phân phát trên các miền như *.gstatic.com, *.ggpht.com, *.google.com, *.googleusercontent.com. Việc sử dụng Google Cloud Storage để phân phát hình ảnh từ miền *.googleapis.com được chấp nhận và bạn nên sử dụng dịch vụ lưu trữ này.
    • Trình kết nối có biểu tượng động sẽ bị từ chối. Sử dụng ảnh tĩnh.
    • Bạn nên sử dụng hình ảnh có kích thước tối thiểu là 48x48 pixel.
    • Tránh sử dụng hình ảnh chỉ có văn bản khó đọc khi giảm kích thước xuống 48x48 pixel.
  5. Điền tất cả nguồn mà trình kết nối của bạn kết nối vào thuộc tính sources . Xem Tài liệu tham khảo về Nguồn trong tệp kê khai để biết thông tin chi tiết.
    • Bạn có thể xem danh sách các nguồn hiện có tại Kho lưu trữ sổ đăng ký dữ liệu. Nếu nguồn mà bạn đang kết nối không tồn tại trong kho lưu trữ, hãy gửi yêu cầu kéo đến Kho lưu trữ sổ đăng ký dữ liệu để thêm nguồn. Trình kết nối của bạn sẽ không vượt qua được quá trình xem xét nếu các nguồn trong tệp kê khai của bạn không tồn tại trong kho lưu trữ.
    • Đây là siêu dữ liệu bổ sung cho trình kết nối sẽ được lập chỉ mục cho tính năng tìm kiếm trong thư viện. Trình kết nối của bạn sẽ hiển thị trong kết quả tìm kiếm khi người dùng tìm kiếm một nguồn cụ thể trong thư viện.
  6. Cung cấp giá trị cho shortDescription, authType, feeType, privacyPolicyUrl và termsOfServiceUrl.
  7. name sẽ trực tiếp thể hiện mục đích của trình kết nối. Một tên rõ ràng sẽ giúp người dùng xác định xem trình kết nối của bạn có đáp ứng nhu cầu của họ hay không. Tránh sử dụng từ trình kết nối trong tên vì người dùng đã biết rằng họ đang xem trình kết nối.
    • Đừng sử dụng các ký tự đặc biệt hoặc không hiển thị nhằm thu hút sự chú ý hoặc có khả năng thay đổi vị trí của trình kết nối.
  8. Đừng sử dụng tên viết tắt cho Looker Studio ở bất cứ đâu trong tệp kê khai (ví dụ: GDS, DS, v.v.).
  9. Không được phép sử dụng biểu tượng cảm xúc trong mọi trường tệp kê khai (description, shortDescription, name, v.v.). Nhìn chung, đừng dùng các ký tự đặc biệt hoặc không hiển thị để thu hút sự chú ý đến trình kết nối của bạn.
  10. Nếu trình kết nối của bạn có giản đồ cố định, hãy tạo mẫu báo cáo cho trình kết nối và thêm giản đồ đó vào tệp kê khai. Bật tính năng Chia sẻ bằng đường liên kết cho báo cáo.

urlFetchWhitelist

  1. Giới hạn số lượng điểm cuối do UrlFetchApp gọi ở các điểm cuối thực sự cần thiết cho chức năng của trình kết nối. Thêm thuộc tính urlFetchWhitelist vào cấp gốc của tệp kê khai. Xem tài liệu tham khảo về urlFetchthêm để biết thêm thông tin.
    • Bao gồm tất cả các điểm cuối được dùng với dịch vụ UrlFetchApp.
    • Nếu trình kết nối của bạn không tìm nạp tài nguyên bằng dịch vụ UrlFetchApp, hãy đặt urlFetchWhitelist thành danh sách trống [].
    • Nếu trình kết nối của bạn không kết nối với một nhóm các điểm cuối cố định hoặc tiền tố điểm cuối thay đổi, hãy bỏ qua thuộc tính urlFetchWhitelist và cung cấp thông tin chi tiết trong trường biểu mẫu Ngoại lệ đối với urlFetchScore khi gửi yêu cầu xem xét.

oauthScopes

  1. Thiết lập phạm vi OAuth rõ ràng trong tệp kê khai. Các trình kết nối không có phạm vi OAuth rõ ràng sẽ bị từ chối.

Trình kết nối

  1. Nếu người dùng cần có tài khoản để sử dụng trình kết nối, hãy đảm bảo trình kết nối description hoặc đường liên kết addOnUrl cung cấp hướng dẫn để giúp người dùng tạo trình kết nối.
  2. Trình kết nối của bạn không được ở trạng thái chưa hoàn tất hoặc đang thử nghiệm. Bạn phải xuất bản một trình kết nối hoàn chỉnh và đang hoạt động. Bạn luôn có thể cập nhật trình kết nối của mình nhưng việc triển khai phiên bản chính thức được phát hành cho người dùng phải được kiểm thử và hoàn thiện tính năng.
  3. Cung cấp thông báo lỗi có ý nghĩa và có thể xử lý cho người dùng khi người dùng gặp phải lỗi nội bộ của Trình kết nối. Điều này bao gồm cả trường hợp người dùng cung cấp dữ liệu đầu vào không hợp lệ/trống trong cấu hình.
  4. shortDescription, description, đường liên kết addOnUrl, đường liên kết supportUrl và trang OAuth (nếu có) không được có lỗi chính tả và ngữ pháp.
  5. shortDescription không được chứa URL.
  6. Sử dụng các phương thức xác thực do getAuthType() cung cấp. Không yêu cầu thông tin xác thực qua getConfig().
  7. Hoàn tất quy trình Xác minh ứng dụng OAuth. Quy trình xác minh là bắt buộc đối với tất cả các trình kết nối, bất kể phương thức xác thực trong getAuthType() là gì. Quy trình xác minh này là một quy trình khác với quy trình xem xét trình kết nối và do một nhóm riêng, không phải Looker Studio sẽ xử lý. Hãy tham khảo phần Câu hỏi thường gặp về quy trình Xác minh API OAuth để biết thêm thông tin. Trình kết nối của bạn sẽ bị từ chối nếu quy trình Xác minh ứng dụng OAuth chưa hoàn tất.
  8. Đảm bảo bạn tuân thủ Điều khoản dịch vụ của Thư viện Looker Studio (Người gửi).

Khi bạn đã đáp ứng tất cả các yêu cầu, hãy nhấp vào nút sau để yêu cầu xem xét trình kết nối của bạn:

Xuất bản Trình kết nối đối tác