#google-api #web-api #google #protocols #api #web #localservices

google-localservices1

一个与 Localservices (协议 v1) 交互的完整库

11 个稳定版本 (3 个主要版本)

5.0.5+20240625 2024年6月27日
5.0.4+20240303 2024年3月5日
5.0.3+20230123 2023年8月23日
5.0.2+20230123 2023年3月16日
2.0.4+20210330 2021年4月15日

#2736 in 网页开发


用于 google-localservices1-cli

MIT 许可证

140KB
2K SLoC

google-localservices1 库允许访问 Google Localservices 服务(协议 v1)的所有功能。

本文档是从 Localservices crate 版本 5.0.5+20240625 生成的,其中 20240625 是由 mako 代码生成器 v5.0.5 构建的 localservices:v1 模式的确切修订版本。

有关 Localservices v1 API 的其他信息,请参阅 官方文档网站

功能

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

本库的结构

API 结构如下主要项

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

所有 结构 都带有适用的特性和类别,以便进一步分类并便于浏览。

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

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

或者具体...

let r = hub.account_reports().search(...).doit().await

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

使用方法

设置你的项目

要使用这个库,你需要在你的Cargo.toml文件中添加以下几行

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_localservices1 as localservices1;
use localservices1::{Result, Error};
use std::default::Default;
use localservices1::{Localservices, 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 = Localservices::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
// 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.account_reports().search()
             .start_date_year(-22)
             .start_date_month(-33)
             .start_date_day(-11)
             .query("ipsum")
             .page_token("voluptua.")
             .page_size(-27)
             .end_date_year(-8)
             .end_date_month(-80)
             .end_date_day(-2)
             .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枚举提供,作为doit()方法的返回值,或者作为中间结果传递给Hub DelegateAuthenticator Delegate

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

上传和下载

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

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

自定义和回调

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

默认实现了代理特例,允许您以最小的努力进行自定义。

服务器请求中的可选部分

此库提供的所有结构都旨在通过json进行编码和解码。可选部分用于表示部分请求或响应是有效的。大多数可选部分被认为是可识别的部分,通过名称进行识别,将被发送到服务器以指示请求的设置部分或所需的响应部分。

构建器参数

使用方法构建器,您可以通过重复调用其方法来准备一个操作调用。这些方法始终接受单个参数,以下语句是正确的。

  • POD通过复制传递
  • 字符串作为&str传递
  • 请求值是移动的

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

Cargo功能

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

许可证

localservices1库由Sebastian Thiel生成,并置于MIT许可证之下。您可以在存储库的许可证文件中阅读全文。

依赖项

~12–23MB
~346K SLoC