#google #google-api #cli #command-line-interface #mybusinessaccountman

app google-mybusinessaccountmanagement1-cli

用于与 My Business Account Management (协议 v1) 交互的完整库

6 个稳定版本

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

网络编程 中排名 2578

MIT 许可证

370KB
5K SLoC

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

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

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

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

安装和源代码

使用 cargo 安装命令行界面:

cargo install google-mybusinessaccountmanagement1-cli

GitHub 上找到源代码。

用法

本文档是根据 My Business Account Management API 的 20240304 修订版生成的。CLI 版本为 5.0.4

mybusinessaccountmanagement1 [options]
        accounts
                admins-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                admins-delete <name> [-p <v>]... [-o <out>]
                admins-list <parent> [-p <v>]... [-o <out>]
                admins-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                create (-r <kv>)... [-p <v>]... [-o <out>]
                get <name> [-p <v>]... [-o <out>]
                invitations-accept <name> (-r <kv>)... [-p <v>]... [-o <out>]
                invitations-decline <name> (-r <kv>)... [-p <v>]... [-o <out>]
                invitations-list <parent> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
        locations
                admins-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                admins-delete <name> [-p <v>]... [-o <out>]
                admins-list <parent> [-p <v>]... [-o <out>]
                admins-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                transfer <name> (-r <kv>)... [-p <v>]... [-o <out>]
  mybusinessaccountmanagement1 --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 文件中,文件名以 mybusinessaccountmanagement1- 开头。您可以使用 --config-dir 标志在每次调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

第一次使用范围时,会要求用户授权。按照CLI的指示授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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

依赖项

~20–31MB
~579K SLoC