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

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

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

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

安装和源代码

使用 cargo 安装命令行界面：

cargo install google-dfareporting2d6-cli

在 GitHub 上查找源代码。

用法

此文档是根据 dfareporting API 的 20170428 版本生成的。CLI 的版本为 1.0.6。

dfareporting2d6 [options]
        account-active-ad-summaries
                get <profile-id> <summary-account-id> [-p <v>]... [-o <out>]
        account-permission-groups
                get <profile-id> <id> [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
        account-permissions
                get <profile-id> <id> [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
        account-user-profiles
                get <profile-id> <id> [-p <v>]... [-o <out>]
                insert <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
                patch <profile-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
        accounts
                get <profile-id> <id> [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
                patch <profile-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
        ads
                get <profile-id> <id> [-p <v>]... [-o <out>]
                insert <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
                patch <profile-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
        advertiser-groups
                delete <profile-id> <id> [-p <v>]...
                get <profile-id> <id> [-p <v>]... [-o <out>]
                insert <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
                patch <profile-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
        advertisers
                get <profile-id> <id> [-p <v>]... [-o <out>]
                insert <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
                patch <profile-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
        browsers
                list <profile-id> [-p <v>]... [-o <out>]
        campaign-creative-associations
                insert <profile-id> <campaign-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <profile-id> <campaign-id> [-p <v>]... [-o <out>]
        campaigns
                get <profile-id> <id> [-p <v>]... [-o <out>]
                insert <profile-id> <default-landing-page-name> <default-landing-page-url> (-r <kv>)... [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
                patch <profile-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
        change-logs
                get <profile-id> <id> [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
        cities
                list <profile-id> [-p <v>]... [-o <out>]
        connection-types
                get <profile-id> <id> [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
        content-categories
                delete <profile-id> <id> [-p <v>]...
                get <profile-id> <id> [-p <v>]... [-o <out>]
                insert <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
                patch <profile-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
        conversions
                batchinsert <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
        countries
                get <profile-id> <dart-id> [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
        creative-assets
                insert <profile-id> <advertiser-id> (-r <kv>)... (-u (simple|resumable) -f <file> [-m <mime>]) [-p <v>]... [-o <out>]
        creative-field-values
                delete <profile-id> <creative-field-id> <id> [-p <v>]...
                get <profile-id> <creative-field-id> <id> [-p <v>]... [-o <out>]
                insert <profile-id> <creative-field-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <profile-id> <creative-field-id> [-p <v>]... [-o <out>]
                patch <profile-id> <creative-field-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <profile-id> <creative-field-id> (-r <kv>)... [-p <v>]... [-o <out>]
        creative-fields
                delete <profile-id> <id> [-p <v>]...
                get <profile-id> <id> [-p <v>]... [-o <out>]
                insert <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
                patch <profile-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
        creative-groups
                get <profile-id> <id> [-p <v>]... [-o <out>]
                insert <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
                patch <profile-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
        creatives
                get <profile-id> <id> [-p <v>]... [-o <out>]
                insert <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
                patch <profile-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
        dimension-values
                query <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
        directory-site-contacts
                get <profile-id> <id> [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
        directory-sites
                get <profile-id> <id> [-p <v>]... [-o <out>]
                insert <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
        dynamic-targeting-keys
                delete <profile-id> <object-id> <name> <object-type> [-p <v>]...
                insert <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
        event-tags
                delete <profile-id> <id> [-p <v>]...
                get <profile-id> <id> [-p <v>]... [-o <out>]
                insert <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
                patch <profile-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
        files
                get <report-id> <file-id> [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
        floodlight-activities
                delete <profile-id> <id> [-p <v>]...
                generatetag <profile-id> [-p <v>]... [-o <out>]
                get <profile-id> <id> [-p <v>]... [-o <out>]
                insert <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
                patch <profile-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
        floodlight-activity-groups
                get <profile-id> <id> [-p <v>]... [-o <out>]
                insert <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
                patch <profile-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
        floodlight-configurations
                get <profile-id> <id> [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
                patch <profile-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
        inventory-items
                get <profile-id> <project-id> <id> [-p <v>]... [-o <out>]
                list <profile-id> <project-id> [-p <v>]... [-o <out>]
        landing-pages
                delete <profile-id> <campaign-id> <id> [-p <v>]...
                get <profile-id> <campaign-id> <id> [-p <v>]... [-o <out>]
                insert <profile-id> <campaign-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <profile-id> <campaign-id> [-p <v>]... [-o <out>]
                patch <profile-id> <campaign-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <profile-id> <campaign-id> (-r <kv>)... [-p <v>]... [-o <out>]
        languages
                list <profile-id> [-p <v>]... [-o <out>]
        metros
                list <profile-id> [-p <v>]... [-o <out>]
        mobile-carriers
                get <profile-id> <id> [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
        operating-system-versions
                get <profile-id> <id> [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
        operating-systems
                get <profile-id> <dart-id> [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
        order-documents
                get <profile-id> <project-id> <id> [-p <v>]... [-o <out>]
                list <profile-id> <project-id> [-p <v>]... [-o <out>]
        orders
                get <profile-id> <project-id> <id> [-p <v>]... [-o <out>]
                list <profile-id> <project-id> [-p <v>]... [-o <out>]
        placement-groups
                get <profile-id> <id> [-p <v>]... [-o <out>]
                insert <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
                patch <profile-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
        placement-strategies
                delete <profile-id> <id> [-p <v>]...
                get <profile-id> <id> [-p <v>]... [-o <out>]
                insert <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
                patch <profile-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
        placements
                generatetags <profile-id> [-p <v>]... [-o <out>]
                get <profile-id> <id> [-p <v>]... [-o <out>]
                insert <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
                patch <profile-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
        platform-types
                get <profile-id> <id> [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
        postal-codes
                get <profile-id> <code> [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
        projects
                get <profile-id> <id> [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
        regions
                list <profile-id> [-p <v>]... [-o <out>]
        remarketing-list-shares
                get <profile-id> <remarketing-list-id> [-p <v>]... [-o <out>]
                patch <profile-id> <remarketing-list-id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
        remarketing-lists
                get <profile-id> <id> [-p <v>]... [-o <out>]
                insert <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <profile-id> <advertiser-id> [-p <v>]... [-o <out>]
                patch <profile-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
        reports
                compatible-fields-query <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
                delete <profile-id> <report-id> [-p <v>]...
                files-get <profile-id> <report-id> <file-id> [-p <v>]... [-o <out>]
                files-list <profile-id> <report-id> [-p <v>]... [-o <out>]
                get <profile-id> <report-id> [-p <v>]... [-o <out>]
                insert <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
                patch <profile-id> <report-id> (-r <kv>)... [-p <v>]... [-o <out>]
                run <profile-id> <report-id> [-p <v>]... [-o <out>]
                update <profile-id> <report-id> (-r <kv>)... [-p <v>]... [-o <out>]
        sites
                get <profile-id> <id> [-p <v>]... [-o <out>]
                insert <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
                patch <profile-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
        sizes
                get <profile-id> <id> [-p <v>]... [-o <out>]
                insert <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
        subaccounts
                get <profile-id> <id> [-p <v>]... [-o <out>]
                insert <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
                patch <profile-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
        targetable-remarketing-lists
                get <profile-id> <id> [-p <v>]... [-o <out>]
                list <profile-id> <advertiser-id> [-p <v>]... [-o <out>]
        targeting-templates
                get <profile-id> <id> [-p <v>]... [-o <out>]
                insert <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
                patch <profile-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
        user-profiles
                get <profile-id> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
        user-role-permission-groups
                get <profile-id> <id> [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
        user-role-permissions
                get <profile-id> <id> [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
        user-roles
                delete <profile-id> <id> [-p <v>]...
                get <profile-id> <id> [-p <v>]... [-o <out>]
                insert <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <profile-id> [-p <v>]... [-o <out>]
                patch <profile-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <profile-id> (-r <kv>)... [-p <v>]... [-o <out>]
  dfareporting2d6 --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]
  --debug
            Output all server communication to standard error. `tx` and `rx` are placed
            into the same stream.
  --debug-auth
            Output all communication related to authentication to standard error. `tx`
            and `rx` are placed into the same stream.

配置

程序将所有持久数据存储在 ~/.google-service-cli 目录中的 JSON 文件中，文件以 dfareporting2d6- 前缀开头。您可以使用 --config-dir 标志在每个调用基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时，会要求用户授权。按照 CLI 提供的说明进行授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

使用 --debug 标志将打印所有客户端-服务器通信到标准错误，而使用 --debug-auth 标志将导致所有与认证相关的通信输出到标准错误。如果设置了 --debug 标志，则错误结果将被调试打印，可能提供更多有关问题的信息。