该 google-games1 库允许访问 Google Games 服务的所有功能。

此文档是从 Games 库版本 5.0.5+20240618 生成的，其中 20240618 是由 mako 代码生成器 v5.0.5 构建的 games:v1 架构的确切修订版。

关于 Games v1 API 的其他信息可以在 官方文档网站 找到。

功能

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

• 访问令牌
• 生成播放分组 API 令牌 和 生成回忆播放分组 API 令牌
• 成就定义
• 列表
• 成就
• 增加、列出、揭示、至少设置步骤、解锁 和 更新多个
• 应用
• 获取、获取端点、已播放 和 验证
• 事件
• 按玩家列出、列出定义 和 记录
• 排行榜
• 获取 和 列表
• 元游戏
• 获取元游戏配置 和 按玩家列出类别
• 玩家
• 获取、获取多个应用玩家ID、获取作用域玩家ID 和 列表
• 召回
• 游戏玩家令牌、从所有开发者游戏中获取最后一个令牌、链接角色、重置角色、检索令牌 和 取消链接角色
• 修订
• 检查
• 分数
• 获取、列表、列表窗口、提交 和 提交多个
• 快照
• 获取 和 列表
• 统计数据
• 获取

此库的结构

API 被结构化为以下主要项目

• 中心
  • 一个中心对象，用于维护状态并允许访问所有 活动
  • 创建 方法构建器，它们反过来允许访问单个 调用构建器
• 资源
  • 你可以将 活动 应用到的主要类型
  • 一组属性和 部分
  • 部分
    • 一组属性
    • 从未在 活动中 直接使用
• 活动
  • 应用于 资源 的操作

所有 结构 都带有适用的特质，以便进一步分类并简化浏览。

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

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

或具体...

let r = hub.applications().get(...).doit().await
let r = hub.applications().get_end_point(...).doit().await
let r = hub.applications().played(...).doit().await
let r = hub.applications().verify(...).doit().await

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

用法

设置你的项目

要使用这个库，您需要将以下几行代码放入您的Cargo.toml文件中

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_games1 as games1;
use games1::{Result, Error};
use std::default::Default;
use games1::{Games, 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 = Games::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.applications().get("applicationId")
             .platform_type("magna")
             .language("no")
             .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进行编码和解码。使用可选值来表示部分请求或响应是有效的。大多数可选值都是被视为部分，它们可以通过名称识别，这些部分将被发送到服务器以指示请求的集合部分或所需的响应部分。

构建器参数

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

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

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

Cargo 特性

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

许可证

games1 库由 Sebastian Thiel 生成，并置于 MIT 许可证之下。您可以在仓库的 许可证文件 中阅读全文。