#google-api #google #web-api #protocols #api #web #games-management

google-gamesmanagement1_management

与游戏管理(协议 v1management)交互的完整库

48个版本 (30个稳定版)

5.0.5+20240618 2024年6月27日
5.0.4+20240228 2024年3月5日
5.0.3+20230112 2023年8月23日
5.0.2+20230112 2023年3月16日
0.1.2+20150316 2015年3月25日

#2601 in 网页编程

每月 22次下载
用于 google-gamesmanagement1_m…

MIT 许可证

330KB
4K SLoC

google-gamesmanagement1_management 库允许访问 Google 游戏管理服务(协议 v1management)的所有功能。

本文档由 Games Management crate 版本 5.0.5+20240618 生成,其中 20240618 是由 mako 代码生成器 v5.0.5 构建的 gamesManagement:v1management 架构的确切修订版。

有关 Games Management v1_management API 的其他信息,请参阅 官方文档网站

特性

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

库的结构

API结构分为以下主要项目

  • 中心节点
    • 一个用于维护状态并允许访问所有活动的中心对象
    • 创建方法构建器,这些构建器反过来允许访问单个调用构建器
  • 资源
    • 可以应用于活动的主要类型
    • 一组属性和部分
    • 部分
      • 一组属性
      • 永远不会直接用于活动
  • 活动
    • 应用于资源的操作

所有结构都标记了适用的特性和,以便进一步分类并简化浏览。

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

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

或者具体...

let r = hub.players().hide(...).doit().await
let r = hub.players().unhide(...).doit().await

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

用法

设置您的项目

要使用此库,您需要在您的Cargo.toml文件中添加以下行

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_gamesmanagement1_management as gamesmanagement1_management;
use gamesmanagement1_management::{Result, Error};
use std::default::Default;
use gamesmanagement1_management::{GamesManagement, 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 = GamesManagement::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
// 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.players().hide("applicationId", "playerId")
             .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进行编码解码。可选用于指示部分请求和响应是有效的。大多数可选部分都是Parts,可以通过名称识别,将它们发送到服务器以指示请求的设置部分或响应中所需的部分。

构建器参数

通过使用method builders,您可以通过重复调用其方法来准备一个动作调用。这些方法始终接受一个参数,以下陈述适用于该参数。

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

Cargo功能

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

许可证

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

依赖项

~12–22MB
~342K SLoC