该 gameservices1 命令行界面 (CLI) 允许您从终端舒适地使用 Google Game Services 服务的多数功能。

默认情况下，所有输出都打印到标准输出，但可以设置标志将其直接导向文件，不受您的 shell 功能限制。错误将打印到标准错误，并导致程序的退出代码非零。

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

有关游戏服务 API 的其他所有信息，请参阅官方文档网站。

安装和源代码

使用 cargo 安装命令行界面

cargo install google-gameservices1-cli

在 GitHub 上找到源代码。

用法

本文档是从修订版 20230105 的 游戏服务 API 生成的。CLI 版本为 5.0.4。

gameservices1 [options]
        projects
                locations-game-server-deployments-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-game-server-deployments-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-game-server-deployments-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-get <name> [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
                locations-operations-cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-operations-delete <name> [-p <v>]... [-o <out>]
                locations-operations-get <name> [-p <v>]... [-o <out>]
                locations-operations-list <name> [-p <v>]... [-o <out>]
  gameservices1 --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 文件中，以 gameservices1- 前缀开头。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

如果没有设置，系统将自动选择最小的可行作用域，例如，当调用只读方法时，它只会请求只读作用域。您可以使用 --scope 标志直接指定作用域。所有适用的作用域均在相应方法的 CLI 文档中有记录。

第一次使用作用域时，用户会被要求授权。按照CLI给出的指示授权或拒绝。

如果用户认证了某个作用域，相应的信息将以JSON格式存储在配置目录中，例如：~/.google-service-cli/gameservices1-token-<scope-hash>.json。无需手动管理这些令牌。

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

应用程序密钥

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

为了使CLI的使用更加舒适，无需强制注册自己的应用程序，CLI附带一个默认应用程序密钥，并相应地配置。这也意味着全球范围内的频繁使用可能会耗尽每日配额。

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

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

调试

尽管CLI尽力提供可用的错误信息，但有时可能需要知道导致特定问题的确切原因。这通过允许所有客户端-服务器通信直接输出到标准错误实现。

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

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