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月16日 |
3.0.0+20220305 | 2022年3月8日 |
#2596 in 网页开发
每月476次 下载
用于 google-mybusinessverifica…
170KB
2K SLoC
google-mybusinessverifications1
库允许访问 Google My Business Verifications 服务(协议 v1)的所有功能。
本文档是从 My Business Verifications 库版本 5.0.5+20240625 生成的,其中 20240625 是由 mako 代码生成器 v5.0.5 构建的 mybusinessverifications:v1 模式的确切修订版。
关于 My Business Verifications v1 API 的其他信息可以在 官方文档网站 上找到。
功能
从中央 枢纽 简单地处理以下 资源...
库结构
API 结构如下主要项
所有 结构 都带有适用的特性,以便进一步分类和便于浏览。
一般来说,您可以像这样调用 活动
let r = hub.resource().activity(...).doit().await
或者具体来说...
let r = hub.locations().verify(...).doit().await
resource()
和 activity(...)
调用创建了 构建器。第二个处理 活动
,支持各种方法来配置即将进行的操作(此处未显示)。它设计成必须立即指定所有必需的参数(即 (...)
),而所有可选的都可以按需 构建。doit()
方法执行与服务器的实际通信并返回相应的结果。
用法
设置您的项目
要使用此库,您需要将以下行放入您的 Cargo.toml
文件中
[dependencies]
google-mybusinessverifications1 = "*"
serde = "^1.0"
serde_json = "^1.0"
一个完整的示例
extern crate hyper;
extern crate hyper_rustls;
extern crate google_mybusinessverifications1 as mybusinessverifications1;
use mybusinessverifications1::api::VerifyLocationRequest;
use mybusinessverifications1::{Result, Error};
use std::default::Default;
use mybusinessverifications1::{MyBusinessVerifications, 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 = MyBusinessVerifications::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 = VerifyLocationRequest::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().verify(req, "name")
.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")
。
支持上传的方法可以使用最多两种不同的协议:简单 和 可恢复。每种协议的独特之处都由定制的 doit(...)
方法表示,分别命名为 upload(...)
和 upload_resumable(...)
。
定制和回调
您可以通过提供一个委托给方法构建器来修改调用doit()
方法的方式,在执行最终的doit()
调用之前。相应的函数将被调用以提供进度信息,并确定系统在失败时是否应该重试。
委托特质默认实现,允许您以最小的努力进行自定义。
服务器请求的可选部分
此库提供的所有结构都是设计成可以通过json进行编码和解码的。可选参数用于表示部分请求和响应是有效的。大多数可选参数被视为部分,这些部分可以通过名称识别,将它们发送到服务器以指示请求的设置部分或响应中期望的部分。
构建器参数
使用方法构建器,您可以通过反复调用其方法来准备一个动作调用。这些方法始终接受一个参数,以下陈述对它适用。
参数将始终被复制或克隆到构建器中,以确保它们与其原始的生命周期独立。
Cargo功能
utoipa
- 添加对utoipa的支持,并在所有类型上派生utoipa::ToSchema
。您必须在#[openapi(schemas(...))]
中导入并注册所需的类型,否则生成的openapi
规范将是无效的。
许可证
mybusinessverifications1库是由Sebastian Thiel生成的,并根据MIT许可证发布。您可以在存储库的许可证文件中阅读全文。
依赖关系
~12–23MB
~343K SLoC