9个稳定版本 (3个主要版本)

5.0.4+0 2024年3月5日
3.1.0+0 2022年4月26日
3.0.0+0 2022年3月8日
2.0.4+0 2021年4月14日
1.0.12+0 2020年2月8日

#2151 in 网络编程

Download history 1/week @ 2024-05-19

184 每月下载量

MIT 许可证

1.5MB
19K SLoC

mybusiness4 命令行界面(CLI)允许您在终端中轻松使用Google My Business服务的多数功能。

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

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

关于My Business API的所有其他信息都可以在官方文档网站找到。

安装和源代码

使用cargo安装命令行界面

cargo install google-mybusiness4-cli

GitHub上找到源代码

用法

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

mybusiness4 [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>]
                delete-notifications <name> [-p <v>]... [-o <out>]
                generate-account-number <name> (-r <kv>)... [-p <v>]... [-o <out>]
                get <name> [-p <v>]... [-o <out>]
                get-notifications <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>]
                list-recommend-google-locations <name> [-p <v>]... [-o <out>]
                locations-admins-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-admins-delete <name> [-p <v>]... [-o <out>]
                locations-admins-list <parent> [-p <v>]... [-o <out>]
                locations-admins-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-associate <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-batch-get <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-batch-get-reviews <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-clear-association <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-delete <name> [-p <v>]... [-o <out>]
                locations-fetch-verification-options <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-find-matches <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-followers-get-metadata <name> [-p <v>]... [-o <out>]
                locations-get <name> [-p <v>]... [-o <out>]
                locations-get-google-updated <name> [-p <v>]... [-o <out>]
                locations-list <parent> [-p <v>]... [-o <out>]
                locations-local-posts-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-local-posts-delete <name> [-p <v>]... [-o <out>]
                locations-local-posts-get <name> [-p <v>]... [-o <out>]
                locations-local-posts-list <parent> [-p <v>]... [-o <out>]
                locations-local-posts-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-local-posts-report-insights <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-media-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-media-customers-get <name> [-p <v>]... [-o <out>]
                locations-media-customers-list <parent> [-p <v>]... [-o <out>]
                locations-media-delete <name> [-p <v>]... [-o <out>]
                locations-media-get <name> [-p <v>]... [-o <out>]
                locations-media-list <parent> [-p <v>]... [-o <out>]
                locations-media-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-media-start-upload <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-questions-answers-delete <parent> [-p <v>]... [-o <out>]
                locations-questions-answers-list <parent> [-p <v>]... [-o <out>]
                locations-questions-answers-upsert <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-questions-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-questions-delete <name> [-p <v>]... [-o <out>]
                locations-questions-list <parent> [-p <v>]... [-o <out>]
                locations-questions-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-report-insights <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-reviews-delete-reply <name> [-p <v>]... [-o <out>]
                locations-reviews-get <name> [-p <v>]... [-o <out>]
                locations-reviews-list <parent> [-p <v>]... [-o <out>]
                locations-reviews-update-reply <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-transfer <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-verifications-complete <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-verifications-list <parent> [-p <v>]... [-o <out>]
                locations-verify <name> (-r <kv>)... [-p <v>]... [-o <out>]
                update <name> (-r <kv>)... [-p <v>]... [-o <out>]
                update-notifications <name> (-r <kv>)... [-p <v>]... [-o <out>]
        attributes
                list [-p <v>]... [-o <out>]
        categories
                list [-p <v>]... [-o <out>]
        chains
                get <name> [-p <v>]... [-o <out>]
                search [-p <v>]... [-o <out>]
        google-locations
                report <name> (-r <kv>)... [-p <v>]... [-o <out>]
                search (-r <kv>)... [-p <v>]... [-o <out>]
        verification-tokens
                generate (-r <kv>)... [-p <v>]... [-o <out>]
  mybusiness4 --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文件中,文件名以mybusiness4-开头。您可以使用--config-dir标志在每个调用上更改用于存储配置的目录。

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

身份验证

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

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

首次使用范围时,用户将被要求授权。根据 CLI 提供的说明授权,或拒绝授权。

如果用户验证了某个范围,相关的信息将作为 JSON 存储在配置目录中,例如 ~/.google-service-cli/mybusiness4-token-<scope-hash>.json。不需要手动管理这些令牌。

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

应用程序密钥

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

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

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

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

调试

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

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

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

依赖项

~20–31MB
~577K SLoC