12 个稳定版本

3.1.0+20220305 2022年4月26日
3.0.0+20220305 2022年3月8日
2.0.4+20210331 2021年4月15日
1.0.13+20170622 2020年4月12日
1.0.6+20170622 2017年9月27日

2999网络编程

Download history 92/week @ 2024-03-31 1/week @ 2024-04-07

84 每月下载量

MIT 许可证

100KB
1.5K SLoC

playcustomapp1 命令行界面(CLI)允许您从终端轻松使用 Google playcustomapp 服务的几乎所有功能。

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

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

有关 playcustomapp API 的其他信息,请参阅 官方文档网站

安装和源代码

使用 cargo 安装命令行界面:

cargo install google-playcustomapp1-cli

GitHub 上找到源代码。

用法

此文档是从 playcustomapp API(修订版 20220305)生成的。CLI 的版本为 3.1.0

playcustomapp1 [options]
        accounts
                custom-apps-create <account> (-r <kv>)... (-u simple -f <file> [-m <mime>]) [-p <v>]... [-o <out>]
  playcustomapp1 --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 文件中,文件名以 playcustomapp1- 开头。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

第一次使用范围时,用户会被询问权限。按照 CLI 给出的指示授予权限,或拒绝。

如果范围已由用户认证,相关信息将存储在配置目录中,以 JSON 格式,例如 ~/.google-service-cli/playcustomapp1-token-<scope-hash>.json。无需手动管理这些令牌。

要撤销授予的认证,请参阅 官方文档

应用程序密钥

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

为了在不强迫任何人注册自己的应用程序的情况下更方便地使用 CLI,CLI 内置了默认的应用程序密钥,并相应地进行了配置。这也意味着全球范围内的密集使用可能会耗尽每日配额。

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

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

调试

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

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

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

依赖项

~18–31MB
~568K SLoC