contactcenterinsights1 命令行界面（CLI）允许您从终端舒适地使用 Google Contactcenterinsights 服务的大部分功能。

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

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

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

安装和源代码

使用 cargo 安装命令行界面：

cargo install google-contactcenterinsights1-cli

在 GitHub 上查找源代码。

用法

此文档是从修订版 20240226 的 Contactcenterinsights API 生成的。CLI 版本为 5.0.4。

contactcenterinsights1 [options]
        projects
                locations-conversations-analyses-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-conversations-analyses-delete <name> [-p <v>]... [-o <out>]
                locations-conversations-analyses-get <name> [-p <v>]... [-o <out>]
                locations-conversations-analyses-list <parent> [-p <v>]... [-o <out>]
                locations-conversations-bulk-analyze <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-conversations-bulk-delete <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-conversations-calculate-stats <location> [-p <v>]... [-o <out>]
                locations-conversations-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-conversations-delete <name> [-p <v>]... [-o <out>]
                locations-conversations-get <name> [-p <v>]... [-o <out>]
                locations-conversations-ingest <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-conversations-list <parent> [-p <v>]... [-o <out>]
                locations-conversations-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-conversations-upload <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-get-settings <name> [-p <v>]... [-o <out>]
                locations-insightsdata-export <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-issue-models-calculate-issue-model-stats <issue-model> [-p <v>]... [-o <out>]
                locations-issue-models-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-issue-models-delete <name> [-p <v>]... [-o <out>]
                locations-issue-models-deploy <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-issue-models-export <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-issue-models-get <name> [-p <v>]... [-o <out>]
                locations-issue-models-import <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-issue-models-issues-delete <name> [-p <v>]... [-o <out>]
                locations-issue-models-issues-get <name> [-p <v>]... [-o <out>]
                locations-issue-models-issues-list <parent> [-p <v>]... [-o <out>]
                locations-issue-models-issues-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-issue-models-list <parent> [-p <v>]... [-o <out>]
                locations-issue-models-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-issue-models-undeploy <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-operations-cancel <name> [-p <v>]... [-o <out>]
                locations-operations-get <name> [-p <v>]... [-o <out>]
                locations-operations-list <name> [-p <v>]... [-o <out>]
                locations-phrase-matchers-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-phrase-matchers-delete <name> [-p <v>]... [-o <out>]
                locations-phrase-matchers-get <name> [-p <v>]... [-o <out>]
                locations-phrase-matchers-list <parent> [-p <v>]... [-o <out>]
                locations-phrase-matchers-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-update-settings <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-views-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-views-delete <name> [-p <v>]... [-o <out>]
                locations-views-get <name> [-p <v>]... [-o <out>]
                locations-views-list <parent> [-p <v>]... [-o <out>]
                locations-views-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
  contactcenterinsights1 --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 文件中，文件名以 contactcenterinsights1- 开头。您可以使用 --config-dir 标志根据每次调用更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时，将要求用户授权。根据 CLI 的说明授予权限或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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