AnalyticsReporting 命令行界面 (CLI) 允许您在终端舒适地使用 Google AnalyticsReporting 服务的几乎所有功能。

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

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

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

安装和源代码

使用 cargo 安装命令行界面

cargo install google-analyticsreporting4-cli

在 GitHub 上找到源代码。

用法

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

analyticsreporting4 [options]
        reports
                batch-get (-r <kv>)... [-p <v>]... [-o <out>]
        user-activity
                search (-r <kv>)... [-p <v>]... [-o <out>]
  analyticsreporting4 --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 目录中，以 analyticsreporting4- 开头的 JSON 文件中。您可以通过在每次调用时使用 --config-dir 标志来更改用于存储配置的目录。

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

身份验证

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

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

第一次使用范围时，会要求用户授权。根据 CLI 的指示授权，或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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