games1 命令行界面（CLI）允许您在终端中方便地使用 Google Games 服务的几乎所有功能。

默认情况下，所有输出都打印到标准输出，但可以通过设置标志将其定向到文件，而不依赖于 shell 的功能。错误将打印到标准错误，并导致程序的退出代码非零。

如果请求数据结构，则这些结构将作为格式化打印的 JSON 返回，以便作为其他工具的输入。

有关 Games API 的其他一切信息，请参阅 官方文档网站。

安装和源代码

使用 cargo 安装命令行界面：

cargo install google-games1-cli

在 GitHub 上找到源代码。

用法

此文档是从修订版 20220217 的 Games API 生成的。CLI 版本为 3.1.0。

games1 [options]
        achievement-definitions
                list [-p <v>]... [-o <out>]
        achievements
                increment <achievement-id> <steps-to-increment> [-p <v>]... [-o <out>]
                list <player-id> [-p <v>]... [-o <out>]
                reveal <achievement-id> [-p <v>]... [-o <out>]
                set-steps-at-least <achievement-id> <steps> [-p <v>]... [-o <out>]
                unlock <achievement-id> [-p <v>]... [-o <out>]
                update-multiple (-r <kv>)... [-p <v>]... [-o <out>]
        applications
                get <application-id> [-p <v>]... [-o <out>]
                get-end-point [-p <v>]... [-o <out>]
                played [-p <v>]...
                verify <application-id> [-p <v>]... [-o <out>]
        events
                list-by-player [-p <v>]... [-o <out>]
                list-definitions [-p <v>]... [-o <out>]
                record (-r <kv>)... [-p <v>]... [-o <out>]
        leaderboards
                get <leaderboard-id> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
        metagame
                get-metagame-config [-p <v>]... [-o <out>]
                list-categories-by-player <player-id> <collection> [-p <v>]... [-o <out>]
        players
                get <player-id> [-p <v>]... [-o <out>]
                list <collection> [-p <v>]... [-o <out>]
        revisions
                check <client-revision> [-p <v>]... [-o <out>]
        scores
                get <player-id> <leaderboard-id> <time-span> [-p <v>]... [-o <out>]
                list <leaderboard-id> <collection> <time-span> [-p <v>]... [-o <out>]
                list-window <leaderboard-id> <collection> <time-span> [-p <v>]... [-o <out>]
                submit <leaderboard-id> <score> [-p <v>]... [-o <out>]
                submit-multiple (-r <kv>)... [-p <v>]... [-o <out>]
        snapshots
                get <snapshot-id> [-p <v>]... [-o <out>]
                list <player-id> [-p <v>]... [-o <out>]
        stats
                get [-p <v>]... [-o <out>]
  games1 --help

Configuration:
  [--scope <url>]...
            Specify the authentication a method should be executed in. Each scope
            requires the user to grant this application permission to use it.
            If unset, it defaults to the shortest scope url for a particular method.
  --config-dir <folder>
            A directory into which we will store our persistent data. Defaults to
            a user-writable directory that we will create during the first invocation.
            [default: ~/.google-service-cli]

配置

程序将把所有持久数据存储在 ~/.google-service-cli 目录中的 JSON 文件中，文件名以 games1- 为前缀。您可以使用 --config-dir 标志在每个调用上更改用于存储配置的目录。

以下段落提供了有关各种类型持久数据的更多信息。

身份验证

大多数 API 都需要用户对任何请求进行身份验证。如果是这种情况，则 作用域 确定了授予的权限集。这些权限的粒度通常不超过 只读 或 完全访问。

如果未设置，系统将自动选择最小的可行范围，例如在调用只读方法时，它只会请求只读范围。您可以使用--scope标志直接指定范围。所有适用的范围都在相应方法的CLI文档中有说明。

首次使用范围时，会要求用户授权。按照CLI给出的说明授权或拒绝。

如果用户认证了某个范围，相应的信息将被存储为JSON格式在配置目录中，例如~/.google-service-cli/games1-token-<scope-hash>.json。不需要手动管理这些令牌。

要撤销授权的认证，请参阅官方文档。

应用程序密钥

为了允许任何应用程序使用Google服务，它需要使用Google开发者控制台进行注册。为该应用程序启用的API将逐个启用。大多数API可以免费使用，并且有每日配额。

为了使CLI更加方便使用，而无需强迫任何人注册自己的应用程序，CLI附带了一个默认的应用程序密钥，相应的配置也已完成。这也意味着全球范围内的重用可能会耗尽每日配额。

您可以通过在此位置放置自己的密钥文件来解决这个问题：~/.google-service-cli/games1-secret.json，假设已为它启用了所需的games API。这样的密钥文件可以在Google开发者控制台中在APIs & auth -> Credentials -> Download JSON下下载，并直接使用。

有关如何设置Google项目和启用API的更多信息，请参阅官方文档。

调试

尽管CLI已尽力提供可用的错误消息，但有时可能希望了解导致特定问题的确切原因。这是通过允许所有客户端-服务器通信被输出到标准错误原样来完成的。

--debug标志将使用Debug表示法将错误打印到标准错误。

您可以考虑将标准错误重定向到文件以方便使用，例如games1 --debug <resource> <method> [options] 2>debug.txt。