使用 google-sheets4 库可以轻松访问 Google Sheets 服务的所有功能。

本文档是从 Sheets crate 版本 5.0.5+20240621 生成的，其中 20240621 是由 mako 代码生成器 v5.0.5 构建的 sheets:v4 架构的确切修订版本。

有关 Sheets v4 API 的其他信息，请参阅 官方文档网站。

功能

从中心 枢纽 轻松处理以下 资源 ...

• 工作表
• 批量更新，创建，开发者元数据获取，开发者元数据搜索，获取，按数据筛选获取，复制工作表到，追加值，批量清除值，按数据筛选批量清除值，批量获取值，按数据筛选批量获取值，批量更新值，按数据筛选批量更新值，清除值，获取值以及更新值

库的结构

API结构如下主要项

• 中心
  • 一个中央对象，用于维护状态并允许访问所有活动
  • 创建方法构建器，这些构建器反过来允许访问单个调用构建器
• 资源
  • 主要类型，可以将活动应用于这些类型
  • 属性和部分的集合
  • 部分
    • 属性集合
    • 在活动中从不直接使用
• 活动
  • 应用于资源的操作

所有结构都带有适用的特性行为，以进一步分类它们并便于浏览。

一般来说，你可以这样调用活动

let r = hub.resource().activity(...).doit().await

或者具体...

let r = hub.spreadsheets().developer_metadata_get(...).doit().await
let r = hub.spreadsheets().developer_metadata_search(...).doit().await
let r = hub.spreadsheets().sheets_copy_to(...).doit().await
let r = hub.spreadsheets().values_append(...).doit().await
let r = hub.spreadsheets().values_batch_clear(...).doit().await
let r = hub.spreadsheets().values_batch_clear_by_data_filter(...).doit().await
let r = hub.spreadsheets().values_batch_get(...).doit().await
let r = hub.spreadsheets().values_batch_get_by_data_filter(...).doit().await
let r = hub.spreadsheets().values_batch_update(...).doit().await
let r = hub.spreadsheets().values_batch_update_by_data_filter(...).doit().await
let r = hub.spreadsheets().values_clear(...).doit().await
let r = hub.spreadsheets().values_get(...).doit().await
let r = hub.spreadsheets().values_update(...).doit().await
let r = hub.spreadsheets().batch_update(...).doit().await
let r = hub.spreadsheets().create(...).doit().await
let r = hub.spreadsheets().get(...).doit().await
let r = hub.spreadsheets().get_by_data_filter(...).doit().await

resource()和activity(...)调用创建构建器。第二个处理活动支持各种方法来配置即将进行的操作（此处未显示）。它设计为必须立即指定所有必需的参数（即(...)），而所有可选的参数都可以根据需要构建。doit()方法执行与服务器之间的实际通信并返回相应的结果。

用法

设置你的项目

要使用此库，您需要在您的Cargo.toml文件中放入以下行

[dependencies]
google-sheets4 = "*"
serde = "^1.0"
serde_json = "^1.0"

一个完整的例子

extern crate hyper;
extern crate hyper_rustls;
extern crate google_sheets4 as sheets4;
use sheets4::api::ValueRange;
use sheets4::{Result, Error};
use std::default::Default;
use sheets4::{Sheets, oauth2, hyper, hyper_rustls, chrono, FieldMask};

// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: oauth2::ApplicationSecret = Default::default();
// Instantiate the authenticator. It will choose a suitable authentication flow for you, 
// unless you replace  `None` with the desired Flow.
// Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about 
// what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and
// retrieve them from storage.
let auth = oauth2::InstalledFlowAuthenticator::builder(
        secret,
        oauth2::InstalledFlowReturnMethod::HTTPRedirect,
    ).build().await.unwrap();
let mut hub = Sheets::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = ValueRange::default();

// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.spreadsheets().values_append(req, "spreadsheetId", "range")
             .value_input_option("no")
             .response_value_render_option("ipsum")
             .response_date_time_render_option("voluptua.")
             .insert_data_option("At")
             .include_values_in_response(false)
             .doit().await;

match result {
    Err(e) => match e {
        // The Error enum provides details about what exactly happened.
        // You can also just use its `Debug`, `Display` or `Error` traits
         Error::HttpError(_)
        |Error::Io(_)
        |Error::MissingAPIKey
        |Error::MissingToken(_)
        |Error::Cancelled
        |Error::UploadSizeLimitExceeded(_, _)
        |Error::Failure(_)
        |Error::BadRequest(_)
        |Error::FieldClash(_)
        |Error::JsonDecodeError(_, _) => println!("{}", e),
    },
    Ok(res) => println!("Success: {:?}", res),
}

处理错误

系统产生的所有错误都作为 Result 枚举返回值，或者作为可能的中继结果传递给 Hub Delegate 或 Authenticator Delegate。

当代理处理错误或中间值时，它们有机会指导系统重试。这使得系统可能对所有类型的错误都有抵抗力。

上传和下载

如果一个方法支持下载，你应该读取响应体（它是 Result 的一部分）以获取媒体。如果这样的方法也支持 Response Result，它将默认返回它。你可以将其视为实际媒体的元数据。要触发媒体下载，你必须通过以下调用设置构建器：.param("alt", "media")。

支持上传的方法可以使用最多 2 种不同的协议：简单 和 可恢复。每种协议的独特性由定制的 doit(...) 方法表示，分别命名为 upload(...) 和 upload_resumable(...)。

定制和回调

你可以通过在最终 doit() 调用之前向 Method Builder 提供一个 delegate 来更改 doit() 方法的调用方式。相应的方法将被调用以提供进度信息，并确定系统在失败时是否应该重试。

delegate trait 默认实现，允许你用最少的努力进行自定义。

服务器请求中的可选部分

此库提供的所有结构都是为了通过 json 进行 encodable 和 decodable。可选部分用于表示部分请求或响应是有效的。大多数可选部分都是可以识别的 Parts，通过名称标识，这些部分将被发送到服务器以指示请求的设置部分或响应中期望的部分。

构建器参数

使用 method builders，你可以通过重复调用它的方法来准备一个动作调用。这些方法将始终接受单个参数，以下陈述适用于该参数。

• PODs 通过复制传递
• 字符串作为 &str 传递
• request values 被移动

参数始终会被复制或克隆到构建器中，以确保它们与其原始生命周期独立。

Cargo 功能

• utoipa - 添加对 utoipa 的支持，并为所有类型推导出 utoipa::ToSchema。您必须在 #[openapi(schemas(...))] 中导入和注册所需的类型，否则生成的 openapi 规范将无效。

许可证

sheets4 库由 Sebastian Thiel 创建，并置于 MIT 许可证下。您可以在存储库的 许可证文件 中阅读全文。