#google #protocols #web #google-api #web-api #site-verification

google-siteverification1

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

44 个版本 (26 个稳定版本)

5.0.5+20191119 2024年6月27日
5.0.4+20191119 2024年3月5日
5.0.3+20191119 2023年8月24日
5.0.2+20191119 2023年3月17日
0.1.2+20131007 2015年3月25日

#2493 in 网页编程


用于 google-siteverification1-…

MIT 许可证

180KB
2.5K SLoC

google-siteverification1 库允许访问 Google siteVerification(服务)的所有功能。

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

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

功能

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

此库的结构

API 结构如下主要项目

  • 枢纽
  • 资源
    • 可以应用于 活动 的主要类型
    • 一组属性和 部分
    • 部分
      • 一组属性
      • 活动 中 never 直接使用
  • 活动
    • 应用于 资源 的操作

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

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

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

或具体地说...

let r = hub.web_resource().get(...).doit().await
let r = hub.web_resource().insert(...).doit().await
let r = hub.web_resource().patch(...).doit().await
let r = hub.web_resource().update(...).doit().await

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

用法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_siteverification1 as siteverification1;
use siteverification1::api::SiteVerificationWebResourceResource;
use siteverification1::{Result, Error};
use std::default::Default;
use siteverification1::{SiteVerification, 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 = SiteVerification::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 = SiteVerificationWebResourceResource::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.web_resource().insert(req, "verificationMethod")
             .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 DelegateAuthenticator Delegate

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

上传和下载

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

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

定制和回调

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

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

服务器请求中的可选部分

本库提供的所有结构都是为了通过json进行编码和解码而设计的。通过RequestValueResponseResult进行编码和解码。使用可选参数来表示部分请求或响应是有效的。大多数可选参数都被视为Parts,可以通过名称识别,这些将被发送到服务器以指示请求的设置部分或响应中期望的部分。

构建器参数

使用方法构建器,您可以重复调用其方法来准备一个动作调用。这些方法始终接受单个参数,以下是一些关于该参数的说明。

  • PODs通过复制传递
  • 字符串作为&str传递
  • 请求值被移动

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

Cargo功能

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

许可证

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

依赖项

~12-23MB
~346K SLoC