该 adsense2 命令行界面 (CLI) 允许您在终端中轻松使用 Google adsense 服务的几乎所有功能。

默认情况下，所有输出都打印到标准输出，但可以设置标志将其直接输出到文件，而不考虑您的 shell 功能。错误将打印到标准错误，并导致程序退出代码非零。

如果请求数据结构，则这些数据结构将以漂亮的打印 JSON 返回，以便作为其他工具的输入。

有关 adsense API 的其他信息，请参阅 官方文档网站。

安装和源代码

使用 cargo 安装命令行界面：

cargo install google-adsense2-cli

在 GitHub上找到源代码。

用法

本文档是从修订版 20240305 的 adsense API 生成的。CLI 版本为 5.0.4。

adsense2 [options]
        accounts
                adclients-adunits-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                adclients-adunits-get <name> [-p <v>]... [-o <out>]
                adclients-adunits-get-adcode <name> [-p <v>]... [-o <out>]
                adclients-adunits-list <parent> [-p <v>]... [-o <out>]
                adclients-adunits-list-linked-custom-channels <parent> [-p <v>]... [-o <out>]
                adclients-adunits-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                adclients-customchannels-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                adclients-customchannels-delete <name> [-p <v>]... [-o <out>]
                adclients-customchannels-get <name> [-p <v>]... [-o <out>]
                adclients-customchannels-list <parent> [-p <v>]... [-o <out>]
                adclients-customchannels-list-linked-ad-units <parent> [-p <v>]... [-o <out>]
                adclients-customchannels-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                adclients-get <name> [-p <v>]... [-o <out>]
                adclients-get-adcode <name> [-p <v>]... [-o <out>]
                adclients-list <parent> [-p <v>]... [-o <out>]
                adclients-urlchannels-get <name> [-p <v>]... [-o <out>]
                adclients-urlchannels-list <parent> [-p <v>]... [-o <out>]
                alerts-list <parent> [-p <v>]... [-o <out>]
                get <name> [-p <v>]... [-o <out>]
                get-ad-blocking-recovery-tag <name> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                list-child-accounts <parent> [-p <v>]... [-o <out>]
                payments-list <parent> [-p <v>]... [-o <out>]
                reports-generate <account> [-p <v>]... [-o <out>]
                reports-generate-csv <account> [-p <v>]... [-o <out>]
                reports-get-saved <name> [-p <v>]... [-o <out>]
                reports-saved-generate <name> [-p <v>]... [-o <out>]
                reports-saved-generate-csv <name> [-p <v>]... [-o <out>]
                reports-saved-list <parent> [-p <v>]... [-o <out>]
                sites-get <name> [-p <v>]... [-o <out>]
                sites-list <parent> [-p <v>]... [-o <out>]
  adsense2 --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 文件中存储所有持久数据，文件名以 adsense2- 为前缀。您可以使用 --config-dir 标志在每次调用中更改用于存储配置的目录。

以下段落中提供了有关各种类型持久数据的更多信息。

身份验证

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

如果没有设置，系统将自动选择最小的可行作用域，例如，在调用只读方法时，它只请求只读作用域。您可以使用 --scope 标志直接指定作用域。所有适用作用域均在各自方法的 CLI 文档中记录。

第一次使用作用域时，用户会被要求进行权限授权。按照 CLI 提供的说明进行授权，或拒绝。

如果作用域被用户验证，相关信息将作为JSON存储在配置目录中，例如：~/.google-service-cli/adsense2-token-<scope-hash>.json。无需手动管理这些令牌。

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

应用程序密钥

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

为了在不强制任何人为自己的应用程序注册的情况下更方便地使用CLI，CLI自带了一个默认的应用程序密钥，并相应地配置。这也意味着全球范围内的重用可能会耗尽每日配额。

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

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

调试

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

使用--debug标志将错误打印到标准错误，使用Debug表示形式。

您可以考虑将标准错误重定向到文件以方便使用，例如：adsense2 --debug <资源> <方法> [选项] 2>debug.txt。