该 analytics3 命令行界面 (CLI) 允许您从终端舒适地使用 Google 分析服务的大多数功能。

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

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

有关 分析 API 的其他一切信息，请参阅 官方文档网站。

安装和源代码

使用 cargo 安装命令行界面

cargo install google-analytics3-cli

在 github 上查找源代码。

用法

此文档是从 分析 API（修订版 20190807）生成的。CLI 版本为 5.0.4。

analytics3 [options]
        data
                ga-get <ids> <start-date> <end-date> <metrics> [-p <v>]... [-o <out>]
                mcf-get <ids> <start-date> <end-date> <metrics> [-p <v>]... [-o <out>]
                realtime-get <ids> <metrics> [-p <v>]... [-o <out>]
        management
                account-summaries-list [-p <v>]... [-o <out>]
                account-user-links-delete <account-id> <link-id> [-p <v>]...
                account-user-links-insert <account-id> (-r <kv>)... [-p <v>]... [-o <out>]
                account-user-links-list <account-id> [-p <v>]... [-o <out>]
                account-user-links-update <account-id> <link-id> (-r <kv>)... [-p <v>]... [-o <out>]
                accounts-list [-p <v>]... [-o <out>]
                client-id-hash-client-id (-r <kv>)... [-p <v>]... [-o <out>]
                custom-data-sources-list <account-id> <web-property-id> [-p <v>]... [-o <out>]
                custom-dimensions-get <account-id> <web-property-id> <custom-dimension-id> [-p <v>]... [-o <out>]
                custom-dimensions-insert <account-id> <web-property-id> (-r <kv>)... [-p <v>]... [-o <out>]
                custom-dimensions-list <account-id> <web-property-id> [-p <v>]... [-o <out>]
                custom-dimensions-patch <account-id> <web-property-id> <custom-dimension-id> (-r <kv>)... [-p <v>]... [-o <out>]
                custom-dimensions-update <account-id> <web-property-id> <custom-dimension-id> (-r <kv>)... [-p <v>]... [-o <out>]
                custom-metrics-get <account-id> <web-property-id> <custom-metric-id> [-p <v>]... [-o <out>]
                custom-metrics-insert <account-id> <web-property-id> (-r <kv>)... [-p <v>]... [-o <out>]
                custom-metrics-list <account-id> <web-property-id> [-p <v>]... [-o <out>]
                custom-metrics-patch <account-id> <web-property-id> <custom-metric-id> (-r <kv>)... [-p <v>]... [-o <out>]
                custom-metrics-update <account-id> <web-property-id> <custom-metric-id> (-r <kv>)... [-p <v>]... [-o <out>]
                experiments-delete <account-id> <web-property-id> <profile-id> <experiment-id> [-p <v>]...
                experiments-get <account-id> <web-property-id> <profile-id> <experiment-id> [-p <v>]... [-o <out>]
                experiments-insert <account-id> <web-property-id> <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
                experiments-list <account-id> <web-property-id> <profile-id> [-p <v>]... [-o <out>]
                experiments-patch <account-id> <web-property-id> <profile-id> <experiment-id> (-r <kv>)... [-p <v>]... [-o <out>]
                experiments-update <account-id> <web-property-id> <profile-id> <experiment-id> (-r <kv>)... [-p <v>]... [-o <out>]
                filters-delete <account-id> <filter-id> [-p <v>]... [-o <out>]
                filters-get <account-id> <filter-id> [-p <v>]... [-o <out>]
                filters-insert <account-id> (-r <kv>)... [-p <v>]... [-o <out>]
                filters-list <account-id> [-p <v>]... [-o <out>]
                filters-patch <account-id> <filter-id> (-r <kv>)... [-p <v>]... [-o <out>]
                filters-update <account-id> <filter-id> (-r <kv>)... [-p <v>]... [-o <out>]
                goals-get <account-id> <web-property-id> <profile-id> <goal-id> [-p <v>]... [-o <out>]
                goals-insert <account-id> <web-property-id> <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
                goals-list <account-id> <web-property-id> <profile-id> [-p <v>]... [-o <out>]
                goals-patch <account-id> <web-property-id> <profile-id> <goal-id> (-r <kv>)... [-p <v>]... [-o <out>]
                goals-update <account-id> <web-property-id> <profile-id> <goal-id> (-r <kv>)... [-p <v>]... [-o <out>]
                profile-filter-links-delete <account-id> <web-property-id> <profile-id> <link-id> [-p <v>]...
                profile-filter-links-get <account-id> <web-property-id> <profile-id> <link-id> [-p <v>]... [-o <out>]
                profile-filter-links-insert <account-id> <web-property-id> <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
                profile-filter-links-list <account-id> <web-property-id> <profile-id> [-p <v>]... [-o <out>]
                profile-filter-links-patch <account-id> <web-property-id> <profile-id> <link-id> (-r <kv>)... [-p <v>]... [-o <out>]
                profile-filter-links-update <account-id> <web-property-id> <profile-id> <link-id> (-r <kv>)... [-p <v>]... [-o <out>]
                profile-user-links-delete <account-id> <web-property-id> <profile-id> <link-id> [-p <v>]...
                profile-user-links-insert <account-id> <web-property-id> <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
                profile-user-links-list <account-id> <web-property-id> <profile-id> [-p <v>]... [-o <out>]
                profile-user-links-update <account-id> <web-property-id> <profile-id> <link-id> (-r <kv>)... [-p <v>]... [-o <out>]
                profiles-delete <account-id> <web-property-id> <profile-id> [-p <v>]...
                profiles-get <account-id> <web-property-id> <profile-id> [-p <v>]... [-o <out>]
                profiles-insert <account-id> <web-property-id> (-r <kv>)... [-p <v>]... [-o <out>]
                profiles-list <account-id> <web-property-id> [-p <v>]... [-o <out>]
                profiles-patch <account-id> <web-property-id> <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
                profiles-update <account-id> <web-property-id> <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
                remarketing-audience-delete <account-id> <web-property-id> <remarketing-audience-id> [-p <v>]...
                remarketing-audience-get <account-id> <web-property-id> <remarketing-audience-id> [-p <v>]... [-o <out>]
                remarketing-audience-insert <account-id> <web-property-id> (-r <kv>)... [-p <v>]... [-o <out>]
                remarketing-audience-list <account-id> <web-property-id> [-p <v>]... [-o <out>]
                remarketing-audience-patch <account-id> <web-property-id> <remarketing-audience-id> (-r <kv>)... [-p <v>]... [-o <out>]
                remarketing-audience-update <account-id> <web-property-id> <remarketing-audience-id> (-r <kv>)... [-p <v>]... [-o <out>]
                segments-list [-p <v>]... [-o <out>]
                unsampled-reports-delete <account-id> <web-property-id> <profile-id> <unsampled-report-id> [-p <v>]...
                unsampled-reports-get <account-id> <web-property-id> <profile-id> <unsampled-report-id> [-p <v>]... [-o <out>]
                unsampled-reports-insert <account-id> <web-property-id> <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
                unsampled-reports-list <account-id> <web-property-id> <profile-id> [-p <v>]... [-o <out>]
                uploads-delete-upload-data <account-id> <web-property-id> <custom-data-source-id> (-r <kv>)... [-p <v>]...
                uploads-get <account-id> <web-property-id> <custom-data-source-id> <upload-id> [-p <v>]... [-o <out>]
                uploads-list <account-id> <web-property-id> <custom-data-source-id> [-p <v>]... [-o <out>]
                uploads-upload-data <account-id> <web-property-id> <custom-data-source-id> (-u simple -f <file> [-m <mime>]) [-p <v>]... [-o <out>]
                web-property-ad-words-links-delete <account-id> <web-property-id> <web-property-ad-words-link-id> [-p <v>]...
                web-property-ad-words-links-get <account-id> <web-property-id> <web-property-ad-words-link-id> [-p <v>]... [-o <out>]
                web-property-ad-words-links-insert <account-id> <web-property-id> (-r <kv>)... [-p <v>]... [-o <out>]
                web-property-ad-words-links-list <account-id> <web-property-id> [-p <v>]... [-o <out>]
                web-property-ad-words-links-patch <account-id> <web-property-id> <web-property-ad-words-link-id> (-r <kv>)... [-p <v>]... [-o <out>]
                web-property-ad-words-links-update <account-id> <web-property-id> <web-property-ad-words-link-id> (-r <kv>)... [-p <v>]... [-o <out>]
                webproperties-get <account-id> <web-property-id> [-p <v>]... [-o <out>]
                webproperties-insert <account-id> (-r <kv>)... [-p <v>]... [-o <out>]
                webproperties-list <account-id> [-p <v>]... [-o <out>]
                webproperties-patch <account-id> <web-property-id> (-r <kv>)... [-p <v>]... [-o <out>]
                webproperties-update <account-id> <web-property-id> (-r <kv>)... [-p <v>]... [-o <out>]
                webproperty-user-links-delete <account-id> <web-property-id> <link-id> [-p <v>]...
                webproperty-user-links-insert <account-id> <web-property-id> (-r <kv>)... [-p <v>]... [-o <out>]
                webproperty-user-links-list <account-id> <web-property-id> [-p <v>]... [-o <out>]
                webproperty-user-links-update <account-id> <web-property-id> <link-id> (-r <kv>)... [-p <v>]... [-o <out>]
        metadata
                columns-list <report-type> [-p <v>]... [-o <out>]
        provisioning
                create-account-ticket (-r <kv>)... [-p <v>]... [-o <out>]
                create-account-tree (-r <kv>)... [-p <v>]... [-o <out>]
        user-deletion
                user-deletion-request-upsert (-r <kv>)... [-p <v>]... [-o <out>]
  analytics3 --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 文件中，文件名以 analytics3- 开头。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

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

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

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

应用程序密钥

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

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

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

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

调试

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

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

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