该 realtimebidding1 命令行界面（CLI）允许您从终端舒适地使用 Google 实时竞价 服务的多数功能。

默认情况下，所有输出都会打印到标准输出，但可以通过标志将其定向到与您的shell能力无关的文件。错误将打印到标准错误，并导致程序退出代码为非零。

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

有关 实时竞价 API 的其他所有信息，请参阅官方文档网站。

安装和源代码

使用 cargo 安装命令行界面

cargo install google-realtimebidding1-cli

在 GitHub 上找到源代码。

用法

本文档是根据修订 20240305 的 实时竞价 API 生成的。CLI 版本为 5.0.4。

realtimebidding1 [options]
        bidders
                creatives-list <parent> [-p <v>]... [-o <out>]
                creatives-watch <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                endpoints-get <name> [-p <v>]... [-o <out>]
                endpoints-list <parent> [-p <v>]... [-o <out>]
                endpoints-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                get <name> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                pretargeting-configs-activate <name> (-r <kv>)... [-p <v>]... [-o <out>]
                pretargeting-configs-add-targeted-apps <pretargeting-config> (-r <kv>)... [-p <v>]... [-o <out>]
                pretargeting-configs-add-targeted-publishers <pretargeting-config> (-r <kv>)... [-p <v>]... [-o <out>]
                pretargeting-configs-add-targeted-sites <pretargeting-config> (-r <kv>)... [-p <v>]... [-o <out>]
                pretargeting-configs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                pretargeting-configs-delete <name> [-p <v>]... [-o <out>]
                pretargeting-configs-get <name> [-p <v>]... [-o <out>]
                pretargeting-configs-list <parent> [-p <v>]... [-o <out>]
                pretargeting-configs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                pretargeting-configs-remove-targeted-apps <pretargeting-config> (-r <kv>)... [-p <v>]... [-o <out>]
                pretargeting-configs-remove-targeted-publishers <pretargeting-config> (-r <kv>)... [-p <v>]... [-o <out>]
                pretargeting-configs-remove-targeted-sites <pretargeting-config> (-r <kv>)... [-p <v>]... [-o <out>]
                pretargeting-configs-suspend <name> (-r <kv>)... [-p <v>]... [-o <out>]
                publisher-connections-batch-approve <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                publisher-connections-batch-reject <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                publisher-connections-get <name> [-p <v>]... [-o <out>]
                publisher-connections-list <parent> [-p <v>]... [-o <out>]
        buyers
                creatives-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                creatives-get <name> [-p <v>]... [-o <out>]
                creatives-list <parent> [-p <v>]... [-o <out>]
                creatives-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                get <name> [-p <v>]... [-o <out>]
                get-remarketing-tag <name> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                user-lists-close <name> (-r <kv>)... [-p <v>]... [-o <out>]
                user-lists-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                user-lists-get <name> [-p <v>]... [-o <out>]
                user-lists-get-remarketing-tag <name> [-p <v>]... [-o <out>]
                user-lists-list <parent> [-p <v>]... [-o <out>]
                user-lists-open <name> (-r <kv>)... [-p <v>]... [-o <out>]
                user-lists-update <name> (-r <kv>)... [-p <v>]... [-o <out>]
  realtimebidding1 --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 文件中，文件名以 realtimebidding1- 前缀。您可以使用 --config-dir 标志在每次调用中更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时，会要求用户授权。按照CLI给出的说明授权或拒绝。

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

要撤销授权，请参考官方文档。

应用程序密钥

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

为了在不强制要求用户注册自己的应用程序的情况下更舒适地使用CLI，CLI包含了一个相应的默认应用程序密钥。这也意味着全球范围内的重用可能会耗尽每日配额。

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

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

调试

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

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

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