8 个版本 (稳定)

5.0.5+20240625 2024年6月27日
5.0.4+20240304 2024年3月5日
5.0.3+20230123 2023年8月24日
5.0.2+20230123 2023年3月17日
3.0.0+20220305 2022年3月8日

#2678 in Web编程


google-playintegrity1-cli 中使用

MIT 许可证

115KB
1.5K SLoC

google-playintegrity1 库允许访问Google Play Integrity服务的所有功能。

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

有关Play Integrity v1 API的其他信息,请参阅官方文档网站

功能

从以下中心 枢纽 轻松使用以下功能...

本库结构

API结构如下主要项目

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

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

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

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

或者具体地...

let r = hub.methods().decode_integrity_token(...).doit().await

资源()活动(...) 调用创建了建造者。后者处理 活动,支持配置即将进行的操作的各种方法(此处未展示)。它是这样的,即必须立即指定所有必需的参数(即 (...)),而所有可选的则可以按需构建doit() 方法执行与服务器的实际通信并返回相应的结果。

使用方法

设置你的项目

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

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

一个完整的例子

extern crate hyper;
extern crate hyper_rustls;
extern crate google_playintegrity1 as playintegrity1;
use playintegrity1::api::DecodeIntegrityTokenRequest;
use playintegrity1::{Result, Error};
use std::default::Default;
use playintegrity1::{PlayIntegrity, 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 = PlayIntegrity::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 = DecodeIntegrityTokenRequest::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.methods().decode_integrity_token(req, "packageName")
             .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() 之前向 Method Builder 提供一个 delegate 来改变 doit() 方法的调用方式。相应的函数将被调用来提供进度信息,以及确定系统在失败时应否重试。

delegate trait 有默认实现,这使得你可以以最少的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可证

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

依赖关系

~12–23MB
~346K SLoC