2 个稳定版本

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

#2799 in 网络编程

28 每月下载量

MIT 许可证

185KB
2.5K SLoC

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

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

如果请求数据结构,这些将以美观打印的 JSON 返回,可作为其他工具的输入使用。

关于我的商业验证 API 的所有其他信息都可以在 官方文档站点 找到。

安装和源代码

使用 cargo 安装命令行界面:

cargo install google-mybusinessverifications1-cli

GitHub 上找到源代码。

用法

本文档是从修订版 20240304 的 mybusinessverifications1 API 生成的。CLI 版本为 5.0.4

mybusinessverifications1 [options]
        locations
                fetch-verification-options <location> (-r <kv>)... [-p <v>]... [-o <out>]
                get-voice-of-merchant-state <name> [-p <v>]... [-o <out>]
                verifications-complete <name> (-r <kv>)... [-p <v>]... [-o <out>]
                verifications-list <parent> [-p <v>]... [-o <out>]
                verify <name> (-r <kv>)... [-p <v>]... [-o <out>]
  mybusinessverifications1 --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 文件中,文件名以 mybusinessverifications1- 开头。您可以使用 --config-dir 标志在每个调用基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用范围时,用户将被要求进行授权。按照 CLI 给出的说明授权权限,或拒绝授权。

如果用户验证了作用域,相应的信息将作为JSON存储在配置目录中,例如:~/.google-service-cli/mybusinessverifications1-token-<scope-hash>.json。无需手动管理这些令牌。

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

应用程序密钥

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

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

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

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

调试

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

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

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

依赖项

~20–31MB
~577K SLoC