open_lark/service/cloud_docs/sheets/v2/data_operation/
write_image.rs

1use serde::{Deserialize, Serialize};
2
3use crate::{
4    core::{
5        api_req::ApiRequest,
6        api_resp::{ApiResponseTrait, BaseResponse, ResponseFormat},
7        constants::AccessTokenType,
8        req_option, SDKResult,
9    },
10    service::sheets::v2::SpreadsheetService,
11};
12
13/// 写入图片
14#[derive(Serialize, Debug, Default)]
15pub struct WriteImageRequest {
16    #[serde(skip)]
17    api_request: ApiRequest,
18    #[serde(skip)]
19    spreadsheet_token: String,
20    /// 查询范围 range=`<sheetId>!<开始格子>:<结束格子>`
21    /// 如:xxxx!A1:D5,详见在线表格开发指南。此处限定为一个格子,如: xxxx!A1:A1
22    range: String,
23    /// 需要写入的图片二进制流,支持 "PNG", "JPEG", "JPG", "GIF", "BMP", "JFIF", "EXIF", "TIFF",
24    /// "BPG", "HEIC" 等图片格式
25    image: Vec<u8>,
26    /// 写入的图片名字
27    name: String,
28}
29
30impl WriteImageRequest {
31    pub fn builder() -> WriteImageRequestBuilder {
32        WriteImageRequestBuilder::default()
33    }
34}
35
36#[derive(Default)]
37pub struct WriteImageRequestBuilder {
38    request: WriteImageRequest,
39}
40
41impl WriteImageRequestBuilder {
42    pub fn spreadsheet_token(mut self, spreadsheet_token: impl ToString) -> Self {
43        self.request.spreadsheet_token = spreadsheet_token.to_string();
44        self
45    }
46
47    pub fn range(mut self, range: impl ToString) -> Self {
48        self.request.range = range.to_string();
49        self
50    }
51
52    pub fn image(mut self, image: Vec<u8>) -> Self {
53        self.request.image = image;
54        self
55    }
56
57    pub fn name(mut self, name: impl ToString) -> Self {
58        self.request.name = name.to_string();
59        self
60    }
61
62    pub fn build(mut self) -> WriteImageRequest {
63        self.request.api_request.body = serde_json::to_vec(&self.request).unwrap();
64        self.request
65    }
66}
67
68/// 写入图片响应体
69#[derive(Debug, Deserialize)]
70pub struct WriteImageResponse {
71    /// spreadsheet 的 token
72    #[serde(rename = "spreadsheetToken")]
73    pub spread_sheet_token: String,
74    /// spreadsheet 的版本号
75    pub revision: i32,
76    /// 写入图片的range
77    #[serde(rename = "updateRange")]
78    pub update_range: String,
79}
80
81impl ApiResponseTrait for WriteImageResponse {
82    fn data_format() -> ResponseFormat {
83        ResponseFormat::Data
84    }
85}
86
87impl SpreadsheetService {
88    /// 该接口用于根据 spreadsheetToken 和 range 向单个格子写入图片。
89    pub async fn write_image(
90        &self,
91        request: WriteImageRequest,
92        option: Option<req_option::RequestOption>,
93    ) -> SDKResult<BaseResponse<WriteImageResponse>> {
94        let mut api_req = request.api_request;
95        api_req.api_path = format!(
96            "/open-apis/sheets/v2/spreadsheets/{spreadsheet_token}/values_image",
97            spreadsheet_token = request.spreadsheet_token
98        );
99        api_req.http_method = reqwest::Method::POST;
100        api_req.supported_access_token_types = vec![AccessTokenType::Tenant, AccessTokenType::App];
101
102        let api_resp = crate::core::http::Transport::request(api_req, &self.config, option).await?;
103
104        Ok(api_resp)
105    }
106}