1个稳定版本
使用旧Rust 2015
1.0.8+20181010 | 2018年10月14日 |
---|
#56 in #standard-error
270KB
3.5K SLoC
该 youtubeanalytics2
命令行界面(CLI)允许您在终端中舒适地使用Google YouTube分析服务的大部分功能。
默认情况下,所有输出都打印到标准输出,但可以通过设置标志将其直接重定向到文件,而不依赖于shell的能力。错误将打印到标准错误,并导致程序的退出代码不为零。
如果请求数据结构,这些结构将以美观打印的JSON返回,可作为其他工具的输入使用。
有关YouTube分析API的所有其他信息,请参阅官方文档站点。
安装和源代码
使用cargo安装命令行界面
cargo install google-youtubeanalytics2-cli
用法
本文档是从YouTube分析 API(修订版20181010)生成的。CLI的版本为1.0.8。
youtubeanalytics2 [options]
group-items
delete [-p <v>]... [-o <out>]
insert (-r <kv>)... [-p <v>]... [-o <out>]
list [-p <v>]... [-o <out>]
groups
delete [-p <v>]... [-o <out>]
insert (-r <kv>)... [-p <v>]... [-o <out>]
list [-p <v>]... [-o <out>]
update (-r <kv>)... [-p <v>]... [-o <out>]
reports
query [-p <v>]... [-o <out>]
youtubeanalytics2 --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
目录中存储所有持久数据,该目录以youtubeanalytics2-
为前缀的JSON文件中。您可以使用--config-dir
标志在每个调用的基础上更改用于存储配置的目录。
以下段落提供了有关各种持久数据的更多信息。
身份验证
大多数API都需要用户对任何请求进行身份验证。如果是这种情况,则范围确定授予的权限集。这些的粒度通常不超过只读或完全访问。
如果未设置,系统将自动选择最小的可行范围,例如,在调用只读方法时,它将仅请求只读范围。您可以使用--scope
标志直接指定范围。所有适用的范围均在各自方法的CLI文档中记录。
首次使用范围时,系统会要求用户进行权限请求。遵循CLI提供的指示来授予权限或拒绝。
如果作用域已被用户认证,则相应信息将作为JSON存储在配置目录中,例如~/.google-service-cli/youtubeanalytics2-token-<scope-hash>.json
。无需手动管理这些令牌。
要撤销授权的认证,请参阅官方文档。
应用程序密钥
为了允许任何应用程序使用Google服务,它需要通过Google开发者控制台进行注册。然后为应用程序逐个启用可能使用的API。大多数API可以免费使用,并且有每日配额。
为了在不强制用户注册自己的应用程序的情况下更方便地使用CLI,CLI自带了一个默认的应用程序密钥,并相应地进行配置。这也意味着全球范围内的重用可能会耗尽每日配额。
您可以通过将您自己的密钥文件放在此位置来解决这个问题:~/.google-service-cli/youtubeanalytics2-secret.json
,假设已经为它启用了所需的youtubeAnalytics API。这样的密钥文件可以在Google开发者控制台的APIs & auth -> Credentials -> Download JSON中下载,并直接使用。
有关如何设置Google项目和启用API的更多信息,请参阅官方文档。
调试
尽管CLI尽最大努力提供可用的错误消息,但有时可能希望了解导致特定问题的确切原因。这是通过允许所有客户端服务器通信直接输出到标准错误来完成的。
--debug
标志将打印所有客户端服务器通信到标准错误,而--debug-auth
标志将导致与认证相关的所有通信输出到标准错误。如果设置了--debug
标志,错误结果将被调试打印,可能提供有关当前问题的更多信息。
您可以考虑将标准错误重定向到文件,以便于使用,例如youtubeanalytics2 --debug <resource> <method> [options] 2>debug.txt
。
依赖项
~17–27MB
~536K SLoC