Method: spreadsheets.values.get

从电子表格中返回一系列值。调用方必须指定电子表格 ID 和范围。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
spreadsheetId

string

从中检索数据的电子表格的 ID。
range

string

要从中检索值的范围的 A1 表示法或 R1C1 表示法。

查询参数

参数
majorDimension

enum (Dimension)

结果应使用的主要维度。

例如，如果工作表 1 中的电子表格数据为 A1=1,B1=2,A2=3,B2=4，请求 range=Sheet1!A1:B2?majorDimension=ROWS 会返回 [[1,2],[3,4]]，而请求 range=Sheet1!A1:B2?majorDimension=COLUMNS 会返回 [[1,3],[2,4]]。
valueRenderOption

enum (ValueRenderOption)

值在输出中的表示方式。默认呈现选项为 FORMATTED_VALUE。
dateTimeRenderOption

enum (DateTimeRenderOption)

输出中日期、时间和时长的表示方式。如果 valueRenderOption 为 FORMATTED_VALUE，系统会忽略此参数。默认的 dateTime 呈现选项是 SERIAL_NUMBER。

请求正文

请求正文必须为空。

响应正文

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

授权范围

需要以下 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

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