webmasters3命令行界面（CLI）允许您从终端舒适地使用Google网站管理员服务的多数功能。

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

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

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

安装和源代码

使用cargo安装命令行界面

cargo install google-webmasters3-cli

在github上找到源代码。

用法

本文档是从webmasters API的20190428修订版生成的。CLI版本为5.0.4。

webmasters3 [options]
        searchanalytics
                query <site-url> (-r <kv>)... [-p <v>]... [-o <out>]
        sitemaps
                delete <site-url> <feedpath> [-p <v>]...
                get <site-url> <feedpath> [-p <v>]... [-o <out>]
                list <site-url> [-p <v>]... [-o <out>]
                submit <site-url> <feedpath> [-p <v>]...
        sites
                add <site-url> [-p <v>]...
                delete <site-url> [-p <v>]...
                get <site-url> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
  webmasters3 --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目录中存储所有持久数据，该目录以webmasters3-为前缀的JSON文件中。您可以使用--config-dir标志在每个调用的基础上更改用于存储配置的目录。

有关各种持久数据的更多信息，请参阅以下段落。

身份验证

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

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

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

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

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

应用程序密钥

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

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

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

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

调试

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

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

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