gmailpostmastertools1-beta1 命令行界面 (CLI) 允许您从终端方便地使用 Google Postmaster Tools 服务的多数功能。

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

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

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

安装和源代码

使用 cargo 安装命令行界面

cargo install google-gmailpostmastertools1_beta1-cli

在 GitHub 上找到源代码。

用法

本文档是根据 Postmaster Tools API 在 20240303 修订版中生成的。CLI 版本为 5.0.4。

gmailpostmastertools1-beta1 [options]
        domains
                get <name> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                traffic-stats-get <name> [-p <v>]... [-o <out>]
                traffic-stats-list <parent> [-p <v>]... [-o <out>]
  gmailpostmastertools1-beta1 --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 目录中存储所有持久数据，该目录以 gmailpostmastertools1-beta1- 前缀的 JSON 文件开始。您可以使用 --config-dir 标志根据调用更改用于存储配置的目录。

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

身份验证

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

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

第一次使用范围时，会要求用户授权。按照 CLI 提供的说明授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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