23个稳定版本 (4个主要版本)
5.0.4+20200930 | 2024年3月5日 |
---|---|
3.1.0+20200930 | 2022年4月26日 |
3.0.0+20200930 | 2022年3月8日 |
2.0.4+20200930 | 2021年4月14日 |
0.3.6+20160907 | 2016年9月11日 |
#2887 in 网络编程
595KB
8K SLoC
该adsensehost4d1
命令行界面(CLI)允许您在终端中轻松使用Google AdSense Host服务的多数功能。
默认情况下,所有输出都打印到标准输出,但可以通过设置标志将其定向到文件,而与您的shell功能无关。错误将打印到标准错误,并导致程序的退出代码不为零。
如果请求数据结构,这些将作为格式化的JSON返回,以便作为其他工具的输入。
有关AdSense Host API的更多信息,请参阅官方文档网站。
安装和源代码
使用cargo安装命令行界面:
cargo install google-adsensehost4d1-cli
在github上查找源代码。
用法
本文档是从修订版20200930的AdSense Host API生成的。CLI版本为5.0.4。
adsensehost4d1 [options]
accounts
adclients-get <account-id> <ad-client-id> [-p <v>]... [-o <out>]
adclients-list <account-id> [-p <v>]... [-o <out>]
adunits-delete <account-id> <ad-client-id> <ad-unit-id> [-p <v>]... [-o <out>]
adunits-get <account-id> <ad-client-id> <ad-unit-id> [-p <v>]... [-o <out>]
adunits-get-ad-code <account-id> <ad-client-id> <ad-unit-id> [-p <v>]... [-o <out>]
adunits-insert <account-id> <ad-client-id> (-r <kv>)... [-p <v>]... [-o <out>]
adunits-list <account-id> <ad-client-id> [-p <v>]... [-o <out>]
adunits-patch <account-id> <ad-client-id> <ad-unit-id> (-r <kv>)... [-p <v>]... [-o <out>]
adunits-update <account-id> <ad-client-id> (-r <kv>)... [-p <v>]... [-o <out>]
get <account-id> [-p <v>]... [-o <out>]
list <filter-ad-client-id>... [-p <v>]... [-o <out>]
reports-generate <account-id> <start-date> <end-date> [-p <v>]... [-o <out>]
adclients
get <ad-client-id> [-p <v>]... [-o <out>]
list [-p <v>]... [-o <out>]
associationsessions
start <product-code>... <website-url> [-p <v>]... [-o <out>]
verify <token> [-p <v>]... [-o <out>]
customchannels
delete <ad-client-id> <custom-channel-id> [-p <v>]... [-o <out>]
get <ad-client-id> <custom-channel-id> [-p <v>]... [-o <out>]
insert <ad-client-id> (-r <kv>)... [-p <v>]... [-o <out>]
list <ad-client-id> [-p <v>]... [-o <out>]
patch <ad-client-id> <custom-channel-id> (-r <kv>)... [-p <v>]... [-o <out>]
update <ad-client-id> (-r <kv>)... [-p <v>]... [-o <out>]
reports
generate <start-date> <end-date> [-p <v>]... [-o <out>]
urlchannels
delete <ad-client-id> <url-channel-id> [-p <v>]... [-o <out>]
insert <ad-client-id> (-r <kv>)... [-p <v>]... [-o <out>]
list <ad-client-id> [-p <v>]... [-o <out>]
adsensehost4d1 --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文件中,文件名以adsensehost4d1-
开头。您可以通过在每次调用时使用--config-dir
标志来更改用于存储配置的目录。
以下段落提供了有关各种持久数据的更多信息。
身份验证
大多数API都需要用户对请求进行身份验证。如果是这种情况,作用域决定了授予的权限集。这些权限的粒度通常不超过只读或完全访问。
如果没有设置,系统将自动选择最小的可行范围,例如在调用只读方法时,它将只请求只读范围。您可以使用 --scope
标志直接指定范围。所有适用的范围都在相应方法的 CLI 文档中进行了说明。
首次使用范围时,系统会提示用户授权。按照 CLI 提供的说明授权,或拒绝授权。
如果用户已认证范围,则相关信息将以 JSON 格式存储在配置目录中,例如 ~/.google-service-cli/adsensehost4d1-token-<scope-hash>.json
。无需手动管理这些令牌。
要撤销授予的认证,请参阅官方文档。
应用程序密钥
为了允许任何应用程序使用 Google 服务,它需要使用Google 开发者控制台进行注册。为应用程序启用可能使用的 API 是逐个启用的。大多数 API 可免费使用,并设有每日配额。
为了在不强制要求用户注册自己的应用程序的情况下,更方便地使用 CLI,CLI 随附一个默认的应用程序密钥,相应地进行了配置。这也意味着全球范围内的重用可能会耗尽每日配额。
您可以通过在此位置放置自己的密钥文件来解决这个问题:~/.google-service-cli/adsensehost4d1-secret.json
,假设已为它启用了所需的 adsensehost API。此类密钥文件可以从 Google 开发者控制台 在 APIs & auth -> Credentials -> Download JSON 下载并直接使用。
有关如何设置 Google 项目和启用 API 的更多信息,请参阅官方文档。
调试
尽管 CLI 尽力提供可用的错误消息,但有时可能希望知道导致特定问题的确切原因。这是通过允许所有客户端服务器通信以原始形式输出到标准错误来完成的。
使用 --debug
标志将错误以 Debug
表示法打印到标准错误。
您可以考虑将标准错误重定向到文件以便于使用,例如 adsensehost4d1 --debug <resource> <method> [options] 2>debug.txt
。
依赖关系
~19–31MB
~577K SLoC