# 更新浮动图片
更新已有的浮动图片位置和宽高。
## 请求
基本 |
---|---
HTTP URL | https://open.feishu.cn/open-apis/sheets/v3/spreadsheets/:spreadsheet_token/sheets/:sheet_id/float_images/:float_image_id
HTTP Method | PATCH
接口频率限制 | [100 次/分钟](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App、Store App
权限要求
**调用该 API 所需的权限。开启其中任意一项权限即可调用**
开启任一权限即可 | 查看、评论、编辑和管理云空间中所有文件(drive:drive)
查看、评论、编辑和管理电子表格(sheets:spreadsheet)
编辑电子表格(sheets:spreadsheet:write_only)
### 请求头
名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `tenant_access_token`
或
`user_access_token`
**值格式**："Bearer `access_token`"
**示例值**："Bearer u-7f1bcd13fc57d46bac21793a18e560"
[了解更多：如何选择与获取 access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)
Content-Type | string | 是 | **固定值**："application/json; charset=utf-8"
### 路径参数
名称 | 类型 | 描述
---|---|---
spreadsheet_token | string | 电子表格的 token。可通过以下两种方式获取。了解更多，参考[电子表格概述](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview)。
- 电子表格的 URL：https://sample.feishu.cn/sheets/==Iow7sNNEphp3WbtnbCscPqabcef==
- 调用[获取文件夹中的文件清单](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/list)
**示例值**："Iow7sNNEphp3WbtnbCscPqabcef"
sheet_id | string | 电子表格工作表的 ID。调用[获取工作表](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/query)获取 ID。
**示例值**："0beg12"
float_image_id | string | 工作表内浮动图片的唯一标识。通过[查询浮动图片](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-float_image/query)接口获取。
**示例值**："ye06SS14ph"
### 请求体
名称 | 类型 | 必填 | 描述
---|---|---|---
float_image_token | string | 否 | 在本更新接口中，该参数无需传入。
**示例值**："boxcnrHpsg1QDqXAAAyachabcef"
range | string | 否 | 浮动图片左上角所在单元格位置，只允许单个单元格的形式，如 "ahgsch!A1:A1"。了解更多，参考[浮动图片使用指南](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-float_image/float-image-user-guide)。
**示例值**："ahgsch!A1:A1"
width | number(float) | 否 | 浮动图片的宽度，单位为像素。不传会默认采用图片实际宽度，如果传则需要大于等于 20 像素。了解更多，参考[浮动图片使用指南](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-float_image/float-image-user-guide)。
**示例值**：100
height | number(float) | 否 | 浮动图片的高度，单位为像素。不传会默认采用图片实际高度，如果传则需要大于等于 20 像素。了解更多，参考[浮动图片使用指南](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-float_image/float-image-user-guide)。
**示例值**：100
offset_x | number(float) | 否 | 浮动图片左上角距离所在单元格左上角的横向偏移，单位为像素，默认为 0，设置的值需要大于等于 0、小于浮动图片左上角所在单元格的宽度。了解更多，参考[浮动图片使用指南](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-float_image/float-image-user-guide)。
**示例值**：0
offset_y | number(float) | 否 | 浮动图片左上角距离所在单元格左上角的纵向偏移，单位为像素，默认为 0。设置的值需要大于等于 0、小于浮动图片左上角所在单元格的高度。了解更多，参考[浮动图片使用指南](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-float_image/float-image-user-guide)。
**示例值**：0
### 请求体示例
```json
{
"float_image_token": "boxcnrHpsg1QDqXAAAyachabcef",
"range": "ahgsch!A1:A1",
"width": 100,
"height": 100,
"offset_x": 0,
"offset_y": 0
}
```
### cURL 请求示例
```bash
curl --location --request PATCH 'https://open.feishu.cn/open-apis/sheets/v3/spreadsheets/shtbchuIXPxjaYxsZzQxBqPxxxxx/sheets/ea131a/float_images/ye06SS14pr' \
--header 'Authorization: Bearer t-384c15ba0644b82caecec91553386563c814c4b9' \
--header 'Content-Type: application/json' \
--data-raw '{
"offset_y": 20,
"width": 100
}'
```
## 响应
### 响应体
名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
float_image | float_image | 浮动图片的相关参数
float_image_id | string | 浮动图片的唯一标识。用于对图片进行增删改查操作。
float_image_token | string | 浮动图片的 token，用于图片的上传和下载操作。你可通过该 token，调用[下载素材](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/media/download)接口下载图片。
range | string | 浮动图片左上角所在单元格位置
width | number(float) | 浮动图片的宽度，单位为像素。
height | number(float) | 浮动图片的高度，单位为像素。
offset_x | number(float) | 浮动图片左上角距离所在单元格左上角的横向偏移，单位为像素。
offset_y | number(float) | 浮动图片左上角距离所在单元格左上角的纵向偏移，单位为像素。
### 响应体示例
```json
{
"code": 0,
"msg": "success",
"data": {
"float_image": {
"float_image_id": "ye06SS14ph",
"float_image_token": "boxbcbQsaSqIXsxxxxx1HCPJFbh",
"range": "ahgsch!A1:A1",
"width": 100,
"height": 100,
"offset_x": 0,
"offset_y": 0
}
}
}
```
### 错误码
HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
500 | 1315201 | Server Error | 服务内部错误，请l联系[技术支持](https://applink.feishu.cn/TLJpeNdW)
500 | 1315203 | Server Error | 服务内部错误，请l联系[技术支持](https://applink.feishu.cn/TLJpeNdW)
400 | 1310235 | Retry Later | 稍后重试
400 | 1310217 | Too Many Request | 请求发送过于频繁，请稍后重试
400 | 1310226 | Excess Limit | 超出限制，参考响应体中的错误提示
400 | 1310215 | Sheet Id Not Found | 工作表 ID 不存在。请检查工作表 ID 是否填写
400 | 1310214 | SpreadSheet Not Found | 电子表格 token 不存在。请检查表格 token 是否填写
400 | 1310218 | Locked Cell | `range` 参数对应的单元格位置为保护范围。你可调用[删除保护范围](https://open.feishu.cn/document/ukTMukTMukTM/uYTM5YjL2ETO24iNxkjN)接口为该单元格删除保护范围或重新设置 `range` 参数
400 | 1310213 | Permission Fail | 没有文档权限。参考[云文档常见问题](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN#16c6475a)问题 3 开通文档权限
400 | 1310229 | Wrong URL Param | 检查 URL 中的路径参数是否填写正确
400 | 1310202 | Wrong Range | `range` 参数填写错误。请检查 `range` 参数
400 | 1310246 | Wrong Float Image Value | 图片宽高或者偏移参数错误。请检查 `width`、`heigh`t、`offset_x` 和 `offset_y` 参数填写是否正确
400 | 1310243 | Wrong Float Image Id | 浮动图片 ID 错误，请检查 `float_image_id` 参数是否填写正确
400 | 1310211 | Wrong Sheet Id | 电子表格工作表的 ID 错误。请检查工作表的 ID
400 | 1310242 | In Mix state | 当前表格数据位于用户机房，正在将数据恢复到 SaaS 环境中，请稍后重试
400 | 1310249 | Spreadsheet Deleted | 电子表格被删除，请恢复表格后重试