#google #web #protocols #google-api #web-api #accelerated-mobile-pages

google-acceleratedmobilepageurl1

一个完整的库,用于与加速移动页面 URL (协议 v1) 交互

19 个稳定版本 (4 个主要版本)

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日
1.0.7+20171202 2018年2月1日

#2595 in Web 编程

Download history 2/week @ 2024-05-18 1/week @ 2024-05-25 2/week @ 2024-06-08 1/week @ 2024-06-15 83/week @ 2024-06-22 12/week @ 2024-06-29

1,175 每月下载次数
用于 google-acceleratedmobilep…

MIT 许可证

105KB
1.5K SLoC

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

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

有关加速移动页面 URL v1 API 的其他所有信息,请参阅 官方文档网站

功能

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

本库的结构

API 结构为以下主要项目

  • 中心
  • 资源
    • 可以将其应用于 活动 的主要类型
    • 一组属性和 部分
    • 部分
      • 一组属性
      • 不直接用于 活动
  • 活动
    • 应用于 资源 的操作

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

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

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

或具体来说...

let r = hub.amp_urls().batch_get(...).doit().await

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

用法

设置项目

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

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

一个完整的例子

extern crate hyper;
extern crate hyper_rustls;
extern crate google_acceleratedmobilepageurl1 as acceleratedmobilepageurl1;
use acceleratedmobilepageurl1::api::BatchGetAmpUrlsRequest;
use acceleratedmobilepageurl1::{Result, Error};
use std::default::Default;
use acceleratedmobilepageurl1::{Acceleratedmobilepageurl, 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 = Acceleratedmobilepageurl::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 = BatchGetAmpUrlsRequest::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.amp_urls().batch_get(req)
             .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(...)

自定义和回调

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

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

服务器请求中的可选部分

本库提供的所有结构都设计为可通过 编码解码json 格式。使用可选类型来表示部分请求或响应是有效的。大多数可选类型都是 部件,通过名称可识别,将发送到服务器以指示请求的集合部分或响应中所需的部分。

构建器参数

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

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

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

Cargo 功能

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

许可证

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

依赖关系

~12–23MB
~347K SLoC