gmailpostmastertools1命令行界面（CLI）允许您从终端舒适地使用Google Postmaster Tools服务的几乎所有功能。

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

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

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

安装和源代码

使用cargo安装命令行界面

cargo install google-gmailpostmastertools1-cli

在github上查找源代码。

用法

此文档是从修订版20240303的Postmaster Tools API生成的。CLI版本为5.0.4。

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

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

身份验证

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

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

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

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

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

应用程序密钥

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

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

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

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

调试

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

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

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