3个稳定版本

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

#14 in #通知

Download history 12/week @ 2024-03-26 62/week @ 2024-04-02 1/week @ 2024-05-21

51 每月下载次数

MIT 许可证

110KB
1.5K SLoC

mybusinessnotifications1 命令行界面(CLI)允许您从终端舒适地使用 Google My Business Notification Settings 服务的几乎所有功能。

默认情况下,所有输出都打印到标准输出,但可以通过设置标志将其直接定向到文件,而不考虑您的 shell 能力。错误将打印到标准错误,并导致程序退出代码非零。

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

有关 My Business Notification Settings API 的其他信息,请参阅 官方文档网站

安装和源代码

使用 cargo 安装命令行界面:

cargo install google-mybusinessnotifications1-cli

github 上查找源代码。

用法

此文档是从修订版 20240304 的 My Business Notification Settings API 生成的。CLI 版本为 5.0.4

mybusinessnotifications1 [options]
        accounts
                get-notification-setting <name> [-p <v>]... [-o <out>]
                update-notification-setting <name> (-r <kv>)... [-p <v>]... [-o <out>]
  mybusinessnotifications1 --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 目录中存储所有持久数据,该目录使用以 mybusinessnotifications1- 为前缀的 JSON 文件。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

有关各种类型持久数据的更多信息,请参阅以下段落。

身份验证

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

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

第一次使用范围时,用户会被要求授权。按照 CLI 提供的说明授权或拒绝。

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

要撤销授权,请参阅官方文档

应用程序密钥

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

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

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

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

调试

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

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

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

依赖项

~20–31MB
~584K SLoC