content2-sandbox 命令行界面（CLI）允许您从终端舒适地使用Google购物内容服务的多数功能。

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

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

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

安装和源代码

使用cargo安装命令行界面

cargo install google-content2_sandbox-cli

在github上查找源代码。

用法

本文档是从修订版20181009的购物内容API生成的。CLI版本为3.1.0。

content2-sandbox [options]
        orderinvoices
                createchargeinvoice <merchant-id> <order-id> (-r <kv>)... [-p <v>]... [-o <out>]
                createrefundinvoice <merchant-id> <order-id> (-r <kv>)... [-p <v>]... [-o <out>]
        orderpayments
                notifyauthapproved <merchant-id> <order-id> (-r <kv>)... [-p <v>]... [-o <out>]
                notifyauthdeclined <merchant-id> <order-id> (-r <kv>)... [-p <v>]... [-o <out>]
                notifycharge <merchant-id> <order-id> (-r <kv>)... [-p <v>]... [-o <out>]
                notifyrefund <merchant-id> <order-id> (-r <kv>)... [-p <v>]... [-o <out>]
        orderreturns
                get <merchant-id> <return-id> [-p <v>]... [-o <out>]
                list <merchant-id> [-p <v>]... [-o <out>]
        orders
                acknowledge <merchant-id> <order-id> (-r <kv>)... [-p <v>]... [-o <out>]
                advancetestorder <merchant-id> <order-id> [-p <v>]... [-o <out>]
                cancel <merchant-id> <order-id> (-r <kv>)... [-p <v>]... [-o <out>]
                cancellineitem <merchant-id> <order-id> (-r <kv>)... [-p <v>]... [-o <out>]
                canceltestorderbycustomer <merchant-id> <order-id> (-r <kv>)... [-p <v>]... [-o <out>]
                createtestorder <merchant-id> (-r <kv>)... [-p <v>]... [-o <out>]
                createtestreturn <merchant-id> <order-id> (-r <kv>)... [-p <v>]... [-o <out>]
                custombatch (-r <kv>)... [-p <v>]... [-o <out>]
                get <merchant-id> <order-id> [-p <v>]... [-o <out>]
                getbymerchantorderid <merchant-id> <merchant-order-id> [-p <v>]... [-o <out>]
                gettestordertemplate <merchant-id> <template-name> [-p <v>]... [-o <out>]
                instorerefundlineitem <merchant-id> <order-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <merchant-id> [-p <v>]... [-o <out>]
                refund <merchant-id> <order-id> (-r <kv>)... [-p <v>]... [-o <out>]
                rejectreturnlineitem <merchant-id> <order-id> (-r <kv>)... [-p <v>]... [-o <out>]
                returnlineitem <merchant-id> <order-id> (-r <kv>)... [-p <v>]... [-o <out>]
                returnrefundlineitem <merchant-id> <order-id> (-r <kv>)... [-p <v>]... [-o <out>]
                setlineitemmetadata <merchant-id> <order-id> (-r <kv>)... [-p <v>]... [-o <out>]
                shiplineitems <merchant-id> <order-id> (-r <kv>)... [-p <v>]... [-o <out>]
                updatelineitemshippingdetails <merchant-id> <order-id> (-r <kv>)... [-p <v>]... [-o <out>]
                updatemerchantorderid <merchant-id> <order-id> (-r <kv>)... [-p <v>]... [-o <out>]
                updateshipment <merchant-id> <order-id> (-r <kv>)... [-p <v>]... [-o <out>]
  content2-sandbox --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文件的形式存储所有持久数据，文件名以content2-sandbox-开头。您可以使用--config-dir标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时，会询问用户权限。根据CLI的指示授予权限或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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