如要构建新的 Google Workspace 插件,请遵循以下通用条款 过程:
- 设置插件的项目并选择所有者 和协作者。
- 设计插件的外观和行为。
- 配置插件的项目清单或 部署资源
- 编写代码来定义插件的外观 行为
- 验证插件的 OAuth 范围。
- 在 主机应用 扩展。
- 发布该插件。
设置插件的项目,并选择所有者和协作者
如果你使用 Apps 脚本构建插件, 您同时创建了 Apps 脚本项目和 Google Cloud 项目。 如果您使用的语言不是 Apps 脚本,那么只需创建一个 Google Cloud 项目即可。
在开始开发插件之前,请先选择一个 用户账号,以便拥有项目并决定要 协作者。项目的所有者会创建和管理项目文件 和相关设置,而协作者可以协助编码和测试。
Apps 脚本项目
您可以构建插件的 Apps 脚本 共享共享 驾车,确保 拥有唯一所有权。放置插件 创建共享云端硬盘脚本文件,这可以确保多个协作者可以访问 脚本项目。
发布插件时,单个用户账号的作用 您作为发布商发布账号必须拥有脚本的修改权限 项目,但不必是所有者。
如需创建 Apps 脚本项目,请参阅脚本项目。
Google Cloud 项目
我们建议您将协作者添加到 插件 Cloud 项目。 这有助于确保您团队中的人员始终都能访问 插件的云设置
如需创建 Google Cloud 项目,请参阅创建 Google Cloud 项目。
设计插件的外观和行为
确定插件的外观和外观 它应该能够正常运行考虑哪些应用场景 插件应该尝试为其提供解决方案。开始 先来看一看简单的设计,然后再进行更多优化。
<ph type="x-smartling-placeholder">请参阅 Google Workspace 插件样式指南 获取有关设计插件用户的指南。 体验。
配置插件项目清单
在 Apps 脚本项目中,项目清单是一种特殊的 JSON 文件。它指定了有关项目的各种详细信息,例如其库 依赖项对于 Google Workspace 插件,清单还会提供 显示 插件。
请参阅清单,详细了解如何配置您的 插件的清单。
在向插件添加代码和功能时,修改 以生成所需的插件 外观和行为。
对插件进行编码
您必须为 插件。使用 Apps 脚本的 卡片服务。如果您正在以另一种代码语言编写,则返回 格式正确的 JSON,以便接口呈现为卡片。
此外,您还必须实现任何触发器 函数中指定的 插件清单如果您的 插件连接到第三方非 Google 服务 您必须为其配置 OAuth 服务。
建造卡牌
您可以通过创建
Card
对象并使用
widgets。触发下列函数中指定的函数:
您的清单必须返回
Card
对象或
Card
对象,用于表示
不同“网页”插件界面中您的
插件也可以在 Google Cloud 控制台中
响应用户操作。
在 Apps 脚本中,您可以使用
CardBuilder
类。每个
卡要求 CardHeader
以及一个或多个
CardSections
。您应该
使用组成
插件界面互动
微件
通常与操作相关联,
互动行为
在您通过
CardBuilder
,您必须调用
CardBuilder.build()
来创建相应的 Card
对象。
您可以使用其他内置的 Apps 脚本
服务,例如
CalendarApp
(用于检索)
您构建的插件卡片中显示的信息
您可以使用从非 Google 服务中提取的数据。
如果您的 Google Workspace 插件需要访问要求使用 OAuth 的非 Google API,您需要 配置并连接到该服务,请参阅连接到 非 Google 服务指南(适用于 。
施工订单
构建卡片时,您必须从顶部开始构建。也就是说, 构建顺序:
- 构建 widget。
- 将该微件添加到卡片部分。
- 重复上述步骤,直到卡片部分包含所有微件。
- 向卡片添加卡片部分。
这是必填字段,因为当您将微件添加到卡片或卡片部分时, 实际上是在添加该 widget 的副本。您对微件所做的任何更改 对象不会反映在最终的卡片中。
通用操作
您可以使用通用操作 来提供与上下文无关的功能。通用操作是指菜单项 无论哪种卡 。所有定义的通用操作始终显示在 插件的卡片菜单中。
如需了解详情,请参阅通用操作 。
验证插件 OAuth 范围
范围定义了 允许插件代表用户执行操作。这是一个 最佳做法是让插件只为其操作设置作用域
在插件项目中,明确设置 插件 范围,以确保 该插件将使用一组权限最小的范围 您可以定义插件在哪些范围中使用 插件 manifest 的文件。
如需了解详情,请参阅范围。
测试插件
要测试未发布的插件,您可以先安装 未发布 插件。 安装并获得授权后,您就可以使用该插件 并在其主机应用中测试其外观和行为 扩展。您应验证该插件的行为是否 用于上下文和用户操作。
如需了解详情,请参阅测试 Google Workspace 插件。
发布插件
插件发布后,他人便可使用 公开或仅限您网域中的用户。开始发布前的准备工作 流程,请务必查看发布内容概览。发布是一个复杂的过程, 准备和完成所需的时间
Google Workspace 插件会发布到 Google Workspace Marketplace。可公开访问 插件必须先完成应用审核,然后才能 发布状态
请参阅发布 Google Workspace 插件,获取以下内容: 。