本页介绍了如何使用 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
如果您尚未这样做，请在 Google Cloud 项目中启用 Marketplace SDK。
在 Google Cloud 控制台中打开您的 Cloud 项目
如果尚未打开，请打开您打算用于此示例的 Cloud 项目：
- 在 Google Cloud 控制台中，前往选择项目页面。
- 选择您要使用的 Google Cloud 项目。或者，点击创建项目，然后按照屏幕上的说明操作。如果您创建了 Google Cloud 项目，可能需要为该项目启用结算功能。
启用 Marketplace SDK
在使用 Google API 之前，您需要在 Google Cloud 项目中启用它们。 您可以在单个 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 管理员是否可以从 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 插件
如需发布 Google Workspace 加购项，您必须提供该加购项的部署 ID。
如需在 Apps 脚本中查找部署 ID，请按以下步骤操作：
- 在 Apps 脚本编辑器中打开 Google Workspace 加载项。
- 依次点击部署 > 管理部署。
- 点击部署 ID 下方的复制。
如需查找 HTTP 加购项的部署 ID，请按以下步骤操作：
- 在“Google Workspace 加载项”下的“应用配置”页面上，依次点击 HTTP 或其他部署> 选择部署。
- 选择要发布的部署。
- 点击选择。
编辑器插件（Google 文档、Google 表格、Google 幻灯片、Google 表单）
如需发布编辑器插件，您必须提供要发布的项目脚本 ID 和版本。
如需查找项目脚本 ID，请按以下步骤操作：
- 在 Apps 脚本编辑器中打开该插件。
- 点击左侧的项目设置图标 。
- 在“ID”下，复制脚本 ID。
如需查找版本，请按以下步骤操作：
- 在 Apps 脚本编辑器中打开该插件。
- 依次点击右上角的部署> 管理部署。
- 版本号位于“配置”下方。
Google Chat 应用
如需发布 交互式 Google Chat 应用，请参阅以下文档：
- 如果您将 Chat 应用构建为插件，则必须在 Chat API 中配置插件设置。如需了解相关步骤，请参阅 Google Workspace 插件文档中的配置 Chat 应用。
- 如果您使用互动事件构建了 Chat 应用，则必须在 Chat API 中配置互动事件设置。如需了解相关步骤，请参阅 Chat API 文档中的接收并响应互动事件。
- 如果您使用 AppSheet 的自动配置功能构建了 Chat 应用，请按照 AppSheet 文档中的步骤发布 Chat 应用，即使用自动配置功能分享 Chat 应用。
Google 云端硬盘应用
如需发布 Google 云端硬盘应用，您必须启用并配置 Google Drive API。
Web 应用
如需发布 Web 应用，您必须提供其通用导航网址，即从 Google 应用菜单 指向 Web 应用的网址。您的 Web 应用必须处于正式版状态，并且功能齐全。
填写“商品详情”页面时，您必须提供尺寸为 96x96 和 48x48 像素的其他图标。
如果您在 Apps 脚本中构建了 Web 应用，请按以下步骤获取通用导航网址：
- 在 Apps 脚本编辑器中打开 Google Workspace 插件。
- 依次点击部署 > 新部署。
- 在“选择类型”下，点击网络应用。
- 填写选项，然后点击部署。
- 点击复制。
指定应用所需的访问权限级别
在 OAuth 范围下，提供应用所需的 OAuth 2.0 范围的完整列表。您在此处输入的 OAuth 范围应与 OAuth 权限请求页面中显示的内容以及 Apps 脚本清单（如果适用）相符。
如果您添加了多个应用集成，请务必将每个应用集成的范围添加到 Marketplace SDK 应用配置页面和 OAuth 权限请求页面。
请始终使用尽可能窄的范围（例如，如果您只需要只读范围，请勿包含完整的 Drive 范围）。
对于 Apps 脚本项目，如需了解详情，请参阅授权范围。
提供应用开发者的相关信息
在开发者信息下，填写联系信息和其他详细信息。 这些字段会显示在应用的商品详情页面上。
| 字段 | |
|---|---|
| 交易者状态 |
根据消费者保护法，我们需要告知欧洲经济区 (EEA) 内的消费者，此购物平台上的商家是交易者还是非交易者：
如果未指定，您的应用的商品详情页面上会显示“交易者身份未指定”。 |
| 开发者名称 | 要显示为应用作者的名称。如果您是贸易商，请提供您的商号或法定名称。 |
| 开发者邮寄地址 |
交易者必须提供此信息。不针对非交易者收集。 您的商家营业地点。请输入可以联系到您的有效邮寄地址。 |
| 开发者网站网址 | 将您（或您的组织）描述为开发者的网站。 |
| 开发者电子邮件地址 |
用作联系方式的电子邮件地址。它不会包含在您的应用详情中。请务必及时更新此电子邮件地址，因为此地址会用于：
|
| 应用网站网址 | 可选。进一步说明您的应用的网站。 |
在 Marketplace SDK 中保存应用配置设置
根据上一部分中的信息，在 Marketplace SDK 中保存应用配置：
在 Google Cloud 控制台中，前往 Marketplace SDK 应用配置页面：
根据您在上一部分中确定的内容填写各个部分。
点击保存草稿。
（可选）您可以在 Google Analytics 中获取应用使用情况分析数据。为此，请在 Marketplace SDK 中添加 Google Analytics ID。
- 进入数据分析标签页。
- 输入您的 Google Analytics ID。
- 点击保存。
问题排查
本部分介绍了您可能会遇到的常见问题。
将应用发布到 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 处于启用状态，并且使用的 IAM 角色不是 Editor 或 Owner 时，就会出现此错误。
如需解决此错误，请实施以下解决方案之一：
请让项目所有者向缺少权限的账号分配
roles/appmetadata.workspaceMarketplaceAppConfigurationAdmin角色，以便该账号可以在 Marketplace SDK 中配置和管理应用。请项目所有者通过 Google Cloud 控制台中的 IAM 和管理 > 角色页面向自定义角色添加缺少的权限。然后，将自定义角色分配给缺少相应权限的账号。
原始
roles/editor或roles/owner可用于发布应用。 不过，安全使用 IAM 文档认为这是一种不良做法，因为无法轻松限制对项目中其他资源的修改权限。