youtubereporting1 命令行界面（CLI）允许您从终端舒适地使用大多数 Google YouTube Reporting 服务功能。

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

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

有关 YouTube Reporting API 的其他所有信息，请参阅 官方文档站点。

安装和源代码

使用 cargo 安装命令行界面：

cargo install google-youtubereporting1-cli

在 GitHub 上找到源代码。

用法

本文档是从修订版 20240304 的 YouTube Reporting API 生成的。CLI 的版本是 5.0.4。

youtubereporting1 [options]
        jobs
                create (-r <kv>)... [-p <v>]... [-o <out>]
                delete <job-id> [-p <v>]... [-o <out>]
                get <job-id> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                reports-get <job-id> <report-id> [-p <v>]... [-o <out>]
                reports-list <job-id> [-p <v>]... [-o <out>]
        media
                download <resource-name> [-p <v>]... [-o <out>]
        report-types
                list [-p <v>]... [-o <out>]
  youtubereporting1 --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 文件中，文件名以 youtubereporting1- 开头。您可以使用 --config-dir 标志在每次调用中更改用于存储配置的目录。

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

身份验证

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

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

第一次使用作用域时，系统会要求用户授权。按照 CLI 提供的说明授予权限或拒绝。

如果作用域被用户验证，相应的信息将以JSON格式存储在配置目录中，例如：~/.google-service-cli/youtubereporting1-token-<scope-hash>.json。不需要手动管理这些令牌。

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

应用程序密钥

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

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

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

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

调试

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

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

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