admin1-reports命令行界面（CLI）允许您在终端中轻松使用Google reports服务的大部分功能。

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

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

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

安装和源代码

使用cargo安装命令行界面：

cargo install google-admin1_reports-cli

在github上找到源代码。

用法

本文档是从修订版20190521的reports API生成的。CLI的版本是1.0.12。

admin1-reports [options]
        activities
                list <user-key> <application-name> [-p <v>]... [-o <out>]
                watch <user-key> <application-name> (-r <kv>)... [-p <v>]... [-o <out>]
        channels
                stop (-r <kv>)... [-p <v>]...
        customer-usage-reports
                get <date> [-p <v>]... [-o <out>]
        entity-usage-reports
                get <entity-type> <entity-key> <date> [-p <v>]... [-o <out>]
        user-usage-report
                get <user-key> <date> [-p <v>]... [-o <out>]
  admin1-reports --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]
  --debug
            Output all server communication to standard error. `tx` and `rx` are placed
            into the same stream.
  --debug-auth
            Output all communication related to authentication to standard error. `tx`
            and `rx` are placed into the same stream.

配置

程序将所有持久数据存储在~/.google-service-cli目录中的JSON文件中，文件名以admin1-reports-开头。您可以使用--config-dir标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时，会要求用户授权。根据CLI给出的说明进行授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

使用--debug标志将打印所有客户端-服务器通信到标准错误，而使用--debug-auth标志将导致所有与认证相关的通信输出到标准错误。如果设置了--debug标志，错误结果将被调试打印，可能提供有关问题的更多信息。