3个稳定版本
5.0.4+20240305 | 2024年3月5日 |
---|---|
3.1.0+20220307 | 2022年4月26日 |
3.0.0+20220307 | 2022年3月8日 |
2964 在 Web编程
每月48次 下载
1MB
12K SLoC
该 authorizedbuyersmarketplace1
命令行界面(CLI)允许您在终端中轻松使用Google授权买家市场服务的大部分功能。
默认情况下,所有输出都打印到标准输出,但可以通过设置标志将其直接重定向到文件,而无需考虑shell的能力。错误将打印到标准错误,并导致程序的退出代码不为零。
如果请求数据结构,这些数据结构将以美观打印的JSON格式返回,以便作为其他工具的输入。
有关授权买家市场API的所有其他信息,请参阅官方文档网站。
安装和源代码
使用cargo安装命令行界面:
cargo install google-authorizedbuyersmarketplace1-cli
在github上查找源代码。
使用方法
本文档是根据修订版20240305的授权买家市场API生成的。CLI的版本为5.0.4。
authorizedbuyersmarketplace1 [options]
bidders
finalized-deals-list <parent> [-p <v>]... [-o <out>]
buyers
auction-packages-get <name> [-p <v>]... [-o <out>]
auction-packages-list <parent> [-p <v>]... [-o <out>]
auction-packages-subscribe <name> (-r <kv>)... [-p <v>]... [-o <out>]
auction-packages-subscribe-clients <auction-package> (-r <kv>)... [-p <v>]... [-o <out>]
auction-packages-unsubscribe <name> (-r <kv>)... [-p <v>]... [-o <out>]
auction-packages-unsubscribe-clients <auction-package> (-r <kv>)... [-p <v>]... [-o <out>]
clients-activate <name> (-r <kv>)... [-p <v>]... [-o <out>]
clients-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
clients-deactivate <name> (-r <kv>)... [-p <v>]... [-o <out>]
clients-get <name> [-p <v>]... [-o <out>]
clients-list <parent> [-p <v>]... [-o <out>]
clients-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
clients-users-activate <name> (-r <kv>)... [-p <v>]... [-o <out>]
clients-users-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
clients-users-deactivate <name> (-r <kv>)... [-p <v>]... [-o <out>]
clients-users-delete <name> [-p <v>]... [-o <out>]
clients-users-get <name> [-p <v>]... [-o <out>]
clients-users-list <parent> [-p <v>]... [-o <out>]
finalized-deals-add-creative <deal> (-r <kv>)... [-p <v>]... [-o <out>]
finalized-deals-get <name> [-p <v>]... [-o <out>]
finalized-deals-list <parent> [-p <v>]... [-o <out>]
finalized-deals-pause <name> (-r <kv>)... [-p <v>]... [-o <out>]
finalized-deals-resume <name> (-r <kv>)... [-p <v>]... [-o <out>]
finalized-deals-set-ready-to-serve <deal> (-r <kv>)... [-p <v>]... [-o <out>]
proposals-accept <name> (-r <kv>)... [-p <v>]... [-o <out>]
proposals-add-note <proposal> (-r <kv>)... [-p <v>]... [-o <out>]
proposals-cancel-negotiation <proposal> (-r <kv>)... [-p <v>]... [-o <out>]
proposals-deals-batch-update <parent> (-r <kv>)... [-p <v>]... [-o <out>]
proposals-deals-get <name> [-p <v>]... [-o <out>]
proposals-deals-list <parent> [-p <v>]... [-o <out>]
proposals-deals-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
proposals-get <name> [-p <v>]... [-o <out>]
proposals-list <parent> [-p <v>]... [-o <out>]
proposals-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
proposals-send-rfp <buyer> (-r <kv>)... [-p <v>]... [-o <out>]
publisher-profiles-get <name> [-p <v>]... [-o <out>]
publisher-profiles-list <parent> [-p <v>]... [-o <out>]
authorizedbuyersmarketplace1 --help
Configuration:
[--scope <url>]...
Specify the authentication a method should be executed in. Each scope
requires the user to grant this application permission to use it.
If unset, it defaults to the shortest scope url for a particular method.
--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文件中,文件名以authorizedbuyersmarketplace1
开头。您可以使用--config-dir
标志在每个调用的基础上更改用于存储配置的目录。
以下段落中提供了有关各种类型持久数据的更多信息。
身份验证
大多数API都需要用户对请求进行身份验证。如果是这种情况,则作用域确定授予的权限集。这些权限的粒度通常不超过只读或完全访问。
如果未设置,系统将自动选择最小的可行范围,例如在调用只读方法时,它将只请求只读范围。您可以使用 --scope
标志直接指定范围。所有适用范围在相应方法的 CLI 文档中有说明。
第一次使用范围时,用户将被要求授权。根据 CLI 提供的说明授予权限或拒绝。
如果用户已对某个范围进行认证,相应信息将被存储在配置目录中的 JSON 格式中,例如 ~/.google-service-cli/authorizedbuyersmarketplace1-token-<scope-hash>.json
。无需手动管理这些令牌。
要撤销授予的认证,请参阅 官方文档。
应用程序密钥
为了允许任何应用程序使用 Google 服务,它需要使用 Google 开发者控制台 进行注册。应用程序可能使用的 API 将逐个启用。大多数 API 可以免费使用,并有限额。
为了在不强制任何人注册自己的应用程序的情况下更舒适地使用 CLI,CLI 提供了一个默认的应用程序密钥,相应地进行了配置。这也意味着全球范围内的频繁使用可能会耗尽每日配额。
您可以通过将您的密钥文件放在此位置来解决这个问题:~/.google-service-cli/authorizedbuyersmarketplace1-secret.json
,假设为它启用了所需的 authorizedbuyersmarketplace API。此类密钥文件可以从 Google 开发者控制台 在 APIs & auth -> Credentials -> Download JSON 下载并直接使用。
有关如何设置 Google 项目和启用 API 的更多信息,请参阅 官方文档。
调试
尽管 CLI 尽最大努力提供可用的错误消息,但有时了解导致特定问题的确切原因可能是有用的。这是通过允许所有客户端-服务器通信以原始形式输出到标准错误来完成的。
使用 --debug
标志将错误以 Debug
表示形式打印到标准错误。
您可以考虑将标准错误重定向到文件,以便于使用,例如 authorizedbuyersmarketplace1 --debug <resource> <method> [options] 2>debug.txt
。
依赖项
~19–31MB
~583K SLoC