合作夥伴連接器需求

請參閱發布總覽，瞭解發布連接器的好處和必要投入程度。如要發布合作夥伴連接器，連接器必須符合下列所有規定。

Apps Script

將連結器送審前，請先在 Apps Script 中完成下列操作：

  1. 分享檢視權限給下列對象：
  2. 建立名為 Production 的部署作業，並將 Production 部署作業更新為要發布的程式碼版本。
  3. 確認您已將 Production 部署作業更新為要審查的版本代碼。
  4. 確認應用程式指令碼中顯示資訊清單檔案。按一下左側的「專案設定」圖示 。選取「在編輯器中顯示『appsscript.json』資訊清單檔案」核取方塊。

資訊清單

在連結器的資訊清單中加入下列內容，並確認 Apps Script 專案已設定為在編輯器中顯示 appsscript.json 資訊清單檔案。

如需更多資訊，請參閱社群連接器資訊清單參考資料。

dataStudio

  1. description 應提供資訊和操作說明，讓使用者基本瞭解連接器和使用方式。如果連接器的說明含糊不清或不完整，將遭到拒絕。
  2. addOnUrl 應為連接器的專屬代管網頁，最好是代管於您自己的網域。該頁面必須包含下列資訊：
    • addOnUrl 網域上的《隱私權政策》和《使用條款》，或這類內容的連結。
    • 使用者需要瞭解的詳細資料，才能使用連接器。
    • 註冊連結 (如果使用連接器時需要帳戶)。
    • 最好是託管在您的網域。不允許在「https://sites.google.com/」上代管。
    • 請參閱現有合作夥伴的範例頁面：Funnel、Supermetrics、 CallRail。
  3. supportUrl 應為代管頁面，以便取得連接器支援。不得為電子郵件或 mailto 連結。
  4. logoUrl 應指向您控管的靜態圖片。您無法在 *.gstatic.com、*.ggpht.com、*.google.com、*.googleusercontent.com 等網域上使用 Google 服務提供的圖片。使用 Google Cloud Storage 從 *.googleapis.com 網域提供圖片是可接受的做法，也是建議的代管選項。
    • 如果連接器含有動畫圖示，將會遭到拒絕。使用靜態圖片。
    • 建議使用至少 48x48 像素的圖片。
    • 請避免使用只有文字的圖片，因為縮小至 48x48 像素時，文字會難以閱讀。
  5. 在 sources 屬性中填入連接器連線的所有來源。詳情請參閱資訊清單參考資料中的來源。
    • 您可以在資料登錄存放區中查看現有來源清單。如果存放區中沒有您要連結的來源，請向資料登錄存放區傳送提取要求，新增來源。如果資訊清單中的來源不存在於存放區，連接器將無法通過審查程序。
    • 這是連接器的額外中繼資料，會編入索引，供藝廊的搜尋結果功能使用。使用者在資源庫中搜尋特定來源時，搜尋結果會顯示您的連結器。
  6. 請提供 shortDescription、authType、feeType、privacyPolicyUrl 和 termsOfServiceUrl 的值。
  7. name 應直接代表連接器的用途。清楚的名稱有助於使用者判斷連接器是否符合需求。請避免在名稱中使用「連接器」一詞，因為使用者已知道自己正在查看連接器。
    • 請勿加入特殊或不可見字元，藉此吸引注意或改變連接器位置。
  8. 請勿在資訊清單中使用數據分析的簡稱 (例如 GDS、DS 等)。
  9. 任何資訊清單欄位 (description、shortDescription、name 等) 均不得使用表情符號。一般而言，請勿加入特殊或不可見字元，藉此吸引對連接器的注意。
  10. 如果連接器有固定結構化定義，請為連接器建立報表範本，並將範本新增至資訊清單。啟用報表的「透過連結共用」功能。

urlFetchWhitelist

  1. 將 UrlFetchApp 呼叫的端點數量限制在連接器功能絕對需要的範圍內。在資訊清單的根層級新增 urlFetchWhitelist 屬性。詳情請參閱 urlFetchWhitelist 參考資料。
    • 請列出 UrlFetchApp 服務使用的所有端點。
    • 如果連接器未使用 UrlFetchApp 服務擷取資源，請將 urlFetchWhitelist 設為空白清單 []。
    • 如果連接器未連線至一組固定端點，或端點前置字元有所不同，請省略 urlFetchWhitelist 屬性，並在提交審查要求時，於「Exception for urlFetchWhitelist」表單欄位中提供詳細資料。

oauthScopes

  1. 在資訊清單中設定明確的 OAuth 範圍。如果連接器沒有明確的 OAuth 範圍，就會遭到拒絕。

連接器

  1. 如果使用者需要帳戶才能使用連接器，請確認連接器description或addOnUrl連結提供相關操作說明，協助使用者建立帳戶。
  2. 連接器不得處於未完成或 Beta 版狀態。您必須發布完整且可正常運作的連結器。您可以隨時更新連接器，但發布給使用者的正式版部署作業應經過測試，且功能完整。
  3. 當使用者遇到連接器內部錯誤時，請提供有意義且實用的錯誤訊息。包括使用者在設定時提供無效/空白輸入內容的情況。
  4. shortDescription、description、addOnUrl 連結、supportUrl 連結和 OAuth 頁面 (如適用) 不應有拼字和文法錯誤。
  5. shortDescription 不得包含網址。
  6. 使用 getAuthType() 提供的驗證方法。請勿透過 getConfig() 要求憑證。
  7. 完成 OAuth 用戶端驗證程序。無論 getAuthType() 中的驗證方法為何，所有連接器都必須通過驗證。驗證程序與連結器審查程序不同，且由另一個團隊負責處理，而非數據分析。詳情請參閱 OAuth API 驗證常見問題。如果未完成 OAuth 用戶端驗證程序，系統會拒絕您的連結器。
    • 在 OAuth 驗證程序中，新增連接器所需的 OAuth 範圍，做為 OAuth 同意畫面設定的一部分。如果無法新增所有必要範圍，您可能會通過 OAuth 驗證程序，但連接器仍會顯示未經驗證的應用程式畫面。這會導致合作夥伴連接器驗證程序失敗。
      通過 OAuth 驗證程序後，請使用新帳戶授權及測試連接器，確保使用者不會看到「未經驗證的應用程式」畫面。
  8. 請務必遵守數據分析資料庫服務條款 (提交者)。

符合所有規定後，請按一下下列按鈕，要求審查連接器：

發布合作夥伴連接器