本页介绍了如何使用 Google Workspace Marketplace SDK 在 Google Workspace Marketplace 上配置和管理您的应用。
如需让应用可供使用,您需要在 Marketplace SDK 中进行设置。Marketplace SDK 是一个工具包,可让您在 Google Workspace Marketplace 上创建和控制应用。您可以使用 Marketplace SDK 管理 Marketplace 设置,例如:
- 您的应用是适用于特定 Google Workspace 组织(专用应用),还是可供所有 Marketplace 用户(公开应用)使用
- 可以安装您的应用的 Marketplace 用户类型
- 您的应用与哪些 Google Workspace 应用集成
- 应用所需的 OAuth 范围
- 有关应用的开发者和维护者的相关信息
无论您是不公开还是公开发布应用,都必须使用 Marketplace SDK 在 Marketplace 中管理应用。
启用 Marketplace SDK
在您的 Google Cloud 项目中启用 Google Workspace Marketplace SDK(如果您尚未执行此操作)。
在 Google Cloud 控制台中打开您的 Cloud 项目
如果尚未打开,请打开您打算用于此示例的 Cloud 项目:
- 在 Google Cloud 控制台中,前往选择项目页面。
- 选择您要使用的 Google Cloud 项目。或者,点击创建项目,然后按照屏幕上的说明操作。如果您创建的是 Google Cloud 项目,则可能需要为项目启用结算功能。
启用 Google Workspace Marketplace SDK
在使用 Google API 之前,您需要先在 Google Cloud 项目中启用这些 API。您可以在单个 Google Cloud 项目中启用一个或多个 API。在 Google Cloud 控制台中,启用 Google Workspace Marketplace 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 管理员能否从 Google Workspace Marketplace 上的商品详情页面安装您的应用。
- 个人安装 + 管理员安装(默认):应用可以由个人用户安装,也可以由网域、组织部门或一组用户的管理员安装。用户的网域政策可能会阻止他们安装应用,即使已启用单独安装功能也是如此。
- 仅限管理员安装:应用只能由管理员为其网域、组织部门或用户群组安装。您的应用只会在 Google Workspace Marketplace 的搜索结果中向管理员和未登录其 Google 账号的用户显示。如果您的应用需要域名安装,请选择此选项。
常见的安装和公开范围设置
下表总结了一些常见的应用配置选项,用于控制安装和公开范围:
目标应用用户 | 应用公开范围设置 | 应用安装设置 | 哪些人可以安装我的应用? | 谁可以使用我的应用? | |
---|---|---|---|---|---|
对于为 Google Workspace 组织构建的应用 | |||||
贵组织中的特定用户 | 私享和不公开列出 | 个人安装 + 管理员安装 | 贵组织中知道应用详情网址的任何人(如果允许)。 | 贵组织中知道应用详情网址的任何人(如果允许)。 | |
您的组织 | 专用 | 个人安装 + 管理员安装 | 贵组织中的任何人(如果允许)。 | 贵组织中的任何人(如果允许)。 | |
您的组织 | 专用 | 仅限管理员 | 管理员 | 由管理员安装应用的用户。 | |
对于可供特定 Google Workspace 组织外部用户使用的应用 | |||||
Google Workspace 组织中的用户 | 公开 | 仅限管理员 | 管理员 | 已由管理员安装该应用的用户。 | |
所有 Google Workspace 用户 | 公开 | 个人安装 + 管理员安装 |
|
|
确定您的应用如何与 Google Workspace 应用集成
选择您的应用或插件可与哪些 Google Workspace 服务搭配使用,例如 Google Workspace 插件或 Google Chat 应用。您必须至少选择一个选项。在某些情况下,您可以在应用详情中添加多个应用集成。请参阅将应用集成列在一起。
根据您选择的应用集成,您可能需要提供更多信息,并在 Google Cloud 项目中启用相关 API。下表介绍了每种情况所需的额外设置:
Google Workspace 插件 (Apps 脚本)
如需发布 Google Workspace 插件,您必须提供该插件的部署 ID。如需查找部署 ID,请按以下步骤操作:
- 在 Apps 脚本编辑器中打开您的 Google Workspace 插件。
- 依次点击部署 > 管理部署。
- 在部署 ID 下,点击复制。
Google Workspace 插件(HTTP 部署)
如果您使用 HTTP 端点构建了 Google Workspace 插件,请按照以下步骤从 Google Cloud 部署资源中获取部署 ID。
- 在“应用配置”页面中的“Google Workspace 插件”下,点击 HTTP 或其他部署 > 选择部署。
- 选择要发布的部署。
- 点击选择。
编辑器插件(文档、表格、幻灯片、表单)
如需发布编辑器插件,您必须提供要发布的项目脚本 ID 和版本。
如需查找项目脚本 ID,请按以下步骤操作:
- 在 Apps 脚本编辑器中打开该插件。
- 点击左侧的项目设置图标 。
- 在“ID”下,复制脚本 ID。
如需查找版本,请按以下步骤操作:
- 在 Apps 脚本编辑器中打开该插件。
- 在右上角,依次点击部署 > 管理部署。
- 版本号位于“配置”下。
Google Chat 应用
要发布 Google Chat 应用,您必须配置 Google Chat API。 请参阅发布 Google Chat 应用。
云端硬盘应用
如需发布云端硬盘应用,您必须启用并配置 Google Drive API。
Web 应用
如需发布 Web 应用,您必须提供其通用导航栏网址,即指向 Google 应用菜单
中的 Web 应用的网址。您的 Web 应用必须处于正式版状态且功能齐全。在填写“商家信息”页面时,您必须提供尺寸为 96x96 和 48x48 像素的其他图标。
如果您是在 Apps Script 中构建的 Web 应用,请按以下步骤获取通用导航栏网址:
- 在 Apps 脚本编辑器中打开您的 Google Workspace 插件。
- 依次点击 Deploy > New deployment。
- 在“选择类型”下,点击 Web 应用。
- 填写选项,然后点击部署。
- 点击复制。
指定您的应用需要的访问权限级别
在 OAuth 范围下,提供应用所需的 OAuth 2.0 范围的完整列表。您在此处输入的 OAuth 权限范围应与您在 OAuth 同意屏幕中显示的内容以及 Apps 脚本清单(如果适用)中显示的内容一致。
如果您包含多个应用集成,请务必将每个集成的范围添加到 Marketplace SDK 应用配置页面和 OAuth 意见征求页面。
请始终使用尽可能小的范围(例如,如果您只需要只读范围,请不要包含完整的云端硬盘范围)。
对于 Apps 脚本项目,如需了解详情,请参阅授权范围。
提供应用开发者的信息
在开发者信息下,填写联系信息和其他详细信息。 这些字段会显示在应用的商品详情页面上。
字段 | |
---|---|
交易者状态 |
根据消费者保护法律,我们必须告知欧洲经济区 (EEA) 的消费者,Google Workspace Marketplace 上的商家是交易者还是非交易者:
如果未指定,应用的商品详情页面上会显示“商家状态未指定”。 |
开发者名称 | 要显示为应用作者的名称。如果您是商家,请提供您的商号或法定名称。 |
开发者邮寄地址 |
交易者必须填写。不会针对非交易者收集。 您的营业地点。请输入可以联系到您的有效邮寄地址。 |
开发者网站网址 | 将您(或贵组织)介绍为开发者的网站。 |
开发者电子邮件 |
要用作联系人的电子邮件地址。未包含在您的应用详情中。请务必及时更新此电子邮件地址,因为系统会使用它:
|
应用网站网址 | 可选。进一步介绍您应用的网站。 |
在 Marketplace SDK 中保存应用配置设置
使用上一部分中的信息,将您的应用配置保存在 Marketplace SDK 中:
在 Google Cloud 控制台中,前往 Marketplace SDK 配置页面:
根据您在上一部分中确定的信息,填写各个部分。
点击保存。
(可选)您可以在 Google Analytics 中获取应用使用情况分析。为此,请在 Marketplace SDK 中添加 Google Analytics ID。
- 进入数据分析标签页。
- 输入您的 Google Analytics ID。
- 点击保存。