資訊清單 (appsscript.json
) 是 Apps Script 連接器專案中的 JSON 檔案。其中包含在 Looker Studio 中部署和使用連接器時所需的社群連接器特定資訊。進一步瞭解 Apps Script 中的資訊清單。
資訊清單應包含下列資訊:
屬性名稱 | 類型 | 說明 |
---|---|---|
必填 (在 dataStudio 屬性下方)
|
||
name
|
string
|
連接器名稱。 上限為 28 個字元 |
company
|
string
|
機構或開發人員的名稱。 |
companyUrl
|
string (link)
|
機構或開發人員網站的連結。 |
logoUrl
|
string (image link)
|
連接器圖示的網址。 規定尺寸為 40 x 40 像素。 |
addOnUrl
|
string (link)
|
導向專屬「瞭解詳情」網頁的連結,可讓您瞭解連接器的功能及存取的資料。建議您代管及維護這個網頁。 這個頁面必須包含或連結至您的《服務條款》和《隱私權政策》。 |
supportUrl
|
string (link)
|
支援這個連接器的支援頁面連結。使用者應該可以透過這個連結回報與連接器的問題。建議您代管及維護這個網頁。 |
description
|
string
|
連接器的說明。 使用者會在您的連接器設定頁面中看到完整說明。連結可供點擊。 |
選填 (在 dataStudio 屬性下方)
|
||
shortDescription
|
string
|
限制:114 個字元。如果連接器發布,這項簡短說明就會顯示在連接器的圖庫資訊卡中。用來簡短說明連接器的功能。使用者瀏覽範本庫中的連接器時,即可看到這項內容。 |
privacyPolicyUrl
|
string (link)
|
連接器 / 開發人員機構《隱私權政策》的連結。 |
termsOfServiceUrl
|
string (link)
|
連接器 / 開發人員機構的《服務條款》連結。 |
authType
|
list(AuthType)
|
連接器的驗證方法類型。請參閱下方的 AuthType。 |
feeType
|
list(FeeType)
|
表示連接器的費用類型。請參閱下方的 FeeType。 |
sources
|
list(Sources)
|
這個連接器可連結的資料來源清單。請參閱下方的來源。 |
templates
|
Object
|
可搭配這個連接器使用的範本清單。您可以設定 default 金鑰來識別系統僅支援一個預設範本。這個值應為要做為範本的 Looker Studio 報表 ID。請參閱「提供報表範本」指南。
|
forceViewersCredentials
|
boolean
|
是否要針對從這個連接器建立的資料來源,強制使用檢視者的憑證。這是選用屬性,預設為 false 。如要進一步瞭解檢視者的憑證,請參閱資料來源憑證。 |
useQueryConfig
|
boolean
|
已淘汰:這個連接器是否要傳回「getData()」的查詢設定;請改用「advancedServices」。 |
advancedServices.data
|
boolean
|
這個連接器是否要傳回「getData()」的查詢設定。請參閱進階服務一節。 |
advancedServices.schema
|
boolean
|
這個連接器是否要傳回「getSchema()」的查詢設定。請參閱進階服務一節。 |
選填 (根層級資源) | ||
urlFetchWhitelist
|
list(string)
|
連接器使用的 HTTPS 網址前置字串清單。擷取到的網址端點都必須與這份清單中的其中一個前置字串相符。這麼做有助於保護使用者資料。詳情請參閱「將網址加入許可清單」。 |
AuthType
驗證方法類型的值可以是下列其中一個值:
列舉值 | 說明 |
---|---|
NONE
|
表示連接器不需要驗證。 |
OAUTH2 |
表示連接器使用 OAuth 2.0。 |
KEY |
表示連接器使用 API 金鑰。 |
USER_PASS |
指出連接器使用使用者名稱/密碼。 |
USER_TOKEN |
表示連接器使用使用者名稱/符記。 |
PATH_USER_PASS |
表示連接器使用路徑/使用者名稱/密碼。 |
PATH_KEY |
表示連接器使用路徑/金鑰。 |
FeeType
費用類型的值可以是下列任一值:
列舉值 | 說明 |
---|---|
FREE |
表示連接器完全免費使用。 |
FREE_TRIAL |
表示連接器提供免費試用選項。 |
PAID |
指出使用者必須付費才能使用連接器。 |
來源
來源是來源的列舉清單,您可以在我們的 Data Registry 存放區中查看現有的來源清單。如果您連結的來源不在存放區中,請傳送提取要求至 Data Registry 存放區以新增來源。來源名稱只能包含大寫字元和底線 (例如,Google Analytics (分析) 為 GOOGLE_ANALYTICS
)。在社群連接器資訊清單中,請使用資料來源 ID 屬性的 值,例如 GOOGLE_ANALYTICS
。
社群連接器的資訊清單範例
以下是已完成的資訊清單範例: