#google #cli #google-api #abusive-experience-report

应用 google-abusiveexperiencereport1-cli

与滥用体验报告(协议 v1)交互的完整库

13 个稳定版本 (3 个主要版本)

5.0.4+20240207 2024 年 3 月 5 日
3.1.0+20220303 2022 年 4 月 26 日
3.0.0+20220303 2022 年 3 月 8 日
2.0.4+20210329 2021 年 4 月 14 日
1.0.7+20171129 2017 年 12 月 12 日

#2943网络编程

Download history 13/week @ 2024-03-10 110/week @ 2024-03-31 2/week @ 2024-04-07 1/week @ 2024-05-19

每月 256 次下载

MIT 许可证

105KB
1.5K SLoC

abusiveexperiencereport1 命令行界面 (CLI) 允许您在终端中舒适地使用 Google 滥用体验报告服务的几乎所有功能。

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

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

有关滥用体验报告 API 的其他信息,请参阅官方文档网站

安装和源代码

使用 cargo 安装命令行界面

cargo install google-abusiveexperiencereport1-cli

GitHub 上查找源代码。

用法

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

abusiveexperiencereport1 [options]
        sites
                get <name> [-p <v>]... [-o <out>]
        violating-sites
                list [-p <v>]... [-o <out>]
  abusiveexperiencereport1 --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 文件中,文件以 abusiveexperiencereport1- 开头。您可以使用 --config-dir 标志在每次调用中更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时,用户将被要求授权。按照 CLI 提供的指示授权或拒绝。

如果用户已对作用域进行了认证,相应的信息将被存储在配置目录中,以 JSON 格式,例如 ~/.google-service-cli/abusiveexperiencereport1-token-<scope-hash>.json。无需手动管理这些令牌。

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

应用程序密钥

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

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

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

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

调试

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

带有 --debug 标志将使用 Debug 表示法将错误打印到标准错误。

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

依赖项

~19–31MB
~579K SLoC