recommender1-beta1 命令行界面（CLI）允许您在终端中方便地使用大多数Google推荐器服务的功能。

默认情况下，所有输出都会打印到标准输出，但可以设置标志将其直接导向文件，而不管您的shell功能如何。错误将打印到标准错误，并导致程序的退出代码不为零。

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

有关Recommender API的更多信息，请参阅官方文档网站。

安装和源代码

使用cargo安装命令行界面：

cargo install google-recommender1_beta1-cli

在github上找到源代码。

使用方法

本文档是根据修订版20240226的Recommender API生成的。CLI的版本为5.0.4。

recommender1-beta1 [options]
        billing-accounts
                locations-insight-types-get-config <name> [-p <v>]... [-o <out>]
                locations-insight-types-insights-get <name> [-p <v>]... [-o <out>]
                locations-insight-types-insights-list <parent> [-p <v>]... [-o <out>]
                locations-insight-types-insights-mark-accepted <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-insight-types-update-config <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
                locations-recommenders-get-config <name> [-p <v>]... [-o <out>]
                locations-recommenders-recommendations-get <name> [-p <v>]... [-o <out>]
                locations-recommenders-recommendations-list <parent> [-p <v>]... [-o <out>]
                locations-recommenders-recommendations-mark-claimed <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-recommenders-recommendations-mark-dismissed <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-recommenders-recommendations-mark-failed <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-recommenders-recommendations-mark-succeeded <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-recommenders-update-config <name> (-r <kv>)... [-p <v>]... [-o <out>]
        folders
                locations-insight-types-insights-get <name> [-p <v>]... [-o <out>]
                locations-insight-types-insights-list <parent> [-p <v>]... [-o <out>]
                locations-insight-types-insights-mark-accepted <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
                locations-recommenders-recommendations-get <name> [-p <v>]... [-o <out>]
                locations-recommenders-recommendations-list <parent> [-p <v>]... [-o <out>]
                locations-recommenders-recommendations-mark-claimed <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-recommenders-recommendations-mark-dismissed <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-recommenders-recommendations-mark-failed <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-recommenders-recommendations-mark-succeeded <name> (-r <kv>)... [-p <v>]... [-o <out>]
        insight-types
                list [-p <v>]... [-o <out>]
        organizations
                locations-insight-types-get-config <name> [-p <v>]... [-o <out>]
                locations-insight-types-insights-get <name> [-p <v>]... [-o <out>]
                locations-insight-types-insights-list <parent> [-p <v>]... [-o <out>]
                locations-insight-types-insights-mark-accepted <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-insight-types-update-config <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
                locations-recommenders-get-config <name> [-p <v>]... [-o <out>]
                locations-recommenders-recommendations-get <name> [-p <v>]... [-o <out>]
                locations-recommenders-recommendations-list <parent> [-p <v>]... [-o <out>]
                locations-recommenders-recommendations-mark-claimed <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-recommenders-recommendations-mark-dismissed <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-recommenders-recommendations-mark-failed <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-recommenders-recommendations-mark-succeeded <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-recommenders-update-config <name> (-r <kv>)... [-p <v>]... [-o <out>]
        projects
                locations-insight-types-get-config <name> [-p <v>]... [-o <out>]
                locations-insight-types-insights-get <name> [-p <v>]... [-o <out>]
                locations-insight-types-insights-list <parent> [-p <v>]... [-o <out>]
                locations-insight-types-insights-mark-accepted <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-insight-types-update-config <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
                locations-recommenders-get-config <name> [-p <v>]... [-o <out>]
                locations-recommenders-recommendations-get <name> [-p <v>]... [-o <out>]
                locations-recommenders-recommendations-list <parent> [-p <v>]... [-o <out>]
                locations-recommenders-recommendations-mark-claimed <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-recommenders-recommendations-mark-dismissed <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-recommenders-recommendations-mark-failed <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-recommenders-recommendations-mark-succeeded <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-recommenders-update-config <name> (-r <kv>)... [-p <v>]... [-o <out>]
        recommenders
                list [-p <v>]... [-o <out>]
  recommender1-beta1 --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文件中，文件名以recommender1-beta1-开头。您可以使用--config-dir标志在每个调用中更改用于存储配置的目录。

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

身份验证

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

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

当第一次使用作用域时，系统会要求用户授权。按照CLI给出的指示授权或拒绝。

如果用户已经认证了某个作用域，相关信息均将以JSON格式存储在配置目录中，例如：~/.google-service-cli/recommender1-beta1-token-<scope-hash>.json。无需手动管理这些令牌。

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

应用程序密钥

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

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

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

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

调试

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

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

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