服务端 API/云文档/电子表格/单元格/读取多个范围
# 读取多个范围

该接口用于根据 spreadsheetToken 和 ranges 读取表格多个范围的值，返回数据限制为10M。

## 请求

基本 |  
---|---
HTTP URL | https://open.larksuite.com/open-apis/sheets/v2/spreadsheets/:spreadsheetToken/values_batch_get
HTTP Method | GET
支持的应用类型 | Custom App、Store App
权限要求<br>**调用该 API 所需的权限。开启其中任意一项权限即可调用**<br>开启任一权限即可 | 查看、评论、编辑和管理云空间中所有文件(drive:drive)<br>查看、评论和下载云空间中所有文件(drive:drive:readonly)<br>查看、评论、编辑和管理电子表格(sheets:spreadsheet)<br>查看、评论和导出电子表格(sheets:spreadsheet:readonly)

### 请求头

名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `user_access_token` 或 `tenant_access_token`<br>**值格式**："Bearer `access_token`"<br>**示例值**："Bearer u-7f1bcd13fc57d46bac21793a18e560"<br>[了解更多：获取与使用access_token](https://open.larksuite.com/document/ukTMukTMukTM/uMTNz4yM1MjLzUzM)
Content-Type | string | 是 | **固定值**："application/json; charset=utf-8"

### 路径参数

参数 | 类型 | 描述
---|---|---
spreadsheetToken | string | spreadsheet 的 token，获取方式见[在线表格开发指南](https://open.larksuite.com/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview)

### 查询参数  
目前对于含有公式的单元格，仅能获取除跨表引用、数组公式以外的公式的值。

**注意事项**：user_id_type目前默认值为lark_id，2022年1月26日后将会调整默认值为open_id，且不再支持lark_id，请尽快适配！
| 参数                 | 类型   | 必须 | 说明                                                         |
| -------------------- | ------ | ---- | ------------------------------------------------------------ |
| ranges               | array<string> | 是   | 多个查询范围 如 url?ranges=range1,range2 ，⁣其中 range 包含 sheetId 与单元格范围两部分，目前支持四种索引方式，详见 [在线表格开发指南](https://open.larksuite.com/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview) |
| valueRenderOption    | string | 否   | valueRenderOption=ToString 可返回纯文本的值(数值类型除外)；valueRenderOption=FormattedValue 计算并格式化单元格；valueRenderOption=Formula单元格中含有公式时返回公式本身；valueRenderOption=UnformattedValue计算但不对单元格进行格式化|
| dateTimeRenderOption  | string | 否   | dateTimeRenderOption=FormattedString 计算并将时间日期按照其格式进行格式化，但不会对数字进行格式化，返回格式化后的字符串。详见[电子表格常见问题](https://open.larksuite.com/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/guide/sheets-faq) |
| user_id_type | string | 否 | 返回的用户id类型，可选open_id,union_id |

###  cURL 请求示例
```
curl --location --request GET 'https://open.larksuite.com/open-apis/sheets/v2/spreadsheets/shtcngNygNfuqhxTBf588jwgWbJ/values_batch_get?ranges=Q7PlXT!A2:B6,0b6377!B1:C8&valueRenderOption=ToString&dateTimeRenderOption=FormattedString' \
--header 'Authorization: Bearer t-e346617a4acfc3a11d4ed24dca0d0c0fc8e0067e' \
```
## 响应  

### 响应体
|参数|类型|说明|
|--|-----|--|
|revision|int |sheet 的版本号|
|spreadsheetToken|string | spreadsheet 的 token，详见[在线表格开发指南](https://open.larksuite.com/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview)|
|totalCells|int|读取的单元格总数|
|valueRanges|array<Object>|值与范围|
|&emsp;∟majorDimension|string|插入维度|
|&emsp;∟range|string|返回数据的范围，为空时表示查询范围没有数据|
|&emsp;∟revision|int|sheet 的版本号|
|&emsp;∟values|array<array<Object>>|查询得到的值|

### 响应体示例    
```json
{
  "code": 0,
  "data": {
    "revision": 0,
    "spreadsheetToken": "***",
    "totalCells": 0,
    "valueRanges": [
      {
        "majorDimension": "ROWS",
        "range": "range1",
        "revision": 0,
        "values": [
          [
            "***"
          ]
        ]
      },
      {
        "majorDimension": "ROWS",
        "range": "range2",
        "revision": 0,
        "values": [
          [
            "***"
          ]
        ]
      }
    ]
  },
  "msg": "Success"
}
```  

### 错误码

具体可参考：[服务端错误码说明](https://open.larksuite.com/document/ukTMukTMukTM/ugjM14COyUjL4ITN)