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 mà bạn cần để 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 thông tin sau:
| tên thuộc tính | Loại | Nội dung mô tả |
|---|---|---|
Bắt buộc (trong thuộc tính dataStudio)
|
||
name
|
string
|
Tên của trình kết nối. Giới hạn ở 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 cho trình kết nối của bạn. 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 dụng. Trang này sẽ 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 chứa 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)
|
Liên kết tới trang hỗ trợ để hỗ trợ trình kết nối này. Người dùng có thể báo cáo 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
|
Mô tả trình kết nối của bạn. 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. Người dùng có thể nhấp vào các đường liên kết. |
Không bắt buộc (trong tài sản 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 của bạn. Sử dụng phần này để mô tả ngắn gọn chức năng của trình kết nối. Người dùng có thể xem nội dung này khi họ 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ư dành cho trình kết nối / tổ chức 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 nhà phát triển. |
authType
|
list(AuthType)
|
Loại phương thức xác thực cho trình kết nối của bạn. Xem phần 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. Hãy xem phần 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 phần Nguồn ở bên dưới. |
templates
|
Object
|
Danh sách mẫu có thể sử dụng với trình kết nối này. Hệ thống chỉ hỗ trợ một mẫu mặc định, xác định mẫu này bằng cách đặt khoá default. Giá trị này phải là mã báo cáo cho báo cáo Looker
Studio sẽ được dùng làm mẫu. Xem hướng dẫn về phần 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
được tạo qua trình kết nối này hay không. Thuộc tính này là không bắt buộc và mặc định là false. Hãy xem bài viết Thông tin xác thực nguồn
dữ liệu để biết thêm thông tin chi tiết về thông tin đăng nhập của người xem.
|
useQueryConfig
|
boolean
|
KHÔNG DÙNG NỮA: Liệu trình kết nối này có trả về cấu hình truy vấn cho hàm "getData()" hay không. Thay vào đó, hãy sử dụng "advancedServices". |
advancedServices.data
|
boolean
|
Liệu trình kết nối này có trả về cấu hình truy vấn cho phương thức "getData()" hay không. Hãy xem các dịch vụ nâng cao. |
advancedServices.schema
|
boolean
|
Liệu trình kết nối này có trả về cấu hình truy vấn cho phương thức "getSchema()" hay không. Hãy xem các dịch vụ nâng cao. |
| Không bắt buộc (Tài sản cấp cơ sở) | ||
urlFetchWhitelist
|
list(string)
|
Danh sách các 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 đều 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 URL an toàn để 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 các giá trị sau:
| Giá trị enum | Nội dung mô tả |
|---|---|
NONE
|
Cho biết không cần phải 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ị cho loại phí có thể là bất kỳ giá trị nào sau đây:
| Giá trị enum | Nội dung mô tả |
|---|---|
FREE |
Cho biết bạn hoàn toàn miễn phí sử dụng trình kết nối. |
FREE_TRIAL |
Cho biết trình kết nối có tùy chọn dùng thử miễn phí. |
PAID |
Cho biết người dùng sẽ phải thanh toán để sử dụng trình kết nối. |
Nguồn
Nguồn là danh sách các giá trị enum của 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 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. Tên nguồn chỉ được chứa 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 của Trình kết nối cộng đồng, hãy sử dụng value của thuộc tính mã nhận dạng nguồn dữ liệu, ví dụ: GOOGLE_ANALYTICS.
Tệp kê khai mẫu dành 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: