Method: spreadsheets.values.batchGet

返回电子表格中的一个或多个值范围。调用方必须指定电子表格 ID 和一个或多个范围。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
spreadsheetId

string

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

查询参数

参数
ranges[]

string

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

enum (Dimension)

结果应使用的主要维度。

例如，如果电子表格数据为 A1=1,B1=2,A2=3,B2=4，则请求 ranges=["A1:B2"],majorDimension=ROWS 会返回 [[1,2],[3,4]]，而请求 ranges=["A1:B2"],majorDimension=COLUMNS 会返回 [[1,3],[2,4]]。
valueRenderOption

enum (ValueRenderOption)

值在输出中应采用的表示方式。默认渲染选项为 ValueRenderOption.FORMATTED_VALUE。
dateTimeRenderOption

enum (DateTimeRenderOption)

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

请求正文

请求正文必须为空。

响应正文

从电子表格中检索多个值范围时的响应。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "spreadsheetId": string,
  "valueRanges": [
    {
      object (ValueRange)
    }
  ]
}
字段
spreadsheetId

string

检索数据时所依据的电子表格的 ID。
valueRanges[]

object (ValueRange)

请求的值。ValueRanges 的顺序与请求的范围的顺序相同。

授权范围

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

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