retail2 命令行界面（CLI）允许您在终端中轻松使用Google Cloud Retail服务的多数功能。

默认情况下，所有输出都打印到标准输出，但可以设置标志将其直接输出到文件，而无需依赖shell的功能。错误将打印到标准错误，并导致程序退出代码为非零。

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

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

安装和源代码

使用cargo安装命令行界面：

cargo install google-retail2-cli

在GitHub上找到源代码。

用法

本文档是根据修订版 20240222 的 Cloud Retail API 生成的。CLI版本为 5.0.4。

retail2 [options]
        projects
                locations-catalogs-attributes-config-add-catalog-attribute <attributes-config> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-attributes-config-remove-catalog-attribute <attributes-config> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-attributes-config-replace-catalog-attribute <attributes-config> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-branches-operations-get <name> [-p <v>]... [-o <out>]
                locations-catalogs-branches-products-add-fulfillment-places <product> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-branches-products-add-local-inventories <product> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-branches-products-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-branches-products-delete <name> [-p <v>]... [-o <out>]
                locations-catalogs-branches-products-get <name> [-p <v>]... [-o <out>]
                locations-catalogs-branches-products-import <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-branches-products-list <parent> [-p <v>]... [-o <out>]
                locations-catalogs-branches-products-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-branches-products-purge <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-branches-products-remove-fulfillment-places <product> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-branches-products-remove-local-inventories <product> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-branches-products-set-inventory <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-complete-query <catalog> [-p <v>]... [-o <out>]
                locations-catalogs-completion-data-import <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-controls-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-controls-delete <name> [-p <v>]... [-o <out>]
                locations-catalogs-controls-get <name> [-p <v>]... [-o <out>]
                locations-catalogs-controls-list <parent> [-p <v>]... [-o <out>]
                locations-catalogs-controls-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-export-analytics-metrics <catalog> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-get-attributes-config <name> [-p <v>]... [-o <out>]
                locations-catalogs-get-completion-config <name> [-p <v>]... [-o <out>]
                locations-catalogs-get-default-branch <catalog> [-p <v>]... [-o <out>]
                locations-catalogs-list <parent> [-p <v>]... [-o <out>]
                locations-catalogs-models-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-models-delete <name> [-p <v>]... [-o <out>]
                locations-catalogs-models-get <name> [-p <v>]... [-o <out>]
                locations-catalogs-models-list <parent> [-p <v>]... [-o <out>]
                locations-catalogs-models-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-models-pause <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-models-resume <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-models-tune <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-operations-get <name> [-p <v>]... [-o <out>]
                locations-catalogs-operations-list <name> [-p <v>]... [-o <out>]
                locations-catalogs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-placements-predict <placement> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-placements-search <placement> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-serving-configs-add-control <serving-config> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-serving-configs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-serving-configs-delete <name> [-p <v>]... [-o <out>]
                locations-catalogs-serving-configs-get <name> [-p <v>]... [-o <out>]
                locations-catalogs-serving-configs-list <parent> [-p <v>]... [-o <out>]
                locations-catalogs-serving-configs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-serving-configs-predict <placement> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-serving-configs-remove-control <serving-config> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-serving-configs-search <placement> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-set-default-branch <catalog> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-update-attributes-config <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-update-completion-config <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-user-events-collect <parent> [-p <v>]... [-o <out>]
                locations-catalogs-user-events-import <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-user-events-purge <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-user-events-rejoin <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-catalogs-user-events-write <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-operations-get <name> [-p <v>]... [-o <out>]
                locations-operations-list <name> [-p <v>]... [-o <out>]
                operations-get <name> [-p <v>]... [-o <out>]
                operations-list <name> [-p <v>]... [-o <out>]
  retail2 --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 目录中存储所有持久数据，以 retail2- 开头的 JSON 文件。您可以使用 --config-dir 标志在每次调用中更改用于存储配置的目录。

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

身份验证

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

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

第一次使用作用域时，用户将被要求授权。按照CLI给出的说明授予权限或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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