使用gspread读写google spreadsheets (1)

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 APIGoogle Drive API,然后【启用】,API图标如下(其实也可以直接从最上方的搜索栏中检索激活,感觉更方便)

Google Sheets API和Google Drive API图标

1.3 创建API调用凭据

        从左侧的导航栏中点击【凭据】进入,然后【创建凭据】,选择【OAuth客户端ID】。

创建凭据1

        选择应用类型为【桌面应用】,名称可以按自己意愿设置(我设置成了“桌面客户端-auto-spreadsheet”),然后单击【创建】,会弹出“OAuth 客户端已创建”的提示框,里面是凭据内容,可以无视,继续单击【确定】

创建凭据2

        凭据创建完成后,会回到前面的“凭据”界面,可以看到刚才创建的凭据信息,点击最右侧的【向下箭头】,把凭据信息下载下来,并改名为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'))

        若程序运行成功,会自动新开一个网页,并申请一系列授权,点击【允许】和【确定】即可,如下图:

API使用授权

        这里打开的是一个公开的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的方法在后文中继续介绍。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,294评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,493评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,790评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,595评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,718评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,906评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,053评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,797评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,250评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,570评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,711评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,388评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,018评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,796评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,023评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,461评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,595评论 2 350