在 Google Workspace Marketplace SDK 中配置应用

本页面介绍如何使用 Google Workspace Marketplace SDK 在 Google Workspace Marketplace 中配置和管理您的应用。

为了让您的应用可供用户使用,您需要在 Google Workspace Marketplace SDK 中设置该应用。Google Workspace Marketplace SDK 是一个工具包,可用于在 Google Workspace Marketplace 中创建和控制应用。您可以使用 Google Workspace Marketplace SDK 来管理 Marketplace 设置,例如:

  • 您的应用是可供特定的 Google Workspace 组织使用(专用应用),还是面向所有 Marketplace 用户(公开应用)
  • 可以安装您应用的 Marketplace 用户类型
  • 您的应用集成了哪些 Google Workspace 应用
  • 您的应用所需的 OAuth 范围
  • 有关应用构建和维护者的信息

无论您是公开发布还是私下发布应用,都必须使用 Google Workspace Marketplace SDK 在 Marketplace 中管理您的应用。

启用 Google Workspace Marketplace SDK

如果尚未在 Google Cloud 项目中启用 Google Workspace Marketplace SDK,请执行此操作:

  1. 打开 Google Cloud Console
  2. 点击顶部的选择项目。如果其他 Google Cloud 项目已打开,请点击 Cloud 项目名称以切换 Cloud 项目。
  3. 选择应用的 Cloud 项目,然后点击打开
  4. 在顶部的搜索栏中输入 Google Workspace Marketplace SDK,然后按 Enter 键。
  5. 打开 Google Workspace Marketplace SDK 页面。

  6. 如果 Google Workspace Marketplace SDK 尚未启用,请点击启用

在 Google Workspace Marketplace SDK 中输入应用设置

  1. 打开 Google Workspace Marketplace SDK
  2. 转到应用配置标签页。
  3. 使用应用的相关信息填写每个部分。如需了解每个设置,请参阅以下应用配置设置部分。
  4. 点击保存
  5. (可选)您可以在 Google Analytics(分析)获取有关应用使用情况的分析信息。为此,请在 Google Workspace Marketplace SDK 中添加 Google Analytics(分析)ID
    1. 前往数据分析标签页。
    2. 输入您的 Google Analytics(分析)ID。
    3. 点击保存

应用配置设置

以下参考文档介绍了 Google Workspace Marketplace SDK 的应用配置页面中提供的设置。

应用显示设置

如果您使用的是 Google Workspace 帐号(由您的工作或学校组织创建的帐号),则可以看到应用公开范围选项。如果您使用的是消费者帐号(以“@gmail.com”结尾的帐号),则只能公开发布。

  • 公开:网域外部人员可以找到并安装该应用。如果您选择公开公开范围,Google 会在发布应用之前对其进行审核并批准。
  • 不公开:只有您网域中的用户可以找到并安装您的应用。

如果您选择以不公开列出状态发布应用,则应用详情不会显示在浏览页面或搜索结果中。用户只能通过直接网址访问应用的商店页面。

如果您想限制应用的发布国家和地区,可以在创建商品详情时在分发部分进行设置。

安装设置

安装设置决定用户或 Workspace 管理员是否可以从 Google Workspace Marketplace 的商品详情页面安装您的应用。

  • 个人 + 管理员安装(默认):应用可以由单个用户安装,也可以由其网域、组织部门或一组用户的管理员安装。即使启用了个人安装,用户的网域政策也可能阻止他们安装应用。
  • 仅限管理员安装:只有管理员的网域、组织部门或用户群组才能安装该应用。只有管理员和未登录其 Google 帐号的用户,您的应用才会在 Google Workspace Marketplace 搜索结果中显示。如果您的应用需要向网域安装,请选择此选项。

应用集成

选择您的应用或插件可支持的 Google Workspace 服务,例如 Google Workspace 插件或 Google Chat 应用。您必须至少选择一个选项。在某些情况下,您可以在应用详情中包含多个应用集成。请参阅一并列出应用集成

根据您选择的应用集成类型,您可能需要提供更多信息并在 Google Cloud 项目中启用相关 API。下表介绍了每种方法所需的额外设置:

Google Workspace 插件(Apps 脚本)

如需发布 Google Workspace 插件,您必须提供该插件的部署 ID。如需查找部署 ID,请按以下步骤操作:

  1. 在 Apps 脚本编辑器中打开 Google Workspace 插件。
  2. 点击部署 > 管理部署
  3. 在部署 ID 下,点击复制

Google Workspace 插件(替代运行时)

如果您使用 Google Apps 脚本以外的编码语言构建 Google Workspace 插件,请按照以下步骤从 Google Cloud 部署资源获取部署 ID。

  1. 在“应用配置”页面上的“Google Workspace 插件”下,点击使用云部署资源进行部署 > 选择部署
  2. 选择要发布的部署。
  3. 点击选择

编辑器插件(文档、表格、幻灯片、表单)

要发布编辑器插件,您必须提供要发布的项目脚本 ID版本

如需查找项目脚本 ID,请按以下步骤操作:

  1. 在 Apps 脚本编辑器中打开该插件。
  2. 点击左侧的 Project settings(项目设置)图标
  3. 在“ID”下,复制脚本 ID。

如要查找版本,请按以下步骤操作:

  1. 在 Apps 脚本编辑器中打开该插件。
  2. 在右上角,依次点击部署 > 管理部署
  3. 版本号就在“配置”下。

Google Chat 应用

如要发布 Google Chat 应用,您必须配置 Google Chat API。 请参阅 发布应用

云端硬盘应用

要发布云端硬盘应用,您必须启用并配置 Drive API

Web 应用

要发布 Web 应用,您必须提供其通用导航栏网址,即从 Google 应用菜单 中指向 Web 应用的网址。您的 Web 应用必须已发布为正式版且所有功能均能正常运行。

填写“商品详情”页面时,您必须额外提供一些大小为 96x96 像素和 48x48 像素的图标。

如果您使用 Apps 脚本构建 Web 应用,要获取通用导航网址,请按以下步骤操作:

  1. 在 Apps 脚本编辑器中打开 Google Workspace 插件。
  2. 点击部署 > 新建部署
  3. 在“选择类型”下方,点击 Web 应用
  4. 填写选项,然后点击部署
  5. 点击复制

OAuth 范围

提供您的应用所需的 OAuth 范围的完整列表。您在此处输入的 OAuth 范围应与您在 OAuth 同意屏幕中显示的 OAuth 范围一致,以及 Apps 脚本清单(如果适用)中显示的范围。

如果您添加了多个应用集成,请确保将每个集成的范围添加到 Google Workspace Marketplace SDK 的“应用配置”页面和您的 OAuth 同意屏幕。

始终使用尽可能窄的范围(例如,如果您只需要使用只读范围,请不要添加完整的云端硬盘范围)。

对于 Apps 脚本项目,请参阅范围了解详情。

开发者信息

这些字段会显示在应用的商品详情页面上。

字段
交易者状态

根据消费者保护法,必须告知欧洲经济区 (EEA) 的消费者,Google Workspace Marketplace 中的商家是交易者还是非交易者

  • 交易者 - 交易者是指出于与交易、业务、工艺或职业相关的目的而行事,或者以交易者的名义或代表交易者的名义行事的人。
  • 非交易者 - 非交易者(消费者)是指出于非专业目的行事的人。

如果未指定,系统会在应用的商品详情页面上显示“未指定交易者状态”。

开发者邮寄地址

交易者必须填写。不针对非交易者收集。

商家营业地点。请输入可以联系到您的有效邮寄地址。

开发者名称 显示为应用作者的姓名。如果您是交易者,请提供您的交易名称或法定名称。
开发者网站网址 说明您(或您的组织)是开发者的网站。
开发者电子邮件地址

用作联系人的电子邮件地址。此范围未包含在您的应用详情中。请确保此电子邮件地址始终保持最新状态,所用用途如下:

  • Google 是否需要联系开发者(例如在应用审核流程中)。
  • 如果未在“商品详情”页面上提供“报告问题”网址,则需通过编辑器插件发送反馈。
应用网站网址 可选。进一步描述您的应用的网站。