surveys2 命令行界面（CLI）允许您从终端舒适地使用Google Surveys服务的多数功能。

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

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

安装和源代码

使用 cargo 安装命令行界面

cargo install google-surveys2-cli

在 GitHub上找到源代码。

用法

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

surveys2 [options]
        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>]
  surveys2 --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文件中，这些文件以surveys2-为前缀。您可以使用--config-dir标志在每个调用上更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时，系统会请求用户权限。遵循CLI给出的说明进行授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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