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

Xem Tổng quan về việc xuất bản để hiểu rõ những lợi ích và mức độ cam kết cần thiết khi phát hành một trình kết nối. Để xuất bản một 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 để xem xét, hãy hoàn tất các bước sau trong Apps Script:

  1. Chia sẻ quyền xem dự án Apps Script của bạn với những người sau:
  2. Tạo một hoạt động triển khai có tên là Production và cập nhật hoạt động triển khai Production lên phiên bản mã mà bạn dự định xuất bản.
  3. Xác nhận rằng bạn đã cập nhật việc triển khai Production lên phiên bản mã mà bạn muốn được xem xét.
  4. Xác nhận rằng tệp kê khai xuất hiện trong Apps Script. Ở bên trái, hãy nhấp vào 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 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 cần cung cấp thông tin và hướng dẫn để người dùng hiểu rõ về trình kết nối và cách sử dụng trình kết nối này. Những trình kết nối có nội dung mô tả mơ hồ và không đầy đủ sẽ bị từ chối.
  2. addOnUrl phải là một trang lưu trữ chuyên biệt về trình kết nối của bạn, tốt nhất là được lưu trữ trên miền của riêng bạn. Trang này phải có các thông tin sau:
    • Chính sách quyền riêng tư và Điều khoản sử dụng hoặc đườ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ạn cần có tài khoản để sử dụng trình kết nối.
    • Nội dung được lưu trữ tốt nhất 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ụ của đối tác hiện tại: Funnel, Supermetrics, CallRail.
  3. supportUrl phải là một trang được lưu trữ để nhận được sự hỗ trợ cho trình kết nối của bạn. Đây không thể là email hoặc đường liên kết mailto.
  4. logoUrl phải trỏ đến một hình ảnh tĩnh do bạn kiểm soát. 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. Bạn có thể sử dụng Google Cloud Storage để phân phát hình ảnh từ miền *.googleapis.com và đây là một lựa chọn lưu trữ được đề xuất.
    • Trình kết nối có biểu tượng động sẽ bị từ chối. Sử dụng hình ả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 được thu nhỏ xuống 48x48 pixel.
  5. Điền vào thuộc tính sources bằng tất cả các nguồn mà trình kết nối của bạn kết nối. Hãy xem Nguồn trong tài liệu tham khảo về tệp kê khai để biết thông tin chi tiết.
    • Bạn có thể xem danh sách 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 có 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 quy trình xem xét nếu các nguồn trong tệp kê khai không có 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 của kết quả tìm kiếm trong thư viện. Trình kết nối của bạn sẽ xuất hiện 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 phải thể hiện trực tiếp mục đích của trình kết nối. 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 dùng từ trình kết nối trong tên vì người dùng đã biết họ đang xem một trình kết nối.
    • Không thêm các ký tự đặc biệt hoặc ký tự không nhìn thấy được với mục đích thu hút sự chú ý hoặc có khả năng làm thay đổi vị trí của giắc cắm.
  8. Không sử dụng tên viết tắt cho Data Studio ở bất kỳ vị trí nào trong tệp kê khai (ví dụ: GDS, DS, v.v.).
  9. Bạn không được dùng biểu tượng cảm xúc trong bất kỳ trường nào của tệp kê khai (description, shortDescription, name, v.v.). Nhìn chung, bạn không nên thêm các ký tự đặc biệt hoặc ký tự không nhìn thấy được với mục đích thu hút sự chú ý đến đầu nối của mình.
  10. Nếu trình kết nối của bạn có một giản đồ cố định, hãy tạo một mẫu báo cáo cho trình kết nối đó rồi thêm vào tệp kê khai. Bật chế độ 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 mà UrlFetchApp gọi đến những điểm cuối hoàn toàn cần thiết cho chức năng của giắc cắm. Thêm thuộc tính urlFetchWhitelist vào cấp cơ sở của tệp kê khai. Xem tài liệu tham khảo về urlFetchWhitelist để biết thêm thông tin.
    • Đưa 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 đ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ệ cho urlFetchWhitelist khi gửi yêu cầu đánh giá.

oauthScopes

  1. Đặt phạm vi OAuth rõ ràng trong tệp kê khai. Những 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 rằng 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 tài khoản.
  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 beta. Bạn phải xuất bản một trình kết nối hoàn chỉnh và hoạt động bình thường. Bạn luôn có thể cập nhật trình kết nối nhưng bản triển khai chính thức được phát hành cho người dùng phải được kiểm thử và có đầy đủ 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 họ 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 thông tin đầu vào không hợp lệ/trống khi định 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 đăng nhập qua getConfig().
  7. Hoàn tất quy trình Xác minh ứng dụng OAuth. Bạn bắt buộc phải xác minh cho tất cả các trình kết nối, bất kể phương thức xác thực trong getAuthType(). Quy trình xác minh 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 biệt xử lý, không phải Data Studio. Hãy tham khảo 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 bạn chưa hoàn tất quy trình Xác minh ứng dụng khách OAuth.
  8. Đảm bảo bạn tuân thủ Điều khoản dịch vụ của Thư viện Data Studio (Người gửi).

Sau khi đá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