Tài liệu tham khảo về tệp kê khai

Tệp kê khai (appsscript.json) là một tệp JSON trong trình kết nối Apps Script của bạn dự án. Trang này chứa một số thông tin nhất định về Trình kết nối cộng đồng của bạn việc cần làm để triển khai và sử dụng trình kết nối trong Looker Studio. Đọc thêm về tệp kê khai trong Apps Script.

Tệp kê khai của bạn phải chứa những thông tin sau:

tên thuộc tính Loại Mô tả
Bắt buộc (trong tài sản dataStudio)
name string Tên trình kết nối của bạn.
Tối đa 28 ký tự
company string Tên của tổ chức hoặc nhà phát triển.
companyUrl string (link) Đường liên kết đến trang web của tổ chức hoặc nhà phát triển.
logoUrl string (image link) URL đến biểu tượng của trình kết nối.
Kích thước bắt buộc là 40 px x 40 px.
addOnUrl string (link) Liên kết đến một trang "Tìm hiểu thêm" chuyên biệt sẽ giải thích những gì trình kết nối thực hiện và dữ liệu mà nó truy cập. Bạn nên lưu trữ và duy trì .
Trang này phải chứa hoặc liên kết đến Điều khoản dịch vụ và Quyền riêng tư của bạn Chính sách.
supportUrl string (link) Đường liên kết đến trang hỗ trợ để hỗ trợ trình kết nối này. Người dùng có thể báo cáo sự cố xảy ra với trình kết nối của bạn tại liên kết này. Bạn sẽ lưu trữ và duy trì trang này.
description string Nội dung mô tả về trình kết nối của bạn.
Người dùng sẽ thấy nội dung mô tả đầy đủ trong trình kết nối của bạn . Người dùng có thể nhấp vào các đường liên kết.
Không bắt buộc (trong thuộc tính dataStudio)
shortDescription string Giới hạn: 114 ký tự. Nếu trình kết nối của bạn đã được xuất bản, mô tả ngắn này sẽ hiển thị trong thẻ thư viện cho trình kết nối. Hãy sử dụng chức năng này để mô tả ngắn gọn chức năng của trình kết nối. Người dùng sẽ có thể xem thẻ này khi họ duyệt qua các trình kết nối trong thư viện của bạn.
privacyPolicyUrl string (link) Đường liên kết đến Chính sách quyền riêng tư dành cho trình kết nối / tổ chức của nhà phát triển.
termsOfServiceUrl string (link) Đường liên kết đến Điều khoản dịch vụ dành cho trình kết nối / tổ chức của nhà phát triển.
authType list(AuthType) Loại phương pháp xác thực cho trình kết nối của bạn. Xem AuthType bên dưới.
feeType list(FeeType) Cho biết loại phí cho trình kết nối của bạn. Xem FeeType bên dưới.
sources list(Sources) Danh sách nguồn dữ liệu mà trình kết nối này có thể kết nối. Hãy xem phần Nguồn bên dưới.
templates Object Danh sách mẫu có thể được sử dụng với trình kết nối này. Chỉ một quy tắc mặc định mẫu được hỗ trợ, được xác định bằng cách đặt giá trị Khoá default. Giá trị này phải là mã báo cáo cho Looker Báo cáo Studio sẽ được dùng làm mẫu. Xem hướng dẫn về Cung cấp mẫu báo cáo.
forceViewersCredentials boolean Liệu có bắt buộc phải cung cấp thông tin đăng nhập của người xem cho các nguồn dữ liệu hay không được tạo từ trình kết nối này. Thuộc tính này là không bắt buộc và mặc định là false. Xem phần Dữ liệu thông tin đăng nhập vào nguồn để biết thêm thông tin về thông tin đăng nhập của người xem.
useQueryConfig boolean KHÔNG DÙNG NỮA: Trình kết nối này có trả về cấu hình truy vấn cho hay không `getData()`. Thay vào đó, hãy sử dụng "advancedServices".
advancedServices.data boolean Trình kết nối này có trả về cấu hình truy vấn cho hay không `getData()`. Xem phần nâng cao luôn miễn phí.
advancedServices.schema boolean Trình kết nối này có trả về cấu hình truy vấn cho hay không `getSchema()`. Xem phần nâng cao luôn miễn phí.
Không bắt buộc (Thuộc tính cấp gốc)
urlFetchWhitelist list(string) Danh sách các tiền tố URL loại HTTPS mà trình kết nối của bạn sử dụng. Mọi điểm cuối URL phải khớp với một trong các tiền tố trong danh sách này. Điều này có thể giúp bảo vệ dữ liệu người dùng. Xem Danh sách an toàn URL để biết thêm chi tiết.

AuthType

Loại phương pháp xác thực có thể mang các giá trị sau đây:

Giá trị enum Mô tả
NONE Cho biết rằng không cần xác thực đối với trình kết nối.
OAUTH2 Cho biết trình kết nối sử dụng OAuth 2.0.
KEY Cho biết trình kết nối sử dụng khoá API.
USER_PASS Cho biết trình kết nối sử dụng tên người dùng/mật khẩu.
USER_TOKEN Cho biết trình kết nối sử dụng tên người dùng/mã thông báo.
PATH_USER_PASS Cho biết trình kết nối sử dụng đường dẫn/tên người dùng/mật khẩu.
PATH_KEY Cho biết trình kết nối sử dụng đường dẫn/khoá.

FeeType

Giá trị của loại phí có thể là bất kỳ giá trị nào sau đây:

Giá trị enum Mô tả
FREE Cho biết trình kết nối được sử dụng hoàn toàn miễn phí.
FREE_TRIAL Cho biết trình kết nối có lựa chọn dùng thử miễn phí.
PAID Cho biết người dùng sẽ phải trả phí để sử dụng trình kết nối.

Nguồn

Nguồn là danh sách enum cho nguồn. Bạn có thể xem danh sách hiện tại tại Kho lưu trữ sổ đăng ký dữ liệu của chúng tôi. 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 lấy dữ liệu đến Hệ thống đăng ký dữ liệu Kho lưu trữ để thêm nguồn. Tên nguồn chỉ có thể chứa chữ hoa ký tự và dấu gạch dưới (ví dụ: Google Analytics sẽ là GOOGLE_ANALYTICS). Trong tệp kê khai Trình kết nối cộng đồng của bạn, hãy sử dụng value của id nguồn dữ liệu thuộc tính, ví dụ: GOOGLE_ANALYTICS.

Tệp kê khai mẫu cho Trình kết nối cộng đồng

Sau đây là ví dụ về một tệp kê khai hoàn chỉnh:

data-studio/appsscript.json
{
  "dataStudio": {
    "name": "Nucleus by Hooli",
    "company": "Hooli Inc.",
    "companyUrl": "https://hooli.xyz",
    "logoUrl": "https://hooli.xyz/middle-out-optimized/nucleus/logo.png",
    "addonUrl": "https://hooli.xyz/data-studio-connector",
    "supportUrl": "https://hooli.xyz/data-studio-connector/support",
    "description": "Nucleus by Hooli connector lets you connect to your data in Data Studio using Nucleus middle out optimization. You will need an account on hooli.xyz to use this connector. Create your account at https://hooli.xyz/signup",
    "shortDescription": "Connect to your data using Nucleus middle out optimization",
    "privacyPolicyUrl": "https://hooli.xyz/privacy",
    "termsOfServiceUrl": "https://hooli.xyz/tos",
    "authType": ["NONE"],
    "feeType": ["PAID"],
    "sources": ["HOOLI_CHAT_LOG", "ENDFRAME_SERVER_STREAM", "RETINABYTE_USER_ANALYTICS"],
    "templates": {
      "default": "872223s89f5fdkjnd983kjf"
    }
  },
  "urlFetchWhitelist": [
    "https://api.hooli.xyz/",
    "https://hooli.xyz/"
  ]
}