doubleclicksearch2 命令行界面 (CLI) 允许您从终端舒适地使用 Google Doubleclicksearch 服务的几乎所有功能。

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

如果请求数据结构，则这些数据结构将作为格式化的 JSON 返回，以便作为其他工具的输入使用。

关于 Doubleclicksearch API 的其他所有信息都可以在 官方文档网站 找到。

安装和源代码

使用 cargo 安装命令行界面

cargo install google-doubleclicksearch2-cli

在 GitHub 上查找源代码。

用法

本文档是从 Doubleclicksearch API 的修订版 20220301 生成的。CLI 的版本为 3.1.0。

doubleclicksearch2 [options]
        conversion
                get <agency-id> <advertiser-id> <engine-account-id> <end-date> <row-count> <start-date> <start-row> [-p <v>]... [-o <out>]
                insert (-r <kv>)... [-p <v>]... [-o <out>]
                update (-r <kv>)... [-p <v>]... [-o <out>]
                update-availability (-r <kv>)... [-p <v>]... [-o <out>]
        reports
                generate (-r <kv>)... [-p <v>]... [-o <out>]
                get <report-id> [-p <v>]... [-o <out>]
                get-file <report-id> <report-fragment> [-p <v>]... [-o <out>]
                request (-r <kv>)... [-p <v>]... [-o <out>]
        saved-columns
                list <agency-id> <advertiser-id> [-p <v>]... [-o <out>]
  doubleclicksearch2 --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 目录中，以 doubleclicksearch2- 为前缀的 JSON 文件中。您可以通过在每次调用时使用 --config-dir 标志来更改用于存储配置的目录。

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

身份验证

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

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

首次使用范围时，会询问用户权限。按照CLI的说明授予权限或拒绝。

如果用户验证了范围，相关信息将以JSON格式存储在配置目录中，例如~/.google-service-cli/doubleclicksearch2-token-.json。不需要手动管理这些令牌。

要撤销授予的认证，请参阅官方文档。

应用程序密钥

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

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

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

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

调试

尽管CLI尽最大努力提供可用的错误消息，但有时了解导致特定问题的确切原因可能是有用的。这是通过允许将所有客户端-服务器通信输出到标准错误原样来完成的。

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

您可以将标准错误重定向到文件，以便于使用，例如doubleclicksearch2 --debug <resource> <method> [options] 2>debug.txt。