資訊清單參考資料

資訊清單 (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」AuthType。
feeType list(FeeType) 指出連接器的費用類型。請參閱下方的「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 指出使用者必須付費才能使用連接器。

來源

「來源」是來源的列舉清單。如要查看現有來源清單，請前往資料登錄存放區。如果連結的來源不存在於存放區，請傳送提取要求至資料登錄存放區，以新增來源。來源名稱只能包含大寫字元和底線 (例如 Google Analytics 為 GOOGLE_ANALYTICS)。在社群連結器資訊清單中，請使用資料來源 ID 屬性的 value，例如 GOOGLE_ANALYTICS。

社群連接器的資訊清單範例

以下是完成的資訊清單範例：

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/"
  ]
}