#google #cli #standard-error #google-api #command-line-interface #json-input #analyticsadmin

app google-analyticsadmin1_alpha-cli

一个完整的库,用于与Google Analytics Admin(协议v1alpha)交互

4个稳定版本

3.1.0+20220307 2022年4月26日
3.0.0+20220307 2022年3月8日
2.0.4+20210331 2021年4月14日
2.0.0+20210331 2021年4月2日

#51 in #standard-error

Download history 20/week @ 2024-03-28 16/week @ 2024-04-04

每月58次下载

MIT 协议

1.5MB
23K SLoC

analyticsadmin1-alpha命令行界面(CLI)允许您从终端舒适地使用Google Google Analytics Admin服务的几乎所有功能。

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

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

有关Google Analytics Admin API的所有其他信息,请参阅官方文档网站

安装和源代码

使用cargo安装命令行界面

cargo install google-analyticsadmin1_alpha-cli

github上找到源代码

用法

本文档是从修订版20220307的Google Analytics Admin API生成的。CLI版本为3.1.0

analyticsadmin1-alpha [options]
        account-summaries
                list [-p <v>]... [-o <out>]
        accounts
                delete <name> [-p <v>]... [-o <out>]
                get <name> [-p <v>]... [-o <out>]
                get-data-sharing-settings <name> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                provision-account-ticket (-r <kv>)... [-p <v>]... [-o <out>]
                search-change-history-events <account> (-r <kv>)... [-p <v>]... [-o <out>]
                user-links-audit <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                user-links-batch-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                user-links-batch-delete <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                user-links-batch-get <parent> [-p <v>]... [-o <out>]
                user-links-batch-update <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                user-links-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                user-links-delete <name> [-p <v>]... [-o <out>]
                user-links-get <name> [-p <v>]... [-o <out>]
                user-links-list <parent> [-p <v>]... [-o <out>]
                user-links-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
        properties
                acknowledge-user-data-collection <property> (-r <kv>)... [-p <v>]... [-o <out>]
                conversion-events-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                conversion-events-delete <name> [-p <v>]... [-o <out>]
                conversion-events-get <name> [-p <v>]... [-o <out>]
                conversion-events-list <parent> [-p <v>]... [-o <out>]
                create (-r <kv>)... [-p <v>]... [-o <out>]
                custom-dimensions-archive <name> (-r <kv>)... [-p <v>]... [-o <out>]
                custom-dimensions-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                custom-dimensions-get <name> [-p <v>]... [-o <out>]
                custom-dimensions-list <parent> [-p <v>]... [-o <out>]
                custom-dimensions-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                custom-metrics-archive <name> (-r <kv>)... [-p <v>]... [-o <out>]
                custom-metrics-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                custom-metrics-get <name> [-p <v>]... [-o <out>]
                custom-metrics-list <parent> [-p <v>]... [-o <out>]
                custom-metrics-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                data-streams-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                data-streams-delete <name> [-p <v>]... [-o <out>]
                data-streams-get <name> [-p <v>]... [-o <out>]
                data-streams-get-global-site-tag <name> [-p <v>]... [-o <out>]
                data-streams-list <parent> [-p <v>]... [-o <out>]
                data-streams-measurement-protocol-secrets-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                data-streams-measurement-protocol-secrets-delete <name> [-p <v>]... [-o <out>]
                data-streams-measurement-protocol-secrets-get <name> [-p <v>]... [-o <out>]
                data-streams-measurement-protocol-secrets-list <parent> [-p <v>]... [-o <out>]
                data-streams-measurement-protocol-secrets-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                data-streams-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                delete <name> [-p <v>]... [-o <out>]
                display-video360-advertiser-link-proposals-approve <name> (-r <kv>)... [-p <v>]... [-o <out>]
                display-video360-advertiser-link-proposals-cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                display-video360-advertiser-link-proposals-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                display-video360-advertiser-link-proposals-delete <name> [-p <v>]... [-o <out>]
                display-video360-advertiser-link-proposals-get <name> [-p <v>]... [-o <out>]
                display-video360-advertiser-link-proposals-list <parent> [-p <v>]... [-o <out>]
                display-video360-advertiser-links-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                display-video360-advertiser-links-delete <name> [-p <v>]... [-o <out>]
                display-video360-advertiser-links-get <name> [-p <v>]... [-o <out>]
                display-video360-advertiser-links-list <parent> [-p <v>]... [-o <out>]
                display-video360-advertiser-links-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                firebase-links-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                firebase-links-delete <name> [-p <v>]... [-o <out>]
                firebase-links-list <parent> [-p <v>]... [-o <out>]
                get <name> [-p <v>]... [-o <out>]
                get-data-retention-settings <name> [-p <v>]... [-o <out>]
                get-google-signals-settings <name> [-p <v>]... [-o <out>]
                google-ads-links-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                google-ads-links-delete <name> [-p <v>]... [-o <out>]
                google-ads-links-list <parent> [-p <v>]... [-o <out>]
                google-ads-links-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                update-data-retention-settings <name> (-r <kv>)... [-p <v>]... [-o <out>]
                update-google-signals-settings <name> (-r <kv>)... [-p <v>]... [-o <out>]
                user-links-audit <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                user-links-batch-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                user-links-batch-delete <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                user-links-batch-get <parent> [-p <v>]... [-o <out>]
                user-links-batch-update <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                user-links-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                user-links-delete <name> [-p <v>]... [-o <out>]
                user-links-get <name> [-p <v>]... [-o <out>]
                user-links-list <parent> [-p <v>]... [-o <out>]
                user-links-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
  analyticsadmin1-alpha --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文件中,文件名以analyticsadmin1-alpha-开头。您可以使用--config-dir标志在每次调用中更改用于存储配置的目录。

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

身份验证

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

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

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

如果用户认证了作用域,则相应信息将作为JSON存储在配置目录中,例如:~/.google-service-cli/analyticsadmin1-alpha-token-<scope-hash>.json。不需要手动管理这些令牌。

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

应用程序密钥

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

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

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

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

调试

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

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

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

依赖项

~18–31MB
~577K SLoC