Google Apps Script OAuth2 库使用教程
项目介绍
Google Apps Script OAuth2 库是一个为 Google Apps Script 开发者提供的 OAuth2 认证库。该库允许开发者创建和授权 OAuth2 令牌,并在令牌过期时刷新它们。这个库利用了 Apps Script 的 UrlFetchApp 服务来处理 OAuth2 流程。
项目快速启动
安装和配置
-
克隆项目:
git clone https://github.com/googleworkspace/apps-script-oauth2.git
-
添加库到你的 Google Apps Script 项目:
- 在 Google Apps Script 编辑器中,点击
资源
->库
。 - 在
添加一个库
输入框中输入库的脚本 ID:1B7FSrk5Zi6L1rSxxTDgDEUsPzlukDsi4KGuTMorsTQHhGBzBkMun4iDF
。 - 点击
添加
,然后选择最新版本。
- 在 Google Apps Script 编辑器中,点击
示例代码
以下是一个简单的示例,展示如何使用 OAuth2 库来获取访问令牌并调用 Google Sheets API。
// 配置 OAuth2 客户端
var oauthConfig = {
clientId: 'YOUR_CLIENT_ID',
clientSecret: 'YOUR_CLIENT_SECRET',
scopes: ['https://www.googleapis.com/auth/spreadsheets'],
callbackFunction: 'authCallback'
};
// 创建 OAuth2 服务
var oauthService = OAuth2.createService('google')
.setAuthorizationBaseUrl('https://accounts.google.com/o/oauth2/auth')
.setTokenUrl('https://accounts.google.com/o/oauth2/token')
.setClientId(oauthConfig.clientId)
.setClientSecret(oauthConfig.clientSecret)
.setCallbackFunction(oauthConfig.callbackFunction)
.setPropertyStore(PropertiesService.getUserProperties())
.setScope(oauthConfig.scopes.join(' '));
// 授权回调函数
function authCallback(request) {
var isAuthorized = oauthService.handleCallback(request);
if (isAuthorized) {
return HtmlService.createHtmlOutput('授权成功!你可以关闭此窗口。');
} else {
return HtmlService.createHtmlOutput('授权失败!');
}
}
// 获取访问令牌并调用 API
function callSheetsApi() {
if (!oauthService.hasAccess()) {
var authorizationUrl = oauthService.getAuthorizationUrl();
Logger.log('请访问以下网址进行授权: %s', authorizationUrl);
return;
}
var url = 'https://sheets.googleapis.com/v4/spreadsheets/YOUR_SPREADSHEET_ID';
var response = UrlFetchApp.fetch(url, {
headers: {
Authorization: 'Bearer ' + oauthService.getAccessToken()
}
});
Logger.log(response.getContentText());
}
应用案例和最佳实践
应用案例
- 自动化报告生成:使用 OAuth2 库授权访问 Google Sheets,自动生成和更新报告。
- 数据同步:在不同的 Google 服务(如 Google Sheets 和 Google Calendar)之间同步数据。
最佳实践
- 安全存储凭据:确保客户端 ID 和客户端密钥安全存储,避免硬编码在脚本中。
- 处理授权错误:实现错误处理逻辑,以便在授权失败时通知用户。
- 定期刷新令牌:确保在令牌过期前刷新令牌,避免服务中断。
典型生态项目
- Google Apps Script 社区:提供丰富的脚本和库,帮助开发者扩展 Google 服务的功能。
- Google Workspace Marketplace:提供各种集成 Google Workspace 的应用程序和服务。
通过以上步骤和示例代码,你可以快速开始使用 Google Apps Script OAuth2 库来实现 OAuth2 认证,并集成 Google 服务到你的应用中。