Google Spreadsheets Python API v4 技术文档

1. 安装指南

安装步骤

1. 确保你已经安装了Python 3.8或更高版本。

2. 使用以下命令安装gspread库：

   pip install gspread
   

依赖项

• Python 3.8+

2. 项目使用说明

基本用法

1. 创建Google API凭据：首先，你需要在Google API Console中创建凭据。具体步骤可以参考这里。

2. 开始使用gspread：

   import gspread
   
   gc = gspread.service_account()
   
   # 打开一个表格
   wks = gc.open("Where is the money Lebowski?").sheet1
   
   # 更新单元格范围
   wks.update([[1, 2], [3, 4]], "A1")
   
   # 更新单个单元格
   wks.update_acell("B42", "it's down there somewhere, let me take another look.")
   
   # 格式化表头
   wks.format('A1:B1', {'textFormat': {'bold': True}})
   

从v5.12升级到v6.0

升级Python版本

• Python 3.7已停止支持，gspread v6需要Python 3.8或更高版本。

修改Worksheet.update参数

• values和range_name参数的位置已交换。你可以交换它们，或者使用命名参数。
• values现在必须是二维数组。

# 示例
file.sheet1.update([["54", "55"]], "B2:C2")
# 或者
file.sheet1.update(range_name="B2:C2", values=[["54", "55"]])

3. 项目API使用文档

打开表格

# 通过标题打开表格
sh = gc.open('My poor gym results')

# 通过表格的key打开
sht1 = gc.open_by_key('0BmgG6nO_6dprdS1MN3d3MkdPa142WFRrdnRRUWl1UFE')

# 通过URL打开
sht2 = gc.open_by_url('https://docs.google.com/spreadsheet/ccc?key=0Bm...FE&hl')

创建表格

sh = gc.create('A new spreadsheet')

# 必须与你的邮箱共享新创建的表格
sh.share('[e-mail]', perm_type='user', role='writer')

选择工作表

# 通过索引选择工作表
worksheet = sh.get_worksheet(0)

# 通过标题选择工作表
worksheet = sh.worksheet("January")

# 选择Sheet1
worksheet = sh.sheet1

# 获取所有工作表的列表
worksheet_list = sh.worksheets()

创建工作表

worksheet = sh.add_worksheet(title="A worksheet", rows="100", cols="20")

删除工作表

sh.del_worksheet(worksheet)

获取单元格值

# 通过标签获取值
val = worksheet.get('B1').first()

# 通过坐标获取值
val = worksheet.cell(1, 2).value

获取行或列的所有值

# 获取第一行的所有值
values_list = worksheet.row_values(1)

# 获取第一列的所有值
values_list = worksheet.col_values(1)

获取工作表的所有值

from gspread.utils import GridRangeType
list_of_lists = worksheet.get(return_type=GridRangeType.ListOfLists)

更新单元格

# 更新单个单元格
worksheet.update_acell('B1', 'Bingo!')

# 更新范围
worksheet.update([[1, 2], [3, 4]], 'A1:B2')

# 批量更新
worksheet.batch_update([{
    'range': 'A1:B2',
    'values': [['A1', 'B1'], ['A2', 'B2']],
}, {
    'range': 'J42:K43',
    'values': [[1, 2], [3, 4]],
}])

4. 项目安装方式

使用pip安装

pip install gspread

手动安装

1. 下载项目源码。

2. 解压后进入项目目录。

3. 运行以下命令：

   python setup.py install
   

通过以上步骤，你可以成功安装并使用gspread库来操作Google Spreadsheets。