#google #google-api #protocols

google-androidpublisher3

与Android Publisher(协议v3)交互的完整库

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

5.0.5+20240229 2024年3月11日
5.0.3+20230124 2023年8月23日
5.0.2+20230124 2023年3月16日
4.0.1+20220307 2022年9月14日
1.0.8+20181009 2018年10月14日

#12 in #google-api

Download history 5/week @ 2024-04-21 13/week @ 2024-04-28 16/week @ 2024-05-05 23/week @ 2024-05-12 35/week @ 2024-05-19 17/week @ 2024-05-26 31/week @ 2024-06-02 2/week @ 2024-06-09 5/week @ 2024-06-16 17/week @ 2024-06-23 17/week @ 2024-06-30 21/week @ 2024-07-07 13/week @ 2024-07-14 31/week @ 2024-07-21 28/week @ 2024-07-28

100 每月下载量
4 个crate中使用 4

MIT 许可证

2MB
24K SLoC

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

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

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

功能

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

支持上传...

支持下载...

此库的结构

API 被组织成以下主要项目

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

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

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

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

或具体...

let r = hub.monetization().subscriptions_base_plans_activate(...).doit().await
let r = hub.monetization().subscriptions_base_plans_deactivate(...).doit().await
let r = hub.monetization().subscriptions_archive(...).doit().await
let r = hub.monetization().subscriptions_create(...).doit().await
let r = hub.monetization().subscriptions_get(...).doit().await
let r = hub.monetization().subscriptions_patch(...).doit().await

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

用法

设置项目

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

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_androidpublisher3 as androidpublisher3;
use androidpublisher3::api::Subscription;
use androidpublisher3::{Result, Error};
use std::default::Default;
use androidpublisher3::{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().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 = Subscription::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.monetization().subscriptions_patch(req, "packageName", "productId")
             .update_mask(&Default::default())
             .regions_version_version("no")
             .latency_tolerance("ipsum")
             .allow_missing(false)
             .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() 之前。相应的方法将被调用以提供进度信息,以及确定系统是否应在失败时重试。

默认实现了 委托特质,允许您以最少的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

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

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

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

许可证

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

依赖项

~17–28MB
~531K SLoC