11个稳定版本

使用旧的Rust 2015

1.0.8+20181010 2018年10月14日
1.0.7+20171206 2017年12月12日
1.0.6+20170925 2017年9月27日
1.0.5+20170517 2017年5月26日
0.3.6+20160513 2016年9月11日

#43#standard-error

29 每月下载量

MIT 许可证

265KB
3.5K SLoC

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

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

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

有关YouTube分析API的更多信息,请参阅官方文档网站

安装和源代码

使用cargo安装命令行界面:

cargo install google-youtubeanalytics1-cli

GitHub上找到源代码。

用法

此文档是根据修订版20181010的YouTube分析API生成的。CLI的版本为1.0.8

youtubeanalytics1 [options]
        group-items
                delete <id> [-p <v>]...
                insert (-r <kv>)... [-p <v>]... [-o <out>]
                list <group-id> [-p <v>]... [-o <out>]
        groups
                delete <id> [-p <v>]...
                insert (-r <kv>)... [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                update (-r <kv>)... [-p <v>]... [-o <out>]
        reports
                query <ids> <start-date> <end-date> <metrics> [-p <v>]... [-o <out>]
  youtubeanalytics1 --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文件中,文件名以youtubeanalytics1-开头。您可以使用--config-dir标志在每次调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

第一次使用作用域时,系统会要求用户授权。遵循CLI给出的说明进行授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

尽管CLI尽力提供可用的错误消息,但有时可能希望知道导致特定问题确切原因。这是通过允许所有客户端服务器通信以标准错误的形式输出。

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

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

依赖项

~16–28MB
~533K SLoC