adexperiencereport1 命令行界面（CLI）允许您从终端舒适地使用Google广告体验报告服务的大多数功能。

默认情况下，所有输出都打印到标准输出，但可以设置标志将其定向到与shell能力无关的文件。错误将打印到标准错误，并将程序退出代码设置为非零。

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

关于广告体验报告API的其余信息可以在官方文档站点找到。

安装和源代码

使用cargo安装命令行界面：

cargo install google-adexperiencereport1-cli

在github上找到源代码。

用法

本文档是根据修订版 20240207 的广告体验报告API生成的。CLI版本为 5.0.4。

adexperiencereport1 [options]
        sites
                get <name> [-p <v>]... [-o <out>]
        violating-sites
                list [-p <v>]... [-o <out>]
  adexperiencereport1 --help

Configuration:
  --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 文件中，文件名以 adexperiencereport1- 开头。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

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

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

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

应用程序密钥

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

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

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

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

调试

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

--debug标志将以Debug表示法将错误打印到标准错误。

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