“gan1-beta1”命令行界面（CLI）允许您从终端轻松使用Google gan服务的多数功能。

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

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

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

安装和源代码

使用cargo安装命令行界面

cargo install google-gan1_beta1-cli

在GitHub上找到源代码。

用法

此文档是从修订版20130205的gan API生成的。CLI版本为3.1.0。

gan1-beta1 [options]
        advertisers
                get <role> <role-id> [-p <v>]... [-o <out>]
                list <role> <role-id> [-p <v>]... [-o <out>]
        cc-offers
                list <publisher> [-p <v>]... [-o <out>]
        events
                list <role> <role-id> [-p <v>]... [-o <out>]
        links
                get <role> <role-id> <link-id> [-p <v>]... [-o <out>]
                insert <role> <role-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <role> <role-id> [-p <v>]... [-o <out>]
        publishers
                get <role> <role-id> [-p <v>]... [-o <out>]
                list <role> <role-id> [-p <v>]... [-o <out>]
        reports
                get <role> <role-id> <report-type> [-p <v>]... [-o <out>]
  gan1-beta1 --help

Configuration:
  --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文件中，文件名以gan1-beta1-开头。您可以使用--config-dir标志在每个调用中更改用于存储配置的目录。

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

身份验证

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

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

第一次使用作用域时，系统会要求用户授权。按照CLI提供的说明授予权限或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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