《google-gamesconfiguration1_configuration》库允许访问 Google 游戏配置服务的所有功能。

本文档是从版本 5.0.5+20240618 的 Games Configuration crate 生成的，其中 20240618 是由 mako 代码生成器 v5.0.5 构建的 gamesConfiguration:v1configuration 架构的精确版本。

关于 Games Configuration v1_configuration API 的其他所有内容都可以在 官方文档站点 找到。

功能

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

• 成就配置
• 删除、获取、插入、列出 和 更新
• 排行榜配置
• 删除、获取、插入、列出 和 更新

本库结构

API结构如下主要项

• 中心对象
  • 用于维护状态并允许访问所有活动
  • 创建方法构建器，进而允许访问单个调用构建器
• 资源
  • 主要类型，可以将活动应用于其中
  • 属性和部分的集合
  • 部分
    • 属性的集合
    • 在活动中从不直接使用
• 活动
  • 应用于资源的操作

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

一般来说，你可以这样调用活动

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

或者具体来说...

let r = hub.achievement_configurations().delete(...).doit().await
let r = hub.achievement_configurations().get(...).doit().await
let r = hub.achievement_configurations().insert(...).doit().await
let r = hub.achievement_configurations().list(...).doit().await
let r = hub.achievement_configurations().update(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_gamesconfiguration1_configuration as gamesconfiguration1_configuration;
use gamesconfiguration1_configuration::{Result, Error};
use std::default::Default;
use gamesconfiguration1_configuration::{GamesConfiguration, 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 = GamesConfiguration::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.achievement_configurations().list("applicationId")
             .page_token("magna")
             .max_results(-11)
             .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()调用之前向Method Builder提供一个delegate来改变doit()方法的调用方式。相应的函数将被调用以提供进度信息，并确定系统在失败时是否应重试。

默认实现了delegate trait，这使得您可以用最小的努力进行定制。

服务器请求中的可选部分

此库提供的所有结构都旨在通过json进行编码和解码。使用可选值来表示部分请求和响应是有效的。大多数可选值都是被认为是Parts，这些可以通过名称识别，并将发送到服务器以指示请求或响应中所需的部分。

构建器参数

使用method builders，您可以通过重复调用其方法来准备一个动作调用。这些方法将始终接受单个参数，以下语句对参数有效：

• PODs通过复制传递
• 字符串作为&str传递
• request values被移动

参数将被复制或克隆到构建器中，以使其与原始的生命周期独立。

Cargo功能

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

许可

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