该 playablelocations3 命令行界面（CLI）允许您从终端舒适地使用 Google Playable Locations 服务的大多数功能。

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

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

有关 Playable Locations API 的其他信息，请参阅官方文档站点。

安装和源代码

使用 cargo 安装命令行界面：

cargo install google-playablelocations3-cli

在 GitHub 上查找源代码。

用法

此文档是从 Playable Locations API 的 20200707 版本生成的。CLI 的版本为 5.0.4。

playablelocations3 [options]
        methods
                log-impressions (-r <kv>)... [-p <v>]... [-o <out>]
                log-player-reports (-r <kv>)... [-p <v>]... [-o <out>]
                sample-playable-locations (-r <kv>)... [-p <v>]... [-o <out>]
  playablelocations3 --help

Configuration:
  --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 文件中，文件名以 playablelocations3- 开头。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用范围时，用户会被要求授权。按照CLI给出的指示授予权限或拒绝。

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

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

应用程序密钥

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

为了在不强制任何人注册自己的应用程序的情况下更方便地使用CLI，CLI附带了一个默认应用程序密钥，已相应配置。这也意味着全球范围内的重用可能会耗尽每日配额。

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

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

调试

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

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

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