資訊清單參考資料

資訊清單 (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 的報表 ID 要做為範本的 Studio 報表。請參閱提供 報表範本
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 的 資源 (例如: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/"
  ]
}