#google-api #google #web-api #api #protocols #web #mybusinesslodging

google-mybusinesslodging1

用于与 My Business Lodging(协议版本 v1)交互的完整库

8 个版本 (稳定版)

5.0.5+20240625 2024年6月27日
5.0.4+20240304 2024年3月5日
5.0.3+20230124 2023年8月24日
5.0.2+20230124 2023年3月17日
3.0.0+20220305 2022年3月8日

#2581 in 网页开发


用于 google-mybusinesslodging1…

MIT 许可证

260KB
3K SLoC

google-mybusinesslodging1 库允许访问 Google My Business Lodging 服务(协议版本 v1)的所有功能。

此文档是根据 My Business Lodging 库版本 5.0.5+20240625 生成的,其中 20240625 是由 mako 代码生成器 v5.0.5 构建的 mybusinesslodging:v1 模式的确切修订版本。

关于 My Business Lodging v1 API 的其他所有信息都可以在 官方文档网站 上找到。

功能

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

此库的结构

API 被结构化为以下主要项

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

所有 结构 都用适用的特性标记,以进一步分类它们并简化浏览。

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

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

或具体地 ...

let r = hub.locations().get_lodging(...).doit().await
let r = hub.locations().update_lodging(...).doit().await

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

使用方法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_mybusinesslodging1 as mybusinesslodging1;
use mybusinesslodging1::api::Lodging;
use mybusinesslodging1::{Result, Error};
use std::default::Default;
use mybusinesslodging1::{MyBusinessLodging, 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 = MyBusinessLodging::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 = Lodging::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.locations().update_lodging(req, "name")
             .update_mask(FieldMask::new::<&str>(&[]))
             .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"

支持上传的方法可以使用最多2种不同的协议:简单可分段的。每种方法的独特性通过定制的doit(...)方法表示,分别命名为upload(...)upload_resumable(...)

自定义和回调

您可以通过在调用最终doit()之前提供一个委托方法构建器来更改调用doit()方法的方式。相应的方法将被调用以提供进度信息,以及确定系统在失败时是否应重试。

委托特质默认实现,允许您以最小的努力对其进行自定义。

服务器请求中的可选部分

本库提供的所有结构均设计为可通过json进行编码解码。使用可选类型(Optionals)来表示部分请求和响应是有效的。大多数可选类型被认为是部分,可以通过名称识别,这些部分将被发送到服务器以指示请求的设置部分或响应中希望包含的部分。

构建器参数

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

  • 数据结构(PODs)通过复制传递
  • 字符串作为 &str 传递
  • 请求值(Request Values)被移动

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

Cargo功能

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

许可

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

依赖关系

~12-23MB
~343K SLoC