流量管理API接入文档
修订历史
| 文档版本 | 修订日期 | 描述 | 修订人 |
| 1.0.0 | 2025-03-27 | 初稿 | 张令帛 |
| 1.0.1 | 2025-06-11 | 增加应用必填参数screen_ori 增加应用type可选项: 鸿蒙 |
张令帛 |
| 1.1.0 | 2025-09-08 | 增加error code 增加列表/编辑/详情接口 增加秘钥获取方式 |
张令帛 |
| 1.2.0 | 2025-10-10 | 增加开屏样式支持 增加代码位类型-新插屏 增加信息流摇一摇功能支持 删除编辑插屏竞价类型 删除插屏跳过按钮 |
张令帛 |
安全密钥secret_key
登录趣盟平台, 点击接入模块, 流量管理API文档, 点击查看秘钥获取. 或联系运营人员获取
请求域名
https://qm-openapi.aiclk.com
应用管理
新增
1.请求路由
/openapi/media/add?secret_key=xxx
2.请求方式
POST
3.请求参数
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| name | string | 是 | 应用名称,最大20个字符 | 测试应用011 |
| category_ids | string | 是 | 应用行业, 详细枚举值见后文 | 100000000,101000000 |
| type | int | 是 | 客户端类型:Android-1 iOS-3 鸿蒙-5 | 1 |
| dau | int | 是 | 应用日活 | 20000 |
| download_url | string | 否 | 下载地址 | https://test.com/path/to/download |
| comment | string | 否 | 应用简介,最大100个字符 | |
| package | string | 是 | 应用包名 | com.xxx.xxx |
| have_wx_appid | int | 是 | 是否有微信app id: 否-0 是-1 | 1 |
| wx_appid | string | 否 | 微信app id (有微信app id时必填) |
1232222s2er21 |
| screen_ori | int | 是 | 屏幕方向: 1-竖屏 2-横屏 | 1 |
4.请求示例
curl --location 'https://qm-openapi.aiclk.com/openapi/media/add?secret_key=xxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"name": "测试媒体011",
"category_ids": "100000000,101000000",
"type": 1,
"dau": 2333,
"package": "com.xxx.xxx",
"download_url": "https://test.com/path/to/download",
"comment": "简介",
"have_wx_appid": 0,
"wx_appid": "",
"screen_ori": 1
}'
5.响应示例
成功
{"code":200,"message":"成功","data":{"id":1028657401}}
失败
{
"code": 4101,
"message": "应用名称 [测试媒体011] 已经存在",
"data": []
}
编辑
1.请求路由
/openapi/media/edit?secret_key=xxx
2.请求方式
POST
审核状态(status)为通过(0)的应用无法编辑
3.请求参数
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| id | int | 是 | 目标应用ID,可从info/list接口获取 | 1028658888 |
| version | Int | 是 | 目标应用当前version,可从info/list接口获取 | 1 |
| name | string | 是 | 应用名称,最大20个字符 | 测试应用011 |
| category_ids | string | 是 | 应用行业, 详细枚举值见后文 | 100000000,101000000 |
| type | int | 是 | 客户端类型:Android-1 iOS-3 鸿蒙-5 | 1 |
| dau | int | 是 | 应用日活 | 20000 |
| download_url | string | 否 | 下载地址 | https://test.com/path/to/download |
| comment | string | 否 | 应用简介,最大100个字符 | |
| package | string | 是 | 应用包名 | com.xxx.xxx |
| have_wx_appid | int | 是 | 是否有微信app id: 否-0 是-1 | 1 |
| wx_appid | string | 否 | 微信app id (有微信app id时必填) |
1232222s2er21 |
| screen_ori | int | 是 | 屏幕方向: 1-竖屏 2-横屏 | 1 |
4.请求示例
curl --location 'https://qm-openapi.aiclk.com/openapi/media/edit?secret_key=xxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"id": 1028657433,
"version": 2,
"name": "测试媒体355",
"category_ids": "101101000,103114000,104000000",
"type": 1,
"dau": "222222",
"download_url": "https://ssssss.xxx",
"comment": "1212222222",
"package": "com.xxxxxxx355",
"have_wx_appid": 0,
"wx_appid": "",
"screen_ori": 1
}'
5.响应示例
成功
{"code":200,"message":"成功","data":{"id":1028657401}}
失败
{
"code": 5003,
"message": "数据已修改, 请刷新后重试",
"data": []
}
列表
1.请求路由
/openapi/media/list?secret_key=xxx
2.请求方式
GET
3.请求参数
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| ids | string | 否 | 应用ID,逗号分隔的准确ID | 1028657427,1028657416 |
| name | string | 否 | 应用名称, 支持模糊查询 | 测试应用011 |
| category_ids | string | 否 | 应用行业, 详细枚举值见后文 | 100000000,101000000 |
| type | int | 否 | 客户端类型:Android-1 iOS-3 鸿蒙-5 | 1 |
| status | int | 否 | 审核状态: 审核通过-0, 已下线-1, 待审核-2, 审核驳回-3 | 2 |
4.响应字段
| 字段名 | 类型 | 描述 |
|---|---|---|
| id | int | 应用id |
| version | int | 应用记录版本号 |
| name | string | 应用名称 |
| status | int | 审核状态: 审核通过-0, 已下线-1, 待审核-2, 审核驳回-3 |
| category_ids | string | 应用行业, 详细枚举值见后文 |
| category_names | string | 应用行业名称 |
| type | int | 客户端类型:Android-1 iOS-3 鸿蒙-5 |
| type_name | string | 客户端类型名称 |
| dau | int | 应用日活 |
| download_url | string | 下载地址 |
| comment | string | 应用简介 |
| package | string | 应用包名 |
| have_wx_appid | int | 应用是否有微信appid |
| wx_appid | string | 微信appid |
| screen_ori | int | 屏幕方向: 1-竖屏 2-横屏 |
5.请求示例
curl --location 'https://qm-openapi.aiclk.com/openapi/media/list?secret_key=xxxxxxxxxxxxxxx&page=1&page_size=20&ids=&name=&category_ids=&type=&status='
6.响应示例
成功
{
"code": 200,
"message": "成功",
"data": {
"page": 1,
"total": 27,
"list": [
{
"id": 1028657427,
"version": 4,
"name": "测试媒体35",
"status": 2,
"category_ids": "101101000,103114000,104000000",
"category_names": "直播,电话通讯,手机美化",
"type": 1,
"type_name": "Android",
"dau": "222222",
"download_url": "https://ssssss.xxx",
"comment": "1212222222",
"package": "com.xxxxxxx35",
"have_wx_appid": 0,
"wx_appid": "",
"screen_ori": 1
},
{
"id": 1028657416,
"version": 17,
"name": "API003",
"status": 0,
"category_ids": "100000000",
"category_names": "手机游戏",
"type": 1,
"type_name": "Android",
"dau": "112",
"download_url": "",
"comment": "",
"package": "com.2223",
"have_wx_appid": 1,
"wx_appid": "afv",
"screen_ori": 1
}
]
}
}
失败
{
"code": 5001,
"message": "请求参数校验异常: Type 无效的值",
"data": []
}
详情
1.请求路由
/openapi/media/info?secret_key=xxx
2.请求方式
GET
3.请求参数
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| id | string | 是 | 应用ID |
4.响应字段
| 字段名 | 类型 | 描述 |
|---|---|---|
| id | int | 应用id |
| version | int | 应用记录版本号 |
| name | string | 应用名称 |
| status | int | 审核状态: 审核通过-0, 已下线-1, 待审核-2, 审核驳回-3 |
| category_ids | string | 应用行业, 详细枚举值见后文 |
| category_names | string | 应用行业名称 |
| type | int | 客户端类型:Android-1 iOS-3 鸿蒙-5 |
| type_name | string | 客户端类型名称 |
| dau | int | 应用日活 |
| download_url | string | 下载地址 |
| comment | string | 应用简介 |
| package | string | 应用包名 |
| have_wx_appid | int | 应用是否有微信appid |
| wx_appid | string | 微信appid |
| screen_ori | int | 屏幕方向: 1-竖屏 2-横屏 |
5.请求示例
curl --location 'https://qm-openapi.aiclk.com/openapi/media/info?secret_key=xxxxxxxxxxxxxxx&id=1028657357'
6.响应示例
成功
{
"code": 200,
"message": "成功",
"data": {
"id": 1028657357,
"version": 11,
"name": "3213",
"status": 1,
"category_ids": "100000000",
"category_names": "手机游戏",
"type": 1,
"type_name": "Android",
"dau": "0",
"download_url": "321",
"comment": "",
"package": "3123",
"have_wx_appid": 0,
"wx_appid": "",
"screen_ori": 1
}
}
失败
{
"code": 5001,
"message": "请求参数校验异常: ID 不能为空",
"data": []
}
获取审核状态
1.请求路由
/openapi/media/get-status?secret_key=xxx
2.请求方式
GET
3.请求参数
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| ids | string | 是 | 应用ID |
4.响应字段
| 字段名 | 类型 | 描述 |
|---|---|---|
| id | int | 应用id |
| status | int | 审核状态: 审核通过-0, 已下线-1, 待审核-2, 审核驳回-3 |
5.请求示例
curl --location 'https://qm-openapi.aiclk.com/openapi/media/get-status?secret_key=xxxxxxxxxxxxxxx&ids=1028657357,1028657416'
6.响应示例
成功
{
"code": 200,
"message": "成功",
"data": [
{
"id": 1028657357,
"status": 1
},
{
"id": 1028657416,
"status": 0
}
]
}
失败
{
"code": 5001,
"message": "请求参数校验异常: Ids 不能为空",
"data": []
}
代码位管理
新增
1.请求路由
/openapi/adslot/add?secret_key=xxx
2.请求方式
POST
3.请求参数
信息流
| 字段名 | 类型 | 是否必须 | 描述 | 示例 |
|---|---|---|---|---|
| type | int | 是 | 代码位类型,枚举值见后 | 1 |
| adslot_name | string | 是 | 代码位名称 | 测试代码位 |
| media_id | int | 是 | 所属应用ID | 1000000001 |
| render_method | int | 是 | 渲染方式: 模版渲染-1 自渲染-2 | 1 |
| adslot_acc_adtype | string | 否 | 创意类型: 图文-1 大图-2 组图-3 视频-4 竖版视频-11 (自渲染必填, 可多选, 英文逗号分隔) |
1,2,3,4,11 |
| acc_adtype | int | 否 | 创意类型: 图文+视频-1 图文-2 视频-3 (模版渲染必填) |
1 |
| creative_type_id | int | 否 | 创意样式: 上文下图-1 左图右文-2 左文右图-3 (模版渲染必填) |
1 |
| video_sound | int | 否 | 视频声音: 静音-1 有声-2 (创意类型包含视频必填) |
1 |
| video_auto_play | int | 否 | 视频自动播放: 自动播放-1 wifi下自动播放-2 不自动播放-3 (创意类型包含视频必填) |
1 |
| shake_num | int | 否 | 交互样式-摇一摇: 关闭-1 左下-2 左上-3 右下-4 居中-5 (所属应用类型为Android时必填) (安卓3.474及以上版本支持) |
1 |
| bidding_type | int | 是 | 竞价类型: 客户端竞价-1 固定cpm-2 服务端竞价-3 | 1 |
| bid_cpm | float2 | 否 | cpm价格, 两位小数 (固定CPM必填) |
0.22 |
开屏
| 字段名 | 类型 | 是否必须 | 描述 | 示例 |
|---|---|---|---|---|
| type | int | 是 | 代码位类型,枚举值见后 | 2 |
| adslot_name | string | 是 | 代码位名称 | 测试代码位 |
| media_id | int | 是 | 所属应用ID | 1000000001 |
| render_method | int | 是 | 渲染方式: 模版渲染-1 自渲染-2 | 1 |
| acc_adtype | int | 否 | 创意类型: 图文-2 (模版渲染必填) |
1 |
| screen_ori | int | 是 | 屏幕方向: 竖版-1 横版-2 | 1 |
| open_screen_skip_button_num | int | 否 | 跳过按钮: 显示-1 不显示-2 (模版渲染必填) |
1 |
| shake_num | int | 否 | 交互样式: 无-1 摇一摇-2 滑一滑-3 扭一扭-4 (模版渲染必填) |
1 |
| bidding_type | int | 是 | 竞价类型: 客户端竞价-1 固定cpm-2 服务端竞价-3 | 1 |
| bid_cpm | float2 | 否 | cpm价格, 两位小数 (固定CPM必填) |
0.22 |
激励视频
| 字段名 | 类型 | 是否必须 | 描述 | 示例 |
|---|---|---|---|---|
| type | int | 是 | 代码位类型,枚举值见后 | 3 |
| adslot_name | string | 是 | 代码位名称 | 测试代码位 |
| media_id | int | 是 | 所属应用ID | 1000000001 |
| render_method | int | 是 | 渲染方式: 模版渲染-1 | 1 |
| acc_adtype | int | 是 | 创意类型: 激励视频-3 | 3 |
| screen_ori | int | 是 | 屏幕方向: 竖版-1 横版-2 | 1 |
| insert_screen_skip_button | int | 是 | 跳过按钮: 整数秒数, 最大60 | 5 |
| bidding_type | int | 是 | 竞价类型: 客户端竞价-1 固定cpm-2 服务端竞价-3 | 1 |
| bid_cpm | float2 | 否 | cpm价格, 两位小数 (固定CPM必填) |
0.22 |
插屏
| 字段名 | 类型 | 是否必须 | 描述 | 示例 |
|---|---|---|---|---|
| type | int | 是 | 代码位类型,枚举值见后 | 4 |
| adslot_name | string | 是 | 代码位名称 | 测试代码位 |
| media_id | int | 是 | 所属应用ID | 1000000001 |
| render_method | int | 是 | 渲染方式: 模版渲染-1 | 1 |
| screen_ori | int | 是 | 屏幕方向: 竖版-1 横版-2 | 1 |
| video_sound | int | 是 | 视频声音: 静音-1 有声-2 | 1 |
| bidding_type | int | 是 | 竞价类型: 客户端竞价-1 固定cpm-2 服务端竞价-3 | 1 |
| bid_cpm | float2 | 否 | cpm价格, 两位小数 (固定CPM必填) |
0.22 |
悬浮icon
| 字段名 | 类型 | 是否必须 | 描述 | 示例 |
|---|---|---|---|---|
| type | int | 是 | 代码位类型,枚举值见后 | 5 |
| adslot_name | string | 是 | 代码位名称 | 测试代码位 |
| media_id | int | 是 | 所属应用ID | 1000000001 |
| render_method | int | 是 | 渲染方式: 模版渲染-1 | 1 |
| bidding_type | int | 是 | 竞价类型: 客户端竞价-1 固定cpm-2 服务端竞价-3 | 1 |
| bid_cpm | float2 | 否 | cpm价格, 两位小数 (固定CPM必填) |
0.22 |
新插屏
| 字段名 | 类型 | 是否必须 | 描述 | 示例 |
|---|---|---|---|---|
| type | int | 是 | 代码位类型,枚举值见后 仅支持安卓应用创建 |
7 |
| adslot_name | string | 是 | 代码位名称 | 测试代码位 |
| media_id | int | 是 | 所属应用ID | 1000000001 |
| render_method | int | 是 | 渲染方式: 模版渲染-1 | 1 |
| screen_ori | int | 是 | 屏幕方向: 竖版-1 | 1 |
| video_sound | int | 是 | 视频声音: 静音-1 有声-2 | 1 |
| creative_type_id | int | 是 | 创意样式: 全屏插屏-1 1:1插屏-2 9:16插屏-3 | 2 |
| bidding_type | int | 是 | 竞价类型: 客户端竞价-1 固定cpm-2 服务端竞价-3 | 1 |
| bid_cpm | float2 | 否 | cpm价格, 两位小数 (固定CPM必填) |
0.22 |
4.请求示例
curl --location 'https://qm-openapi.aiclk.com/openapi/adslot/add?secret_key=xxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"media_id": 1028657394,
"render_method": 1,
"acc_adtype": 1,
"bidding_type": 1,
"video_sound": 1,
"video_auto_play": 2,
"adslot_name": "测试测试01222",
"creative_type_id": 1,
"bid_cpm": "222",
"type": 1
}'
5.响应示例
成功
{"code":200,"message":"成功","data":{"id":1028659300}}
失败
{
"code": 5001,
"message": "请求参数校验异常: Type 无效的值",
"data": []
}
编辑
1.请求路由
/openapi/adslot/edit?secret_key=xxx
2.请求方式
POST
3.请求参数
信息流
| 字段名 | 类型 | 是否必须 | 描述 | 示例 |
|---|---|---|---|---|
| id | int | 是 | 代码位ID | 1028659345 |
| adslot_name | string | 是 | 代码位名称 | 测试代码位 |
| adslot_acc_adtype | string | 否 | 创意类型: 图文-1 大图-2 组图-3 视频-4 竖版视频-11 (自渲染必填, 可多选, 英文逗号分隔) |
1,2,3,4,11 |
| acc_adtype | int | 否 | 创意类型: 图文+视频-1 图文-2 视频-3 (模版渲染必填) |
1 |
| creative_type_id | int | 否 | 创意样式: 上文下图-1 左图右文-2 左文右图-3 (模版渲染必填) |
1 |
| video_sound | int | 否 | 视频声音: 静音-1 有声-2 (创意类型包含视频必填) |
1 |
| video_auto_play | int | 否 | 视频自动播放: 自动播放-1 wifi下自动播放-2 不自动播放-3 (创意类型包含视频必填) |
1 |
开屏
| 字段名 | 类型 | 是否必须 | 描述 | 示例 |
|---|---|---|---|---|
| id | int | 是 | 代码位ID | 1028659345 |
| adslot_name | string | 是 | 代码位名称 | 测试代码位 |
| open_screen_skip_button_num | int | 否 | 跳过按钮: 显示-1 不显示-2 (模版渲染必填) |
1 |
| shake_num | int | 否 | 交互样式: 无-1 摇一摇-2 滑一滑-3 扭一扭-4 (模版渲染必填) |
1 |
激励视频
| 字段名 | 类型 | 是否必须 | 描述 | 示例 |
|---|---|---|---|---|
| id | int | 是 | 代码位ID | 1028659345 |
| adslot_name | string | 是 | 代码位名称 | 测试代码位 |
| screen_ori | int | 是 | 屏幕方向: 竖版-1 横版-2 | 1 |
| insert_screen_skip_button | int | 是 | 跳过按钮: 整数秒数, 最大60 | 5 |
插屏
| 字段名 | 类型 | 是否必须 | 描述 | 示例 |
|---|---|---|---|---|
| id | int | 是 | 代码位ID | 1028659345 |
| adslot_name | string | 是 | 代码位名称 | 测试代码位 |
| screen_ori | int | 是 | 屏幕方向: 竖版-1 横版-2 | 1 |
| video_sound | int | 是 | 视频声音: 静音-1 有声-2 | 1 |
悬浮icon
| 字段名 | 类型 | 是否必须 | 描述 | 示例 |
|---|---|---|---|---|
| id | int | 是 | 代码位ID | 1028659345 |
| adslot_name | string | 是 | 代码位名称 | 测试代码位 |
新插屏
| 字段名 | 类型 | 是否必须 | 描述 | 示例 |
|---|---|---|---|---|
| id | int | 是 | 代码位ID | 1028659345 |
| adslot_name | string | 是 | 代码位名称 | 测试代码位 |
| video_sound | int | 是 | 视频声音: 静音-1 有声-2 | 1 |
4.请求示例
curl --location 'https://qm-openapi.aiclk.com/openapi/adslot/edit?secret_key=xxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"id": 1028659352,
"adslot_name": "1232123",
"acc_adtype": 2,
"creative_type_id": 2,
"video_sound": 2,
"video_auto_play": 3
}'
5.响应示例
成功
{"code":200,"message":"成功","data":{"id":1028659300}}
失败
{
"code": 5001,
"message": "请求参数校验异常: 模版渲染中创意类型[acc_adtype]必填.",
"data": []
}
列表
1.请求路由
/openapi/adslot/list?secret_key=xxx
2.请求方式
GET
3.请求参数
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| ids | string | 否 | 代码位ID,逗号分隔的准确ID | 1028659345 |
| name | string | 否 | 代码位名称, 支持模糊查询 | 测试应用011 |
| audit | string | 否 | 审核状态 :待审核-0, 通过-1, 未通过-2 | 1 |
| type | int | 否 | 代码位类型,枚举值见后 | 1 |
| bidding_type | int | 否 | 竞价类型: 客户端竞价-1 固定cpm-2 服务端竞价-3 | 1 |
4.响应字段
| 字段名 | 类型 | 描述 |
|---|---|---|
| id | int | 代码位id |
| type | int | 代码位类型,枚举值见后 |
| audit | int | 审核状态 :待审核-0, 通过-1, 未通过-2 |
| media_id | int | 所属应用ID |
| media_name | string | 所属应用名称 |
| adslot_name | string | 代码位名称 |
| render_method | int | 渲染方式: 模版渲染-1 自渲染-2 |
| acc_adtype | int | 创意类型: 图文+视频-1 图文-2 视频-3 |
| adslot_acc_adtype | string | 创意类型: 图文-1 大图-2 组图-3 视频-4 竖版视频-11 |
| video_sound | int | 视频声音: 静音-1 有声-2 |
| video_auto_play | int | 视频自动播放: 自动播放-1 wifi下自动播放-2 不自动播放-3 |
| creative_type_id | int | 创意样式: 信息流(type=1): 上文下图-1 左图右文-2 左文右图-3 新插屏(type=7): 全屏插屏-1 1:1插屏-2 9:16插屏-3 |
| shake_num | int | 交互样式: 信息流(type=1): 关闭-1 左下-2 左上-3 右下-4 居中-5 开屏(type=2): 无-1 摇一摇-2 滑一滑-3 扭一扭-4 |
| open_screen_skip_button_num | int | 跳过按钮: 显示-1 不显示-2 |
| insert_screen_skip_button | int | 跳过按钮: 整数秒数, 最大60 |
| screen_ori | int | 屏幕方向: 竖版-1 横版-2 |
| bidding_type | int | 竞价类型: 客户端竞价-1 固定cpm-2 服务端竞价-3 |
| bid_cpm | float | cpm价格, 两位小数 |
5.请求示例
curl --location 'https://qm-openapi.aiclk.com/openapi/adslot/list?secret_key=xxxxxxxxxxxxxxx&ids=&name=&audit=&type=&bidding_type='
6.响应示例
成功
{
"code": 200,
"message": "成功",
"data": {
"page": 1,
"total": 87,
"list": [
{
"id": 1028659353,
"audit": 0,
"adslot_acc_adtype": "1,2,3,4",
"media_id": 1028657373,
"media_name": "我是测试是测试",
"adslot_name": "测试测试413",
"type": 1,
"acc_adtype": 0,
"render_method": 2,
"video_sound": 1,
"video_auto_play": 2,
"creative_type_id": 0,
"shake_num": 1,
"open_screen_skip_button_num": 1,
"insert_screen_skip_button": 0,
"screen_ori": 0,
"bidding_type": 3,
"bid_cpm": 0
},
{
"id": 1028659352,
"audit": 0,
"adslot_acc_adtype": "1,2,3",
"media_id": 1028657416,
"media_name": "API003",
"adslot_name": "1232123",
"type": 1,
"acc_adtype": 2,
"render_method": 1,
"video_sound": 0,
"video_auto_play": 0,
"creative_type_id": 2,
"shake_num": 1,
"open_screen_skip_button_num": 1,
"insert_screen_skip_button": 0,
"screen_ori": 0,
"bidding_type": 1,
"bid_cpm": 0
}
]
}
}
失败
{
"code": 4011,
"message": "安全密钥secret_key参数缺失",
"data": []
}
详情
1.请求路由
/openapi/adslot/info?secret_key=xxx
2.请求方式
GET
3.请求参数
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| id | string | 是 | 应用ID |
4.响应字段
| 字段名 | 类型 | 描述 |
|---|---|---|
| id | int | 代码位id |
| type | int | 代码位类型,枚举值见后 |
| audit | int | 审核状态 :待审核-0, 通过-1, 未通过-2 |
| media_id | int | 所属应用ID |
| media_name | string | 所属应用名称 |
| adslot_name | string | 代码位名称 |
| render_method | int | 渲染方式: 模版渲染-1 自渲染-2 |
| acc_adtype | int | 创意类型: 图文+视频-1 图文-2 视频-3 |
| adslot_acc_adtype | string | 创意类型: 图文-1 大图-2 组图-3 视频-4 竖版视频-11 |
| video_sound | int | 视频声音: 静音-1 有声-2 |
| video_auto_play | int | 视频自动播放: 自动播放-1 wifi下自动播放-2 不自动播放-3 |
| creative_type_id | int | 创意样式: 信息流(type=1): 上文下图-1 左图右文-2 左文右图-3 新插屏(type=7): 全屏插屏-1 1:1插屏-2 9:16插屏-3 |
| shake_num | int | 交互样式: 信息流(type=1): 关闭-1 左下-2 左上-3 右下-4 居中-5 开屏(type=2): 无-1 摇一摇-2 滑一滑-3 扭一扭-4 |
| open_screen_skip_button_num | int | 跳过按钮: 显示-1 不显示-2 |
| insert_screen_skip_button | int | 跳过按钮: 整数秒数, 最大60 |
| screen_ori | int | 屏幕方向: 竖版-1 横版-2 |
| bidding_type | int | 竞价类型: 客户端竞价-1 固定cpm-2 服务端竞价-3 |
| bid_cpm | float | cpm价格, 两位小数 |
5.请求示例
curl --location 'https://qm-openapi.aiclk.com/openapi/adslot/info?secret_key=xxxxxxxxxxxxxxx&id=1028659351'
6.响应示例
成功
{
"code": 200,
"message": "成功",
"data": {
"id": 1028659351,
"audit": 2,
"adslot_acc_adtype": "2,4,8,11",
"media_id": 1028657416,
"media_name": "API003",
"adslot_name": "API测试001_插屏2",
"type": 4,
"acc_adtype": 0,
"render_method": 1,
"video_sound": 1,
"video_auto_play": 2,
"creative_type_id": 0,
"shake_num": 1,
"open_screen_skip_button_num": 1,
"insert_screen_skip_button": 11,
"screen_ori": 2,
"bidding_type": 2,
"bid_cpm": 20
}
}
失败
{
"code": 5001,
"message": "请求参数校验异常: ID 不能为空",
"data": []
}
获取审核状态
1.请求路由
/openapi/adslot/get-status?secret_key=xxx
2.请求方式
GET
3.请求参数
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| ids | string | 是 | 应用ID |
4.响应字段
| 字段名 | 类型 | 描述 |
|---|---|---|
| id | int | 代码位id |
| audit | int | 审核状态 :待审核-0, 通过-1, 未通过-2 |
5.请求示例
curl --location 'https://qm-openapi.aiclk.com/openapi/adslot/get-status?secret_key=xxxxxxxxxxxxxxx&ids=1028659351,1028659350,1028659349'
6.响应示例
成功
{
"code": 200,
"message": "成功",
"data": [
{
"id": 1028659349,
"audit": 0
},
{
"id": 1028659350,
"audit": 2
},
{
"id": 1028659351,
"audit": 2
}
]
}
失败
{
"code": 5001,
"message": "请求参数校验异常: Ids 不能为空",
"data": []
}
参考
枚举值
type
| 值 | 描述 |
|---|---|
| 1 | 信息流 |
| 2 | 开屏 |
| 3 | 激励视频 |
| 4 | 插屏 |
| 5 | 悬浮icon |
| 7 | 新插屏 |
category_id
| id | level | parent | name |
|---|---|---|---|
| 100000000 | 1 | 0 | 手机游戏 |
| 101000000 | 1 | 0 | 影音播放 |
| 101100000 | 2 | 101000000 | 视频 |
| 101101000 | 2 | 101000000 | 直播 |
| 101102000 | 2 | 101000000 | 音乐 |
| 101103000 | 2 | 101000000 | K歌 |
| 101104000 | 2 | 101000000 | 铃声收音机 |
| 102000000 | 1 | 0 | 系统工具 |
| 102105000 | 2 | 102000000 | WiFi |
| 102106000 | 2 | 102000000 | 浏览器 |
| 102107000 | 2 | 102000000 | 输入法 |
| 102108000 | 2 | 102000000 | 优化省电 |
| 102109000 | 2 | 102000000 | 安全 |
| 102110000 | 2 | 102000000 | Root |
| 102111000 | 2 | 102000000 | 文件管理 |
| 103000000 | 1 | 0 | 通讯社交 |
| 103112000 | 2 | 103000000 | 聊天 |
| 103113000 | 2 | 103000000 | 交友 |
| 103114000 | 2 | 103000000 | 电话通讯 |
| 103115000 | 2 | 103000000 | 私密婚恋 |
| 103116000 | 2 | 103000000 | 社区 |
| 104000000 | 1 | 0 | 手机美化 |
| 104117000 | 2 | 104000000 | 桌面 |
| 104118000 | 2 | 104000000 | 壁纸 |
| 104119000 | 2 | 104000000 | 主题 |
| 104120000 | 2 | 104000000 | 锁屏 |
| 104121000 | 2 | 104000000 | 字体桌面部件 |
| 104122000 | 2 | 104000000 | 动态壁纸 |
| 105000000 | 1 | 0 | 新闻阅读 |
| 105123000 | 2 | 105000000 | 小说 |
| 105124000 | 2 | 105000000 | 新闻资讯 |
| 105125000 | 2 | 105000000 | 电子书 |
| 105126000 | 2 | 105000000 | 漫画听书 |
| 105127000 | 2 | 105000000 | 搞笑 |
| 106000000 | 1 | 0 | 摄影图像 |
| 106128000 | 2 | 106000000 | 美化 |
| 106129000 | 2 | 106000000 | 相机 |
| 106130000 | 2 | 106000000 | 搞怪 |
| 106131000 | 2 | 106000000 | 图像编辑短视频 |
| 106132000 | 2 | 106000000 | 相册 |
| 107000000 | 1 | 0 | 考试学习 |
| 107133000 | 2 | 107000000 | 学习 |
| 107134000 | 2 | 107000000 | 英语 |
| 107135000 | 2 | 107000000 | 背单词 |
| 107136000 | 2 | 107000000 | 考试 |
| 107137000 | 2 | 107000000 | 翻译驾考 |
| 108000000 | 1 | 0 | 网上购物 |
| 108138000 | 2 | 108000000 | 商城 |
| 108139000 | 2 | 108000000 | 团购 |
| 108140000 | 2 | 108000000 | 优惠 |
| 108141000 | 2 | 108000000 | 快递全球导购 |
| 109000000 | 1 | 0 | 金融理财 |
| 109142000 | 2 | 109000000 | 支付 |
| 109143000 | 2 | 109000000 | 炒股 |
| 109144000 | 2 | 109000000 | 银行 |
| 109145000 | 2 | 109000000 | 理财记账彩票 |
| 109146000 | 2 | 109000000 | 借贷 |
| 109147000 | 2 | 109000000 | 投资 |
| 109148000 | 2 | 109000000 | 保险 |
| 110000000 | 1 | 0 | 生活休闲 |
| 110149000 | 2 | 110000000 | 小工具 |
| 110150000 | 2 | 110000000 | 电影票 |
| 110151000 | 2 | 110000000 | 美食 |
| 110152000 | 2 | 110000000 | 娱乐上门服务 |
| 110153000 | 2 | 110000000 | 汽车 |
| 110154000 | 2 | 110000000 | 房产家居 |
| 110155000 | 2 | 110000000 | 求职 |
| 111000000 | 1 | 0 | 旅游出行 |
| 111156000 | 2 | 111000000 | 地图导航 |
| 111157000 | 2 | 111000000 | 购票 |
| 111158000 | 2 | 111000000 | 公交地铁用车租车 |
| 111159000 | 2 | 111000000 | 住宿 |
| 111160000 | 2 | 111000000 | 旅行攻略 |
| 112000000 | 1 | 0 | 健康运动 |
| 112161000 | 2 | 112000000 | 减肥健身 |
| 112162000 | 2 | 112000000 | 医疗 |
| 112163000 | 2 | 112000000 | 养生 |
| 112164000 | 2 | 112000000 | 怀孕经期 |
| 113000000 | 1 | 0 | 办公商务 |
| 113165000 | 2 | 113000000 | 办公软件 |
| 113166000 | 2 | 113000000 | 云盘存储 |
| 113167000 | 2 | 113000000 | 效率办公笔记 |
| 113168000 | 2 | 113000000 | 邮箱 |
| 114000000 | 1 | 0 | 育儿亲子 |
| 114169000 | 2 | 114000000 | 玩游戏 |
| 114170000 | 2 | 114000000 | 育儿 |
| 114171000 | 2 | 114000000 | 讲故事 |
| 114172000 | 2 | 114000000 | 唱儿歌早教 |
| 114173000 | 2 | 114000000 | 小儿百科 |
错误码
| code | Message | 排查原因 |
|---|---|---|
| 102 | 系统错误,请稍后重试 | 服务端处理请求时发生未知错误,请联系相关对接人员排查 |
| 5001 | 请求参数校验异常 | 检查请求参数格式 |
| 5002 | 系统内部异常 | 服务端处理请求时发生未知错误,请稍后重试 |
| 5003 | 数据已修改, 请刷新后重试 | 编辑时版本号过期, 核对记录版本号version |
| 5004 | id为 [xxx] 的记录不存在 | ID不存在,请核对ID字段 |
| 4011 | 安全密钥secret_key参数缺失 | 请检查请求参数并补充有效的安全密钥 |
| 4012 | 安全密钥secret_key无效 | 请确认安全密钥的准确性和有效性 |
| 4013 | 请求频率超限 | 当前请求频次超过系统限制(10),请降低调用频率 |
| 4014 | 每日请求额度超限 | 已达到当日最大请求限额(500),请合理控制调用频次 |
| 4101 | 应用名称 [xxx] 已经存在 | 修改应用名称 |
| 4102 | 应用名称中不能包含 - 字符 | 修改应用名称 |
| 4103 | 包名 [xxx] 在系统中已存在,无法创建该应用。 | 检查包名 |
| 4105 | 行业ID [xxx] 不存在 | 不是有效的行业ID |
| 4106 | 应用审核已通过, 无法编辑 | 应用通过审核后, 无法编辑 |
| 4107 | 请求应用ID数量超限 | 请求应用ID数量过大, 减少后重试(200) |
| 4201 | 所属应用 [xxx] 不存在 | 无有效的应用ID |
| 4202 | 所属应用状态未审核通过 | 代码位所属应用状态必须为审核通过 |
| 4203 | 代码位名称已存在,请修改代码位名称后重试 | 修改代码位名称 |
| 4207 | 请求代码位ID数量超限 | 请求代码位ID数量过大, 减少后重试(200) |