#google #google-api #cli #command-line-interface #adexchangeseller

应用 google-adexchangeseller2-cli

一个用于与 Ad Exchange Seller(协议 v2.0)交互的完整库

20 个稳定版本 (4 个主要版本)

5.0.4+20171101 2024 年 3 月 5 日
3.1.0+20171101 2022 年 4 月 26 日
3.0.0+20171101 2022 年 3 月 8 日
2.0.4+20171101 2021 年 4 月 14 日
0.3.6+20160805 2016 年 9 月 11 日

2856网络编程

Download history 14/week @ 2024-03-10 1/week @ 2024-03-17 165/week @ 2024-03-31 2/week @ 2024-04-07

每月 416 次下载

MIT 许可证

350KB
5K SLoC

adexchangeseller2 命令行界面 (CLI) 允许您从终端舒适地使用 Google Ad Exchange Seller 服务的多数功能。

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

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

有关 Ad Exchange Seller API 的其他信息,请参阅 官方文档网站

安装和源代码

使用 cargo 安装命令行界面

cargo install google-adexchangeseller2-cli

GitHub 上找到源代码。

用法

本文档是从 Ad Exchange Seller API 的 20171101 修订版生成的。CLI 的版本是 5.0.4

adexchangeseller2 [options]
        accounts
                adclients-list <account-id> [-p <v>]... [-o <out>]
                alerts-list <account-id> [-p <v>]... [-o <out>]
                customchannels-get <account-id> <ad-client-id> <custom-channel-id> [-p <v>]... [-o <out>]
                customchannels-list <account-id> <ad-client-id> [-p <v>]... [-o <out>]
                get <account-id> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                metadata-dimensions-list <account-id> [-p <v>]... [-o <out>]
                metadata-metrics-list <account-id> [-p <v>]... [-o <out>]
                preferreddeals-get <account-id> <deal-id> [-p <v>]... [-o <out>]
                preferreddeals-list <account-id> [-p <v>]... [-o <out>]
                reports-generate <account-id> <start-date> <end-date> [-p <v>]... [-o <out>]
                reports-saved-generate <account-id> <saved-report-id> [-p <v>]... [-o <out>]
                reports-saved-list <account-id> [-p <v>]... [-o <out>]
                urlchannels-list <account-id> <ad-client-id> [-p <v>]... [-o <out>]
  adexchangeseller2 --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 文件中,文件以 adexchangeseller2- 前缀开头。您可以使用 --config-dir 标志在每次调用中更改用于存储配置的目录。

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

身份验证

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

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

首次使用范围时,用户会被要求授权。按照CLI提供的指示授权,或拒绝。

如果用户已认证范围,相应的信息将以 JSON 格式存储在配置目录中,例如 ~/.google-service-cli/adexchangeseller2-token-<scope-hash>.json。无需手动管理这些令牌。

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

应用程序密钥

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

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

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

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

调试

尽管CLI尽力提供可用的错误消息,但有时可能希望知道导致特定问题的确切原因。这是通过允许将所有客户端服务器通信以“原样”输出到标准错误来实现的。

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

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

依赖

~20–32MB
~584K SLoC