3个稳定版本

5.0.4+20240303 2024年3月5日
3.1.0+20220305 2022年4月26日
3.0.0+20220305 2022年3月8日

2857 in Web编程

48 monthly downloads

MIT 协议

105KB
1.5K SLoC

fcmdata1-beta1 命令行界面(CLI)允许您从终端舒适地使用Google Fcmdata服务的多数功能。

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

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

关于Fcmdata API的其他信息可以在官方文档站点找到。

安装和源代码

使用cargo安装命令行界面

cargo install google-fcmdata1_beta1-cli

github上找到源代码。

用法

此文档是从修订版20240303的Fcmdata API生成的。CLI的版本为5.0.4

fcmdata1-beta1 [options]
        projects
                android-apps-delivery-data-list <parent> [-p <v>]... [-o <out>]
  fcmdata1-beta1 --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目录中,目录前缀为fcmdata1-beta1-的JSON文件中。您可以使用--config-dir标志在每次调用的基础上更改用于存储配置的目录。

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

身份验证

大多数API要求用户对请求进行身份验证。如果是这种情况,则范围确定授予的权限集合。这些通常不超过只读完全访问

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

首次使用范围时,用户会被要求授权。遵循CLI提供的指示授予权限,或拒绝。

如果用户对某个作用域进行了身份验证,相关信息将被存储在配置目录中的 JSON 格式,例如 ~/.google-service-cli/fcmdata1-beta1-token-<scope-hash>.json。无需手动管理这些令牌。

要撤销授权的身份验证,请参阅官方文档

应用程序密钥

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

为了在不强制用户注册自己的应用程序的情况下,更舒适地使用 CLI,CLI 随附了一个默认的应用程序密钥,并根据需要进行配置。这也意味着全球范围内的频繁使用可能会耗尽每日配额。

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

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

调试

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

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

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

依赖项

~20–34MB
~596K SLoC