如何通过Python Google Sheets API获取首个工作表

使用Python的googleapiclient获取Google表格内容时，硬编码工作表名称（比如Sheet1）会在工作表名称变更时触发googleapiclient.errors.HttpError异常，因为指定的工作表已不存在。需要实现无需依赖固定工作表名称，直接获取表格中默认/首个工作表内容的功能。

现有代码：

sheets_service = discovery.build('sheets', 'v4', credentials=credentials)
content = sheets_service.spreadsheets().values().get(spreadsheetId=spreadsheet_id, range='Sheet1').execute()

期望实现类似通配符的效果，自动获取首个工作表内容。

解决方案 #

Google Sheets API不支持用通配符指定工作表，但可以先获取表格元数据提取首个工作表名称，再基于该名称获取数据，具体步骤如下：

1. 调用spreadsheets().get()接口获取表格的完整元数据，其中包含所有工作表的列表
2. 从返回的sheets数组中取第一个元素，提取其properties.title字段作为首个工作表的名称
3. 使用动态获取的工作表名称调用values().get()获取对应内容

完整代码示例：

from googleapiclient import discovery

sheets_service = discovery.build('sheets', 'v4', credentials=credentials)

# 获取表格元数据，提取首个工作表名称
spreadsheet_metadata = sheets_service.spreadsheets().get(spreadsheetId=spreadsheet_id).execute()
first_sheet_title = spreadsheet_metadata['sheets'][0]['properties']['title']

# 获取首个工作表的内容
content = sheets_service.spreadsheets().values().get(
    spreadsheetId=spreadsheet_id,
    range=first_sheet_title
).execute()

补充说明 #

• 若需处理表格无任何工作表的极端情况，可添加判断逻辑避免索引越界异常
• 若要获取所有工作表数据，可遍历spreadsheet_metadata['sheets']数组，逐个获取每个工作表的内容

内容的提问来源于stack exchange，提问作者starmandeluxe