该 consumersurveys2 命令行界面 (CLI) 允许您在终端中舒适地使用 Google Consumer Surveys 服务的几乎所有功能。

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

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

安装和源代码

使用 cargo 安装命令行界面：

cargo install google-consumersurveys2-cli

在 github 上找到源代码。

用法

本文档是根据修订版 20170407 的 消费者调查 API 生成的。CLI 版本为 5.0.4。

consumersurveys2 [options]
        mobileapppanels
                get <panel-id> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                update <panel-id> (-r <kv>)... [-p <v>]... [-o <out>]
        results
                get <survey-url-id> (-r <kv>)... [-p <v>]... [-o <out>]
        surveys
                delete <survey-url-id> [-p <v>]... [-o <out>]
                get <survey-url-id> [-p <v>]... [-o <out>]
                insert (-r <kv>)... [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                start <resource-id> (-r <kv>)... [-p <v>]... [-o <out>]
                stop <resource-id> [-p <v>]... [-o <out>]
                update <survey-url-id> (-r <kv>)... [-p <v>]... [-o <out>]
  consumersurveys2 --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 目录中以 consumersurveys2- 前缀的 JSON 文件中存储所有持久数据。您可以使用 --config-dir 标志根据调用更改用于存储配置的目录。

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

身份验证

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

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

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

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

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

应用程序密钥

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

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

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

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

调试

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

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

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