#google #协议 #钱包对象

google-walletobjects1

用于与钱包对象(协议v1)交互的完整库

6个版本 (稳定版)

5.0.5+20240626 2024年6月27日
5.0.4+20240304 2024年3月5日
5.0.3+20230124 2023年8月24日
5.0.2+20230124 2023年3月16日
4.0.4+20220928 2022年10月1日

967身份验证

每月43次 下载
google-walletobjects1-cli 中使用

MIT 协议

1.5MB
20K SLoC

《google-walletobjects1》库允许访问Google钱包对象服务的所有功能。

本文档是从Walletobjects crate版本5.0.5+20240626生成的,其中20240626mako代码生成器v5.0.5构建的walletobjects:v1模式的精确修订版本。

关于Walletobjects v1 API的其他信息可以在官方文档站点找到。

功能

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

由 ... 支持的上传

由 ... 支持的下载

本库的结构

API 结构如下主要项

  • 中心
  • 资源
    • 您可以将其应用于 活动 的主要类型
    • 属性和 部分 的集合
    • 部分
      • 属性集合
      • 活动 中从未直接使用
  • 活动
    • 应用于 资源 的操作

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

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

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

或者具体...

let r = hub.eventticketclass().addmessage(...).doit().await
let r = hub.eventticketobject().addmessage(...).doit().await
let r = hub.flightclass().addmessage(...).doit().await
let r = hub.flightobject().addmessage(...).doit().await
let r = hub.genericclass().addmessage(...).doit().await
let r = hub.genericobject().addmessage(...).doit().await
let r = hub.giftcardclass().addmessage(...).doit().await
let r = hub.giftcardobject().addmessage(...).doit().await
let r = hub.loyaltyclass().addmessage(...).doit().await
let r = hub.loyaltyobject().addmessage(...).doit().await
let r = hub.offerclass().addmessage(...).doit().await
let r = hub.offerobject().addmessage(...).doit().await
let r = hub.transitclass().addmessage(...).doit().await
let r = hub.transitobject().addmessage(...).doit().await

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

用法

设置项目

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

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_walletobjects1 as walletobjects1;
use walletobjects1::api::AddMessageRequest;
use walletobjects1::{Result, Error};
use std::default::Default;
use walletobjects1::{Walletobjects, 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 = Walletobjects::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 = AddMessageRequest::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.eventticketclass().addmessage(req, "resourceId")
             .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进行编码解码而设计的。可选部分用于表示部分请求和响应是有效的。大多数可选部分被认为是部分,这些部分可以通过名称识别,将被发送到服务器,以指示请求的设置部分或响应中期望的部分。

构建器参数

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

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

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

Cargo功能

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

许可证

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

依赖关系

~12–22MB
~344K SLoC