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

1use serde::Serialize;
2use serde_json::Value;
3
4use crate::{
5    core::{
6        api_req::ApiRequest, api_resp::BaseResponse, constants::AccessTokenType, req_option,
7        SDKResult,
8    },
9    impl_executable_builder_owned,
10    service::sheets::v2::{
11        data_operation::{UpdateSheetDataResponse, ValueRangeRequest},
12        SpreadsheetSheetService,
13    },
14};
15
16/// 追加数据请求
17#[derive(Serialize, Debug, Default)]
18pub struct AppendDataRequest {
19    #[serde(skip)]
20    api_request: ApiRequest,
21    #[serde(skip)]
22    spreadsheet_token: String,
23    /// 遇到空行追加,默认 OVERWRITE,若空行的数量小于追加数据的行数,则会覆盖已有数据;可选
24    /// INSERT_ROWS ,会在插入足够数量的行后再进行数据追加
25    #[serde(rename = "insertDataOption")]
26    insert_data_option: String,
27    /// 值与范围
28    #[serde(rename = "valueRange")]
29    value_range: ValueRangeRequest,
30}
31
32impl AppendDataRequest {
33    pub fn builder() -> AppendDataRequestBuilder {
34        AppendDataRequestBuilder::default()
35    }
36}
37
38#[derive(Default)]
39pub struct AppendDataRequestBuilder {
40    request: AppendDataRequest,
41}
42
43impl AppendDataRequestBuilder {
44    pub fn spreadsheet_token(mut self, spreadsheet_token: impl ToString) -> Self {
45        self.request.spreadsheet_token = spreadsheet_token.to_string();
46        self
47    }
48
49    /// 插入范围,包含 sheetId 与单元格范围两部分,目前支持四种索引方式,详见
50    /// 在线表格开发指南,range所表示的范围需要大于等于values占用的范围。
51    pub fn range(mut self, range: impl ToString) -> Self {
52        self.request.value_range.range = range.to_string();
53        self
54    }
55
56    /// 需要写入的值,如要写入公式、超链接、email、@人等,可详看附录sheet 支持写入数据类型
57    pub fn values(mut self, values: Value) -> Self {
58        self.request.value_range.values = values;
59        self
60    }
61
62    pub fn build(mut self) -> AppendDataRequest {
63        self.request.api_request.body = serde_json::to_vec(&self.request).unwrap();
64        self.request
65    }
66}
67
68pub type AppendDataResponse = UpdateSheetDataResponse;
69
70// 使用宏实现ExecutableBuilder trait
71impl_executable_builder_owned!(
72    AppendDataRequestBuilder,
73    SpreadsheetSheetService,
74    AppendDataRequest,
75    BaseResponse<AppendDataResponse>,
76    append_data
77);
78
79impl SpreadsheetSheetService {
80    /// 追加数据
81    pub async fn append_data(
82        &self,
83        request: AppendDataRequest,
84        option: Option<req_option::RequestOption>,
85    ) -> SDKResult<BaseResponse<AppendDataResponse>> {
86        let mut api_req = request.api_request;
87        api_req.api_path = format!(
88            "/open-apis/sheets/v2/spreadsheets/{spreadsheet_token}/values_append",
89            spreadsheet_token = request.spreadsheet_token
90        );
91        api_req.http_method = reqwest::Method::POST;
92        api_req.supported_access_token_types = vec![AccessTokenType::Tenant, AccessTokenType::App];
93
94        let api_resp = crate::core::http::Transport::request(api_req, &self.config, option).await?;
95
96        Ok(api_resp)
97    }
98}