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