TradPlus CLI 使用说明
修订历史
| 发布时间 | 修订说明 |
|---|---|
| 2026-05-22 | 新增 §5.1/§8 命令参数速查、写操作参数表、典型工作流;明确 flags/--args 传参规范 |
| (更早) | 安装、鉴权、输出格式与功能列表 |
1. 简介
TradPlus CLI 是面向 TradPlus OpenAPI 的命令行工具,命令名为 tp。它适合在终端、脚本、CI 或服务器环境中完成配置查询、报表导出、巡检和少量配置修改。
CLI 的特点:
- 可在 Shell 脚本、定时任务、CI 中使用。
- 支持
json、jsonl、csv、table等输出格式。 - 写操作默认不会直接执行,需要显式添加
--yes。 - 复杂参数可通过
--args传入 JSON 对象。
2. 安装
推荐使用安装脚本。脚本会自动识别操作系统和 CPU 架构,下载对应的 tp 二进制包并安装。
| 系统 | CPU 架构 | 安装命令 |
|---|---|---|
| macOS / Linux | amd64 / arm64 | install-tp.sh |
| Windows | amd64 / arm64 | install-tp.ps1 |
2.1 macOS / Linux
复制并执行:
curl -fsSL "https://mcp.tradplusad.com/cli/tp/install-tp.sh?version=latest" | bash
如果只想确认会下载哪个版本,不实际安装:
curl -fsSL "https://mcp.tradplusad.com/cli/tp/install-tp.sh?version=latest" | bash -s -- --dry-run
2.2 Windows PowerShell
复制并执行:
iwr "https://mcp.tradplusad.com/cli/tp/install-tp.ps1?version=latest" -UseB | iex
如遇执行策略限制,可先下载安装脚本,再用下面方式执行:
powershell -ExecutionPolicy Bypass -File .\install-tp.ps1
2.3 安装后验证
tp version
tp --help
如果提示 tp: command not found,说明安装目录不在 PATH 中。请根据安装脚本输出,把安装目录加入当前 shell 或系统环境变量。
3. 配置凭证
CLI 调用 OpenAPI 时需要 API Key 和密钥。可在 TradPlus 后台“我的账号”中获取。
| 名称 | CLI 字段 | 说明 |
|---|---|---|
| API Key | bear | 标识用户身份 |
| 密钥 | secret | 用于请求签名 |
| API 地址 | base_url | 推荐 https://api-developer.tradplusad.com |
3.1 写入本地配置
推荐把凭证写入本地配置,后续命令就不需要重复输入 。将 <your bear> 和 <your secret> 替换为自己的 API Key 和密钥:
tp config set --bear "<your bear>" --secret "<your secret>" --base-url "https://api-developer.tradplusad.com"
查看本地配置:
tp config get
配置文件默认保存到:
~/.tradplus/config.yaml
3.2 使用环境变量
适合脚本、CI、容器等不希望写入本地配置文件的场景。
export TRADPLUS_BEAR="<your bear>"
export TRADPLUS_SECRET="<your secret>"
export TRADPLUS_BASE_URL="https://api-developer.tradplusad.com"
其中 TRADPLUS_BASE_URL 建议使用 https://api-developer.tradplusad.com。环境变量只在当前终端会话中生效,新的终端窗口需要重新设置,或写入自己的 shell 配置文件。
3.3 使用命令行参数
也可以在单次命令中直接传入:
tp app list --bear "<your bear>" --secret "<your secret>"
通常无需在单次命令中设置 API 地址。如需显式指定,建议值为 https://api-developer.tradplusad.com:
tp app list --bear "<your bear>" --secret "<your secret>" --base-url "https://api-developer.tradplusad.com"
鉴权优先级从高到低为:
- 命令行参数:
--bear、--secret、--base-url - 环境变量:
TRADPLUS_BEAR、TRADPLUS_SECRET、TRADPLUS_BASE_URL - 本地配置文件:
~/.tradplus/config.yaml
4. 快速开始
安装并配置完成后,建议先执行:
tp version
tp auth summarize
tp app list --format table
确认某个应用或广告位是否在当前账号权限范围内:
tp auth scope --app-uuid "<app_uuid>"
tp auth scope --adseat-uuid "<adseat_uuid>"
查看某个命令的参数:
tp app list --help
tp placement upsert --help
tp report v4 --help
5. 输出格式与通用参数
常用全局参数:
| 参数 | 说明 |
|---|---|
--format compact | 简洁文本,适合人工查看 |
--format table | 表格输出,适合终端查看 |
--format json | JSON 输出,适合脚本处理 |
--format jsonl | 一行一个 JSON,适合流式处理 |
--format csv | CSV 输出,适合导入 Excel 或数据工具 |
--fields | 逗号分隔字段名,用于控制列表输出字段 |
--args | JSON 对象字符串,用于传入复杂参数 |
--yes | 确认执行写操作 |
--print-request | 写操作执行前打印最终请求参数,便于核对 |
示例:
tp app list --format table
tp app list --format json
tp app list --format csv --fields app_uuid,app_name,platform
tp adseat list --app-uuid "<app_uuid>" --format table --fields adseat_uuid,seat_name,ad_type
部分参数需要数字类型,例如 ad_type、os、adsource_id、api_token_id 等。使用 --args 传 JSON 时,应传数字而不是字符串:
tp platform list --args '{"ad_type":4,"os":1}'
不要写成:
tp platform list --args '{"ad_type":"4","os":"1"}'
5.1 参数传递规范(必读)
tp 不支持 在命令末尾用 参数名 参数值 的 positional 方式传参。下列写法均无效:
# ❌ 错误:currency 不会被识别
tp placement list currency USD
# ❌ 错误:key value 顺序写法无效
tp adseat list app_uuid abc123
应使用 --flag 或 --args JSON:
# ✅ 使用子命令 flags
tp placement list --currency USD
tp adseat list --app-uuid "abc123"
# ✅ 使用 --args(字段名与 OpenAPI / MCP 工具一致,snake_case)
tp placement list --args '{"currency":"USD","adseat_uuids":"<uuid>","is_on":-1}'
| 传递方式 | 字段命名 | 适用场景 |
|---|---|---|
| 子命令 flags | kebab-case,如 --adseat-uuid、--app-uuids | 常用筛选;见各命令 --help |
--args JSON | snake_case,如 adseat_uuids、start_date | 子命令未暴露的字段、写操作复杂 body |
| 全局 flags | --format、--fields、--yes 等 | 输出格式与写确认 |
合并规则:子命令先把 flags 写入参数 map,再合并 --args;同名字段以 --args 为准。
发现参数的三条路径(人工与 AI 均适用):
tp <