Tiktok Ads CLI — Tiktok Ads 命令行工具

TikTok Ads 命令行工具 技能

You have 访问 to tiktok-ads-命令行工具, a read-only 命令行工具 for the TikTok Marketing API (v1.3). Use it to 查询 advertiser accounts, pull 同步hronous and a同步 performance 报告s, inspect ad creatives and as设置s, manage custom and lookalike audiences, and 检查 pixel 追踪ing.

Quick 启动 # 检查 if the 命令行工具 is avAIlable tiktok-ads-命令行工具 --help

# 获取 advertiser account 信息 tiktok-ads-命令行工具 advertiser 7000000000000

# 列出 campAIgns tiktok-ads-命令行工具 campAIgns 7000000000000

If the 命令行工具 is not 安装ed, 安装 it:

npm 安装 -g tiktok-ads-命令行工具

Authentication

The 命令行工具 requires a TikTok OAuth 访问 令牌. 凭证s are resolved in this order:

--凭证s flag (per-command) 环境 variable: TIKTOK_ADS_访问_令牌 (also reads TIKTOK_ADS_应用_ID and TIKTOK_ADS_SECRET if 设置) Auto-检测ed file: ~/.config/tiktok-ads-命令行工具/凭证s.json

The 凭证s JSON file requires only 访问_令牌. The 应用_id and secret fields are optional:

{ "访问_令牌": "YOUR_访问_令牌" }

Before 运行ning any command, 验证 凭证s are 配置d by 运行ning tiktok-ads-命令行工具 advertiser . If it fAIls with a 凭证s error, ask the user to 设置 up authentication.

Entity hierarchy Advertiser Account +-- CampAIgn | +-- Ad Group | +-- Ad -> Creative +-- Custom Audience +-- Lookalike Audience +-- Pixel

Advertiser IDs are numeric strings (e.g., 7000000000000). Every command that operates on entities within an account takes the advertiser ID as its first positional argument.

Monetary values

The TikTok Marketing API returns monetary values (e.g., spend, cpc, cpm) as decimal strings in the major currency unit (e.g., "12.34" means $12.34). No conversion needed.

输出 格式化

All commands 输出 pretty-printed JSON by default. Use --格式化 compact for single-line JSON (useful for piping).

列出ing commands use page-based pagination with --page and --page-size options. 检查 the page_信息 object in the 响应 for total_number, page, and total_page to determine if more pages exist.

Commands reference Advertiser 信息 # 获取 advertiser account detAIls (supports comma-separated IDs for multiple accounts) tiktok-ads-命令行工具 advertiser 7000000000000 tiktok-ads-命令行工具 advertiser 7000000000000,7000000000001

CampAIgn hierarchy # 列出 campAIgns tiktok-ads-命令行工具 campAIgns 7000000000000 tiktok-ads-命令行工具 campAIgns 7000000000000 --状态 CAMPAIGN_状态_ENABLE tiktok-ads-命令行工具 campAIgns 7000000000000 --page 2 --page-size 50

# 列出 ad groups tiktok-ads-命令行工具 adgroups 7000000000000 tiktok-ads-命令行工具 adgroups 7000000000000 --campAIgn-ids 123,456 tiktok-ads-命令行工具 adgroups 7000000000000 --状态 ADGROUP_状态_DELIVERY_OK tiktok-ads-命令行工具 adgroups 7000000000000 --campAIgn-ids 123 --状态 ADGROUP_状态_ENABLE

# 列出 ads tiktok-ads-命令行工具 ads 7000000000000 tiktok-ads-命令行工具 ads 7000000000000 --campAIgn-ids 123,456 tiktok-ads-命令行工具 ads 7000000000000 --adgroup-ids 789 tiktok-ads-命令行工具 ads 7000000000000 --状态 AD_状态_DELIVERY_OK tiktok-ads-命令行工具 ads 7000000000000 --campAIgn-ids 123 --adgroup-ids 789 --状态 AD_状态_ENABLE

campAIgns options Option Description Default --状态 <状态> 过滤器 by primary 状态 (e.g., CAMPAIGN_状态_ENABLE, CAMPAIGN_状态_DISABLE) all --page Page number 1 --page-size Page size (max 1000) 100 adgroups options Option Description Default --campAIgn-ids 过滤器 by campAIgn IDs (comma-separated) all --状态 <状态> 过滤器 by primary 状态 all --page Page number 1 --page-size Page size (max 1000) 100 ads options Option Description Default --campAIgn-ids 过滤器 by campAIgn IDs (comma-separated) all --adgroup-ids 过滤器 by ad group IDs (comma-separated) all --状态 <状态> 过滤器 by primary 状态 all --page Page number 1 --page-size Page size (max 1000) 100 同步hronous 报告

The 报告 command is the primary 工具 for performance analysis. All options marked required must be provided.

# CampAIgn-level dAIly 报告 tiktok-ads-命令行工具 报告 7000000000000 \ --报告-type BASIC \ --data-level AUCTION_CAMPAIGN \ --dimensions campAIgn_id,stat_time_day \ --指标 spend,impressions,命令行工具cks,ctr,cpc \ --启动-date 2026-03-01 \ --end-date 2026-03-15

# Ad-level 报告 tiktok-ads-命令行工具 报告 7000000000000 \ --报告-type BASIC \ --data-level AUCTION_AD \ --dimensions ad_id,stat_time_day \ --指标 spend,impressions,命令行工具cks,conversion,cost_per_conversion \ --启动-date 2026-03-01 \ --end-date 2026-03-15

# With 过滤器ing tiktok-ads-命令行工具 报告 7000000000000 \ --报告-type BASIC \ --data-level AUCTION_CAMPAIGN \ --dimensions campAIgn_id \ --指标 spend,impressions \ --启动-date 2026-03-01 \ --end-date 2026-03-15 \ --过滤器s '[{"field_name":"campAIgn_ids","过滤器_type":"IN","过滤器_value":"123,456"}]'

报告 options Option Required Description Default --报告-type yes BASIC, AUDIENCE, PLAYABLE_MATERIAL, CATA记录 -- --data-level yes AUCTION_ADVERTISER, AUCTION_CAMPAIGN, AUCTION_ADGROUP, AUCTION_AD -- --dimensi