#google #protocols #google-api #web #web-api #api #mybusinessbusinessin

google-mybusinessbusinessinformation1

一个用于与 My Business Business Information(协议 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 日

#2701 in Web 编程


用于 google-mybusinessbusiness…

MIT 许可证

335KB
4K SLoC

google-mybusinessbusinessinformation1 库允许访问 Google My Business Business Information 服务的所有功能。

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

有关 My Business Business Information v1 API 的其他所有信息,请参阅 官方文档网站

功能

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

库的结构

API结构如下几个主要元素

  • 枢纽
  • 资源
    • 主要类型,可以将其应用于活动
    • 一组属性和部分
    • 部分
      • 一组属性
      • 永远不会在活动中直接使用
  • 活动
    • 应用于资源的操作

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

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

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

或者更具体...

let r = hub.accounts().locations_create(...).doit().await
let r = hub.locations().attributes_get_google_updated(...).doit().await
let r = hub.locations().delete(...).doit().await
let r = hub.locations().get(...).doit().await
let r = hub.locations().get_attributes(...).doit().await
let r = hub.locations().get_google_updated(...).doit().await
let r = hub.locations().patch(...).doit().await
let r = hub.locations().update_attributes(...).doit().await

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

使用方法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_mybusinessbusinessinformation1 as mybusinessbusinessinformation1;
use mybusinessbusinessinformation1::api::Location;
use mybusinessbusinessinformation1::{Result, Error};
use std::default::Default;
use mybusinessbusinessinformation1::{MyBusinessBusinessInformation, 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 = MyBusinessBusinessInformation::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 = Location::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.accounts().locations_create(req, "parent")
             .validate_only(true)
             .request_id("voluptua.")
             .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 Delegate,或者传递给Authenticator Delegate

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

上传和下载

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

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

定制和回调

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

delegate trait默认实现,允许您以最小的努力进行定制。

服务器请求中的可选部分

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

构建器参数

使用method builders,您可以通过重复调用其方法来准备一个动作调用。这些方法始终接受一个参数,以下陈述适用于该参数。

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

Cargo Features

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

许可证

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

依赖项

~12–22MB
~342K SLoC