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

默认情况下，所有输出都打印到标准输出，但可以使用标志将其重定向到文件，而不受您的 shell 功能的限制。错误将打印到标准错误，并将导致程序退出代码非零。

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

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

安装和源代码

使用 cargo 安装命令行界面

cargo install google-partners2-cli

在 GitHub 上查找源代码。

用法

本文档是根据修订版 20180925 的 Partners API 生成的。CLI 版本为 5.0.4。

partners2 [options]
        analytics
                list [-p <v>]... [-o <out>]
        client-messages
                log (-r <kv>)... [-p <v>]... [-o <out>]
        companies
                get <company-id> [-p <v>]... [-o <out>]
                leads-create <company-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
        leads
                list [-p <v>]... [-o <out>]
        methods
                get-partnersstatus [-p <v>]... [-o <out>]
                update-companies (-r <kv>)... [-p <v>]... [-o <out>]
                update-leads (-r <kv>)... [-p <v>]... [-o <out>]
        offers
                history-list [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
        user-events
                log (-r <kv>)... [-p <v>]... [-o <out>]
        user-states
                list [-p <v>]... [-o <out>]
        users
                create-company-relation <user-id> (-r <kv>)... [-p <v>]... [-o <out>]
                delete-company-relation <user-id> [-p <v>]... [-o <out>]
                get <user-id> [-p <v>]... [-o <out>]
                update-profile (-r <kv>)... [-p <v>]... [-o <out>]
  partners2 --help

Configuration:
  --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 文件中，文件名以 partners2- 开头。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时，会请求用户授权。根据 CLI 提供的说明进行授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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