#google #google-api #protocols #androidpublisher #web #web-api

google-androidpublisher2

一个用于与 Android Publisher (协议 v2) 交互的完整库

48 个版本 (30 个稳定版)

5.0.5+20200331 2024年6月27日
5.0.4+20200331 2024年3月5日
5.0.3+20200331 2023年8月23日
5.0.2+20200331 2023年3月16日
0.1.2+20150128 2015年3月25日

#2748 in 网页编程


google-androidpublisher2-… 中使用

MIT 许可证

1MB
13K SLoC

google-androidpublisher2 库允许访问 Google Android Publisher 服务的所有功能。

本文档由 Android Publisher 库版本 5.0.5+20200331 生成,其中 20200331 是由 mako 代码生成器 v5.0.5 构建的 androidpublisher:v2 架构的确切修订。

有关 Android Publisher v2 API 的其他信息,请参阅 官方文档网站

特性

从中央 中心 简单地处理以下 资源...

支持通过 ... 上传

本库的结构

API 结构如下主要项

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

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

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

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

或者具体...

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

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

使用方法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_androidpublisher2 as androidpublisher2;
use androidpublisher2::api::InAppProduct;
use androidpublisher2::{Result, Error};
use std::default::Default;
use androidpublisher2::{AndroidPublisher, 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 = AndroidPublisher::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 = InAppProduct::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.inappproducts().patch(req, "packageName", "sku")
             .auto_convert_missing_prices(true)
             .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")

支持上传的方法可以使用多达2种不同的协议进行上传:简单可续传。每种协议的独特性由定制的doit(...)方法表示,这些方法分别命名为upload(...)upload_resumable(...)

自定义和回调

您可以通过向doit()方法调用提供代理方法构建器来更改方法的调用方式,在最终进行doit()调用之前。相应的函数将被调用以提供进度信息,以及确定系统在失败时是否应该重试。

代理特质具有默认实现,允许您以最少的努力对其进行自定义。

服务器请求中的可选部分

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

构建器参数

通过方法构建器,您可以通过反复调用其方法来准备一个动作调用。这些方法始终只接受一个参数,以下陈述对于该参数是正确的。

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

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

Cargo功能

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

许可协议

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

依赖关系

~12–24MB
~344K SLoC