Skip to content

广告主 API ​

广告主端接口前缀为 /api/advertiser。除登录 / 注册 / 找回密码外,均需在请求头携带广告主 JWT:Authorization: Bearer <token>。

响应结构、分页与错误码约定见 概述与鉴权。

认证 ​

登录 ​

POST /api/advertiser/auth/login

参数类型必填说明
usernamestring是用户名,也支持用注册邮箱登录
passwordstring是登录密码
bash
curl -X POST https://api.adbnk.co/api/advertiser/auth/login \
  -H "Content-Type: application/json" \
  -d '{"username":"demo","password":"secret123"}'
json
{
  "code": 0,
  "message": "登录成功",
  "data": {
    "token": "eyJ0eXAiOiJKV1Qi....",
    "token_type": "Bearer",
    "expires_in": 86400,
    "user": {
      "id": 12,
      "username": "demo",
      "nickname": "Demo",
      "email": "[email protected]"
    }
  },
  "timestamp": 1752200000
}

注册 ​

POST /api/advertiser/auth/register

采用渐进式 KYC,最小必填仅 email + password。注册成功直接返回可用 token。

参数类型必填说明
emailstring是有效邮箱,全局唯一
passwordstring是密码,至少 8 位
usernamestring否不填则自动派生(3-30 位字母数字下划线)
mobilestring否手机号
company_namestring否公司名称
contact_namestring否联系人
industrystring否行业名称

其他认证接口 ​

方法路径说明
POST/auth/forgot-password发送重置邮件,参数 email;请求过于频繁时返回 429
POST/auth/reset-password参数 token、new_password、confirm_password
POST/auth/logout登出(前端丢弃 token 即可)
GET/auth/profile获取当前登录广告主信息
POST/auth/password修改密码,参数 old_password、new_password、confirm_password

推广计划(Campaign) ​

列表 ​

GET /api/advertiser/campaigns

参数类型必填说明
page / page_sizeint否分页
keywordstring否按名称模糊搜索
statusstring否状态筛选
pricing_modelstring否计费模式筛选
start_date / end_datedate否创建时间范围

创建 ​

POST /api/advertiser/campaigns

前置条件

创建推广计划会进入审核流程,要求账户资料完善度达到 basic,否则返回 412。

参数类型必填说明
namestring是计划名称
ad_typestring否不传即「智能投放」(推荐):由素材决定投放到哪里。仅在要把计划限定到某一种格式时才设置(BANNER/NATIVE/VIDEO/POPUP/REWARDED/RESPONSIVE 等)
price / bidnumber是出价,bid 会兜底为 price,不可为负
pricing_modelstring否计费模式,默认 CPC;可选 CPM/CPA/CPV/CPS
typestring否计划类型,默认 PERFORMANCE
objectivestring否投放目标,默认 TRAFFIC
daily_budgetnumber否日预算,不可为负
total_budgetnumber否总预算,不可为负
start_date / end_datedate否投放起止日期,空表示不限
landing_urlstring否落地页 URL(https://)
tracker_idint否转化追踪器 ID;CPA/CPS 计费时必填
rotation_modestring否轮播模式,默认 EVEN
target_countriesarray否定向国家/地区
target_devicesarray否定向设备
target_osarray否定向操作系统
target_browsersarray否定向浏览器
target_hours / weekdaysarray否分时 / 分日定向
bid_adjustmentsobject否分维度竞价调整,见下

bid_adjustments ​

bid_adjustments 按维度对基础出价做百分比加价 / 减价。只接受 device、geo、os 三个维度,每个维度是「取值 → 百分比」的映射:

json
{
  "device": { "MOBILE": 20, "PC": -10 },
  "geo":    { "US": 15, "JP": -20 },
  "os":     { "ANDROID": -5 }
}

键在保存时统一转大写。百分比被钳制到 [-90, 500];0 与无法解析的项会被丢弃,最终为空的对象存为 null。引擎会把命中该次请求的各维度百分比相加后作用于基础出价——计算方式与边界情况见定向与竞价。

bash
curl -X POST https://api.adbnk.co/api/advertiser/campaigns \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "夏季促销",
    "pricing_model": "CPC",
    "bid": 0.35,
    "daily_budget": 200,
    "landing_url": "https://shop.example.com"
  }'

其他计划操作 ​

方法路径说明
GET/campaigns/{id}详情
PUT/campaigns/{id}更新
DELETE/campaigns/{id}删除计划及其下的广告(素材仍保留在素材库)
POST/campaigns/{id}/toggle启停
POST/campaigns/{id}/copy复制
POST/campaigns/{id}/submit-audit提交审核
POST/campaigns/batch-submit-audit批量提交审核
GET/campaigns/{id}/stats计划统计

广告与广告组 ​

广告组 /api/advertiser/adgroups、广告 /api/advertiser/ads 均提供标准 CRUD(index / show / store / update / destroy)以及 toggle、stats、submit-audit 等操作,结构与推广计划一致。

素材与素材库 ​

素材列表 ​

GET /api/advertiser/creatives

参数类型必填说明
keywordstring否名称搜索
typestring否素材类型
statusstring否状态
audit_statusstring否审核状态

创建素材 ​

POST /api/advertiser/creatives

参数类型必填说明
namestring是素材名称
creative_typestring否素材子类型,默认 image(须在允许集合内)
typestring否展示类型,默认 IMAGE
size_id / width / heightint否尺寸
image_media_idint否主图素材 ID(推荐,来自素材库)
image_media_id_2int否第二张图素材 ID
video_media_idint否视频素材 ID
icon_media_idint否图标素材 ID
html_codestring否HTML 广告代码
vast_xml / vast_urlstring否VAST 视频广告
click_urlstring否点击 URL

素材以 media_id 为准

广告主创建/更新素材时,*_url 字段不接受外部 URL,图片/视频只能通过素材库 *_media_id 引用,由服务端解析出可用 URL。

素材库接口:GET /media、POST /media/upload、POST /media/ai-image、POST /media/ai-video、POST /media/ai-copy。

上传辅助:POST /creatives/upload(图片)、POST /creatives/upload-video(视频)。

报表统计 ​

所有报表默认时间范围为最近 7 天。

方法路径说明
GET/statistics/explore灵活报表:自选指标、维度、筛选与对比(后台「数据报表」页使用的就是它)
GET/statistics/explore/meta当前账户可用的指标和维度
GET/statistics/saved-reports保存的报表配置(POST 新建,/{id} 上 PUT / DELETE 修改或删除)
GET/statistics/report汇总报表
GET/statistics/campaigns按计划维度
GET/statistics/region地域(geo)报表
GET/statistics/hourly分时报表
GET/statistics/device设备报表
GET/statistics/export导出

GET /api/advertiser/statistics/explore 参数:

参数类型必填说明
start_date / end_datedate否日期范围,默认最近 7 天
dimensionsstring否逗号分隔的行维度,最多四个,默认 date;可选值见 /statistics/explore/meta
columnsstring否逗号分隔的返回指标,默认标准指标集
filters / excludeobject否包含 / 排除指定维度取值,如 {"country":["US"]}
comparestring否previous / year / custom(配合 compare_start_date / compare_end_date),默认 none
sort / orderstring否排序的指标或维度,以及 asc / desc
exportstring否csv 或 xlsx,把当前视图下载为文件

GET /api/advertiser/statistics/report 参数:

参数类型必填说明
start_datedate否起始日期,默认 7 天前
end_datedate否结束日期,默认今天
group_bystring否分组维度,默认 date
campaign_idint否指定计划
bash
curl "https://api.adbnk.co/api/advertiser/statistics/region?start_date=2026-07-01&end_date=2026-07-10" \
  -H "Authorization: Bearer <token>"

余额与充值 ​

方法路径说明
GET/deposits/balance查询账户余额
GET/deposits充值订单列表
POST/deposits发起充值
GET/deposits/transactions资金流水
GET/deposits/{id}充值订单详情
POST/deposits/{id}/cancel取消订单

发起充值 ​

POST /api/advertiser/deposits

参数类型必填说明
amountnumber是充值金额,须大于 0 且不低于最小充值额
payment_methodstring是支付方式:BANK/USDT/ALIPAY/WECHAT/OFFLINE

前置条件

充值要求账户资料完善度达到 basic,否则返回 412。

bash
curl -X POST https://api.adbnk.co/api/advertiser/deposits \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"amount": 500, "payment_method": "USDT"}'

转化追踪器 ​

创建 / 管理转化追踪器详见 事件与转化上报 及 转化追踪指南。相关接口位于 /api/advertiser/trackers。

TIP

更多广告主功能(优化规则、响应式广告、返佣、通知绑定等)请以广告主控制台为准。

按 MIT 许可发布的文档内容。