5个稳定版本

5.0.4+20240304 2024年3月5日
3.1.0+20220303 2022年4月26日
3.0.0+20220303 2022年3月8日
2.0.4+20210329 2021年4月15日
2.0.0+20210329 2021年4月2日

#316 in #command-line-interface

Download history 2/week @ 2024-04-07

88 个月下载量

MIT 许可证

430KB
5K SLoC

analyticsdata1-beta 命令行界面(CLI)允许您从终端舒适地使用Google AnalyticsData服务的多数功能。

默认情况下,所有输出都打印到标准输出,但可以设置标志将其直接导向文件,而无需依赖shell的功能。错误将打印到标准错误,并导致程序的退出代码非零。

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

有关AnalyticsData API的所有其他信息,请参阅官方文档网站

安装和源代码

使用cargo安装命令行界面:

cargo install google-analyticsdata1_beta-cli

GitHub上找到源代码。

用法

此文档是从版本20240304的AnalyticsData API生成的。CLI版本为5.0.4

analyticsdata1-beta [options]
        properties
                audience-exports-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                audience-exports-get <name> [-p <v>]... [-o <out>]
                audience-exports-list <parent> [-p <v>]... [-o <out>]
                audience-exports-query <name> (-r <kv>)... [-p <v>]... [-o <out>]
                batch-run-pivot-reports <property> (-r <kv>)... [-p <v>]... [-o <out>]
                batch-run-reports <property> (-r <kv>)... [-p <v>]... [-o <out>]
                check-compatibility <property> (-r <kv>)... [-p <v>]... [-o <out>]
                get-metadata <name> [-p <v>]... [-o <out>]
                run-pivot-report <property> (-r <kv>)... [-p <v>]... [-o <out>]
                run-realtime-report <property> (-r <kv>)... [-p <v>]... [-o <out>]
                run-report <property> (-r <kv>)... [-p <v>]... [-o <out>]
  analyticsdata1-beta --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文件的形式存储所有持久数据,文件名以analyticsdata1-beta-开头。您可以使用--config-dir标志在每次调用中更改用于存储配置的目录。

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

身份验证

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

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

第一次使用作用域时,用户将被要求授权。遵循CLI给出的说明来授予权限或拒绝。

如果用户验证了作用域,相关数据将作为JSON存储在配置目录中,例如:~/.google-service-cli/analyticsdata1-beta-token-<scope-hash>.json。无需手动管理这些令牌。

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

应用程序密钥

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

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

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

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

调试

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

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

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

依赖关系

~20–31MB
~577K SLoC