服务端 API/云文档/电子表格/单元格/设置单元格样式
# 设置单元格样式
该接口用于根据 spreadsheetToken 、range 和样式信息更新单元格样式；单次写入不超过5000行，100列。
## 请求
基本 |
---|---
HTTP URL | https://open.larksuite.com/open-apis/sheets/v2/spreadsheets/:spreadsheetToken/style
HTTP Method | PUT
支持的应用类型 | Custom App、Store App
权限要求
**调用该 API 所需的权限。开启其中任意一项权限即可调用**
开启任一权限即可 | 查看、评论、编辑和管理云空间中所有文件(drive:drive)
查看、评论、编辑和管理电子表格(sheets:spreadsheet)
### 请求头
名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `user_access_token` 或 `tenant_access_token`
**值格式**："Bearer `access_token`"
**示例值**："Bearer u-7f1bcd13fc57d46bac21793a18e560"
[了解更多：获取与使用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)|
### 请求体
**请求参数说明** :
|参数|类型|必须|说明|
|--|-----|--|----|
|appendStyle||是|设置单元格样式
| ∟range|string|是|查询范围，包含 sheetId 与单元格范围两部分，目前支持四种索引方式，详见[在线表格开发指南](https://open.larksuite.com/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview)|
| ∟style||是|需要更新的样式|
| ∟font| |否|字体相关样式|
| ∟bold|bool|否|是否加粗|
| ∟italic|bool|否|是否斜体|
| ∟fontSize|string|否|字体大小 字号大小为9~36 行距固定为1.5，如:10pt/1.5|
| ∟clean|bool|否|清除 font 格式,默认 false| 请求 body |
| ∟textDecoration|int|否|文本装饰 ，0 默认，1 下划线，2 删除线 ，3 下划线和删除线|
| ∟formatter|string|否|数字格式，详见附录 [sheet支持数字格式类型](https://open.larksuite.com/document/ukTMukTMukTM/uMjM2UjLzIjN14yMyYTN) |
| ∟hAlign|int|否|水平对齐，0 左对齐，1 中对齐，2 右对齐|
| ∟vAlign|int|否|垂直对齐， 0 上对齐，1 中对齐， 2 下对齐|
| ∟foreColor|string|否|字体颜色|
| ∟backColor|string|否|背景颜色|
| ∟borderType|string|否|边框类型，可选 "FULL_BORDER"，"OUTER_BORDER"，"INNER_BORDER"，"NO_BORDER"，"LEFT_BORDER"，"RIGHT_BORDER"，"TOP_BORDER"，"BOTTOM_BORDER"|
| ∟borderColor|string|否|边框颜色|
| ∟clean|bool|否|是否清除所有格式,默认 false|
### 请求体示例
```json
{
"appendStyle":{
"range": "string",
"style":{
"font":{
"bold":true,
"italic":true,
"fontSize":"10pt/1.5",
"clean":false
},
"textDecoration":0,
"formatter":"",
"hAlign": 0 ,
"vAlign":0,
"foreColor":"#000000",
"backColor":"#21d11f",
"borderType":"FULL_BORDER",
"borderColor": "#ff0000",
"clean": false
}
}
}
```
### cURL 请求示例
```
curl --location --request PUT 'https://open.larksuite.com/open-apis/sheets/v2/spreadsheets/shtcngNygNfuqhxTBf588jwgWbJ/style' \
--header 'Authorization: Bearer t-e346617a4acfc3a11d4ed24dca0d0c0fc8e0067e' \
--header 'Content-Type: application/json' \
--data-raw '{
"appendStyle":{
"range": "BzY8T5!A3:C4",
"style":{
"font":{
"bold":true,
"italic":true,
"fontSize":"10pt/1.5",
"clean":false
},
"textDecoration":0,
"formatter":"",
"hAlign": 0 ,
"vAlign":0,
"foreColor":"#000000",
"backColor":"#21d11f",
"borderType":"FULL_BORDER",
"borderColor": "#ff0000",
"clean": false
}
}
}'
```
## 响应
### 响应体
|参数|类型|说明|
|--|-----|--|
|spreadsheetToken|string |spreadsheet 的 token|
|updatedRange|string |设置样式的范围|
|updatedRows|int|设置样式的行数|
|updatedColumns|int|设置样式的列数|
|updatedCells|int|设置样式的单元格总数|
|revision|int|sheet 的版本号|
### 响应体示例
```json
{
"code": 0,
"msg": "Success",
"data":{
"spreadsheetToken": "string",
"updatedRange": "string",
"updatedRows": 0,
"updatedColumns": 0,
"updatedCells": 0,
"revision": 0
}
}
```
### 错误码
具体可参考：[服务端错误码说明](https://open.larksuite.com/document/ukTMukTMukTM/ugjM14COyUjL4ITN)