Google Workspace Add-on for Gmail 开源项目指南

Google Workspace Add-on for Gmail 开源项目指南

gmail-add-on-codelab项目地址:https://gitcode.com/gh_mirrors/gm/gmail-add-on-codelab

---

1. 目录结构及介绍

该项目在GitHub上的存储库遵循了一个清晰的结构，以简化开发过程。以下是主要的文件和文件夹结构：

.
├── CODE_OF_CONDUCT.md           # 行为准则
├── CONTRIBUTING.md               # 贡献指南
├── LICENSE                       # 使用的Apache 2.0许可证文本
├── README.md                     # 项目简介和快速入门指南
├── SECURITY.md                   # 安全政策说明
└── appscript.json                # 项目的配置文件，定义了插件的基本元数据

此外，项目还包括一系列按步骤编写的脚本文件（如Step-0, Step-1等），引导开发者逐步完成Add-on的构建过程。这些文件不在上述展示的顶层目录中，但它们是项目的核心部分，用于实际实现Google Workspace Add-on的功能。

2. 项目的启动文件介绍

虽然这个特定的项目依赖于Google Apps Script的在线IDE环境，没有传统的单一启动文件（如main.py或index.js），但是关键的起点是通过访问appscript.json来配置你的项目，并在Google Apps Script编辑器内开始编写代码。实际上，开发者从访问或创建名为Code.gs的文件开始他们的编码工作，这是存放主要应用逻辑的地方。在本教程的上下文中，“启动”意味着在Google Apps Script编辑器中打开或创建此Code.gs文件，并开始实施由appscript.json所定义的功能函数，比如getContextualAddOn，这是触发Add-on行为的关键函数之一。

3. 项目的配置文件介绍

appscript.json 是项目的配置文件，它包含了关于Add-on的重要元数据和配置选项。以下是它的一些关键字段解释：

• timeZone: 设置项目的时区。
• oauthScopes: 指定应用程序需要的权限范围，这里是允许Add-on执行Gmail相关的操作。
• gmail: 此对象配置了与Gmail Add-on相关的信息，包括插件的名字、图标URL以及触发条件等。
  • name: 插件显示的名称。
  • logoUrl: 加载到Add-on旁的图标地址。
  • contextualTriggers: 触发Add-on的条件，这里设置为无条件触发，函数getContextualAddOn将在满足条件时被调用。
  • primaryColor: 设置Add-on界面的主要颜色。

配置此文件是确保Add-on能够正确集成到Gmail环境中的第一步，也是定义其外观和初步交互模式的关键。

通过仔细调整这些配置项，并结合Google Apps Script的代码编写，开发者就能够创建一个功能丰富的Gmail Add-on，允许用户直接在邮件界面内处理事务，如将收据信息添加至Google Sheets。

gmail-add-on-codelab项目地址:https://gitcode.com/gh_mirrors/gm/gmail-add-on-codelab