Method: spreadsheets.get

返回指定 ID 对应的电子表格。调用方必须指定电子表格 ID。

默认情况下，系统不会返回网格中的数据。您可以通过以下 2 种方式之一添加网格数据：

  • 使用 HTTP 中的 fields 网址参数指定字段掩码，其中列出所需字段

  • 将 includeGridData 网址参数设置为 true。如果设置了字段掩码，系统会忽略 includeGridData 参数

对于大型电子表格，最佳实践是仅检索所需的特定电子表格字段。

如需仅检索部分电子表格数据，请使用 ranges 网址参数。范围使用 A1 表示法指定。您可以定义单个单元格（例如 A1）或多个单元格（例如 A1:D5）。您还可以从同一电子表格中的其他工作表获取单元格（例如 Sheet2!A1:C4），或一次检索多个范围（例如 ?ranges=A1:D5&ranges=Sheet2!A1:C4）。限制范围后，系统只会返回与请求的范围相交的电子表格部分。

HTTP 请求

GET https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}

网址采用 gRPC 转码语法。

路径参数

参数
spreadsheetId

string

要请求的电子表格。

查询参数

参数
ranges[]

string

要从电子表格中检索的范围。
includeGridData

boolean

如果应返回网格数据，则为 true。如果在请求中设置了字段掩码，则系统会忽略此参数。
excludeTablesInBandedRanges

boolean

如果应从带状范围中排除表格，则为 true。如果未设置，则为 false。

请求正文

请求正文必须为空。

响应正文

如果成功，则响应正文包含一个 Spreadsheet 实例。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets
  • https://www.googleapis.com/auth/spreadsheets.readonly

如需了解详情，请参阅授权指南。