0.0 前言
使用Python操作micrsoft offce实现办公自动化能够极大的提高工作效率,包括 excel、word、powerpoint等。Google提供了功能超级完整的在线office软件系统,方便文件数据的共享、管理和更新,而使用Python通过调用google api同样可是实现自动化办公。
Google提供官方api用于Python调用(ref: https://developers.google.com/sheets/api/quickstart/python),但官方api太不友好,因此选择第三方的gspread库实现(ref: https://gspread.readthedocs.io/en/latest/index.html#)。网上还有很多教程使用的是gdata库,但gdata库只支持Python 2.X,而且已经停更很多年,就不推荐了。
1.0 申请API使用权限
(默认用户已经拥有谷歌账户并且使用过google spreadsheets,知道如何分享、使用文档,并且已安装gspread)
1.1 新建API项目
前往谷歌开发者控制台,找到下图的内容,点击【新建项目】。由于我已经有建立好的项目,因此新建项目的界面可能和首次尝试的用户不太一样,稍微找一下就可以(英文页面的话可以在右上角的“三个点”中的偏好设置进行修改)。
点击【新建项目】后,可以看到如下的界面。然后填写项目名称和组织名称(可选)即可,我这里给项目命名为Auto-Spreadsheet-01。填写完成后,点击【创建】按钮。
1.2 启用相关API服务
在项目中启用相关API服务。这里需要先确定已选定项目Auto-Spreadsheet-01,可以观察左上角是否出现相应项目的名称。若不是我们要求的项目,点击项目名称会出现项目菜单,选择即可。
确认项目后,点击搜索栏下方的【+ENABLE APIS AND SERVICES】,找到Google Sheets API和Google Drive API,然后【启用】,API图标如下(其实也可以直接从最上方的搜索栏中检索激活,感觉更方便)。
1.3 创建API调用凭据
从左侧的导航栏中点击【凭据】进入,然后【创建凭据】,选择【OAuth客户端ID】。
选择应用类型为【桌面应用】,名称可以按自己意愿设置(我设置成了“桌面客户端-auto-spreadsheet”),然后单击【创建】,会弹出“OAuth 客户端已创建”的提示框,里面是凭据内容,可以无视,继续单击【确定】。
凭据创建完成后,会回到前面的“凭据”界面,可以看到刚才创建的凭据信息,点击最右侧的【向下箭头】,把凭据信息下载下来,并改名为credentials.json。
1.4 设置gspread使用凭据
把凭据信息放在gspread相应的文件夹内。要使用gspread调用google API就需要gspread使用刚刚创建好的凭据,现在要把凭据交给gspread。根据官网的说明,凭据应放在【%APPDATA%\gspread\credentials.json】文件夹内(APPDATA是windows用户下面的隐藏文件夹),但在我操作过程中实际是把凭据放在了【%APPDATA%\Roaming\gspread\credentials.json】内,具体情况可以根据代码反馈来看,如果gspread没有得到凭据,在运行代码时会报错,并且把准确的文件夹放置信息报出来,如下图。
1.5 试验效果
打开编辑器,建立代码脚本test.py,把以下代码复制进去。
import gspread
gc = gspread.oauth()
sh = gc.open("commentary data")
print(sh.sheet1.get('A1'))
若程序运行成功,会自动新开一个网页,并申请一系列授权,点击【允许】和【确定】即可,如下图:
这里打开的是一个公开的google spreadsheet,名称为“commentary data”,地址为
https://docs.google.com/spreadsheets/d/1ww2UcaIz19H_1MRJLmCLp6UGQMvg1_xg65yrn0uZ0rQ/edit#gid=0。
若代码运行成功,将会返回A1单元格的内容:[['Batsman']]。
2.0 总结说明
gspread提供了两种api调用方式,一种是bot account,一种是end users。本文介绍的是end users使用方式,即api的使用者是个人,这种方式会定期要求对google文档访问的授权(每次授权有有效期,机制类似网站登录的缓存一样);但bot account相当于建立了一个机器人账户,无需多次授权,但需要将google 文档的分享给该账户,此后就可以无限制访问。但考虑本人的使用场景,选择了end users模式。
至此说明已成功使用python通过gspread实现了google spreadsheet访问,关于gspread的方法在后文中继续介绍。