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 dự án trình kết nối Apps Script của bạn. Tệp 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. Đây là thông tin bắt buộc để 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 có các thông tin sau:

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

AuthType

Giá trị cho loại phương thức xác thực có thể là một trong những giá trị sau:

Giá trị enum Mô tả
NONE Cho biết không cần xác thực cho 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 bạn có thể sử dụng trình kết nối 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ẽ cần phải trả phí để sử dụng trình kết nối.

Nguồn

Sources là một danh sách các enum cho các nguồn. 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 của chúng tôi. 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. Tên nguồn chỉ có thể chứa các ký tự viết hoa 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, hãy sử dụng giá trị của thuộc tính mã nhận dạng nguồn dữ liệu, ví dụ: GOOGLE_ANALYTICS.

Ví dụ về tệp kê khai 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/"
  ]
}