Google Workspace Add-ons 示例项目教程
1. 项目的目录结构及介绍
add-ons-samples/
├── apps-script/
│ ├── calendar-add-on/
│ ├── chat-add-on/
│ ├── docs-add-on/
│ ├── drive-add-on/
│ ├── gmail-add-on/
│ ├── sheets-add-on/
│ └── slides-add-on/
├── codelabs/
│ ├── apps-script-codelab/
│ └── node-js-codelab/
├── LICENSE
└── README.md
目录结构介绍
- apps-script/: 包含各种Google Workspace应用的插件示例,如日历、聊天、文档、云端硬盘、Gmail、表格和幻灯片。
- codelabs/: 包含Apps Script和Node.js的代码实验室,帮助开发者学习如何使用这些技术创建插件。
- LICENSE: 项目的开源许可证文件。
- README.md: 项目的介绍和使用说明。
2. 项目的启动文件介绍
每个插件示例的启动文件通常是Code.gs
或index.js
,具体取决于使用的编程语言。以下是一些常见的启动文件示例:
示例1: calendar-add-on/Code.gs
function onCalendarEventOpen(e) {
// 插件的主要逻辑代码
}
示例2: node-js-codelab/index.js
const express = require('express');
const app = express();
app.get('/', (req, res) => {
res.send('Hello World!');
});
app.listen(3000, () => {
console.log('Server is running on port 3000');
});
3. 项目的配置文件介绍
apps-script/calendar-add-on/appsscript.json
{
"timeZone": "America/New_York",
"dependencies": {},
"exceptionLogging": "STACKDRIVER",
"oauthScopes": [
"https://www.googleapis.com/auth/calendar.addons.execute",
"https://www.googleapis.com/auth/calendar.readonly"
],
"addOns": {
"calendar": {
"homepageTrigger": {
"runFunction": "onCalendarHomePageOpen",
"enabled": true
},
"eventOpenTrigger": {
"runFunction": "onCalendarEventOpen"
}
}
}
}
配置文件介绍
- timeZone: 设置插件的时区。
- dependencies: 定义插件的依赖项。
- exceptionLogging: 设置异常日志记录方式。
- oauthScopes: 定义插件所需的OAuth权限范围。
- addOns: 定义插件在Google Calendar中的触发器和行为。
通过以上内容,您可以了解如何使用Google Workspace Add-ons示例项目,并根据需要进行自定义开发。