3个稳定版本
5.0.4+20240304 | 2024年3月5日 |
---|---|
3.1.0+20220305 | 2022年4月26日 |
3.0.0+20220305 | 2022年3月8日 |
#2714 in 网络编程
每月46次下载
185KB
2.5K SLoC
mybusinessplaceactions1
命令行界面(CLI)允许您从终端舒适地使用Google My Business Place Actions服务的几乎所有功能。
默认情况下,所有输出都打印到标准输出,但可以通过标志将其定向到文件,而与shell的功能无关。错误将打印到标准错误,并导致程序的退出代码为非零。
如果请求数据结构,这些数据结构将作为格式化的JSON返回,以便作为其他工具的输入。
有关My Business Place Actions API的所有其他信息,请参阅官方文档网站。
安装和源代码
使用cargo安装命令行界面
cargo install google-mybusinessplaceactions1-cli
用法
本文档是从My Business Place Actions API的修订版20240304生成的。CLI版本为5.0.4。
mybusinessplaceactions1 [options]
locations
place-action-links-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
place-action-links-delete <name> [-p <v>]... [-o <out>]
place-action-links-get <name> [-p <v>]... [-o <out>]
place-action-links-list <parent> [-p <v>]... [-o <out>]
place-action-links-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
place-action-type-metadata
list [-p <v>]... [-o <out>]
mybusinessplaceactions1 --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文件中,文件名以mybusinessplaceactions1-
开头。您可以使用--config-dir
标志在每个调用的基础上更改用于存储配置的目录。
以下段落提供了有关各种持久数据的更多信息。
身份验证
大多数API都需要用户对任何请求进行身份验证。如果是这种情况,则作用域确定授予的权限集。这些通常是只读或完全访问。
如果未设置,系统将自动选择最小的可行范围,例如在调用只读方法时,它只会请求只读范围。您可以使用 --scope
标志直接指定范围。所有适用范围都在相应方法的 CLI 文档中有说明。
首次使用范围时,会要求用户授权。按照 CLI 提供的说明授权或拒绝。
如果用户认证了某个范围,相关信息将以 JSON 格式存储在配置目录中,例如 ~/.google-service-cli/mybusinessplaceactions1-token-<scope-hash>.json
。不需要手动管理这些令牌。
要撤销授予的认证,请参阅 官方文档。
应用程序密钥
为了允许任何应用程序使用 Google 服务,需要使用 Google 开发者控制台 进行注册。然后依次启用应用程序可能使用的 API。大多数 API 可以免费使用,并有每日配额。
为了使 CLI 的使用更加方便,无需强制用户注册自己的应用程序,CLI 随带一个默认的应用程序密钥,相应地进行了配置。这也意味着全球范围内的频繁使用可能会耗尽每日配额。
您可以通过将您自己的密钥文件放置在此位置来解决这个问题:~/.google-service-cli/mybusinessplaceactions1-secret.json
,假设已为它启用了所需的 mybusinessplaceactions API。这样的密钥文件可以在 Google 开发者控制台 的 APIs & auth -> Credentials -> Download JSON 处下载并直接使用。
有关如何设置 Google 项目和启用 API 的更多信息,请参阅 官方文档。
调试
尽管 CLI 尽力提供可用的错误消息,但有时了解导致特定问题的确切原因可能很有帮助。这是通过允许所有客户端-服务器通信直接输出到标准错误来完成的。
使用 --debug
标志将在标准错误中打印使用 Debug
表示的错误。
您可以将标准错误重定向到文件,以便于使用,例如 mybusinessplaceactions1 --debug <resource> <method> [options] 2>debug.txt
。
依赖项
~20–31MB
~578K SLoC