23个稳定版本 (4个主要版本)
5.0.4+20240228 | 2024年3月5日 |
---|---|
3.1.0+20220217 | 2022年4月26日 |
3.0.0+20220217 | 2022年3月8日 |
2.0.4+20210325 | 2021年4月15日 |
0.3.6+20160901 | 2016年9月11日 |
#2 in #game
498 个月下载量
380KB
5K SLoC
gamesmanagement1-management
命令行界面(CLI)允许您从终端舒适地使用 Google Games Management 服务的多数功能。
默认情况下,所有输出都打印到标准输出,但可以通过设置标志将其直接重定向到文件,而无需依赖您的 shell 功能。错误将打印到标准错误,并导致程序的退出代码非零。
如果请求数据结构,这些将作为格式化的 JSON 返回,以便作为其他工具的输入。
有关 Games Management API 的其他信息,请参阅官方文档网站。
安装和源代码
使用 cargo 安装命令行界面
cargo install google-gamesmanagement1_management-cli
在 GitHub 上找到源代码。
用法
本文档是从修订版 20240228 的 Games Management API 生成的。CLI 版本为 5.0.4。
gamesmanagement1-management [options]
achievements
reset <achievement-id> [-p <v>]... [-o <out>]
reset-all [-p <v>]... [-o <out>]
reset-all-for-all-players [-p <v>]...
reset-for-all-players <achievement-id> [-p <v>]...
reset-multiple-for-all-players (-r <kv>)... [-p <v>]...
applications
list-hidden <application-id> [-p <v>]... [-o <out>]
events
reset <event-id> [-p <v>]...
reset-all [-p <v>]...
reset-all-for-all-players [-p <v>]...
reset-for-all-players <event-id> [-p <v>]...
reset-multiple-for-all-players (-r <kv>)... [-p <v>]...
players
hide <application-id> <player-id> [-p <v>]...
unhide <application-id> <player-id> [-p <v>]...
scores
reset <leaderboard-id> [-p <v>]... [-o <out>]
reset-all [-p <v>]... [-o <out>]
reset-all-for-all-players [-p <v>]...
reset-for-all-players <leaderboard-id> [-p <v>]...
reset-multiple-for-all-players (-r <kv>)... [-p <v>]...
gamesmanagement1-management --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 文件中,文件名以 gamesmanagement1-management-
开头。您可以使用 --config-dir
标志在每个调用的基础上更改用于存储配置的目录。
有关各种持久数据的更多信息,请参阅以下段落。
身份验证
大多数 API 需要用户对任何请求进行身份验证。如果是这样,则 范围 确定了授予的权限集。这些权限的粒度通常不超过 只读 或 完全访问。
如果没有设置,系统将自动选择最小的可行范围,例如在调用只读方法时,它只会请求只读范围。您可以使用 --scope
标志直接指定范围。所有适用的范围都在相应方法的CLI文档中进行了说明。
首次使用范围时,用户会被要求授权。按照CLI给出的说明授权或拒绝。
如果用户验证了范围,相关的信息将以 JSON 格式存储在配置目录中,例如 ~/.google-service-cli/gamesmanagement1-management-token-<scope-hash>.json
。不需要手动管理这些令牌。
要撤销授权的认证,请参阅官方文档。
应用程序密钥
为了允许任何应用程序使用Google服务,它需要通过Google开发者控制台进行注册。应用程序可能使用的API将逐个为其启用。大多数API可以免费使用,并且有每日配额。
为了使CLI更易于使用,而无需强制用户注册自己的应用程序,CLI附带了一个默认应用程序密钥,已相应配置。这也意味着全球范围内的重用可能会耗尽每日配额。
您可以通过在此位置放置自己的密钥文件来解决这个问题: ~/.google-service-cli/gamesmanagement1-management-secret.json
,假设已为其启用了所需的 gamesManagement API。这样的密钥文件可以在 Google开发者控制台 中在 APIs & auth -> Credentials -> Download JSON 下下载,并直接使用。
有关如何设置Google项目和启用API的更多信息,请参阅官方文档。
调试
尽管CLI尽力提供可用的错误消息,但有时了解导致特定问题的确切原因可能是希望知道的事情。这是通过允许所有客户端-服务器通信以 原样 输出到标准错误来完成的。
使用 --debug
标志将打印使用 Debug
表示法的错误到标准错误。
您可以考虑将标准错误重定向到文件以方便使用,例如 gamesmanagement1-management --debug <resource> <method> [options] 2>debug.txt
。
依赖项
~20–31MB
~579K SLoC