open_lark/service/cloud_docs/sheets/v3/data_operation/
append_data.rs

1use reqwest::Method;
2use serde::{Deserialize, Serialize};
3
4use crate::{
5    core::{
6        api_req::ApiRequest,
7        api_resp::{ApiResponseTrait, BaseResponse, ResponseFormat},
8        constants::AccessTokenType,
9        endpoints::cloud_docs::*,
10        http::Transport,
11        req_option::RequestOption,
12        standard_response::StandardResponse,
13        SDKResult,
14    },
15    impl_executable_builder_owned,
16    service::sheets::v3::DataOperationService,
17};
18
19impl DataOperationService {
20    /// 追加数据
21    ///
22    /// <https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-value/append>
23    pub async fn append_data(
24        &self,
25        request: AppendDataRequest,
26        option: Option<RequestOption>,
27    ) -> SDKResult<AppendDataResponseData> {
28        let mut api_req = request.api_request;
29        api_req.http_method = Method::POST;
30        api_req.api_path = SHEETS_V3_SPREADSHEET_VALUES_APPEND
31            .replace("{}", &request.spreadsheet_token)
32            .replace("{}", &request.range);
33        api_req.supported_access_token_types = vec![AccessTokenType::Tenant, AccessTokenType::User];
34
35        let api_resp: BaseResponse<AppendDataResponseData> =
36            Transport::request(api_req, &self.config, option).await?;
37
38        api_resp.into_result()
39    }
40}
41
42/// 追加数据请求
43#[derive(Default, Debug, Serialize, Deserialize)]
44pub struct AppendDataRequest {
45    #[serde(skip)]
46    api_request: ApiRequest,
47    /// spreadsheet 的 token
48    spreadsheet_token: String,
49    /// 查询范围，包含 sheetId 与单元格范围两部分
50    range: String,
51    /// 插入数据的方式
52    #[serde(rename = "insertDataOption")]
53    insert_data_option: Option<String>,
54    /// 数据值
55    #[serde(rename = "valueRange")]
56    value_range: ValueRangeRequest,
57}
58
59impl AppendDataRequest {
60    pub fn builder() -> AppendDataRequestBuilder {
61        AppendDataRequestBuilder::default()
62    }
63}
64
65#[derive(Default)]
66pub struct AppendDataRequestBuilder {
67    request: AppendDataRequest,
68}
69
70impl AppendDataRequestBuilder {
71    pub fn spreadsheet_token(mut self, spreadsheet_token: impl ToString) -> Self {
72        self.request.spreadsheet_token = spreadsheet_token.to_string();
73        self
74    }
75
76    pub fn range(mut self, range: impl ToString) -> Self {
77        self.request.range = range.to_string();
78        self
79    }
80
81    pub fn insert_data_option(mut self, insert_data_option: impl ToString) -> Self {
82        self.request.insert_data_option = Some(insert_data_option.to_string());
83        self
84    }
85
86    pub fn values(mut self, values: Vec<Vec<serde_json::Value>>) -> Self {
87        self.request.value_range = ValueRangeRequest {
88            range: self.request.range.clone(),
89            values,
90        };
91        self
92    }
93
94    pub fn build(mut self) -> AppendDataRequest {
95        self.request.api_request.body = serde_json::to_vec(&self.request).unwrap();
96        self.request
97    }
98}
99
100// Trait implementation
101impl_executable_builder_owned!(
102    AppendDataRequestBuilder,
103    DataOperationService,
104    AppendDataRequest,
105    AppendDataResponseData,
106    append_data
107);
108
109/// 值与范围请求
110#[derive(Default, Debug, Serialize, Deserialize)]
111pub struct ValueRangeRequest {
112    /// 查询范围
113    pub range: String,
114    /// 范围内的值
115    pub values: Vec<Vec<serde_json::Value>>,
116}
117
118/// 追加数据响应体最外层
119#[derive(Deserialize, Debug)]
120pub struct AppendDataResponseData {
121    /// 表格的 token
122    #[serde(rename = "spreadsheetToken")]
123    pub spreadsheet_token: String,
124    /// 数据更新的位置
125    #[serde(rename = "tableRange")]
126    pub table_range: String,
127    /// sheet 的版本号
128    pub revision: i32,
129    /// 更新的行数
130    pub updates: UpdatesInfo,
131}
132
133impl ApiResponseTrait for AppendDataResponseData {
134    fn data_format() -> ResponseFormat {
135        ResponseFormat::Data
136    }
137}
138
139/// 更新信息
140#[derive(Deserialize, Debug)]
141pub struct UpdatesInfo {
142    /// 受更新影响的表格范围
143    #[serde(rename = "updatedRange")]
144    pub updated_range: String,
145    /// 更新的行数
146    #[serde(rename = "updatedRows")]
147    pub updated_rows: i32,
148    /// 更新的列数
149    #[serde(rename = "updatedColumns")]
150    pub updated_columns: i32,
151    /// 更新的单元格数
152    #[serde(rename = "updatedCells")]
153    pub updated_cells: i32,
154}
155
156#[cfg(test)]
157#[allow(unused_variables, unused_unsafe)]
158mod test {
159    use serde_json::json;
160
161    use super::AppendDataResponseData;
162
163    #[test]
164    fn test_append_data_response() {
165        let json = json!({
166            "spreadsheetToken": "shtcnmBA*****yGehy8",
167            "tableRange": "Sheet1!A1:B2",
168            "revision": 123,
169            "updates": {
170                "updatedRange": "Sheet1!A3:B3",
171                "updatedRows": 1,
172                "updatedColumns": 2,
173                "updatedCells": 2
174            }
175        });
176
177        let response: AppendDataResponseData = serde_json::from_value(json).unwrap();
178        assert_eq!(response.spreadsheet_token, "shtcnmBA*****yGehy8");
179        assert_eq!(response.updates.updated_rows, 1);
180    }
181}
open_lark/service/cloud_docs/sheets/v3/data_operation/append_data.rs

open_lark/service/cloud_docs/sheets/v3/data_operation/
append_data.rs
