在 Google Workspace Marketplace SDK 中設定應用程式

本頁面說明如何使用 Google Workspace Marketplace SDK,在 Google Workspace Marketplace 中設定及管理應用程式。

如要開放使用應用程式,您必須在 Marketplace SDK 中設定應用程式。Marketplace SDK 是一套工具包,可讓您在 Marketplace 中建立及控管應用程式。您可以使用 Marketplace SDK 管理 Marketplace 設定,例如:

  • 應用程式是提供給特定 Google Workspace 機構 (私人應用程式),還是所有 Marketplace 使用者 (公開應用程式)
  • 可安裝您應用程式的 Marketplace 使用者類型
  • 應用程式整合的 Google Workspace 應用程式
  • 應用程式所需的 OAuth 範圍
  • 應用程式的建構者和維護者資訊

無論您是私下或公開發布應用程式,都必須使用 Marketplace SDK 在 Marketplace 上管理應用程式。

啟用 Marketplace SDK

如果您尚未啟用 Marketplace SDK,請在 Google Cloud 專案中啟用該 SDK。

在 Google Cloud 控制台中開啟 Cloud 專案

如果尚未開啟,請開啟您打算用於這個範例的 Cloud 專案:

  1. 前往 Google Cloud 控制台的「選取專案」頁面。

    選取 Cloud 專案

  2. 選取要使用的 Google Cloud 專案。或者,按一下「建立專案」,然後按照畫面上的指示操作。建立 Google Cloud 專案後,您可能需要為專案啟用計費功能

開啟 Marketplace SDK

使用 Google API 前,請先在 Google Cloud 專案中啟用這些 API。您可以在單一 Google Cloud 專案中啟用一或多個 API。
  • 在 Google Cloud 控制台中啟用 Google Workspace Marketplace SDK。

    啟用 SDK

決定應用程式的設定

下文說明 Marketplace SDK「應用程式設定」頁面提供的設定。

選擇哪些人可以查看及安裝您的應用程式

設定應用程式時,您可以使用下列設定指定可存取應用程式的使用者:

  • 應用程式顯示設定:如果您要在 Google Workspace 機構中發布應用程式,請選擇應用程式資訊是否要設為不公開、僅供機構內使用者查看,或是開放給所有 Google Workspace 使用者。
  • 安裝設定:應用程式是否只能由 Google Workspace 管理員安裝。

無論您在應用程式資訊中指定哪些設定,Google Workspace 機構的使用者都可能無法根據管理員設定,探索、安裝或使用您的應用程式。管理員可以透過下列方式影響應用程式的適用情形:

  • 控管使用者能否在 Marketplace 中查看應用程式,以及能否代表使用者安裝應用程式。
  • 使用許可清單管理及精選機構的應用程式。如果您為使用許可清單的機構開發應用程式,請洽詢管理員,瞭解如何將應用程式加入許可清單。
  • 關閉特定 Google Workspace 應用程式,例如移除 Google Chat、Google Chat 應用程式或兩者的存取權。在這些情況下,使用者無法從 Marketplace 安裝您的應用程式。

如要瞭解管理員如何管理 Marketplace 存取權,請參閱 Marketplace 管理員說明文件

應用程式顯示設定

如果您使用 Google Workspace 帳戶 (公司或學校機構建立的帳戶),系統會顯示「應用程式顯示設定」選項。如果您使用個人帳戶 (結尾為「@gmail.com」的帳戶),只能公開發布。

  • 公開:網域外部使用者可以找到並安裝應用程式。如果選擇公開顯示,Google 會先審查並核准您的應用程式資訊,再發布。
  • 私人:只有網域內的使用者可以尋找及安裝您的應用程式。

如果選擇以「未發布」形式發布,應用程式資訊就不會顯示在瀏覽或搜尋結果中。使用者只能透過直接網址存取應用程式的商店頁面。

如要限制應用程式的適用國家/地區,請在建立商店資訊時,於「發行」部分進行設定。

應用程式安裝設定

「安裝設定」選項會決定使用者或 Google Workspace 管理員是否能從 Marketplace 的商店資訊頁面安裝您的應用程式。

  • 個人 + 管理員安裝 (預設):使用者可自行安裝應用程式,管理員也能為網域、機構單位或使用者群組安裝應用程式。即使已啟用個別安裝功能,使用者網域政策仍可能禁止使用者安裝應用程式。
  • 僅限管理員安裝:只有管理員才能為網域、機構單位或使用者群組安裝應用程式。只有管理員和未登入 Google 帳戶的使用者,才能在 Google Workspace Marketplace 搜尋結果中看到您的應用程式。如果應用程式需要安裝網域,請選擇這個選項。

常見的安裝和瀏覽權限設定

下表摘要列出一些常見的應用程式設定選項,包括安裝和顯示方式:

目標應用程式使用者 「應用程式顯示設定」設定 應用程式安裝設定 哪些人可以安裝我的應用程式? 誰可以使用我的應用程式?
為 Google Workspace 機構建構的應用程式  
貴機構的特定使用者 「私人」和「不公開」 個人 + 管理員安裝 如果獲得許可,貴機構中知道應用程式資訊網址的所有人。 如果獲得許可,貴機構中知道應用程式資訊網址的所有人。
貴機構 私人 個人 + 管理員安裝 如果獲得許可,貴機構中的任何使用者都能存取。 如果獲得許可,貴機構中的任何使用者都能存取。
貴機構 私人 僅限管理員 管理員 由管理員安裝應用程式的使用者。
適用於特定 Google Workspace 機構外部使用者可存取的應用程式  
Google Workspace 機構中的使用者 公開 僅限管理員 管理員 由管理員安裝應用程式的使用者。
所有 Google Workspace 使用者 公開 個人 + 管理員安裝
  • 將 Google Workspace 應用程式用於個人用途的使用者。
  • 如果獲得許可,Google Workspace 機構中的使用者。
  • 將 Google Workspace 應用程式用於個人用途的使用者。
  • 如果獲得許可,Google Workspace 機構中的使用者。

找出應用程式與 Google Workspace 應用程式的整合方式

選擇應用程式或外掛程式要搭配使用的 Google Workspace 服務,例如 Google Workspace 外掛程式或 Google Chat 應用程式。您必須至少選擇一個選項。在某些情況下,您可以在應用程式資訊中加入多個應用程式整合。請參閱「一併列出應用程式整合功能」。

視選擇的應用程式整合方式而定,您可能需要提供更多資訊,並在 Google Cloud 專案中啟用相關 API。下表說明各項額外設定:

Google Workspace 外掛程式

如要發布 Google Workspace 外掛程式,您必須提供外掛程式的部署 ID。

如要在 Apps Script 中查看部署作業 ID,請按照下列步驟操作:

  1. 在 Apps Script 編輯器中開啟 Google Workspace 外掛程式。
  2. 依序點選「部署」>「管理部署作業」
  3. 按一下部署作業 ID 下方的「複製」

如要找出 HTTP 外掛程式的部署 ID,請按照下列步驟操作:

  1. 在「Google Workspace 外掛程式」下方的「應用程式設定」頁面中,依序點選「HTTP 或其他部署作業」> 「選取部署作業」
  2. 選取要發布的部署作業。
  3. 按一下「選取」

編輯器外掛程式 (文件、試算表、簡報、表單)

如要發布編輯器外掛程式,請提供要發布的專案指令碼 ID版本

如要找出專案指令碼 ID,請按照下列步驟操作:

  1. 在 Apps Script 編輯器中開啟外掛程式。
  2. 按一下左側的「專案設定」
  3. 在「ID」下方,複製指令碼 ID。

如要查看版本,請按照下列步驟操作:

  1. 在 Apps Script 編輯器中開啟外掛程式。
  2. 依序按一下右上方的「部署」> 「管理部署」
  3. 版本號碼位於「設定」下方。

Google Chat 應用程式

如要發布 互動式 Google Chat 應用程式,請參閱下列說明文件:

  • 如果您將 Chat 應用程式建構為外掛程式,則必須在 Chat API 中設定外掛程式設定。如需步驟,請參閱 Google Workspace 外掛程式說明文件中的「設定 Chat 應用程式」。
  • 如果您使用互動事件建立 Chat 應用程式,則必須在 Chat API 中設定互動事件設定。如需相關步驟,請參閱 Chat API 說明文件中的「接收及回應互動事件」。
  • 如果您使用 AppSheet 的自動設定功能建構 Chat 應用程式,請按照 AppSheet 說明文件中的步驟發布 Chat 應用程式,請參閱「使用自動設定功能分享 Chat 應用程式」。

Google 雲端硬碟應用程式

如要發布雲端硬碟應用程式,您必須啟用並設定 Google Drive API

網頁應用程式

如要發布網頁應用程式,請提供通用導覽網址,也就是從 Google 應用程式選單 指向網頁應用程式的網址。網路應用程式必須處於正式版狀態,且功能完備。

填寫商店資訊頁面時,您必須提供大小為 96x96 和 48x48 像素的其他圖示。

如果您是在 Apps Script 中建構網路應用程式,請按照下列步驟取得通用導覽網址:

  1. 在 Apps Script 編輯器中開啟 Google Workspace 外掛程式。
  2. 依序點按「Deploy」(部署) > 「New deployment」(新部署作業)
  3. 在「選取類型」下方,按一下「網頁應用程式」
  4. 填寫選項,然後按一下「部署」
  5. 按一下「複製」

指定應用程式所需的存取層級

在「OAuth 範圍」下方,提供應用程式所需的 OAuth 2.0 範圍完整清單。您在此輸入的 OAuth 範圍應與OAuth 同意畫面中顯示的範圍相符,且與 Apps Script 資訊清單 (如適用) 中的範圍相符。

如果您加入多個應用程式整合,請務必將每個應用程式的範圍新增至 Marketplace SDK 應用程式設定頁面和 OAuth 同意畫面。

請盡量使用範圍最小的權限 (例如,如果只需要唯讀權限,請勿加入完整的 Google 雲端硬碟權限)。

如為 Apps Script 專案,請參閱「授權範圍」一文瞭解詳情。

提供應用程式開發人員的相關資訊

在「開發人員資訊」下方,填寫聯絡資訊和其他詳細資料。 這些欄位會顯示在應用程式的商店資訊頁面。

欄位
交易者狀態

根據消費者保護法,我們必須向歐洲經濟區 (EEA) 境內的消費者告知,這個市集上的商家是交易商還是非交易商

  • 交易商:交易商是指基於與交易、業務、技術或專業相關目的行事的人,或是以交易商的名義或代表交易商行事的人。
  • 非交易商:非交易商 (消費者) 是指基於非專業目的行事的個人。

如果未指定,應用程式的商店資訊頁面會顯示「交易人狀態未指定」。

開發人員名稱 應用程式作者的顯示名稱。如果您是交易者,請提供商業名稱或法定全名。
開發人員郵寄地址

交易者必須提供這項資訊。不會向非交易商收取。

商家的所在位置。請輸入可聯繫到您的有效郵寄地址。

開發人員網站網址 說明您 (或貴機構) 是開發人員的網站。
開發人員電子郵件

用來做為聯絡窗口的電子郵件地址。應用程式資訊中未包含這項資訊。請務必提供最新的電子郵件地址,因為系統會使用這個地址:

  • Google 需要與開發人員聯絡時 (例如在應用程式審查程序中)。
  • 如果商店資訊頁面未提供「回報問題」網址,請透過編輯器外掛程式傳送意見回饋。
應用程式網站網址 (選用步驟) 進一步說明應用程式的網站。

在 Marketplace SDK 中儲存應用程式設定

使用上一節的資訊,在 Marketplace SDK 中儲存應用程式設定:

  1. 前往 Google Cloud 控制台的 Marketplace SDK「應用程式設定」頁面:

    前往 Marketplace SDK 設定頁面

  2. 根據前一個部分的判斷結果,填寫各個部分。

  3. 按一下「儲存草稿」

  4. (選用) 您可以在 Google Analytics取得應用程式使用情況的分析資料。如要這麼做,請在 Marketplace SDK 中新增 Google Analytics ID

    1. 前往「數據分析」分頁。
    2. 輸入 Google Analytics ID。
    3. 按一下 [儲存]

疑難排解

本節說明您可能會遇到的常見問題。

將應用程式發布至 Marketplace 時缺少必要權限

您無法在 Marketplace 上發布應用程式,因為嘗試在 Marketplace SDK 的「應用程式設定」頁面設定應用程式時,會失敗並顯示下列錯誤訊息:

You are missing at least one of the following required permissions: Project workspacemarketplace.appconfiguration.view / workspacemarketplace.appconfiguration.update

啟用 Marketplace SDK API,並使用 EditorOwner 以外的 IAM 角色時,就會發生這個錯誤。

如要解決這個錯誤,請採用下列任一解決方案:

  • 請專案擁有者將roles/appmetadata.workspaceMarketplaceAppConfigurationAdmin角色指派給缺少權限的帳戶,允許該帳戶在 Marketplace SDK 中設定及管理應用程式。

  • 請專案擁有者透過 Google Cloud 控制台的「IAM & Admin」(IAM 與管理) >「Roles」(角色) 頁面,將缺少的權限新增至自訂角色。接著,將自訂角色指派給缺少權限的帳戶。

  • 您可以使用原始 roles/editorroles/owner 發布應用程式。 不過,安全地使用 IAM 文件認為這是錯誤的做法,因為您無法輕鬆限制專案中其他資源的編輯權限。