indexing3 命令行界面（CLI）允许您在终端中舒适地使用 Google 索引服务的大部分功能。

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

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

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

安装和源代码

使用 cargo 安装命令行界面：

cargo install google-indexing3-cli

在 GitHub 上找到源代码。

用法

本文档是根据修订版 20240227 的索引 API 生成的。CLI 的版本为 5.0.4。

indexing3 [options]
        url-notifications
                get-metadata [-p <v>]... [-o <out>]
                publish (-r <kv>)... [-p <v>]... [-o <out>]
  indexing3 --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 目录中存储所有持久数据，该目录以 indexing3- 为前缀的 JSON 文件。您可以使用 --config-dir 标志根据调用更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时，会询问用户授权。按照CLI的指示授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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