searchconsole1 命令行界面（CLI）允许您在终端中轻松使用大多数Google搜索控制台服务功能。

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

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

有关搜索控制台API的所有其他信息，请参阅官方文档网站。

安装和源代码

使用cargo安装命令行界面

cargo install google-searchconsole1-cli

在GitHub上查找源代码。

用法

本文档是根据修订版20240304的搜索控制台API生成的。CLI版本为5.0.4。

searchconsole1 [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>]
        url-inspection
                index-inspect (-r <kv>)... [-p <v>]... [-o <out>]
        url-testing-tools
                mobile-friendly-test-run (-r <kv>)... [-p <v>]... [-o <out>]
  searchconsole1 --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目录中，以searchconsole1-为前缀的JSON文件中。您可以通过--config-dir标志在每次调用时更改用于存储配置的目录。

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

身份验证

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

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

第一次使用范围时，会要求用户授权。按照 CLI 指示授予权限或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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