营销平台

 营销平台3.0 Omni API V7.3接口文档
公告栏 查看历史版本

营销平台3.0 Omni API

公共部分

【重要】对接必读

修订记录

日期 修订版本 修改描述
2021-6-22 v0.1 创建文档
2021-7-06 v0.2 更新素材上传接口地址，完善通用说明部分
2021-7-15 v1.0 增加《典型场景举例部分》
2021-7-20 v1.1 1.增加计划、广告组、创意等部分请求参数demo示例
2.计划详情、计划列表、广告组详情、广告组列表、广告创意详情、广告创意列表接口增加updateTime和insertTime返回
3.广告组创建、编辑接口参数deepOcpcType、flowScene、ocpcOptmType、ocpcType字段描述修改
4.广告计划 分页查询接口 返回item中参数，删除 adId、 adName 、adGroupId、adGroupIdName 、 adServingType 字段
5.增加附录-》规格部分
6.增加搜索关键词相关的查询行业类目接口
2021-08-10 v1.2 1.添加定向修改年龄的枚举值
2.数据接口问题记录添加说明
3.去除/v3/plan/get /v3/group/get接口里的数据字段，请使用专门的数据接口查询
4./v3/plan/page /v3/group/page /v3/ad/page接口
（1）增加对limit正确范围描述，增加needStats查询参数：needStats=0不查询数据字段，默认不查询。
（2）金额字段的单位全部统一成分，具体字段包括：
convertActivePrice
convertAppCreditPrice
convertAppCustomPrice
convertAppOrderPrice
convertAppPayPrice
convertDpPrice
convertRegisterPrice
convertRetentionPrice
cost
dayBudget
dpAppCreditPrice
dpAppOrderPrice
dpAppPayPrice
dpConvertActivationPrice
dpConvertRegisterPrice
dpUdConvertPrice
formCntPrice
quickAppPayPrice
price
ocpcPrice
deepOcpcPrice
followMaxPrice
5.计划管理相关接口
（1）page接口去除部分无用字段，增加日预算单位，cost单位
（2）批量接口增加planIds示例
6.广告组管理相关接口
（1）广告组添加接口，增加关键词出价单位，删除delelteFlage、dynamicPrice、targetROI、smartExpandBreakthrouth字段
（2）广告组编辑接口，增加关键词出价单位，删除delelteFlage、dynamicPrice、targetROI、smartExpandBreakthrouth字段，返回数据中minPrice、maxPrice增加单位，modifyType增加枚举
（3）page接口，adsGroupIds参数增加举例，删除adServingType字段，asc默认值，orderByColumn字段枚举，planIds字段示例，showStatusSet枚举
（4）delete接口，status接口，batchSchedule接口，batchTarget接口，price接口，ocpcPrice接口，deepOcpcPrice接口，增加groupIds参数示例
（5）去除接口返回ocpcState字段
7.广告创意管理相关接口
（1）删除批量复制广告创意接口
2021-08-11 v1.3 1. /v3/data/common/query/queryGameOffLineData接口添加1-9分成付费流水（10per_total_pay）和5-5分成付费流水字段（50per_total_pay）
2. /v3/creative/material/communal/upload接口更新说明文档，明确了参数matSpecId、picType支持的取值和两种素材上传方式的差异3. /v2/communal/owner/setAccDayBudget接口添加budgetType=0用来表示设置日预算为不限
2021-08-13 v1.4 1. 添加对各数据接口groupByColumn字段，多次调用返回的数据不一致的说明
2. /v3/data/common/query/queryGameRTData
2021-08-16 v1.5 删除v2/communal/agency/customer/list接口返回的rebateDayBudget字段，此字段实际上未返回
billingType 计费方式.1:CPD 2:CPC 5:OCPX，删除其他废弃选项
2021-08-25 v1.6 1. 修复queryKwData接口timeLevel说明
2. 添加queryAdData groupByColumn字段的示例
2021-08-30 v1.7 1. /v3/data/common/query/queryKwData接口，groupbyColumn移除owner_id，global_spec_id字段
2. /v3/data/common/query/queryGameRTData groupByColumn可传入的字段修改
3. API应答返回Header里增加request-id返回
2021-09-06 v1.8 1. 新增代理商消耗查询接口 ：/v3/data/common/agency/query/queryOwnerCost
2. 新增代理商效果查询接口 ：/v3/data/common/agency/query/queryAgencyEffect
2021-09-16 v1.9 1. /v2/communal/material/pageList接口增加描述
2. /v3/communal/interval/config/groupPrice 新增 extensionType 标的物类型参数
2021-09-17 v2.0 1.【数据】各数据接口添加exra字段说明。
2.【数据】各数据接口添加总量接口说明。
3. 修改/v3/group/get接口的showStatus的含义，改成和/v3/group/page的showStatus一致。
4. 在下列接口新增（如果当前不存在的话）showStatusName对应showStatus的中文解释，subShowStatusName对应status的中文解释。当前的返回字段不变。
涉及的接口：
v3/plan/page
v3/group/page
v3/ad/page
v3/plan/get
v3/group/get
v3/ad/get
2021-10-13 v2.1 1.  定向类型type新增枚举 ：6-电话包11-OAID。
2.  数据接口单位由元改为分。
2021-11-01 v2.2 1.  提供关键词相关接口
2.  广告组 /v3/group/get、v3/group/edit 接口添加快应用打开并加桌参数
2021-11-30 v2.3 1. 新增上传素材到素材库接口 /v3/creative/material/communal/uploadDepot
2. 转化类型 25-deepLink出传留存, 26-系统新增激活, 27-快应用加桌
3. 配置接口增加规格创意数量限制的type说明
4.添加代理商小游戏接口/v3/data/common/agency/query/queryAgentQuickGame5.修正素材查询接口/v3/creative/material/communal/query文档：pageNum、pageSize参数无上限限制，type参数不传时默认查询全部类型素材
5.美化备注部分的demo格式
2021-12-22 v2.4 1. 素材统一查询接口 /v3/creative/material/communal/query 新增按更新时间查询参数startUpdateTime、endUpdateTime
2. 新增，编辑广告创意增加开启动态衍生开关 dynamicCr ，1-开启 0-关闭  开启后不允许关闭
2022-3-13 v2.5 1.接入SDK请求方法以及传参明细
2.补全部分接口字段备注
3.新增SDK请求示例和SDK接入范围
4. 创意批量管理v3/ad/batch接口新增互动素材id字段
5.查询规格列表/v3/communal/spec/list接口增加互动素材相关内容，并对required、format及v3/ad/batch接口参数的关系做了说明
6. /v3/data/common/summary/queryGameRTData接口修改filter_zero参数的说明
7.更新【公共部分】SDK使用文档
8.添加子客户消耗查询接口
2022-3-29 v2.6 1.更新SDK使用说明
2.广告报表更新
子客户广告报表新增：回传次留率、快应用关键行为量、快应用关键行为成本、表单转化率、表单关键行为量、表单关键行为成本、有效咨询量、有效咨询成本、微信关注量、微信关注成本、网页购买量、网页购买成本、拨打电话量、拨打电话成本、快应用加桌量、快应用加桌成本、deeplink回传留存量、deeplink回传留存成本等18个字段；
子客户小游戏报表新增：总付费流水等7个游戏内购相关字段；
代理商小游戏报表新增：总付费流水等15个游戏内购相关字段
3.更新地域编码对照表：增加区县编码
2022-05-06 v2.7 1【推广】广告创意管理：增加衍生视频映射接口，用于查询广告当前是否是衍生广告以及源广告等信息
2【数据】新增广告明细实时数据查询-子客户：queryAdRTExtData接口
3 子客户游戏明细数据、子客户&代理商小游戏数据添加留存率相关字段
4 数据相关接口更新timeLevel字段说明：广告明细数据总量查询-子客户、广告明细数据查询-子客户、游戏明细数据总量查询-子客户、游戏明细数据查询-子客户、关键词明细数据总量查询-子客户、关键词明细数据查询-子客户、代理商消耗数据总量查询、代理商消耗数据查询、代理商效果数据总量查询、代理商效果数据查询去掉MONTH、WEEK两个时间粒度查询
5 游戏实时明细数据查询-子客户，游戏实时汇总数据查询-子客户接口增加：新增付费金额，游戏付费ROI1字段
2022-06-14 v2.8 1.【数据】代理商小游戏接口修改active_nums描述
2.【数据】代理商/子客户消耗报表新增流量场景筛选条件
3.【SDK】更新
① SDK使用说明更新
② 修改SDK依赖包版本号
③ 修复SDK线上环境域名错误问题
④ 修复H5模板查询接口地址错误问题
4. 增加转化目标类型、深度转化目标类型枚举值
5. 删除定向创建、更新接口的mobilePrice字段
2022-08-05 v2.9 1. 新增8.10接口，获取当前登录客户信息，代理商和子客户通用，在代理商进入子客户时同时返回代理商和子客户信息
2. 定向列表添加showStatus字段
3. 计划、广告组、广告层级，推广类型增加小程序推广
4. 广告组推广列表接口，增加小程序类型、小程序ID、小程序Path字段返回
5. 广告组新增、编辑接口增加关键词、词包 转化出价 深度转化出价 目标ROI系数 字段，涉及接口：/v3/group/add、/v3/group/edit
6. 关键词绑定广告组等接口增加关键词、词包 转化出价 深度转化出价 目标ROI系数 字段，涉及接口：/v3/communal/searchKeyWord/addGroupKw、/v3/communal/searchKeyWord/editGroupKw
7. 广告组新增、编辑接口，添加渠道包ID字段，涉及接口：/v3/group/add、/v3/group/edit
8. 新增渠道包列表查询接口（4.12）：/v3/channelPkg/list
9. 广告组新增、编辑接口，传参增加免一阶字段defaultSecondStage，以及单个广告组详情的查询接口，返回增加免一阶字段defaultSecondStage
2022-09-09 v3.0 1. 增加资质相关接口（16.1-16.5）客户可以通过接口方式上传行业资质提供审核。
2. 增加人群包/定向包创建操作指引流程（13.1），定向相关接口重新编号；客户可查看该文档熟悉定向包/人群包创建流程。
3.广告报表、推广列表新增转化指标：注册-应用付费率
2022-10-21 v3.1 1. 新增代理商余额查询接口 ：/v3/data/common/agency/query/queryMktAggData 备注：v2代理商余额查询接口的计算方式，是通过子客户累加算出来的，如果子客户太多接口有超时的风险，所以新增一个新的代理商余额查询接口
2. 新增广告组，添加绑定自定义词包或禁推词包参数：kwPackageId和kwPackageType参数，接口：/v3/group/add，/v3/group/edit
3. 新建或编辑广告组，网页推广-搜索 关键词或词包信息必填，接口：/v3/group/add，/v3/group/edit
2022-11-2 v3.2 1. 新增用户资质查询接口/v3/communal/owner/customer/qualification/info，解决外部用户获取不到cdn url访问问题。
2. 增加三级行业code以及名称返回/v3/communal/owner/customer/qualification/get3. 获取行业证书列表接口/v3/communal/qualification/elements变更 由 传递 firstIndustryCode，secondIndustryCode改为 secondIndustryCode，thirdIndustryCode 同时thirdIndustryCode 将在/v3/communal/qualification/industry接口一并返回
4. 新增编辑接口增加三级行业code以及名称为必填 获取方式如上描述
2022-11-25 v3.3 1、广告组新增ocpcType类型，新增流量场景：13-展示优选
2022-11-30 v3.4 1、广告报表新增字段：预约量，取消预约量，预约下载量
2、子客户游戏数据报表新增字段：买量广告收入、广告变现活跃ROI、游戏关键行为量、游戏关键行为成本、付费次数、每次付费成本
3、子客户小游戏数据报表新增字段：快应用关键行为量、快应用关键行为成本
4、添加批量开启免一阶接口
2023-01-13 v3.5 1、新增程序化广告新建、编辑、查询接口
2023-01-17 v3.6 1、所有报表的流量场景字段新增两个枚举值：12联盟不限、13展示优选
2、所有报表的推广目标字段新增两个枚举值：7微信小程序推广、8直播推广
2023-03-07 v3.7 1、广告组新增和编辑接口添加目标ROI系数字段
2023-04-23 v3.8 1、广告组新增、编辑接口添加商品广告相关字段，/v3/group/add、/v3/group/edit
2、查询广告组详情接口添加商品广告相关字段返回，/v3/group/get
3、新增接口：操作商品广告创意、查询商品广告创意接口，/v3/ad/dpa_strategy/save、/v3/ad/dpa_strategy/get
4、计划新增接口添加竞价策略相关字段，/v3/plan/add
5、广告组编辑，出价设置相关接口增加出价字段限制说明/v3/group/add，/v3/group/price，/v3/group/ocpcPrice，/v3/group/deepOcpcPrice，
/v3/group/edit6、添加广告组支持的转化类型和深度转化类型
2023-08-03 v3.9 1、商品广告新增创意新增接口/v3/ad/dpa_strategy/add，废弃/v3/ad/dpa_strategy/save 接口
2023-08-08 v4.0 1、增加商品广告详情接口 /v3/ad/dpa_strategy/detail 支持广告组id或者细化到广告层id查询
2、增加 /v3/ad/dpa_strategy/add 接口注释~~~~
2023-08-16 v4.1 1、增加新的接口 /v3/ad/dpa_strategy/edit   编辑商品广告创意（新）
2023-08-21 v4.2 1、/v3/ad/dpa_strategy/add接口补充遗漏参数 曝光检测链接 exposeUrl 点击检测链接 clickUrl
2023-08-22 v4.3 1、广告报表新增字段：
         roi14  广告变现ROI14（分成后）
         ltv14  广告变现LTV14（分成后）
         cate_name  一级行业名称
         sub_cate_name  二级行业名称
         third_cate_name  三级行业名称
2023-09-08 v4.4 1、增加18. 商品库接口分类
2、在商品库分类下增加商品批量入库接口 /dpa/v2/product/batchSave
3、在商品库分类下增加xml导入商品格式规范
2023-09-12 v4.5 1、商品库批量接口、xml文件在sDPA直投模式时，品牌名称及品牌logo为必填
2023-09-15 v4.6 1、广告报表（子客户）、效果数据（代理商）新增字段：
         quick_app_act_rate    快应用关键行为转化率
2、游戏报表-游戏数据（代理商）新增字段：
         buy_user_income_active   买量广告收入
2023-09-19 v4.7 新增5.12 sdpa广告投放全流程指引文档；投放sdpa广告前需关注该文档。
2023-09-25 v4.8 1、接口信息更正：/v3/ad/dpa_strategy/detail接口方法为GET方法
2、商品批量入库接口：/dpa/v2/product/batchSave，商品库ID字段为必填
2023-10-11 v4.9 1、获取单个广告创意详情接口：/v3/ad/get，添加showStatus枚举含义说明，showStatus=4为程序化广告待优选
2023-10-17 v5.0 修正13.2新增定向接口SDK接入说明
2023-10-19 v5.1 1、动态商品创意【模板模式】下支持多种规格，对omni api接入使用（5.9 新增商品广告创意）和（5.11 编辑商品广告创意）两个接口创建和编辑【模板模式】下的多规格场景做了备注说明
2023-10-27 v5.1 定向：imei文件上传SDK接口描述修改
2023-11-01 v5.2 1、添加商品库相关接口：18.3 商品批量删除接口、18.4 商品库商品查询接口
2023-11-15 v5.3 1、添加查询Rta动态出价相关数据接口：6.22 查询Rta动态出价数据
2023-11-24 v5.4 1、添加商品库授权、商品库取消授权、查询商品库授权列表三个接口，详情见18.5、18.6、18.7
2023-11-28 v5.5 1、6.10接口游戏明细数据查询-子客户接口返回新增cash_cost（现金消耗 单位：分）
2023-12-05 v5.6 1、新增6.23 opush明细数据查询，6.24 opush汇总数据查询
2023-12-11 v5.7 1、新增6.25 dpa商品id粒度明细数据查询，6.26 dpa商品id粒度汇总数据查询
2023-12-13 v5.8 1、添加批量修改广告监测链接的接口，详情见5.13
2024-01-08 v5.9 1、新增6.27 rta外部实验id明细数据查询
2、添加广告分页查询接口数据字段返回
2024-01-10 v6.0 1、新增/v3/ad/page、/v3/group/page、/v3/plan/page部分返回字段，三个接口返回的数据字段统一添加在 公共部分 -> 对接必读的1.9节
2、新增/v2/communal/agency/customer/list部分返回字段
2024-01-10 v6.1 1、新增获取定向区域元数据接口，详情见13.13
2024-01-11 v6.2 1、新增获取定向省市元数据接口，详情见13.14
2024-01-16 v6.3 1、计划、广告组层级推广目标新增extensionType=6（应用调起），详情见 3.【推广】计划管理、4.【推广】广告组管理
2、广告组层级流量场景新增flowScene=14（通知栏），广告组相关接口新增pushAppPageType（应用内页）参数，对deepUrl在通知栏流量场景下的传值做了说明，详情见 4.【推广】广告组管理
3、广告层级新增短文本规格，该规格下新增广告内容content字段，详情见 5.5
4、广告层级新增通知栏预览推送接口，详情见 5.14
2024-02-01 v6.4 1、广告组层级增加OCPX自动优化相关参数：ocpxOptimizeSwitch、ocpxOptimizeType
2024-02-20 v6.5 1、在商品批量入库接口和XML导入商品对接文档的视频传参中添加size（视频大小）参数，详情见 18.1、18.2
2024-02-29 v6.6 1、广告组落地页类型移除波文建站（达尔文建站），详情见 4.1、4.2、4.3、12.1、附录
2、广告组ocpcType新增【快应用变现ROI1】类型，详情见 4.1
2024-03-06 v6.7 1、修改账务接口返回字段名称描述（含义保持不变），返回账户改为返货账务，详情见6.21、8.1、8.5、8.7
2024-03-13 v6.8 1、批量商品入库接口新增普通商品库的商品字段（小说和短剧行业），详情见18.1
2024-03-28 v6.9 1. 小游戏明细数据查询-代理商新增活跃ROI，详情见 6.182.小游戏明细数据查询-子客户新增活跃ROI，详情见 6.5
2024-04-03 v7.0 1、删除部分老旧OcpcType
2024-04-08 v7.1 1、新增4.0节，用于描述部分广告组接口通用字段，详情见：广告组管理 -> 4.0广告组接口基础字段说明
2、广告组接口、创意接口新增对网络消息流量场景的投放支持，详情见：4.1、4.2、5.5
3、通知栏下创意的中图规格复用横板大图globalSpecId的，详情见：5.5
2024-04-08 v7.2 1.、接口请求入参flowSceneList，新增14通知栏、15网络消息，详情见：6.1、6.2、6.3、6.4、6.6、6.7、6.8、6.11、6.12、6.13、6.14、6.15、6.16、6.17、6.18、6.19、6.202、接口请求出参flow_scene，新增14通知栏、15网络消息，详情见：6.1、6.2、6.3、6.4、6.6、6.7、6.8、6.11、6.12、6.13、6.14、6.15、6.16、6.17、6.18、6.19、6.20
2024-04-25 v7.3 1.接口请求入参新增globalSpecIdList，创意规格id集合，详情见：6.1、6.2、6.32.接口请求入参新增subAccList，子账户列表集合，详情见:6.23、6.24

1 通用声明

1.1 权限认证

所有接口均通过请求头（HEADER）中传递TOKEN（授权令牌）来进行身份认证和鉴权，系统会在校验TOKEN有效、接口调用配额充足、接口调用频次未超限3个条件符合后应答此次请求。
I.生成TOKEN（授权令牌）

token=base64(owner_id+“,”+api_id+“,”+time_stamp+“,”+sign)
所有内容使用半角逗号（,）按顺序拼接起来，再经过Base64编码。
owner_id：用户帐号id,为营销平台的广告主ID；
api_id：API授权接入方唯一身份标识；
api_key：开通API授权后获得的私钥，在开通授权邮件中会与app_id一块提供；
time_stamp：发起请求时的时间戳，精确到秒，这个值跟接收到请求时的服务器时间戳值偏差（正或负）超过1200秒（20分钟）时，请求会被拒绝，要求调用方重新生成token（请使用UTC+08:00中国北京时间）；
sign：签名字符串，sign=sha1(api_id+api_key+time_stamp)，采用sha1加密算法生成签名串（此处加号+代表字符串拼接，不是指要包含加号+），time_stamp为上面使用的时间戳；

java代码示例

public static void main(String[] a) {
    int timestamp = unixTime();
    long ownerId = 1000001622;
    String apiId = "64";
    String apiKey = "8aa8696140aa412bb188e157fa4afd37";
    System.out.println(generateToken(apiId, apiKey, ownerId, timestamp));
}

private static String generateToken(String apiId, String apiKey, long ownerId, int timestamp) {

String sign = Hashing.sha1().hashString(apiId + apiKey + timestamp, Charset.defaultCharset()).toString();

String token = BaseEncoding.base64().encode((ownerId + "," + apiId + "," + timestamp + "," + sign).getBytes());

return token;

}


public static int unixTime() {

BigDecimal num = new BigDecimal(System.currentTimeMillis() / 1000L);

return num.intValue();

}

II.配额和频次控制

系统对每个API授权有配额（单个接口每天可以调用的总次数，接收请求后即计算次数，无论是否成功处理）限制和频次（单个接口每分钟调用的次数，接收请求后即计算次数，无论是否成功处理）限制。当您申请开通API授权时，我们会根据您帐号的累计投入、日均消费、帐号规模等因素综合评估，设定具体限制额度和频次。您可在授权开通后找运营接口人了解具体额度和频次限制。

1.2 编码方式

若无特殊说明或应答头中的Content-Type未指定编码，请求和应答均使用UTF-8（无BOM头）。

1.3 URL定义

测试环境域名：https://sapi-ads-test.wanyol.com
线上环境域名：https://sapi.ads.heytapmobi.com/

1.4 API请求

HTTPMethod
调用方应根据具体接口的要求设置HTTPMethod为GET或POST。
HTTPHeader
调用方应遵循HTTP协议设置相应的Header，目前支持的Header为Content-Type，用于指定数据格式。若接口中没有特殊说明，本文档中所有接口调用时的Content-Type应为application/x-www-form-urlencoded。
【数据相关】分类接口HTTPHeader示例

Content-Type:application/json
Authorization:Bearer TOKEN_VALUE

其他接口HTTPHeader示例

Content-Type:application/x-www-form-urlencoded
Authorization:Bearer TOKEN_VALUE

1.5 API应答

HTTP状态码
支持HTTP标准状态码，具体如下：

状态码 名称 描述
200 成功 当API请求被正确处理，且能按设计获取结果时返回该状态请求被正确处理，且能按设计获取结果时返回该状态码。
3XX 跳转 在特定情况下，API可能会返回这些状态码，建议调用方按照HTTP标准来处理。
4XX 客户端错误 由客户端原因造成的错误。
5XX 服务器端错误 API或其下层服务发生内部错误。

其中，4xx和5xx的状态码仅用于辅助调用方快速识别问题，不作为包含实际语义的返回码，若有调整也不另行通知，实际操作结果以API返回的数据为准。调用方也应能够识别和处理由于网络异常等因素导致的，由非API服务返回的HTTP状态码，如504GatewayTimeout
HTTPHeader
应答会根据接口要求设置Content-Type。本文档中Content-Type均设置为application/json。
每次请求会生成唯一的request-id，会设置在返回Header里，方便排查问题，例如：request-id: 505b73cdde2442f5a95316ea13d6ba65
HTTPBody
应答的JSON数据中包含三部分内容，分别为返回码、返回信息和数据，如下表所示：

名称 类型 是否必填 限制 描述
code int 是 等于0表示成功，不等于0表示错误，具体见附录【返回码定义】 返回码
msg String 否 code不等于0时，message为错误信息 错误信息
data Object 否 具体返回内容见各接口定义 资源数据

1.6 代理商访问子客户接口

所有通过代理商来访问子客户接口的形式，都需要在请求参数中传递子客户ownerId，用于指定操作/查询某个子客户的数据。
I.传参方式【重点关注】
传递方式和其他接口参数一样，如果是application/x-www-form-urlencoded形式接口，直接放到body参数，如果是application/json接口直接放到json外层。《【数据】数据相关》的接口传参为application/json格式，其他基本还是保持和2.0一样为application/x-www-form-urlencoded形式。
II.涉及接口【重点关注】
除代理商接口外所有接口均需要传递子客户ownerId，下面是代理商接口。

路径 说明
/v2/communal/agency/** 代理商操作接口

1.7 3.0相对2.0接口变化

如对接方式，域名、认证方式、公共错误码，返回值code-msg结构等均无变化。

计划、广告组、广告全部接口均有变化（地址+参数）,全部为新增接口。

 广告，游戏，关键词全部接口均有变化（地址+参数），全部为新增接口

没有变化

有变化

本次新增接口

本次新增接口，新增定向属性

对接方式，公共错误码，返回值结构等均无变化

本次新增接口

没有变化

1.8 计划、广告组、广告列表接口返回值状态说明

status: 2, — db对应真实的状态值（详细状态）
statusName: "余额不足",   — 其他隐藏的状态，气泡查看（详细状态描述）
showStatus: 3, — 前端展示状态（可无需关注）
showStatusName: "计划暂停",   — 列表上展示出来的状态，直观概括（前端展示状态描述）
status2: 0  — 投放开关，0-开启，1-关闭

1.9 计划、广告组、广告列表接口返回数据字段说明

涉及接口：

字段名 字段含义描述
cost 消耗金额，元为单位
expose 曝光量
click 点击量
clickPrice 点击成本
clickRate 点击率
download 下载量
downloadPrice 下载成本
downloadRate 下载率
ecpm ecpm，元为单位
formCnt 表单提交量
formCntPrice 表单提交成本，元为单位
formPriceRate 表单转化率
convertActive 回传激活量
convertActivePrice 回传激活成本，元为单位
convertRegister 注册量
convertRegisterPrice 注册成本，元为单位
convertRetention 回传留存
convertRetentionPrice 回传留存成本，元为单位
convertAppCredit 应用内授信
convertAppCreditPrice 应用内授信成本，元为单位
convertAppOrder 应用内下单
convertAppOrderPrice 应用内下单成本，元为单位
convertAppPay 应用内付费
convertAppPayPrice 应用内付费成本，元为单位
convertAppCustom 应用内自定义转化
convertAppCustomPrice 应用内自定义转化成本，元为单位
convertDp 回传拉活
convertDpPrice 回传拉活成本，元为单位
convertDpRate deeplink回传拉活转化率
dpConvertActivationNums deeplink回传激活量
dpConvertActivationPrice deeplink回传激活成本
dpConvertRegisterNums deeplink回传注册量
dpConvertRegisterPrice deeplink回传注册成本
dpAppPayNums deeplink应用付费量
dpAppPayPrice deeplink应用付费成本
dpUdConvertNums deeplink自定义转化量
dpUdConvertPrice deeplink自定义转化成本
dpAppCreditNums deeplink应用内授信量
dpAppCreditPrice deeplink应用内授信成本
dpAppOrderNums deeplink应用内下单量
dpAppOrderPrice deeplink应用内下单成本
dpAppOrderRate deeplink应用内下单转化率
quickAppPay 快应用付费
quickAppPayPrice 快应用付费成本
dpConvertRetentionNums deeplink回传存留量
dpConvertRetentionPrice deeplink回传存留成本
qappQuickLnkNums 快应用加桌量
qappQuickLnkPrice 快应用加桌成本
quickAppActNum 快应用关键行为量
quickAppActCost 快应用关键行为成本
convertRetentionRate 回传次留率
formKeyActNums 表单关键行为量
formKeyActPrice 表单关键行为成本
effectConsultNums 有效咨询量
effectConsultPrice 有效咨询成本
wechatFocusNums 微信关注量
wechatFocusPrice 微信关注成本
webPageBuyNums 网页购买量
webPageBuyPrice 网页购买成本
callUpNums 拨打电话量
callUpPrice 拨打电话成本
gameAppActNums 游戏关键行为量
gameAppActPrice 游戏关键行为成本
dpConvertRetentionRate （DP拉活）回传留存率
wechatGameRegister 微信小游戏注册量
wechatGameRegisterPrice 微信小游戏注册成本
wechatGamePay 微信小游戏付费量
wechatGamePayPrice 微信小游戏付费成本
payNums 付费次数
payPerPrice 每次付费成本
convertRetention3 第3日留存
convertRetention4 第4日留存
convertRetention5 第5日留存
convertRetention6 第6日留存
convertRetention7 第7日留存
wechatGamePayCost 微信小游戏付费总额
firstPayNum 微信小游戏首次付费人数
wechatGameRoi1 微信小游戏ROI1
convertRetention3Rate 第3日留存率
convertRetention4Rate 第4日留存率
convertRetention5Rate 第5日留存率
convertRetention6Rate 第6日留存率
convertRetention7Rate 第7日留存率
lt7 LT7总留存
lt7Rate LI7总留存率
registerAppPayRate 注册-应用付费率
bookNums 预约量
cancelBookNums 取消预约量
bookDownloadNums 预约下载量
convertLongRetentionNums 长留自定义转化量
convertLongRetentionPrice 长留自定义转化成本
convertPerPayNums 每次付费转化量
convertPerPayPrice 每次付费成本
roi14 roi14
ltv14 ltv14
quickAppActRate 快应用关键行为转化率
convertPayCost 付费金额
appRoi 应用ROI

2.0流量类型映射到3.0流量场景关系表

| 新版流量划分 | 旧版流量划分 |

推广目的 extensionType 推广流量 extensionFlow 流量场景 flowScene 业务 广告渠道 chnid 样式 showtype
应用 2 全流量 1 全流量 1 - - - - -
链接 1 全流量 1 全流量 1 - - - - -
快应用 3 全流量 1 全流量 1 - - - - -
应用 2 自有流量 2 精选推荐 2 分发广告 商店 1 软件商店 128
应用 2 自有流量 2 安装有礼 3 分发广告 商店 1 软件商店 128
应用 2 自有流量 2 开机必备 4 分发广告 商店 1 软件商店 128
应用 2 自有流量 2 搜索 5 搜索广告 商店 1 搜索推广 32
链接 1 自有流量 2 搜索 5 搜索广告 非商店 2 搜索卡片 512
快应用 3 自有流量 2 搜索 5 搜索广告 非商店 2 搜索卡片 512
应用 2 自有流量 2 信息流 6 信息流广告 非商店 2 信息流 16
链接 1 自有流量 2 信息流 6 信息流广告 非商店 2 信息流 16
快应用 3 自有流量 2 信息流 6 信息流广告 非商店 2 信息流 16
应用 2 联盟流量 3 banner 7 联盟广告 联盟 3 banner 1
应用 2 联盟流量 3 开屏 8 联盟广告 联盟 3 开屏 4
应用 2 联盟流量 3 插屏 9 联盟广告 联盟 3 插屏 2
应用 2 联盟流量 3 原生 10 联盟广告 联盟 3 原生 8
应用 2 联盟流量 3 激励视频 11 联盟广告 联盟 3 激励视频 64
应用 2 联盟流量 3 联盟通投 12 联盟广告 联盟 3 不限 1024
链接 1 联盟流量 3 banner 7 联盟广告 联盟 3 banner 1
链接 1 联盟流量 3 开屏 8 联盟广告 联盟 3 开屏 4
链接 1 联盟流量 3 插屏 9 联盟广告 联盟 3 插屏 2
链接 1 联盟流量 3 原生 10 联盟广告 联盟 3 原生 8
链接 1 联盟流量 3 激励视频 11 联盟广告 联盟 3 激励视频 64
快应用 3 联盟流量 3 banner 7 联盟广告 联盟 3 banner 1
快应用 3 联盟流量 3 开屏 8 联盟广告 联盟 3 开屏 4
快应用 3 联盟流量 3 插屏 9 联盟广告 联盟 3 插屏 2
快应用 3 联盟流量 3 原生 10 联盟广告 联盟 3 原生 8
快应用 3 联盟流量 3 激励视频 11 联盟广告 联盟 3 激励视频 64
快应用 3 联盟流量 3 联盟通投 12 联盟广告 联盟 3 不限 1024

SDK使用说明

概述

广告服务 SDK 提供了Token获取、请求封装、响应解释等功能，以本地化方式轻松完成API的调用和结果的获取，旨在帮助开发者快速搭建投放管理系统。 未来还会基于常用的广告投放场景，提供场景化的接口组合及调用封装。

如何安装运行

<dependency>
    <groupId>com.heytap.ads.omni</groupId>
    <artifactId>omni-api-sdk</artifactId>
    <version>1.0.2</version>
    <description>OPPO Omni API SDK</description>
</dependency>

如何使用

SDK数组参数调用的方法名与API接口一一对应，如v3/ad/get接口就对应OmniAds.getInstance().ads().v3AdGet()方法。

使用SDK-DEMO示例(根据配置类型获取配置项示例)


/**
 * 根据配置类型获取配置项
 */
public class V3CommunalConfigGetList {
    //定义omniAds
    public OmniAds omniAds;
    //注意：owner_id是Long类型，传入的参数结尾要加“L”
    private final static Long OWNER_ID = 分配到的owner_id;
    //API授权接入方唯一身份标识；
    private final static String API_ID = 分配的apiId;
    //开通API授权后获得的私钥，在开通授权邮件中会与app_id一块提供；
    private final static String API_KEY = 分配的apiKey;
    //重要提示：返回类型暂定ResultDto<Object>，该返回类型由omniAds.adsCommunal().v3CommunalConfigGetList(data)决定，调用该方法后获取返回类型再进行修改
    public ResultDto<Object> getConfigList() throws Exception {
        OmniAds omniAds = new OmniAds(OWNER_ID, API_ID, API_KEY);
        // 默认使用沙箱环境(测试环境)
        omniAds.useSandbox();
        //线上环境
        //omniAds.useProduction();
        // debug==true 会打印请求详细信息
        omniAds.setDebug(true);
        //传递参数分为4种情况：
        //1.传递对象参数---接口备注详情里标注了需要实例化的传参对象，通过data.setxxx 设置必要参数, 详情见文档
         （例）  AdsConfigReq data = new AdsConfigReq();
                data.setType("EXTENSION_TYPE");
        //2.map动态传递参数---文档里未标注实例化的传参对象则用map传递，通过map.put()设置必要参数，详情见文档
         （例）  Map<String,Object> map = new HashMap();
                map.put("type","EXTENSION_TYPE");
        //3.字段传参，详情见文档
         （例） String type = "EXTENSION_TYPE";
        //4.不传参
        //访问接口，每个功能点对应不同的集群，接口备注详情里都有标注
        ResultDto<Object> res = omniAds.adsCommunal().v3CommunalConfigGetList(data);
        return res;
    }
    public static void main(String[] args) {
        try {
            //实例化调用类
            V3CommunalConfigGetList entity = new V3CommunalConfigGetList();
            //重要提示：类型暂定ResultDto<Object>，该返回类型由omniAds.adsCommunal().v3CommunalConfigGetList(data)决定，调用该方法后获取返回类型再进行修改
            ResultDto<Object> response = entity.getConfigList();
            //response.getData();获取响应data数据
        } catch (OmniAdsResponseException e) {
            e.printStackTrace();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

1. 公告

1.1 营销平台3.0数据接口金额单位统一的公告

兼容性考虑

为了减少对广告主的影响，元改分上线后，我们会在网关层增加一个过滤器，把这次涉及到的字段单位改回元。意思就是使用API的广告主不会感知到这个变化。等广告主自己的系统完成升级后，可以在API统一添加HTTP头：

x-uniform-currency-unit: true

使用这个HTTP头之后，会禁用网关层的过滤器，下面的金额字段单位会直接使用分。

影响面

1. 对于数据请求参数里有costCeiling和costFloor字段的，其单位原来是元，现在改为分。

2. 下列接口中被列举的字段单位原来是元，现在改为分。

元改分具体接口
推广列表接口
1. /v3/plan/page2. /v3/group/page3. /v3/ad/page字段：convertActivePrice、convertAppCreditPrice、convertAppCustomPrice、convertAppOrderPrice、convertAppPayPrice、convertDpPrice、convertRegisterPrice、convertRetentionPrice、cost、dayBudget、dpAppCreditPrice、dpAppOrderPrice、dpAppPayPrice、dpConvertActivationPrice、dpConvertRegisterPrice、dpUdConvertPrice、formCntPrice、quickAppPayPrice、price、ocpcPrice、deepOcpcPrice、followMaxPrice
 
代理商消耗数据报表相关接口：
1. /v3/data/common/agency/query/queryOwnerCost
2. /v3/data/common/agency/summary/queryOwnerCost
字段：cost
 
代理商效果数据报表相关接口：
1. /v3/data/common/agency/query/queryAgencyEffect
2. /v3/data/common/agency/summary/queryAgencyEffect
字段：cost、download_price、click_price
 
广告数据报表相关接口：
1. /v3/data/common/query/queryAdData
2. /v3/data/common/summary/queryAdData
字段：cost、download_price、form_price、click_price、convert_active_price、convert_register_price、convert_retention_price、convert_app_credit_price、convert_app_order_price、convert_app_pay_price、convert_app_custom_price、convert_dp_price、dp_convert_activation_price、dp_convert_register_price、dp_app_pay_price、dp_ud_convert_price、dp_app_credit_price、dp_app_order_price、quick_app_pay_price
 
离线游戏报表相关接口：
1. /v3/data/common/query/queryGameOffLineData
字段：ad_new_pay、total_pay、buy_user_income0、ad_price、click_price、down_price、active_price、inter_buy_ltv1、inter_buy_ltv3、inter_buy_ltv7、inter_buy_ltv30、register_price、new_pay_price、new_user_ltv1、new_user_ltv3、new_user_ltv7、new_user_ltv30
2. /v3/data/common/summary/queryGameOffLineData
字段：buy_active_user_income、buy_active_user_income3、buy_active_user_income7、buy_active_user_income30、buy_user_income0、ltv1_pay、ltv3_pay、ltv7_pay、ltv30_pay
其它修改：
50per_total_pay、10per_total_pay 添加 ifnull,数据库中为空时返回 0
 
 
游戏实时数据接口：
1. /v3/data/common/query/queryGameRTData
2. /v3/data/common/summary/queryGameRTData
字段：cost、game_activate_price、game_new_pay_price、game_register_price、download_price、form_price、click_price、convert_active_price、convert_register_price、convert_retention_price、convert_app_credit_price、convert_app_order_price、convert_app_pay_price、convert_app_custom_price、convertDpsPrice
 
小游戏数据接口：
1. /v3/data/common/query/queryQuickGame
字段：inter_buy_pay、acc_cost、buy_user_income0、click_price、active_cost、new_user_buy_ltv1、new_user_buy_ltv3、new_user_buy_ltv7、new_user_buy_ltv30、pay_cost、inter_buy_ltv1、inter_buy_ltv3、inter_buy_ltv7、inter_buy_ltv30、ltv1_pay
2. /v3/data/common/summary/queryQuickGame
字段：acc_cost、buy_user_income0、buy_user_income、buy_user_income3、buy_user_income7、buy_user_income30、ltv1_pay、ltv3_pay、ltv7_pay、ltv30_pay、inter_buy_pay
 
关键词报表相关数据接口：
1. /v3/data/common/summary/queryKwData
2. /v3/data/common/query/queryKwData
字段：cost、download_price、click_price
 
子客户消耗报表数据接口
1. /v3/data/common/summary/queryAccountCost
2. /v3/data/common/query/queryAccountCost
字段：cost
 
广告明细数据接口
1. /v3/data/common/query/getSrptRptDataList
字段：cost、download_price、form_price、click_price、convert_active_price、convert_register_price、convert_retention_price、convert_app_credit_price、convert_app_order_price、convert_app_pay_price、convert_app_custom_price、convert_app_order_price、convert_app_custom_price、convert_dp_price、dp_convert_activation_price、dp_convert_register_price、dp_app_pay_price、dp_ud_convert_price、dp_app_credit_price、dp_app_order_price、quick_app_pay_price

2. 典型场景举例

2.1 计划-新建计划

**1 获取支持的推广目的   **
请求地址：

/v3/communal/config/getList

请求参数：

type=EXTENSION_TYPE

SDK请求方法：（使用SDK接入）

omniAds.adsCommunal().v3CommunalConfigGetList(data)

SDK请求参数：

AdsConfigReq data参数
data.setXxx; 
  1.String type 配置类型，获取配置列表，配置类型不能为空，EXTENSION_TYPE：推广目的，EXTENSION_FLOW：推广流量，FLOW_SCENE：流量场景，BILLING_TYPE：出价方式，OCPC_TYPE：转化类型，DEEP_OCPC_TYPE：深度转化类型，SPEC_TYPE：规格，URL_TYPE：监测链接，SMART_EXPAND_TYPE；智能拓量，FIREFLY_APP_DOWN_PAGE：萤火虫应用下载页，PAGE_TYPE：落地页类型，REQUIRED_SPEC_TYPE：全流量必填规格
  2.List<String> typeList 配置类型列表，批量获取配置项，配置类型列表不能为空
  3.Integer extensionType 推广目标 1：链接推广 2：应用推广 3: 快应用推广 7: 小程序推广 --非必须
  4.Integer extensionFlow 推广流量：1-全流量场景，2-自有流量，3-联盟流量 --非必须
  5.Integer flowScene     流量场景：1-全流量场景，2-精选推广，3-安装有礼，4-开机必备，5-搜索，6-信息流，7-Banner，8-开屏，9-插屏，10-原生，11-激励视频，12-联盟通投。修改出价，流量场景不能为空 --非必须

响应报文：

{
    "code":0,
    "data":[
        {
            "value":"2",
            "ext":{
                "name":"应用推广",
                "value":2
            }
        },
        {
            "value":"1",
            "ext":{
                "name":"网页推广",
                "value":1
            }
        },
        {
            "value":"3",
            "ext":{
                "name":"快应用推广",
                "value":3
            }
        }
    ]
}

2 新建带预算的应用推广类型计划
请求地址：

/v3/plan/add

请求参数：

extensionType: 2
planName: 应用推广_2021/07/15_20:11:43
dayLimit: 1
dayBudget: 200000

SDK请求方法：（使用SDK接入）

 omniAds.adsPlan().v3PlanAdd(data)

SDK请求参数：

/**
 * AdsPlanAddForm data必传参数
 * 1.String planName        计划名称长度必须在1-100字符之间
 * 2.Integer extensionType  推广目标 1：链接推广 2：应用推广 3: 快应用推广 7: 小程序推广
 * 3.Integer dayLimit       是否限制日预算 0 不限制 1 限制, 当dayLimit=1时dayBudget必填
 * Long dayBudget      日预算 (限制日预算时必填 单位（分）
 */

响应报文：

{"code":0,"data":{"planId":200012854}}

3 新建不带预算的链接推广类型计划
请求地址：

/v3/plan/add

请求参数：

extensionType:1
planName:网页推广_2021/12/01_10:10:48
dayLimit:0
dayBudget:0

SDK请求方法：（使用SDK接入）

 omniAds.adsPlan().v3PlanAdd(data)

SDK请求参数：

/**
 * AdsPlanAddForm data必传参数
 * 1.String planName        计划名称长度必须在1-100字符之间
 * 2.Integer extensionType  推广目标 1：链接推广 2：应用推广 3: 快应用推广 7: 小程序推广
 * 3.Integer dayLimit       是否限制日预算 0 不限制 1 限制, 当dayLimit=1时dayBudget必填
 * Long dayBudget      日预算 (限制日预算时必填 单位（分）
 */

响应报文：

{"code":0,"data":{"planId":200012858}}

2.2 广告组-新建应用下载模板页广告组

1 获取当前支持的推广目的
请求地址：

/v3/communal/config/getList

请求参数：

type: EXTENSION_TYPE

SDK请求方法：（使用SDK接入）

omniAds.adsCommunal().v3CommunalConfigGetList(data)

SDK请求参数：

/** 
 *  AdsConfigReq data参数
 * 1.String type 配置类型，获取配置列表，配置类型不能为空，EXTENSION_TYPE：推广目的，EXTENSION_FLOW：推广流量，FLOW_SCENE：流量场景，BILLING_TYPE：出价方式，OCPC_TYPE：转化类型，DEEP_OCPC_TYPE：深度转化类型，SPEC_TYPE：规格，URL_TYPE：监测链接，SMART_EXPAND_TYPE；智能拓量，FIREFLY_APP_DOWN_PAGE：萤火虫应用下载页，PAGE_TYPE：落地页类型，REQUIRED_SPEC_TYPE：全流量必填规格
 * 2.List<String> typeList 配置类型列表，批量获取配置项，配置类型列表不能为空
 * 3.Integer extensionType 推广目标 1：链接推广 2：应用推广 3: 快应用推广 7: 小程序推广 --非必须
 * 4.Integer extensionFlow 推广流量：1-全流量场景，2-自有流量，3-联盟流量 --非必须
 * 5.Integer flowScene     流量场景：1-全流量场景，2-精选推广，3-安装有礼，4-开机必备，5-搜索，6-信息流，7-Banner，8-开屏，9-插屏，10-原生，11-激励视频，12-联盟通投。修改出价，流量场景不能为空 --非必须
 * */

响应报文：

{
    "code": 0,
    "data": [{
        "value": "2",
        "ext": "{"name":"应用推广","value":2}"
    },
    {
        "value": "1",
        "ext": "{"name":"网页推广","value":1}"
    },
    {
        "value": "3",
        "ext": "{"name":"快应用推广","value":3}"
    }]
}

2 获取当前支持的推广流量
请求地址：

/v3/communal/config/getList

请求参数：

type: EXTENSION_FLOW
extensionType: 2

SDK请求方法：（使用SDK接入）

omniAds.adsCommunal().v3CommunalConfigGetList(data)

SDK请求参数：


/** 
 *  AdsConfigReq data参数
 * 1.String type 配置类型，获取配置列表，配置类型不能为空，EXTENSION_TYPE：推广目的，EXTENSION_FLOW：推广流量，FLOW_SCENE：流量场景，BILLING_TYPE：出价方式，OCPC_TYPE：转化类型，DEEP_OCPC_TYPE：深度转化类型，SPEC_TYPE：规格，URL_TYPE：监测链接，SMART_EXPAND_TYPE；智能拓量，FIREFLY_APP_DOWN_PAGE：萤火虫应用下载页，PAGE_TYPE：落地页类型，REQUIRED_SPEC_TYPE：全流量必填规格
 * 2.List<String> typeList 配置类型列表，批量获取配置项，配置类型列表不能为空
 * 3.Integer extensionType 推广目标 1：链接推广 2：应用推广 3: 快应用推广 7: 小程序推广 --非必须
 * 4.Integer extensionFlow 推广流量：1-全流量场景，2-自有流量，3-联盟流量 --非必须
 * 5.Integer flowScene     流量场景：1-全流量场景，2-精选推广，3-安装有礼，4-开机必备，5-搜索，6-信息流，7-Banner，8-开屏，9-插屏，10-原生，11-激励视频，12-联盟通投。修改出价，流量场景不能为空 --非必须
 * */

响应报文：

{
    "code": 0,
    "data": [{
        "value": "2",
        "ext": "{"name":"自有流量","value":2}"
    },
    {
        "value": "3",
        "ext": "{"name":"联盟流量","value":3}"
    }]
}

3 获取支持的流量场景
请求地址：

/v3/communal/config/getList

请求参数：

type: FLOW_SCENE
extensionType: 2
extensionFlow: 3

SDK请求方法：（使用SDK接入）

omniAds.adsCommunal().v3CommunalConfigGetList(data)

SDK请求参数：


/** 
 *  AdsConfigReq data参数
 * 1.String type 配置类型，获取配置列表，配置类型不能为空，EXTENSION_TYPE：推广目的，EXTENSION_FLOW：推广流量，FLOW_SCENE：流量场景，BILLING_TYPE：出价方式，OCPC_TYPE：转化类型，DEEP_OCPC_TYPE：深度转化类型，SPEC_TYPE：规格，URL_TYPE：监测链接，SMART_EXPAND_TYPE；智能拓量，FIREFLY_APP_DOWN_PAGE：萤火虫应用下载页，PAGE_TYPE：落地页类型，REQUIRED_SPEC_TYPE：全流量必填规格
 * 2.List<String> typeList 配置类型列表，批量获取配置项，配置类型列表不能为空
 * 3.Integer extensionType 推广目标 1：链接推广 2：应用推广 3: 快应用推广 7: 小程序推广 --非必须
 * 4.Integer extensionFlow 推广流量：1-全流量场景，2-自有流量，3-联盟流量 --非必须
 * 5.Integer flowScene     流量场景：1-全流量场景，2-精选推广，3-安装有礼，4-开机必备，5-搜索，6-信息流，7-Banner，8-开屏，9-插屏，10-原生，11-激励视频，12-联盟通投。修改出价，流量场景不能为空 --非必须
 * */

响应报文：

{
    "code": 0,
    "data": [{
        "value": "12",
        "ext": "{"name":"不限","value":12}"
    },
    {
        "value": "7",
        "ext": "{"name":"banner","value":7}"
    },
    {
        "value": "9",
        "ext": "{"name":"插屏","value":9}"
    },
    {
        "value": "8",
        "ext": "{"name":"开屏","value":8}"
    },
    {
        "value": "10",
        "ext": "{"name":"原生","value":10}"
    },
    {
        "value": "11",
        "ext": "{"name":"激励视频","value":11}"
    }]
}

4 获取应用信息
请求地址：

/v2/communal/group/appInfo

请求参数：

appId: 30383853

SDK请求方法：（使用SDK接入）

omniAds.adsCommunal().v2CommunalGroupAppInfo(appId, pkgName, bizType, flowScence)

SDK请求参数：

/**
 * 必传参数
 * 1.Integer appId  广告ID
 * 2.String pkgName 应用包名
 * 3.Integer bizType 业务类型 1：cpd广告产品，2：feeds广告，3：合约广告，" +
 *                                                       "4：招商活动广告，5：智能短信广告，6：联盟广告，7：搜索，100：外部ADX，101：业务公共类型，102：融合，201：电商
 * 4.Integer flowScene     流量场景：1-全流量场景，2-精选推广，3-安装有礼，4-开机必备，5-搜索，6-信息流，7-Banner，8-开屏，9-插屏，10-原生，11-激励视频，12-联盟通投。修改出价，流量场景不能为空
 * */

响应报文：

{
    "code": 0, 
    "data": {
        "appId": 30383853, 
        "appName": "绝世仙王", 
        "appPackage": "com.syzh.jsxw.nearme.gamecenter", 
        "iconUrl": "https://store.heytapimage.com/img/202106/28/b8c3540c95bb731aaab9d0261a62565b.png", 
        "status": 0, 
        "resourceStatus": 1, 
        "onewordDesc": "2021国创神话冒险手游", 
        "categoryId": 8, 
        "appAuth": 0
    }
}

5 获取当前支持的落地页类型
请求地址：

/v3/communal/config/getList

请求参数：

type: PAGE_TYPE
extensionFlow: 3
extensionType: 2
flowScene: 12

SDK请求方法：（使用SDK接入）

omniAds.adsCommunal().v3CommunalConfigGetList(data)

SDK请求参数：


/** 
 *  AdsConfigReq data参数
 * 1.String type 配置类型，获取配置列表，配置类型不能为空，EXTENSION_TYPE：推广目的，EXTENSION_FLOW：推广流量，FLOW_SCENE：流量场景，BILLING_TYPE：出价方式，OCPC_TYPE：转化类型，DEEP_OCPC_TYPE：深度转化类型，SPEC_TYPE：规格，URL_TYPE：监测链接，SMART_EXPAND_TYPE；智能拓量，FIREFLY_APP_DOWN_PAGE：萤火虫应用下载页，PAGE_TYPE：落地页类型，REQUIRED_SPEC_TYPE：全流量必填规格
 * 2.List<String> typeList 配置类型列表，批量获取配置项，配置类型列表不能为空
 * 3.Integer extensionType 推广目标 1：链接推广 2：应用推广 3: 快应用推广 7: 小程序推广 --非必须
 * 4.Integer extensionFlow 推广流量：1-全流量场景，2-自有流量，3-联盟流量 --非必须
 * 5.Integer flowScene     流量场景：1-全流量场景，2-精选推广，3-安装有礼，4-开机必备，5-搜索，6-信息流，7-Banner，8-开屏，9-插屏，10-原生，11-激励视频，12-联盟通投。修改出价，流量场景不能为空 --非必须
 * */

响应报文：

{
    "code": 0,
    "data": [{
        "value": "11",
        "ext": "{"name":"萤火虫模板","value":11}"
    },
    {
        "value": "4",
        "ext": "{"name":"萤火虫建站","value":4}"
    }]
}

6 获取萤火虫应用下载模板页
请求地址：

/v3/communal/h5Template/list

请求参数：

extensionFlow: 3
flowScene: 12

SDK请求方法：（使用SDK接入）

omniAds.adsMaterial().v3CommunalH5Template(data)

SDK请求参数：

/**
 * 参数  AdsV3H5TemplateForm data
 * 1.Integer tid;// 模板ID
 * 2.String tname;// 模板名称
 * 3.Integer bizId;// 业务ID
 * 4.String bizAdSource;// 业务内部广告来源
 * 5.String url;// 模板地址
 * 6.String demoUrl;// 模板demo地址
 * 7.String ext; 扩展字段
 * 8.Long inserTime;
 * 9.Long updateTime;
 * 10.Integer delFlag; 0正常，1删除
 * 11.String ownerId;//广告主ID
 * 12.Integer outterFlag; 外部模板标记【0：非；1：是】
 * 13.String outterChn;  外部渠道（如：ADX动态模板，记录为dspId）
 */

响应报文：

{
    "code": 0, 
    "data": [
        {
            "h5Id": 4, 
            "h5Name": "萤火虫沉浸式A版", 
            "bizAdSource": "union_advert", 
            "h5Url": "https://adsfs.heytapimage.com/marketing/template/union/A/index.html?pagebgcolor=immerse", 
            "demoUrl": "https://adsfs.heytapimage.com/union/middle_page/tl_demo/v2-example-A.png", 
            "delFlag": 0
        }, 
        {
            "h5Id": 5, 
            "h5Name": "萤火虫沉浸式B版", 
            "bizAdSource": "union_advert", 
            "h5Url": "https://adsfs.heytapimage.com/marketing/template/union/B/index.html?pagebgcolor=immerse", 
            "demoUrl": "https://adsfs.heytapimage.com/union/middle_page/tl_demo/v2-example-B.png", 
            "delFlag": 0
        }, 
        {
            "h5Id": 8, 
            "h5Name": "萤火虫A版", 
            "bizAdSource": "union_advert", 
            "h5Url": "https://adsfs.heytapimage.com/marketing/template/union/A/index.html", 
            "demoUrl": "https://adsfs.heytapimage.com/union/middle_page/tl_demo/v2-example-A.png", 
            "delFlag": 0
        }, 
        {
            "h5Id": 9, 
            "h5Name": "萤火虫B版", 
            "bizAdSource": "union_advert", 
            "h5Url": "https://adsfs.heytapimage.com/marketing/template/union/B/index.html", 
            "demoUrl": "https://adsfs.heytapimage.com/union/middle_page/tl_demo/v2-example-B.png", 
            "delFlag": 0
        }, 
        {
            "h5Id": 26, 
            "h5Name": "下载浮层", 
            "bizAdSource": "union_advert", 
            "h5Url": "https://adsfs.heytapimage.com/mp/app/union/layerN/index.html", 
            "demoUrl": "https://adsfs.heytapimage.com/union/middle_page/tl_demo/v2-example-layer.png", 
            "delFlag": 0
        }, 
        {
            "h5Id": 27, 
            "h5Name": "自定义", 
            "bizAdSource": "union_advert", 
            "h5Url": "", 
            "demoUrl": "", 
            "delFlag": 0
        }, 
        {
            "h5Id": 28, 
            "h5Name": "通用F版", 
            "bizAdSource": "union_advert", 
            "h5Url": "https://adsfs.heytapimage.com/mp/app/union/F/index.html", 
            "demoUrl": "https://adsfs.heytapimage.com/union/middle_page/tl_demo/v2-example-F.jpg", 
            "delFlag": 0
        }
    ]
}

7 获取对应app支持的萤火虫落地页
请求地址：

/v2/communal/ad/sparkPageNew/list

请求参数：

pageType: 4
appId: 30383853

SDK请求方法：（使用SDK接入）

omniAds.adsCommunal().v2CommunalAdSparkPageNewList(data)

SDK请求参数：

/**
 * AdsAdPageForm data 参数
 * 1. String pageId 落地页id
 * 2. String pageUrl   落地页url 与 pageType 不能同时为空
 * 3.Integer pageType  建站类型与 pageUrl 不能同时为空
 * 0-自定义落地页
 * 1-一叶智能
 * 2-云脑建站
 * 4-萤火虫建站
 * 5-快应用建站
 * 6-广告主自建页面 JS SDK
 * 7-广告主自建页面 H5 API 回传
 * 8-信息流 线索直达
 * 9-商店详情页
 * 11-萤火虫应用模板下载页
 * 12-互动落地页
 * <p>
 * 4.String appId   应用id  适用于应用推广场景，起校验作用，传入appId参数确保只返回该应用的落地页，不能单独使用，需要与pageType、pageUrl配合使用
 */

响应报文：

{
    "code": 0, 
    "data": [
        {
            "pageId": "95058", 
            "pageUrl": "", 
            "pageName": "竖版视频", 
            "pageType": 9, 
            "ocpcType": 0, 
            "targetType": 0, 
            "appId": "2297"
        }, 
        {
            "pageId": "95102", 
            "pageUrl": "", 
            "pageName": "蘑菇街", 
            "pageType": 9, 
            "ocpcType": 0, 
            "targetType": 0, 
            "appId": "23896"
        }
    ]
}

8 获取对应流量场景支持的转化类型
请求地址：

/v3/communal/config/getList

SDK请求方法：（使用SDK接入）

omniAds.adsCommunal().v3CommunalConfigGetList(data)

请求参数：

type: OCPC_TYPE
extensionType: 2
flowScene: 12

响应报文：

{
    "code": 0,
    "data": [{
        "value": "5-1",
        "ext": "{"name":"下载","value":1,"billingType":5}"
    },
    {
        "value": "5-2",
        "ext": "{"name":"激活","value":2,"billingType":5}"
    },
    {
        "value": "5-4",
        "ext": "{"name":"游戏注册","value":4,"billingType":5}"
    },
    {
        "value": "5-8",
        "ext": "{"name":"回传激活","value":8,"billingType":5}"
    }]
}

备注： 5-1取-后面的1，标识转化类型枚举值1.

9 获取对应流量场景支持的深度转化类型
请求地址：

/v3/communal/config/getList

SDK请求方法：（使用SDK接入）

omniAds.adsCommunal().v3CommunalConfigGetList(data)

请求参数：

type: DEEP_OCPC_TYPE
ocpcType: 0
extensionType: 2
extensionFlow: 3
flowScene: 12

响应报文：

{
    "code": 0,
    "data": [{
        "value": "2-8",
        "ext": "{"name":"回传激活","value":8,"ocpcType":2}"
    },
    {
        "value": "2-7",
        "ext": "{"name":"注册","value":7,"ocpcType":2}"
    },
    {
        "value": "4-5",
        "ext": "{"name":"游戏付费","value":5,"ocpcType":4}"
    },
    {
        "value": "8-10",
        "ext": "{"name":"回传留存","value":10,"ocpcType":8}"
    },
    {
        "value": "8-10",
        "ext": "{"name":"系统留存","value":15,"ocpcType":8}"
    }]
}

10 获取价格限制配置
请求地址：

/v3/communal/interval/config/groupPrice

请求参数：

flowScene=12
ocpcType=0

SDK请求方法：（使用SDK接入）

omniAds.adsCommunal().v3GroupPrice(extensionType, flowScene, ocpcType)

SDK请求参数：

/**
 * AdsV3MtrSpecForm data 参数
 * 1. Integer extensionType; 推广类型 1：链接推广 2：应用推广 3: 快应用推广 7: 小程序推广  必传
 * 2. Integer flowScene  * 流量场景   必传
 * 1.全流量场景
 * 2.精选推广
 * 3.安装有礼
 * 4.开机必备
 * 5.搜索
 * 6.信息流
 * 7.banner
 * 8.开屏
 * 9.插屏
 * 10.原生
 * 11.激励视频
 * 12.通投类型
 * 20.品牌
 * 3.Integer ocpcType  目标转化类型  必传 
 */

响应报文：

{
    "code": 0, 
    "data": {
        "flowScene": 12, 
        "ocpcType": 0, 
        "floorBid": 10, 
        "maxBid": 10000, 
        "oFloorBid": 120, 
        "oMaxBid": 20000, 
        "dFloorBid": 120, 
        "dMaxBid": 300000
    }
}
--------------------------- 最终新建广告组 ------------------------

新建一个ocpc激活类型、应用下载模板页为萤火虫沉浸式B版，app为绝世仙王、且设置了推广日期和播放时段的的联盟banner广告组。
请求地址：

/v3/group/add

请求参数：

planId: 200001707
adGroupName: 应用推广_联盟流量_2021/07/15_15:53:11
appId: 30383853
extensionFlow: 3
flowScene: 7
pageType: 11
pageId: 5（对应/v3/communal/h5Template/list接口返回的h5Id）
pageUrl: https://adsfs.heytapimage.com/marketing/template/union/B/index.html?pagebgcolor=immerse&pkg=com.syzh.jsxw.nearme.gamecenter
smartExpandType: 0
timeLimit: 1
dayLimit: 1
beginTime: 20210715
endTime: 20210717
timeSet: {"1":"1,2","2":"","3":"","4":"","5":"","6":"","7":""}
billingType: 5
adServingType: 0
price: 100
ocpcType: 2
ocpcPrice: 200
targetId: 0
extensionType: 2
groupPrice: 1
autoOpenFlag: 0
targetSource: 1

SDK请求方法：（使用SDK接入）

omniAds.adsGroup().v3GroupAdd(data)

SDK请求参数：

/**
 * AdsGroupAddForm data 必传参数
 * 1.String adGroupName 广告组名称，长度为1-100个字符
 * 2.Long planId        计划ID
 * 3.String pageUrl     广告h5落地链接（链接,应用,快应用推广同样作用）选择下载浮层或者F版的落地链接类型，需要将当前广告的目标落地链接URLencode之后，组装在下载浮层的URL地址后面，链接推广、快应用推广时必填。若为萤火虫应用下载模板页，则传递模板url，可通/v3/communal/h5Template/list接口获取模板id和url，也可参考《典型场景举例-新建应用下载模板页广告组》
 * 4.Integer extensionType  标的物类型 1：链接推广 2：应用推广 3: 快应用推广 7: 小程序推广"
 * 5.Integer extensionFlow  推广流量：1-全流量场景，2-自有流量，3-联盟流量
 * 6.Integer flowScene      流量场景：1-全流量场景，2-精选推荐，3-安装有礼，4-开机必备，5-搜索，6-信息流，7-Banner，8-开屏，9-插屏，10-原生，11-激励视频，12-联盟通投
 * 7.Integer dayLimit       推广日期限制 0-不限制推广日期 1-限制推广日期，当为1时，beginTime和endTime必传
 * 推广开始时间 Integer beginTime 格式：YYYYMMDD
 * 推广截止时间 Integer endTime   格式：YYYYMMDD
 * 8.Integer billingType    计费方式.1:CPD 2:CPC 3:CPM 4:CPS 5:OCPC 6:CPA
 */

响应报文：

{
    "code": 0, 
    "data": {
        "insertTime": null, 
        "updateTime": null, 
        "updateBy": null, 
        "updateHost": null, 
        "deleteFlag": null, 
        "auditTime": null, 
        "statusName": null, 
        "subStatusName": null, 
        "webStatus": null, 
        "showStatus": null, 
        "adGroupId": 300025683, 
        "adGroupName": null, 
        "planId": null, 
        "planName": null, 
        "targetType": null, 
        "pageId": null, 
        "pageType": null, 
        "pageUrl": null, 
        "deepUrl": null, 
        "appId": null, 
        "appPackage": null, 
        "appName": null, 
        "appRef": null, 
        "categoryId": null, 
        "secondCategoryId": null, 
        "thirdCategroyId": null, 
        "instantAppUrl": null, 
        "instantAppId": null, 
        "beginTime": null, 
        "endTime": null, 
        "targetId": null, 
        "targetSource": null, 
        "timeSet": null, 
        "status": null, 
        "extensionType": 2, 
        "extensionFlow": 3, 
        "flowScene": 7, 
        "expose": 0, 
        "click": 0, 
        "download": 0, 
        "cost": 0, 
        "timeLimit": null, 
        "dayLimit": null, 
        "status2": null, 
        "openGroupId": null, 
        "formOrderNums": 0, 
        "formPrice": "0", 
        "convertActive": 0, 
        "convertRegister": 0, 
        "convertActivePrice": "0", 
        "convertRegisterPrice": "0", 
        "convertRetention": 0, 
        "convertRetentionPrice": "0", 
        "convertAppCredit": 0, 
        "convertAppCreditPrice": "0", 
        "convertAppOrder": 0, 
        "convertAppOrderPrice": "0", 
        "convertAppPay": 0, 
        "convertAppPayPrice": "0", 
        "convertAppCustom": 0, 
        "convertAppCustomPrice": "0", 
        "convertDp": 0, 
        "convertDpsPrice": "0", 
        "smartExpandType": null, 
        "autoOpenFlag": null, 
        "groupPrice": null, 
        "billingType": null, 
        "price": null, 
        "ocpcPrice": null, 
        "ocpcType": null, 
        "ocpcOptmType": null, 
        "deepOcpcPrice": null, 
        "deepOcpcType": null, 
        "ocpcState": null, 
        "targetROI": null, 
        "adServingType": null, 
        "followMaxPrice": null, 
        "followAppIdList": null, 
        "smartExpandBreakthrough": null
    }
}

2.3 创意-创建广告创意

1 获取按钮文案（可选）
请求地址：

/v3/communal/config/getList

请求参数：

type=BUTTON_TITLE

SDK请求方法：（使用SDK方法接入）

omniAds.adsCommunal().v3CommunalConfigGetList(data)

SDK请求参数：

/** 
 *  AdsConfigReq data参数
 * 1.String type 配置类型，获取配置列表，配置类型不能为空，EXTENSION_TYPE：推广目的，EXTENSION_FLOW：推广流量，FLOW_SCENE：流量场景，BILLING_TYPE：出价方式，OCPC_TYPE：转化类型，DEEP_OCPC_TYPE：深度转化类型，SPEC_TYPE：规格，URL_TYPE：监测链接，SMART_EXPAND_TYPE；智能拓量，FIREFLY_APP_DOWN_PAGE：萤火虫应用下载页，PAGE_TYPE：落地页类型，REQUIRED_SPEC_TYPE：全流量必填规格
 * 2.List<String> typeList 配置类型列表，批量获取配置项，配置类型列表不能为空
 * 3.Integer extensionType 推广目标 1：链接推广 2：应用推广 3: 快应用推广 7: 小程序推广 --非必须
 * 4.Integer extensionFlow 推广流量：1-全流量场景，2-自有流量，3-联盟流量 --非必须
 * 5.Integer flowScene     流量场景：1-全流量场景，2-精选推广，3-安装有礼，4-开机必备，5-搜索，6-信息流，7-Banner，8-开屏，9-插屏，10-原生，11-激励视频，12-联盟通投。修改出价，流量场景不能为空 --非必须
 * */

响应报文：

{
    "code":0,
    "data":[
        {
            "value":"0",
            "ext":[
                "打开",
                "下载",
                "去看看",
                "了解详情",
                "参与活动",
                "领取优惠",
                "立即打开",
                "立即下载",
                "立即查看",
                "立即体验",
                "立即申请",
                "立即抢购",
                "立即领取",
                "立即加入",
                "获取报价",
                "点击咨询"
            ]
        }
    ]
}

2 获取广告组下每个规格下支持可创建的创意数量上限（必须）
请求地址：

/v3/communal/config/getList

请求参数：

type=AD_EACH_SPEC_NUM_LIMIT

返回：

{"code":0,"data":[{"value":"10"}]}

3 获取广告组下所有规格支持的可创建创意数量上限（必须）
请求地址：

/v3/communal/config/getList

请求参数：

type=AD_ALL_SPEC_NUM_LIMIT

响应报文：

{"code":0,"data":[{"value":"100"}]}

4 获取动态词包（可选）
请求地址：

/v2/communal/dynamic/symbol/list

请求参数：

page=1
pageCount=20
ownerId=1000039147

SDK请求方法：（使用SDK接入）

omniAds.adsCommunal().v2CommunalDynamicSymbolList(data)

SDK请求参数：

/**
 * DynamicSymbolReq data 参数
 * 1. Long ownerId  广告主id  必传
 * 2. Integer page  分页查询页数，非必填，默认1
 * 3.Integer pageCount  分页查询每页数量，非必填，默认500
 */

响应报文：

{
    "code":0,
    "data":{
        "totalCount":4,
        "itemCount":4,
        "items":[
            {
                "symbol":"城市",
                "defaultWord":"本地",
                "ownerId":0,
                "statusFlag":1,
                "targetKey":"city"
            },
            {
                "symbol":"时间",
                "defaultWord":"今日",
                "ownerId":0,
                "statusFlag":1,
                "targetKey":"time"
            },
            {
                "symbol":"星期",
                "defaultWord":"星期天",
                "ownerId":0,
                "statusFlag":1,
                "targetKey":"week"
            },
            {
                "symbol":"男生女生",
                "defaultWord":"本地人",
                "ownerId":0,
                "statusFlag":1,
                "targetKey":"性别"
            }
        ]
    }
}

5 获取当前流量场景下每个规格所需的元素配置（必须，重要！！！）

此接口详细描述参考：/v3/communal/spec/list 接口文档部分。
需要注意的是当前规格下，哪些元素必填，哪些元素选填、以及对应元素的详细要求，都是由此接口返回值描述。

请求地址：

/v3/communal/spec/list

请求参数：

flowScene:8
extensionType:1
extensionFlow:3

SDK请求方法：（使用SDK接入）

omniAds.adsCommunal().v3CommunalSpecList(data)

SDK请求参数：

/**
 * AdsV3MtrSpecForm data 参数
 * 1. Integer extensionType; 推广类型 1：链接推广 2：应用推广 3: 快应用推广 7: 小程序推广  必传
 * 2. Integer extensionFlow  * 推广流量   必传
 * 1.全流量场景
 * 2.自有流量
 * 3.联盟流量
 * 3.Integer flowScene  流量场景    必传
 * 1-全流量场景
 * 2-精选推广
 * 3-安装有礼
 * 4-开机必备
 * 5-搜索
 * 6-信息流
 * 7-Banner
 * 8-开屏
 * 9-插屏
 * 10-原生
 * 11-激励视频
 * 12-联盟通投。
 */

响应报文：

{
  "code": 0,
  "data": [
    {
      "mSpecName": "开屏横图",
      "extensionType": 1,
      "flowScene": 8,
      "globalSpecId": 5,
      "format": "{\"bdName\":{\"maxLen\":8,\"minLen\":1},\"brandLogo\":{\"fmt\":[\"jpg\",\"png\",\"jpeg\"],\"h\":200,\"s\":100,\"w\":200},\"buttonTxt\":{\"maxLen\":4,\"minLen\":1},\"imgs\":[{\"fmt\":[\"jpg\",\"png\",\"jpeg\"],\"h\":1080,\"s\":300,\"w\":1920,\"whSc\":[\"16:9\"]}],\"repeat\":false,\"title\":{\"maxLen\":23,\"minLen\":1},\"videoBgImg\":{},\"videoImg\":{},\"videoList\":[]}",
      "demoUrl": "123",
      "required": "{\"imgs\": 1}"
    },
    {
      "mSpecName": "图标大图",
      "extensionType": 1,
      "flowScene": 8,
      "globalSpecId": 71,
      "format": "{\"bdName\":{\"maxLen\":8},\"brandLogo\":{\"fmt\":[\"jpg\",\"png\",\"jpeg\"],\"h\":200,\"s\":100,\"w\":200},\"buttonTxt\":{\"maxLen\":4},\"imgs\":[{\"fmt\":[\"jpg\",\"png\",\"jpeg\"],\"h\":512,\"s\":100,\"w\":512}],\"repeat\":false,\"title\":{\"maxLen\":23}}",
      "demoUrl": "[https://adsfs\.oppomobile\.com/union/union\_advert/adtype\_demo/v2\-raw\-large\-app\.jpg](https://adsfs.oppomobile.com/union/union_advert/adtype_demo/v2-raw-large-app.jpg)",
      "required": "{\"imgs\": 1,\"title\":1,\"bdName\":1,\"buttonTxt\":1}"
    },
    {
      "mSpecName": "竖版视频",
      "extensionType": 1,
      "flowScene": 8,
      "globalSpecId": 63,
      "format": "{\"bdName\":{\"maxLen\":8,\"minLen\":1},\"brandLogo\":{\"fmt\":[\"jpg\",\"png\",\"jpeg\"],\"h\":200,\"s\":100,\"w\":200},\"buttonTxt\":{\"maxLen\":4,\"minLen\":1},\"imgs\":[],\"interactives\":[{\"fmt\":[\"zip\"],\"s\":3072,\"whSc\":[\"9:16\"]}],\"repeat\":false,\"title\":{\"maxLen\":23,\"minLen\":1},\"videoBgImg\":{\"fmt\":[\"jpg\",\"png\",\"jpeg\"],\"h\":1280,\"s\":150,\"w\":720},\"videoImg\":{\"fmt\":[\"jpg\",\"png\",\"jpeg\"],\"h\":1280,\"s\":150,\"w\":720},\"videoList\":[{\"fmt\":[\"mp4\"],\"h\":0,\"maxDrt\":60,\"minDrt\":0,\"s\":25600,\"w\":0,\"whSc\":[\"9:16\"]}]}",
      "demoUrl": "[https://adsfs\.oppomobile\.com/union/union\_advert/adtype\_demo/v2\-raw\-large\-app\.jpg](https://adsfs.oppomobile.com/union/union_advert/adtype_demo/v2-raw-large-app.jpg)",
      "required": "{\"videoList\":1,\"title\":2}"
    },
    {
      "mSpecName": "开屏竖图",
      "extensionType": 1,
      "flowScene": 8,
      "globalSpecId": 34,
      "format": "{\"bdName\":{\"maxLen\":8,\"minLen\":1},\"brandLogo\":{\"fmt\":[\"jpg\",\"png\",\"jpeg\"],\"h\":200,\"s\":100,\"w\":200},\"buttonTxt\":{\"maxLen\":4,\"minLen\":1},\"imgs\":[{\"fmt\":[\"jpg\",\"png\",\"jpeg\"],\"h\":1920,\"s\":300,\"w\":1080,\"whSc\":[\"9:16\"]}],\"repeat\":false,\"title\":{\"maxLen\":23,\"minLen\":1},\"videoBgImg\":{},\"videoImg\":{},\"videoList\":[]}",
      "demoUrl": "[https://adsfs\.oppomobile\.com/union/union\_advert/adtype\_demo/v2\-raw\-large\-app\.jpg](https://adsfs.oppomobile.com/union/union_advert/adtype_demo/v2-raw-large-app.jpg)",
      "required": "{\"imgs\": 1,\"title\":2}"
    }
  ]
}

6 素材上传（可选）
请求地址：

/v3/creative/material/communal/upload

请求参数：

file:(binary)
matSpecId:71
picType:imgs

响应报文：

{
  "code": 0,
  "data": {
    "url": "[https://adsfs.heytapimage.com/ads-material-depot/image/72ed5e25f0d3c76b5541c5e2226e137e.jpg](https://adsfs.heytapimage.com/ads-material-depot/image/72ed5e25f0d3c76b5541c5e2226e137e.jpg)",
    "id": 45441815
  }
}

7 查询素材中心素材（可选）
请求地址：

/creative/material/image/getList

请求参数：

size:102400
dimension:512*512
page:1
pageSize:10
suffixes:jpg
suffixes:png
suffixes:jpeg

响应报文：

{
  "code": 0,
  "data": {
    "items": [
      {
        "labels": [

        ],

        "compressedSize": 0,

        "compressedMd5": "",

        "compressedUrl": "",

        "webpMUrl": null,

        "webpMd5": "",

        "deleteFlag": 0,

        "updateTime": 0,

        "insertTime": 1638325900,

        "extJson": "",

        "md5": "41718787d0c7d58d4e38d92b43924abc",

        "duration": 0,

        "size": 32348,

        "uploadWay": 1,

        "suffix": "jpg",

        "type": 1,

        "height": 512,

        "width": 512,

        "coverUrl": "",

        "materialUrl": "https://adsfs.heytapimage.com/ads-material-depot/image/72ed5e25f0d3c76b5541c5e2226e137e.jpg",

        "materialName": "22.jpg",

        "openMaterialId": "41718787d0c7d58d4e38d92b43924abc",

        "ownerId": 1000062687,

        "id": 45441815

      },

      {

        "labels": [


        ],

        "compressedSize": 0,

        "compressedMd5": "",

        "compressedUrl": "",

        "webpMUrl": null,

        "webpMd5": "",

        "deleteFlag": 0,

        "updateTime": 1604568334,

        "insertTime": 1604367896,

        "extJson": "",

        "md5": "17005b36168bbcebb379c33aac9233f0",

        "duration": 0,

        "size": 46567,

        "uploadWay": 1,

        "suffix": "jpg",

        "type": 1,

        "height": 512,

        "width": 512,

        "coverUrl": "",

        "materialUrl": "https://adsfs.heytapimage.com/ads-material-depot/image/13f0425cdaf68684deebddffd3033698.jpg",

        "materialName": "修改一下.jpg",

        "openMaterialId": "17005b36168bbcebb379c33aac9233f0",

        "ownerId": 1000062687,

        "id": 26720068

      },

      {

        "labels": [


        ],

        "compressedSize": 0,

        "compressedMd5": "",

        "compressedUrl": "",

        "webpMUrl": null,

        "webpMd5": "",

        "deleteFlag": 0,

        "updateTime": 0,

        "insertTime": 1600055167,

        "extJson": "",

        "md5": "1d4f643c2cf2c7fb4a334f629df023bd",

        "duration": 0,

        "size": 8804,

        "uploadWay": 1,

        "suffix": "png",

        "type": 1,

        "height": 512,

        "width": 512,

        "coverUrl": "",

        "materialUrl": "https://adsfs.heytapimage.com/ads-material-depot/image/4b1f1d9213e437d1f64b98536e1fcd94.png",

        "materialName": "510x510.png",

        "openMaterialId": "1d4f643c2cf2c7fb4a334f629df023bd",

        "ownerId": 1000062687,

        "id": 24933208

      },

      {

        "labels": [


        ],

        "compressedSize": 0,

        "compressedMd5": "",

        "compressedUrl": "",

        "webpMUrl": null,

        "webpMd5": "",

        "deleteFlag": 0,

        "updateTime": 0,

        "insertTime": 1600055167,

        "extJson": "",

        "md5": "5cab543ebd2cc098359d99719fa3f28a",

        "duration": 0,

        "size": 10717,

        "uploadWay": 1,

        "suffix": "png",

        "type": 1,

        "height": 512,

        "width": 512,

        "coverUrl": "",

        "materialUrl": "https://adsfs.heytapimage.com/ads-material-depot/image/5767e36e4a55241d835c7a5c68df4dec.png",

        "materialName": "520x520.png",

        "openMaterialId": "5cab543ebd2cc098359d99719fa3f28a",

        "ownerId": 1000062687,

        "id": 24933209

      }

    ],

    "itemCount": 4,

    "totalCount": 4

  }

}

注意素材中心素材是广告主私有的，也是广告主自行上传上去管理的，新建创意时可以从素材中心选择素材来复用。

---------------- 创建广告创意----------------------
8 创建广告创意

下面例子同时创建两个竖版大图创意，以及一个横版视频创意。
请求地址：

/v3/ad/batch

请求参数：

addList[0].adGroupId: 300026777
addList[0].adName: 网页推广_信息流_竖版大图_创意1_2021/07/16_14:16:52
addList[0].adPlanId: 200013226
addList[0].adSource: 1
addList[0].brandLogoImgId: 38704057
addList[0].brandName: 諷德誦功
addList[0].buttonTxt:
addList[0].copywriter: fodlord影院、gps、gf手机等都可以！
addList[0].copywriterId: 275876
addList[0].industryId: null
addList[0].globalSpecId: 50
addList[0].videoBgImgId:
addList[0].videoImgId:
addList[0].imgMatIds: 43449718
addList[0].exposeUrl:
addList[0].clickUrl:
addList[0].downloadUrl:
addList[1].adGroupId: 300026777
addList[1].adName: 网页推广_信息流_竖版大图_创意2_2021/07/16_14:16:52
addList[1].adPlanId: 200013226
addList[1].adSource: 1
addList[1].brandLogoImgId: 38704057
addList[1].brandName: 手动阀
addList[1].buttonTxt:
addList[1].copywriter: 第三方
addList[1].copywriterId: 275972
addList[1].industryId: null
addList[1].globalSpecId: 50
addList[1].videoBgImgId:
addList[1].videoImgId:
addList[1].imgMatIds: 43449718
addList[1].exposeUrl:
addList[1].clickUrl:
addList[1].downloadUrl:
addList[2].adGroupId: 300026777
addList[2].adName: 网页推广_信息流_横版视频_创意1_2021/07/16_14:16:52
addList[2].adPlanId: 200013226
addList[2].adSource: 1
addList[2].brandLogoImgId: 38704057
addList[2].brandName: 手动阀
addList[2].buttonTxt:
addList[2].copywriter: 双方都
addList[2].copywriterId: 275973
addList[2].industryId: null
addList[2].globalSpecId: 60
addList[2].videoBgImgId:
addList[2].videoImgId: 39107956
addList[2].videoMatIds: 38703350
addList[2].exposeUrl:
addList[2].clickUrl:
addList[2].playBeginUrl:
addList[2].playEndUrl:
addList[2].downloadUrl:

SDK请求方法：（使用SDK接入）

omniAds.ads().v3AdBatch(data

SDK请求参数：

/**
 * 必传参数
 * 1.新增广告列表时必传  List<AdsAdCollectReq> addList
 * a. String adName 广告名称
 * b. Integer globalSpecId 统一规格ID
 * c. Long adPlanId 计划ID
 * d. Long adGroupId 广告组ID
 * 2.编辑广告列表时必传  List<AdsAdCollectReq> editList
 * a.Long adId 广告ID
 * b.Long adPlanId 计划ID
 * c.Long adGroupId 广告组ID
 * 3.删除广告列表时必传  List<AdsAdDelReq> delList
 * a. Long adId 广告ID
 */

2.4 创意-编辑广告创意

1 首先查询当前广告组下面的所有广告创意列表
请求地址：

/v3/ad/list

请求参数：

adGroupId:300012658

SDK请求方法：（使用SDK接入）

omniAds.ads().v3AdList(data)

SDK请求参数：

/**
 * AdsAdCollectListReq data必传参数
 * 1.Long adGroupId 广告组ID
 */

响应报文：

{
  "code": 0,
  "data": [
    {
      "adId": 400035867,
      "adName": "测试创意1",
      "status": 16777216,
      "showStatus": 1,
      "showStatusName": "暂停中",
      "subShowStatusName": "",
      "status2": 1,
      "adSource": 1,
      "globalSpecId": 5,
      "deleteFlag": 0,
      "adPlanId": 200004883,
      "adGroupId": 300012658,
      "adFlag": 3,
      "copywriter": "",
      "brandName": "",
      "buttonTxt": "",
      "imgMats": [
        {
          "materialUrl": "https://adsfs.heytapimage.com/ads-material-depot/image/b7e084cc1ba01a35285017029f2a4dec.jpg",
          "mid": 45441914
        }
      ],
      "exposeUrl": "",
      "clickUrl": "",
      "playBeginUrl": "",
      "playEndUrl": "",
      "downloadUrl": "",
      "dynamicCr": 0,
      "interactCr": 0,
      "insertTime": 1625643671,
      "updateTime": 1638326605
    },
    {
      "adId": 404941869,
      "adName": "测试创意2",
      "status": 256,
      "showStatus": 2,
      "showStatusName": "审核中",
      "subShowStatusName": "",
      "status2": 0,
      "adSource": 1,
      "globalSpecId": 71,
      "deleteFlag": 0,
      "adPlanId": 200004883,
      "adGroupId": 300012658,
      "adFlag": 3,
      "copywriter": "朋友家的消毒剂，我惊呆了！这里免费领取",
      "copywriterId": 1719774,
      "brandName": "测试",
      "buttonTxt": "打开",
      "imgMats": [
        {
          "materialUrl": "https://adsfs.heytapimage.com/ads-material-depot/image/13f0425cdaf68684deebddffd3033698.jpg",
          "mid": 26720068
        }
      ],
      "exposeUrl": "",
      "clickUrl": "",
      "playBeginUrl": "",
      "playEndUrl": "",
      "downloadUrl": "",
      "dynamicCr": 0,
      "interactCr": 0,
      "insertTime": 1638326605,
      "updateTime": 1638326605
    }
  ]
}

2 编辑广告创意
备注：这是一个批量接口，可以批量操作同一个广告组下面的广告创意，包含新增/编辑/删除等操作，可以同时进行。
下面基于原有的广告组下面的创意的基础上，添加一个创意，并删除一个创意。
请求地址：

/v3/ad/batch

请求参数：

addList[0].adGroupId: 300012658
addList[0].adName: 新增创意1
addList[0].adPlanId: 200004883
addList[0].adSource: 1
addList[0].brandLogoImgId:
addList[0].dynamicCr: 0
addList[0].copywriterId: 0
addList[0].globalSpecId: 5
addList[0].imgMatIds: 45441920
editList[0].adGroupId: 300012658
editList[0].adName: 测试创意2
editList[0].adPlanId: 200004883
editList[0].adSource: 1
editList[0].brandName: 测试
editList[0].buttonTxt: 打开
editList[0].copywriter: 朋友家的消毒剂，我惊呆了！这里免费领取
editList[0].dynamicCr: 0
editList[0].copywriterId: 1719774
editList[0].globalSpecId: 71
editList[0].imgMatIds: 26720068
editList[0].adId: 404941869
delList[0].adGroupId: 300012658
delList[0].adId: 400035867

SDK请求方法：（使用SDK接入）

omniAds.ads().v3AdBatch(data

SDK请求参数：

/**
 * 必传参数
 * 1.新增广告列表时必传  List<AdsAdCollectReq> addList
 * a. String adName 广告名称
 * b. Integer globalSpecId 统一规格ID
 * c. Long adPlanId 计划ID
 * d. Long adGroupId 广告组ID
 * 2.编辑广告列表时必传  List<AdsAdCollectReq> editList
 * a.Long adId 广告ID
 * b.Long adPlanId 计划ID
 * c.Long adGroupId 广告组ID
 * 3.删除广告列表时必传  List<AdsAdDelReq> delList
 * a. Long adId 广告ID
 */

2.5 通用-根据配置类型获取配置项

/v3/communal/config/getList用在很多元数据配置查询的地方，需要注意的是大部分配置受权限控制。

1 获取推广目的
请求地址：

/v3/communal/config/getList

请求参数：

type=EXTENSION_TYPE

SDK请求方法：（使用SDK方法接入）

omniAds.adsCommunal().v3CommunalConfigGetList(data)

SDK请求参数：

/** 
 *  AdsConfigReq data参数
 * 1.String type 配置类型，获取配置列表，配置类型不能为空，EXTENSION_TYPE：推广目的，EXTENSION_FLOW：推广流量，FLOW_SCENE：流量场景，BILLING_TYPE：出价方式，OCPC_TYPE：转化类型，DEEP_OCPC_TYPE：深度转化类型，SPEC_TYPE：规格，URL_TYPE：监测链接，SMART_EXPAND_TYPE；智能拓量，FIREFLY_APP_DOWN_PAGE：萤火虫应用下载页，PAGE_TYPE：落地页类型，REQUIRED_SPEC_TYPE：全流量必填规格
 * 2.List<String> typeList 配置类型列表，批量获取配置项，配置类型列表不能为空
 * 3.Integer extensionType 推广目标 1：链接推广 2：应用推广 3: 快应用推广 7: 小程序推广 --非必须
 * 4.Integer extensionFlow 推广流量：1-全流量场景，2-自有流量，3-联盟流量 --非必须
 * 5.Integer flowScene     流量场景：1-全流量场景，2-精选推广，3-安装有礼，4-开机必备，5-搜索，6-信息流，7-Banner，8-开屏，9-插屏，10-原生，11-激励视频，12-联盟通投。修改出价，流量场景不能为空 --非必须
 * */响应报文：
{
  "code": 0,
  "data": [
    {
      "value": "2",
      "ext": {
        "name": "应用推广",
        "value": 2
      }
    },
    {
      "value": "1",
      "ext": {
        "name": "网页推广",
        "value": 1
      }
    },
    {
      "value": "3",
      "ext": {
        "name": "快应用推广",
        "value": 3
      }
    }
  ]
}

2 获取推广目的下支持的推广流程

请求地址：

/v3/communal/config/getList

请求参数：

type=EXTENSION_FLOW
extensionType=1

响应报文：

{
  "code": 0,
  "data": [
    {
      "value": "2",
      "ext": {
        "name": "自有流量",
        "value": 2
      }
    },
    {
      "value": "3",
      "ext": {
        "name": "联盟流量",
        "value": 3
      }
    }
  ]
}

3 获取推广目的+推广流量下对应的流量场景：
请求地址：

/v3/communal/config/getList

请求参数：

type=FLOW_SCENE
extensionType=1
extensionFlow=2

响应报文：

{
  "code": 0,
  "data": [
    {
      "value": "5",
      "ext": {
        "name": "搜索",
        "value": 5
      }
    },
    {
      "value": "6",
      "ext": {
        "name": "信息流",
        "value": 6
      }
    }
  ]
}

4 获取流量场景下支持的计费类型
请求地址：

/v3/communal/config/getList

请求参数：

type=BILLING_TYPE
flowScene=6
extensionType=1

响应报文：

{
  "code": 0,
  "data": [
    {
      "value": "2",
      "ext": {
        "name": "CPC",
        "value": 2
      }
    },
    {
      "value": "5",
      "ext": {
        "name": "oCPC",
        "value": 5
      }
    }
  ]
}

5 获取流量场景下对应的ocpx转化类型
请求地址：

/v3/communal/config/getList

请求参数：

type=OCPC_TYPE
extensionType=1
flowScene=6

响应报文：

{
  "code": 0,
  "data": [
    {
      "value": "5-6",
      "ext": {
        "name": "线索提交",
        "value": 6,
        "billingType": 5
      }
    }
  ]
}

6 获取流量场景下支持的深度转化类型
请求地址：

/v3/communal/config/getList

请求参数：

type:DEEP_OCPC_TYPE
extensionType:2
extensionFlow:3
flowScene:12

响应报文：

{
  "code": 0,
  "data": [
    {
      "value": "2-8",
      "ext": "{\"name\":\"回传激活\",\"value\":8,\"ocpcType\":2,\"ocpcOptmType\":2}"
    },
    {
      "value": "2-7",
      "ext": "{\"name\":\"注册\",\"value\":7,\"ocpcType\":2,\"ocpcOptmType\":2}"
    },
    {
      "value": "4-5",
      "ext": "{\"name\":\"游戏付费\",\"value\":5,\"ocpcType\":4,\"ocpcOptmType\":1}"
    },
    {
      "value": "8-10",
      "ext": "{\"name\":\"回传留存\",\"value\":10,\"ocpcType\":8,\"ocpcOptmType\":1}"
    },
    {
      "value": "8-15",
      "ext": "{\"name\":\"系统留存\",\"value\":15,\"ocpcType\":8,\"ocpcOptmType\":1}"
    }
  ]
}

7 获取流量场景下支持的落地页类型

请求地址：

/v3/communal/config/getList

请求参数：

type=PAGE_TYPE
extensionFlow=2
extensionType=1
flowScene=6

响应报文：

{
  "code": 0,
  "data": [
    {
      "value": "4",
      "ext": {
        "name": "萤火虫建站",
        "value": 4
      }
    },
    {
      "value": "0",
      "ext": {
        "name": "自定义落地页",
        "value": 0
      }
    },
    {
      "value": "6",
      "ext": {
        "name": "JS线索投放",
        "value": 6
      }
    },
    {
      "value": "7",
      "ext": {
        "name": "API线索投放",
        "value": 7
      }
    }
  ]
}




3.【推广】计划管理

3.1 添加单个计划信息

基本信息

Path： /v3/plan/add

Method： POST

接口描述：

请求实例：

extensionType=2
dayBudget=155500
deliveryMode=0
planName=%E5%BA%94%E7%94%A8%E6%8E%A8%E5%B9%BF_2021%2F07%2F20_14%3A34%3A11
dayLimit=1

响应报文：

{
  "code": 0,
  "data": {
    "planId": 200163758
  }
}

SDK请求方法：（使用SDK方法接入）

omniAds.adsPlan().v3PlanAdd(data)

SDK请求参数：

AdsPlanAddForm data必传参数
data.setXXX;
 1.String planName        计划名称长度必须在1-100字符之间
 2.Integer extensionType  推广目标 1：链接推广  2：应用推广-应用下载  3：快应用推广  6：应用推广-应用调起  7：小程序推广  8：直播推广
 3.Integer dayLimit       是否限制日预算 0 不限制 1 限制, 当dayLimit=1时dayBudget必填
 4.Long dayBudget      日预算 (限制日预算时必填 单位（分）
 5.deliveryMode        竞价策略0-稳定成本 1-最大转化 （预算不能设置不限）

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
dayBudget 否 日预算 (限制日预算时必填 单位（分）)
dayLimit 是 是否限制日预算 0 不限制 1 限制, 当dayLimit=1时dayBudget必填
extensionType 是 推广目标 1：链接推广 2：应用推广-应用下载 3：快应用推广 6：应用推广-应用调起 7：小程序推广 8：直播推广
planName 是 计划名称 最大长度不能超过100字符
deliveryMode 否 0 竞价策略0-稳定成本 1-最大转化 （预算不能设置不限）

返回数据

名称类型必须默认值备注
code
integer否
data
object否
planId
integer否广告计划ID
msg
string否

3.2 批量设置或修改日预算

基本信息

Path： /v3/plan/dayBudget

Method： POST

接口描述：

请求实例：

planIds=200012330,200014945
dayBudget=22225200
dayLimit=1

响应参数：

{
    "code": 0,
    "data": [
        {
            "planId": 200014945,
            "planName": "编辑网页推广_2021/07/19_19:06:38",
            "leftTimes": 7,
            "totalTimes": 10,
            "ret": 0,
            "msg": null
        },
        {
            "planId": 200012330,
            "planName": "应用推广_2021/07/15_14:16:55",
            "leftTimes": 8,
            "totalTimes": 10,
            "ret": 0,
            "msg": null
        }
    ]
}

SDK请求方法：（使用SDK方法接入）

omniAds.adsPlan().v3PlanDayBudget(data)

SDK请求参数：

AdsPlanBudgetForm data
data.setXxx;
 1.List<Long> planIds 计划 planIds 不能为空
 2.Long dayBudget 日预算 (dayLimit=1 时dayBudget必填  单位（分）)
 3.Integer dayLimit       是否限制日预算 0 不限制 1 限制, 当dayLimit=1时dayBudget必填

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
dayBudget 否 日预算 (dayLimit=1 时dayBudget必填 单位（分）)
dayLimit 是 是否限制日预算 0 不限制 1 限制
planIds 是 计划ids 多个id以逗号分隔

返回数据

名称类型必须默认值备注
code
integer否
data
object []否
leftTimes
integer否剩余次数
msg
string否失败原因, 冗余信息
planId
integer否计划id
planName
string否计划名称
ret
integer否更新是否成功 0 成功 1 失败
totalTimes
integer否总次数
msg
string否

3.3 批量删除计划

基本信息

Path： /v3/plan/delete

Method： POST

接口描述：

请求实例：

planIds=200011041,200012235

响应报文：

{
    "code": 0
}

SDK请求方法：（使用SDK方法接入）

omniAds.adsPlan().v3PlanDelete(planIds)

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
planIds 是 200011041,200012235 计划ids 多个id以逗号分隔

返回数据

名称类型必须默认值备注
code
integer否
data
object []否
leftTimes
integer否剩余次数
msg
string否失败原因, 冗余信息
planId
integer否计划id
planName
string否计划名称
ret
integer否更新是否成功 0 成功 1 失败
totalTimes
integer否总次数
msg
string否

3.4 编辑单个计划信息

基本信息

Path： /v3/plan/edit

Method： POST

接口描述：

请求实例：

planIds=200011041,200012235
extensionType=1
dayBudget=22222200
planName=%E7%BC%96%E8%BE%91%E7%BD%91%E9%A1%B5%E6%8E%A8%E5%B9%BF_2021%2F07%2F19_19%3A06%3A38
dayLimit=1
planId=200008991

响应报文：

{
    "code": 0,
    "data": {
        "planId": 200008991,
        "planName": "应用推广_2021/07/12_15:32:121111",
        "leftTimes": 9,
        "totalTimes": 10,
        "ret": 0,
        "msg": null
    }
}

SDK请求方法：（使用SDK方法接入）

omniAds.adsPlan().v3PlanEdit(data);

SDK请求参数：

/**
 * AdsPlanEditForm data 必传参数
 * 1. Long planId       计划id (修改单个广告使用)
 * 2. String planName   计划名称 (修改名称时必传)，计划名称长度必须在1-100字符之间
 * 非必传参数
 * 1. Integer dayLimit  是否限制日预算 0 不限制 1 限制 (修改预算时必传)
 * 1.1  Long dayBudget  日预算 (dayLimit=1 时dayBudget必填 必须为整数 单位（分）
 */

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
dayBudget 否 日预算 (dayLimit=1 时dayBudget必填 必须为整数 单位（分）)
dayLimit 否 是否限制日预算 0 不限制 1 限制 (修改预算时必传)
planId 是 计划id (修改单个广告使用)
planName 否 计划名称 (修改名称时必传)

返回数据

名称类型必须默认值备注
code
integer否
data
object否
leftTimes
integer否剩余次数
msg
string否失败原因, 冗余信息
planId
integer否计划id
planName
string否计划名称
ret
integer否更新是否成功 0 成功 1 失败
totalTimes
integer否总次数
msg
string否

3.5 获取单个计划信息

基本信息

Path： /v3/plan/get

Method： GET

接口描述：

status字段是按照二进制位来表示内容含义的，下面表格的数字代表是第几个二进制位：

status
二进制位 解释
0 计划暂停
1 余额不足
2 达到计划预算
3 达到账户预算
8 广告组暂停
9 未开始
10 已结束
11 不在推广时段
12 App下架
13 App等级低
14 App版本过低
15 App已删除
16 快应用下架
17 必填规格异常
24 广告暂停

showStatus字段含义：
0 启动中
1 暂停中
2 余额不足
3 达到账户预算
4 达到计划预算

请求实例：

planId=200012330

响应报文：

{
  "code": 0,
  "data": {
    "planId": 200012330,
    "status": 2,
    "extensionType": 2,
    "deleteFlag": 0,
    "planName": "应用推广_2021/07/15_14:16:55",
    "dayLimit": 0,
    "dayBudget": "9999999999999",
    "showStatus": 2,
    "status2": 0,
    "statusName": "余额不足"
  }
}

SDK请求方法：（使用SDK方法接入）

omniAds.adsPlan().v3PlanGet(planId)

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
planId 是 计划Id

返回数据

名称类型必须默认值备注
code
integer否
data
object否
dayBudget
integer否计划日预算（分）
dayLimit
integer否是否限额0不限制 1限制
deleteFlag
integer否删除状态
extensionType
integer否推广目标 1：链接推广 2：应用推广-应用下载 3：快应用推广 6：应用推广-应用调起 7：小程序推广 8：直播推广
extensionTypeName
string否推广目标名称
planId
integer否广告计划ID
planName
string否广告计划名称
showStatus
integer否前端展示状态
showStatusName
string否前端展示状态描述
status
integer否详细状态
status2
integer否投放开关 0-开启 1-关闭
subShowStatusName
string否详细状态描述
insertTime
integer否插入时间(秒级时间戳)
updateTime
integer否更新时间(秒级时间戳)
msg
string否

3.6 批量启停计划

基本信息

Path： /v3/plan/status

Method： POST

接口描述：

SDK请求方法：（使用SDK方法接入）

omniAds.adsPlan().v3PlanStatus(data);

SDK请求参数:

AdsPlanStatusForm data 参数
data.setXxx;
   List<Long> planIds  计划ids 多个id以逗号分隔  必传
   Integer status2     投放开关标识 0-开 1-关    必传


**请求实例：**

planIds=200012239,200012238
dayBudget=40000
dayLimit=1



响应报文：


{
&nbsp; "code": 0,
&nbsp; "data": [
&nbsp;&nbsp;&nbsp; {
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; "planId": 200012239,
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; "planName": "测试计划",
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; "leftTimes": 8,
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; "totalTimes": 10,
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; "ret": 0
&nbsp;&nbsp;&nbsp; },
&nbsp;&nbsp;&nbsp; {
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; "planId": 200012238,
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; "planName": "应用推广_2021/07/13_11:26:16",
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; "leftTimes": 8,
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; "totalTimes": 10,
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; "ret": 0
&nbsp;&nbsp;&nbsp; }
&nbsp; ]
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
planIds 是 200011041,200012235 计划ids 多个id以逗号分隔
status2 是 投放开关标识 0-开 1-关

返回数据

名称类型必须默认值备注
code
integer否
data
object []否
leftTimes
integer否剩余次数
msg
string否失败原因, 冗余信息
planId
integer否计划id
planName
string否计划名称
ret
integer否更新是否成功 0 成功 1 失败
totalTimes
integer否总次数
msg
string否

3.7 分页查询广告计划列表

基本信息

Path： /v3/plan/page

Method： POST

接口描述：

特别说明：计划、广告组、广告分页查询接口返回的数据字段具有共性，因此返回的数据字段请参考API文档：公共部分 -> 对接必读 -> 1.9节

SDK请求方法：（使用SDK方法接入）

omniAds.adsPlan().v3PlanPage(data)

SDK请求参数：

AdsPlanDataReq data；
data.setXxx;

String planNameLike;          广告计划名称

Set<Integer> extensionTypes;  推广目标列表 推广目标枚举值 1：链接推广  2：应用推广-应用下载  3：快应用推广  6：应用推广-应用调起  7：小程序推广  8：直播推广 (选择多个目标以逗号分隔)

Set<Integer> showStatusSet;   展示状态列表，启动中-0 暂停中-1 广告组暂停-2 计划暂停-3 (多个id以逗号分隔)

Integer deleteFlag = 0;       是否删除，0-未删除，1-删除

Set<Long> planIds;            广告计划ID列表 多个id以逗号分隔

Long beginTime;               开始日期，格式：YYYYMMDD

Long endTime;

String asc;                   排序方式，ASC-顺序 DESC-逆序

Integer page;                 分页查询起始页，起始页从1开始,页码必须大于等于1       必传

Integer limit;                分页大小                                           必传


Long dayBudgetFloor;          日预算下限

Long dayBudgetCeiling;        日预算上限


@ApiParam(value = "消耗金额下限", hidden = true)

private String costFloor;

@ApiParam(value = "消耗金额上限", hidden = true)

private String costCeiling;

@ApiParam(value = "曝光量下限", hidden = true)

private String exposeFloor;

@ApiParam(value = "曝光量上限", hidden = true)

private String exposeCeiling;

@ApiParam(value = "点击量下限", hidden = true)

private String clickFloor;

@ApiParam(value = "点击量上限", hidden = true)

private String clickCeiling;

@ApiParam(value = "点击率下限", hidden = true)

private String clickRateFloor;

@ApiParam(value = "点击率下限", hidden = true)

private String clickRateCeiling;

@ApiParam(value = "下载量下限", hidden = true)

private String downloadFloor;

@ApiParam(value = "下载量上限", hidden = true)

status字段是按照二进制位来表示内容含义的，下面表格的数字代表是第几个二进制位：

status
二进制位 解释
0 计划暂停
1 余额不足
2 达到计划预算
3 达到账户预算
8 广告组暂停
9 未开始
10 已结束
11 不在推广时段
12 App下架
13 App等级低
14 App版本过低
15 App已删除
16 快应用下架
17 必填规格异常
24 广告暂停

showStatus字段含义：
0 启动中
1 暂停中
2 余额不足
3 达到账户预算
4 达到计划预算

请求实例：

extensionType=2
dayLimit=1
page=1
limit=1
deleteFlag=0

响应报文：

{
  "code": 0,
  "data": {
    "pageNum": 1,
    "pageSize": 1,
    "total": 458,
    "totalPage": 458,
    "records": [
      {
        "showStatus": 2,
        "showStatusName": "余额不足",
        "status2": 0,
        "deleteFlag": 0,
        "planId": 200014945,
        "planName": "网页推广_2021/07/19_19:06:38",
        "extensionType": 1,
        "extensionTypeName": "网页推广",
        "dayBudget": "不限"
      }
    ]
  }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
asc 否 排序方式，ASC-顺序 DESC-逆序
beginTime 否 开始日期，格式：YYYYMMDD
deleteFlag 否 是否删除，0-未删除，1-删除
endTime 否 结束日期，格式：YYYYMMDD
extensionTypes 否 推广目标列表
推广目标枚举值 1：链接推广 2：应用推广-应用下载 3：快应用推广 6：应用推广-应用调起 7：小程序推广 8：直播推广 (选择多个目标以逗号分隔)
limit 是 页大小 最大只支持1000
orderByColumn 否 排序的列
计划日预算 dayBudget
计划Id planId
计划名称 planName
page 是 分页查询起始页，起始页从1开始
planIds 否 广告计划ID列表 多个id以逗号分隔
planNameLike 否 广告计划名称
showStatusSet 否 展示状态列表，0: 计划启动中 1: 计划暂停 2: 账户余额不足 3: 账户预算不足 4: 计划预算不足 (多个id以逗号分隔)
needStats 否 0 是否查询数据字段，0表示不查询，1表示查询（推荐使用0以提高性能）

返回数据

名称类型必须默认值备注
code
integer否
data
object否
pageNum
integer否页码
pageSize
integer否每页大小
records
object []否数据集合
click
string否点击量
clickRate
string否点击率
convertActive
string否回传激活量
convertActivePrice
string否回传激活成本
convertAppCredit
string否应用内授信
convertAppCreditPrice
string否应用内授信成本
convertAppCustom
string否应用内自定义转化
convertAppCustomPrice
string否应用内自定义转化成本
convertAppOrder
string否应用内下单（电商）
convertAppOrderPrice
string否应用内下单（电商）成本
convertAppPay
string否应用内付费
convertAppPayPrice
string否应用内付费成本
convertDp
string否回传拉活
convertDpPrice
string否回传拉活成本
convertRegister
string否注册量
convertRegisterPrice
string否注册成本
convertRetention
string否回传留存
convertRetentionPrice
string否回传留存成本
cost
string否消耗金额 单位（分）
dayBudget
string否计划日预算 单位（分）
deleteFlag
integer否删除状态
download
string否下载量
downloadRate
string否下载率
dpAppCreditNums
string否deeplink应用内授信量
dpAppCreditPrice
string否deeplink应用内授信成本
dpAppOrderNums
string否deeplink应用内下单量
dpAppOrderPrice
string否deeplink应用内下单成本
dpAppPayNums
string否deeplink应用付费量
dpAppPayPrice
string否deeplink应用付费成本
dpConvertActivationNums
string否deeplink回传激活量
dpConvertActivationPrice
string否deeplink回传激活成本
dpConvertRegisterNums
string否deeplink回传注册量
dpConvertRegisterPrice
string否deeplink回传注册成本
dpUdConvertNums
string否deeplink自定义转化量
dpUdConvertPrice
string否deeplink自定义转化成本
ecpm
string否ecpm
expose
string否曝光量
extensionFlow
integer否推广流量
extensionFlowName
string否推广流量名称
extensionType
integer否推广目标 1：链接推广 2：应用推广-应用下载 3：快应用推广 6：应用推广-应用调起 7：小程序推广 8：直播推广
extensionTypeName
string否推广目标名称
formCnt
string否表单提交量
formCntPrice
string否表单提交成本
planId
integer否广告计划ID
planName
string否广告计划名称
quickAppPay
string否快应用付费
quickAppPayPrice
string否快应用付费成本
showStatus
integer否前端展示状态
showStatusName
string否前端展示状态描述
status
integer否详细状态
statusName
string否详细状态描述，与subShowStatusName一致
status2
integer否投放开关，0-开启，1-关闭
subShowStatusName
string否详细状态描述
pacingStatus
integer否匀速投放类型，0-关闭匀速投放，1-开启匀速投放
deliveryMode
integer否竞价策略，0-稳定成本，1-最大转化
deliveryModeName
string否竞价策略名称
budgetLimit
integer否预算类型，0-不限预算，1-限制预算
insertTime
integer否插入时间(秒级时间戳)
updateTime
integer否更新时间(秒级时间戳)
total
integer否数据总条数
totalPage
integer否总页数
msg
string否

4.【推广】广告组管理

4.0 广告组接口基础字段说明

基本信息

Path： /4.0

Method： GET

接口描述：

1. 流量场景，字段名：flowScene

字段值 含义描述 字段值 含义描述
1 全流量场景 11 激励视频
2 精选推荐 12 联盟通投
3 安装有礼 13 展示优选
4 开机必备 14 通知栏
5 搜索 15 网络消息
6 信息流
7 Banner
8 开屏
9 插屏
10 原生

2. 推广流量，字段名：extensionFlow

字段值 含义描述
1 全流量场景
2 自有流量
3 联盟流量

3. 广告组扩展字段，字段名：extJson

通过K-V形式存储广告组扩展信息，示例：

{"PUSH_BEGIN_END_TIME":"20240408_20240409","PUSH_TIME_SET":"{\"1\":\"1,2\",\"2\":\"1,2\",\"3\":\"1,2,8,9\",\"4\":\"8,9\",\"5\":\"8,9\",\"6\":\"\",\"7\":\"\"}"}

下面针对扩展字段中的key，value进行说明：

扩展字段-Key 扩展字段-Value
PUSH_BEGIN_END_TIME 流量场景：通知栏、网络消息下的消息可下发日期
格式：下发开始日期 + "_" + 下发结束日期
示例：20240408_20240409
说明：不传即表示不限制日期
PUSH_TIME_SET 流量场景：通知栏、网络消息下的消息可下发时段
格式：下发时段为map结构，key为星期，取值为1~7，value表示当天的小时数，取值为0~23，为空表示当天不可播
示例：{"1":"0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23","2":"","3":"8,9,10,11,12","4":"","5":"","6":"","7":""}，其中"1":"0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23"，表示星期一全部时间段都可以投放，"2":""，表示星期二全天的时间段都不可投放
说明：不传即表示不限制时段
SMS_SERVICE_ID 流量场景：网络消息下的服务号
示例：65fa9061e4b090cb98ac5a41

备注：

4. 广告组转化类型、深度转化类型

说明：广告组转化类型、深度转化类型共用一套枚举值，通过配置来区分是转化类型还是深度转化类型

字段值 含义描述 字段值 含义描述 字段值 含义描述
0 默认 16 回传激活（DP） 32 快应用关键行为
1 APP下载 17 回传注册（DP） 33 --已废弃
2 APP激活 18 应用付费（DP） 34 回传留存率（DP拉活）
3 --已废弃 19 应用内自定义转化（DP） 35 游戏关键行为
4 游戏注册 20 应用内授信（DP） 36 微信小游戏注册
5 游戏付费 21 应用内下单（DP） 37 微信小游戏付费
6 表单注册 22 快应用付费 38 每次付费
7 注册 23 游戏付费ROI1 39 回传留存率
8 回传激活 24 -- 40 应用付费率
9 应用付费 25 回传留存（DP拉活） 41 游戏变现ROI1
10 回传留存 26 系统新增激活 42 游戏变现ROI7
11 --已废弃 27 --已废弃 43 游戏预约
12 应用内授信 28 --已废弃 44 长留自定义
13 --已废弃 29 --已废弃 45 每次付费
14 deepLink拉活 30 --已废弃 46 变现ROI14
15 系统留存 31 --已废弃 47 快应用变现ROI1




4.1 添加单个广告组

基本信息

Path： /v3/group/add

Method： POST

接口描述：

注意：竞价策略为最大转化的计划 出价信息不需填写（price ocpcPrice deepOcpcPrice targetROI）

【创建广告组demo实例见：典型场景举例 ——> 广告组-新建应用下载模板页广告组】

SDK接入，请求方法：

omniAds.adsGroup().v3GroupAdd(data);

SDK请求参数：

AdsGroupAddForm data;
data.setXxx;

1.String adGroupName 广告组名称，长度为1-100个字符

2.Long planId        计划ID

3.String pageUrl     广告h5落地链接（链接,应用,快应用推广同样作用）选择下载浮层或者F版的落地链接类型，需要将当前广告的目标落地链接URLencode之后，组装在下载浮层的URL地址后面，链接推广、快应用推广时必填。若为萤火虫应用下载模板页，则传递模板url，可通/v3/communal/h5Template/list接口获取模板id和url，也可参考《典型场景举例-新建应用下载模板页广告组》

4.Integer extensionType  标的物类型 1：链接推广  2：应用推广-应用下载  3：快应用推广  6：应用推广-应用调起  7：小程序推广  8：直播推广

5.Integer extensionFlow  推广流量，详情见：4.0广告组接口基础字段说明

6.Integer flowScene      流量场景，详情见：4.0广告组接口基础字段说明

7.Integer dayLimit       推广日期限制 0-不限制推广日期 1-限制推广日期，当为1时，beginTime和endTime必传

推广开始时间 Integer beginTime 格式：YYYYMMDD

推广截止时间 Integer endTime   格式：YYYYMMDD

8.Integer billingType    计费方式.1:CPD 2:CPC 3:CPM 4:CPS 5:OCPC 6:CPA

在新增广告组前，需调用一下接口，获取必要的信息，在调用新增广告组接口时，作为参数传递给新增接口：

元数据配置相关：
1）查询应用、快应用历史列表：/v2/communal/group/listHistoryAppInfo
2）获取推广目的配置：/v3/communal/config/getList?type=EXTENSION_TYPE
3）获取推广流量配置：/v3/communal/config/getList?type=EXTENSION_FLOW&extensionType=2
4）获取特定推广流量配置：/v3/communal/config/getList?type=FLOW_SCENE&extensionType=2&extensionFlow=1
通过传入的type、extensionType、extensionFlow获取对象的元数据配置

获取出价配置：
1）/v3/communal/interval/config/groupPrice
通过flowScene、ocpcType获取对应场景的出价配置

获取定向相关：
1）获取定向列表：/v2/communal/target/list
2）查询定向详情：/v2/communal/target/get
3）省市查询接口：/v2/communal/target/provinceAndCityMapping
4）查询定向相关数据和用户权限：/v2/communal/target/get/metadataV2?extensionType=2&flowScene=1

获取关键词相关接口：
1）查询行业词包：/v3/communal/searchKeyWord/listCategoryKws

获取应用信息：
1）查询应用信息：/v2/communal/group/appInfo
2）查询快应用信息：/v2/communal/instant/appInfo

落地页建站相关：
1）查询建站落地页列表：/v2/communal/ad/sparkPageNew/list
2）获取模板列表：/v3/communal/h5Template/list
3）deeplink校验接口：/v3/communal/deeplink/validate

详细示例可参考《典型应用场景举例》

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
adGroupName 是 广告组名称
adSearchPremiumKwSaveDTOList[0].categoryId 否 行业类目ID(当在添加出价类目词包时必传)
adSearchPremiumKwSaveDTOList[0].keyword 否 关键词 or 行业类目名称，网页推广-搜索，关键词或词包信息必填
adSearchPremiumKwSaveDTOList[0].matchType 否 匹配类型 1:精准匹配 2:词组匹配 3:模糊匹配
adSearchPremiumKwSaveDTOList[0].price 否 出价，必须大于0（单位：分）
adSearchPremiumKwSaveDTOList[0].source 否 来源 2:出价类目词包 5:广告主手动上传(出价词包)
adSearchPremiumKwSaveDTOList[0].kwPackageId 否 添加自定义词包或禁推词包的词包Id
adSearchPremiumKwSaveDTOList[0].kwPackageType 是 词包类型，1：自定义词包，2：禁推词包
appId 否 应用id，应用推广时必填
autoOpenFlag 否 下载并打开 0-未开启 1-开启
beginTime 否 推广开始时间，格式：YYYYMMDD
billingType 是 计费方式.1:CPD 2:CPC 5:OCPX
dayLimit 是 推广日期限制 0-不限制推广日期 1-限制推广日期，当为1时，beginTime和endTime必传
deepOcpcPrice 否 深度ocpc转化出价（单位：分） 竞价策略为最大转化的计划 该参数不需要传
deepOcpcType 否 深度ocpc转换类型，详情见：4.0广告组接口基础字段说明
deepUrl 否 直达链接
备注：当flowScene=14（通知栏）时，deepUrl传值为应用内页
endTime 否 推广截止时间，格式：YYYYMMDD
extensionFlow 是 推广流量，详情见：4.0广告组接口基础字段说明
extensionType 是 标的物类型 1：链接推广 2：应用推广-应用下载 3：快应用推广 6：应用推广-应用调起 7：小程序推广 8：直播推广
flowScene 是 流量场景，详情见：4.0广告组接口基础字段说明
instantAppId 否 快应用Id，快应用推广时必填
instantAppUrl 否 快应用落地链接，快应用推广时必填
ocpcOptmType 否 区分ocpc出价类型. 默认为0，0-单出价，1-双出价，2-两阶段
ocpcPrice 否 目标转化出价（单位：分） 竞价策略为最大转化的计划 该参数不需要传
ocpcType 否 目标转化类型，详情见：4.0广告组接口基础字段说明
pageId 否 落地页id。若为萤火虫应用下载模板页，则传递模板id，可通/v3/communal/h5Template/list接口获取模板id和url，也可参考《典型场景举例-新建应用下载模板页广告组》
pageType 否 落地页建站类型: 0：自定义落地页 1：一叶智能 2：云脑建站 4：萤火虫建站 5：快应用建站 6：广告主自建页面 JS SDK 7：H5 API 回传 8：信息流线索直达 9：商店详情页 11：萤火虫应用模板下载页 12：互动落地页
pageUrl 否 广告h5落地链接（链接,应用,快应用推广同样作用）选择下载浮层或者F版的落地链接类型，需要将当前广告的目标落地链接URLencode之后，组装在下载浮层的URL地址后面，链接推广、快应用推广时必填。若为萤火虫应用下载模板页，则传递模板url，可通/v3/communal/h5Template/list接口获取模板id和url，也可参考《典型场景举例-新建应用下载模板页广告组》
planId 是 计划id
price 否 基础出价（单位：分） 竞价策略为最大转化的计划 该参数不需要传
smartExpandType 否 智能扩量-信息流 扩量标示位 0-未扩量 1-广告扩量 2-广告组拓量
targetId 否 定向id
timeLimit 否 推广时段限制，0-不限制推广时段 1-限制推广时段，当为1时，timeSet必传
timeSet 否 推广时段，格式为json字符串，（x-(1-7)对应周一到周日）, 如timeSet=”{‘1’:‘1,2,3’}”表示周一的0:30-1:00,1:00-1:30，1:30-2:00为播放时间, 开始时间不能小于今天
linkDeskFlag 否 是否打开快应用并添加到桌面，1-打开并加桌，0-关闭加桌，默认值为0
注意：必须配置了权限才能设置linkDeskFlag=1
appletType 否 小程序类型 默认为0，1：微信小游戏
kwOcpcPrice 否 广告组 关键词、词包 目标转化出价（单位：分）
kwDeepOcpcPrice 否 广告组 关键词、词包 深度转化出价（单位：分）
kwTargetROI 否 广告组 关键词、词包 目标ROI系数 * 1000000, (0,10]
channelPkgId 否 渠道包ID，必须大于0，渠道包投放，appId为必填，应用必须处于上架状态且等级符合要求
defaultSecondStage 否 是否开启免一阶 1-开启，0-关闭
targetROI 否 广告组目标ROI系数 * 1000000, (0,10] 竞价策略为最大转化的计划 该参数不需要传
adsDpaProductDTO.dpaProductType 否 Integer，商品广告类型，1: sdpa
adsDpaProductDTO.dpaProductLibraryId 否 Long，商品广告-商品库id
adsDpaProductDTO.dpaProductIdList[0] 否 String列表，商品广告-商品id列表
advertiseType 否 广告类型，0-普通广告，1-预约广告，2-商品广告
pushAppPageType 否 流量场景为通知栏时，应用内页的类型，默认值为0，表示不传应用内页，1：INTEND_ACTION，4：ACTIVITY，5：SCHEME_URL
备注：应用内页通过deepUrl参数传值
ocpxOptimizeSwitch 否 0 OCPX自动优化开关，0表示未开启，1表示开启
备注：需要和深度ocpc转换类型搭配使用
ocpxOptimizeType 否 0 OCPX优化类型，默认值为0：表示不使用。
可选项 1：七日留存，2：次留率（优选），3：14日LTV
备注：需要和ocpxOptimizeSwitch搭配使用，仅ocpxOptimizeSwitch=1时可以设置
extJson 否 扩展字段,type-value形式存储广告组扩展信息，详情见：4.0广告组接口基础字段说明

返回数据

名称类型必须默认值备注
code
integer否
data
object否
adGroupId
integer否广告组id
adGroupName
string否广告组名称
adServingType
integer否投放模式 0-普通投放 1-跟随投放
appId
integer否应用id
appName
string否应用名称
appPackage
string否应用包名
appRef
string否app推广渠道标识
auditTime
integer否
autoOpenFlag
integer否下载并打开
beginTime
integer否推广开始时间 YYYYMMDD
billingType
integer否计费方式.1:CPD 2:CPC 5:OCPX
categoryId
integer否应用一级类目
click
integer否0点击量
convertActive
integer否0回传激活
convertActivePrice
string否0回传激活成本
convertAppCredit
integer否0回传应用内授信
convertAppCreditPrice
string否0回传应用内授信成本
convertAppCustom
integer否0回传应用内自定义转化
convertAppCustomPrice
string否0回传应用内自定义转化成本
convertAppOrder
integer否0回传应用内下单（电商）
convertAppOrderPrice
string否0回传应用内下单（电商）成本
convertAppPay
integer否0回传应用内付费
convertAppPayPrice
string否0回传应用内付费成本
convertDp
integer否0回传拉活
convertDpsPrice
string否0回传拉活成本
convertRegister
integer否0回传注册
convertRegisterPrice
string否0回传注册成本
convertRetention
integer否0回传留存
convertRetentionPrice
string否0回传留存成本
cost
integer否0花费
dayLimit
integer否播放日期限制 0 不限 1 限制
deepOcpcPrice
integer否深度ocpc转化出价 竞价策略为最大转化的计划 该参数不需要传
deepOcpcType
integer否深度ocpc转换类型，详情见：4.0广告组接口基础字段说明
deepUrl
string否直达链接
deleteFlag
integer否删除标识
download
integer否0下载量
dynamicPrice
integer否是否为动态出价 1-开启动态出价，0-关闭动态出价，2-不使用动态出价，默认值为2 不使用动态出价
endTime
integer否推广截止时间
expose
integer否0曝光量
extensionFlow
integer否推广流量，详情见：4.0广告组接口基础字段说明
extensionType
integer否推广目的 1：链接推广 2：应用推广-应用下载 3：快应用推广 6：应用推广-应用调起 7：小程序推广 8：直播推广
flowScene
integer否流量场景，详情见：4.0广告组接口基础字段说明
followAppIdList
integer []否跟随appId列表
否
followMaxPrice
integer否更随最高价格
formOrderNums
integer否0formOrderNums
formPrice
string否0formPrice
groupPrice
integer否出价、计费: 0 不支持, 1 支持
insertTime
integer否
instantAppId
integer否快应用AppId
instantAppUrl
string否快应用链接
ocpcOptmType
integer否区分ocpc单出价和双出价. 默认0-单出价，1-双出价
ocpcPrice
integer否目标转化出价 竞价策略为最大转化的计划 该参数不需要传
ocpcType
integer否目标转化类型，详情见：4.0广告组接口基础字段说明
openGroupId
string否openGroupId
pageId
integer否落地页id
pageType
integer否落地页建站类型:1-一叶智能 2-云脑建站 4-萤火虫建站 5-快应用建站 6-广告主自建页面 JS SDK 7-H5 API 回传 8-信息流线索直达
pageUrl
string否目标链接
planId
integer否计划id
planName
string否计划名称
price
integer否基础出价（单位：分） 竞价策略为最大转化的计划 该参数不需要传
secondCategoryId
integer否应用二级类目
showStatus
integer否
smartExpandBreakthrough
string否智能拓量
smartExpandType
integer否智能扩量-信息流 扩量标示位 0：未扩量 1：广告扩量 2：广告组拓量
status
integer否广告组状态
status2
integer否开关状态 0 开启 1 关闭
statusName
string否
subStatusName
string否
targetId
integer否定向id
targetROI
integer否目标ROI系数 * 1000000, (0,10] 竞价策略为最大转化的计划 该参数不需要传
targetSource
integer否定向来源：1-广告组私有定向 2-可复用定向
targetType
integer否标的物类型 1：链接推广 2：应用推广 3: 快应用推广 7: 小程序推广
thirdCategroyId
integer否应用三级类目
timeLimit
integer否播放时段限制 0 不限 1 限制
timeSet
string否推广时段
updateBy
string否
updateHost
string否
updateTime
integer否
webStatus
integer否
msg
string否

4.2 编辑单个广告组

基本信息

Path： /v3/group/edit

Method： POST

接口描述：

注意：竞价策略为最大转化的计划 出价信息不能修改（price ocpcPrice deepOcpcPrice targetROI）
编辑单个广告组：
SDK接入，请求方法：

omniAds.adsGroup().v3GroupEdit(data)

SDK请求参数：

AdsGroupEditForm data;
data.setXxx;
    private Long planId;       必传
    private Long adGroupId;    必传
    private String adGroupName;
    private Long appId;
    private Long pageId;       落地页id。若为萤火虫应用下载模板页，则传递模板id，可通/v3/communal/h5Template/list接口获取模板id和url，也可参考《典型场景举例-新建应用下载模板页广告组》
    private Integer pageType;  地页建站类型: 0：自定义落地页 1：一叶智能 2：云脑建站 4：萤火虫建站 5：快应用建站 6：广告主自建页面 JS SDK " "7：H5 API 回传 8：信息流线索直达 9：商店详情页 11：萤火虫应用模板下载页 12：互动落地页
    private String pageUrl;    广告h5落地链接（链接,应用,快应用推广同样作用）选择下载浮层或者F版的落地链接类型，需要将当前广告的目标落地链接URLencode之后，组装在下载浮层的URL地址后面，链接推广、快应用推广时必填。若为萤火虫应用下载模板页，则传递模板url，可通/v3/communal/h5Template/list接口获取模板id和url，也可参考《典型场景举例-新建应用下载模板页广告组》
    private String deepUrl;    直达链接
    private Integer instantAppId;  快应用Id
    private String instantAppUrl;  快应用落地链接
    private Long targetId;     定向必须大于等于0
    private Integer extensionType;  标的物类型 1：链接推广  2：应用推广-应用下载  3：快应用推广  6：应用推广-应用调起  7：小程序推广  8：直播推广
    private Integer extensionFlow;  推广流量，详情见：4.0广告组接口基础字段说明
    private Integer flowScene;      流量场景，详情见：4.0广告组接口基础字段说明。修改出价，流量场景不能为空
    private Integer dayLimit;       推广日期限制 0-不限制推广日期 1-限制推广日期，当为1时，beginTime和endTime必传
    private Integer beginTime;      格式：YYYYMMDD
    private Integer endTime;
    private String timeSet;         推广时段，格式为json字符串，（x-(1-7)对应周一到周日）, 如timeSet=”{‘1’:‘1,2,3’}”表示周一的0:30-1:00,1:00-1:30，1:30-2:00为播放时间, 开始时间不能小于今天
    private Integer timeLimit;      推广时段限制，0-不限制推广时段 1-限制推广时段，当为1时，timeSet必传
    private Integer groupPrice;     是否支持广告组出价 1-支持，要么不传，要么传1，修改出价信息、落地页信息时groupPrice必填
    private Integer billingType;    计费方式.1:CPD 2:CPC 3:CPM 4:CPS 5:OCPC 6:CPA
    private Integer price;          基础出价（单位：分） 竞价策略为最大转化的计划 价格不需要填写
    private Integer ocpcPrice;      目标转化出价（单位：分）竞价策略为最大转化的计划 价格不需要填写
    private Integer ocpcType;       目标转化类型

请求参数：

planId: 200008260
adGroupId: 300087873
adGroupName: 应用推广_自有流量_2021/07/17_17:34:321
appId: 21279
extensionFlow: 2
flowScene: 3
pageType: 9
pageId: 0
billingType: 5
followMaxPrice:
price: 150
ocpcType: 4
ocpcPrice: 250
deepOcpcType: 5
deepOcpcPrice: 1000
targetId: 834313
ocpcOptmType: 1
extensionType: 2
groupPrice: 1
autoOpenFlag: 0
oldTarget: 1
kwOcpcPrice: 250
kwDeepOcpcPrice: 1000
kwTargetROI: 4

响应报文：

{
    "code": 0, 
    "data": {
        "adGroupId": 300094341, 
        "adGroupName": "应用推广_自有流量_2021/08/04_9:56:16", 
        "leftTimes": null, 
        "totalTimes": null, 
        "ret": 0, 
        "msg": null, 
        "minPrice": null, 
        "maxPrice": null, 
        "modifyType": null, 
        "groupUpdateInfos": [
            {
                "adGroupId": 300094341, 
                "adGroupName": null, 
                "leftTimes": 9, 
                "totalTimes": 10, 
                "ret": 0, 
                "msg": null, 
                "minPrice": null, 
                "maxPrice": null, 
                "modifyType": 5
            }
        ]
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
adGroupId 是 广告组id
adGroupName 否 广告组名称，长度限制为1~100个字符
adSearchPremiumKwSaveDTOList[0].categoryId 否 行业类目ID(当在添加出价类目词包时必传)
adSearchPremiumKwSaveDTOList[0].keyword 是 关键词 or 行业类目名称(搜索关键词添加和删除时都必填)，网页推广-搜索，关键词或词包不能全部删除
adSearchPremiumKwSaveDTOList[0].matchType 否 匹配类型 1:精准匹配 2:词组匹配 3:模糊匹配
adSearchPremiumKwSaveDTOList[0].price 否 出价，必须大于0（单位：分）添加关键词时必填
adSearchPremiumKwSaveDTOList[0].source 否 来源 2:出价类目词包 5:广告主手动上传(出价词包)
adSearchPremiumKwSaveDTOList[0].deleteFlag 否 0 删除标记 0:未删除 1:已删除 如果传了1，则必须同时传kwPackageId
adSearchPremiumKwSaveDTOList[0].kwPackageId 否 123321 关键词所属的词包Id，仅删除关键词时必填
appId 否 应用id
autoOpenFlag 否 下载并打开 0-未开启 1-开启
beginTime 否 推广开始时间，格式：YYYYMMDD
billingType 否 计费方式.1:CPD 2:CPC 5:OCPX
dayLimit 否 推广日期限制 0-不限制推广日期 1-限制推广日期，当为1时，beginTime和endTime必传
deepOcpcPrice 否 深度ocpc转化出价（单位：分） 竞价策略为最大转化的计划 广告组深度转化出价不允许修改
deepOcpcType 否 深度ocpc转换类型，详情见：4.0广告组接口基础字段说明
deepUrl 否 直达链接
备注：当flowScene=14（通知栏）时，deepUrl传值为应用内页
endTime 否 推广截止时间，格式：YYYYMMDD
extensionFlow 否 推广流量，详情见：4.0广告组接口基础字段说明
extensionType 否 标的物类型 1：链接推广 2：应用推广-应用下载 3：快应用推广 6：应用推广-应用调起 7：小程序推广 8：直播推广
flowScene 否 流量场景，详情见：4.0广告组接口基础字段说明。修改出价，流量场景不能为空
groupPrice 否 是否支持广告组出价 1-支持，要么不传，要么传1，修改出价信息、落地页信息时groupPrice必填
instantAppId 否 快应用Id
instantAppUrl 否 快应用落地链接
ocpcOptmType 否 区分ocpc出价类型. 默认为0，0-单出价，1-双出价，2-两阶段
ocpcPrice 否 目标转化出价（单位：分） 竞价策略为最大转化的计划 广告组转化出价不允许修改
ocpcType 否 目标转化类型，详情见：4.0广告组接口基础字段说明
pageId 否 落地页id
pageType 否 落地页建站类型: 0：自定义落地页 1：一叶智能 2：云脑建站 4：萤火虫建站 5：快应用建站 6：广告主自建页面 JS SDK 7：H5 API 回传 8：信息流线索直达 9：商店详情页 11：萤火虫应用模板下载页 12：互动落地页
pageUrl 否 广告h5落地链接（链接,应用,快应用推广同样作用）选择下载浮层或者F版的落地链接类型，需要将当前广告的目标落地链接URLencode之后，组装在下载浮层的URL地址后面，链接推广、快应用推广时必填
planId 是 计划id
price 否 基础出价（单位：分）竞价策略为最大转化的计划 广告组基础出价不允许修改
smartExpandType 否 智能扩量-信息流 扩量标示位 0-未扩量 1-广告扩量 2-广告组拓量
targetId 否 定向id
timeLimit 否 推广时段限制，0-不限制推广时段 1-限制推广时段，当为1时，timeSet必传
timeSet 否 推广时段，格式为json字符串，（x-(1-7)对应周一到周日）, 如timeSet=”{‘1’:‘1,2,3’}”表示周一的0:30-1:00,1:00-1:30，1:30-2:00为播放时间, 开始时间不能小于今天
linkDeskFlag 否 是否打开快应用并添加到桌面，1-打开并加桌，0-关闭加桌，默认值为0
注意：必须配置了权限才能设置linkDeskFlag=1
appletType 否 小程序类型 默认为0，1：微信小游戏
kwOcpcPrice 否 广告组 关键词、词包 目标转化出价（单位：分）
kwDeepOcpcPrice 否 广告组 关关键词、词包 深度转化出价（单位：分）
kwTargetROI 否 广告组 关关键词、词包 目标ROI系数 * 1000000, (0,10]
channelPkgId 否 渠道包ID，必须大于0，渠道包投放，appId为必填，应用必须处于上架状态且等级符合要求
defaultSecondStage 否 是否开启免一阶 1-开启，0-关闭
targetROI 是 广告组目标ROI系数 * 1000000, (0,10] 竞价策略为最大转化的计划 该字段不允许修改
adsDpaProductDTO.dpaProductType 否 Integer，商品广告类型，1: sdpa
adsDpaProductDTO.dpaProductLibraryId 否 Long，商品广告-商品库id
adsDpaProductDTO.dpaProductIdList[0] 否 String列表，商品广告-商品id列表
advertiseType 是 广告类型，0-普通广告，1-预约广告，2-商品广告
pushAppPageType 否 流量场景为通知栏时，应用内页的类型，默认值为0，表示不传应用内页，1：INTEND_ACTION，4：ACTIVITY，5：SCHEME_URL
备注：应用内页通过deepUrl参数传值
ocpxOptimizeSwitch 否 OCPX自动优化开关，0表示未开启，1表示开启
备注：需要和深度ocpc转换类型搭配使用
ocpxOptimizeType 否 OCPX优化类型，默认值为0：表示不使用。
可选项 1：七日留存，2：次留率（优选），3：14日LTV
备注：需要和ocpxOptimizeSwitch搭配使用，仅ocpxOptimizeSwitch=1时可以设置
extJson 否 扩展字段,type-value形式存储广告组扩展信息，详情见：4.0广告组接口基础字段说明

返回数据

名称类型必须默认值备注
code
integer否
data
object否返回更新信息数组
adGroupId
integer否广告组id
adGroupName
string否广告组名称
groupUpdateInfos
object []否更新信息列表
adGroupId
integer否广告组id
adGroupName
string否广告组名称
leftTimes
integer否剩余修改次数
totalTimes
integer否总修改次数
ret
integer否更新是否成功 0-成功 1-失败
msg
string否失败原因
minPrice
integer否最小价格（单位：分）
maxPrice
integer否最大价格（单位：分）
modifyType
integer否修改类型：1-推广时段，2-基础出价，3-转化出价，4-深度转化出价，5-目标ROI系数
leftTimes
integer否剩余修改次数
maxPrice
integer否最大价格（单位：分）
minPrice
integer否最小价格（单位：分）
modifyType
integer否修改类型：1-推广时段，2-基础出价，3-转化出价，4-深度转化出价，5-目标ROI系数
msg
string否失败原因
ret
integer否更新是否成功 0-成功 1-失败
totalTimes
integer否总修改次数
msg
string否

4.3 获取单个广告组信息

基本信息

Path： /v3/group/get

Method： GET

接口描述：

获取单个广告组信息：
SDK接入，请求方法：

omniAds.adsGroup().v3GroupPage(adGroupId)

SDK请求参数：adGroupId
请求参数：

adGroupId: 300087873

响应报文：

{
    "code": 0, 
    "data": {
        "insertTime": 1626514798, 
        "updateTime": 1626677513, 
        "updateBy": "1100050065", 
        "updateHost": "10.117.9.81", 
        "deleteFlag": 0, 
        "auditTime": null, 
        "statusName": "启动中", 
        "subStatusName": "启动中", 
        "webStatus": 0, 
        "showStatus": 0, 
        "adGroupId": 300087873, 
        "adGroupName": "应用推广_自有流量_2021/07/17_17:34:32", 
        "planId": 200008260, 
        "planName": "应用推广_2021/07/17_17:34:29", 
        "targetType": 2, 
        "pageId": 0, 
        "pageType": 9, 
        "pageUrl": "", 
        "deepUrl": "", 
        "appId": 21279, 
        "appPackage": "com.ctugames.tiredbirds", 
        "appName": "疲惫的小鸟 v2.0 ", 
        "appRef": "default", 
        "categoryId": 8, 
        "secondCategoryId": 81, 
        "thirdCategroyId": null, 
        "instantAppUrl": "", 
        "instantAppId": 0, 
        "beginTime": 0, 
        "endTime": 0, 
        "targetId": 834313, 
        "targetSource": 1, 
        "timeSet": "", 
        "status": 0, 
        "extensionType": 2, 
        "extensionFlow": 2, 
        "flowScene": 3, 
        "timeLimit": 0, 
        "dayLimit": 0, 
        "status2": 0, 
        "openGroupId": "300087873", 
        "formOrderNums": 0, 
        "formPrice": "0", 
        "smartExpandType": 0, 
        "autoOpenFlag": 0, 
        "groupPrice": 1, 
        "billingType": 5, 
        "price": 150, 
        "ocpcPrice": 250, 
        "ocpcType": 4, 
        "ocpcOptmType": 1, 
        "deepOcpcPrice": 1000, 
        "deepOcpcType": 5, 
        "ocpcState": 1, 
        "targetROI": 0, 
        "adServingType": 0, 
        "followMaxPrice": 0, 
        "followAppIdList": null, 
        "smartExpandBreakthrough": "", 
        "dynamicPrice": 2,
        "defaultSecondStage": 0,
        "linkDeskFlag": 0
    }
}

status字段是按照二进制位来表示内容含义的，下面表格的数字代表是第几个二进制位：

status
二进制位 解释
0 计划暂停
1 余额不足
2 达到计划预算
3 达到账户预算
8 广告组暂停
9 未开始
10 已结束
11 不在推广时段
12 App下架
13 App等级低
14 App版本过低
15 App已删除
16 快应用下架
17 必填规格异常
24 广告暂停

showStatus字段含义：
0 启动中
1 暂停中
2 应用状态异常
3 快应用状态异常
4 已结束
5 未开始
6 不在推广时段
7 规格投放暂停

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
adGroupId 是 广告组id

返回数据

名称类型必须默认值备注
code
integer否
data
object否
adGroupId
integer否广告组id
adGroupName
string否广告组名称
adServingType
integer否投放模式 0-普通投放 1-跟随投放
appId
integer否应用id
appName
string否应用名称
appPackage
string否应用包名
appRef
string否app推广渠道标识
auditTime
integer否
autoOpenFlag
integer否下载并打开
beginTime
integer否推广开始时间 YYYYMMDD
billingType
integer否计费方式.1:CPD 2:CPC 5:OCPX
categoryId
integer否应用一级类目
dayLimit
integer否播放日期限制 0 不限 1 限制
deepOcpcPrice
integer否深度ocpc转化出价
deepOcpcType
integer否深度ocpc转换类型， see @AdOcpcTypeEnum. ocpcState都用一个
deepUrl
string否直达链接，备注：当flowScene=14（通知栏）时，deepUrl传值为应用内页
deleteFlag
integer否删除标识
dynamicPrice
integer否是否为动态出价 1-开启动态出价，0-关闭动态出价，2-不使用动态出价，默认值为2 不使用动态出价
endTime
integer否推广截止时间
extensionFlow
integer否推广流量
extensionType
integer否标的物类型 1：链接推广 2：应用推广-应用下载 3：快应用推广 6：应用推广-应用调起 7：小程序推广 8：直播推广
flowScene
integer否流量场景
followAppIdList
integer []否跟随appId列表
否
followMaxPrice
integer否更随最高价格
formOrderNums
integer否0formOrderNums
formPrice
string否0formPrice
groupPrice
integer否出价、计费: 0 不支持, 1 支持
insertTime
integer否插入时间(秒级时间戳)
instantAppId
integer否快应用AppId
instantAppUrl
string否快应用链接
ocpcOptmType
integer否区分ocpc单出价和双出价. 默认0-单出价，1-双出价
ocpcPrice
integer否目标转化出价
ocpcType
integer否目标转化类型:1-下载,2-拉活
ocpxOptimizeSwitch
integer否OCPX自动优化开关，0表示未开启，1表示开启
ocpxOptimizeType
integer否OCPX优化类型，默认值为0：表示不使用。 可选项 1：七日留存，2：次留率（优选），3：14日LTV
openGroupId
string否openGroupId
pageId
integer否落地页id
pageType
integer否落地页建站类型:1-一叶智能 2-云脑建站 4-萤火虫建站 5-快应用建站 6-广告主自建页面 JS SDK 7-H5 API 回传 8-信息流线索直达
pageUrl
string否目标链接
planId
integer否计划id
planName
string否计划名称
price
integer否基础出价（单位：分）
secondCategoryId
integer否应用二级类目
showStatus
integer否前端展示的状态
smartExpandBreakthrough
string否智能拓量
smartExpandType
integer否智能扩量-信息流 扩量标示位 0：未扩量 1：广告扩量 2：广告组拓量
status
integer否广告组详细状态
status2
integer否开关状态 0 开启 1 关闭
showStatusName
string否前端展示的状态描述
subShowStatusName
string否广告组详细状态描述
targetId
integer否定向id
targetROI
integer否目标ROI系数 * 1000000, (0,10]
targetSource
integer否定向来源：1-广告组私有定向 2-可复用定向
targetType
integer否标的物类型 1：链接推广 2：应用推广 3: 快应用推广 7: 小程序推广
thirdCategroyId
integer否应用三级类目
timeLimit
integer否播放时段限制 0 不限 1 限制
timeSet
string否推广时段
updateBy
string否
updateHost
string否
updateTime
integer否更新时间(秒级时间戳)
webStatus
integer否
linkDeskFlag
integer否是否打开快应用并添加到桌面，1-打开并加桌，0-关闭加桌，默认值为0
defaultSecondStage
integer是是否开启免一阶 1-开启，0-关闭
adsDpaProductDTO
object否商品广告
dpaProductType
integer是商品广告类型，1: sdpa
dpaProductLibraryId
number是商品广告-商品库id
dpaProductIdList
string []是商品广告-商品id列表
pushAppPageType
integer否应用内页的类型，默认值为0，表示不传应用内页，1：INTEND_ACTION，4：ACTIVITY，5：SCHEME_URL
extJson
string否扩展字段,type-value形式存储广告组扩展信息，详情见：4.0广告组接口基础字段说明
msg
string否

4.4 分页查询广告组列表

基本信息

Path： /v3/group/page

Method： POST

接口描述：

特别说明：计划、广告组、广告分页查询接口返回的数据字段具有共性，因此返回的数据字段请参考API文档：公共部分 -> 对接必读 -> 1.9节

分页查询广告组列表：
SDK接入，请求方法：

omniAds.adsGroup().v3GroupPage()

SDK请求参数：

AdsGroupListForm data；

请求参数：

page: 1
limit: 25
beginTime: 20210719
endTime: 20210719
extensionTypes: 1,2,3
extensionFlows: 1,2,3
flowScenes: 1,5,6,7,8,9,10,11,12
adServingType:
deleteFlag: 1
showStatusSet: 0,1,2,3,4,5,6,7,8
orderByColumn: ad_group_id
asc: DESC

响应报文：

{
    "code": 0, 
    "data": {
        "pageNum": 1, 
        "pageSize": 25, 
        "total": 1, 
        "totalPage": 1, 
        "records": [
            {
                "status": 0, 
                "statusName": "", 
                "showStatus": 0, 
                "showStatusName": "启动中", 
                "status2": 0, 
                "deleteFlag": 0, 
                "planId": 200008260, 
                "planName": "应用推广_2021/07/17_17:34:29", 
                "extensionType": 2, 
                "extensionTypeName": "应用推广", 
                "dayBudget": "不限", 
                "adGroupId": 300087873, 
                "adGroupName": "应用推广_自有流量_2021/07/17_17:34:32", 
                "extensionFlow": 2, 
                "extensionFlowName": "自有流量", 
                "flowScene": 3, 
                "flowSceneName": "安装有礼", 
                "price": "150", 
                "ocpcPrice": "250", 
                "ocpcType": 4, 
                "ocpcTypeName": "游戏注册", 
                "deepOcpcPrice": "1000", 
                "deepOcpcType": 5, 
                "deepOcpcTypeName": "游戏付费", 
                "ocpcState": "点击阶段", 
                "dynamicPrice": 2, 
                "adServingType": "普通投放", 
                "followMaxPrice": "-"
            }
        ]
    }
}

status字段是按照二进制位来表示内容含义的，下面表格的数字代表是第几个二进制位：

status
二进制位 解释
0 计划暂停
1 余额不足
2 达到计划预算
3 达到账户预算
8 广告组暂停
9 未开始
10 已结束
11 不在推广时段
12 App下架
13 App等级低
14 App版本过低
15 App已删除
16 快应用下架
17 必填规格异常
24 广告暂停

showStatus字段含义：
0 启动中
1 暂停中
2 应用状态异常
3 快应用状态异常
4 已结束
5 未开始
6 不在推广时段
7 规格投放暂停

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
adGroupIdLike 否 广告组ID
adGroupIds 否 广告组ID列表，多个广告组id通过英文逗号隔开，例如：200009058,200009052
adGroupNameLike 否 广告组名称
adServingType 否 投放类型列表 0-普通投放 1-跟随投放
asc 否 排序方式 ASC-顺序 DESC-逆序，默认值ASC
beginTime 否 开始日期，格式：YYYYMMDD
deleteFlag 否 是否删除，0-未删除 1-删除
endTime 否 结束日期，格式：YYYYMMDD
extensionFlows 否 推广流量列表 1-全流量场景，2-自有流量，3-联盟流量，多个推广流量通过英文逗号隔开，例如：1,2,3
extensionTypes 否 推广目标列表
推广目标枚举值 1：链接推广 2：应用推广-应用下载 3：快应用推广 6：应用推广-应用调起 7：小程序推广 8：直播推广，多个推广目标通过英文逗号隔开，例如：1,2
flowScenes 否 流量场景列表
流量场景枚举值：1-全流量场景，2-精选推荐，3-安装有礼，4-开机必备，5-搜索，6-信息流，7-Banner，8-开屏，9-插屏，10-原生，11-激励视频，12-联盟通投，13-展示优选，14-通知栏，多个流量场景通过英文逗号隔开，例如：1,2,3
limit 是 分页大小 最小1最大1000
orderByColumn 否 排序的数据列：
adGroupId：广告组Id
adGroupName：广告组名称
price：基础出价
ocpcPrice:转化出价
deepOcpcPrice：深度转化出价
targetROI：目标ROI系数
followMaxPrice：跟随最高出价
page 是 分页号
planIds 否 广告计划ID列表，多个计划id通过英文逗号隔开，例如：200009058,200009052
showStatusSet 否 展示状态列表，启动中-0，暂停中-1，应用状态异常-2，快应用状态异常-3，已结束-4，未开始-5，不在推广时段-6，规格投放暂停-7，计划暂停-8
needStats 否 0 是否查询数据字段，0表示不查询，1表示查询（推荐使用0以提高性能）

返回数据

名称类型必须默认值备注
code
integer否
data
object否
pageNum
integer否页码
pageSize
integer否每页大小
records
object []否数据集合
adGroupId
integer否广告组ID
adGroupName
string否广告组名称
adId
integer否广告ID
adName
string否广告名称
adServingType
string否投放模式
auditDesc
string否审核原因
auditStatus
integer否审核状态
click
string否点击量
clickRate
string否点击率
convertActive
string否回传激活量
convertActivePrice
string否回传激活成本
convertAppCredit
string否应用内授信
convertAppCreditPrice
string否应用内授信成本
convertAppCustom
string否应用内自定义转化
convertAppCustomPrice
string否应用内自定义转化成本
convertAppOrder
string否应用内下单（电商）
convertAppOrderPrice
string否应用内下单（电商）成本
convertAppPay
string否应用内付费
convertAppPayPrice
string否应用内付费成本
convertDp
string否回传拉活
convertDpPrice
string否回传拉活成本
convertRegister
string否注册量
convertRegisterPrice
string否注册成本
convertRetention
string否回传留存
convertRetentionPrice
string否回传留存成本
cost
string否消耗金额
creativeTypeName
string否创意类型
dayBudget
string否计划日预算
deepOcpcPrice
string否深度转化出价
deepOcpcType
integer否深度转化类型
deepOcpcTypeName
string否深度转化类型名称
deleteFlag
integer否删除状态
download
string否下载量
downloadRate
string否下载率
dpAppCreditNums
string否deeplink应用内授信量
dpAppCreditPrice
string否deeplink应用内授信成本
dpAppOrderNums
string否deeplink应用内下单量
dpAppOrderPrice
string否deeplink应用内下单成本
dpAppPayNums
string否deeplink应用付费量
dpAppPayPrice
string否deeplink应用付费成本
dpConvertActivationNums
string否deeplink回传激活量
dpConvertActivationPrice
string否deeplink回传激活成本
dpConvertRegisterNums
string否deeplink回传注册量
dpConvertRegisterPrice
string否deeplink回传注册成本
dpUdConvertNums
string否deeplink自定义转化量
dpUdConvertPrice
string否deeplink自定义转化成本
dynamicPrice
integer否动态出价
ecpm
string否ecpm
expose
string否曝光量
extensionFlow
integer否推广流量
extensionFlowName
string否推广流量名称
extensionType
integer否推广目标 1：链接推广 2：应用推广-应用下载 3：快应用推广 6：应用推广-应用调起 7：小程序推广 8：直播推广
extensionTypeName
string否推广目标名称
flowScene
integer否流量场景
flowSceneName
string否流量场景名称
followAppIdList
integer []否跟随appId列表
否
followMaxPrice
string否更随最高价格
formCnt
string否表单提交量
formCntPrice
string否表单提交成本
globalSpecId
integer否创意规格
globalSpecName
string否创意规格名称
ocpcPrice
string否转化出价
ocpcType
integer否转化类型
ocpcTypeName
string否转化类型名称
planId
integer否广告计划ID
planName
string否广告计划名称
price
string否基础出价
quickAppPay
string否快应用付费
quickAppPayPrice
string否快应用付费成本
showStatus
integer否前端展示状态
showStatusName
string否前端展示状态描述
status
integer否详细状态
statusName
string否详细状态描述，与subShowStatusName一致
status2
integer否投放开关
subShowStatusName
string否详细状态描述
targetROI
string否目标ROI系数
billingType
integer否计费类型，2-cpc，5-ocpx
insertTime
integer否插入时间(秒级时间戳)
updateTime
integer否更新时间(秒级时间戳)
appletType
integer否小程序类型
appletId
string否小程序ID
appletPath
string否小程序Path
deepUrl
string否直达链接
ocpcState
integer否ocpc转化阶段 1-点击阶段, 2-转化阶段, 3-深度转化阶段
advertiseType
integer否广告类型，1-普通广告，2-预约广告，3-商品广告
advertiseTypeName
string否广告类型名称
gainQuantityStatus
integer否一键起量状态，0表示未起量，1表示起量中，2表示起量结束
gainQuantityStatusName
string否一键起量状态名称，0表示未起量，1表示起量中，2表示起量结束
gainQuantityBudget
integer否一键起量预算，单位是分
gainQuantityCycles
integer否一键起量次数，针对每个广告组，每次起量后累加
gainQuantityDate
integer否一键起量日期，当且仅当等于当日才能起量
gainQuantitySwitch
integer否一键起量开关，0表示未开启，1表示开启
defaultSecondStage
integer否是否开启免一阶，0-未开启，1-开启
pushAppPageType
integer否应用内页的类型，默认值为0，表示不传应用内页，1：INTEND_ACTION，4：ACTIVITY，5：SCHEME_URL
total
integer否数据总条数
totalPage
integer否总页数
msg
string否

4.5 批量删除广告组

基本信息

Path： /v3/group/delete

Method： POST

接口描述：

批量删除广告组：
SDK接入，请求方法：

omniAds.adsGroup().v3GroupDelete(data)

SDK请求参数：

AdsBatchGroupDeleteForm data；

请求参数：

groupIds: 300088058,300088057

响应报文：

{
    "code": 0
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
groupIds 是 广告组id列表，groupIds[0]=300088219，groupIds[1]=300088220

返回数据

名称类型必须默认值备注
code
integer否
data
object []否
adGroupId
integer否广告组id
adGroupName
string否广告组名称
leftTimes
integer否剩余修改次数
maxPrice
integer否最大价格
minPrice
integer否最小价格
modifyType
integer否修改类型：1-推广时段，2-基础出价，3-转化出价，4-深度转化出价，5-目标ROI系数
msg
string否失败原因
ret
integer否更新是否成功 0-成功 1-失败
totalTimes
integer否总修改次数
msg
string否

4.6 批量启停广告组

基本信息

Path： /v3/group/status

Method： POST

接口描述：

批量启停广告组：
SDK接入，请求方法：

omniAds.adsGroup().v3GroupStatus(data)

SDK请求参数：

AdsBatchGroupStatusForm data；

请求参数：

groupIds[0]: 300088219
groupIds[1]: 300088218
status2: 1    开关状态 0 开启 1 关闭

响应报文：

{
    "code": 0
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
groupIds 是 广告组id列表，groupIds[0]=300088219，groupIds[1]=300088220
status2 是 开关状态 0 开启 1 关闭

返回数据

名称类型必须默认值备注
code
integer否
data
object []否
adGroupId
integer否广告组id
adGroupName
string否广告组名称
leftTimes
integer否剩余修改次数
maxPrice
integer否最大价格
minPrice
integer否最小价格
modifyType
integer否修改类型：1-推广时段，2-基础出价，3-转化出价，4-深度转化出价，5-目标ROI系数
msg
string否失败原因
ret
integer否更新是否成功 0-成功 1-失败
totalTimes
integer否总修改次数
msg
string否

4.7 批量修改排期

基本信息

Path： /v3/group/batchSchedule

Method： POST

接口描述：

批量修改排期：
SDK接入，请求方法：

omniAds.adsGroup().v3GroupBatchSchedule(data)

SDK请求参数：

AdsBatchGroupScheduleForm data；

请求参数：

groupIds: 300088219 （必传参数）
beginTime: 20210721  推广开始时间，格式：YYYYMMDD
endTime: 20210723
timeSet: {"1":"","2":"4,7","3":"11","4":"","5":"","6":"","7":""}  推广时段，格式为json字符串，（x-(1-7)对应周一到周日）, 如timeSet=”{‘1’:‘1,2,3’}”表示周一的0:30-1:00,1:00-1:30，1:30-2:00为播放时间, 开始时间不能小于今天"
timeLimit: 1  推广时段限制，0-不限制推广时段 1-限制推广时段，当为1时，timeSet必传
dayLimit: 1   推广日期限制 0-不限制推广日期 1-限制推广日期，当为1时，beginTime和endTime必传

响应报文：

{
    "code": 0, 
    "data": [
        {
            "adGroupId": 300088219, 
            "adGroupName": "应用推广_自有流量_2021/07/19_10:25:32", 
            "leftTimes": 4, 
            "totalTimes": 5, 
            "ret": 0, 
            "msg": null, 
            "minPrice": null, 
            "maxPrice": null, 
            "modifyType": null
        }
    ]
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
beginTime 否 推广开始时间，格式：YYYYMMDD
dayLimit 否 推广日期限制 0-不限制推广日期 1-限制推广日期，当为1时，beginTime和endTime必传
endTime 否 推广截止时间，格式：YYYYMMDD
groupIds 是 广告组id列表，groupIds[0]=300088219，groupIds[1]=300088220
timeLimit 否 推广时段限制，0-不限制推广时段 1-限制推广时段，当为1时，timeSet必传
timeSet 否 推广时段，格式为json字符串，（x-(1-7)对应周一到周日）, 如timeSet=”{‘1’:‘1,2,3’}”表示周一的0:30-1:00,1:00-1:30，1:30-2:00为播放时间, 开始时间不能小于今天

返回数据

名称类型必须默认值备注
code
integer否
data
object []否返回更新信息数组
adGroupId
integer否广告组id
adGroupName
string否广告组名称
leftTimes
integer否剩余修改次数
maxPrice
integer否最大价格
minPrice
integer否最小价格
modifyType
integer否修改类型：1-推广时段，2-基础出价，3-转化出价，4-深度转化出价，5-目标ROI系数
msg
string否失败原因
ret
integer否更新是否成功 0-成功 1-失败
totalTimes
integer否总修改次数
msg
string否

4.8 批量修改定向包

基本信息

Path： /v3/group/batchTarget

Method： POST

接口描述：

批量修改定向包：（详情见 定向相关接口 -> 获取定向列表）
SDK接入，请求方法：

omniAds.adsGroup().v3GroupBatchTarget

SDK请求参数：

AdsBatchGroupTargetForm data；
data.setGroupIds()；广告组id列表    必传
data.setTargetId();定向id不能为空，并且必须大于1  必传

1、通过接口获取定向包信息：/v2/communal/target/list/page
请求参数：

immutable: 0
type: 1
delStatus: 0
version: 2
page: 1
pageCount: 20

响应报文：

{
    "code": 0, 
    "data": {
        "totalCount": 1, 
        "itemCount": 1, 
        "items": [
            {
                "targetId": 834313, 
                "openTargetId": 834313, 
                "openV2TargetId": "834313", 
                "ownerId": "1100050065", 
                "targetName": "0713test", 
                "targetDesc": "", 
                "delStatus": 0, 
                "createTime": 1626144196, 
                "updateTime": 1626144196, 
                "sex": "1", 
                "age": "2,3", 
                "appActive": "70767,3548", 
                "immutable": 0, 
                "type": 1, 
                "pTargetId": 0, 
                "oppAudienceId": 0, 
                "appActiveDays": 3, 
                "audienceCount": 0, 
                "version": 2, 
                "deleteSeed": 0, 
                "expansionStatus": 0, 
                "expansionCount": 0, 
                "seedFileName": "", 
                "showStatus": 2, 
                "longitude": "104.072745", 
                "latitude": "30.578994", 
                "radius": 5000, 
                "locationName": "成都市", 
                "address": "成都市", 
                "mapLocations": "[{"address":"成都市","dlat":0.0,"dlon":0.0,"latitude":"30.578994","locationName":"成都市","longitude":"104.072745","radius":5000}]", 
                "imeiType": 0, 
                "appUninstallDays": 0
            }
        ]
    }
}

2、调用修改定向包接口：/v3/group/batchTarget
请求参数：

groupIds[0]:300088219
percent:78

响应报文：

{
    "code": 0, 
    "data": [
        {
            "adGroupId": 300088219, 
            "adGroupName": "应用推广_自有流量_2021/07/19_10:25:32", 
            "leftTimes": null, 
            "totalTimes": null, 
            "ret": 0, 
            "msg": null, 
            "minPrice": null, 
            "maxPrice": null, 
            "modifyType": null
        }
    ]
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
groupIds 是 广告组id列表，groupIds[0]=300088219，groupIds[1]=300088220
targetId 是 定向id

返回数据

名称类型必须默认值备注
code
integer否
data
object []否返回更新信息数组
adGroupId
integer否广告组id
adGroupName
string否广告组名称
leftTimes
integer否剩余修改次数
maxPrice
integer否最大价格
minPrice
integer否最小价格
modifyType
integer否修改类型：1-推广时段，2-基础出价，3-转化出价，4-深度转化出价，5-目标ROI系数
msg
string否失败原因
ret
integer否更新是否成功 0-成功 1-失败
totalTimes
integer否总修改次数
msg
string否

4.9 批量修改广告组基础出价

基本信息

Path： /v3/group/price

Method： POST

接口描述：

注意：竞价策略为最大转化的计划 广告组出价不允许修改

批量修改广告组基础出价：
SDK接入，请求方法：

omniAds.adsGroup().v3GroupPrice()

SDK请求参数：

AdsBatchPriceForm data；
data.setXXX
List<Long> groupIds;  广告组id列表   必传
Integer percent;      按百分比修改出价，例如：50，percent取值范围为0~1000000 ，percent与price两者必传其一
Integer price;        基础出价（单位：分），price取值范围为0~1000000（分） percent与price两者必传其一
Integer groupPrice;   是否支持广告组出价 1-支持，要么不传，要么传1。修改price时需传入groupPrice
Integer billingType;  计费方式.1:CPD 2:CPC 3:CPM 4:CPS 5:OCPC 6:CPA，billingType取值为1~6，修改price时需传入billingType

1、直接修改价格：
请求参数：

groupIds[0]:300088219
price:200

响应报文：

{
    "code": 0, 
    "data": [
        {
            "adGroupId": 300088219, 
            "adGroupName": "应用推广_自有流量_2021/07/19_10:25:32", 
            "leftTimes": 9, 
            "totalTimes": 10, 
            "ret": 0, 
            "msg": null, 
            "minPrice": 60, 
            "maxPrice": 10000, 
            "modifyType": null
        }
    ]
}

2、按比例修改价格：
请求参数：

groupIds[0]:300088219
percent:78

响应报文：

{
    "code": 0, 
    "data": [
        {
            "adGroupId": 300088219, 
            "adGroupName": "应用推广_自有流量_2021/07/19_10:25:32", 
            "leftTimes": 9, 
            "totalTimes": 10, 
            "ret": 0, 
            "msg": null, 
            "minPrice": 60, 
            "maxPrice": 10000, 
            "modifyType": null
        }
    ]
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
billingType 否 计费方式.1:CPD 2:CPC 3:CPM 4:CPS 5:OCPC 6:CPA
groupIds 是 广告组id列表，groupIds[0]=300088219，groupIds[1]=300088220
groupPrice 否 是否支持广告组出价 1-支持，要么不传，要么传1
percent 否 按百分比修改出价，只能传整数，例如：50
price 否 基础出价（单位：分）

返回数据

名称类型必须默认值备注
code
integer否
data
object []否返回更新信息数组
adGroupId
integer否广告组id
adGroupName
string否广告组名称
leftTimes
integer否剩余修改次数
maxPrice
integer否最大价格（单位：分）
minPrice
integer否最小价格（单位：分）
modifyType
integer否修改类型：1-推广时段，2-基础出价，3-转化出价，4-深度转化出价，5-目标ROI系数
msg
string否失败原因
ret
integer否更新是否成功 0-成功 1-失败
totalTimes
integer否总修改次数
msg
string否

4.10 批量修改广告组转化出价

基本信息

Path： /v3/group/ocpcPrice

Method： POST

接口描述：

注意：竞价策略为最大转化的计划 广告组转化出价不允许修改

批量修改广告组转化出价：
SDK接入，请求方法：

omniAds.adsGroup().v3GroupOcpcPrice(data)

SDK请求参数：

AdsBatchOcpcPriceForm data；
data.setXXX;

List<Long> groupIds;  广告组id列表   必传

Integer ocpcPercent;   按百分比修改出价，例如：50，percent取值范围为0~1000000 ，percent与price两者必传其一

Integer ocpcPrice;        基础出价（单位：分），price取值范围为0~1000000（分） percent与price两者必传其一

Integer groupPrice;   是否支持广告组出价 1-支持，要么不传，要么传1。修改price时需传入groupPrice

Integer billingType;  计费方式.1:CPD 2:CPC 3:CPM 4:CPS 5:OCPC 6:CPA，billingType取值为1~6，修改price时需传入billingType

1、直接修改价格：
请求参数：

groupIds[0]:300088219
ocpcPrice:200      // （单位：分）

响应报文：

{
    "code": 0, 
    "data": [
        {
            "adGroupId": 300088058, 
            "adGroupName": "应用推广_自有流量_游戏付费游戏付费ROI1", 
            "leftTimes": 8, 
            "totalTimes": 10, 
            "ret": 0, 
            "msg": null, 
            "minPrice": 120, 
            "maxPrice": 10000, 
            "modifyType": null
        }
    ]
}

2、按比例修改价格：
请求参数：

groupIds[0]:300088219
ocpcPercent:150

响应报文：

{
    "code": 0, 
    "data": [
        {
            "adGroupId": 300088058, 
            "adGroupName": "应用推广_自有流量_游戏付费游戏付费ROI1", 
            "leftTimes": 8, 
            "totalTimes": 10, 
            "ret": 0, 
            "msg": null, 
            "minPrice": 120, 
            "maxPrice": 10000, 
            "modifyType": null
        }
    ]
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
billingType 否 计费方式.1:CPD 2:CPC 3:CPM 4:CPS 5:OCPC 6:CPA
groupIds 是 广告组id列表，groupIds[0]=300088219，groupIds[1]=300088220
groupPrice 否 是否支持广告组出价 1-支持，要么不传，要么传1
ocpcPercent 否 按百分比修改转化出价，只能传整数，例如：50
ocpcPrice 是 目标转化出价（单位：分）

返回数据

名称类型必须默认值备注
code
integer否
data
object []否返回更新信息数组
adGroupId
integer否广告组id
adGroupName
string否广告组名称
leftTimes
integer否剩余修改次数
maxPrice
integer否最大价格（单位：分）
minPrice
integer否最小价格（单位：分）
modifyType
integer否修改类型：1-推广时段，2-基础出价，3-转化出价，4-深度转化出价，5-目标ROI系数
msg
string否失败原因
ret
integer否更新是否成功 0-成功 1-失败
totalTimes
integer否总修改次数
msg
string否

4.11 批量修改广告组深度转化出价

基本信息

Path： /v3/group/deepOcpcPrice

Method： POST

接口描述：

注意：竞价策略为最大转化的计划 广告组深度转化出价不允许修改

批量修改广告组深度转化出价：
SDK接入，请求方法：

omniAds.adsGroup().v3GroupDeepOcpcPrice(data);

SDK请求参数：

AdsBatchDeepOcpcPriceForm data；
data.setXXX;

List<Long> groupIds;      广告组id列表不能为空

Integer deepOcpcPercent;  按百分比修改深度转化出价，例如：50，deepOcpcPercent与deepOcpcPrice两者必传其一，取值范围为0~1000000 ，deepOcpcPercent与deepOcpcPrice两者必传其一

Integer deepOcpcPrice;    深度ocpc转化出价（单位：分），deepOcpcPercent与deepOcpcPrice两者必传其一，取值范围为0~1000000（分），deepOcpcPercent与deepOcpcPrice两者必传其一

Integer groupPrice;       是否支持广告组出价 1-支持，要么不传，要么传1，修改deepOcpcPrice时需传入groupPrice

Integer billingType;         计费方式.1:CPD 2:CPC 3:CPM 4:CPS 5:OCPC 6:CPA，修改deepOcpcPrice时需传入billingType

1、直接修改价格：
请求参数：

groupIds[0]:300088219
deepPcpcPrice:500      //（单位：分）

响应报文：

{
    "code": 0, 
    "data": [
        {
            "adGroupId": 300087873, 
            "adGroupName": "应用推广_自有流量_2021/07/17_17:34:32", 
            "leftTimes": 9, 
            "totalTimes": 10, 
            "ret": 0, 
            "msg": null, 
            "minPrice": 250, 
            "maxPrice": 300000, 
            "modifyType": null
        }
    ]
}

2、按比例修改价格：
请求参数：

groupIds[0]:300088219
deepOcpcPercent:200

响应报文：

{
    "code": 0, 
    "data": [
        {
            "adGroupId": 300087873, 
            "adGroupName": "应用推广_自有流量_2021/07/17_17:34:32", 
            "leftTimes": 9, 
            "totalTimes": 10, 
            "ret": 0, 
            "msg": null, 
            "minPrice": 250, 
            "maxPrice": 300000, 
            "modifyType": null
        }
    ]
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
billingType 否 计费方式.1:CPD 2:CPC 3:CPM 4:CPS 5:OCPC 6:CPA
deepOcpcPercent 否 按百分比修改深度转化出价，只能传整数，例如：50，deepOcpcPercent与deepOcpcPrice两者必传其一
deepOcpcPrice 否 深度ocpc转化出价（单位：分），deepOcpcPercent与deepOcpcPrice两者必传其一
groupIds 是 广告组id列表，groupIds[0]=300088219，groupIds[1]=300088220
groupPrice 否 是否支持广告组出价 1-支持，要么不传，要么传1

返回数据

名称类型必须默认值备注
code
integer否
data
object []否返回更新信息数组
adGroupId
integer否广告组id
adGroupName
string否广告组名称
leftTimes
integer否剩余修改次数
maxPrice
integer否最大价格（单位：分）
minPrice
integer否最小价格（单位：分）
modifyType
integer否修改类型：1-推广时段，2-基础出价，3-转化出价，4-深度转化出价，5-目标ROI系数
msg
string否失败原因
ret
integer否更新是否成功 0-成功 1-失败
totalTimes
integer否总修改次数
msg
string否

4.12 查询渠道包列表

基本信息

Path： /v3/channelPkg/list

Method： POST

接口描述：

响应报文：

{
    "code": 0, 
    "msg": "", 
    "date": [
        {
            "channelPkgId": 12345, 
            "channelPkgName": "pkgName", 
            "channelPkgLevel": "L2", 
            "appId": 234565, 
            "appName": "name", 
            "packageName": "packageName", 
            "status": 2, 
            "level": "L1"
        }, 
        {
            "channelPkgId": 12345, 
            "channelPkgName": "pkgName", 
            "channelPkgLevel": "L2", 
            "appId": 234565, 
            "appName": "name", 
            "packageName": "packageName", 
            "status": 2, 
            "level": "L1"
        }
    ]
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
appId 是 应用Id，Long类型
flowScene 否 流量场景，如果参数有流量场景，精选推荐、开机必备、安装有礼需为A级资源（L2）；其他流量场景至少为B级资源（L1）

返回数据

名称类型必须默认值备注
code
number是返回状态码，0表示成功，非0表示失败
msg
string是错误信息
date
object []是渠道包列表
channelPkgId
number是渠道id
channelPkgName
string是渠道包名称
channelPkgLevel
string是渠道包资源等级，例如L2
appId
number否应用ID，接口入库的渠道包没有应用信息
appName
string否应用名称，接口入库的渠道包没有应用信息
packageName
string否应用包名，接口入库的渠道包没有应用信息
status
number是渠道包状态：0-待审核 1-上架(商店) 2-下架(商店) 3-审核不通过 4-提交商店失败 5-预上架
level
string是商店资源等级，例如L1、L2

4.13 批量开启免一阶

基本信息

Path： /v3/group/batchOpenDefaultSecondStage

Method： POST

接口描述：

响应报文：

{
    "code": 0,
    "data": [
        {
            "adGroupId": 300000586,
            "adGroupName": null,
            "leftTimes": null,
            "totalTimes": null,
            "ret": 120276,
            "msg": "广告组免一阶与动态出价不能同时开启",
            "minPrice": null,
            "maxPrice": null,
            "modifyType": null,
            "groupUpdateInfos": []
        },
        {
            "adGroupId": 300000589,
            "adGroupName": null,
            "leftTimes": null,
            "totalTimes": null,
            "ret": 0,
            "msg": null,
            "minPrice": null,
            "maxPrice": null,
            "modifyType": null,
            "groupUpdateInfos": []
        }
    ]
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是 application/x-www-form-urlencoded

Query

参数名称 必须 示例 备注
groupIds 是 广告组id列表，groupIds[0]=300088219，groupIds[1]=300088220

返回数据

名称类型必须默认值备注
code
number否
data
object []否
adGroupId
number否
adGroupName
string否
leftTimes
number否
totalTimes
number否
ret
number否
msg
null否
minPrice
null否
maxPrice
null否
modifyType
null否

4.14 批量修改Deeplink链接

基本信息

Path： /v3/group/batchUpdateDp

Method： POST

接口描述：

备注：当flowScene=14（通知栏）时，deepUrl为应用内页，不支持批量修改
响应报文：

{
    "code": 0,
    "data": [
        {
            "adGroupId": 300471252,
            "adGroupName": "应用推广_联盟流量_2023/07/25_17:40:24",
            "leftTimes": null,
            "totalTimes": null,
            "ret": 120226,
            "msg": "广告组（300471252）和DP链接对应的应用不一致，无法修改",
            "minPrice": null,
            "maxPrice": null,
            "minRatio": null,
            "maxRatio": null,
            "modifyType": null,
            "groupUpdateInfos": []
        },
        {
            "adGroupId": 300470807,
            "adGroupName": null,
            "leftTimes": null,
            "totalTimes": null,
            "ret": 120226,
            "msg": "广告组（300470807）不存在，请核对后重新输入",
            "minPrice": null,
            "maxPrice": null,
            "minRatio": null,
            "maxRatio": null,
            "modifyType": null,
            "groupUpdateInfos": []
        }
    ]
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是 application/x-www-form-urlencoded

Body

参数名称 参数类型 必须 示例 备注
groupIds 文本 是 1,2,3 广告组id列表
deepUrl 文本 是 Deeplink链接

返回数据

名称类型必须默认值备注
code
number否
data
object []否
adGroupId
number否
adGroupName
string否
ret
number否
msg
null否

4.15 批量修改渠道包ID

基本信息

Path： /v3/group/batchUpdateChannelPkgId

Method： POST

接口描述：

响应报文：

{
    "code": 0,
    "data": [
        {
            "adGroupId": 300471252,
            "adGroupName": "应用推广_联盟流量_2023/07/25_17:40:24",
            "leftTimes": null,
            "totalTimes": null,
            "ret": 120226,
            "msg": "广告组（300471252）和DP链接对应的应用不一致，无法修改",
            "minPrice": null,
            "maxPrice": null,
            "minRatio": null,
            "maxRatio": null,
            "modifyType": null,
            "groupUpdateInfos": []
        },
        {
            "adGroupId": 300470807,
            "adGroupName": null,
            "leftTimes": null,
            "totalTimes": null,
            "ret": 120226,
            "msg": "广告组（300470807）不存在，请核对后重新输入",
            "minPrice": null,
            "maxPrice": null,
            "minRatio": null,
            "maxRatio": null,
            "modifyType": null,
            "groupUpdateInfos": []
        }
    ]
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是 application/x-www-form-urlencoded

Body

参数名称 参数类型 必须 示例 备注
groupIds 文本 是 1,2,3 广告组id列表
channelPkgId 文本 是 1 渠道包ID
appId 文本 是 1 应用ID

返回数据

名称类型必须默认值备注
code
number否
data
object []否
adGroupId
number否
adGroupName
string否
ret
number否
msg
null否

5.【推广】广告创意管理

5.1 批量启停广告创意

基本信息

Path： /v3/ad/status

Method： POST

接口描述：

批量启停广告创意
SDK接入，请求方法：

omniAds.ads().v3AdStatus(data)

SDK请求参数：

AdsAdStatusForm data;
data.setXxx;
List<Long> adIds;  广告id列表不为空

Integer status2;   标识暂停启动 0 启动 1 暂停

请求参数：

adIds[0]: 400092045
adIds[1]: 400091199
status2: 1

响应报文：

{
"code": 0
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是 multipart/form-data

Query

参数名称 必须 示例 备注
adIds 是 广告id列表
status2 是 标识暂停启动 0 启动 1 暂停

返回数据

名称类型必须默认值备注
code
integer否
msg
string否
data
object []否
adId
integer否广告id
adName
string否广告名称
leftTimes
integer否剩余次数
totalTimes
integer否总次数
ret
integer否更新是否成功 0 成功 1 失败
msg
string否失败原因, 冗余信息
minPrice
integer否最小价格
maxPrice
integer否最大价格

5.10 查询商品广告创意（新）

基本信息

Path： /v3/ad/dpa_strategy/detail

Method： GET

接口描述：

{
    "code": 0,
    "data": {
        "adGroupId": 300472335,
        "adName": "SDPA_2023/08/08_17:47",
        "creativeModeType": 0,
        "strategies": [
            {
                "globalSpecId": 1,
                "dpaProductId": "691603826609",
                "brandName": "5时非饿",
                "brandLogoUrl": "https://adsfs.heytapimage.com/ads-material-depot/image/2cb868d5c45b2e21663291158510482a.jpg",
                "brandLogoImgId": 44243459,
                "dpaCollects": [
                    {
                        "adId": 401082002,
                        "mappingId": 26288,
                        "creativeTemplateId": 0,
                        "copywriter": "{商品名称}",
                        "buttonTxt": "",
                        "imgUrl": "https://adsfs-ads-test.wanyol.com/ads-material-depot/image/d5807a5c70121bac5251c0569f63e81e.jpg",
                        "imgMatId": 44236774,
                        "videoUrl": "",
                        "videoImgUrl": "",
                        "videoBgImgUrl": "",
                        "videoMatId": 0,
                        "videoImgMatId": 0,
                        "videoBgImgMatId": 0
                    }
                ]
            },
            {
                "globalSpecId": 1,
                "dpaProductId": "694574797457",
                "brandName": "",
                "brandLogoUrl": "",
                "brandLogoImgId": 0,
                "dpaCollects": [
                    {
                        "adId": 0,
                        "mappingId": 26289,
                        "creativeTemplateId": 0,
                        "copywriter": "{商品名称}",
                        "buttonTxt": "",
                        "imgUrl": "",
                        "imgMatId": 0,
                        "videoUrl": "",
                        "videoImgUrl": "",
                        "videoBgImgUrl": "",
                        "videoMatId": 0,
                        "videoImgMatId": 0,
                        "videoBgImgMatId": 0
                    }
                ]
            },
            {
                "globalSpecId": 1,
                "dpaProductId": "694786843636",
                "brandName": "",
                "brandLogoUrl": "",
                "brandLogoImgId": 0,
                "dpaCollects": [
                    {
                        "adId": 0,
                        "mappingId": 26290,
                        "creativeTemplateId": 0,
                        "copywriter": "{商品名称}",
                        "buttonTxt": "",
                        "imgUrl": "",
                        "imgMatId": 0,
                        "videoUrl": "",
                        "videoImgUrl": "",
                        "videoBgImgUrl": "",
                        "videoMatId": 0,
                        "videoImgMatId": 0,
                        "videoBgImgMatId": 0
                    }
                ]
            },
            {
                "globalSpecId": 1,
                "dpaProductId": "694859883232",
                "brandName": "",
                "brandLogoUrl": "",
                "brandLogoImgId": 0,
                "dpaCollects": [
                    {
                        "adId": 0,
                        "mappingId": 26291,
                        "creativeTemplateId": 0,
                        "copywriter": "{商品名称}",
                        "buttonTxt": "",
                        "imgUrl": "",
                        "imgMatId": 0,
                        "videoUrl": "",
                        "videoImgUrl": "",
                        "videoBgImgUrl": "",
                        "videoMatId": 0,
                        "videoImgMatId": 0,
                        "videoBgImgMatId": 0
                    }
                ]
            },
            {
                "globalSpecId": 1,
                "dpaProductId": "694861839753",
                "brandName": "",
                "brandLogoUrl": "",
                "brandLogoImgId": 0,
                "dpaCollects": [
                    {
                        "adId": 0,
                        "mappingId": 26292,
                        "creativeTemplateId": 0,
                        "copywriter": "{商品名称}",
                        "buttonTxt": "",
                        "imgUrl": "",
                        "imgMatId": 0,
                        "videoUrl": "",
                        "videoImgUrl": "",
                        "videoBgImgUrl": "",
                        "videoMatId": 0,
                        "videoImgMatId": 0,
                        "videoBgImgMatId": 0
                    }
                ]
            }
        ],
        "selectedAd": {
            "globalSpecId": 1,
            "dpaProductId": "691603826609",
            "adId": 401082002
        },
        "exposeUrl": "",
        "clickUrl": "",
        "exposeEndUrl": "",
        "playBeginUrl": "",
        "playEndUrl": "",
        "downloadUrl": ""
    }
}

请求参数

Query

参数名称 必须 示例 备注
adGroupId 是 广告组ID 广告组ID
adId 否 广告ID 广告ID

返回数据

名称类型必须默认值备注
code
number否状态码
data
object否数据
adGroupId
number否广告组id
adName
string否广告id
creativeModeType
number否创意生成模式0-直投 1-模板模式
strategies
object []否
globalSpecId
number是规格Id
dpaProductId
string是商品id
brandName
string是品牌名称
brandLogoUrl
string是品牌LOGO
brandLogoImgId
number是品牌LOGO素材ID，默认值0
dpaCollects
object []是
adId
number是广告id，默认值0
creativeTemplateId
number是模板模式 模板id，默认值0
copywriter
string是文案
buttonTxt
string是品牌名称
imgUrl
string是素材图URL
imgMatId
number是图片素材ID，默认值0
videoUrl
string是视频素材URL
videoImgUrl
string是视频封面图URL
videoBgImgUrl
string是视频背景图URL
videoMatId
number是视频素材id，默认值0
videoImgMatId
number是视频结束图素材id，默认值0
videoBgImgMatId
number是视频背景图素材id，默认值0
exposeUrl
string否曝光监测链接
clickUrl
string否点击监测链接

5.11 编辑商品广告创意（新）

基本信息

Path： /v3/ad/dpa_strategy/edit

Method： POST

接口描述：

备注：
1、在动态商品创意【模板模式】下，单次调用只能编辑模板模式下的一种规格
2、如果需要编辑【模板模式】下的不同规格，需要多次调用编辑接口（传入不同的规格ID）

响应报文：

{
    "code": 0, 
    "data": 1
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 必须 示例 备注
adGroupId 文本 是 3241344 广告组ID
adName 文本 否 sdpaxxx 广告名称前缀
globalSpecId 文本 是 1 统一规格id ,1-横版大图 50-竖版大图 60-横版视频 63-竖版视频
templateBrandLogoImgId 文本 否 123121 品牌LOGO图片id （必须在素材库中） 模板模式专用
templateButtonTxt 文本 否 打开 按钮文案 模板模式专用
templateCopywriter 文本 否 百亿补贴 广告文案 模板模式专用
templateBrandName 文本 否 拼多多 品牌名称 模板模式专用
customizeProductInfo[0].adId 文本 否 233333 广告id 直投模式专用（该字段非必填，如果用户想自定义某个广告id的信息需要填写相关信息 如果想自动生成则不需要填写。）
customizeProductInfo[0].copywriter 文本 否 广告文案 直投模式专用（该字段非必填，如果用户想自定义某个商品id的信息需要填写相关信息 如果想自动生成则不需要填写。）
customizeProductInfo[0].buttonTxt 文本 否 按钮文案 直投模式专用（该字段非必填，如果用户想自定义某个商品id的信息需要填写相关信息 如果想自动生成则不需要填写。）
exposeUrl 文本 否 https://xxxxx 曝光监测链接
clickUrl 文本 否 https://xxxxx 点击监测链接

返回数据

名称类型必须默认值备注
code
number是返回状态码，0表示成功，非0表示失败
msg
string是错误信息
data
number是添加，编辑成功条数

5.12 sdpa广告投放全流程指引

基本信息

Path： /00

Method： GET

接口描述：

一、sdpa广告投放全流程

1.直投模式流程图


 

2.模板模式流程图

3.相关接口

4.流程解析

**注：商品库可看作sdpa广告投放的素材库。由于sdpa广告投放所支持的规格在不同场景下，所需必填字段不同。故商品库不对商品的所有字段做强限制，投放直投sdpa广告时，需关注当前广告规格所需的必填字段。广告规格信息可从接口或从营销平台页面中获取。
**直投模式例：投放应用推广-信息流-横版大图sdpa广告，该广告创意所需的必填字段如下：图片、品牌logo、文案、品牌名称。
直投模式字段映射如下：
创意规格 标准化元素 对应商品库字段
横版大图 1.img图片:1280_720、<150kb、jpg、jpeg、png__
2.txt文案:0-35字
3.brand_name品牌名称:0-18字
4.brand_logo品牌logo:200_200 100kb jpg、jpeg、png5.button_txt按钮文案：0-4字		 1、imgUrl主图/images扩展图
2、productName商品名称
3、brandName品牌名称
4、brandLogo品牌图片地址
5、无
横版视频 1.video视频：16：9、<122880KB、MP4，时长0-120s
2.video_img图片:1280_720、<150kb、jpg、jpeg、png__
3.txt文案:0-35字
4.brand_name品牌名称:0-18字
5.brand_logo品牌logo:200_200 100kb jpg、jpeg、png6.button_txt按钮文案：0-4字
7.video_backgroud_img图片：720*1280、<150kb、jpg、jpeg、png		 1、videos-url扩展视频url
2、videos-imgUrl视频图片url
3、productName商品名称
4、brandName品牌名称
5、brandLogo品牌图片地址
6、无
7、videos-imgUrl视频图片url
竖版大图 1.img图片: 1080 x 1920、<150kb、jpg、jpeg、png
2.txt文案:0-23字
3.brand_name品牌名称:0-8字
4.brand_logo品牌logo:200*200 100kb jpg、jpeg、png
5.button_txt按钮文案：0-4字		 1、imgUrl主图/images扩展图
2、productName商品名称
3、brandName品牌名称
4、brandLogo品牌图片地址
5、无
竖版视频 1.video视频：9：16、<122880KB、MP4，时长0-120s
2.video_img图片:720_1280、<150kb、jpg、jpeg、png__
3.txt文案:0-23字
4.brand_name品牌名称:0-8字
5.brand_logo品牌logo:200_200 100kb jpg、jpeg、png6.button_txt按钮文案：0-4字
7.video_backgroud_img图片：720*1280、<150kb、jpg、jpeg、png		 1、videos-url扩展视频url
2、videos-imgUrl视频图片url
3、productName商品名称
4、brandName品牌名称
5、brandLogo品牌图片地址
6、无
7、videos-imgUrl视频图片url

若想成功创建sdpa广告，则所选商品的信息中需包含相应字段，即：brandLogo、productName、brandName。若商品信息中不包含这些字段，则sdpa广告无法创建成功。可以在补齐相应必填字段后，重新进行创建流程即可创建成功。
同理，若需创建视频类商品广告创意，则商品信息中需包含视频素材信息。
 
**模板模式例：投放应用推广-信息流-横版大图sdpa广告，该广告创意所需的必填字段如下：模板、品牌logo、文案、品牌名称。
 

上述字段均需广告主在创建广告时根据接口文档中字段名自行填入（上述字段无需在商品库中必填，创建广告时仅拉取商品主图图片），即模板ID（该模板需绑定广告组所选商品库，并发布），品牌logo，文案、品牌名称。若不填入这些信息，则无法创建sdpa广告。
 

二、广告为异步创建，接口无法返回创建结果，如何查看创建结果？

进入营销平台web页面，查看商品广告组的操作日志，即可查询动态商品创意创建结果。

5.13 批量更新广告监测链接

基本信息

Path： /v3/ad/batchMonitorUrl

Method： POST

接口描述：

请求响应示例：

{
    "code": 0, 
    "msg": "添加成功",
    "data": [1234,234454,83784]
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是 multipart/form-data

Query

参数名称 必须 示例 备注
adIds[0] 是 广告ID列表
adIds[1] 是 广告ID列表
clickUrl 否 点击监测链接，监测链接不能都为空
exposeUrl 否 曝光监测链接，监测链接不能都为空

返回数据

名称类型必须默认值备注
code
integer否状态码
msg
string否错误信息
data
integer []否返回数据
否更新的广告ID列表

5.14 通知栏流量场景下的预览推送接口

基本信息

Path： /v3/ad/push/notifications/preview

Method： POST

接口描述：

请求响应示例：

{
    "code": 0, 
    "msg": "推送成功",
    "data": {
        "messageId":"test"
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是 multipart/form-data

Query

参数名称 必须 示例 备注
openId 是 手机imei
copywriter 是 广告文案
content 否 广告内容
globalSpecId 是 统一规格ID
imgMatId 否 图片素材id

返回数据

名称类型必须默认值备注
code
integer否状态码
msg
string否错误信息
data
object否返回数据
messageId
string否push推送的消息ID，即使推送失败，也有可能有message

5.2 获取单个广告创意详情

基本信息

Path： /v3/ad/get

Method： GET

接口描述：

SDK接入，请求方法：

omniAds.ads().v3AdGet(adId)

SDK请求参数：
adId ：广告ID
status字段是按照二进制位来表示内容含义的，下面表格的数字代表是第几个二进制位：

status
二进制位 解释
0 计划暂停
1 余额不足
2 达到计划预算
3 达到账户预算
8 广告组暂停
9 未开始
10 已结束
11 不在推广时段
12 App下架
13 App等级低
14 App版本过低
15 App已删除
16 快应用下架
17 必填规格异常
24 广告暂停

showStatus字段含义：
0 启动中
1 暂停中
2 广告组暂停
3 计划暂停
4 程序化广告待优选
获取单个广告创意详情：
请求参数：

adId=400080377

响应报文：

{
  "code": 0,
  "data": {
    "adId": 400080377,
    "adName": "网页推广_信息流_横版小图_创意1_2021/07/16_14:37:27",
    "status": 0,
    "status2": 0,
    "adSource": 1,
    "globalSpecId": 20,
    "adPlanId": 200013226,
    "adGroupId": 300026777,
    "copywriter": "这才是仙侠手游，装备全靠打，坐骑全靠抓",
    "copywriterId": 276198,
    "brandName": "手动阀",
    "buttonTxt": "",
    "imgMats": [
      {
        "materialUrl": "[https://adsfs.heytapimage.com/ads-material-depot/image/bd401ac3d925970681567e7e3145ebba.jpg](https://adsfs.heytapimage.com/ads-material-depot/image/bd401ac3d925970681567e7e3145ebba.jpg)",
        "mid": 29519483
      }
    ],
    "brandLogoImg": {
      "materialUrl": "[https://adsfs.heytapimage.com/ads-material-depot/image/8af3ea946324e8d9144ca6a09b5282a2.png](https://adsfs.heytapimage.com/ads-material-depot/image/8af3ea946324e8d9144ca6a09b5282a2.png)",
      "mid": 39108003
    },
    "exposeUrl": "",
    "clickUrl": "",
    "playBeginUrl": "",
    "playEndUrl": "",
    "downloadUrl": "",
    "dynamicCr": 0
  }
}




请求参数

Query

参数名称 必须 示例 备注
adId 是 adId

返回数据

名称类型必须默认值备注
code
integer否
msg
string否
data
object否
adId
integer否广告ID
adName
string否广告名称
openAdId
string否外部广告id
status
integer否广告详细状态
showStatus
integer否简化的状态
showStatusName
string否简化的状态中文解释
subShowStatusName
string否广告详细状态中文解释
status2
integer否广告启停状态：1:表示暂停;0表示启用
adSource
integer否广告来源，1:oppo
globalSpecId
integer否统一规格id
adPlanId
integer否计划ID
adGroupId
integer否广告组ID
copywriter
string否广告文案
copywriterId
integer否文案id
brandName
string否品牌名称
buttonTxt
string否按钮文案
imgMats
object []否图片素材id
mId
integer否素材id
materialUrl
string否素材地址
videoMats
object []否视频素材id
mId
integer否素材id
materialUrl
string否素材地址
brandLogoImg
object否品牌LOGO图片
mId
integer否素材id
materialUrl
string否素材地址
videoBgImg
object否视频结束背景图
mId
integer否素材id
materialUrl
string否素材地址
videoImg
object否视频封面图
mId
integer否素材id
materialUrl
string否素材地址
exposeUrl
string否曝光监测链接
clickUrl
string否点击监测链接
playBeginUrl
string否开始播放监测链接
playEndUrl
string否结束播放监测链接
downloadUrl
string否下载监测链接
dynamicCr
integer否是否开启了衍生 0否 1是
insertTime
integer否插入时间(秒级时间戳)
updateTime
integer否更新时间(秒级时间戳)
content
string否短文本规格的内容

5.3 获取广告组下广告详情列表

基本信息

Path： /v3/ad/list

Method： POST

接口描述：

获取广告组下广告详情列表(创意编辑时调用)
SDK接入，请求方法：

omniAds.ads().v3AdList(data)

SDK请求参数：

AdsAdCollectListReq data；
data.setXxx;
Long adGroupId 广告组ID  必传

请求参数：

adGroupId=300026777

响应报文：

{
  "code": 0,
  "data": [
    {
      "adId": 400080299,
      "adName": "网页推广_信息流_竖版大图_创意1_2021/07/16_14:16:52",
      "status": 0,
      "status2": 0,
      "adSource": 1,
      "globalSpecId": 50,
      "adPlanId": 200013226,
      "adGroupId": 300026777,
      "copywriter": "fodlord影院、gps、gf手机等都可以！",
      "copywriterId": 275876,
      "brandName": "諷德誦功",
      "buttonTxt": "",
      "imgMats": [
        {
          "materialUrl": "[https://adsfs.heytapimage.com/ads-material-depot/image/538884a95dd9376a90cd00b9ea560c0d.jpg](https://adsfs.heytapimage.com/ads-material-depot/image/538884a95dd9376a90cd00b9ea560c0d.jpg)",
          "mid": 43449718
        }
      ],
      "brandLogoImg": {
        "materialUrl": "[https://adsfs.heytapimage.com/ads-material-depot/image/06beaff00ca93854ba1eb77628a3ec02.jpg](https://adsfs.heytapimage.com/ads-material-depot/image/06beaff00ca93854ba1eb77628a3ec02.jpg)",
        "mid": 38704057
      },
      "exposeUrl": "",
      "clickUrl": "",
      "playBeginUrl": "",
      "playEndUrl": "",
      "downloadUrl": "",
      "dynamicCr": 0
    },
    {
      "adId": 400080301,
      "adName": "网页推广_信息流_横版视频_创意1_2021/07/16_14:16:52",
      "status": 0,
      "status2": 0,
      "adSource": 1,
      "globalSpecId": 60,
      "adPlanId": 200013226,
      "adGroupId": 300026777,
      "copywriter": "双方都",
      "copywriterId": 275973,
      "brandName": "手动阀",
      "buttonTxt": "",
      "videoMats": [
        {
          "materialUrl": "[https://adsfs.heytapimage.com/ads-material-depot/video/eadbc7109cd03726839bd986388ad27c.mp4](https://adsfs.heytapimage.com/ads-material-depot/video/eadbc7109cd03726839bd986388ad27c.mp4)",
          "mid": 38703350
        }
      ],
      "brandLogoImg": {
        "materialUrl": "[https://adsfs.heytapimage.com/ads-material-depot/image/06beaff00ca93854ba1eb77628a3ec02.jpg](https://adsfs.heytapimage.com/ads-material-depot/image/06beaff00ca93854ba1eb77628a3ec02.jpg)",
        "mid": 38704057
      },
      "videoImg": {
        "materialUrl": "[https://adsfs.heytapimage.com/ads-material-depot/image/a12f5e677eaeaafcd292fa58570ca5f1.jpg](https://adsfs.heytapimage.com/ads-material-depot/image/a12f5e677eaeaafcd292fa58570ca5f1.jpg)",
        "mid": 39107956
      },
      "exposeUrl": "",
      "clickUrl": "",
      "playBeginUrl": "",
      "playEndUrl": "",
      "downloadUrl": "",
      "dynamicCr": 0
    },
    {
      "adId": 400080377,
      "adName": "网页推广_信息流_横版小图_创意1_2021/07/16_14:37:27",
      "status": 0,
      "status2": 0,
      "adSource": 1,
      "globalSpecId": 20,
      "adPlanId": 200013226,
      "adGroupId": 300026777,
      "copywriter": "这才是仙侠手游，装备全靠打，坐骑全靠抓",
      "copywriterId": 276198,
      "brandName": "手动阀",
      "buttonTxt": "",
      "imgMats": [
        {
          "materialUrl": "[https://adsfs.heytapimage.com/ads-material-depot/image/bd401ac3d925970681567e7e3145ebba.jpg](https://adsfs.heytapimage.com/ads-material-depot/image/bd401ac3d925970681567e7e3145ebba.jpg)",
          "mid": 29519483
        }
      ],
      "brandLogoImg": {
        "materialUrl": "[https://adsfs.heytapimage.com/ads-material-depot/image/8af3ea946324e8d9144ca6a09b5282a2.png](https://adsfs.heytapimage.com/ads-material-depot/image/8af3ea946324e8d9144ca6a09b5282a2.png)",
        "mid": 39108003
      },
      "exposeUrl": "",
      "clickUrl": "",
      "playBeginUrl": "",
      "playEndUrl": "",
      "downloadUrl": "",
      "dynamicCr": 0
    }
  ]
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是 multipart/form-data

Query

参数名称 必须 示例 备注
adGroupId 是 广告组ID

返回数据

名称类型必须默认值备注
code
integer否
msg
string否
data
object []否
adId
integer否广告ID
adName
string否广告名称
openAdId
string否外部广告id
status
integer否广告状态(按位或)1:广告启停位(1:表示暂停;0表示启用)2:广告组启停位(1:表示暂停;0表示启用)4:计划启停位(1:表示暂停;0表示启用)8:应用状态位(1:应用导致暂停;0表示正常)16:余额状态位(1:余额导致暂停;0表示正常)32:限额状态位(1:限额导致暂停;0表示正常)
status2
integer否广告启停状态：1:表示暂停;0表示启用
adSource
integer否广告来源，1:oppo
globalSpecId
integer否统一规格id
adPlanId
integer否计划ID
adGroupId
integer否广告组ID
copywriter
string否广告文案
copywriterId
integer否文案id
brandName
string否品牌名称
buttonTxt
string否按钮文案
imgMats
object []否图片素材id
mId
integer否素材id
materialUrl
string否素材地址
videoMats
object []否视频素材
mId
integer否素材id
materialUrl
string否素材地址
brandLogoImg
object否品牌LOGO图片
mId
integer否素材id
materialUrl
string否素材地址
videoBgImg
object否视频结束背景图
mId
integer否素材id
materialUrl
string否素材地址
videoImg
object否视频封面图id
mId
integer否素材id
materialUrl
string否素材地址
exposeUrl
string否曝光监测链接
clickUrl
string否点击监测链接
playBeginUrl
string否开始播放监测链接
playEndUrl
string否结束播放监测链接
downloadUrl
string否下载监测链接
dynamicCr
integer否是否开启了衍生 0否 1是
insertTime
integer否插入时间(秒级时间戳)
updateTime
integer否更新时间(秒级时间戳)
content
string否短文本规格下的内容

5.4 分页获取广告创意列表

基本信息

Path： /v3/ad/page

Method： POST

接口描述：

特别说明：计划、广告组、广告分页查询接口返回的数据字段具有共性，因此返回的数据字段请参考API文档：公共部分 -> 对接必读 -> 1.9节

SDK接入，请求方法：

omniAds.ads().v3AdPage(data)

SDK请求参数：

AdsAdListForm data;
data.setXxx;
page: 1       分页页号   必传

limit: 25    分页大小   必传


beginTime: 20210720


endTime: 20210720


deleteFlag: 0   是否删除,0 未删除 1 删除


String orderByColumn: ad_id    排序的数据列


asc: DESC       排序方式,ASC-顺序 DESC-逆序

status字段是按照二进制位来表示内容含义的，下面表格的数字代表是第几个二进制位：

status
二进制位 解释
0 计划暂停
1 余额不足
2 达到计划预算
3 达到账户预算
8 广告组暂停
9 未开始
10 已结束
11 不在推广时段
12 App下架
13 App等级低
14 App版本过低
15 App已删除
16 快应用下架
17 必填规格异常
24 广告暂停

showStatus字段含义：
0 启动中
1 暂停中
2 广告组暂停
3 计划暂停分页获取广告创意列表
请求参数：

page: 1
limit: 25
beginTime: 20210720
endTime: 20210720
deleteFlag: 0
orderByColumn: ad_id
asc: DESC

响应报文：

{
  "code": 0,
  "data": {
    "pageNum": 1,
    "pageSize": 25,
    "total": 4,
    "totalPage": 1,
    "records": [
      {
        "status": 2,
        "statusName": "",
        "showStatus": 3,
        "showStatusName": "审核中",
        "status2": 0,
        "deleteFlag": 0,
        "planId": 200013226,
        "planName": "网页推广_2021/07/16_14:16:31",
        "extensionType": 1,
        "extensionTypeName": "网页推广",
        "adGroupId": 300026777,
        "adGroupName": "网页推广_自有流量_2021/07/16_14:16:34",
        "extensionFlow": 2,
        "extensionFlowName": "自有流量",
        "flowScene": 6,
        "flowSceneName": "信息流",
        "price": "2.00",
        "ocpcPrice": "3.00",
        "ocpcType": 6,
        "ocpcTypeName": "线索提交",
        "deepOcpcType": 0,
        "deepOcpcTypeName": "",
        "ocpcState": "点击阶段",
        "dynamicPrice": 2,
        "adId": 400080377,
        "adName": "网页推广_信息流_横版小图_创意1_2021/07/16_14:37:27",
        "auditStatus": 3,
        "auditDesc": "审核拒绝;测试广告;",
        "creativeTypeName": "",
        "globalSpecId": 20,
        "globalSpecName": "横版小图"
      },
      {
        "status": 2,
        "statusName": "审核拒绝;测试广告;",
        "showStatus": 3,
        "showStatusName": "审核拒绝",
        "status2": 0,
        "deleteFlag": 0,
        "planId": 200013226,
        "planName": "网页推广_2021/07/16_14:16:31",
        "extensionType": 1,
        "extensionTypeName": "网页推广",
        "adGroupId": 300026777,
        "adGroupName": "网页推广_自有流量_2021/07/16_14:16:34",
        "extensionFlow": 2,
        "extensionFlowName": "自有流量",
        "flowScene": 6,
        "flowSceneName": "信息流",
        "price": "2.00",
        "ocpcPrice": "3.00",
        "ocpcType": 6,
        "ocpcTypeName": "线索提交",
        "deepOcpcType": 0,
        "deepOcpcTypeName": "",
        "ocpcState": "点击阶段",
        "dynamicPrice": 2,
        "adId": 400080301,
        "adName": "网页推广_信息流_横版视频_创意1_2021/07/16_14:16:52",
        "auditStatus": 2,
        "auditDesc": "审核拒绝;测试广告;",
        "creativeTypeName": "",
        "globalSpecId": 60,
        "globalSpecName": "横版视频"
      },
      {
        "status": 2,
        "statusName": "审核拒绝;测试广告",
        "showStatus": 3,
        "showStatusName": "审核拒绝",
        "status2": 0,
        "deleteFlag": 0,
        "planId": 200013226,
        "planName": "网页推广_2021/07/16_14:16:31",
        "extensionType": 1,
        "extensionTypeName": "网页推广",
        "adGroupId": 300026777,
        "adGroupName": "网页推广_自有流量_2021/07/16_14:16:34",
        "extensionFlow": 2,
        "extensionFlowName": "自有流量",
        "flowScene": 6,
        "flowSceneName": "信息流",
        "price": "2.00",
        "ocpcPrice": "3.00",
        "ocpcType": 6,
        "ocpcTypeName": "线索提交",
        "deepOcpcType": 0,
        "deepOcpcTypeName": "",
        "ocpcState": "点击阶段",
        "dynamicPrice": 2,
        "adId": 400080299,
        "adName": "网页推广_信息流_竖版大图_创意1_2021/07/16_14:16:52",
        "auditStatus": 2,
        "auditDesc": "审核拒绝;测试广告",
        "creativeTypeName": "",
        "globalSpecId": 50,
        "globalSpecName": "竖版大图"
      },
      {
        "status": 2,
        "statusName": "审核拒绝;测试",
        "showStatus": 3,
        "showStatusName": "审核拒绝",
        "status2": 0,
        "deleteFlag": 0,
        "planId": 200012858,
        "planName": "网页推广_2021/07/15_20:27:12",
        "extensionType": 1,
        "extensionTypeName": "网页推广",
        "adGroupId": 300026229,
        "adGroupName": "网页推广_自有流量_2021/07/15_23:26:58",
        "extensionFlow": 2,
        "extensionFlowName": "自有流量",
        "flowScene": 5,
        "flowSceneName": "搜索",
        "price": "2.00",
        "ocpcType": 0,
        "ocpcTypeName": "",
        "deepOcpcType": 0,
        "deepOcpcTypeName": "",
        "ocpcState": "-",
        "dynamicPrice": 2,
        "adId": 400078173,
        "adName": "网页推广_搜索_图标大图_创意1_2021/07/15_23:27:30",
        "auditStatus": 2,
        "auditDesc": "审核拒绝;测试",
        "creativeTypeName": "",
        "globalSpecId": 71,
        "globalSpecName": "图标大图"
      }
    ]
  }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是 multipart/form-data

Query

参数名称 必须 示例 备注
adGroupIds 否 广告组ID列表
adIds 否 广告ID列表
adNameLike 否 广告名称
asc 否 排序方式,ASC-顺序 DESC-逆序
auditStatusSet 否 审核状态列表,审核中-0 审核拒绝-2
beginTime 否 开始日期，如20210621
endTime 否 结束日期，如20210621
extensionFlows 否 推广流量列表，1-全流量 2-自有流量 3-联盟流量
extensionTypes 否 推广目标列表，1：链接推广 2：应用推广 3
flowScenes 否 流量场景枚举值列表：1-全流量场景，2-精选推荐，3-安装有礼，4-开机必备，5-搜索，6-信息流，7-Banner，8-开屏，9-插屏，10-原生，11-激励视频，12-联盟通投，13-展示优选，14-通知栏
globalSpecIds 否 创意规格列表，/spec/list规格查询接口返回，另可参考附录-规格部分
limit 是 页大小，取值范围[1,1000]
orderByColumn 否 排序的数据列：
adId：广告Id
adName：广告名称
price：基础出价
ocpcPrice:转化出价
deepOcpcPrice：深度转化出价
page 是 页号
planIds 否 广告计划ID列表
showStatusSet 否 展示状态列表，启动中-0 暂停中-1 广告组暂停-2 计划暂停-3
needStats 否 是否查询数据字段，0表示不查询，1表示查询（推荐使用0以提高性能）

返回数据

名称类型必须默认值备注
code
integer否
msg
string否
data
object否
pageNum
integer否页码
pageSize
integer否每页大小
total
integer否数据总条数
totalPage
integer否总页数
records
object []否数据集合
status
integer否详细状态
subShowStatusName
string否详细状态名称
showStatus
integer否前端展示状态
showStatusName
string否前端展示状态描述
status2
integer否投放开关 0-开启 1-关闭
deleteFlag
integer否删除状态 0-未删除 1-已删除
planId
integer否广告计划ID
planName
string否广告计划名称
extensionType
integer否推广目标 1：链接推广 2：应用推广-应用下载 3：快应用推广 6：应用推广-应用调起 7：小程序推广 8：直播推广
extensionTypeName
string否推广目标名称
dayBudget
string否计划日预算，分为单位
adGroupId
integer否广告组ID
adGroupName
string否广告组名称
extensionFlow
integer否推广流量
extensionFlowName
string否推广流量名称
flowScene
integer否流量场景
flowSceneName
string否流量场景名称
price
string否基础出价，元为单位
ocpcPrice
string否转化出价，元为单位
ocpcType
integer否转化类型
ocpcTypeName
string否转化类型名称
deepOcpcPrice
string否深度转化出价，元为单位
deepOcpcType
integer否深度转化类型
deepOcpcTypeName
string否深度转化类型名称
ocpcState
string否ocpc转化阶段 1-点击阶段, 2-转化阶段, 3-深度转化阶段
targetROI
string否目标ROI系数
dynamicPrice
integer否动态出价
adId
integer否广告ID
adName
string否广告名称
auditStatus
integer否审核状态
auditDesc
string否审核原因
creativeTypeName
string否创意类型
globalSpecId
integer否创意规格
globalSpecName
string否创意规格名称
vrType
integer否创意类型，5：程序化创意，6：动态商品创意，其他为自定义创意
vrTypeName
string否创意类型名称
insertTime
integer否记录插入时间(秒级时间戳)
updateTime
integer否记录更新时间(秒级时间戳)
cost
string否消耗金额，元为单位
expose
string否曝光量
click
string否点击量
clickRate
string否点击率
download
string否下载量
downloadRate
string否下载率
ecpm
string否ecpm，元为单位
formCnt
string否表单提交量
formCntPrice
string否表单提交成本，元为单位
convertActive
string否回传激活量
convertActivePrice
string否回传激活成本，元为单位
convertRegister
string否注册量
convertRegisterPrice
string否注册成本，元为单位
convertRetention
string否回传留存
convertRetentionPrice
string否回传留存成本，元为单位
convertAppCredit
string否应用内授信
convertAppCreditPrice
string否应用内授信成本，元为单位
convertAppOrder
string否应用内下单
convertAppOrderPrice
string否应用内下单成本，元为单位
convertAppPay
string否应用内付费
convertAppPayPrice
string否应用内付费成本，元为单位
convertAppCustom
string否应用内自定义转化
convertAppCustomPrice
string否应用内自定义转化成本，元为单位
convertDp
string否回传拉活
convertDpPrice
string否回传拉活成本，元为单位
dpConvertActivationNums
string否deeplink回传激活量
dpConvertActivationPrice
string否deeplink回传激活成本
dpConvertRegisterNums
string否deeplink回传注册量
dpConvertRegisterPrice
string否deeplink回传注册成本
dpAppPayNums
string否deeplink应用付费量
dpAppPayPrice
string否deeplink应用付费成本
dpUdConvertNums
string否deeplink自定义转化量
dpUdConvertPrice
string否deeplink自定义转化成本
dpAppCreditNums
string否deeplink应用内授信量
dpAppCreditPrice
string否deeplink应用内授信成本
dpAppOrderNums
string否deeplink应用内下单量
dpAppOrderPrice
string否deeplink应用内下单成本
quickAppPay
string否快应用付费
quickAppPayPrice
string否快应用付费成本
adServingType
string否投放模式，0-普通投放 1-跟随投放
followMaxPrice
string否更随最高价格
followAppIdList
integer []否跟随appId列表
defaultSecondStage
integer否是否免一阶
dpConvertRetentionNums
string否deeplink回传存留量
dpConvertRetentionPrice
string否deeplink回传存留成本
qappQuickLnkNums
string否快应用加桌量
qappQuickLnkPrice
string否快应用加桌成本
quickAppActNum
string否快应用关键行为量
quickAppActCost
string否快应用关键行为成本
convertRetentionRate
string否回传次留率
formKeyActNums
string否表单关键行为量
formKeyActPrice
string否表单关键行为成本
effectConsultNums
string否有效咨询量
effectConsultPrice
string否有效咨询成本
wechatFocusNums
string否微信关注量
wechatFocusPrice
string否微信关注成本
webPageBuyNums
string否网页购买量
webPageBuyPrice
string否网页购买成本
callUpNums
string否拨打电话量
callUpPrice
string否拨打电话成本
gameAppActNums
string否游戏关键行为量
gameAppActPrice
string否游戏关键行为成本
dpConvertRetentionRate
string否（DP拉活）回传留存率
wechatGameRegister
string否微信小游戏注册量
wechatGameRegisterPrice
string否微信小游戏注册成本
wechatGamePay
string否微信小游戏付费量
wechatGamePayPrice
string否微信小游戏付费成本
payNums
string否付费次数
payPerPrice
string否每次付费成本
convertRetention3
string否第3日留存
convertRetention4
string否第4日留存
convertRetention5
string否第5日留存
convertRetention6
string否第6日留存
convertRetention7
string否第7日留存
wechatGamePayCost
string否微信小游戏付费总额
firstPayNum
string否微信小游戏首次付费人数
wechatGameRoi1
string否微信小游戏ROI1
convertRetention3Rate
string否第3日留存率
convertRetention4Rate
string否第4日留存率
convertRetention5Rate
string否第5日留存率
convertRetention6Rate
string否第6日留存率
convertRetention7Rate
string否第7日留存率
lt7
string否LT7总留存
lt7Rate
string否LI7总留存率
registerAppPayRate
string否注册-应用付费率
bookNums
string否预约量
cancelBookNums
string否取消预约量
bookDownloadNums
string否预约下载量
convertLongRetentionNums
string否长留自定义转化量
convertLongRetentionPrice
string否长留自定义转化成本
convertPerPayNums
string否每次付费转化量
convertPerPayPrice
string否每次付费成本
roi14
string否roi14
ltv14
string否ltv14
cateName
string否行业一级分类
subCateName
string否行业二级分类
thirdCateName
string否行业三级分类
quickAppActRate
string否快应用关键行为转化率
convertPayCost
string否付费金额
appRoi
string否appRoi

5.5 批量操作广告创意(新增编辑删除)

基本信息

Path： /v3/ad/batch

Method： POST

接口描述：

批量操作(新增/编辑/删除)广告创意(新增和编辑限制同一个广告组下，删除不限制，可操作1-50个)
###前置调用接口###：
【1.查询规格详情】
请求地址：

/v3/communal/spec/list

请求参数：

flowScene=1
extensionType=2
extensionFlow=1

响应报文：

{
  "code": 0,
  "data": [
    {
      "mSpecName": "横版大图",
      "extensionType": 1,
      "flowScene": 6,
      "globalSpecId": 1,
      "format": "{"bdName":{"maxLen":18,"minLen":1},"brandLogo":{"fmt":["jpg","png","jpeg"],"h":200,"s":100,"w":200},"buttonTxt":{"maxLen":4,"minLen":1},"imgs":[{"fmt":["jpg","png","jpeg"],"h":720,"s":150,"w":1280}],"repeat":false,"title":{"maxLen":35,"minLen":1},"videoBgImg":{},"videoImg":{},"videoList":[]}",
      "demoUrl": "https://adsfs.oppomobile.com/union/union_advert/adtype_demo/v2-raw-large-app.jpg",
      "required": "{"imgs": 1,"title":1,"bdName":1,"brandLogo":2}"
    },
    {
      "mSpecName": "竖版大图",
      "extensionType": 1,
      "flowScene": 6,
      "globalSpecId": 50,
      "format": "{"bdName":{"maxLen":8,"minLen":1},"brandLogo":{"fmt":["jpg","png","jpeg"],"h":200,"s":100,"w":200},"buttonTxt":{"maxLen":4,"minLen":1},"imgs":[{"fmt":["jpg","png","jpeg"],"h":1920,"s":300,"w":1080,"whSc":["9: 16"]}],"repeat":false,"title":{"maxLen":23,"minLen":1},"videoBgImg":{},"videoImg":{},"videoList":[]}",
      "demoUrl": "https://adsfs.oppomobile.com/union/union_advert/adtype_demo/v2-raw-large-app.jpg",
      "required": "{"imgs": 1,"title":1,"bdName":1,"brandLogo":1}"
    },
    {
      "mSpecName": "横版小图",
      "extensionType": 1,
      "flowScene": 6,
      "globalSpecId": 20,
      "format": "{"bdName":{"maxLen":8},"brandLogo":{"fmt":["jpg","png","jpeg"],"h":200,"s":100,"w":200},"buttonTxt":{"maxLen":4},"imgs":[{"fmt":["jpg","png","jpeg"],"h":210,"s":100,"w":320}],"repeat":false,"title":{"maxLen":23}}",
      "demoUrl": "https://adsfs.oppomobile.com/union/union_advert/adtype_demo/v2-raw-large-app.jpg",
      "required": "{"imgs": 1,"title":1,"bdName":1,"brandLogo":1}"
    },
    {
      "mSpecName": "横版组图",
      "extensionType": 1,
      "flowScene": 6,
      "globalSpecId": 30,
      "format": "{"bdName":{"maxLen":18},"brandLogo":{"fmt":["jpg","png","jpeg"],"h":200,"s":100,"w":200},"buttonTxt":{"maxLen":4},"imgs":[{"fmt":["jpg","png","jpeg"],"h":210,"s":100,"w":320},{"fmt":["jpg","png","jpeg"],"h":210,"s":100,"w":320},{"fmt":["jpg","png","jpeg"],"h":210,"s":100,"w":320}],"repeat":false,"title":{"maxLen":35}}",
      "demoUrl": "https://adsfs.oppomobile.com/union/union_advert/adtype_demo/v2-raw-large-app.jpg",
      "required": "{"imgs": 1,"title":1,"bdName":1,"brandLogo":1}"
    },
    {
      "mSpecName": "横版视频",
      "extensionType": 1,
      "flowScene": 6,
      "globalSpecId": 60,
      "format": "{"bdName":{"maxLen":18,"minLen":1},"brandLogo":{"fmt":["jpg","png","jpeg"],"h":200,"s":100,"w":200},"buttonTxt":{"maxLen":4,"minLen":1},"imgs":[],"repeat":false,"title":{"maxLen":35,"minLen":1},"videoBgImg":{"fmt":["png","jpg","jpeg"],"h":1280,"s":150,"w":720},"videoImg":{"fmt":["png","jpg","jpeg"],"h":720,"s":150,"w":1280},"videoList":[{"fmt":["mp4"],"h":0,"maxDrt":60000,"minDrt":0,"s":25600,"w":0,"whSc":["16: 9"]}]}",
      "demoUrl": "https://adsfs.oppomobile.com/union/union_advert/adtype_demo/v2-raw-large-app.jpg",
      "required": "{"videoList":1,"videoImg":1,"title":1,"bdName":1,"brandLogo":1}"
    },
    {
      "mSpecName": "竖版视频",
      "extensionType": 1,
      "flowScene": 6,
      "globalSpecId": 63,
      "format": "{"bdName":{"maxLen":8,"minLen":1},"brandLogo":{"fmt":["jpg","png","jpeg"],"h":200,"s":100,"w":200},"buttonTxt":{"maxLen":4,"minLen":1},"imgs":[],"repeat":false,"title":{"maxLen":23,"minLen":1},"videoBgImg":{"fmt":["jpg","png","jpeg"],"h":1280,"s":150,"w":720},"videoImg":{"fmt":["jpg","png","jpeg"],"h":1280,"s":150,"w":720},"videoList":[{"fmt":["mp4"],"h":0,"maxDrt":60000,"minDrt":0,"s":25600,"w":0,"whSc":["9: 16"]}]}",
      "demoUrl": "https://adsfs.oppomobile.com/union/union_advert/adtype_demo/v2-raw-large-app.jpg",
      "required": "{"videoList":1,"videoImg":1,"title":1,"bdName":1,"brandLogo":1}"
    }
  ]
}

其中required字段表明当前规格哪些元素必填，1必填，2选填，没有描述就不能传，format部分为规格限制详情，更多详情及其与v3/ad/batch接口的参数的关系~~~~ 参考/spec/list接口文档
【2.从素材库查询素材（非必须）】
请求地址：

/creative/material/image/getList

请求参数：

size=102400
dimension=200*200
page=1
pageSize=10
suffixes=jpg
suffixes=png
suffixes=jpeg

【3.上传素材(非必须)】
请求地址：

/creative/material/v3/communal/upload

【4.获取按钮文案】
请求地址：

/v3/communal/config/getList

请求参数：

type=BUTTON_TITLE

【5.获取必填规格】
请求地址：

/v3/communal/config/getList

请求参数：

type=REQUIRED_SPEC_TYPE
extensionFlow=1
flowScene=1

举例：
1 批量删除
请求参数：

delList[0].adId: 400091099
delList[1].adId: 400091092

响应报文：

{"code":0,"data":[]}

2 编辑或新增广告创意
参考《典型场景举例部分》

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是 multipart/form-data

Query

参数名称 必须 示例 备注
addList[0].adGroupId 是 广告组ID[新增、编辑时必填]
addList[0].adId 是 广告ID[编辑时必填]
addList[0].adName 是 广告名称[新增时必填]
addList[0].adPlanId 是 计划ID[新增、编辑时必填]
addList[0].brandLogoImgId 否 品牌LOGO图片id
addList[0].brandName 否 品牌名称
addList[0].buttonTxt 否 按钮文案
addList[0].clickUrl 否 点击监测链接
addList[0].copywriter 否 广告文案
流程场景为网络消息下规格的标题
addList[0].copywriterId 否 文案id
addList[0].downloadUrl 否 下载监测链接
addList[0].dynamicCr 否 是否衍生 0-否 1-是（目前只有横版大图支持衍生视频创意）
addList[0].exposeEndUrl 否 曝光结束监测链接
addList[0].exposeUrl 否 曝光监测链接
addList[0].globalSpecId 是 统一规格ID[新增时必填]
备注：通知栏流量场景下的中图为图标大图，globalSpecId=71
addList[0].imgMatIds 否 图片素材id
addList[0].playBeginUrl 否 开始播放监测链接
addList[0].playEndUrl 否 结束播放监测链接
addList[0].status 否 广告状态(按位或)1
addList[0].videoBgImgId 否 视频结束背景图id
addList[0].videoImgId 否 视频封面图id
addList[0].videoMatIds 否 视频素材id
addList[0].interactMatIds 否 互动素材id
addList[0].content 否 流量场景为通知栏下规格的内容
流程场景为网络消息下规格的描述
delList[0].adId 是 广告ID[删除时必填]
editList[0].adGroupId 是 广告组ID[新增、编辑时必填]
editList[0].adId 是 广告ID[编辑时必填]
editList[0].adName 是 广告名称[新增时必填]
editList[0].adPlanId 是 计划ID[新增、编辑时必填]
editList[0].brandLogoImgId 否 品牌LOGO图片id
editList[0].brandName 否 品牌名称
editList[0].buttonTxt 否 按钮文案
editList[0].clickUrl 否 点击监测链接
editList[0].copywriter 否 广告文案
流程场景为网络消息下规格的标题
editList[0].copywriterId 否 文案id
editList[0].downloadUrl 否 下载监测链接
editList[0].dynamicCr 否 是否衍生 0-否 1-是 若已经开启衍生 不允许关闭（目前只有横版大图支持衍生视频创意）
editList[0].exposeEndUrl 否 曝光结束监测链接
editList[0].exposeUrl 否 曝光监测链接
editList[0].globalSpecId 是 统一规格ID[新增时必填]
备注：通知栏流量场景下的中图为图标大图，globalSpecId=71
editList[0].imgMatIds 否 图片素材id
editList[0].playBeginUrl 否 开始播放监测链接
editList[0].playEndUrl 否 结束播放监测链接
editList[0].status 否 广告状态(按位或)1
editList[0].videoBgImgId 否 视频结束背景图id
editList[0].videoImgId 否 视频封面图id
editList[0].videoMatIds 是 视频素材id
editList[0].interactMatIds 是 互动素材id
editList[0].content 否 流量场景为通知栏下规格的内容
流程场景为网络消息下规格的描述

返回数据

名称类型必须默认值备注
code
integer否
msg
string否
data
integer []否

5.6 获取衍生广告映射关系

基本信息

Path： /v3/ad/deriveMapping

Method： GET

接口描述：

响应参数解释：

flag结果标记 
0-传入参数为原广告 没有衍生成功/没有开启衍生/广告不属于广告主 
1-传入参数为原广告
2-传入参数为衍生广告id

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
adId 是 401033536 原广告Id/衍生广告id

返回数据

{
    "code": 0,
    "data": {
        "adId": 401033530,
        "deriveAdId": 401033653,
        "flag": 2
    }
}

5.7 操作商品广告创意（弃用）

基本信息

Path： /v3/ad/dpa_strategy/save

Method： POST

接口描述：

响应报文：

{
    "code": 0, 
    "data": 1
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
adGroupId 是 广告组ID
adName 是 广告名称
globalSpecId 是 统一规格ID
copywriter 否 广告文案
brandName 否 品牌名称
brandLogoImgId 否 品牌LOGO图片id
buttonTxt 否 按钮文案
creativeModeType 是 动态商品广告 创意模式：0-直投模式，1-模板模式
creativeTemplateId 否 动态商品广告模板模式下的模板ID
exposeUrl 否 曝光监测链接，只支持https协议
clickUrl 否 点击监测链接，只支持https协议

返回数据

名称类型必须默认值备注
code
number是返回状态码，0表示成功，非0表示失败
msg
string否错误信息
data
number是添加，编辑成功条数

5.8 查询商品广告创意（弃用）

基本信息

Path： /v3/ad/dpa_strategy/get

Method： POST

接口描述：

响应报文：

{
    "code": 0, 
    "data": {
        "adGroupId": 300462885, 
        "adName": "动态商品创意_2023/04/23_10:41:55", 
        "globalSpecId": 1, 
        "copywriter": "岁的法国", 
        "copywriterId": null, 
        "brandName": "是", 
        "brandLogoImgId": 44241073, 
        "brandLogoImgUrl": "https://adsfs-ads-test.wanyol.com/ads-material-depot/image/920239415735631dfe029dac993a7f32.jpg", 
        "buttonTxt": "", 
        "creativeModeType": 0, 
        "creativeTemplateId": 0, 
        "exposeUrl": "", 
        "clickUrl": ""
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
adGroupId 是 广告组ID

返回数据

名称类型必须默认值备注
code
number是返回状态码，0表示成功，非0表示失败
msg
string否错误信息
data
object否动态商品创意信息
adGroupId
number否广告组ID
adName
string否广告名称
globalSpecId
number否统一规格ID
copywriter
string否广告文案
brandName
string否品牌名称
brandLogoImgId
number否品牌LOGO图片id
brandLogoImgUrl
string否品牌LOGO图片链接
buttonTxt
string否按钮文案
creativeModeType
number否动态商品广告 创意模式：0-直投模式，1-模板模式
creativeTemplateId
number否动态商品广告模板模式下的模板ID
exposeUrl
string否曝光监测链接
clickUrl
string否点击监测链接

5.9 新增商品广告创意（新）

基本信息

Path： /v3/ad/dpa_strategy/add

Method： POST

接口描述：

备注：
1、动态商品创意【模板模式】新增了对多规格（横板大图、竖版大图）的支持，调用新增商品创意（/v3/ad/dpa_strategy/add）接口时，单次只能添加一种规格的模板创意
2、如果要在动态商品创意【模板模式】下添加多个规格（同一个广告组），需要多次调用新增商品创意的接口（传入不同的规格ID）

响应报文：

{
    "code": 0, 
    "data": 1
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 必须 示例 备注
adGroupId 文本 是 3241344 广告组ID
adName 文本 是 sdpaxxx 广告名称前缀
globalSpecId 文本 是 1 统一规格id ,1-横版大图 50-竖版大图 60-横版视频 63-竖版视频
creativeTemplateId 文本 否 123123 模板模式参数 模板id 模板模式专用（若广告组所选商品库为模板模式，则该字段必填）
templateBrandLogoImgId 文本 否 123121 品牌LOGO图片id 需要先上传品牌logo获取到素材库id 模板模式专用（若广告组所选商品库为模板模式，则该字段必填）
templateButtonTxt 文本 否 打开 按钮文案 模板模式专用（若广告组所选商品库为模板模式，则该字段必填）
templateCopywriter 文本 否 百亿补贴 广告文案 模板模式专用（若广告组所选商品库为模板模式，则该字段必填）
templateBrandName 文本 否 拼多多 品牌名称 模板模式专用（若广告组所选商品库为模板模式，则该字段必填）
customizeProductInfo[0].dpaProductId 文本 否 233333 dpa商品id 直投模式专用（该字段非必填，如果用户想自定义某个商品id的信息需要填写相关信息 如果想自动生成则不需要填写。）
customizeProductInfo[0].copywriter 文本 否 广告文案 直投模式专用（该字段非必填，如果用户想自定义某个商品id的信息需要填写相关信息 如果想自动生成则不需要填写。）
customizeProductInfo[0].buttonTxt 文本 否 按钮文案 直投模式专用（该字段非必填，如果用户想自定义某个商品id的信息需要填写相关信息 如果想自动生成则不需要填写。）
exposeUrl 文本 否 https://sdfafasdfa 曝光监测链接
clickUrl 文本 否 https://sdfafasdfa 点击监测链接

返回数据

名称类型必须默认值备注
code
number是返回状态码，0表示成功，非0表示失败
msg
string是错误信息
data
number是创建广告为异步创建，返回的条数为即将创建的广告的条数

6.【数据】数据相关

6.1 广告汇总数据查询-子客户

基本信息

Path： /v3/data/common/summary/queryAdData

Method： POST

接口描述：

SDK接入请求方法：

omniAds.adsData().v3QueryAdData(map);

请求参数示例：（同SDK请求参数）

{
  "endTime": 20210531,
  "beginTime": 20210401,
  "timeLevel": "DAY",
  "paraMap": {
    "filter_zero": 0
  }
}

返回参数示例：

{
    "code": 0,
    "data": {
        "owner_id": "1100050065",
        "click_rate": 0,
        "dp_app_credit_price": 0,
        "dp_app_order_price": 0,
        "download": 0,
        "dp_convert_register_price": 0,
        "convert_app_pay": 0,
        "dp_ud_convert_nums": 0,
        "click_price": 0,
        "ad_group_id": "0",
        "convert_register": 0,
        "app_id": "0",
        "dp_ud_convert_price": 0,
        "convert_app_order": 0,
        "dp_app_credit_nums": 0,
        "global_spec_id": "0",
        "owner_name": "0",
        "convert_app_credit_price": 0,
        "click": 0,
        "plan_name": "0",
        "form_cnt": 0,
        "quick_app_pay": 0,
        "ad_group_name": "0",
        "ad_id": "0",
        "ecpm": 0,
        "quick_app_pay_price": 0,
        "form_price": 0,
        "convert_app_custom": 0,
        "dp_convert_register_nums": 0,
        "convert_retention_price": 0,
        "convert_app_order_price": 0,
        "convert_dp": 0,
        "flow_scene": "0",
        "download_rate": 0,
        "convert_register_price": 0,
        "convert_active_price": 0,
        "convert_app_credit": 0,
        "dp_convert_activation_price": 0,
        "convert_app_custom_price": 0,
        "dp_convert_activation_nums": 0,
        "convert_dp_price": 0,
        "download_price": 0,
        "cost": 0.00,
        "dp_app_pay_price": 0,
        "ad_name": "0",
        "expose": 0,
        "extension_flow": "0",
        "convert_retention": 0,
        "convert_app_pay_price": 0,
        "app_name": "0",
        "dp_app_order_nums": 0,
        "extension_type": "0",
        "convert_active": 0,
        "plan_id": "0",
        "dp_app_pay_nums": 0
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是 application/json

Body

名称类型必须默认值备注
beginTime
integer否起始时间 不填的话默认是当天如20201001 beginTime endTime须配合使用
endTime
integer否结束时间 不填的话默认是当天如20201001 beginTime endTime须配合使用
orderByColumns
string否数据排序字段，不传则按默认排序-数据插入顺序 建议：ftime 可以排序的字段： ad_group_id、ad_id、app_id、owner_id、plan_id、quick_app_pay、quick_app_pay_price click、click_price、click_rate、convert_active、convert_active_price、convert_app_pay、convert_dp、convert_app_pay_price、 convert_dp_price、convert_register、convert_register_price、convert_retention_price、download、download_price、 download_rate、dp_app_credit_nums、dp_app_credit_nums_price、dp_app_order_nums、dp_app_order_nums_price、 dp_app_pay_nums、dp_app_pay_nums_price、dp_convert_activation_nums、dp_convert_register_nums、dp_ud_convert_nums、 dp_ud_convert_nums_price、ecpm、expose
ascDesc
string否DESC正序逆序 可取值 ASC DESC两种 不可取其他值 支持大小写
page
integer否1分页起始
pageCount
integer否10分页大小
paraMap
object否与业务相关的具体参数
adGroupIds
string []否广告组ID集合
extensionFlowList
string []否推广流量集合
否1.全流量场景，2自由流量，3联盟流量
extensionTypeList
string []否推广目标集合
否 1:链接推广 2:应用推广 3:快应用推广 7:微信小程序推广 8:直播推广
flowSceneList
string []否流量场景集合
否流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频、12联盟不限、13展示优选、14通知栏、15网络消息
planIds
string []否计划id集合
filter_zero
integer否是否过滤真实消耗等于0的数据，1：过滤； 其余不过滤
globalSpecIdList
integer []否创意规格id集合
adIds
string []否广告id集合
costFloor
integer否消耗金额大于
costCeiling
integer否消耗金额小于
exposeFloor
integer否曝光量大于
exposeCeiling
integer否曝光量小于
clickFloor
integer否点击量大于
clickCeiling
integer否点击量小于
downloadFloor
integer否下载量大于
downloadCeiling
integer否下载量小于
ecpmFloor
integer否ecpm大于
ecpmCeiling
integer否ecpm小于

返回数据

名称类型必须默认值备注
code
integer是状态码 0请求正常 1系统异常 11001:服务端异常 110000：参数错误 110002：用户不存在或已过期，请重新登录 110003：无效的接口查询路径 110101：查询天数不合法，具体见msg 110104：超过批量查询最大限制，默认500 其余请看msg
msg
string是具体信息
data
object是
ad_group_id
string否广告组id
ad_group_name
string否广告组名称
ad_id
string否广告id
ad_name
string否广告名称
app_id
string否应用id
app_name
string否应用名称
click
integer否点击量
click_price
number否点击均价（单位：分）
click_rate
number否点击率
convert_active
integer否回传激活量
convert_active_price
number否回传激活均价（单位：分）
convert_app_credit
integer否应用内授信
convert_app_credit_price
number否应用内授信均价（单位：分）
convert_app_custom
integer否自定义转化
convert_app_custom_price
number否自定义转化均价（单位：分）
convert_app_order
integer否应用内下单
convert_app_order_price
number否应用内下单均价（单位：分）
convert_app_pay
integer否应用内付费
convert_app_pay_price
number否应用内付费均价（单位：分）
convert_dp
integer否dp回传拉活量
convert_dp_price
number否dp回传拉活均价（单位：分）
convert_register
integer否回传注册量
convert_register_price
number否回传注册均价（单位：分）
convert_retention
integer否回传留存量
convert_retention_price
number否回传留存均价（单位：分）
cost
integer否消耗（实扣，单位分）
download
integer否下载量
download_price
number否下载均价（单位：分）
download_rate
number否下载率
dp_app_credit_nums
integer否dp应用内授信量
dp_app_credit_price
number否dp应用内授信均价（单位：分）
dp_app_order_nums
integer否dp应用内下单量
dp_app_order_price
number否dp应用内下单均价（单位：分）
dp_app_pay_nums
integer否dp应用内付费量
dp_app_pay_price
number否dp应用内付费均价（单位：分）
dp_convert_activation_nums
integer否dp回传激活量
dp_convert_activation_price
number否dp回传激活均价（单位：分）
dp_convert_register_nums
integer否dp回传注册量
dp_convert_register_price
number否dp回传注册均价（单位：分）
dp_ud_convert_nums
integer否dp自定义转化量
dp_ud_convert_price
number否dp自定义转化均价单位：分）
ecpm
number否ecpm
expose
integer否曝光量
extension_flow
string否推广流量：0默认值无意义，1全流量场景、2自有流量、3联盟流量
extension_type
string否推广目标 1链接推广，2应用推广，3快应用，7微信小程序推广，8直播推广
flow_scene
string否流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频、12联盟不限、13展示优选、14通知栏、15网络消息
form_cnt
integer否表单量
form_price
number否表单均价（单位：分）
global_spec_id
string否统一规格id
owner_id
string否广告主id
owner_name
string否广告主名称
plan_id
string否计划id
plan_name
string否计划名称
quick_app_pay
integer否快应用付费量
quick_app_pay_price
number否快应用付费均价（单位：分）
convert_retention_rate
number否回传次留率
quick_app_act_num
integer否快应用关键行为量
quick_app_act_cost
number否快应用关键行为成本（单位：分）
form_price_rate
number否表单转化率
form_key_act_nums
integer否表单关键行为量
form_key_act_price
number否表单关键行为成本（单位：分）
effect_consult_nums
integer否有效咨询量
effect_consult_price
number否有效咨询量
wechat_focus_nums
integer否微信关注量
wechat_focus_price
number否微信关注成本（单位：分）
web_page_buy_nums
integer否网页购买量
web_page_buy_price
number否网页购买成本（单位：分）
call_up_nums
integer否拨打电话量
call_up_price
number否拨打电话成本（单位：分）
qapp_quick_lnk_nums
integer否快应用加桌量
qapp_quick_lnk_price
number否快应用加桌成本（单位：分）
wechat_game_register
integer否微信小游戏注册量
wechat_game_register_price
number否微信小游戏注册成本（单位：分）
wechat_game_pay
integer否微信小游戏付费量
wechat_game_pay_price
number否微信小游戏付费成本（单位：分）
pay_nums
integer否付费次数
pay_per_price
number否每次付费成本（单位：分）
wechat_game_pay_cost
number否微信小游戏付费总额（单位：分）
first_pay_num
integer否微信小游戏首次付费人数
wechat_game_roi1
number否微信小游戏ROI1
convert_retention_3
integer否第3日留存
convert_retention_4
integer否第4日留存
convert_retention_5
integer否第5日留存
convert_retention_6
integer否第6日留存
convert_retention_7
integer否第7日留存
convert_retention_3_rate
number否第3日留存率
convert_retention_4_rate
number否第4日留存率
convert_retention_5_rate
number否第5日留存率
convert_retention_6_rate
number否第6日留存率
convert_retention_7_rate
number否第7日留存率
lt7
integer否LT7总留存
lt7_rate
number否LT7总留存率
register_app_pay_rate
number否注册应用付费率
roi14
number否广告变现ROI14（分成后）
ltv14
number否广告变现LTV14（分成后）
quick_app_act_rate
number否快应用关键行为转化率

6.2 广告明细数据总量查询-子客户

基本信息

Path： /v3/data/common/total/queryAdData

Method： POST

接口描述：

groupByColumn用法：
1.场景：需要查询多个广告创意的数据
   解决办法：groupByColumn:ad_id
2.场景：需要查询广告计划*创意分组的数据
   解决办法：groupByColumn:ad_group_id,ad_id

注：
1.默认分组字段为ftime，如果groupByColumn不为空，最后组装的sql == group by ftime,{groupByColumn}
2.groupByColumn支持的字段名格式可以查看接口返回字段名示例，注意：设置了用该字段后，返回的数据时是已经经过聚合后的数据，所以只能关注该维度字段和指标字段的值，其他维度的值是随机的，所以出现该情况时请忽略。当timeLevel参数是“ALL”时，groupByColumn字段的值是owner_id，未设置时是ftime。

SDK接入请求方法：

omniAds.adsData().v3TotalQueryAdData（map）

请求参数示例：(同SDK请求参数)

{
    "page": 1,
    "ascDesc": "ASC",
    "endTime": 20210531,
    "pageCount": 10,
    "timeLevel": "DAY",
    "beginTime": 20210401,
    "orderByColumns": "ftime",
    "paraMap": {
        "filter_zero": 0,
        "groupByColumn": "ad_id"
    }
}

返回参数示例：

{
    "code": 0,
    "msg": "",
    "data": 100
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是 application/json

Body

名称类型必须默认值备注
beginTime
integer否起始时间 不填的话默认是当天如20201001 beginTime endTime须配合使用
endTime
integer否结束时间 不填的话默认是当天如20201001 beginTime endTime须配合使用
timeLevel
string否DAY时间聚合粒度，可填值（必须大写）：HOUR（小时），DAY（天），ALL（整体），默认按天粒度，ALL粒度暂不支持查询当日数据
paraMap
object否与业务相关的具体参数
adGroupIds
string []否广告组ID集合
extensionFlowList
string []否推广流量集合
否1.全流量场景，2自由流量，3联盟流量
extensionTypeList
string []否推广目标集合
否 1:链接推广 2:应用推广 3:快应用推广 7:微信小程序推广 8:直播推广
flowSceneList
string []否流量场景集合
否流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频、12联盟不限、13展示优选、14通知栏、15网络消息
planIds
string []否计划id集合
globalSpecIdList
integer []否创意规格id集合
filter_zero
integer否是否过滤真实消耗等于0的数据，1：过滤； 其余不过滤
adIds
string []否广告id集合
groupByColumn
string否查询分组字段 其他字段可根据返回字段名类比，如：ad_group_id 请看备注示例 支持分组的字段： ad_group_id、ad_id、app_id、owner_id、plan_id 注意：设置了用该字段后，返回的数据时是已经经过聚合后的数据，所以只能关注该维度字段和指标字段的值，其他维度的值是随机的。
costFloor
integer否消耗金额大于
costCeiling
integer否消耗金额小于
exposeFloor
integer否曝光量大于
exposeCeiling
integer否曝光量小于
clickFloor
integer否点击量大于
clickCeiling
integer否点击量小于
downloadFloor
integer否下载量大于
downloadCeiling
integer否下载量小于
ecpmFloor
integer否ecpm大于
ecpmCeiling
integer否ecpm小于

返回数据

名称类型必须默认值备注
code
integer是状态码 0请求正常 1系统异常 11001:服务端异常 110000：参数错误 110002：用户不存在或已过期，请重新登录 110003：无效的接口查询路径 110101：查询天数不合法，具体见msg 110104：超过批量查询最大限制，默认500 其余请看msg
msg
string是具体信息
data
integer是该查询的数据总量

6.3 广告明细数据查询-子客户

基本信息

Path： /v3/data/common/query/queryAdData

Method： POST

接口描述：

groupByColumn用法：
1.场景：需要查询多个广告创意的数据
   解决办法：groupByColumn:ad_id
2.场景：需要查询广告计划*创意分组的数据
   解决办法：groupByColumn:ad_group_id,ad_id

注：
1.默认分组字段为ftime，如果groupByColumn不为空，最后组装的sql == group by ftime,{groupByColumn}
2.groupByColumn支持的字段名格式可以查看接口返回字段名示例，注意：设置了用该字段后，返回的数据时是已经经过聚合后的数据，所以只能关注该维度字段和指标字段的值，其他维度的值是随机的，所以出现该情况时请忽略。当timeLevel参数是“ALL”时，groupByColumn字段的值是owner_id，未设置时是ftime。
3.如果想提高查询的响应速度，可以将参数"extra"设置为"skip_total"，使用该选项不会返回totalCount的值。如果需要该值的话，需要使用接口“6.2 广告明细数据总量查询-子客户”进行获取。

SDK接入请求方法：omniAds.adsData().v3QueryQueryAdData(map)

请求参数示例：（同SDK请求参数）

{
    "page": 1,
    "ascDesc": "ASC",
    "endTime": 20210531,
    "pageCount": 10,
    "timeLevel": "DAY",
    "beginTime": 20210401,
    "orderByColumns": "ftime",
    "paraMap": {
        "filter_zero": 0,
        "groupByColumn": "ad_id"
    }
}

返回参数示例：

{
    "code": 0,
    "data": {
        "totalCount": 3,
        "itemCount": 3,
        "items": [
            {
                "owner_id": "1100050065",
                "click_rate": 0,
                "dp_app_credit_price": 0,
                "dp_app_order_price": 0,
                "download": 0,
                "dp_convert_register_price": 0,
                "convert_app_pay": 0,
                "dp_ud_convert_nums": 0,
                "click_price": 0,
                "ad_group_id": "0",
                "convert_register": 0,
                "app_id": "0",
                "dp_ud_convert_price": 0,
                "convert_app_order": 0,
                "dp_app_credit_nums": 0,
                "global_spec_id": "0",
                "owner_name": "0",
                "convert_app_credit_price": 0,
                "click": 0,
                "plan_name": "0",
                "form_cnt": 0,
                "quick_app_pay": 0,
                "ad_group_name": "0",
                "ad_id": "0",
                "ecpm": 0,
                "quick_app_pay_price": 0,
                "form_price": 0,
                "convert_app_custom": 0,
                "dp_convert_register_nums": 0,
                "convert_retention_price": 0,
                "convert_app_order_price": 0,
                "convert_dp": 0,
                "flow_scene": "0",
                "download_rate": 0,
                "convert_register_price": 0,
                "convert_active_price": 0,
                "convert_app_credit": 0,
                "dp_convert_activation_price": 0,
                "convert_app_custom_price": 0,
                "ftime": 20210526,
                "dp_convert_activation_nums": 0,
                "convert_dp_price": 0,
                "download_price": 0,
                "cost": 0.00,
                "dp_app_pay_price": 0,
                "ad_name": "0",
                "expose": 0,
                "extension_flow": "0",
                "convert_retention": 0,
                "convert_app_pay_price": 0,
                "app_name": "0",
                "dp_app_order_nums": 0,
                "extension_type": "0",
                "convert_active": 0,
                "plan_id": "0",
                "dp_app_pay_nums": 0
            },
            {
                "owner_id": "1100050065",
                "click_rate": 0,
                "dp_app_credit_price": 0,
                "dp_app_order_price": 0,
                "download": 0,
                "dp_convert_register_price": 0,
                "convert_app_pay": 0,
                "dp_ud_convert_nums": 0,
                "click_price": 0,
                "ad_group_id": "0",
                "convert_register": 0,
                "app_id": "0",
                "dp_ud_convert_price": 0,
                "convert_app_order": 0,
                "dp_app_credit_nums": 0,
                "global_spec_id": "0",
                "owner_name": "0",
                "convert_app_credit_price": 0,
                "click": 0,
                "plan_name": "0",
                "form_cnt": 0,
                "quick_app_pay": 0,
                "ad_group_name": "0",
                "ad_id": "0",
                "ecpm": 0,
                "quick_app_pay_price": 0,
                "form_price": 0,
                "convert_app_custom": 0,
                "dp_convert_register_nums": 0,
                "convert_retention_price": 0,
                "convert_app_order_price": 0,
                "convert_dp": 0,
                "flow_scene": "0",
                "download_rate": 0,
                "convert_register_price": 0,
                "convert_active_price": 0,
                "convert_app_credit": 0,
                "dp_convert_activation_price": 0,
                "convert_app_custom_price": 0,
                "ftime": 20210527,
                "dp_convert_activation_nums": 0,
                "convert_dp_price": 0,
                "download_price": 0,
                "cost": 0.00,
                "dp_app_pay_price": 0,
                "ad_name": "0",
                "expose": 0,
                "extension_flow": "0",
                "convert_retention": 0,
                "convert_app_pay_price": 0,
                "app_name": "0",
                "dp_app_order_nums": 0,
                "extension_type": "0",
                "convert_active": 0,
                "plan_id": "0",
                "dp_app_pay_nums": 0
            },
            {
                "owner_id": "1100050065",
                "click_rate": 0,
                "dp_app_credit_price": 0,
                "dp_app_order_price": 0,
                "download": 0,
                "dp_convert_register_price": 0,
                "convert_app_pay": 0,
                "dp_ud_convert_nums": 0,
                "click_price": 0,
                "ad_group_id": "0",
                "convert_register": 0,
                "app_id": "0",
                "dp_ud_convert_price": 0,
                "convert_app_order": 0,
                "dp_app_credit_nums": 0,
                "global_spec_id": "0",
                "owner_name": "0",
                "convert_app_credit_price": 0,
                "click": 0,
                "plan_name": "0",
                "form_cnt": 0,
                "quick_app_pay": 0,
                "ad_group_name": "0",
                "ad_id": "0",
                "ecpm": 0,
                "quick_app_pay_price": 0,
                "form_price": 0,
                "convert_app_custom": 0,
                "dp_convert_register_nums": 0,
                "convert_retention_price": 0,
                "convert_app_order_price": 0,
                "convert_dp": 0,
                "flow_scene": "0",
                "download_rate": 0,
                "convert_register_price": 0,
                "convert_active_price": 0,
                "convert_app_credit": 0,
                "dp_convert_activation_price": 0,
                "convert_app_custom_price": 0,
                "ftime": 20210528,
                "dp_convert_activation_nums": 0,
                "convert_dp_price": 0,
                "download_price": 0,
                "cost": 0.00,
                "dp_app_pay_price": 0,
                "ad_name": "0",
                "expose": 0,
                "extension_flow": "0",
                "convert_retention": 0,
                "convert_app_pay_price": 0,
                "app_name": "0",
                "dp_app_order_nums": 0,
                "extension_type": "0",
                "convert_active": 0,
                "plan_id": "0",
                "dp_app_pay_nums": 0
            }
        ]
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是 application/json

Body

名称类型必须默认值备注
beginTime
integer否起始时间 不填的话默认是当天如20201001 beginTime endTime须配合使用
endTime
integer否结束时间 不填的话默认是当天如20201001 beginTime endTime须配合使用
ascDesc
string否DESC正序逆序 可取值 ASC DESC两种 不可取其他值 支持大小写 建议配合orderByColumns一起使用， 如orderByColumns: "ftime",ascDesc: "DESC"
timeLevel
string否DAY时间聚合粒度，可填值（必须大写）：HOUR（小时），DAY（天），ALL（整体），默认按天粒度，ALL粒度暂不支持查询当日数据
page
integer否1分页起始
pageCount
integer否10分页大小
paraMap
object否与业务相关的具体参数
adGroupIds
string []否广告组ID集合
extensionFlowList
string []否推广流量集合
否1.全流量场景，2自由流量，3联盟流量
extensionTypeList
string []否推广目标集合
否 1:链接推广 2:应用推广 3:快应用推广 7:微信小程序推广 8:直播推广
flowSceneList
string []否流量场景集合
否流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频、12联盟不限、13展示优选、14通知栏、15网络消息
planIds
string []否计划id集合
globalSpecIdList
integer []否创意规格id集合
filter_zero
integer否是否过滤真实消耗等于0的数据，1：过滤； 其余不过滤
adIds
string []否广告id集合
groupByColumn
string否查询分组字段 其他字段可根据返回字段名类比，如：ad_group_id 请看备注示例 支持分组的字段： ad_group_id、ad_id、app_id、owner_id、plan_id 注意：设置了用该字段后，返回的数据时是已经经过聚合后的数据，所以只能关注该维度字段和指标字段的值，其他维度的值是随机的。
costFloor
integer否消耗金额大于
costCeiling
integer否消耗金额小于
exposeFloor
integer否曝光量大于
exposeCeiling
integer否曝光量小于
clickFloor
integer否点击量大于
clickCeiling
integer否点击量小于
downloadFloor
integer否下载量大于
downloadCeiling
integer否下载量小于
ecpmFloor
integer否ecpm大于
ecpmCeiling
integer否ecpm小于
extra
string否额外选项，可选： 1. skip_total，传入该值时，返回的数据中不再包含totalCount数据，可以提高查询响应速度

返回数据

名称类型必须默认值备注
code
integer是状态码 0请求正常 1系统异常 11001:服务端异常 110000：参数错误 110002：用户不存在或已过期，请重新登录 110003：无效的接口查询路径 110101：查询天数不合法，具体见msg 110104：超过批量查询最大限制，默认500 其余请看msg
msg
string是具体信息
data
object是
totalCount
integer否符合查询总数
itemCount
integer否分页查询数量
items
object []否
ad_group_id
string否广告组id
ad_group_name
string否广告组名称
ad_id
string否广告id
ad_name
string否广告名称
app_id
string否应用id
app_name
string否应用名称
click
integer否点击量
click_price
number否点击均价（单位：分）
click_rate
number否点击率
convert_active
integer否回传激活量
convert_active_price
number否回传激活均价（单位：分）
convert_app_credit
integer否应用内授信
convert_app_credit_price
number否应用内授信均价（单位：分）
convert_app_custom
integer否自定义转化
convert_app_custom_price
number否自定义转化均价（单位：分）
convert_app_order
integer否应用内下单
convert_app_order_price
number否应用内下单均价（单位：分）
convert_app_pay
integer否应用内付费
convert_app_pay_price
number否应用内付费均价（单位：分）
convert_dp
integer否dp回传拉活量
convert_dp_price
number否dp回传拉活均价（单位：分）
convert_register
integer否回传注册量
convert_register_price
number否回传注册均价（单位：分）
convert_retention
integer否回传留存量
convert_retention_price
number否回传留存均价（单位：分）
cost
integer否消耗实扣（单位：分）
download
integer否下载量
download_price
number否下载均价（单位：分）
download_rate
number否下载率，小数
dp_app_order_nums
integer否dp应用内下单量
dp_app_order_price
number否dp应用内下单均价（单位：分）
dp_convert_activation_nums
integer否dp回传激活量
dp_convert_activation_price
number否dp回传激活均价（单位：分）
dp_convert_register_nums
integer否dp回传注册量
dp_convert_register_price
number否dp回传注册均价（单位：分）
dp_ud_convert_nums
integer否dp自定义转化量
dp_ud_convert_price
number否dp自定义转化均价单位：分）
ecpm
number否ecpm
expose
integer否曝光量
extension_flow
string否推广流量：0默认值无意义，1全流量场景、2自有流量、3联盟流量
extension_type
string否推广目标 1链接推广，2应用推广，3快应用，7微信小程序推广、8直播推广
flow_scene
string否流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频、12联盟不限、13展示优选、14通知栏、15网络消息
form_cnt
integer否表单量
form_price
number否表单均价（单位：分）
global_spec_id
string否统一规格id
owner_id
string否广告主id
owner_name
string否广告主名称
plan_id
string否计划id
plan_name
string否计划名称
quick_app_pay
integer否快应用付费量
quick_app_pay_price
number否快应用付费成本（单位：分）
convert_retention_rate
number否回传次留率
quick_app_act_num
integer否快应用关键行为量
quick_app_act_cost
number否快应用关键行为成本
form_price_rate
number否表单转化率
form_key_act_nums
integer否表单关键行为量
form_key_act_price
number否表单关键行为成本
effect_consult_nums
integer否有效咨询量
effect_consult_price
number否有效咨询量
wechat_focus_nums
integer否微信关注量
wechat_focus_price
number否微信关注成本
web_page_buy_nums
integer否网页购买量
web_page_buy_price
number否网页购买成本
call_up_nums
integer否拨打电话量
call_up_price
number否拨打电话成本
qapp_quick_lnk_nums
integer否快应用加桌量
qapp_quick_lnk_price
number否快应用加桌成本
dp_convert_retention_nums
integer否deeplink回传留存量
dp_convert_retention_price
number否deeplink回传留存成本
wechat_game_register
integer否微信小游戏注册量
wechat_game_register_price
number否微信小游戏注册成本
wechat_game_pay
integer否微信小游戏付费量
wechat_game_pay_price
number否微信小游戏付费成本
pay_nums
integer否付费次数
pay_per_price
number否每次付费成本
wechat_game_pay_cost
number否微信小游戏付费总额
first_pay_num
integer否微信小游戏首次付费人数
wechat_game_roi1
number否微信小游戏ROI1
convert_retention_3
integer否第3日留存
convert_retention_4
integer否第4日留存
convert_retention_5
integer否第5日留存
convert_retention_6
integer否第6日留存
convert_retention_7
integer否第7日留存
convert_retention_3_rate
number否第3日留存率
convert_retention_4_rate
number否第4日留存率
convert_retention_5_rate
number否第5日留存率
convert_retention_6_rate
number否第6日留存率
convert_retention_7_rate
number否第7日留存率
lt7
integer否LT7总留存
lt7_rate
number否LI7总留存率
register_app_pay_rate
number否注册应用付费率
book_nums
integer否预约量
cancel_book_nums
integer否取消预约量
book_download_nums
integer否预约下载量
roi14
number否广告变现ROI14（分成后）
ltv14
number否广告变现LTV14（分成后）
cate_name
string否一级行业名称
sub_cate_name
string否二级行业名称
third_cate_name
string否三级行业名称
quick_app_act_rate
number否快应用关键行为转化率

6.4 小游戏明细数据总量查询-子客户

基本信息

Path： /v3/data/common/total/queryQuickGame

Method： POST

接口描述：

groupByColumn用法：
1.场景：需要查询多个app的数据
   解决办法：groupByColumn:app_id
2.场景：需要查询广告计划*创意分组的数据
   解决办法：groupByColumn:group_id,ad_id

注：
1.默认分组字段为ftime，如果groupByColumn不为空，最后组装的sql == group by ftime,{groupByColumn}

SDK请求接入请求方法：omniAds.adsData().v3TotalQueryQuickGame(map)
请求参数示例：（同SDK请求参数）

{
    "beginTime": 20210620,
    "endTime": 20210621,
    "orderByColumns": "dt",
    "ascDesc": "DESC",
    "timeLevel": "DAY",
    "paraMap": {
        "adGroupIds": [
            "12431",
            "14435"
        ],
        "extensionFlowList": [
            "2",
            "1"
        ],
        "planIds": [
            "12431",
            "14435"
        ],
        "adIds": [
            "12431",
            "14435"
        ],
        "appIdList": [
            "adipisicing anim labore tempor",
            "reprehenderit fugiat Ut",
            "exercitation",
            "do Lorem et"
        ],
        "app_id": "4132",
        "app_name": "consequ",
        "flowSceneList": [
            "1",
            "2"
        ],
        "exposeFloor": -67280287,
        "exposeCeiling": 41164553,
        "clickFloor": -89015186,
        "clickCeiling": -95405039,
        "ecpmFloor": -74395941,
        "ecpmCeiling": 24198488,
        "groupByColumn": "app_id"
    }
}

返回参数示例：

{
    "code": 0,
    "msg": "",
    "data": 1000
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是 application/json

Body

名称类型必须默认值备注
beginTime
integer否起始时间 不填的话默认是当天如20201001, 小游戏目前不支持实时数据，故需要填写起始时间小于当天时间 beginTime endTime须配合使用
endTime
integer否结束时间 不填的话默认是当天如20201001 小游戏目前不支持实时数据，故需要填写结束时间小于当天时间 beginTime填写，endTime必填 beginTime endTime须配合使用
orderByColumns
string否数据排序字段，不传则按默认排序-数据插入顺序建议：dt；支持的orderByColumns字段有： ad_id,group_id,plan_id,app_id,owner_id,agency_id,acc_cost,ecpm,expose_nums,click_nums,click_rate,click_price,active_nums,active_rate,active_cost, new_user_buy_ltv1,new_user_buy_ltv3,new_user_buy_ltv7,new_user_buy_ltv30,new_user_buy_roi1,new_user_buy_roi3,new_user_buy_roi7,new_user_buy_roi30, buy_user_income0,new_pay_user_nums,pay_transfer_rate,pay_cost,inter_buy_ltv1,inter_buy_ltv3,inter_buy_ltv7,inter_buy_ltv30,inter_buy_roi1,inter_buy_roi3, inter_buy_roi7,inter_buy_roi30,inter_buy_pay,buy_user_income,buy_user_income3,buy_user_income7,buy_user_income30,ltv1_pay,ltv3_pay,ltv7_pay,ltv30_pay, extension_flow,flow_scene,extension_type,global_spec_id,ad_flag
ascDesc
string否DESC正序逆序 可取值 ASC DESC两种 不可取其他值 支持大小写 建议配合orderByColumns一起使用， 如orderByColumns: "dt",ascDesc: "DESC"
timeLevel
string否DAY时间聚合粒度，可填值（必须大写）：DAY（天），默认按天粒度
paraMap
object否与业务相关的具体参数
adGroupIds
string []否广告组ID集合
extensionFlowList
string []否推广流量集合
否1.全流量场景，2.自有流量，3联盟流量
planIds
string []否计划id集合
adIds
string []否广告id集合
appIdList
string []否应用集合，如果要查各个应用明细数据，则orderByColumns需要添加app_id
app_id
string否应用id
app_name
string否支持模糊查询应用名称
flowSceneList
string []否流量场景集合
否流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频、12联盟不限、13展示优选、14通知栏、15网络消息
exposeFloor
integer否曝光大于exposeFloor
exposeCeiling
integer否曝光小于exposeCeiling
clickFloor
integer否点击大于clickFloor
clickCeiling
integer否点击小于clickCeiling
ecpmFloor
integer否ecpm大于ecpmFloor
ecpmCeiling
integer否ecpm小于ecpmCeiling

返回数据

名称类型必须默认值备注
code
integer是状态码 0请求正常 1系统异常 11001:服务端异常 110000：参数错误 110002：用户不存在或已过期，请重新登录 110003：无效的接口查询路径 110101：查询天数不合法，具体见msg 110104：超过批量查询最大限制，默认500 其余请看msg
msg
string是具体信息
data
integer是该查询数据总量

6.5 小游戏明细数据查询-子客户

基本信息

Path： /v3/data/common/query/queryQuickGame

Method： POST

接口描述：

groupByColumn用法：
1.场景：需要查询多个app的数据
   解决办法：groupByColumn:app_id
2.场景：需要查询广告计划*创意分组的数据
   解决办法：groupByColumn:group_id,ad_id

注：
1.默认分组字段为ftime，如果groupByColumn不为空，最后组装的sql == group by ftime,{groupByColumn}
2.groupByColumn支持的字段名格式可以查看接口返回字段名示例，注意：设置了用该字段后，返回的数据时是已经经过聚合后的数据，所以只能关注该维度字段和指标字段的值，其他维度的值是随机的。
3.如果想提高查询的响应速度，可以将参数"extra"设置为"skip_total"，使用该选项不会返回totalCount的值。如果需要该值的话，需要使用接口“6.4 小游戏明细数据总量查询-子客户”进行获取。

SDK请求接入请求方法：omniAds.adsData().v3QueryQueryQuickGame(map)
请求参数示例：（同SDK请求参数）

{
  "beginTime": 20210620,
  "endTime": 20210621,
  "orderByColumns": "dt",
  "ascDesc": "DESC",
  "timeLevel": "DAY",
  "page": 1,
  "pageCount": 10,
  "paraMap": {
    "adGroupIds": [
      "12431","14435"
    ],
    "extensionFlowList": [
     "2","1"
    ],
    "planIds": [
     "12431","14435"
    ],
    "adIds": [
      "12431","14435"
    ],
    "appIdList": [
      "adipisicing anim labore tempor",
      "reprehenderit fugiat Ut",
      "exercitation",
      "do Lorem et"
    ],
    "app_id": "4132",
    "app_name": "consequ",
    "flowSceneList": [
      "1","2"
    ],
    "exposeFloor": -67280287,
    "exposeCeiling": 41164553,
    "clickFloor": -89015186,
    "clickCeiling": -95405039,
    "ecpmFloor": -74395941,
    "ecpmCeiling": 24198488,
    "groupByColumn": "app_id"
  }
}

返回参数示例：

{
    "code": 0,
    "data": {
        "totalCount": 5,
        "itemCount": 5,
        "items": [
            {
                "buy_user_income0": 13.62,
                "owner_id": "1100050065",
                "click_rate": 82.0000,
                "inter_buy_ltv3": 41.83,
                "inter_buy_ltv7": 44.23,
                "dt": 1618070400000,
                "inter_buy_roi30": 2302.0000,
                "pay_transfer_rate": 15.0000,
                "flow_scene": 5,
                "new_user_buy_ltv30": 22.44,
                "active_nums": 3109,
                "fdate": 20210411,
                "inter_buy_pay": 33.37,
                "new_user_buy_ltv7": 11.92,
                "click_price": 0.44,
                "new_user_buy_ltv1": 0,
                "app_id": "12000288",
                "new_user_buy_ltv3": 40.94,
                "new_user_buy_roi30": 3408.0000,
                "ltv1_pay": 8163.69,
                "global_spec_id": "1",
                "new_user_buy_roi1": 0.0600,
                "inter_buy_ltv30": 37.58,
                "group_name": "快应用推广_自有流量_2021/04/08_14:35:36",
                "new_user_buy_roi3": 1319.0000,
                "expose_nums": 16812,
                "new_pay_user_nums": 3848,
                "pay_cost": 19.87,
                "ad_name": "快应用推广_信息流_横版大图_创意1_2021/04/08_14:38:25",
                "active_cost": 49.53,
                "inter_buy_roi7": 4081.0000,
                "new_user_buy_roi7": 3283.0000,
                "click_nums": 4684,
                "inter_buy_roi3": 4349.0000,
                "active_rate": 69.0000,
                "plan_name": "快应用推广_2021/04/08_14:35:29",
                "extension_flow": 2,
                "inter_buy_roi1": 3906.0000,
                "app_name": "小白战纪",
                "ad_id": "400002843",
                "ecpm": 0.89,
                "inter_buy_ltv1": 25.05,
                "group_id": "300003944",
                "extension_type": 3,
                "plan_id": "200003679",
                "acc_cost": 172119.63
            },
            {
                "buy_user_income0": 10.57,
                "owner_id": "1100050065",
                "click_rate": 25.0000,
                "inter_buy_ltv3": 14.94,
                "inter_buy_ltv7": 28.67,
                "dt": 1618156800000,
                "inter_buy_roi30": 1871.0000,
                "pay_transfer_rate": 90.0000,
                "flow_scene": 5,
                "new_user_buy_ltv30": 24.82,
                "active_nums": 2264,
                "fdate": 20210412,
                "inter_buy_pay": 48.01,
                "new_user_buy_ltv7": 17.80,
                "click_price": 0.76,
                "new_user_buy_ltv1": 37.75,
                "app_id": "12000288",
                "new_user_buy_ltv3": 22.25,
                "new_user_buy_roi30": 4184.0000,
                "ltv1_pay": 7498.69,
                "global_spec_id": "1",
                "new_user_buy_roi1": 0.0100,
                "inter_buy_ltv30": 20.72,
                "group_name": "快应用推广_自有流量_2021/04/08_14:35:36",
                "new_user_buy_roi3": 3906.0000,
                "expose_nums": 15857,
                "new_pay_user_nums": 4797,
                "pay_cost": 24.62,
                "ad_name": "快应用推广_信息流_横版大图_创意1_2021/04/08_14:38:25",
                "active_cost": 20.75,
                "inter_buy_roi7": 3051.0000,
                "new_user_buy_roi7": 3099.0000,
                "click_nums": 7618,
                "inter_buy_roi3": 2665.0000,
                "active_rate": 22.0000,
                "plan_name": "快应用推广_2021/04/08_14:35:29",
                "extension_flow": 1,
                "inter_buy_roi1": 1934.0000,
                "app_name": "小白战纪",
                "ad_id": "400002843",
                "ecpm": 0.12,
                "inter_buy_ltv1": 13.98,
                "group_id": "300003944",
                "extension_type": 3,
                "plan_id": "200003679",
                "acc_cost": 263419.03
            },
            {
                "buy_user_income0": 44.04,
                "owner_id": "1100050065",
                "click_rate": 77.0000,
                "inter_buy_ltv3": 43.95,
                "inter_buy_ltv7": 17.95,
                "dt": 1618243200000,
                "inter_buy_roi30": 1853.0000,
                "pay_transfer_rate": 79.0000,
                "flow_scene": 5,
                "new_user_buy_ltv30": 32.81,
                "active_nums": 1149,
                "fdate": 20210413,
                "inter_buy_pay": 13.18,
                "new_user_buy_ltv7": 10.31,
                "click_price": 0.13,
                "new_user_buy_ltv1": 30.37,
                "app_id": "12000288",
                "new_user_buy_ltv3": 21.03,
                "new_user_buy_roi30": 1797.0000,
                "ltv1_pay": 1343.35,
                "global_spec_id": "1",
                "new_user_buy_roi1": 0.0020,
                "inter_buy_ltv30": 31.55,
                "group_name": "快应用推广_自有流量_2021/04/08_14:35:36",
                "new_user_buy_roi3": 1985.0000,
                "expose_nums": 16328,
                "new_pay_user_nums": 3139,
                "pay_cost": 18.65,
                "ad_name": "快应用推广_信息流_横版大图_创意1_2021/04/08_14:38:25",
                "active_cost": 37.82,
                "inter_buy_roi7": 4763.0000,
                "new_user_buy_roi7": 3387.0000,
                "click_nums": 2301,
                "inter_buy_roi3": 4686.0000,
                "active_rate": 93.0000,
                "plan_name": "快应用推广_2021/04/08_14:35:29",
                "extension_flow": 3,
                "inter_buy_roi1": 2188.0000,
                "app_name": "小白战纪",
                "ad_id": "400002843",
                "ecpm": 0.08,
                "inter_buy_ltv1": 32.16,
                "group_id": "300003944",
                "extension_type": 3,
                "plan_id": "200003679",
                "acc_cost": 307004.47
            },
            {
                "buy_user_income0": 17.24,
                "owner_id": "1100050065",
                "click_rate": 99.0000,
                "inter_buy_ltv3": 46.97,
                "inter_buy_ltv7": 31.53,
                "dt": 1618329600000,
                "inter_buy_roi30": 4996.0000,
                "pay_transfer_rate": 65.0000,
                "flow_scene": 2,
                "new_user_buy_ltv30": 43.62,
                "active_nums": 2392,
                "fdate": 20210414,
                "inter_buy_pay": 27.83,
                "new_user_buy_ltv7": 49.97,
                "click_price": 0.92,
                "new_user_buy_ltv1": 12.23,
                "app_id": "12000288",
                "new_user_buy_ltv3": 35.33,
                "new_user_buy_roi30": 2766.0000,
                "ltv1_pay": 7845.27,
                "global_spec_id": "1",
                "new_user_buy_roi1": 2118.0000,
                "inter_buy_ltv30": 19.51,
                "group_name": "快应用推广_自有流量_2021/04/08_14:35:36",
                "new_user_buy_roi3": 2499.0000,
                "expose_nums": 18484,
                "new_pay_user_nums": 4719,
                "pay_cost": 43.87,
                "ad_name": "快应用推广_信息流_横版大图_创意1_2021/04/08_14:38:25",
                "active_cost": 18.78,
                "inter_buy_roi7": 3876.0000,
                "new_user_buy_roi7": 4044.0000,
                "click_nums": 2663,
                "inter_buy_roi3": 1801.0000,
                "active_rate": 64.0000,
                "plan_name": "快应用推广_2021/04/08_14:35:29",
                "extension_flow": 3,
                "inter_buy_roi1": 1775.0000,
                "app_name": "小白战纪",
                "ad_id": "400002843",
                "ecpm": 0.81,
                "inter_buy_ltv1": 13.83,
                "group_id": "300003944",
                "extension_type": 3,
                "plan_id": "200003679",
                "acc_cost": 412637.27
            },
            {
                "buy_user_income0": 14.03,
                "owner_id": "1100050065",
                "click_rate": 66.0000,
                "inter_buy_ltv3": 45.14,
                "inter_buy_ltv7": 35.27,
                "dt": 1618329600000,
                "inter_buy_roi30": 1801.0000,
                "pay_transfer_rate": 96.0000,
                "flow_scene": 6,
                "new_user_buy_ltv30": 49.38,
                "active_nums": 1112,
                "fdate": 20210414,
                "inter_buy_pay": 42.63,
                "new_user_buy_ltv7": 27.60,
                "click_price": 0.44,
                "new_user_buy_ltv1": 43.89,
                "app_id": "50",
                "new_user_buy_ltv3": 14.12,
                "new_user_buy_roi30": 3783.0000,
                "ltv1_pay": 1996.70,
                "global_spec_id": "20",
                "new_user_buy_roi1": 4527.0000,
                "inter_buy_ltv30": 10.68,
                "group_name": "快应用推广_自有流量_2021/05/14_10:07:40",
                "new_user_buy_roi3": 2731.0000,
                "expose_nums": 14862,
                "new_pay_user_nums": 3572,
                "pay_cost": 44.89,
                "ad_name": "快应用推广_信息流_横版小图_创意1_2021/05/14_10:08:08",
                "active_cost": 37.77,
                "inter_buy_roi7": 2653.0000,
                "new_user_buy_roi7": 2547.0000,
                "click_nums": 4643,
                "inter_buy_roi3": 1012.0000,
                "active_rate": 90.0000,
                "plan_name": "快应用推广_2021/05/14_10:07:38",
                "extension_flow": 2,
                "inter_buy_roi1": 1523.0000,
                "app_name": "快应用测试-ksfia",
                "ad_id": "400009163",
                "ecpm": 0.57,
                "inter_buy_ltv1": 42.92,
                "group_id": "300013127",
                "extension_type": 3,
                "plan_id": "200005335",
                "acc_cost": 294941.58
            }
        ]
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是 application/json

Body

名称类型必须默认值备注
beginTime
integer否起始时间 不填的话默认是当天如20201001, 小游戏目前不支持实时数据，故需要填写起始时间小于当天时间 beginTime endTime须配合使用
endTime
integer否结束时间 不填的话默认是当天如20201001 小游戏目前不支持实时数据，故需要填写结束时间小于当天时间 beginTime填写，endTime必填 beginTime endTime须配合使用
orderByColumns
string否数据排序字段，不传则按默认排序-数据插入顺序建议：dt；支持的orderByColumns字段有： ad_id,group_id,plan_id,app_id,owner_id,agency_id,acc_cost,ecpm,expose_nums,click_nums,click_rate,click_price,active_nums,active_rate,active_cost, new_user_buy_ltv1,new_user_buy_ltv3,new_user_buy_ltv7,new_user_buy_ltv30,new_user_buy_roi1,new_user_buy_roi3,new_user_buy_roi7,new_user_buy_roi30, buy_user_income0,new_pay_user_nums,pay_transfer_rate,pay_cost,inter_buy_ltv1,inter_buy_ltv3,inter_buy_ltv7,inter_buy_ltv30,inter_buy_roi1,inter_buy_roi3, inter_buy_roi7,inter_buy_roi30,inter_buy_pay,buy_user_income,buy_user_income3,buy_user_income7,buy_user_income30,ltv1_pay,ltv3_pay,ltv7_pay,ltv30_pay, extension_flow,flow_scene,extension_type,global_spec_id,ad_flag
ascDesc
string否DESC正序逆序 可取值 ASC DESC两种 不可取其他值 支持大小写 建议配合orderByColumns一起使用， 如orderByColumns: "dt",ascDesc: "DESC"
timeLevel
string否DAY时间聚合粒度，可填值（必须大写）：DAY（天），默认按天粒度
page
integer否1分页起始
pageCount
integer否10分页大小，最大500
paraMap
object否与业务相关的具体参数
adGroupIds
string []否广告组ID集合
extensionFlowList
string []否推广流量集合
否1.全流量场景，2.自有流量，3联盟流量
planIds
string []否计划id集合
adIds
string []否广告id集合
appIdList
string []否应用集合，如果要查各个应用明细数据，则orderByColumns需要添加app_id
app_id
string否应用id
app_name
string否支持模糊查询应用名称
flowSceneList
string []否流量场景集合
否流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频、12联盟不限、13展示优选、14通知栏、15网络消息
exposeFloor
integer否曝光大于exposeFloor
exposeCeiling
integer否曝光小于exposeCeiling
clickFloor
integer否点击大于clickFloor
clickCeiling
integer否点击小于clickCeiling
ecpmFloor
integer否ecpm大于ecpmFloor
ecpmCeiling
integer否ecpm小于ecpmCeiling
extra
string否额外选项，可选： 1. skip_total，传入该值时，返回的数据中不再包含totalCount数据，可以提高查询响应速度

返回数据

名称类型必须默认值备注
code
integer是状态码 0请求正常 1系统异常 11001:服务端异常 110000：参数错误 110002：用户不存在或已过期，请重新登录 110003：无效的接口查询路径 110101：查询天数不合法，具体见msg 110104：超过批量查询最大限制，默认500 其余请看msg
msg
string是具体信息
data
object是
totalCount
integer否符合查询总数
itemCount
integer否分页查询数量
items
object []否
fdate
string否数据日期，如20210614
dt
string否数据日期时间戳
app_id
string否应用id
app_name
string否应用名称
owner_id
string否广告主Id
owner_name
string否广告主名称
group_id
string否广告组Id
group_name
string否广告组名称
plan_id
string否计划id
plan_name
string否计划名称
ad_id
string否广告id
ad_name
string否广告名称
extension_type
integer否推广目标 1链接推广，2应用推广，3快应用
global_spec_id
string否统一规格id
extension_flow
integer否推广流量：0默认值无意义，1全流量场景、2自有流量、3联盟流量
flow_scene
integer否流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频、12联盟不限、13展示优选、14通知栏、15网络消息
expose_nums
integer否曝光数
click_nums
integer否点击数
click_rate
number否点击率,小数
active_nums
integer否激活人数，通过买量下载最近180天激活的用户
active_rate
number否激活率,小数
new_user_buy_roi1
integer否广告变现ROI1（单位：分）
new_user_buy_roi3
integer否广告变现ROI3（单位：分）
new_user_buy_roi7
integer否广告变现ROI7（单位：分）
new_user_buy_roi30
integer否广告变现ROI30（单位：分）
buy_user_income0
integer否首日广告收入（单位：分）
new_pay_user_nums
integer否新增付费用户数
pay_transfer_rate
number否付费转化率，小数
inter_buy_roi1
number否内购ROI1（单位：分）
inter_buy_roi3
number否内购ROI3（单位：分）
inter_buy_roi7
number否内购ROI7（单位：分）
inter_buy_roi30
number否内购ROI30（单位：分）
inter_buy_pay
number否内购付费流水（单位：分）
acc_cost
integer否实扣金额（单位：分）
ecpm
number否ecpm
click_price
number否点击均价（单位：分）
active_cost
number否新增用户成本（单位：分）
new_user_buy_ltv1
number否广告变现LTV1（单位：分）
new_user_buy_ltv3
number否广告变现LTV3（单位：分）
new_user_buy_ltv7
number否广告变现LTV7（单位：分）
new_user_buy_ltv30
number否广告变现LTV30，小数
pay_cost
number否付费成本（单位：分）
inter_buy_ltv1
number否内购LTV1（单位：分）
inter_buy_ltv3
number否内购LTV3（单位：分）
inter_buy_ltv7
number否内购LTV7（单位：分）
inter_buy_ltv30
number否内购LTV30（单位：分）
buy_user_income_his
number否广告历史变现收入（分成后）
new_user_buy_roi_his
number否广告变现ROI累积
ltv1_pay
number否首日付费流水
total_pay
integer否总付费流水
new_req_nums
integer否新增用户(180天首次活跃)
new_req_retent2_nums
integer否次日留存数
new_req_retent3_nums
integer否3日留存数
new_req_retent7_nums
integer否7日留存数
new_req_retent14_nums
integer否14日留存数
new_req_retent30_nums
integer否30日留存数
new_req_retent2_rate
number否次日留存率
new_req_retent3_rate
number否3日留存率
new_req_retent7_rate
number否7日留存率
new_req_retent14_rate
number否14日留存率
new_req_retent30_rate
number否30日留存率
quick_app_act_num
integer否快应用关键行为量
quick_app_act_cost
number否快应用关键行为成本（单位：分）
buy_income_active_roi
number否活跃ROI
buy_user_income_active_roi
number否活跃ROI（应分成）

6.6 游戏实时明细数据总量查询-子客户

基本信息

Path： /v3/data/common/total/queryGameRTData

Method： POST

接口描述：

groupByColumn用法：
1.场景：需要查询多个app的数据
   解决办法：groupByColumn:app_id
2.场景：需要查询广告计划*创意分组的数据
   解决办法：groupByColumn:ad_group_id,ad_id

注：
1.默认分组字段为ftime，如果groupByColumn不为空，最后组装的sql == group by ftime,{groupByColumn}

SDK请求接入请求方法：omniAds.adsData().v3TotalQueryGameRTData(map)

请求参数示例：（同SDK请求参数）

{
  "timeLevel": "HOUR",
  "ascDesc": "ASC",
  "orderByColumns": "ftime",
  "paraMap": {
    "exposeFloor": 30,
    "ecpmFloor": 85,
    "downloadFloor": 3,
    "downloadCeiling": 77,
    "clickCeiling": 105,
    "adIds": [
      "142",
      "100"
    ],
    "extensionFlowList": [
      "1",
      "2"
    ],
    "filter_zero": 73,
    "ecpmCeiling": 140,
    "flowSceneList": [
      "3",
      "2",
      "1"
    ],
    "planIds": [
      "15451"
    ],
    "clickFloor": 20,
    "exposeCeiling": 100,
    "appIdList": [
      "15536"
    ],
    "adGroupIds": [
      "1546398"
    ],
    "groupByColumn": "app_id"
  }
}

返回示例：

{
    "code": 0,
    "msg": "",
    "data": 1000
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是 application/json

Body

名称类型必须默认值备注
orderByColumns
string否数据排序字段，不传则按默认排序-数据插入顺序 建议：ftime
ascDesc
string否DESC正序逆序 可取值 ASC DESC两种 不可取其他值 支持大小写 建议配合orderByColumns一起使用， 如orderByColumns: "ftime",ascDesc: "DESC"
timeLevel
string否DAY时间聚合粒度，可填值（必须大写）：HOUR（小时），DAY（天），默认按天粒度
page
integer否1分页起始
pageCount
integer否10分页大小，最大500
paraMap
object否与业务相关的具体参数
adGroupIds
string []否广告组ID集合
extensionFlowList
string []否推广流量集合
否1.全流量场景，2自由流量，3联盟流量
planIds
string []否计划id集合
adIds
string []否广告id集合
appIdList
string []否应用集合，如果要查各个应用明细数据，则orderByColumns需要添加app_id
flowSceneList
string []否流量场景集合
否流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频、12联盟不限、13展示优选、14通知栏、15网络消息
filter_zero
integer否是否过滤真实消耗等于0的数据，1：过滤； 其余不过滤
groupByColumn
string否可根据多维度分组统计数据，默认ftime 可传入的字段：ad_id,app_id,ad_group_id,plan_id，不可随意传递
exposeFloor
integer否曝光大于exposeFloor
exposeCeiling
integer否曝光小于exposeCeiling
clickFloor
integer否点击大于clickFloor
clickCeiling
integer否点击小于clickCeiling
downloadFloor
integer否下载大于downloadFloor
downloadCeiling
integer否下载小于downloadCeiling
ecpmFloor
integer否ecpm大于ecpmFloor
ecpmCeiling
integer否ecpm小于ecpmCeiling

返回数据

名称类型必须默认值备注
code
integer是状态码 0请求正常 1系统异常 11001:服务端异常 110000：参数错误 110002：用户不存在或已过期，请重新登录 110003：无效的接口查询路径 110101：查询天数不合法，具体见msg 110104：超过批量查询最大限制，默认500 其余请看msg
msg
string是具体信息
data
integer是该查询数据总量

6.7 游戏实时明细数据查询-子客户

基本信息

Path： /v3/data/common/query/queryGameRTData

Method： POST

接口描述：

groupByColumn用法：
1.场景：需要查询多个app的数据
   解决办法：groupByColumn:app_id
2.场景：需要查询广告计划*创意分组的数据
   解决办法：groupByColumn:ad_group_id,ad_id

注：
1.默认分组字段为ftime，如果groupByColumn不为空，最后组装的sql == group by ftime,{groupByColumn}
2.groupByColumn支持的字段名格式可以查看接口返回字段名示例，注意：设置了用该字段后，返回的数据时是已经经过聚合后的数据，所以只能关注该维度字段和指标字段的值，其他维度的值是随机的。默认是ftime
3.如果想提高查询的响应速度，可以将参数"extra"设置为"skip_total"，使用该选项不会返回totalCount的值。如果需要该值的话，需要使用接口“6.6 游戏实时明细数据总量查询-子客户”进行获取。

SDK请求接入请求方法：omniAds.adsData().v3QueryQueryGameRTData(map)
请求参数示例：（同SDK请求参数）

{
    "timeLevel": "HOUR",
    "pageCount": 10,
    "page": 1,
    "ascDesc": "ASC",
    "orderByColumns": "ftime",
    "paraMap": {
        "exposeFloor": 30,
        "ecpmFloor": 85,
        "downloadFloor": 3,
        "downloadCeiling": 77,
        "clickCeiling": 105,
        "adIds": [
            "142",
            "100"
        ],
        "extensionFlowList": [
            "1",
            "2"
        ],
        "filter_zero": 73,
        "ecpmCeiling": 140,
        "flowSceneList": [
            "3",
            "2",
            "1"
        ],
        "planIds": [
            "15451"
        ],
        "clickFloor": 20,
        "exposeCeiling": 100,
        "appIdList": [
            "15536"
        ],
        "adGroupIds": [
            "1546398"
        ],
        "groupByColumn": "app_id"
    }
}

返回示例：

{
    "code": 0,
    "data": {
        "totalCount": 1,
        "itemCount": 1,
        "items": [
            {
                "game_activate_rate": 4.00,
                "owner_id": "1100050065 ",
                "click_rate": 12.32,
                "game_new_pay_price": 1.60,
                "download": 25,
                "convert_app_pay": 2,
                "click_price": 0.06,
                "ad_group_id": "1546398",
                "convert_register": 12,
                "app_id": "15536",
                "convert_app_order": 5,
                "global_spec_id": "1",
                "owner_name": "航飞",
                "convert_app_credit_price": 0.16,
                "game_activate_price": 1.60,
                "click": 25,
                "plan_name": "测试计划",
                "form_cnt": 40,
                "game_register_price": 0.40,
                "ad_group_name": "测试广告组",
                "ad_id": "100",
                "game_activate": 1,
                "ecpm": 7.88,
                "form_price": 0.04,
                "convert_app_custom": 6,
                "game_register_rate": 16.00,
                "convert_retention_price": 0.15,
                "game_new_pay": 1,
                "convert_app_order_price": 0.32,
                "convert_dp": 3,
                "flow_scene": "1",
                "download_rate": 12.32,
                "convert_register_price": 0.13,
                "convert_active_price": 0.32,
                "convert_app_credit": 10,
                "convert_app_custom_price": 0.27,
                "ftime": 2021071202,
                "download_price": 0.06,
                "cost": 1.60,
                "ad_name": "测试广告",
                "expose": 203,
                "extension_flow": "1",
                "game_new_pay_rate": 4.00,
                "convert_retention": 11,
                "convert_app_pay_price": 0.80,
                "app_name": "测试应用",
                "game_register": 4,
                "extension_type": "1",
                "convert_active": 5,
                "convertDpsPrice": 0.53,
                "plan_id": "15451",
                "ltv1_pay": 2.13,
                "roi1":133.13
            }
        ]
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是 application/json

Body

名称类型必须默认值备注
orderByColumns
string否数据排序字段，不传则按默认排序-数据插入顺序 建议：ftime
ascDesc
string否DESC正序逆序 可取值 ASC DESC两种 不可取其他值 支持大小写 建议配合orderByColumns一起使用， 如orderByColumns: "ftime",ascDesc: "DESC"
timeLevel
string否DAY时间聚合粒度，可填值（必须大写）：HOUR（小时），DAY（天），默认按天粒度
page
integer否1分页起始
pageCount
integer否10分页大小，最大500
paraMap
object否与业务相关的具体参数
adGroupIds
string []否广告组ID集合
extensionFlowList
string []否推广流量集合
否1.全流量场景，2自由流量，3联盟流量
planIds
string []否计划id集合
adIds
string []否广告id集合
appIdList
string []否应用集合，如果要查各个应用明细数据，则orderByColumns需要添加app_id
flowSceneList
string []否流量场景集合
否流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频、12联盟不限、13展示优选、14通知栏、15网络消息
filter_zero
integer否是否过滤实扣等于0的数据，1：过滤； 其余不过滤
groupByColumn
string否可根据多维度分组统计数据，默认ftime 可传入的字段：ad_id,app_id,ad_group_id,plan_id，不可随意传递
exposeFloor
integer否曝光大于exposeFloor
exposeCeiling
integer否曝光小于exposeCeiling
clickFloor
integer否点击大于clickFloor
clickCeiling
integer否点击小于clickCeiling
downloadFloor
integer否下载大于downloadFloor
downloadCeiling
integer否下载小于downloadCeiling
ecpmFloor
integer否ecpm大于ecpmFloor
ecpmCeiling
integer否ecpm小于ecpmCeiling
extra
string否额外选项，可选： 1. skip_total，传入该值时，返回的数据中不再包含totalCount数据，可以提高查询响应速度

返回数据

名称类型必须默认值备注
code
integer是状态码 0请求正常 1系统异常 11001:服务端异常 110000：参数错误 110002：用户不存在或已过期，请重新登录 110003：无效的接口查询路径 110101：查询天数不合法，具体见msg 110104：超过批量查询最大限制，默认500 其余请看msg
msg
string是具体信息
data
object是
totalCount
integer否符合查询总数
itemCount
integer否分页查询数量
items
object []否
ad_group_id
string否广告组id
ad_group_name
string否广告组名称
ad_id
string否广告id
ad_name
string否广告名称
app_id
string否应用id
app_name
string否应用名称
click
integer否点击
click_price
number否点击均价（单位：分）
click_rate
number否点击率,小数（推荐自行计算，计算公式：click/expose）
convertDpsPrice
number否回传拉活均价（单位：分）
cost
integer否广告应扣金额（单位：分）
download
integer否下载量
download_price
number否下载均价（单位：分）
download_rate
number否下载率，小数（推荐自行计算，计算公式：download/expose）
ecpm
number否ecpm
expose
integer否曝光量
extension_flow
string否推广流量：0默认值无意义，1全流量，2自有流量，3联盟流量
extension_type
string否推广类型：1链接推广，2应用推广，3快应用，7微信小程序推广，8直播推广
flow_scene
string否流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频、12联盟不限、13展示优选、14通知栏、15网络消息
ftime
integer否数据记录时间戳
game_activate
integer否平台激活人数
game_activate_price
number否平台激活均价（单位：分）
game_activate_rate
number否平台激活率，小数（推荐自行计算，计算公式：game_activate/download）
game_new_pay
integer否游戏新增付费用户数
game_new_pay_price
number否游戏新增付费均价（单位：分）
game_new_pay_rate
number否游戏新增付费率，小数（推荐自行计算，计算公式：game_new_pay/download）
game_register
integer否游戏注册人数
game_register_price
number否游戏注册均价（单位：分）
game_register_rate
number否游戏注册率，小数（推荐自行计算，计算公式：game_register/download）
global_spec_id
string否统一规格id
owner_id
string否广告主id
owner_name
string否广告主名称
plan_id
string否计划id
plan_name
string否计划名称
ltv1_pay
integer否新增付费金额（单位：分）
roi1
number否游戏付费ROI1，小数（推荐自行计算，计算公式：ltv1_pay/cost)

6.8 游戏实时汇总数据查询-子客户

基本信息

Path： /v3/data/common/summary/queryGameRTData

Method： POST

接口描述：

SDK请求接入请求方法：omniAds.adsData().v3SummaryQueryGameRTData(map)
请求参数示例：（同SDK请求参数）

{
    "endTime": 20210531,
    "beginTime": 20210401,
    "timeLevel": "DAY",
    "paraMap": {
        "exposeFloor": 30,
        "ecpmFloor": 85,
        "downloadFloor": 3,
        "downloadCeiling": 77,
        "clickCeiling": 105,
        "adIds": [
            "142",
            "100"
        ],
        "extensionFlowList": [
            "1",
            "2"
        ],
        "filter_zero": 73,
        "ecpmCeiling": 140,
        "flowSceneList": [
            "3",
            "2",
            "1"
        ],
        "planIds": [
            "15451"
        ],
        "clickFloor": 20,
        "exposeCeiling": 100,
        "appIdList": [
            "15536"
        ],
        "adGroupIds": [
            "1546398"
        ]
    }
}

返回示例：

{
    "code": 0,
    "data": {
        "game_activate_rate": 4.00,
        "owner_id": "1100050065 ",
        "click_rate": 12.32,
        "game_new_pay_price": 1.60,
        "download": 25,
        "convert_app_pay": 2,
        "click_price": 0.06,
        "ad_group_id": "1546398",
        "convert_register": 12,
        "app_id": "15536",
        "convert_app_order": 5,
        "global_spec_id": "1",
        "owner_name": "航飞",
        "convert_app_credit_price": 0.16,
        "game_activate_price": 1.60,
        "click": 25,
        "plan_name": "测试计划",
        "form_cnt": 40,
        "game_register_price": 0.40,
        "ad_group_name": "测试广告组",
        "ad_id": "100",
        "game_activate": 1,
        "ecpm": 7.88,
        "form_price": 0.04,
        "convert_app_custom": 6,
        "game_register_rate": 16.00,
        "convert_retention_price": 0.15,
        "game_new_pay": 1,
        "convert_app_order_price": 0.32,
        "convert_dp": 3,
        "flow_scene": "1",
        "download_rate": 12.32,
        "convert_register_price": 0.13,
        "convert_active_price": 0.32,
        "convert_app_credit": 10,
        "convert_app_custom_price": 0.27,
        "ftime": 202107120221,
        "download_price": 0.06,
        "cost": 1.60,
        "ad_name": "测试广告",
        "expose": 203,
        "extension_flow": "1",
        "game_new_pay_rate": 4.00,
        "convert_retention": 11,
        "convert_app_pay_price": 0.80,
        "app_name": "测试应用",
        "game_register": 4,
        "extension_type": "1",
        "convert_active": 5,
        "convertDpsPrice": 0.53,
        "plan_id": "15451",
        "ltv1_pay": 2.13,
        "roi1":133.13
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是 application/json

Body

名称类型必须默认值备注
orderByColumns
string否正序逆序 可取值 ASC DESC两种 不可取其他值 支持大小写 建议：ftime
ascDesc
string否DESC正序逆序 可取值 ASC DESC两种 不可取其他值 必须大写 建议配合orderByColumns一起使用， 如orderByColumns: "ftime",ascDesc: "DESC"
page
integer否1分页起始
pageCount
integer否10分页大小，最大500
paraMap
object否与业务相关的具体参数
adGroupIds
string []否广告组ID集合
extensionFlowList
string []否推广流量集合
否1.全流量场景，2自由流量，3联盟流量
planIds
string []否计划id集合
adIds
string []否广告id集合
appIdList
string []否应用集合，如果要查各个应用明细数据，则orderByColumns需要添加app_id
flowSceneList
string []否流量场景集合
否流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频、12联盟不限、13展示优选、14通知栏、15网络消息
filter_zero
integer否是否过滤真实消耗等于0的数据，1：过滤； 其余不过滤
exposeFloor
integer否曝光大于exposeFloor
exposeCeiling
integer否曝光小于exposeCeiling
clickFloor
integer否点击大于clickFloor
clickCeiling
integer否点击小于clickCeiling
downloadFloor
integer否下载大于downloadFloor
downloadCeiling
integer否下载小于downloadCeiling
ecpmFloor
integer否ecpm大于ecpmFloor
ecpmCeiling
integer否ecpm小于ecpmCeiling

返回数据

名称类型必须默认值备注
code
integer是状态码 0请求正常 1系统异常 11001:服务端异常 110000：参数错误 110002：用户不存在或已过期，请重新登录 110003：无效的接口查询路径 110101：查询天数不合法，具体见msg 110104：超过批量查询最大限制，默认500 其余请看msg
msg
string是具体信息
data
object否
ad_group_id
string否广告组id
ad_group_name
string否广告组名称
ad_id
string否广告id
ad_name
string否广告名称
app_id
string否应用id
app_name
string否应用名称
click
integer否点击
click_price
number否点击均价（单位：分）
click_rate
number否点击率，小数（推荐自行计算，计算公式：click/expose）
cost
integer否广告应扣金额（单位：分）
download
integer否下载量
download_price
number否下载均价（单位：分）
download_rate
number否下载率，小数（推荐自行计算，计算公式：download/expose）
ecpm
number否ecpm
expose
integer否曝光量
extension_flow
string否推广流量：0默认值无意义，1全流量，2自有流量，3联盟流量
extension_type
string否推广类型：1链接推广，2应用推广，3快应用，7微信小程序推广，8直播推广
flow_scene
string否流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频、12联盟不限、13展示优选、14通知栏、15网络消息
form_cnt
integer否表单量
form_price
number否表单均价（单位：分）
ftime
integer否数据记录时间戳
game_activate
integer否平台激活人数
game_activate_price
number否平台激活均价（单位：分）
game_activate_rate
number否平台激活率，小数（推荐自行计算，计算公式：game_activate/download）
game_new_pay
integer否游戏新增付费用户数
game_new_pay_price
number否游戏新增付费均价（单位：分）
game_new_pay_rate
number否游戏新增付费率，小数（推荐自行计算，计算公式：game_new_pay/download）
game_register
integer否游戏注册人数
game_register_price
number否游戏注册均价（单位：分）
game_register_rate
number否游戏注册率，小数（推荐自行计算，计算公式：game_register/download）
global_spec_id
string否统一规格id
owner_id
string否广告主id
owner_name
string否广告主名称
plan_id
string否计划id
plan_name
string否计划名称
ltv1_pay
integer否新增付费金额（单位：分）
roi1
number否游戏付费ROI1，小数（推荐自行计算，计算公式：ltv1_pay/cost)

6.10 游戏明细数据查询-子客户

基本信息

Path： /v3/data/common/query/queryGameOffLineData

Method： POST

接口描述：

注：
1.如果想提高查询的响应速度，可以将参数"extra"设置为"skip_total"，使用该选项不会返回totalCount的值。如果需要该值的话，需要使用接口“6.9 游戏明细数据总量查询-子客户”进行获取。
SDK请求接入请求方法：omniAds.adsData().v3QueryQueryGameOffLineData(map)
请求参数示例：（同SDK请求参数）

{
    "beginTime": 20210621,
    "endTime": 20210621,
    "orderByColumns": "dt",
    "ascDesc": "asc",
    "timeLevel": "DAY",
    "page": 1,
    "pageCount": 10,
    "paraMap": {
        "adGroupIds": [
            "1234",
            "5326"
        ],
        "extensionFlowList": [
            "1",
            "2"
        ],
        "planIds": [
            "1234",
            "5326"
        ],
        "exposeFloor": 1,
        "exposeCeiling": 2,
        "clickFloor": 1,
        "clickCeiling": 1,
        "downloadFloor": 1,
        "downloadCeiling": 1,
        "ecpmFloor": 1,
        "ecpmCeiling": 1,
        "adIds": [
            "41532",
            "6437654",
            "58685",
            "2352"
        ],
        "appIdList": [
            "26564",
            "45865586",
            "627637"
        ],
        "app_id": "1415",
        "app_name": "consequat",
        "flowSceneList": [
            "1",
            "2",
            "3"
        ]
    }
}

返回参数示例：

{
    "code": 0,
    "data": {
        "totalCount": 3,
        "itemCount": 3,
        "items": [
            {
                "buy_user_income0": 0.00,
                "owner_id": "1100050065",
                "new_user_roi30": 0.0000,
                "click_rate": 0.0000,
                "inter_buy_ltv3": 0.00,
                "inter_buy_ltv7": 0.00,
                "inter_buy_roi30": 0.0000,
                "ad_price": 0.00,
                "new_pay_price": 0.00,
                "flow_scene": "-1",
                "new_user_roi3": 0.0000,
                "new_pay_rate": 0.0000,
                "active_nums": 0,
                "new_user_roi1": 10.0000,
                "down_rate": 0.0000,
                "fdate": 20210605,
                "down_cnt": 0,
                "register_rate": 0.0000,
                "click_price": 0.00,
                "app_id": 123,
                "down_price": 0.00,
                "global_spec_id": "-1",
                "inter_buy_ltv30": 0.00,
                "group_name": "未知",
                "active_price": 0.00,
                "expose_nums": 0,
                "inter_buy_roi7": 0.0000,
                "click_nums": 0,
                "inter_buy_roi3": 0.0000,
                "active_rate": 0.0000,
                "plan_name": "未知",
                "extension_flow": "-1",
                "ad_new_pay_ssoid": 0,
                "new_user_roi7": 0.0000,
                "inter_buy_roi1": 20.0000,
                "total_pay": 0.00,
                "ad_new_pay": 0.00,
                "new_user_ltv7": 0.00,
                "ecpm": 0.00,
                "inter_buy_ltv1": 0.01,
                "new_user_ltv1": 0.03,
                "group_id": "-1",
                "new_user_ltv3": 0.00,
                "new_user_ltv30": 0.00,
                "register_price": 0.00,
                "extension_type": "-1",
                "plan_id": "-1",
                "ad_new_ssoid": 0,
                "cash_cost":0
            },
            {
                "buy_user_income0": 0.20,
                "owner_id": "1100050065",
                "new_user_roi30": 0.0000,
                "click_rate": 0.8000,
                "ad_price": 0.43,
                "new_pay_price": 0.34,
                "new_pay_rate": 0.3500,
                "active_nums": 96,
                "click_price": 0.02,
                "app_id": 24535,
                "down_price": 0.20,
                "global_spec_id": "-1",
                "owner_name": "3",
                "inter_buy_ltv30": 0.25,
                "group_name": "未知",
                "expose_nums": 3,
                "click_nums": 20,
                "active_rate": 0.0300,
                "plan_name": "未知",
                "new_user_roi7": 0.0000,
                "total_pay": 6.00,
                "ad_id": "1000001",
                "new_user_ltv7": 0.00,
                "ecpm": 0.10,
                "new_user_ltv1": 0.02,
                "new_user_ltv3": 0.00,
                "new_user_ltv30": 0.00,
                "register_price": 0.50,
                "ad_new_ssoid": 35,
                "inter_buy_ltv3": 0.04,
                "inter_buy_ltv7": 0.36,
                "inter_buy_roi30": 20.0000,
                "flow_scene": "-1",
                "new_user_roi3": 0.0000,
                "new_user_roi1": 0.0000,
                "down_rate": 0.3000,
                "fdate": 2021629,
                "down_cnt": 90,
                "register_rate": 0.7000,
                "active_price": 0.07,
                "ad_name": "测试广告",
                "inter_buy_roi7": 20.0000,
                "inter_buy_roi3": 20.0000,
                "extension_flow": "-1",
                "ad_new_pay_ssoid": 57,
                "inter_buy_roi1": 25.0000,
                "app_name": "测试",
                "ad_new_pay": 0.15,
                "inter_buy_ltv1": 0.26,
                "group_id": "2563",
                "extension_type": "-1",
                "plan_id": "4747",
                "cash_cost":0
            },
            {
                "buy_user_income0": 0.22,
                "owner_id": "1100050065",
                "new_user_roi30": 0.0000,
                "click_rate": 0.8500,
                "ad_price": 0.43,
                "new_pay_price": 0.33,
                "new_pay_rate": 0.1500,
                "active_nums": 245,
                "click_price": 0.06,
                "app_id": 24535,
                "down_price": 0.24,
                "global_spec_id": "-1",
                "owner_name": "3",
                "inter_buy_ltv30": 0.25,
                "group_name": "未知",
                "expose_nums": 45,
                "click_nums": 20,
                "active_rate": 0.0300,
                "plan_name": "未知",
                "new_user_roi7": 0.0000,
                "total_pay": 6.00,
                "ad_id": "1000001",
                "new_user_ltv7": 0.00,
                "ecpm": 0.10,
                "new_user_ltv1": 0.02,
                "new_user_ltv3": 0.00,
                "new_user_ltv30": 0.00,
                "register_price": 0.35,
                "ad_new_ssoid": 68,
                "inter_buy_ltv3": 0.53,
                "inter_buy_ltv7": 0.36,
                "inter_buy_roi30": 20.1000,
                "flow_scene": "-1",
                "new_user_roi3": 0.0000,
                "new_user_roi1": 30.0000,
                "down_rate": 0.3500,
                "fdate": 2021630,
                "down_cnt": 25,
                "register_rate": 0.6000,
                "active_price": 0.13,
                "ad_name": "测试广告",
                "inter_buy_roi7": 20.4000,
                "inter_buy_roi3": 25.0000,
                "extension_flow": "-1",
                "ad_new_pay_ssoid": 24,
                "inter_buy_roi1": 25.3000,
                "app_name": "测试",
                "ad_new_pay": 0.26,
                "inter_buy_ltv1": 0.20,
                "group_id": "2563",
                "extension_type": "-1",
                "plan_id": "4747",
                "cash_cost":0
            }
        ]
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是 application/json

Body

名称类型必须默认值备注
beginTime
integer否起始时间 不填的话默认是当天如20201001 目前不支持实时数据，故需要填写起始时间小于当天时间 beginTime endTime须配合使用
endTime
integer否结束时间 不填的话默认是当天如20201001 目前不支持实时数据，故需要填写结束时间小于当天时间 beginTime endTime须配合使用
orderByColumns
string否数据排序字段，不传则按默认排序-数据插入顺序 建议：dt
ascDesc
string否DESC正序逆序 可取值 ASC DESC两种 不可取其他值 支持大小写 建议配合orderByColumns一起使用， 如orderByColumns: "dt",ascDesc: "DESC"
timeLevel
string否DAY时间聚合粒度，可填值（必须大写）：DAY（天），默认按天粒度
page
integer否1分页起始
pageCount
integer否10分页大小，最大500
paraMap
object否与业务相关的具体参数
adGroupIds
string []否广告组ID集合
extensionFlowList
string []否推广流量集合
否1.全流量场景，2自由流量，3联盟流量
planIds
string []否计划id集合
exposeFloor
integer否曝光大于exposeFloor
exposeCeiling
integer否曝光小于exposeCeiling
clickFloor
integer否点击大于clickFloor
clickCeiling
integer否点击小于clickCeiling
downloadFloor
integer否下载大于downloadFloor
downloadCeiling
integer否下载小于downloadCeiling
ecpmFloor
integer否ecpm大于ecpmFloor
ecpmCeiling
integer否ecpm小于ecpmCeiling
adIds
string []否广告id集合
appIdList
string []否应用集合，如果要查各个应用明细数据，则orderByColumns需要添加app_id
app_id
string否应用id
app_name
string否支持模糊查询应用名称
flowSceneList
string []否流量场景集合
否流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频、12联盟不限、13展示优选、14通知栏、15网络消息
extra
string否额外选项，可选： 1. skip_total，传入该值时，返回的数据中不再包含totalCount数据，可以提高查询响应速度

返回数据

名称类型必须默认值备注
code
integer是状态码 0请求正常 1系统异常 11001:服务端异常 110000：参数错误 110002：用户不存在或已过期，请重新登录 110003：无效的接口查询路径 110101：查询天数不合法，具体见msg 110104：超过批量查询最大限制，默认500 其余请看msg
msg
string是具体信息
data
object是
totalCount
integer否符合查询总数
itemCount
integer否分页查询数量
items
object []否
fdate
string否数据日期，如20210614
app_id
string否应用id
app_name
string否应用名称
owner_id
string否广告主Id
owner_name
string否广告主名称
group_id
string否广告组Id
group_name
string否广告组名称
plan_id
string否计划id
plan_name
string否计划名称
ad_id
string否广告id
ad_name
string否广告名称
extension_type
integer否推广目标 1链接推广，2应用推广，3快应用，7微信小程序推广，8直播推广
global_spec_id
integer否统一规格id
extension_flow
integer否推广流量：0默认值无意义，1全流量场景、2自有流量、3联盟流量
flow_scene
integer否流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频、12联盟不限、13展示优选、14通知栏、15网络消息
total_pay
number否总付费流水（分）
ad_new_ssoid
integer否注册人数
ad_new_pay_ssoid
integer否新增付费人数
ad_new_pay
number否首日付费流水（单位：分）
down_cnt
integer否下载次数（搜索&分发：实扣下载；信息流合联盟：总下载）
expose_nums
integer否曝光数
click_nums
integer否点击数
click_rate
number否点击率，小数
down_rate
number否下载率，小数
register_rate
number否注册率，小数
register_price
number否注册成本
new_pay_price
number否付费成本
active_nums
integer否激活人数，通过买量下载最近180天激活的用户
active_rate
number否激活率，小数
new_pay_rate
number否付费转化率，小数
ad_price
number否广告实扣金额（单位：分）
new_user_ltv1
number否游戏付费LVT1（单位：分）
new_user_ltv3
number否游戏付费LVT3（单位：分）
new_user_ltv7
number否游戏付费LVT7（单位：分）
new_user_ltv30
number否游戏付费LVT30（单位：分）
buy_user_income0
number否首日广告收入（单位：分）
inter_buy_roi1
number否广告变现ROI1
inter_buy_roi3
number否广告变现ROI3
inter_buy_roi7
number否广告变现ROI7
inter_buy_roi30
number否广告变现ROI30
new_user_roi1
number否游戏付费ROI1
new_user_roi3
number否游戏付费ROI3
new_user_roi7
number否游戏付费ROI7
new_user_roi30
number否游戏付费ROI30
ecpm
number否
click_price
number否点击均价（单位：分）
down_price
number否下载成本（单位：分）
active_price
number否激活成本（单位：分）
inter_buy_ltv1
number否广告变现LTV1（单位：分）
inter_buy_ltv3
number否广告变现LTV3（单位：分）
inter_buy_ltv7
number否广告变现LTV7（单位：分）
inter_buy_ltv30
number否广告变现LTV30（单位：分）
10per_total_pay
number否1-9分成付费流水（单位：分）
50per_total_pay
number否5-5分成付费流水（单位：分）
pay_retention1
integer否次日留存数（付费）
pay_retention3
integer否3日留存数
pay_retention7
integer否7日留存数
pay_retention14
integer否14日留存数
pay_retention30
integer否30日留存数
pay_retention1_rate
number否次日留存率
pay_retention3_rate
number否3日留存率
pay_retention7_rate
number否7日留存率
pay_retention14_rate
number否14日留存率
pay_retention30_rate
number否30日留存率
activate_nums
integer否启动用户数
cash_retention1
integer否次日留存数（变现）
cash_retention3
integer否3日留存数（变现）
cash_retention7
integer否7日留存数（变现）
cash_retention1_rate
number否次日留存率（变现）
cash_retention3_rate
number否3日留存率（变现）
cash_retention7_rate
number否7日留存率（变现）
buy_user_income_active
number否买量广告收入（单位：分）
buy_user_income_active_roi
number否广告变现活跃ROI
game_app_act_nums
integer否游戏关键行为量
game_app_act_price
number否游戏关键行为成本（单位：分）
pay_nums
integer否付费次数
pay_per_price
number否每次付费成本（单位：分）
cash_cost
number否现金消耗（单位：分）

6.9 游戏明细数据总量查询-子客户

基本信息

Path： /v3/data/common/total/queryGameOffLineData

Method： POST

接口描述：

SDK请求接入请求方法：omniAds.adsData().v3TotalQueryGameOffLineData(map)
请求参数示例：（同SDK请求参数）

{
    "beginTime": 20210621,
    "endTime": 20210621,
    "orderByColumns": "dt",
    "ascDesc": "asc",
    "timeLevel": "DAY",
    "paraMap": {
        "adGroupIds": [
            "1234",
            "5326"
        ],
        "extensionFlowList": [
            "1",
            "2"
        ],
        "planIds": [
            "1234",
            "5326"
        ],
        "exposeFloor": 1,
        "exposeCeiling": 2,
        "clickFloor": 1,
        "clickCeiling": 1,
        "downloadFloor": 1,
        "downloadCeiling": 1,
        "ecpmFloor": 1,
        "ecpmCeiling": 1,
        "adIds": [
            "41532",
            "6437654",
            "58685",
            "2352"
        ],
        "appIdList": [
            "26564",
            "45865586",
            "627637"
        ],
        "app_id": "1415",
        "app_name": "consequat",
        "flowSceneList": [
            "1",
            "2",
            "3"
        ]
    }
}

返回参数示例：

{
    "code": 0,
    "msg": "",
    "data": 1000
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是 application/json

Body

名称类型必须默认值备注
beginTime
integer否起始时间 不填的话默认是当天如20201001 目前不支持实时数据，故需要填写起始时间小于当天时间 beginTime endTime须配合使用
endTime
integer否结束时间 不填的话默认是当天如20201001 目前不支持实时数据，故需要填写结束时间小于当天时间 beginTime endTime须配合使用
orderByColumns
string否数据排序字段，不传则按默认排序-数据插入顺序 建议：dt
ascDesc
string否DESC正序逆序 可取值 ASC DESC两种 不可取其他值 支持大小写 建议配合orderByColumns一起使用， 如orderByColumns: "dt",ascDesc: "DESC"
timeLevel
string否DAY时间聚合粒度，可填值（必须大写）：DAY（天），默认按天粒度
paraMap
object否与业务相关的具体参数
adGroupIds
string []否广告组ID集合
extensionFlowList
string []否推广流量集合
否1.全流量场景，2自由流量，3联盟流量
planIds
string []否计划id集合
exposeFloor
integer否曝光大于exposeFloor
exposeCeiling
integer否曝光小于exposeCeiling
clickFloor
integer否点击大于clickFloor
clickCeiling
integer否点击小于clickCeiling
downloadFloor
integer否下载大于downloadFloor
downloadCeiling
integer否下载小于downloadCeiling
ecpmFloor
integer否ecpm大于ecpmFloor
ecpmCeiling
integer否ecpm小于ecpmCeiling
adIds
string []否广告id集合
appIdList
string []否应用集合，如果要查各个应用明细数据，则orderByColumns需要添加app_id
app_id
string否应用id
app_name
string否支持模糊查询应用名称
flowSceneList
string []否流量场景集合
否流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频、12联盟不限、13展示优选、14通知栏、15网络消息

返回数据

名称类型必须默认值备注
code
integer是状态码 0请求正常 1系统异常 11001:服务端异常 110000：参数错误 110002：用户不存在或已过期，请重新登录 110003：无效的接口查询路径 110101：查询天数不合法，具体见msg 110104：超过批量查询最大限制，默认500 其余请看msg
msg
string是具体信息
data
integer是该查询数据总量

6.11 关键词明细数据总量查询-子客户

基本信息

Path： /v3/data/common/total/queryKwData

Method： POST

接口描述：

groupByColumn用法：
1.场景：需要查询多个广告创意的数据
   解决办法：groupByColumn:ad_id
2.场景：需要查询广告计划*创意分组的数据
   解决办法：groupByColumn:ad_group_id,ad_id

注：
1.默认分组字段为ftime，如果groupByColumn不为空，最后组装的sql == group by ftime,{groupByColumn}

SDK请求接入请求方法：omniAds.adsData().v3TotalQueryKwData(map)
请求参数示例：（同SDK请求参数）

{
    "beginTime": 20210401,
    "page": 1,
    "endTime": 20210531,
    "paraMap": {
        "planIds": [
            "1342"
        ],
        "groupByColumn": "keywords",
        "adGroupIds": [
            "412412",
            "523",
            "4125"
        ],
        "adIds": [
            "312",
            "52"
        ],
        "filter_zero": 65950122,
        "extensionTypeList": [
            "1"
        ],
        "extensionFlowList": [
            "1"
        ],
        "flowSceneList": [
            "1",
            "2"
        ]
    },
    "orderByColumns": "ftime",
    "pageCount": 10,
    "timeLevel": "DAY",
    "ascDesc": "ASC"
}

返回参数示例：

{
    "code": 0,
    "msg": "",
    "data": 1000
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是 application/json

Body

名称类型必须默认值备注
beginTime
integer否起始时间 不填的话默认是当天如20201001 beginTime endTime须配合使用
endTime
integer否结束时间 不填的话默认是当天如20201001 beginTime endTime须配合使用
timeLevel
string否DAY时间聚合粒度，可填值（必须大写）：DAY（天），默认按天粒度
paraMap
object否与业务相关的具体参数
adGroupIds
string []否广告组ID集合
extensionFlowList
string []否推广流量集合
否1.全流量场景，2自由流量，3联盟流量
extensionTypeList
string []否推广目标集合
否 1:链接推广 2:应用推广 3:快应用推广 7:微信小程序推广 8:直播推广
flowSceneList
string []否流量场景集合
否流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频、12联盟不限、13展示优选、14通知栏、15网络消息
planIds
string []否计划id集合
filter_zero
integer否是否过滤真实消耗等于0的数据，1：过滤； 其余不过滤
adIds
string []否广告id集合
groupByColumn
string否数据查询分组字段，参考keywords 其他字段可根据返回字段名类比，不可随意传递

可以进行分组的字段：
plan_id，ad_group_id，ad_id，app_id
注意：设置了用该字段后，返回的数据时是已经经过聚合后的数据，所以只能关注该维度字段和指标字段的值，其他维度的值是随机的。

返回数据

名称类型必须默认值备注
code
integer是状态码 0请求正常 1系统异常 11001:服务端异常 110000：参数错误 110002：用户不存在或已过期，请重新登录 110003：无效的接口查询路径 110101：查询天数不合法，具体见msg 110104：超过批量查询最大限制，默认500 其余请看msg
msg
string是返回信息
data
integer是查询数据总量

6.12 关键词明细数据查询-子客户

基本信息

Path： /v3/data/common/query/queryKwData

Method： POST

接口描述：

groupByColumn用法：
1.场景：需要查询多个广告创意的数据
   解决办法：groupByColumn:ad_id
2.场景：需要查询广告计划*创意分组的数据
   解决办法：groupByColumn:ad_group_id,ad_id

注：
1.默认分组字段为ftime，如果groupByColumn不为空，最后组装的sql == group by ftime,{groupByColumn}
2.groupByColumn支持的字段名格式可以查看接口返回字段名示例,注意：设置了用该字段后，返回的数据时是已经经过聚合后的数据，所以只能关注该维度字段和指标字段的值，其他维度的值是随机的，所以出现该情况时请忽略。默认ftime
3.如果想提高查询的响应速度，可以将参数"extra"设置为"skip_total"，使用该选项不会返回totalCount的值。如果需要该值的话，需要使用接口“6.11 关键词明细数据总量查询-子客户”进行获取。

SDK请求接入请求方法：omniAds.adsData().v3QueryQueryKwData(map)
请求参数示例：（同SDK请求参数）

{
    "beginTime": 20210401,
    "page": 1,
    "endTime": 20210531,
    "paraMap": {
        "planIds": [
            "1342"
        ],
        "groupByColumn": "keywords",
        "adGroupIds": [
            "412412",
            "523",
            "4125"
        ],
        "adIds": [
            "312",
            "52"
        ],
        "filter_zero": 65950122,
        "extensionTypeList": [
            "1"
        ],
        "extensionFlowList": [
            "1"
        ],
        "flowSceneList": [
            "1",
            "2"
        ]
    },
    "orderByColumns": "ftime",
    "pageCount": 10,
    "timeLevel": "DAY",
    "ascDesc": "ASC"
}

返回参数示例：

{
    "code": 0,
    "data": {
        "totalCount": 61,
        "itemCount": 10,
        "items": [
            {
                "keywords": "keyworld",
                "owner_id": "1100050065",
                "click_rate": 32.60,
                "flow_scene": "5",
                "download": 18600,
                "download_rate": 24.93,
                "click_price": 3.82,
                "ad_group_id": "300041199",
                "app_id": "0",
                "ftime": 20210401,
                "global_spec_id": "71",
                "download_price": 4.99,
                "owner_name": "二级代理商子客户test",
                "cost": 92831.40,
                "ad_name": "搜索-唯品会-CPD-测试0603-图标-2021/06/18 16:50:24",
                "expose": 74598,
                "click": 24318,
                "plan_name": "",
                "extension_flow": "2",
                "app_name": "",
                "ad_group_name": "",
                "ad_id": "400037338",
                "result_expose_nums": 105,
                "ecpm": 1244.42,
                "orderFlag": 3,
                "pos_nums": 667,
                "extension_type": "1",
                "plan_id": "200006592",
                "bidRank": 6.35
            },
            {
                "keywords": "keyworld",
                "owner_id": "1100050065",
                "click_rate": 34.65,
                "flow_scene": "5",
                "download": 20400,
                "download_rate": 25.00,
                "click_price": 4.08,
                "ad_group_id": "300041199",
                "app_id": "0",
                "ftime": 20210402,
                "global_spec_id": "71",
                "download_price": 5.66,
                "owner_name": "二级代理商子客户test",
                "cost": 115450.20,
                "ad_name": "搜索-唯品会-CPD-测试0603-图标-2021/06/18 16:50:24",
                "expose": 81588,
                "click": 28272,
                "plan_name": "",
                "extension_flow": "2",
                "app_name": "",
                "ad_group_name": "",
                "ad_id": "400037338",
                "result_expose_nums": 117,
                "ecpm": 1415.04,
                "orderFlag": 3,
                "pos_nums": 910,
                "extension_type": "1",
                "plan_id": "200006592",
                "bidRank": 7.78
            },
            {
                "keywords": "keyworld",
                "owner_id": "1100050065",
                "click_rate": 23.25,
                "flow_scene": "5",
                "download": 10644,
                "download_rate": 16.14,
                "click_price": 30.74,
                "ad_group_id": "300041199",
                "app_id": "0",
                "ftime": 20210403,
                "global_spec_id": "71",
                "download_price": 44.27,
                "owner_name": "二级代理商子客户test",
                "cost": 471240.24,
                "ad_name": "搜索-唯品会-CPD-测试0603-图标-2021/06/18 16:50:24",
                "expose": 65946,
                "click": 15330,
                "plan_name": "",
                "extension_flow": "2",
                "app_name": "",
                "ad_group_name": "",
                "ad_id": "400037338",
                "result_expose_nums": 125,
                "ecpm": 7145.85,
                "orderFlag": 3,
                "pos_nums": 557,
                "extension_type": "1",
                "plan_id": "200006592",
                "bidRank": 4.46
            },
            {
                "keywords": "keyworld",
                "owner_id": "1100050065",
                "click_rate": 21.33,
                "flow_scene": "5",
                "download": 8700,
                "download_rate": 8.68,
                "click_price": 119.49,
                "ad_group_id": "300041199",
                "app_id": "0",
                "ftime": 20210404,
                "global_spec_id": "71",
                "download_price": 293.54,
                "owner_name": "二级代理商子客户test",
                "cost": 2553807.36,
                "ad_name": "搜索-唯品会-CPD-测试0603-图标-2021/06/18 16:50:24",
                "expose": 100188,
                "click": 21372,
                "plan_name": "",
                "extension_flow": "2",
                "app_name": "",
                "ad_group_name": "",
                "ad_id": "400037338",
                "result_expose_nums": 197,
                "ecpm": 25490.15,
                "orderFlag": 3,
                "pos_nums": 703,
                "extension_type": "1",
                "plan_id": "200006592",
                "bidRank": 3.57
            },
            {
                "keywords": "keyworld",
                "owner_id": "1100050065",
                "click_rate": 19.58,
                "flow_scene": "5",
                "download": 12492,
                "download_rate": 12.85,
                "click_price": 34.55,
                "ad_group_id": "300041199",
                "app_id": "0",
                "ftime": 20210405,
                "global_spec_id": "71",
                "download_price": 52.65,
                "owner_name": "二级代理商子客户test",
                "cost": 657730.74,
                "ad_name": "搜索-唯品会-CPD-测试0603-图标-2021/06/18 16:50:24",
                "expose": 97242,
                "click": 19038,
                "plan_name": "",
                "extension_flow": "2",
                "app_name": "",
                "ad_group_name": "",
                "ad_id": "400037338",
                "result_expose_nums": 5,
                "ecpm": 6763.85,
                "orderFlag": 3,
                "pos_nums": 701,
                "extension_type": "1",
                "plan_id": "200006592",
                "bidRank": 140.20
            },
            {
                "keywords": "keyworld",
                "owner_id": "1100050065",
                "click_rate": 12.48,
                "flow_scene": "5",
                "download": 9564,
                "download_rate": 8.11,
                "click_price": 145.15,
                "ad_group_id": "300041199",
                "app_id": "0",
                "ftime": 20210406,
                "global_spec_id": "71",
                "download_price": 223.29,
                "owner_name": "二级代理商子客户test",
                "cost": 2135517.78,
                "ad_name": "搜索-唯品会-CPD-测试0603-图标-2021/06/18 16:50:24",
                "expose": 117894,
                "click": 14712,
                "plan_name": "",
                "extension_flow": "2",
                "app_name": "",
                "ad_group_name": "",
                "ad_id": "400037338",
                "result_expose_nums": 42,
                "ecpm": 18113.88,
                "orderFlag": 3,
                "pos_nums": 919,
                "extension_type": "1",
                "plan_id": "200006592",
                "bidRank": 21.88
            },
            {
                "keywords": "keyworld",
                "owner_id": "1100050065",
                "click_rate": 19.26,
                "flow_scene": "5",
                "download": 10374,
                "download_rate": 9.98,
                "click_price": 111.59,
                "ad_group_id": "300041199",
                "app_id": "0",
                "ftime": 20210407,
                "global_spec_id": "71",
                "download_price": 215.31,
                "owner_name": "二级代理商子客户test",
                "cost": 2233640.28,
                "ad_name": "搜索-唯品会-CPD-测试0603-图标-2021/06/18 16:50:24",
                "expose": 103938,
                "click": 20016,
                "plan_name": "",
                "extension_flow": "2",
                "app_name": "",
                "ad_group_name": "",
                "ad_id": "400037338",
                "result_expose_nums": 31,
                "ecpm": 21490.12,
                "orderFlag": 3,
                "pos_nums": 426,
                "extension_type": "1",
                "plan_id": "200006592",
                "bidRank": 13.74
            },
            {
                "keywords": "keyworld",
                "owner_id": "1100050065",
                "click_rate": 24.69,
                "flow_scene": "5",
                "download": 10986,
                "download_rate": 9.36,
                "click_price": 72.64,
                "ad_group_id": "300041199",
                "app_id": "0",
                "ftime": 20210408,
                "global_spec_id": "71",
                "download_price": 191.62,
                "owner_name": "二级代理商子客户test",
                "cost": 2105108.22,
                "ad_name": "搜索-唯品会-CPD-测试0603-图标-2021/06/18 16:50:24",
                "expose": 117390,
                "click": 28980,
                "plan_name": "",
                "extension_flow": "2",
                "app_name": "",
                "ad_group_name": "",
                "ad_id": "400037338",
                "result_expose_nums": 139,
                "ecpm": 17932.60,
                "orderFlag": 3,
                "pos_nums": 393,
                "extension_type": "1",
                "plan_id": "200006592",
                "bidRank": 2.83
            },
            {
                "keywords": "keyworld",
                "owner_id": "1100050065",
                "click_rate": 38.42,
                "flow_scene": "5",
                "download": 10710,
                "download_rate": 15.38,
                "click_price": 89.13,
                "ad_group_id": "300041199",
                "app_id": "0",
                "ftime": 20210409,
                "global_spec_id": "71",
                "download_price": 222.70,
                "owner_name": "二级代理商子客户test",
                "cost": 2385156.42,
                "ad_name": "搜索-唯品会-CPD-测试0603-图标-2021/06/18 16:50:24",
                "expose": 69648,
                "click": 26760,
                "plan_name": "",
                "extension_flow": "2",
                "app_name": "",
                "ad_group_name": "",
                "ad_id": "400037338",
                "result_expose_nums": 58,
                "ecpm": 34245.87,
                "orderFlag": 3,
                "pos_nums": 870,
                "extension_type": "1",
                "plan_id": "200006592",
                "bidRank": 15.00
            },
            {
                "keywords": "keyworld",
                "owner_id": "1100050065",
                "click_rate": 28.08,
                "flow_scene": "5",
                "download": 20964,
                "download_rate": 32.64,
                "click_price": 60.52,
                "ad_group_id": "300041199",
                "app_id": "0",
                "ftime": 20210410,
                "global_spec_id": "71",
                "download_price": 52.07,
                "owner_name": "二级代理商子客户test",
                "cost": 1091495.88,
                "ad_name": "搜索-唯品会-CPD-测试0603-图标-2021/06/18 16:50:24",
                "expose": 64224,
                "click": 18036,
                "plan_name": "",
                "extension_flow": "2",
                "app_name": "",
                "ad_group_name": "",
                "ad_id": "400037338",
                "result_expose_nums": 61,
                "ecpm": 16995.14,
                "orderFlag": 3,
                "pos_nums": 525,
                "extension_type": "1",
                "plan_id": "200006592",
                "bidRank": 8.61
            }
        ]
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是 application/json

Body

名称类型必须默认值备注
beginTime
integer否起始时间 不填的话默认是当天如20201001 beginTime endTime须配合使用
endTime
integer否结束时间 不填的话默认是当天如20201001 beginTime endTime须配合使用
orderByColumns
string否数据排序字段，不传则按默认排序-数据插入顺序 建议：dt 可以排序的字段： dt、ftime、owner_id、plan_id、ad_group_id、ad_id、app_id、global_spec_id、click、click_price、click_rate、cost、download、download_price、download_rate、ecpm、expose、extension_flow、extension_type、flow_scene、result_expose_nums
ascDesc
string否DESC正序逆序 可取值 ASC DESC两种 不可取其他值 支持大小写 建议配合orderByColumns一起使用， 如orderByColumns: "ftime",ascDesc: "DESC"
timeLevel
string否DAY时间聚合粒度，可填值（必须大写）：DAY（天），默认按天粒度
page
integer否1分页起始
pageCount
integer否10分页大小,最大500
paraMap
object否与业务相关的具体参数
adGroupIds
string []否广告组ID集合
extensionFlowList
string []否推广流量集合
否1.全流量场景，2自由流量，3联盟流量
extensionTypeList
string []否推广目标集合
否 1:链接推广 2:应用推广 3:快应用推广 7:微信小程序推广 8:直播推广
flowSceneList
string []否流量场景集合
否流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频、12联盟不限、13展示优选、14通知栏、15网络消息
planIds
string []否计划id集合
filter_zero
integer否是否过滤真实消耗等于0的数据，1：过滤； 其余不过滤
adIds
string []否广告id集合
groupByColumn
string否数据查询分组字段，参考keywords 其他字段可根据返回字段名类比，不可随意传递

可以进行分组的字段：
plan_id，ad_group_id，ad_id，app_id
注意：设置了用该字段后，返回的数据时是已经经过聚合后的数据，所以只能关注该维度字段和指标字段的值，其他维度的值是随机的。

extra
string否额外选项，可选：

  1. skip_total，传入该值时，返回的数据中不再包含totalCount数据，可以提高查询响应速度

返回数据

名称类型必须默认值备注
code
integer是状态码 0请求正常 1系统异常 11001:服务端异常 110000：参数错误 110002：用户不存在或已过期，请重新登录 110003：无效的接口查询路径 110101：查询天数不合法，具体见msg 110104：超过批量查询最大限制，默认500 其余请看msg
msg
string是返回信息
data
object是
totalCount
integer否符合查询总数
itemCount
integer否分页查询数量
items
object否
ad_group_id
string否广告组id
ad_group_name
string否广告组名称
ad_id
string否广告id
ad_name
string否广告名称
app_id
string否应用id
app_name
string否应该名称
bidRank
integer否竞价排名（pos_nums/result_expose_nums）
click
integer否点击量
click_price
number否点击均价（单位：分）
click_rate
number否点击率，小数
cost
integer否消耗（单位：分）
download
integer否下载量
download_price
number否下载均价（单位：分）
download_rate
number否下载率，小数
ecpm
number否ecpm
expose
integer否曝光量
extension_flow
string否推广流量：0默认值无意义，1全流量场景、2自有流量、3联盟流量
extension_type
string否1:链接推广 2:应用推广 3:快应用 7:微信小程序推广 8:直播推广
flow_scene
string否流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频、12联盟不限、13展示优选、14通知栏、15网络消息
global_spec_id
string否统一规格id
orderFlag
string否排序字段 查询不传keywords ，则按orderFlag asc, {#orderByColumns}{#ascDesc}排序。其余则根据 {#orderByColumns}{#ascDesc}排序 orderFlag :排序规则，1系统拓量，2类目词包，3出价词
owner_id
string否广告主id
owner_name
string否广告主名称
plan_id
string否计划id
plan_name
string否计划名称
pos_nums
integer否结果页广告位序号总和
result_expose_nums
integer否结果页曝光量
keywords
string否关键词

6.13 关键词汇总数据查询-子客户

基本信息

Path： /v3/data/common/summary/queryKwData

Method： POST

接口描述：

SDK请求接入请求方法：omniAds.adsData().v3SummaryQueryKwData(map)
请求参数示例：（同SDK请求参数）

{
    "endTime": 20210531,
    "beginTime": 20210401,
    "timeLevel": "DAY",
    "paraMap": {
        "filter_zero": 0
    }
}

返回参数示例：

{
    "code": 0,
    "data": {
        "keywords": "keyworld",
        "owner_id": "1100050065",
        "click_rate": 21.15,
        "flow_scene": "5",
        "download": 933036,
        "download_rate": 17.67,
        "click_price": 78.81,
        "ad_group_id": "300041199",
        "app_id": "0",
        "global_spec_id": "71",
        "download_price": 94.30,
        "owner_name": "二级代理商子客户test",
        "cost": 87988095.90,
        "ad_name": "搜索-唯品会-CPD-测试0603-图标-2021/06/18 16:50:24",
        "expose": 5278956,
        "click": 1116408,
        "plan_name": "",
        "extension_flow": "2",
        "app_name": "",
        "ad_group_name": "",
        "ad_id": "400037338",
        "result_expose_nums": 6570,
        "ecpm": 16667.71,
        "orderFlag": 3,
        "pos_nums": 39444,
        "extension_type": "1",
        "plan_id": "200006592",
        "bidRank": 6.00
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是 application/json

Body

名称类型必须默认值备注
beginTime
integer否起始时间 不填的话默认是当天如20201001 beginTime endTime须配合使用
endTime
integer否结束时间 不填的话默认是当天如20201001 beginTime endTime须配合使用
orderByColumns
string否数据排序字段，不传则按默认排序-数据插入顺序 建议：ftime 可以排序的字段： dt、ftime、owner_id、plan_id、ad_group_id、ad_id、app_id、global_spec_id、click、click_price、click_rate、cost、download、download_price、download_rate、ecpm、expose、extension_flow、extension_type、flow_scene、result_expose_nums
ascDesc
string否DESC正序逆序 可取值 ASC DESC两种 不可取其他值 支持大小写 建议配合orderByColumns一起使用， 如orderByColumns: "ftime",ascDesc: "DESC"
page
integer否1分页起始
pageCount
integer否10分页大小,最大500
paraMap
object否与业务相关的具体参数
adGroupIds
string []否广告组ID集合
extensionFlowList
string []否推广流量集合
否1.全流量场景，2自由流量，3联盟流量
extensionTypeList
string []否推广目标集合
否 1:链接推广 2:应用推广 3:快应用推广 7:微信小程序推广 8:直播推广
flowSceneList
string []否流量场景集合
否流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频、12联盟不限、13展示优选、14通知栏、15网络消息
planIds
string []否计划id集合
filter_zero
integer否是否过滤真实消耗等于0的数据，1：过滤； 其余不过滤
adIds
string []否广告id集合

返回数据

名称类型必须默认值备注
code
integer是状态码 0请求正常 1系统异常 11001:服务端异常 110000：参数错误 110002：用户不存在或已过期，请重新登录 110003：无效的接口查询路径 110101：查询天数不合法，具体见msg 110104：超过批量查询最大限制，默认500 其余请看msg
msg
string是返回信息
data
object否
ad_group_id
string否广告组id
ad_group_name
string否广告组名称
ad_id
string否广告id
ad_name
string否广告名称
app_id
string否应用id
app_name
string否应该名称
bidRank
integer否竞价排名（pos_nums/result_expose_nums）
click
integer否点击量
click_price
number否点击均价（单位：分）
click_rate
number否点击率，小数
cost
integer否消耗（单位：分）
download
integer否下载量
download_price
number否下载均价（单位：分）
download_rate
number否下载率
ecpm
number否ecpm
expose
integer否曝光量
extension_flow
string否推广流量：0默认值无意义，1全流量场景、2自有流量、3联盟流量
extension_type
string否推广目的[1:链接推广 2:应用推广 3:快应用推广 7:微信小程序推广 8:直播推广
flow_scene
string否流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频、12联盟不限、13展示优选、14通知栏、15网络消息
global_spec_id
string否统一规格id
orderFlag
string否排序字段 查询不传keywords ，则按orderFlag asc, {#orderByColumns}{#ascDesc}排序。其余则根据 {#orderByColumns}{#ascDesc}排序 orderFlag :排序规则，1系统拓量，2类目词包，3出价词
owner_id
string否广告主id
owner_name
string否广告主名称
plan_id
string否计划id
plan_name
string否计划名称
pos_nums
integer否结果页广告位序号总和
result_expose_nums
integer否结果页曝光量
keywords
string否关键词

6.14 代理商消耗数据总量查询

基本信息

Path： /v3/data/common/agency/total/queryOwnerCost

Method： POST

接口描述：

注：
1. 接口未传"groupByColumn时"，是根据timeLevel参数进行聚合（默认时）的，所以返回的字段除了cost字段和时间，其他字段都可能是不准确的（需要忽略）；如果传了"groupByColumn"字段的话，那么是根据这个字段进行聚合的，其他字段（除了cost）都有可能是不准确的，需要忽略。

字段说明：
subAccList int[] 子账户类型列表
extensionFlowList string[] 推广流量列表
owner_type 客户类型
sub_owner_id 子客户id 代理商可以选择其下某一个子客户的消耗
groupByColumn 聚合维度 可以按照  【子客户】，【子账户类型】 和 【流量场景】 三个维度聚合，可分别单独使用也可一起使用（组合使用时用逗号隔开即可） 使用时 放在paraMap里面格式为：  "groupByColumn": "sub_acc,extension_flow"

SDK请求接入请求方法：omniAds.adsData().v3AgencyTotalQueryOwnerCost(map)
请求参数示例：（同SDK请求参数）

{
    "page": 1,
    "pageCount": 10,
    "beginTime": "20210825",
    "endTime": "20210825",
    "timeLevel": "ALL",
    "orderByColumns": "dt",
    "ascDesc": "ASC",
    "paraMap": {
        "subAccList": [
            "1",
            "0",
            "9999"
        ],
        "owner_type": 0,
        "extensionFlowList": [
            1,
            2
        ],
        "flowSceneList": [
            7,
            8
        ],
        "groupByColumn": "owner_id,sub_acc,extension_flow"
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是

Body

名称类型必须默认值备注
endTime
integer否结束时间 不填的话默认是当天如20201001beginTime endTime须配合使用
timeLevel
string否时间聚合粒度，可填值（必须大写）：DAY（天），ALL（整体），默认按整体粒度，即对所有数据进行聚合
beginTime
integer否起始时间 不填的话默认是当天如20201001beginTime endTime须配合使用
paraMap
object否与业务相关的具体参数
groupByColumn
string否数据查询分组聚合字段，其他字段可根据返回字段名类比，不可随意传递，默认根据timeLevel参数进行聚合

可以进行分组的字段：
owner_id
注意：设置了用该字段后，返回的数据时是已经经过聚合后的数据，所以只能关注该维度字段和指标字段的值，其他维度的值是随机的。

extensionFlowList
string否推广流量列表，如["1"]. 1.全流量场景 2.自由流量场景 3.联盟流量场景
subAccList
string否账户类型列表，如["1"]，0.现金账户; 1.返货账户 2.9999.赠送账户
owner_type
string否客户类型: 0子客户, 1一级代理商, 2二级代理商, 3三级代理商
sub_owner_id
string否子客户id
flowSceneList
string []否流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频、12联盟不限、13展示优选、14通知栏、15网络消息

返回数据

名称类型必须默认值备注
code
integer否状态码 0: 请求正常 1: 系统异常 11001: 服务端异常 110000：参数错误 110002：用户不存在或已过期，请重新登录 110003：无效的接口查询路径 110101：查询天数不合法，具体见msg 110104：超过批量查询最大限制，默认500其余请看msg
msg
string否提示信息
data
integer否查询的数据总量

6.15 代理商消耗数据查询

基本信息

Path： /v3/data/common/agency/query/queryOwnerCost

Method： POST

接口描述：

注：
1. 接口未传"groupByColumn时"，是根据timeLevel参数进行聚合（默认时）的，所以返回的字段除了cost和fdate字段，其他字段如都可能是不准确的（需要忽略）；如果传了"groupByColumn"字段的话，那么是根据这个字段进行聚合的，其他字段（除了cost）都有可能是不准确的，需要忽略。
2. 如果想提高查询的响应速度，可以将参数"extra"设置为"skip_total"，使用该选项不会返回totalCount的值。如果需要该值的话，需要使用接口“6.14 代理商消耗数据总量查询”进行获取。

字段说明：
subAccList int[] 子账户类型列表
extensionFlowList string[] 推广流量列表
owner_type 客户类型
sub_owner_id 子客户id 代理商可以选择其下某一个子客户的消耗
groupByColumn 聚合维度 可以按照  【子客户】，【子账户类型】 和 【流量场景】 三个维度聚合，可分别单独使用也可一起使用（组合使用时用逗号隔开即可） 使用时 放在paraMap里面格式为：  "groupByColumn": "sub_acc,extension_flow"

SDK请求接入请求方法：omniAds.adsData().v3AgencyQueryQueryOwnerCost(map)
参数示例：（同SDK请求参数）

{
    "page": 1,
    "pageCount": 10,
    "beginTime": "20210825",
    "endTime": "20210825",
    "timeLevel": "ALL",
    "orderByColumns": "dt",
    "ascDesc": "ASC",
    "paraMap": {
        "subAccList": [
            "1",
            "0",
            "9999"
        ],
        "owner_type": 0,
        "extensionFlowList": [
            1,
            2
        ],
        "flowSceneList": [
            7,
            8
        ],
        "groupByColumn": "owner_id,sub_acc,extension_flow"
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是

Body

名称类型必须默认值备注
page
integer是分页起始
ascDesc
string否正序逆序 可取值 ASC DESC两种 不可取其他值 支持大小写
endTime
integer是结束时间 不填的话默认是当天如20201001beginTime endTime须配合使用
pageCount
integer是分页大小
timeLevel
string是时间聚合粒度，可填值（必须大写）：DAY（天），ALL（整体），默认按整体粒度，即对所有数据进行聚合
beginTime
integer是起始时间 不填的话默认是当天如20201001beginTime endTime须配合使用
orderByColumns
string否数据排序字段，不传则按默认排序-数据插入顺序建议：ftime可以排序的字段：ad_group_id、ad_id、app_id、owner_id、plan_id、quick_app_pay、quick_app_pay_priceclick、click_price、click_rate、convert_active、convert_active_price、convert_app_pay、convert_dp、convert_app_pay_price、convert_dp_price、convert_register、convert_register_price、convert_retention_price、download、download_price、download_rate、dp_app_credit_nums、dp_app_credit_nums_price、dp_app_order_nums、dp_app_order_nums_price、dp_app_pay_nums、dp_app_pay_nums_price、dp_convert_activation_nums、dp_convert_register_nums、dp_ud_convert_nums、dp_ud_convert_nums_price、ecpm、expose
paraMap
object否与业务相关的具体参数
groupByColumn
string否数据查询分组聚合字段，其他字段可根据返回字段名类比，不可随意传递，默认根据timeLevel参数进行聚合

可以进行分组的字段：
owner_id
注意：设置了用该字段后，返回的数据时是已经经过聚合后的数据，所以只能关注该维度字段和指标字段的值，其他维度的值是随机的。

extensionFlowList
string否推广流量列表，如["1"]. 1.全流量场景 2.自由流量场景 3.联盟流量场景
subAccList
string是账户类型列表，如["1"]，0.现金账户; 1.返货账户 2.9999.赠送账户
owner_type
string是客户类型: 0子客户, 1一级代理商, 2二级代理商, 3三级代理商
sub_owner_id
string是子客户id
extra
string否额外选项，可选：

  1. skip_total，传入该值时，返回的数据中不再包含totalCount数据，可以提高查询响应速度
flowSceneList
string []否流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频、12联盟不限、13展示优选、14通知栏、15网络消息

返回数据

名称类型必须默认值备注
code
integer否状态码0请求正常1系统异常11001:服务端异常110000：参数错误110002：用户不存在或已过期，请重新登录110003：无效的接口查询路径110101：查询天数不合法，具体见msg110104：超过批量查询最大限制，默认500其余请看msg
data
object否数据
totalCount
number否总条数
itemCount
number否本次请求条数
items
object []否返回数据的数组
owner_name
string是代理商名字
cost
number是消耗 单位分
agent_id
number是代理商id
owner_id
number是广告主id
sub_acc_name
string是子账户
sub_acc
number是账户类型：0-现金账户，1-返货账户，9999-赠送账户
extension_flow
string是推广流量：0默认值无意义，1全流量场景、2自有流量、3联盟流量
flow_scene
string是流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频、12联盟不限、13展示优选、14通知栏、15网络消息
company_name
string是公司主体
fdate
number是日期，格式YYYYMMDD
extension_type
string是标的物类型 1:链接推广 2:应用推广 3:快应用 7:微信小程序推广 8:直播推广
owner_type
number是客户类型:0子客户,1一级代理商,2二级代理商,3三级代理商

6.16 代理商效果数据总量查询

基本信息

Path： /v3/data/common/agency/total/queryAgencyEffect

Method： POST

接口描述：

注：
1. 接口未传"groupByColumn时"，是根据timeLevel参数进行聚合（默认时）；如果传了"groupByColumn"字段的话，那么是根据这个字段进行聚合的。

字段说明：
flowSceneList int[] 所选择 流量场景列表 枚举值：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频等
extensionFlowList int[] 所选择推广流量列表  枚举值：0默认值无意义，1全流量场景、2自有流量、3联盟流量'
extensionTypeList int[]  所选择 标的物类型列表 枚举值：1:链接推广2:应用推广 3:快应用
owner_type 客户类型:0子客户,1一级代理商,2二级代理商,3三级代理商
groupByColumn 聚合维度 可以按照  【推广流量】，【标的物类型】 和 【流量场景】 三个维度聚合，可分别单独使用也可一起使用（组合使用时用逗号隔开即可） 使用时 放在paraMap里面格式为：  "groupByColumn": "owner_id,sub_acc,extension_flow"

SDK请求接入请求方法：omniAds.adsData().v3AgencyTotalQueryAgencyEffect(map)
参数示例：（同SDK请求参数）

{
    "page": 1,
    "pageCount": 10,
    "beginTime": "20210823",
    "endTime": "20210829",
    "timeLevel": "DAY",
    "orderByColumns": "dt",
    "ascDesc": "ASC",
    "paraMap": {
        "owner_type": 0,
        "extensionTypeList": [
            2,
            1,
            3
        ],
        "flowSceneList": [
            1,
            5,
            6,
            7
        ],
        "extensionFlowList": [
            1,
            2,
            3
        ],
        "groupByColumn": "owner_id,extension_type,extension_flow,flow_scene"
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是

Body

名称类型必须默认值备注
beginTime
string是起始时间 不填的话默认是当天如20201001beginTime endTime须配合使用
endTime
string是结束时间 不填的话默认是当天如20201001beginTime endTime须配合使用
timeLevel
string是时间聚合粒度，可填值（必须大写）：DAY（天），ALL（整体），默认按整体粒度，即对所有数据进行聚合
paraMap
object否与业务相关的具体参数
owner_type
integer否客户类型:0子客户,1一级代理商,2二级代理商,3三级代理商
extensionTypeList
string否标的物类型[1:链接推广 2:应用推广 3:快应用 7:微信小程序推广 8:直播推广]
flowSceneList
string否流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频、12联盟不限、13展示优选、14通知栏、15网络消息
extensionFlowList
string否推广流量：0默认值无意义，1全流量场景、2自有流量、3联盟流量
groupByColumn
string否数据查询分组聚合字段，其他字段可根据返回字段名类比，不可随意传递，默认根据timeLevel参数进行聚合。

可以进行分组的字段：
owner_id
注意：设置了用该字段后，返回的数据时是已经经过聚合后的数据，所以只能关注该维度字段和指标字段的值，其他维度的值是随机的。

返回数据

名称类型必须默认值备注
code
integer否状态码0请求正常1系统异常11001:服务端异常110000：参数错误110002：用户不存在或已过期，请重新登录110003：无效的接口查询路径110101：查询天数不合法，具体见msg110104：超过批量查询最大限制，默认500其余请看msg
data
object否数据
totalCount
number否总条数
itemCount
number否本次请求条数
items
object []否返回数据的数组
download_price
number是下载单价
owner_name
string是代理商名字
cost
number是消耗 单位元 精确到小数点后2位
owner_id
number是广告主id
click_rate
number是点击率
expose
number是曝光数
click
number是点击数
extension_flow
string是推广流量：0默认值无意义，1全流量场景、2自有流量、3联盟流量'
flow_scene
string是流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频、12联盟不限、13展示优选、14通知栏、15网络消息
download
number是下载数
download_rate
number是下载率
ecpm
number是千次曝光收益
fdate
number是日期，格式YYYYMMDD
click_price
number是点击单价
extension_type
string是标的物类型[1:链接推广2:应用推广 3:快应用 7:微信小程序推广 8:直播推广]
owner_type
number是客户类型:0子客户,1一级代理商,2二级代理商,3三级代理商

6.17 代理商效果数据查询

基本信息

Path： /v3/data/common/agency/query/queryAgencyEffect

Method： POST

接口描述：

注：
1. 接口未传"groupByColumn时"，是根据timeLevel参数进行聚合（默认时）的，所以返回的字段除了cost、click、expose、download和agent_id等相关的字段，其他字段如都可能是不准确的（需要忽略）；如果传了"groupByColumn"字段的话，那么是根据这个字段进行聚合的，其他字段（除了cost）都有可能是不准确的，需要忽略。
2. 如果想提高查询的响应速度，可以将参数"extra"设置为"skip_total"，使用该选项不会返回totalCount的值。如果需要该值的话，需要使用接口“6.16 代理商效果数据总量查询”进行获取。

字段说明：
flowSceneList int[] 所选择 流量场景列表 枚举值：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频等
extensionFlowList int[] 所选择推广流量列表  枚举值：0默认值无意义，1全流量场景、2自有流量、3联盟流量'
extensionTypeList int[]  所选择 标的物类型列表 枚举值：1:链接推广2:应用推广 3:快应用
owner_type 客户类型:0子客户,1一级代理商,2二级代理商,3三级代理商
groupByColumn 聚合维度 可以按照  【推广流量】，【标的物类型】 和 【流量场景】 三个维度聚合，可分别单独使用也可一起使用（组合使用时用逗号隔开即可） 使用时 放在paraMap里面格式为：  "groupByColumn": "owner_id,sub_acc,extension_flow"

SDK请求接入请求方法：omniAds.adsData().v3AgencyQueryQueryAgencyEffect(map)
参数示例：（同SDK请求参数）

{
    "page": 1,
    "pageCount": 10,
    "beginTime": "20210823",
    "endTime": "20210829",
    "timeLevel": "DAY",
    "orderByColumns": "dt",
    "ascDesc": "ASC",
    "paraMap": {
        "owner_type": 0,
        "extensionTypeList": [
            2,
            1,
            3
        ],
        "flowSceneList": [
            1,
            5,
            6,
            7
        ],
        "extensionFlowList": [
            1,
            2,
            3
        ],
        "groupByColumn": "owner_id,extension_type,extension_flow,flow_scene"
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是

Body

名称类型必须默认值备注
page
integer是分页起始
pageCount
integer是分页大小
beginTime
string是起始时间 不填的话默认是当天如20201001beginTime endTime须配合使用
endTime
string是结束时间 不填的话默认是当天如20201001beginTime endTime须配合使用
timeLevel
string是时间聚合粒度，可填值（必须大写）：DAY（天），ALL（整体），默认按整体粒度，即对所有数据进行聚合
orderByColumns
string否数据排序字段，不传则按默认排序
ascDesc
string否正序逆序 可取值 ASC DESC两种 不可取其他值 支持大小写
paraMap
object否与业务相关的具体参数
owner_type
integer否客户类型:0子客户,1一级代理商,2二级代理商,3三级代理商
extensionTypeList
string否标的物类型[1:链接推广 2:应用推广 3:快应用 7:微信小程序推广 8:直播推广]
flowSceneList
string否流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频、12联盟不限、13展示优选、14通知栏、15网络消息
extensionFlowList
string否推广流量：0默认值无意义，1全流量场景、2自有流量、3联盟流量
groupByColumn
string否数据查询分组聚合字段，其他字段可根据返回字段名类比，不可随意传递，默认根据timeLevel参数进行聚合。

可以进行分组的字段：
owner_id
注意：设置了用该字段后，返回的数据时是已经经过聚合后的数据，所以只能关注该维度字段和指标字段的值，其他维度的值是随机的。

extra
string否额外选项，可选： 1. skip_total，传入该值时，返回的数据中不再包含totalCount数据，可以提高查询响应速度

返回数据

名称类型必须默认值备注
code
integer否状态码0请求正常1系统异常11001:服务端异常110000：参数错误110002：用户不存在或已过期，请重新登录110003：无效的接口查询路径110101：查询天数不合法，具体见msg110104：超过批量查询最大限制，默认500其余请看msg
data
object否数据
totalCount
number否总条数
itemCount
number否本次请求条数
items
object []否返回数据的数组
download_price
number是下载单价，单位分
owner_name
string是代理商名字
cost
number是消耗 单位分
owner_id
number是广告主id
click_rate
number是点击率
expose
number是曝光数
click
number是点击数
extension_flow
string是推广流量：0默认值无意义，1全流量场景、2自有流量、3联盟流量'
flow_scene
string是流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频、12联盟不限、13展示优选、14通知栏、15网络消息
download
number是下载数
download_rate
number是下载率
ecpm
number是千次曝光收益
fdate
number是日期，格式YYYYMMDD
click_price
number是点击单价，单位分
extension_type
string是标的物类型[1:链接推广2:应用推广 3:快应用 7:微信小程序推广 8:直播推广]
owner_type
number是客户类型:0子客户,1一级代理商,2二级代理商,3三级代理商
quick_app_act_rate
number是快应用关键行为转化率

6.18 小游戏明细数据查询-代理商

基本信息

Path： /v3/data/common/agency/query/queryAgentQuickGame

Method： POST

接口描述：

groupByColumn用法：
1.场景：根据app_id聚合
   解决办法：groupByColumn:app_id

SDK请求接入请求方法：omniAds.adsData().v3AgencyQueryQueryAgentQuickGame(map)
请求参数示例：（同SDK请求参数）

{
  "beginTime": 20210620,
  "endTime": 20210621,
  "orderByColumns": "dt",
  "ascDesc": "DESC",
  "timeLevel": "DAY",
  "page": 1,
  "pageCount": 10,
  "paraMap": {
    "appIdList": [
      1
      2,
      3,
     4
    ],
    "app_id": "4132",
    "app_name": "consequ",
    "flowSceneList": [
      "1","2"
    ],
    "exposeFloor": -67280287,
    "exposeCeiling": 41164553,
    "clickFloor": -89015186,
    "clickCeiling": -95405039,
    "ecpmFloor": -74395941,
    "ecpmCeiling": 24198488,
    "groupByColumn": "dt"
  }
}

返回参数示例：

{
    "code": 0,
    "data": {
        "totalCount": 5,
        "itemCount": 5,
        "items": [
            {
                "buy_user_income3": 0.0,
                "owner_id": "1000043688",
                "click_rate": 0.0,
                "flow_scene": 8,
                "new_user_buy_ltv30": 0.0,
                "active_nums": 0.0,
                "fdate": 20211121,
                "new_user_buy_ltv7": 0.0,
                "id": 35864053,
                "click_price": 0.0,
                "new_user_buy_ltv1": 0.0,
                "app_id": "0",
                "new_user_buy_ltv3": 0.0,
                "buy_user_income7": 0.0,
                "new_user_buy_roi30": 0.0,
                "global_spec_id": "34",
                "owner_name": "±±¾©ؖ͸θç¼¼˵ԐО¹«˾",
                "new_user_buy_roi1": 0.0,
                "new_user_buy_roi3": 0.0,
                "expose_nums": 0.0,
                "new_pay_user_nums": 0.0,
                "new_user_buy_roi7": 0.0,
                "click_nums": 0.0,
                "active_rate": 0.0,
                "extension_flow": 3,
                "app_name": "",
                "ecpm": 0.0,
                "extension_type": 1,
                "buy_user_income": 0.0,
                "buy_user_income30": 0.0,
                "acc_cost": 0.0
            },
            {
                "buy_user_income3": 0.0,
                "owner_id": "1000113826",
                "click_rate": 0.0,
                "flow_scene": 6,
                "new_user_buy_ltv30": 0.0,
                "active_nums": 0.0,
                "fdate": 20211121,
                "new_user_buy_ltv7": 0.0,
                "id": 35864054,
                "click_price": 0.0,
                "new_user_buy_ltv1": 0.0,
                "app_id": "0",
                "new_user_buy_ltv3": 0.0,
                "buy_user_income7": 0.0,
                "new_user_buy_roi30": 0.0,
                "global_spec_id": "1",
                "owner_name": "SMBSH-°ڊ˃󿾭XXL",
                "new_user_buy_roi1": 0.0,
                "new_user_buy_roi3": 0.0,
                "expose_nums": 0.0,
                "new_pay_user_nums": 0.0,
                "new_user_buy_roi7": 0.0,
                "click_nums": 0.0,
                "active_rate": 0.0,
                "extension_flow": 2,
                "app_name": "",
                "ecpm": 0.0,
                "extension_type": 1,
                "buy_user_income": 0.0,
                "buy_user_income30": 0.0,
                "acc_cost": 0.0
            }
        ]
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是 application/json

Body

名称类型必须默认值备注
beginTime
integer否起始时间 不填的话默认是当天如20201001, 小游戏目前不支持实时数据，故需要填写起始时间小于当天时间 beginTime endTime须配合使用
endTime
integer否结束时间 不填的话默认是当天如20201001 小游戏目前不支持实时数据，故需要填写结束时间小于当天时间 beginTime填写，endTime必填 beginTime endTime须配合使用
orderByColumns
string否数据排序字段，不传则按默认排序-数据插入顺序建议：dt；支持的orderByColumns字段有： ad_id,group_id,plan_id,app_id,owner_id,agency_id,acc_cost,ecpm,expose_nums,click_nums,click_rate,click_price,active_nums,active_rate,active_cost, new_user_buy_ltv1,new_user_buy_ltv3,new_user_buy_ltv7,new_user_buy_ltv30,new_user_buy_roi1,new_user_buy_roi3,new_user_buy_roi7,new_user_buy_roi30, buy_user_income0,new_pay_user_nums,pay_transfer_rate,pay_cost,inter_buy_ltv1,inter_buy_ltv3,inter_buy_ltv7,inter_buy_ltv30,inter_buy_roi1,inter_buy_roi3, inter_buy_roi7,inter_buy_roi30,inter_buy_pay,buy_user_income,buy_user_income3,buy_user_income7,buy_user_income30,ltv1_pay,ltv3_pay,ltv7_pay,ltv30_pay, extension_flow,flow_scene,extension_type,global_spec_id,ad_flag
ascDesc
string否DESC正序逆序 可取值 ASC DESC两种 不可取其他值 支持大小写 建议配合orderByColumns一起使用， 如orderByColumns: "dt",ascDesc: "DESC"
timeLevel
string否DAY时间聚合粒度，可填值（必须大写）：DAY（天），默认按天粒度
page
integer否1分页起始
pageCount
integer否10分页大小，最大500
paraMap
object否与业务相关的具体参数
appIdList
string []否应用集合，如果要查各个应用明细数据，则orderByColumns需要添加app_id
app_id
string否应用id
app_name
string否支持模糊查询应用名称
flowSceneList
string []否流量场景集合
否流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频、12联盟不限、13展示优选、14通知栏、15网络消息
exposeFloor
integer否曝光大于exposeFloor
exposeCeiling
integer否曝光小于exposeCeiling
clickFloor
integer否点击大于clickFloor
clickCeiling
integer否点击小于clickCeiling
ecpmFloor
integer否ecpm大于ecpmFloor
ecpmCeiling
integer否ecpm小于ecpmCeiling
extra
string否额外选项，可选： 1. skip_total，传入该值时，返回的数据中不再包含totalCount数据，可以提高查询响应速度
groupByColumn
string否进行分组聚合的字段，用逗号分隔 可选：dt

返回数据

名称类型必须默认值备注
code
integer是状态码 0请求正常 1系统异常 11001:服务端异常 110000：参数错误 110002：用户不存在或已过期，请重新登录 110003：无效的接口查询路径 110101：查询天数不合法，具体见msg 110104：超过批量查询最大限制，默认500 其余请看msg
msg
string是具体信息
data
object是
totalCount
integer否符合查询总数
itemCount
integer否分页查询数量
items
object []否
fdate
string否数据日期，如20210614
app_id
string否应用id
app_name
string否应用名称
owner_id
string否广告主Id
owner_name
string否广告主名称
extension_type
integer否推广目标 1链接推广，2应用推广，3快应用，7微信小程序推广，8直播推广
global_spec_id
string否统一规格id
extension_flow
integer否推广流量：0默认值无意义，1全流量场景、2自有流量、3联盟流量
flow_scene
integer否流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频、12联盟不限、13展示优选、14通知栏、15网络消息
expose_nums
integer否曝光数
click_nums
integer否点击数
click_rate
number否点击率,小数
active_nums
integer否90天首次活跃的新增用户
active_rate
number否激活率,小数
new_user_buy_roi1
integer否广告变现ROI1（单位：元）
new_user_buy_roi3
integer否广告变现ROI3（单位：元）
new_user_buy_roi7
integer否广告变现ROI7（单位：元）
new_user_buy_roi30
number否广告变现ROI30（单位：元）
buy_user_income0
number否首日广告收入
new_pay_user_nums
number否新增付费用户数
acc_cost
number否实扣金额（单位：分）
ecpm
number否小数
click_price
number否点击均价（单位：分）
active_cost
number否新增用户成本（单位：分）
new_user_buy_ltv1
number否广告变现LTV1（单位：分）
new_user_buy_ltv3
number否广告变现LTV3（单位：分）
new_user_buy_ltv7
number否广告变现LTV7（单位：分）
new_user_buy_ltv30
number否广告变现LTV30，小数
buy_user_income_his
number否广告历史变现收入
new_user_buy_roi_his
number否广告变现ROI累积
ltv1_pay
number否首日付费流水
total_pay
number否总付费流水
pay_cost
number否付费成本
pay_transfer_rate
number否付费转化率
inter_buy_roi1
number否游戏付费ROI1
inter_buy_roi30
number否游戏付费ROI30
inter_buy_roi7
number否游戏付费ROI7
inter_buy_roi3
number否游戏付费ROI3
inter_buy_ltv1
number否游戏付费LTV1
inter_buy_ltv30
number否游戏付费LTV30
inter_buy_ltv7
number否游戏付费LTV7
inter_buy_ltv3
number否游戏付费LTV3
new_req_nums
number否新增用户(180天首次活跃)
new_req_retent2_nums
number否次日留存数
new_req_retent3_nums
number否3日留存数
new_req_retent7_nums
number否7日留存数
new_req_retent14_nums
number否14日留存数
new_req_retent30_nums
number否30日留存数
new_req_retent2_rate
number否次日留存率
new_req_retent3_rate
number否3日留存率
new_req_retent7_rate
number否7日留存率
new_req_retent14_rate
number否14日留存率
new_req_retent30_rate
number否30日留存率
buy_income_active_roi
number否活跃ROI
buy_user_income_active_roi
number否活跃ROI（应分成）

6.19子客户消耗数据查询

基本信息

Path： /v3/data/common/omniapi/query/queryOwnerCost

Method： POST

接口描述：

SDK请求接入请求方法：omniAds.adsData().v3OmniapiQueryQueryOwnerCost(map)
参数示例：（同SDK请求参数）

{
    "page": 1,
    "pageCount": 10,
    "beginTime": "20210825",
    "endTime": "20210825",
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是

Body

名称类型必须默认值备注
page
integer是分页起始
endTime
integer是结束时间 不填的话默认是当天如20201001beginTime endTime须配合使用
pageCount
integer是分页大小
beginTime
integer是起始时间 不填的话默认是当天如20201001beginTime endTime须配合使用

返回数据

名称类型必须默认值备注
code
integer否状态码0请求正常1系统异常11001:服务端异常110000：参数错误110002：用户不存在或已过期，请重新登录110003：无效的接口查询路径110101：查询天数不合法，具体见msg110104：超过批量查询最大限制，默认500其余请看msg
data
object否数据
totalCount
number否总条数
itemCount
number否本次请求条数
items
object []否返回数据的数组
owner_name
string是代理商名字
cost
number是消耗 单位分
owner_id
number是广告主id
sub_acc_name
string是子账户
sub_acc
number是账户类型：0-现金账户，1-返货账户，9999-赠送账户
flow_scene
string是流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频、12联盟不限、13展示优选、14通知栏、15网络消息
fdate
number是日期，格式yyyyMMdd，如20211119

6.20 广告明细实时数据查询-子客户

基本信息

Path： /v3/data/common/query/queryAdRTExtData

Method： POST

接口描述：

注：
1. 该接口是保留的实时数据，建议只当前一天的离线数据没有出来时使用。因为数据表里的粒度是十几分钟，数据量很大，而且只保留了最近2-3天，查询时不要将时间范围设得太大，尽量只查前一天的数据。
2. 默认分组字段为ftime，如果groupByColumn不为空，最后组装的sql == group by ftime,{groupByColumn}
3. groupByColumn支持的字段名格式可以查看接口返回字段名示例，注意：设置了用该字段后，返回的数据时是已经经过聚合后的数据，所以只能关注该维度字段和指标字段的值，其他维度的值是随机的，所以出现该情况时请忽略。当timeLevel参数是“ALL”时，groupByColumn字段的值是owner_id，未设置时是ftime。
4. 如果想提高查询的响应速度，可以将参数"extra"设置为"skip_total"，使用该选项不会返回totalCount实际的值（返回-1~~~~）。如果需要该值的话，需要使用接口“6.2 广告明细数据总量查询-子客户”进行获取。

groupByColumn用法：
1.场景：需要查询多个广告创意的数据
   解决办法：groupByColumn:ad_id
2.场景：需要查询广告计划*创意分组的数据
   解决办法：groupByColumn:ad_group_id,ad_id

SDK接入请求方法：omniAds.adsData().v3QueryQueryAdData(map)

请求参数示例：（同SDK请求参数）

{
    "page": 1,
    "ascDesc": "ASC",
    "endTime": 20210531,
    "pageCount": 10,
    "timeLevel": "DAY",
    "beginTime": 20210401,
    "orderByColumns": "ftime",
    "paraMap": {
        "filter_zero": 0,
        "groupByColumn": "ad_id"
    }
}

返回参数示例：

{
    "code": 0,
    "data": {
        "totalCount": 3,
        "itemCount": 3,
        "items": [
            {
                "owner_id": "1100050065",
                "click_rate": 0,
                "dp_app_credit_price": 0,
                "dp_app_order_price": 0,
                "download": 0,
                "dp_convert_register_price": 0,
                "convert_app_pay": 0,
                "dp_ud_convert_nums": 0,
                "click_price": 0,
                "ad_group_id": "0",
                "convert_register": 0,
                "app_id": "0",
                "dp_ud_convert_price": 0,
                "convert_app_order": 0,
                "dp_app_credit_nums": 0,
                "global_spec_id": "0",
                "owner_name": "0",
                "convert_app_credit_price": 0,
                "click": 0,
                "plan_name": "0",
                "form_cnt": 0,
                "quick_app_pay": 0,
                "ad_group_name": "0",
                "ad_id": "0",
                "ecpm": 0,
                "quick_app_pay_price": 0,
                "form_price": 0,
                "convert_app_custom": 0,
                "dp_convert_register_nums": 0,
                "convert_retention_price": 0,
                "convert_app_order_price": 0,
                "convert_dp": 0,
                "flow_scene": "0",
                "download_rate": 0,
                "convert_register_price": 0,
                "convert_active_price": 0,
                "convert_app_credit": 0,
                "dp_convert_activation_price": 0,
                "convert_app_custom_price": 0,
                "ftime": 20210526,
                "dp_convert_activation_nums": 0,
                "convert_dp_price": 0,
                "download_price": 0,
                "cost": 0.00,
                "dp_app_pay_price": 0,
                "ad_name": "0",
                "expose": 0,
                "extension_flow": "0",
                "convert_retention": 0,
                "convert_app_pay_price": 0,
                "app_name": "0",
                "dp_app_order_nums": 0,
                "extension_type": "0",
                "convert_active": 0,
                "plan_id": "0",
                "dp_app_pay_nums": 0
            },
            {
                "owner_id": "1100050065",
                "click_rate": 0,
                "dp_app_credit_price": 0,
                "dp_app_order_price": 0,
                "download": 0,
                "dp_convert_register_price": 0,
                "convert_app_pay": 0,
                "dp_ud_convert_nums": 0,
                "click_price": 0,
                "ad_group_id": "0",
                "convert_register": 0,
                "app_id": "0",
                "dp_ud_convert_price": 0,
                "convert_app_order": 0,
                "dp_app_credit_nums": 0,
                "global_spec_id": "0",
                "owner_name": "0",
                "convert_app_credit_price": 0,
                "click": 0,
                "plan_name": "0",
                "form_cnt": 0,
                "quick_app_pay": 0,
                "ad_group_name": "0",
                "ad_id": "0",
                "ecpm": 0,
                "quick_app_pay_price": 0,
                "form_price": 0,
                "convert_app_custom": 0,
                "dp_convert_register_nums": 0,
                "convert_retention_price": 0,
                "convert_app_order_price": 0,
                "convert_dp": 0,
                "flow_scene": "0",
                "download_rate": 0,
                "convert_register_price": 0,
                "convert_active_price": 0,
                "convert_app_credit": 0,
                "dp_convert_activation_price": 0,
                "convert_app_custom_price": 0,
                "ftime": 20210527,
                "dp_convert_activation_nums": 0,
                "convert_dp_price": 0,
                "download_price": 0,
                "cost": 0.00,
                "dp_app_pay_price": 0,
                "ad_name": "0",
                "expose": 0,
                "extension_flow": "0",
                "convert_retention": 0,
                "convert_app_pay_price": 0,
                "app_name": "0",
                "dp_app_order_nums": 0,
                "extension_type": "0",
                "convert_active": 0,
                "plan_id": "0",
                "dp_app_pay_nums": 0
            },
            {
                "owner_id": "1100050065",
                "click_rate": 0,
                "dp_app_credit_price": 0,
                "dp_app_order_price": 0,
                "download": 0,
                "dp_convert_register_price": 0,
                "convert_app_pay": 0,
                "dp_ud_convert_nums": 0,
                "click_price": 0,
                "ad_group_id": "0",
                "convert_register": 0,
                "app_id": "0",
                "dp_ud_convert_price": 0,
                "convert_app_order": 0,
                "dp_app_credit_nums": 0,
                "global_spec_id": "0",
                "owner_name": "0",
                "convert_app_credit_price": 0,
                "click": 0,
                "plan_name": "0",
                "form_cnt": 0,
                "quick_app_pay": 0,
                "ad_group_name": "0",
                "ad_id": "0",
                "ecpm": 0,
                "quick_app_pay_price": 0,
                "form_price": 0,
                "convert_app_custom": 0,
                "dp_convert_register_nums": 0,
                "convert_retention_price": 0,
                "convert_app_order_price": 0,
                "convert_dp": 0,
                "flow_scene": "0",
                "download_rate": 0,
                "convert_register_price": 0,
                "convert_active_price": 0,
                "convert_app_credit": 0,
                "dp_convert_activation_price": 0,
                "convert_app_custom_price": 0,
                "ftime": 20210528,
                "dp_convert_activation_nums": 0,
                "convert_dp_price": 0,
                "download_price": 0,
                "cost": 0.00,
                "dp_app_pay_price": 0,
                "ad_name": "0",
                "expose": 0,
                "extension_flow": "0",
                "convert_retention": 0,
                "convert_app_pay_price": 0,
                "app_name": "0",
                "dp_app_order_nums": 0,
                "extension_type": "0",
                "convert_active": 0,
                "plan_id": "0",
                "dp_app_pay_nums": 0
            }
        ]
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是 application/json

Body

名称类型必须默认值备注
beginTime
integer否起始时间 不填的话默认是当天如20201001 beginTime endTime须配合使用
endTime
integer否结束时间 不填的话默认是当天如20201001 beginTime endTime须配合使用
ascDesc
string否DESC正序逆序 可取值 ASC DESC两种 不可取其他值 支持大小写 建议配合orderByColumns一起使用， 如orderByColumns: "ftime",ascDesc: "DESC"
timeLevel
string否DAY时间聚合粒度，可填值（必须大写）：HOUR（小时），DAY（天），默认按天粒度
page
integer否1分页起始
pageCount
integer否10分页大小
paraMap
object否与业务相关的具体参数
adGroupIds
string []否广告组ID集合
extensionFlowList
string []否推广流量集合
否1.全流量场景，2自由流量，3联盟流量
extensionTypeList
string []否推广目标集合
否 1:链接推广 2:应用推广 3:快应用推广 7:微信小程序推广 8:直播推广
flowSceneList
string []否流量场景集合
否流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频、12联盟不限、13展示优选、14通知栏、15网络消息
planIds
string []否计划id集合
filter_zero
integer否是否过滤真实消耗等于0的数据，1：过滤； 其余不过滤
adIds
string []否广告id集合
groupByColumn
string否查询分组字段 其他字段可根据返回字段名类比，如：ad_group_id 请看备注示例 支持分组的字段： ad_group_id、ad_id、app_id、owner_id、plan_id 注意：设置了用该字段后，返回的数据时是已经经过聚合后的数据，所以只能关注该维度字段和指标字段的值，其他维度的值是随机的。
costFloor
integer否消耗金额大于
costCeiling
integer否消耗金额小于
exposeFloor
integer否曝光量大于
exposeCeiling
integer否曝光量小于
clickFloor
integer否点击量大于
clickCeiling
integer否点击量小于
downloadFloor
integer否下载量大于
downloadCeiling
integer否下载量小于
ecpmFloor
integer否ecpm大于
ecpmCeiling
integer否ecpm小于
extra
string否额外选项，可选： 1. skip_total，传入该值时，返回的数据中不再包含totalCount数据，可以提高查询响应速度

返回数据

名称类型必须默认值备注
code
integer是状态码 0请求正常 1系统异常 11001:服务端异常 110000：参数错误 110002：用户不存在或已过期，请重新登录 110003：无效的接口查询路径 110101：查询天数不合法，具体见msg 110104：超过批量查询最大限制，默认500 其余请看msg
msg
string是具体信息
data
object是
totalCount
integer否符合查询总数
itemCount
integer否分页查询数量
items
object []否
ad_group_id
string否广告组id
ad_group_name
string否广告组名称
ad_id
string否广告id
ad_name
string否广告名称
app_id
string否应用id
app_name
string否应用名称
click
integer否点击量
click_price
integer否点击均价（单位：分）
click_rate
integer否点击率，小数，单位%
convert_active
integer否回传激活量
convert_active_price
integer否回传激活均价（单位：分）
convert_app_credit
integer否应用内授信
convert_app_credit_price
integer否应用内授信均价（单位：分）
convert_app_custom
integer否自定义转化
convert_app_custom_price
integer否自定义转化均价（单位：分）
convert_app_order
integer否应用内下单
convert_app_order_price
integer否应用内下单均价（单位：分）
convert_app_pay
integer否应用内付费
convert_app_pay_price
integer否应用内付费均价（单位：分）
convert_dp
integer否dp回传拉活量
convert_dp_price
integer否dp回传拉活均价（单位：分）
convert_register
integer否回传注册量
convert_register_price
integer否回传注册均价（单位：分）
convert_retention
integer否回传留存量
convert_retention_price
integer否回传留存均价（单位：分）
cost
integer否消耗实扣（单位：分）
download
integer否下载量
download_price
integer否下载均价（单位：分）
download_rate
integer否下载率，小数，单位%
dp_app_order_nums
integer否dp应用内下单量
dp_app_order_price
integer否dp应用内下单均价（单位：分）
dp_convert_activation_nums
integer否dp回传激活量
dp_convert_activation_price
integer否dp回传激活均价（单位：分）
dp_convert_register_nums
integer否dp回传注册量
dp_convert_register_price
string否dp回传注册均价（单位：分）
dp_ud_convert_nums
integer否dp自定义转化量
dp_ud_convert_price
integer否dp自定义转化均价单位：分）
ecpm
integer否
expose
integer否曝光量
extension_flow
string否推广流量：0默认值无意义，1全流量场景、2自有流量、3联盟流量
extension_type
string否推广目标 1链接推广，2应用推广，3快应用，7微信小程序推广，8直播推广
flow_scene
string否流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频、12联盟不限、13展示优选、14通知栏、15网络消息
form_cnt
integer否表单量
form_price
integer否表单均价（单位：分）
global_spec_id
string否统一规格id
owner_id
string否广告主id
owner_name
string否广告主名称
plan_id
string否计划id
plan_name
string否计划名称
quick_app_pay
integer否快应用付费量
quick_app_pay_price
integer否快应用付费成本（单位：分）
convert_retention_rate
number否回传次留率，单位%
quick_app_act_num
number否快应用关键行为量
quick_app_act_cost
number否快应用关键行为成本
form_price_rate
number否表单转化率，单位%
form_key_act_nums
number否表单关键行为量
form_key_act_price
number否表单关键行为成本（单位：分）
effect_consult_nums
number否有效咨询量
effect_consult_price
number否有效咨询量
wechat_focus_nums
number否微信关注量
wechat_focus_price
number否微信关注成本
web_page_buy_nums
number否网页购买量
web_page_buy_price
number否网页购买成本
call_up_nums
number否拨打电话量
call_up_price
number否拨打电话成本
qapp_quick_lnk_nums
number否快应用加桌量
qapp_quick_lnk_price
number否快应用加桌成本
dp_convert_retention_nums
number否deeplink回传留存量
dp_convert_retention_price
number否deeplink回传留存成本

6.21 代理商余额查询接口

基本信息

Path： /v3/data/common/agency/query/queryMktAggData

Method： POST

接口描述：

请求参数示例：

{
    "paraMap": {
        "queryOwnerType": 0
    }
}

返回参数示例：

{
    "code": 0,
    "data": {
        "totalCount": 1,
        "itemCount": 1,
        "items": [
            {
                "cash_bal": 497215724154134,
                "rebate_bal": 839251489,
                "today_cash_cost": 36000,
                "today_rebate_cost": 3097,
                "today_total_cost": 39097,
                "today_vir_cost": 0,
                "total_bal": 497216564182979,
                "vir_bal": 777356,
                "yesterday_cost": 0
            }
        ]
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是

Body

名称类型必须默认值备注
paraMap
object是与业务相关的具体参数
queryOwnerType
integer是广告主查询类型，必传queryOwnerType=0

返回数据

名称类型必须默认值备注
code
integer是状态码0请求正常1系统异常11001:服务端异常110000：参数错误110002：用户不存在或已过期，请重新登录110003：无效的接口查询路径110101：查询天数不合法，具体见msg110104：超过批量查询最大限制，默认500其余请看msg
msg
string是具体信息
data
object是
totalCount
integer否符合查询总数
itemCount
integer否分页查询数量
items
object []否
cash_bal
integer是现金余额(分)
rebate_bal
integer是返货账户余额(分)
vir_bal
integer是虚拟账户金额(分)
today_cash_cost
integer是现金账户消耗(分)
today_rebate_cost
integer是返货账户消耗(分)
today_vir_cost
integer是虚拟账号消耗(分)
today_total_cost
integer是总消耗(分)
total_bal
integer是总余额值: vir_bal[赠送余额] + rebate_bal[返货余额] + cash_bal[现金余额]
yesterday_cost
integer是昨日消耗

6.22 查询Rta动态出价数据

基本信息

Path： /v3/data/common/omniapi/query/queryRtaData

Method： POST

接口描述：

请求参数示例：
{
 "paraMap": {
   "dt":"2023-11-06"
  }
}

返回参数示例：
{
   "code":0,
   "data": {
       "totalCount":5,
       "itemCount":5,
       "items": [
            {
               "dt":1699200000000,
               "acc_nums":1764,
               "expose_nums":15395,
               "click_nums":2172,
               "rta_dyna_price_fac":"5.1956483",
               "ad_owner_id":"1000120118",
               "acc_cost":664
            },
            {
               "dt":1699200000000,
               "acc_nums":98,
               "expose_nums":28093,
               "click_nums":436,
               "rta_dyna_price_fac":"8.6232482",
               "ad_owner_id":"1000120118",
               "acc_cost":674
            },
            {
               "dt":1699200000000,
               "acc_nums":893,
               "expose_nums":27235,
               "click_nums":2065,
               "rta_dyna_price_fac":"4.9650024",
               "ad_owner_id":"1000120118",
               "acc_cost":440
            },
            {
               "dt":1699200000000,
               "acc_nums":1095,
               "expose_nums":39825,
               "click_nums":1498,
               "rta_dyna_price_fac":"5.2260307",
               "ad_owner_id":"1000120118",
               "acc_cost":234
            },
            {
               "dt":1699200000000,
               "acc_nums":2179,
               "expose_nums":6538,
               "click_nums":742,
               "rta_dyna_price_fac":"6.596112",
               "ad_owner_id":"1000120118",
               "acc_cost":543
            }
        ]
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是

Body

名称类型必须默认值备注
paraMap
object否与业务相关的具体参数
dt
string否日期
page
integer是分页起始
pageCount
integer是分页大小

返回数据

名称类型必须默认值备注
code
number否状态码0请求正常1系统异常11001:服务端异常110000：参数错误110002：用户不存在或已过期，请重新登录110003：无效的接口查询路径110101：查询天数不合法 110104：超过批量查询最大限制，默认500
data
object否
totalCount
number否符合查询总数
itemCount
number否分页查询数量
items
object []否结果
dt
number是日期
acc_nums
number是实扣点击/下载量
expose_nums
number是曝光量
click_nums
number是点击量
rta_dyna_price_fac
string是动态出价因子
ad_owner_id
string是广告主id
acc_cost
number是实扣金额

6.23 增值付费消息报表数据查询

基本信息

Path： /v3/data/common/query/queryBizPushData

Method： POST

接口描述：

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是

Body

名称类型必须默认值备注
beginTime
integer否起始时间 不填的话默认是当天如20201001beginTime endTime须配合使用
endTime
integer否结束时间 不填的话默认是当天如20201001beginTime endTime须配合使用
timeLevel
string否时间粒度 聚合粒度 有HOUR DAY WEEK MONTH ALL五个粒度具体支持到那个粒度和具体业务相关 取值如前 必须大写
page
string否分页起始
pageCount
string否分页大小
orderByColumns
string否数据排序字段
ascDesc
string否正序逆序 可取值 ASC DESC两种 不可取其他值 支持大小写 建议配合orderByColumns一起使用， 如orderByColumns: "dt",ascDesc: "DESC"
paraMap
object否与业务相关的具体参数
app_name
string否应用名称，模糊搜索
app_id
string否应用ID
package_name
string否应用包名
push_way
string否推送方式：API,WEB
style
string否样式：1:标准样式，2:长文本，3:大图
create_platform
string否创建平台：1=API，2=Opush推送运营平台，3=ADMIN平台，4=用户增长平台，5=营销云，6=API商业化，7=控制台商业化
is_unfold
string否是否免折叠：0=否，1=是
is_bgpicture_url
string否是否有背景图：0=否，1=是
is_top_push
string否是否置顶：0=否，1=是
is_buttons
string否是否有按钮：0=否，1=是
is_label
string否是否有标签：0=否，1=是
subAccList
string []否子账户列表 0=现金，1:=返还，9999=虚拟
groupByColumn
string否分组字段逗号分隔

返回数据

名称类型必须默认值备注
code
string否状态码0请求正常1系统异常11001:服务端异常110000：参数错误110002：用户不存在或已过期，请重新登录110003：无效的接口查询路径110101：查询天数不合法，具体见msg110104：超过批量查询最大限制，默认500其余请看msg
msg
string否具体信息
data
object否
totalCount
number是符合查询总数
itemCount
number是分页查询数量
items
object []是结果
is_unfold
string否是否免折叠：0=否，1=是
is_top_push
string否是否置顶：0=否，1=是
owner_id
string否广告主ID
push_way
string否推送方式：API,WEB
create_platform
string否创建平台：1=API，2=Opush推送运营平台，3=ADMIN平台，4=用户增长平台，5=营销云，6=API商业化，7=控制台商业化
is_bgpicture_url
string否是否有背景图：0=否，1=是
app_name
string否应用名称
acc_nums
integer否实扣点击
package_name
string否应用包名
evt_cost
integer否应扣金额（分）
style
string否样式：1:标准样式，2:长文本，3:大图
id
string否主键id
is_label
string否是否有标签：0=否，1=是
app_id
string否应用ID
acc_id
string否账户ID
evt_nums
integer否应扣点击
acc_cost
integer否实扣金额（分）
dt
string否时间
is_buttons
string否是否有按钮：0=否，1=是
sub_acc
string否子账户 0=现金，1:=返还，9999=虚拟

6.24 增值付费消息报表汇总数据查询

基本信息

Path： /v3/data/common/summary/queryBizPushData

Method： POST

接口描述：

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是

Body

名称类型必须默认值备注
beginTime
integer否起始时间 不填的话默认是当天如20201001beginTime endTime须配合使用
endTime
integer否结束时间 不填的话默认是当天如20201001beginTime endTime须配合使用
paraMap
object否与业务相关的具体参数
app_name
string否应用名称，模糊搜索
app_id
string否应用ID
package_name
string否应用包名
push_way
string否推送方式：API,WEB
style
string否样式：1:标准样式，2:长文本，3:大图
create_platform
string否创建平台：1=API，2=Opush推送运营平台，3=ADMIN平台，4=用户增长平台，5=营销云，6=API商业化，7=控制台商业化
is_unfold
string否是否免折叠：0=否，1=是
is_bgpicture_url
string否是否有背景图：0=否，1=是
is_top_push
string否是否置顶：0=否，1=是
is_buttons
string否是否有按钮：0=否，1=是
subAccList
string []否子账户 0=现金，1:=返还，9999=虚拟
is_label
string否是否有标签：0=否，1=是

返回数据

名称类型必须默认值备注
code
string否状态码0请求正常1系统异常11001:服务端异常110000：参数错误110002：用户不存在或已过期，请重新登录110003：无效的接口查询路径110101：查询天数不合法，具体见msg110104：超过批量查询最大限制，默认500其余请看msg
msg
string否具体信息
data
object否
evt_nums
string否应扣点击
evt_cost
string否应扣金额（分）
average_evt_cost
string否应扣均价（分）
acc_nums
string否实扣点击
acc_cost
string否实扣金额（分）
average_acc_cost
string否实扣均价（分）
dt
string否时间

6.25 dpa商品id粒度明细数据查询

基本信息

Path： /v3/data/common/query/queryAdsDpaProductData

Method： POST

接口描述：

request

{
 "page":1,
 "pageCount":10,
 "beginTime":"20231201",
 "endTime":"20231201",
 "timeLevel":"DAY",
 "orderByColumns":"",
 "ascDesc":"ASC",
 "paraMap":{
   "biz_type":"feeds",
   "response_product_id":"1",
   "ad_id":"1"
 }
}

result

{
   "code":0,
   "data":{
       "totalCount":1,
       "itemCount":1,
       "items":[
           {
               "acc_nums":2505,
               "ad_name":"1",
               "expose_nums":2505,
               "fdate":20231201,
               "biz_type":"feeds",
               "response_product_id":"1",
               "ad_id":"1",
               "down_nums":3619,
               "acc_cost":2505
           }
       ]
   }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是

Body

名称类型必须默认值备注
beginTime
integer否起始时间 不填的话默认是当天如20201001beginTime endTime须配合使用
endTime
integer否结束时间 不填的话默认是当天如20201001beginTime endTime须配合使用
timeLevel
string否时间粒度 聚合粒度 有 DAY ALL五个粒度具体支持到那个粒度和具体业务相关 取值如前 必须大写
page
string否分页起始
pageCount
string否分页大小
orderByColumns
string否数据排序字段，仅支持当时查询列表返回字段
ascDesc
string否正序逆序 可取值 ASC DESC两种 不可取其他值 支持大小写 建议配合orderByColumns一起使用， 如orderByColumns: "dt",ascDesc: "DESC"
paraMap
object否与业务相关的具体参数
biz_type
string否业务类型 feeds,union,srh,cpd,未知和空字符串
response_product_id
string否响应商品ID
ad_id
string否广告ID
groupByColumn
string否可根据多维度分组统计数据，默认fdate 可传入的字段：ad_id,biz_type,response_product_id不可随意传递

返回数据

名称类型必须默认值备注
code
string否状态码0请求正常1系统异常11001:服务端异常110000：参数错误110002：用户不存在或已过期，请重新登录110003：无效的接口查询路径110101：查询天数不合法，具体见msg110104：超过批量查询最大限制，默认500其余请看msg
msg
string否具体信息
data
object否
totalCount
number是符合查询总数
itemCount
number是分页查询数量
items
object []是结果
fdate
integer否日期
owner_id
string否广告主id
biz_type
string否业务类型 feeds,union,srh,cpd,未知和空字符串
response_product_id
string否响应商品ID
ad_id
string否广告ID
ad_name
string否广告名称
expose_nums
integer是曝光量
acc_cost
integer是实扣金额（分）
acc_nums
integer是实扣点击
down_nums
integer是下载量

6.26 dpa商品id粒度汇总数据查询

基本信息

Path： /v3/data/common/summary/queryAdsDpaProductData

Method： POST

接口描述：

request

{
  "beginTime": "20231201",
  "endTime": "20231201",
  "timeLevel": "ALL",
  "paraMap": {
    "biz_type": "feeds",
    "response_product_id": "1",
    "ad_id": "1"
  }
}

result

{
    "code": 0,
    "data": {
        "acc_nums": 2505,
        "ad_name": "1",
        "expose_nums": 2505,
        "biz_type": "feeds",
        "response_product_id": "1",
        "ad_id": "1",
        "down_nums": 3619,
        "acc_cost": 2505
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是

Body

名称类型必须默认值备注
beginTime
integer否起始时间 不填的话默认是当天如20201001beginTime endTime须配合使用
endTime
integer否结束时间 不填的话默认是当天如20201001beginTime endTime须配合使用
paraMap
object否与业务相关的具体参数
biz_type
string否业务类型 feeds,union,srh,cpd,未知和空字符串
response_product_id
string否响应商品ID
ad_id
string否广告ID

返回数据

名称类型必须默认值备注
code
string否状态码0请求正常1系统异常11001:服务端异常110000：参数错误110002：用户不存在或已过期，请重新登录110003：无效的接口查询路径110101：查询天数不合法，具体见msg110104：超过批量查询最大限制，默认500其余请看msg
msg
string否具体信息
data
object否
fdate
integer否日期
owner_id
string否广告主id
biz_type
string否业务类型 feeds,union,srh,cpd,未知和空字符串
response_product_id
string否响应商品ID
ad_id
string否广告ID
ad_name
string否广告名称
expose_nums
integer是曝光量
acc_cost
integer是实扣金额（分）
acc_nums
integer是实扣点击
down_nums
integer是下载量

6.27 rta外部实验id明细数据查询

基本信息

Path： /v3/data/common/query/queryRtaExpData

Method： POST

接口描述：

request

{
  "page": 1,
  "pageCount": 10,
  "beginTime": "20240101",
  "endTime": "20240104",
  "timeLevel": "HOUR",
  "orderByColumns": "rta_exp_group_id",
  "ascDesc": "DESC",
  "paraMap": {
    "rta_exp_group_id":"1"
  }
}

result

{
    "code": 0,
    "data": {
        "totalCount": 1,
        "itemCount": 1,
        "items": [
            {
                "rta_exp_group_id": "1",
                "owner_id": "1000001009",
                "expose_nums": 1,
                "fdate": 2024010203,
                "acc_cost": 1
            }
        ]
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是

Body

名称类型必须默认值备注
beginTime
integer否起始时间 不填的话默认是当天如20201001beginTime endTime须配合使用
endTime
integer否结束时间 不填的话默认是当天如20201001beginTime endTime须配合使用
timeLevel
string否时间粒度 聚合粒度 有 DAY HOUR ALL粒度具体支持到那个粒度和具体业务相关 取值如前 必须大写
page
string否分页起始
pageCount
string否分页大小
orderByColumns
string否数据排序字段，仅支持当时查询列表返回字段
ascDesc
string否正序逆序 可取值 ASC DESC两种 不可取其他值 支持大小写 建议配合orderByColumns一起使用， 如orderByColumns: "fdate",ascDesc: "DESC"
paraMap
object否与业务相关的具体参数
groupByColumn
string否可根据多维度分组统计数据，默认fdate 可传入的字段：rta_exp_group_id 不可随意传递
rta_exp_group_id
string否RTA实验组ID

返回数据

名称类型必须默认值备注
code
string否状态码0请求正常1系统异常11001:服务端异常110000：参数错误110002：用户不存在或已过期，请重新登录110003：无效的接口查询路径110101：查询天数不合法，具体见msg110104：超过批量查询最大限制，默认500其余请看msg
msg
string否具体信息
data
object否
totalCount
number是符合查询总数
itemCount
number是分页查询数量
items
object []是结果
fdate
integer否日期
owner_id
string否广告主id
rta_exp_group_id
string否RTA实验组ID
expose_nums
integer否曝光量
acc_cost
integer否实扣金额（分）

7. 搜索关键词相关

7.1 查询行业类目

基本信息

Path： /v3/communal/searchKeyWord/listCategoryKws

Method： POST

接口描述：

查询行业类目：

注：
1、查询根目录时，categoryId=0或为空
2、查询某个层级的类目词包，取上一层级的kwId作为接口请求参数categoryId的值来作为查询条件

请求参数：

categoryId: 10000

SDK接入请求方法：

omniAds.adsSearchKeyWord.V3CommunalSearchKeyWordListCategoryKws(data)

SDK请求参数：

AdSearchCategoryKwQueryDTO data；
data.setXxx;

private Long categoryId;  类目id不能小于0

private Long appId;       appId必须大于0

响应报文：


{
    "code": 0, 
    "data": [
        {
            "kwId": 10000, 
            "kwName": "医疗医美", 
            "source": 2, 
            "pId": 0, 
            "level": 1, 
            "queryNum": 151188, 
            "leaf": false
        }, 
        {
            "kwId": 20000, 
            "kwName": "教育培训", 
            "source": 2, 
            "pId": 0, 
            "level": 1, 
            "queryNum": 42543231, 
            "leaf": false
        }
    ]
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 必须 示例 备注
categoryId 文本 否 10000 行业类目ID，categoryId=0或为空表示查询根目录，否则查询指定的层级目录

返回数据

名称类型必须默认值备注
object []否
kwId
integer否行业类目ID
kwName
string否行业类目名称
pId
integer否父类ID，根目录pId=0
level
integer否层级，根目录level=0
leaf
boolean否是否是叶子节点
queryNum
integer否0月搜索量
suggestPrice
integer否0推荐出价
competeLevel
integer否0竞争程度
source
string是关键词来源，1：系统推荐-关键词，2：出价类目词包，3：行业热词-出关键词，5：手动输入或手动上传-关键词，6：系统推荐-禁推词包/自定义词包，7：手动输入或手动上传-禁推词包/自定义词包

7.2 获取广告组下的所有关键词（旧）

基本信息

Path： /v3/communal/searchKeyWord/listPremiumKws

Method： POST

接口描述：

获取广告组下的所有关键词（旧）：

请求参数：

adGroupId: 300582205
sourceSet: 0

SDK接入请求方法：

omniAds.adsSearchKeyWord.V3CommunalSearchKeyWordListPremiumKws(data)

请求参数：

AdSearchPremiumKwQueryDTO data；
data.setXxx;

private Long adGroupId;  广告组ID

private Long packageId;  包编码

private Long ownerId;

private Long appId;   应用id

private String keyword;   关键词

private Set<Integer> auditStatusSet;   <span class="colour" style="color: rgb(17, 17, 18);">审核状态[0待审核 1审核通过 2审核不通过]集</span>

private Set<Integer> sourceSet;      <span class="colour" style="color: rgb(17, 17, 18);">来源[1算法推荐 2商店推送 3运营添加 4广告主自定义 5临时添加]集</span>

private Set<String> categories;

private Integer deleteFlag;

private String orderByColumn = "insert_time";  排序字段

private int orderByType = 0;

private int callFlag = 0;

响应报文：

{
    "code": 0, 
    "data": [
        {
            "id": 246, 
            "kwPackageId": 800000081, 
            "kwPackageType": 1, 
            "adGroupId": 300286177, 
            "ownerId": 1100047375, 
            "matchType": 3, 
            "price": 800, 
            "source": 6, 
            "keyword": "ik", 
            "auditStatus": 1, 
            "auditMsg": "审核通过", 
            "deleteFlag": 0, 
            "kwPackageName": "seweoe"
        }, 
        {
            "kwPackageId": 600017492, 
            "adGroupId": 300286177, 
            "ownerId": 1100047375, 
            "appId": 653260, 
            "matchType": 3, 
            "price": 818, 
            "source": 1, 
            "keyword": "迷你世界", 
            "auditStatus": 0, 
            "auditMsg": "", 
            "deleteFlag": 0
        }
    ]
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是

Query

参数名称 必须 示例 备注
adGroupId 是 广告组ID
sourceSet 是 0 关键词来源，0：所有关键词， 1：系统推荐-关键词，2：出价类目词包，3：行业热词-出关键词，5：手动输入或手动上传-关键词，6：系统推荐-禁推词包/自定义词包，7：手动输入或手动上传-禁推词包/自定义词包

Body

名称类型必须默认值备注
adGroupId
integer是广告组ID
sourceSet
string否关键词来源

返回数据

名称类型必须默认值备注
code
number否
msg
string否
data
object []否
keyword
string否关键词
categoryId
number否行业类目ID
adGroupId
number否广告组ID
KwPackageName
string否词包名称
price
number否出价
ownerId
number否广告主ID
source
number否关键词来源，1：系统推荐-出价词包，2：出价类目词，3：行业热词-出价词包，5：出价词包（手动输入或手动上传），6：系统推荐-禁推词包/自定义词包，7：禁推词包/自定义词包（手动输入或手动上传）
kwPackageType
number否词包类型，1：自定义词包，2：禁推词包
kwPackageId
number否词包ID
id
number否词包与广告组的关联关系id
auditMsg
string否审核备注
deleteFlag
number否删除状态，0：未删除，1：已删除
appId
number否应用id
matchType
number否匹配类型 1：精准匹配，2：词组匹配，3：模糊匹配
auditStatus
number否审核状态 1：审核通过，2：审核拒绝

7.3 获取广告组下的所有关键词/词包（新）

基本信息

Path： /v3/communal/searchKeyWord/listGroupKwPkg

Method： POST

接口描述：

获取广告组下的所有关键词/词包（新）：
SDK接入，请求地址：

omniAds.adsSearchKeyWord.v3ListGroupKwPkg(data)

SDK请求参数：

ListGroupKwPkgForm data;

请求参数：

adGroupId: 300582205
type: 0

响应报文：

{
    "code": 0, 
    "data": [
        {
            "id": 246, 
            "kwPackageId": 800000081, 
            "kwPackageType": 1, 
            "adGroupId": 300286177, 
            "ownerId": 1100047375, 
            "matchType": 3, 
            "price": 800, 
            "source": 6, 
            "keyword": "ik", 
            "auditStatus": 1, 
            "deleteFlag": 0, 
            "kwPackageName": "seweoe"
        }, 
        {
            "kwPackageId": 600017492, 
            "adGroupId": 300286177, 
            "ownerId": 1100047375, 
            "appId": 653260, 
            "matchType": 3, 
            "price": 818, 
            "source": 1, 
            "keyword": "迷你世界", 
            "auditStatus": 0, 
            "deleteFlag": 0
        }
    ]
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
adGroupId 是 广告组ID
type 否 查询类型，0：查询所有，1：查询关键词，2：查询行业类目词包，3：查询自定义词包/禁推词包，默认值为0

返回数据

名称类型必须默认值备注
code
number否
data
object []否
id
number否自定义词词包、禁推词包与广告组的关联关系id，如果为关键词或行业类目词包，id为空
kwPackageId
number是词包ID
kwPackageType
number否词包类型，1：自定义词包，2：禁推词包，如果为关键词或行业类目词包，词包类型为空
adGroupId
number是广告组ID
ownerId
number是广告主ID
matchType
number是匹配类型 1：精准匹配，2：词组匹配，3：模糊匹配
price
number是出价
source
number是关键词来源，1：系统推荐-关键词，2：出价类目词包，3：行业热词-出关键词，5：手动输入或手动上传-关键词，6：系统推荐-禁推词包/自定义词包，7：手动输入或手动上传-禁推词包/自定义词包
keyword
string是关键词
auditStatus
number是审核状态 0：未审核，1：审核通过，2：审核拒绝
deleteFlag
number是删除状态，0：未删除，1：已删除
kwPackageName
string否词包名称
appId
number否应用id

7.4 新增自定义词包、禁推词包

基本信息

Path： /v3/communal/searchKeyWord/addCustomOrNoKwPkg

Method： POST

接口描述：

新增自定义词包、禁推词包：
SDK接入，请求方法：

omniAds.adsSearchKeyWord.v3AddCustomOrNoKwPkg(data)

SDK请求参数：

AddCustomKwPkgForm

请求参数：

kwPackageName: onePackage
kwPackageType: 1
pkgKeywords[0].keyword: nihao
pkgKeywords[0].matchType: 2

响应报文：

{
    "code": 0
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
kwPackageName 是 词包名称，长度为2~20个字符
kwPackageType 是 词包类型，1：自定义词包，2：禁推词包，默认值为1
pkgKeywords[0].keyword 是 词包中的关键词，长度不能超过20个字符
pkgKeywords[0].matchType 否 关键词匹配类型 1：精准匹配，2：词组匹配，3：模糊匹配，默认值为1

返回数据

名称类型必须默认值备注
code
integer是返回状态码，0表示成功，非0表示异常
msg
string否返回错误信息

7.5 删除自定义词包、禁推词包中的关键词

基本信息

Path： /v3/communal/searchKeyWord/deleteKwInPkg

Method： POST

接口描述：

删除自定义词包、禁推词包中的关键词：
SDK接入，请求方法：

omniAds.adsSearchKeyWord.v3DeleteKwInPkg（data）

SDK请求参数：

DeleteKwInPkgForm data;

请求参数：

kwPackageId: 300582205
keywords[0].keyword: nihao
keywords[1].keyword: test1024

响应报文：

{
    "code": 0
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
kwPackageId 是 词包ID
keywords[0].keyword 是 词包中的关键词，长度不能超过20个字符
keywords[1].keyword 是 词包中的关键词，长度不能超过20个字符

返回数据

名称类型必须默认值备注
code
integer是返回状态码，0表示成功，非0表示异常
msg
string否返回错误信息

7.6 向自定义词包、禁推词包添加关键词

基本信息

Path： /v3/communal/searchKeyWord/addKwToPkg

Method： POST

接口描述：

向自定义词包、禁推词包添加关键词：
SDK接入，请求方法

omniAds.adsSearchKeyWord.v3AddKwToPkg(data)

SDK请求参数：

AddKwToPkgForm data;

请求参数：

kwPackageId: 12345567
pkgKeywords[0].keyword: nihao
pkgKeywords[0].matchType: 2

响应报文：

{
    "code": 0
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
kwPackageId 是 词包ID
pkgKeywords[0].keyword 是 词包的关键词，长度不能超过20个字符
pkgKeywords[0].matchType 否 关键词匹配类型 1：精准匹配，2：词组匹配，3：模糊匹配，默认值为1

返回数据

名称类型必须默认值备注
code
integer是返回状态码，0表示成功，非0表示异常
msg
string否返回错误信息

7.7 编辑自定义词包、禁推词包名称

基本信息

Path： /v3/communal/searchKeyWord/editCustomOrNoKwPkg

Method： POST

接口描述：

编辑自定义词包、禁推词包名称：
SDK接入，请求方法：

omniAds.adsSearchKeyWord.v3EditCustomOrNoKwPkg(data)

SDK请求参数：

EditKwPkgForm data;

请求参数：

kwPackageId: 12345343455
kwPackageName: testPackage
pkgKeywords[0].keyword: nihao
pkgKeywords[0].matchType:2

响应报文：

{
    "code": 0
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
kwPackageId 是 词包ID
kwPackageName 否 词包名称，长度为2~20个字符，输入新词包名，会替换原来的词包名
pkgKeywords[0].keyword 否 词包中的关键词，长度不能超过20个字符
pkgKeywords[0].matchType 否 关键词匹配类型 1：精准匹配，2：词组匹配，3：模糊匹配，默认值为1

返回数据

名称类型必须默认值备注
code
integer是返回状态码，0表示成功，非0表示异常
msg
string否返回错误信息

7.8 批量删除自定义词包、禁推词包（与广告组绑定关系也会一起删除）

基本信息

Path： /v3/communal/searchKeyWord/batchDeleteKwPkg

Method： POST

接口描述：

批量删除自定义词包、禁推词包（与广告组绑定关系也会一起删除）：
SDK接入，请求方法：

omniAds.adsSearchKeyWord.v3BatchDeleteKwPkg（data）

SDK请求参数：

BatchDeleteKwPkgForm data；

请求参数：

kwPkgIdList[0]: 300582205
kwPkgIdList[1]: 878772833

响应报文：

{
    "code": 0
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是

Query

参数名称 必须 示例 备注
kwPkgIdList[0] 是 词包ID
kwPkgIdList[1] 是 词包ID

返回数据

名称类型必须默认值备注
code
integer是返回状态码，0表示成功，非0表示异常
msg
string否返回错误信息

7.9 广告组绑定关键词、行业类目词包、自定义/禁推词包

基本信息

Path： /v3/communal/searchKeyWord/addGroupKw

Method： POST

接口描述：

广告组绑定关键词、行业类目词包、自定义/禁推词包：
SDK接入，请求方法：

omniAds.adsSearchKeyWord.v3AddGroupKw(data)

SDK请求参数：

AddGroupKwForm

请求参数：

adGroupId: 12342344

searchKeywords[0].keyword: testKeyword

searchKeywords[0].matchType: 1

searchKeywords[0].price: 100

searchKeywords[0].ocpcPrice: 100

searchKeywords[0].deepOcpcPrice: 100

searchKeywords[0].targetROI: 6


categoryPackages[0].categoryId: 34745958

categoryPackages[0].matchType: 3

categoryPackages[0].price: 200

categoryPackages[0].ocpcPrice: 100

categoryPackages[0].deepOcpcPrice: 100

categoryPackages[0].targetROI: 6


customOrNoPackages[0].kwPackageId: 98978682

customOrNoPackages[0].price: 3000

customOrNoPackages[0].ocpcPrice: 100

customOrNoPackages[0].deepOcpcPrice: 100

customOrNoPackages[0].targetROI: 6

响应报文：

{
    "code": 0
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
adGroupId 是 广告组ID
searchKeywords[0].keyword 否 关键词，长度不能超过20个字符
searchKeywords[0].source 否 关键词来源，1：系统推荐，3：行业热词，5：手动输入或手动上传
searchKeywords[0].matchType 否 关键词匹配类型 1：精准匹配，2：词组匹配，3：模糊匹配，默认值为1
searchKeywords[0].price 否 关键词价格，必须大于0
searchKeywords[0].ocpcPrice 否 关键词 目标转化出价（单位：分）
searchKeywords[0].deepOcpcPrice 否 关键词 深度转化出价（单位：分）
searchKeywords[0].targetROI 否 关键词 目标ROI系数 * 1000000, (0,10]
categoryPackages[0].categoryId 否 行业类目ID
categoryPackages[0].matchType 否 匹配类型 1：精准匹配，2：词组匹配，3：模糊匹配，默认值为1
categoryPackages[0].price 否 行业类目在广告组出价
categoryPackages[0].ocpcPrice 否 行业类目在广告组目标转化出价（单位：分）
categoryPackages[0].deepOcpcPrice 否 行业类目在广告组深度转化出价（单位：分）
categoryPackages[0].targetROI 否 行业类目在广告组目标ROI系数 * 1000000, (0,10]
customOrNoPackages[0].kwPackageId 否 词包ID
customOrNoPackages[0].price 否 词包在广告组出价，只有自定义词包才能设置出价
customOrNoPackages[0].ocpcPrice 否 词包在广告组目标转化出价（单位：分），只有自定义词包才能设置出价
customOrNoPackages[0].deepOcpcPrice 否 词包在广告组深度转化出价（单位：分），只有自定义词包才能设置出价
customOrNoPackages[0].targetROI 否 词包在广告组目标ROI系数 * 1000000, (0,10]，只有自定义词包才能设置出价

返回数据

名称类型必须默认值备注
code
integer是返回状态码，0表示成功，非0表示异常
msg
string否返回错误信息

7.10 广告组删除关键词、行业类目词包、自定义/禁推词包

基本信息

Path： /v3/communal/searchKeyWord/deleteGroupKw

Method： POST

接口描述：

广告组删除关键词、行业类目词包、自定义/禁推词包：

请求参数：

adGroupId: 12342344

searchKeywords[0].keyword: testKeyword

searchKeywords[0].kwPackageId: 1989893


categoryPackages[0].categoryId: 34745958

categoryPackages[0].kwPackageId: 3989893


customOrNoPackages[0].id: 4938923

响应报文：

{
    "code": 0
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
adGroupId 是 广告组ID
searchKeywords[0].keyword 否 关键词，长度不能超过20个字符
searchKeywords[0].kwPackageId 否 词包ID
categoryPackages[0].categoryId 否 行业类目ID
categoryPackages[0].kwPackageId 否 词包ID
customOrNoPackages[0].id 否 自定义词包、禁推词包绑定关系id

返回数据

名称类型必须默认值备注
code
integer是返回状态码，0表示成功，非0表示异常
msg
string否返回错误信息

7.11 编辑广告组绑定的关键词、行业类目词包、自定义词包价格，匹配模式

基本信息

Path： /v3/communal/searchKeyWord/editGroupKw

Method： POST

接口描述：

编辑广告组绑定的关键词、行业类目词包、自定义词包价格，匹配模式：

请求参数：

adGroupId=1234234

searchKeywords[0].keyword: testKeyword

searchKeywords[0].kwPackageId: 789899879882

searchKeywords[0].matchType: 1

searchKeywords[0].price: 100

searchKeywords[0].ocpcPrice: 100

searchKeywords[0].deepOcpcPrice: 100

searchKeywords[0].targetROI: 6


categoryPackages[0].categoryId: 34745958

categoryPackages[0].kwPackageId: 978868767873

categoryPackages[0].matchType: 3

categoryPackages[0].price: 200

categoryPackages[0].ocpcPrice: 100

categoryPackages[0].deepOcpcPrice: 100

categoryPackages[0].targetROI: 6


customPackages[0].id: 98978682

customPackages[0].price: 3000

customOrNoPackages[0].ocpcPrice: 100

customOrNoPackages[0].deepOcpcPrice: 100

customOrNoPackages[0].targetROI: 6

响应报文：

{
    "code": 0
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
adGroupId 是 广告组ID
searchKeywords[0].keyword 否 关键词，长度不能超过20个字符
searchKeywords[0].kwPackageId 否 词包ID
searchKeywords[0].price 否 关键词价格，必须大于0
searchKeywords[0].ocpcPrice 否 关键词 目标转化出价（单位：分），必须大于0
searchKeywords[0].deepOcpcPrice 否 关键词 深度转化出价（单位：分），必须大于0
searchKeywords[0].targetROI 否 关键词 目标ROI系数 * 1000000, (0,10]，必须大于0
searchKeywords[0].matchType 否 关键词匹配类型 1：精准匹配，2：词组匹配，3：模糊匹配，默认值为1
categoryPackages[0].categoryId 否 行业类目ID
categoryPackages[0].kwPackageId 否 词包ID
categoryPackages[0].price 否 行业类目在广告组出价
categoryPackages[0].ocpcPrice 否 行业类目在广告组目标转化出价（单位：分）
categoryPackages[0].deepOcpcPrice 否 行业类目在广告组深度转化出价（单位：分）
categoryPackages[0].targetROI 否 行业类目在广告组目标ROI系数 * 1000000, (0,10]
categoryPackages[0].matchType 否 关键词匹配类型 1：精准匹配，2：词组匹配，3：模糊匹配，默认值为1
customPackages[0].id 否 自定义词包绑定关系id
customPackages[0].price 否 词包在广告组出价，只有自定义词包才能设置出价
customOrNoPackages[0].ocpcPrice 否 词包在广告组目标转化出价（单位：分），只有自定义词包才能设置出价
customOrNoPackages[0].deepOcpcPrice 否 词包在广告组深度转化出价（单位：分），只有自定义词包才能设置出价
customOrNoPackages[0].targetROI 否 词包在广告组目标ROI系数 * 1000000, (0,10]，只有自定义词包才能设置出价

返回数据

名称类型必须默认值备注
code
integer是返回状态码，0表示成功，非0表示异常
msg
string否返回错误信息

7.12 获取账户下的所有词包

基本信息

Path： /v3/communal/searchKeyWord/queryKwPackageByOwner

Method： POST

接口描述：

获取账户下的所有词包：

请求参数：

kwPackageType: 2

SDK接入请求方法：

omniAds.adsSearchKeyWord.V3CommunalSearchKeyWordQueryPackageByOwner(data)

请求参数：

PremiumCustomKwDTO data；
data.setXxx;

List<Long> kwPackageIdList;

List<String> keywordList;

响应报文：

{
    "code": 0, 
    "data": [
        {
            "kwPackageId": 800000042, 
            "kwPackageName": "地方", 
            "ownerId": 138405424, 
            "keyword": "地区", 
            "kwPackageType": 2, 
            "source": 6, 
            "matchType": 3, 
            "auditStatus": 0, 
            "deleteFlag": 0, 
            "kwCount": 2
        }, 
        {
            "kwPackageId": 800000044, 
            "kwPackageName": "就是111", 
            "ownerId": 138405424, 
            "keyword": "测测", 
            "kwPackageType": 2, 
            "source": 6, 
            "matchType": 3, 
            "auditStatus": 0, 
            "deleteFlag": 0, 
            "kwCount": 1
        }
    ]
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
kwPackageType 是 1 词包类型，1：自定义词包，2：禁推词包

返回数据

名称类型必须默认值备注
code
number是返回状态码
data
object []否返回数据
kwPackageId
number是词包ID
kwPackageName
string是词包名称
ownerId
number是广告主ID
kwPackageType
number是词包类型，1：自定义词包，2：禁推词包
source
number是关键词来源，6：系统推荐-禁推词包/自定义词包，7：禁推词包/自定义词包（手动输入或手动上传）
matchType
number是匹配类型 1：精准匹配，2：词组匹配，3：模糊匹配
auditStatus
number是审核状态 1：审核通过，2：审核拒绝
deleteFlag
number是删除状态，0：未删除，1：已删除
kwCount
number是词包内的词数
auditMsg
string是审核备注

7.13 查询单个自定义词包、禁推词包下的所有关键词

基本信息

Path： /v3/communal/searchKeyWord/queryKwByPackageId

Method： POST

接口描述：

查询单个自定义词包、禁推词包下的所有关键词：

请求参数：

kwPackageId: 978868767873

响应报文：

{
    "code": 0, 
    "data": [
        {
            "kwPackageId": 800000042, 
            "kwPackageName": "地方", 
            "ownerId": 138405424, 
            "keyword": "地区", 
            "kwPackageType": 2, 
            "source": 6, 
            "matchType": 3, 
            "auditStatus": 0, 
            "deleteFlag": 0
        }, 
        {
            "kwPackageId": 800000044, 
            "kwPackageName": "就是111", 
            "ownerId": 138405424, 
            "keyword": "测测", 
            "kwPackageType": 1, 
            "source": 6, 
            "matchType": 3, 
            "auditStatus": 0, 
            "deleteFlag": 0
        }
    ]
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
kwPackageId 是 词包ID

返回数据

名称类型必须默认值备注
code
number否返回状态码
data
object []否返回数据
kwPackageId
number是词包ID
kwPackageName
string是词包名称
ownerId
number是广告主ID
keyword
string是关键词
kwPackageType
number是词包类型，1：自定义词包，2：禁推词包
source
number是6：系统推荐-禁推词包/自定义词包，7：禁推词包/自定义词包（手动输入或手动上传）
matchType
number是匹配类型 1：精准匹配，2：词组匹配，3：模糊匹配
auditStatus
number是审核状态 1：审核通过，2：审核拒绝
deleteFlag
number是删除状态，0：未删除，1：已删除

8. 广告主相关

8.1 代理商客户查询

基本信息

Path： /v2/communal/agency/customer/list

Method： POST

接口描述：

查询所有子客户和次级代理商
请求参数示例：

page=1
pageCount=1

SDK请求方法：（使用SDK方法接入）

omniAds.adsAgency().V2AgencyCustomerList(data)

SDK请求参数：

CustomerListReq data
data.setXxx;

Long operatorId;  操作用戶ID

String operatorName;   操作用户名

Integer ownerType;     过滤条件，查询当前代理商下的广告主类型

int id;                 定向Id，也叫customerId

Long ownerId;

String ownerName;

Integer auditStatus;     审核状态, 0: 未审核 1：审核通过 2：审核未通过

Integer page;      当前页   不为空

Integer pageCount;   每页数量  不为空

响应报文：

{
    "code": 0,
    "data": {
        "totalCount": 40,
        "itemCount": 1,
        "items": [
            {
                "accId": 800050006,
                "cashBal": 793585,
                "cashLockBal": 0,
                "cashCost": 146992,
                "rebateBal": 0,
                "rebateCost": 0,
                "virBal": 0,
                "virCost": 0,
                "accDayBudget": 0,
                "budgetType": 1,
                "totalBalance": 793585,
                "lastDayCost": 0,
                "ownerId": 1100050133,
                "ownerName": "商品",
                "ownerType": 1,
                "auditStatus": 1,
                "insertTime": 1625730847,
                "updateTime": 1625732057,
                "openId": ""
            }
        ]
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是 application/x-www-form-urlencoded

Query

参数名称 必须 示例 备注
id 否 0 customerId，用户信息Id
ownerId 否 0 广告主ID
ownerName 否 广告主名称
auditStatus 否 0 审核状态, 0: 未审核 1：审核通过 2：审核未通过
page 是 0 当前页
pageCount 是 0 每页数量

返回数据

名称类型必须默认值备注
code
integer否
msg
string否
data
object否
totalCount
integer否
itemCount
integer否
items
object []否
ownerId
integer否广告主ID
ownerName
string否广告主名称
ownerType
integer否广告主类型
loginAcc
string否账务ID
auditStatus
integer否审核状态
insertTime
integer否创建时间(秒)
updateTime
integer否更新时间(秒)
openId
string否第三方Id
operationReason
string否审核原因
accId
integer否财务ID
cashBal
integer否现金余额(分)
cashDayBudget
integer否现金账户日预算(分)
cashLockBal
integer否现金账户锁定余额(分)
cashCost
integer否现金账户消耗(分)
rebateBal
integer否返货账户余额(分)
rebateCost
integer否返货账户消耗(分)
virBal
integer否虚拟账户金额(分)
virCost
integer否虚拟账号消耗(分)
accDayBudgetLimit
integer否账户日预算最低限制(分)
totalBalance
integer否总余额值: virBal[赠送余额] + rebateBal[返货余额] + cashBal[现金余额]
lastDayCost
integer否昨日消耗
budgetType
integer否预算类型，0：日预算-不限 1-限制
todayTotalCost
integer否今日总消耗

8.10 获取当前登录客户信息

基本信息

Path： /v2/communal/owner/unifiedInfo

Method： GET

接口描述：

请求参数

Query

参数名称 必须 示例 备注
ownerId 否 123123 子客户的ownerId，仅代理商操作子客户填写

返回数据

名称类型必须默认值备注
code
integer否
msg
string否
data
object否
ownerId
integer否用户id
ownerName
string否名称
accId
integer否财务账号id
loginType
integer否登录类型 1-代理商登入;2- 代理商登入子账户;3-子账户自己登入;4-直客登入;5-运营登入
ownerType
integer否广告主类型 0:代理商账号 1:代理商子客户 2:旧直客 3:新直客 4:运营
level
integer否代理商层级 1级代理商为1，最多支持3级代理商。子客户和直客本字段无意义。
loginUser
object否当前的登录用户，仅代理商进入子客户时返回该字段
ownerId
integer否用户id
ownerName
string否名称
accId
integer否财务账号id
ownerType
integer否广告主类型 0:代理商账号 1:代理商子客户 2:旧直客 3:新直客 4:运营
level
integer是代理商层级 1级代理商为1，最多支持3级代理商。

8.2 广告主权限查询

基本信息

Path： /v2/communal/auth/query

Method： POST

接口描述：

查询广告主对应的菜单、数据权限信息
loginType 只能为 1 2 3 4， 且为必传参数
如果代理商查询子客户，需要传子客户ownerId

请求参数示例：

loginType=1

SDK接入请求方法：

omniAds.adsAgency().V2CommunalAuthQuery(data)

SDK请求参数：

AdsBaseForm data;
data.setXxx;

private Integer loginType;  代理商登入;2- 代理商登入子账户;3-子账户自己登入;4-直客登入  必传参数

private Long ownerId;       广告主ID, 当loginType为2 时， ownerId必填

响应报文:

{
    "code": 0,
    "data": {
        "ownerId": 1100047448,
        "menuTree": [
            "115",
            "116",
            "117"
        ],
        "dataTree": [
            "0",
            "chn_1",
            "show_type_128",
            "show_type_32",
            "kw_custom",
            "chn_2",
            "show_type_16"
        ]
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是 application/x-www-form-urlencoded

Query

参数名称 必须 示例 备注
loginType 是 0 1-代理商登入;2- 代理商登入子账户;3-子账户自己登入;4-直客登入
必传参数
ownerId 否 0 广告主ID, 当loginType为2 时， ownerId必填

返回数据

名称类型必须默认值备注
code
integer否
msg
string否
data
object否
ownerId
integer否广告主id
menuTree
string []否菜单权限
dataTree
string []否数据权限

8.3 账务流水查询

基本信息

Path： /v2/communal/finance/billHis

Method： POST

接口描述：

请求参数示例：

page=1
pageCount=2
loginType=1

SDK接入请求方法：

omniAds.adsAgency().V2FinanceBillHis(data,page,pageCount,loginType)

SDK请求参数：

AdsAccBillHisForm data = new AdsAccBillHisForm();
data.setXxx;

private Long startTime; // 开始时间

private Long endTime; // 结束时间

private Integer ownerId; // 客户广告主ID - 只有代理商可以使用

private Integer subAcc; // 账户类型 0:现金账户 1:返货账户 9999:赠送账户

private Integer billSub; // 流水子类型  100:充值  , 200:锁定 , 201:解锁 , 300:划账

private Integer billType; // 账务类型  0 : 存入  , 1 :  支出

private Integer pOwnerType;  财务流水对端账户的广告主类型， 0:代理商主 1:代理商从 2:oppo开发社区  3:广告主


Integer page = 1;

Integer pageCount = 10;

Integer loginType=1;

响应报文：

{
    "code": 0,
    "data": {
        "totalCount": 4,
        "itemCount": 2,
        "items": [
            {
                "billTime": "2021-07-08 16:31:40",
                "subAcc": 0,
                "billType": 1,
                "billMoney": 1000000,
                "billDesc": "代理商划账",
                "accId": 800047321,
                "relateAccId": 800050006,
                "relateOwnerId": 1100050133,
                "relateOwnerName": "商品",
                "relateOwnerType": 0,
                "billSub": 300
            },
            {
                "billTime": "2021-07-07 11:14:14",
                "subAcc": 0,
                "billType": 1,
                "billMoney": 100000,
                "billDesc": "代理商划账",
                "accId": 800047321,
                "relateAccId": 800049958,
                "relateOwnerId": 1100050085,
                "relateOwnerName": "master测试",
                "relateOwnerType": 0,
                "billSub": 300
            }
        ]
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是 application/x-www-form-urlencoded

Query

参数名称 必须 示例 备注
startTime 否 0 查询开始时间
开始时间Unix timestamp 例如1695021027
endTime 否 0 查询结束时间
结束时间Unix timestamp 例如1697611199
ownerId 否 0 从账号广告主ID(代理商可以用)
客户广告主ID - 只有代理商可以使用
subAcc 否 0 账户类型, 0:现金账户 1:返货账户 9999:赠送账户
账户类型
billSub 否 0 账务类型 , 100:充值 , 200:锁定 , 201:解锁 , 300:划账
流水子类型 100:充值 , 200:锁定 , 201:解锁 , 300:划账
billType 否 0 流水类型, 0 : 存入 , 1 : 支出
账务类型 0 : 存入 , 1 : 支出
pOwnerType 否 0 财务流水对端账户的广告主类型， 0:代理商主 1:代理商从 2:oppo开发社区 3:广告主
page 是 0 当前页
pageCount 是 0 一页个数
loginType 是 0 登陆类型1-代理商登录；2- 代理商登录子账号； 3-子账号自己登录；4-直客登录

返回数据

名称类型必须默认值备注
code
integer否
msg
string否
data
object否
totalCount
integer否
itemCount
integer否
items
object []否
billTime
string否流水时间
subAcc
integer否子账户 0:现金 1: 返还 9999:虚拟
billType
integer否流水类型 0:存入 1:支出
billMoney
integer否流水金额; 充值金额、锁定金额等
billDesc
string否流水描述
accId
integer否账务id
relateAccId
integer否关联的accId,主要用于识别转帐对象
relateOwnerId
integer否关联的广告主ID
relateOwnerName
string否关联广告主名称
relateOwnerType
integer否关联的广告主类型
billSub
integer否流水子类型 100:充值 200:锁定 201:解锁

8.4 获取当前登陆态子客户信息

基本信息

Path： /v2/communal/owner/info

Method： POST

接口描述：

用户基础信息接口
无请求参数：
SDK接入请求方法：

 omniAds.adsOwner().v2CommunalOwnerInfo()

响应报文：

{
    "code": 0,
    "data": {
        "ownerId": 1100047375,
        "accId": 800047248,
        "loginType": 3,
        "ownerType": 1,
        "maxLevel": 3
    }
}




请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是 application/x-www-form-urlencoded

返回数据

名称类型必须默认值备注
code
integer否
msg
string否
data
object否
ownerId
integer否用户id
accId
integer否财务账号id
loginType
integer否登陆类型
ownerType
integer否广告主类型

8.5 子客户余额查询

基本信息

Path： /v2/communal/owner/balance

Method： POST

接口描述：

SDK接入请求方法：

omniAds.adsAgency().V2OwnerBalance()

从账户或者直客 账务情况

{
    "code": 0,
    "data": {
        "accId": 800047248,
        "cashBal": 79081073,
        "cashLockBal": 0,
        "cashCost": 6400,
        "rebateBal": 0,
        "rebateCost": 0,
        "virBal": 0,
        "virCost": 0,
        "accDayBudget": 123412,
        "budgetType": 1,
        "accDayBudgetLimit": 20000,
        "totalBalance": 79081073
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是 application/x-www-form-urlencoded

返回数据

名称类型必须默认值备注
code
integer否
msg
string否
data
object否
accId
integer否财务ID
cashBal
integer否现金余额(分)
cashDayBudget
integer否现金账户日预算(分)
cashLockBal
integer否现金账户锁定余额(分)
cashCost
integer否现金账户消耗(分)
rebateDayBudget
integer否返货账户日预算(分)
rebateBal
integer否返货账户余额(分)
rebateCost
integer否返货账户消耗(分)
virBal
integer否虚拟账户金额(分)
virCost
integer否虚拟账号消耗(分)
accDayBudgetLimit
integer否账户日预算最低限制(分)
totalBalance
integer否总余额值: virBal[赠送余额] + rebateBal[返货余额] + cashBal[现金余额]
lastDayCost
integer否昨日消耗

8.6 客户日预算设置

基本信息

Path： /v2/communal/owner/setAccDayBudget

Method： POST

接口描述：

设置账户日预算(new)
SDK接入请求方法：

omniAds.adsOwner().v2CommunalOwnerSetAccDayBudget(accDayBudget,budgetType)

SDK请求参数：

Long accDayBudget 日预算
Integer budgetType 账户日预算类型，0：额度不限

请求参数示例：

accDayBudget=40000

响应示例

{
    "code": 0
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是 application/x-www-form-urlencoded

Query

参数名称 必须 示例 备注
accDayBudget 否 0 账户日预算设置，预算单位为分,
budgetType 否 0 如果为预算不限，设置budgetType=0

返回数据

名称类型必须默认值备注
code
integer否
msg
string否
data
null否

8.7 代理商余额查询接口

基本信息

Path： /v2/communal/agency/balance

Method： POST

接口描述：

代理商账务情况 - 包含总余额,各个子账户余额以及预算
SDK接入请求方法：

omniAds.adsAgency().V2AgencyBalance()

无请求参数：

响应示例：

{
    "code": 0,
    "data": {
        "accId": 800047321,
        "cashBal": 8899800,
        "cashLockBal": 0,
        "cashCost": 600,
        "rebateBal": 0,
        "rebateCost": 0,
        "virBal": 0,
        "virCost": 0,
        "accDayBudget": 0,
        "budgetType": 1,
        "totalBalance": 8899800
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是 application/x-www-form-urlencoded

返回数据

名称类型必须默认值备注
code
integer否
msg
string否
data
object否
accId
integer否财务ID
cashBal
integer否现金余额(分)
cashDayBudget
integer否现金账户日预算(分)
cashLockBal
integer否现金账户锁定余额(分)
cashCost
integer否现金账户消耗(分)
rebateDayBudget
integer否返货账户日预算(分)
rebateBal
integer否返货账户余额(分)
rebateCost
integer否返货账户消耗(分)
virBal
integer否虚拟账户金额(分)
virCost
integer否虚拟账号消耗(分)
accDayBudgetLimit
integer否账户日预算最低限制(分)
totalBalance
integer否总余额值: virBal[赠送余额] + rebateBal[返货余额] + cashBal[现金余额]
lastDayCost
integer否昨日消耗

8.8 获取当前登陆态代理商信息

基本信息

Path： /v2/communal/agency/info

Method： POST

接口描述：

代理商基础信息接口
无请求参数
SDK接入请求方法：

omniAds.adsAgency().V2AgencyInfo()

响应示例：

{
    "code": 0,
    "data": {
        "ownerId": 1100047448,
        "accId": 800047321,
        "loginType": 1,
        "ownerType": 0,
        "maxLevel": 3
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是 application/x-www-form-urlencoded

返回数据

名称类型必须默认值备注
code
integer否
msg
string否
data
object否
ownerId
integer否用户id
accId
integer否财务账号id
loginType
integer否登陆类型
ownerType
integer否广告主类型

8.9 账务流水导出

基本信息

Path： /v2/communal/finance/billHisExport

Method： POST

接口描述：

账务流水导出
SDK接入请求方法：

omniAds.adsAgency().V2FinanceBillHisExport(data, loginType);

SDK请求参数：

/**
 * 参数：
 * loginType  登陆类型，必传
 * AdsAccBillHisForm data
 * Integer subAcc    账户类型, 0:现金账户 1:返货账户 9999:赠送账户
 * Integer billSub   账务类型 , 100:充值  , 200:锁定 , 201:解锁 , 300:划账
 * Integer billType  流水类型, 0 : 存入  , 1 :  支出
 * Integer pOwnerType 财务流水对端账户的广告主类型， 0:代理商主 1:代理商从 2:oppo开发社区  3:广告主
 * Integer ownerId    从账号广告主ID(代理商可以用)
 * Long startTime
 * Long endTime
 *
 * */

请求示例
curl --location --request POST 'https://sapi-ads-test.wanyol.com/v2/communal/finance/billHisExport'
--header 'Authorization: Bearer MTEwMDA0NzM3NSx6ZW5nanVhbiwxNjI2OTE2MzYwLDc4YWU4NTYwZmRiMWRlZjZjMzQxMDUzZTZjZDM4Y2E1ZGJlOWNmNTM='
--header 'Content-Type: application/x-www-form-urlencoded'
--data-urlencode 'loginType=3'







响应为文件

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是 application/x-www-form-urlencoded

Query

参数名称 必须 示例 备注
startTime 否 0 查询开始时间
开始时间
endTime 否 0 查询结束时间
结束时间
ownerId 否 0 从账号广告主ID(代理商可以用)
客户广告主ID - 只有代理商可以使用
subAcc 否 0 账户类型, 0:现金账户 1:返货账户 9999:赠送账户
账户类型
billSub 否 0 账务类型 , 100:充值 , 200:锁定 , 201:解锁 , 300:划账
流水子类型 100:充值 , 200:锁定 , 201:解锁 , 300:划账
billType 否 0 流水类型, 0 : 存入 , 1 : 支出
账务类型 0 : 存入 , 1 : 支出
pOwnerType 否 0 财务流水对端账户的广告主类型， 0:代理商主 1:代理商从 2:oppo开发社区 3:广告主
loginType 是 0 登陆类型

返回数据

名称类型必须默认值备注
code
integer否
msg
string否
data
null否

9. 动态词包

9.1 获取有效动态词通配符

基本信息

Path： /v2/communal/dynamic/symbol/list

Method： POST

接口描述：

获取有效动态词通配符
SDK接入，请求方法：

omniAds.adsSearchKeyWord().getSymbolList(data)

SDK请求参数：

AdSearchPremiumKwQueryDTO data；
data.setXxx;

private Long adGroupId;

private Long packageId;

private Long ownerId;

private Long appId;

private String keyword;

private Set<Integer> auditStatusSet;   <span class="colour" style="color: rgb(17, 17, 18);">审核状态[0待审核 1审核通过 2审核不通过]</span>

private Set<Integer> sourceSet;   <span class="colour" style="color: rgb(17, 17, 18);">来源[1算法推荐 2商店推送 3运营添加 4广告主自定义 5临时添加]</span>

private Set<String> categories;

private Integer deleteFlag;

private String orderByColumn = "insert_time";

private int orderByType = 0;

private int callFlag = 0;

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是 application/x-www-form-urlencoded

Query

参数名称 必须 示例 备注
ownerId 否 广告主id
page 否 分页查询页数，非必填，默认1
pageCount 否 分页查询每页数量，非必填，默认500

返回数据

名称类型必须默认值备注
code
integer否
msg
string否
data
object否
totalCount
integer否数据总数
itemCount
integer否当前页数量
items
object []否当前数据
symbol
string否动态文案通配符
defaultWord
string否动态文案默认值
ownerId
integer否广告主id
statusFlag
integer否状态位 0：无效 1：有效
targetKey
string否标签类型

10. 素材相关

10.1 分页获取广告主素材

基本信息

Path： /v2/communal/material/pageList

Method： POST

接口描述：

此接口主要用于查询2.0素材，若要查询素材中心素材（即可用于投放的素材），可通过接口：/v3/creative/material/communal/query

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是 application/x-www-form-urlencoded

Query

参数名称 必须 示例 备注
ids 否 1,2,3 素材id集合,字段名称ids,逗号分隔
type 否 1 类型: 1:图片 2:视频
pageNum 是 1 页号，从1开始
pageSize 是 10 页容量，取值[1,500]

返回数据

名称类型必须默认值备注
code
integer否
msg
string否
data
object否
totalCount
integer否满足查询条件的数据总量
itemCount
integer否当前items集合的数据量
items
object []否
mId
integer否素材id
width
integer否宽
height
integer否高
type
integer否类型: 1:图片 2:视频
md5
string否素材md5
duration
integer否时长
materialUrl
string是素材URL

10.2 创意中心-统一上传接口

基本信息

Path： /v3/creative/material/communal/upload

Method： POST

接口描述：

素材上传方式包括新建创意和上传创意中心两种场景，本接口用于新建创意时上传素材的情况。
1. 新建创意场景：当前创意新建时直接上传，需要传入matSpecId参数，校验上传文件和matSpecId标示的规格是否匹配
2. 上传创意中心：目前暂不支持API上传，可先前往创意中心上传，然后新建创意时通过素材统一查询接口从创意中心查询素材id用于新建创意

请求示例:

files: @"/F:/4s.mp4"
matSpecId: 60

响应：

{
    "code": 0,
    "data": {
        "url": "[https://adsfs.heytapimage.com/ads-material-depot/video/1dfb03215c47bf738c82747cef8f930c.mp4](https://adsfs.heytapimage.com/ads-material-depot/video/1dfb03215c47bf738c82747cef8f930c.mp4)",
        "id": 43312306,
        "coverUrl": "[https://adsfs.heytapimage.com/ads-material-depot/video/1dfb03215c47bf738c82747cef8f930c_thumb.jpg](https://adsfs.heytapimage.com/ads-material-depot/video/1dfb03215c47bf738c82747cef8f930c_thumb.jpg)"
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type multipart/form-data 是

Body

参数名称 参数类型 必须 示例 备注
files 文件 是 支持文件格式限目前所有规格里的格式（jpg/jpeg/png/mp4）
matSpecId 文本 是 取自对应广告创意的规格id即globalSpecId字段
picType 文本 否 指示图片字段的名称，默认取全部图片类型。支持的取值包括：imgs(普通图片)/brandLogo(品牌logo)/videoImg(视频封面)/videoBgImg(视频结束背景图)

返回数据

名称类型必须默认值备注
code
string是0-成功 | 其他-失败
msg
string否失败时提示错误内容
data
object是具体数据
id
number是上传成功的素材id
url
string是上传成功的素材url

10.3 创意中心-素材统一查询接口

基本信息

Path： /v3/creative/material/communal/query

Method： GET

接口描述：

请求示例：

pageSize: 1
pageNum: 1
aspectRatios: 1:1
aspectRatios: 3:2
suffixes: png
suffixes: jpg

响应：

{
    "code": 0,
    "data": {
        "items": [
            {
                "id": 00000000,
                "ownerId": 00000000,
                "openMaterialId": "xxxxxxxxxx",
                "materialName": "xxxxxxxxx.jpg",
                "materialUrl": "https://adsfs.heytapimage.com/ads-material-depot/image/xxxxxx.jpg",
                "coverUrl": "",
                "width": 512,
                "height": 512,
                "type": 1,
                "suffix": "jpg",
                "uploadWay": 1,
                "size": 11704,
                "duration": 0,
                "md5": "xxxxxx",
                "extJson": "",
                "insertTime": 1625742540,
                "updateTime": 0,
                "deleteFlag": 0,
                "webpMd5": "",
                "webpMUrl": null,
                "compressedUrl": "",
                "compressedMd5": "",
                "compressedSize": 0
            }
        ],
        "totalCount": 500,
        "itemCount": 1
    }
}

请求参数

Query

参数名称 必须 示例 备注
id 否 素材id
materialName 否 素材名称，支持模糊查询
width 否 素材宽度
height 否 素材高度
aspectRatio 否 16:9 宽高比
aspectRatios 否 aspectRatios=1:1&aspectRatios=4:3 多个宽高比，按http协议的query数组形式传递，即拆分为多个键相同的键值对
size 否 1024768 素材大小，单位字节
duration 否 视频素材最大时长，单位秒
durationCeil 否 素材时长上限，单位秒
durationFloor 否 素材时长下限，单位秒
type 否 2 1-图片, 2-视频 默认查询全部
suffixes 否 suffixes=png&suffixes=jpeg 素材文件后缀名，按http协议的query数组形式传递
startUpdateTime 否 最早更新时间，10位(单位秒)unix时间戳，需要小于时间上限2037-12-31 23:59:59
endUpdateTime 否 最晚更新时间，10位(单位秒)unix时间戳，需要小于时间上限2037-12-31 23:59:59
pageNum 否 查询页码，默认1
pageSize 否 查询分页大小，默认10，最大1000

返回数据

名称类型必须默认值备注
code
number是0-成功 | 其他-失败
msg
string否失败时提示错误信息
data
object是
itemCount
number是返回结果数量
totalCount
number是符合当前查询条件的全部素材数量
items
object []是
id
number是
materialName
string是
materialUrl
string是
coverUrl
string否视频封面url
width
number是
height
number是
size
number是
duration
number否
type
number是
suffix
string是文件名后缀
uploadWay
number是
md5
string是
insertTime
number是
updateTime
number是
ownerId
number是

10.4 创意中心-上传素材到素材库

基本信息

Path： /v3/creative/material/communal/uploadDepot

Method： POST

接口描述：

请求示例:

file: @"/test.mp4"

响应示例:

{
    code: 0,
    data: {
       url: "[https://adsfs.heytapimage.com/ads-material-depot/video/xxxxxx.mp4](https://adsfs.heytapimage.com/ads-material-depot/video/xxxxxx.mp4)",
       "id": 43312306,
       coverUrl: "https://adsfs.heytapimage.com/ads-material-depot/video/xxxxxx.jpg"
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type multipart/form-data 是

Body

参数名称 参数类型 必须 示例 备注
file 文件 是 图片或视频文件，暂不支持互动素材

返回数据

名称类型必须默认值备注
code
number是
msg
string否
data
object否
id
number是
url
string是
coverUrl
string否

11. 规格相关

11.1 查询规格列表

基本信息

Path： /v3/communal/spec/list

Method： POST

接口描述：

根据条件查询获取规格列表
SDK接入，请求方法：

omniAds.adsCommunal().getSpec（data）

SDK请求参数：


AdsV3MtrSpecForm data;
data.setXxx;

private Integer extensionType;   推广类型1.链接推广 2.应用推广 3.快应用    不能为空

private Integer extensionFlow;   推广流量，详情见：广告组管理 -> 4.0广告组接口基础字段说明 不能为空

private Integer flowScene;       流量场景，详情见：广告组管理 -> 4.0广告组接口基础字段说明 不能为空

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是 application/x-www-form-urlencoded

Query

参数名称 必须 示例 备注
extensionType 是 0 推广类型
1.链接推广
2.应用推广
3.快应用
extensionFlow 是 0 推广流量，详情见：广告组管理 -> 4.0广告组接口基础字段说明
flowScene 是 0 流量场景，详情见：广告组管理 -> 4.0广告组接口基础字段说明

返回数据

名称类型必须默认值备注
code
integer否
msg
string否
data
object []否
mSpecName
string否规格名称
extensionType
integer否推广类型
flowScene
integer否流量场景
globalSpecId
integer否全局规格id
format
string否规格详情JSON字符串

一、外层字段： TitleFmt title;// 标题格式要求 DescFmt desc;// 描述格式要求 BdNameFmt bdName;// 品牌名称格式要求 List videoList;// 视频格式要求 List imgs;// 图片格式要求集合 List interactives; // 互动创意格式要求集合 boolean repeat = false; //是否多张图片 Integer minImgNum; //当repeat=true时表示限制最少minImgNum张imgs[0]指定的图片 Integer maxImgNum; //当repeat=true时表示限制最多maxImgNum张imgs[0]指定的图片 ImgFmt brandLogo; //品牌Logo图片. TitleFmt buttonTxt; //按钮文案. ImgFmt videoBgImg; //视频结束背景图. ImgFmt videoImg; //视频封面.

二、内层字段： TitleFmt: Integer len;// 字数限制 Boolean need;// 是否必填 Integer minLen; //字数最小值 Integer maxLen; //字数最大值

DescFmt: Integer len;// 字数限制 Boolean need;// 是否必填 Integer minLen; //字数最小值 Integer maxLen; //字数最大值

BdNameFmt: Integer len;// 字数限制 Boolean need;// 是否必填 Integer minLen; //字数最小值 Integer maxLen; //字数最大值

VideoFmt: Long maxDrt;// 最大时长，s Long minDrt;// 最小时长，s List whSc;// 视频宽高比集合(宽：高,如16:9) Integer w;// 视频宽 Integer h;// 视频高 Long s;// 视频大小 List fmt;// 视频文件格式集合

ImgFmt: Integer w;// 图片宽 Integer h;// 图片高 Float rate;// 图片宽高比(保留两位小数) List whSc;// 图片宽高比集合(宽：高,如16:9) Long s;// 图片大小 List fmt;// 图片文件格式集合 Integer titleNum; //标题字数限制 Integer subTitleNum; //副标题字数限制 Integer validateFlag; //校验标识 null、1：校验 2：不校验

InteractFmt: Integer w; //宽（图片型互动素材） Integer h ; // 高（图片型互动素材） List mode; // 互动模式集合 List type; // 互动zip包类型集合 List whSc; // 宽高比集合(宽:高,如16:9) Long s; //素材大小 List fmt; // 文件格式集合

示例： { "bdName":{"maxLen":8,"minLen":1}, "brandLogo":{"fmt":["jpg","png","jpeg"],"h":200,"s":100,"w":200}, "buttonTxt":{"maxLen":4,"minLen":1},"imgs":[],"repeat":false,"title":{"maxLen":23,"minLen":1}, "videoBgImg":{"fmt":["png","jpg","jpeg"],"h":1280,"s":150,"w":720}, "videoImg":{"fmt":["png","jpg","jpeg"],"h":720,"s":150,"w":1280}, "videoList":[{"fmt":["mp4"],"h":0,"maxDrt":60000,"minDrt":0,"s":25600,"w":0,"whSc":["16:9"]}], "interactives":[{"fmt":["zip"],"s":5120,"w":1080,"h":1920,"whSc":[]}] }

demoUrl
string否demoUrl
required
string否JSON格式字符串，指定当前规格下各元素传递必要性: 1-必传，2-选传。 注意：未出现的字段不能传 示例：{"videoList":1,"videoImg":1,"title":1,"bdName":1,"brandLogo":1,"interactives":2}

字段释义：
title - 广告文案
bdName - 品牌名称
videoList - 视频集合
imgs - 图片集合
brandLogo - 品牌Logo图片
buttonTxt - 按钮文案
videoBgImg - 视频结束背景图
videoImg - 视频封面
interactives - 互动素材集合

总结：
required 对当前规格下各元素的必填、选填做了要求，没有描述就不能传。
format 对当前规格下各元素的各种详细规范做了描述。
/v3/ad/batch接口参数是传递的具体元素

required字段 与 format外层字段 与 /v3/ad/batch接口参数 映射关系如下：
title -> title -> addList[0].copywriter
bdName -> bdName -> addList[0].brandName
videoList -> videoList -> addList[0].videoMatIds
imgs -> imgs -> addList[0].imgMatIds
brandLogo -> brandLogo -> addList[0].brandLogoImgId
buttonTxt -> buttonTxt -> addList[0].buttonTxt
videoBgImg -> videoBgImg -> addList[0].videoBgImgId
videoImg -> videoImg -> addList[0].videoImgId
interactives -> interactives -> addList[0].interactMatIds

12. 落地页相关

12.1 查询建站落地页

基本信息

Path： /v2/communal/ad/sparkPageNew/list

Method： POST

接口描述：

SDK接入，请求参数：

omniAds.adsCommunal().v2CommunalAdSparkPageNewList(data)

SDK请求参数：

AdsAdPageForm data；
data.setXxx;

private String pageId; 落地页id

private String pageUrl; 落地页url与 pageType 不能同时为空

/**


    

  • 建站类型
    • 

  • 与 pageUrl 不能同时为空
    • 

  • <p>
    • 

  • 0-自定义落地页
    • 

  • 1-一叶智能
    • 

  • 2-云脑建站
    • 

  • 4-萤火虫建站
    • 

  • 5-快应用建站
    • 

  • 6-广告主自建页面 JS SDK
    • 

  • 7-广告主自建页面 H5 API 回传
    • 

  • 8-信息流 线索直达
    • 

  • 9-商店详情页
    • 

  • 11-萤火虫应用模板下载页
    • 

  • 12-互动落地页
    • 

  • 



/

private Integer pageType;

/*


    

  • 应用id
    • 

  • <p>
    • 

  • 适用于应用推广场景，起校验作用，传入appId参数确保只返回该应用的落地页
    • 

  • 不能单独使用，需要与pageType、pageUrl配合使用
    
*/
    
private String appId;

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是 application/x-www-form-urlencoded

Query

参数名称 必须 示例 备注
pageUrl 否 落地页url
与 pageType 不能同时为空
pageType 否 0 建站类型
与 pageUrl 不能同时为空


0-自定义落地页
1-一叶智能
2-云脑建站
4-萤火虫建站
5-快应用建站
6-广告主自建页面 JS SDK
7-广告主自建页面 H5 API 回传
8-信息流 线索直达
9-商店详情页
11-萤火虫应用模板下载页
12-互动落地页
appId 否 应用id


适用于应用推广场景，起校验作用，传入appId参数确保只返回该应用的落地页
不能单独使用，需要与pageType、pageUrl配合使用

返回数据

名称类型必须默认值备注
code
integer否
msg
string否
data
object []否
pageId
string否落地页id
pageUrl
string否落地页url
pageName
string否落地页名称
pageType
integer否建站类型
ocpcType
integer否转化类型 6-线索提交
targetType
integer否标的物类型 1-链接推广 2-应用推广 3-快应用 4-电商
appId
string否应用id

12.2 获取模板列表

基本信息

Path： /v3/communal/h5Template/list

Method： POST

接口描述：

SDK接入，请求方法：

omniAds.adsMaterial().v3CommunalH5Template(data)

SDK请求参数：

AdsV3H5TemplateForm data;
data.setXxx;

/**


    

  • 推广流量
    • 

  • 推广流量为“全流量场景”时，会忽略流量场景
    • 

  • <p>
    • 

  • 1.全流量场景
    • 

  • 2.自有流量
    • 

  • 3.联盟流量
    • 

  • 



/

private Integer extensionFlow;

/*


    

  • 流量场景
    • 

  • 推广流量不是“全流量场景”时生效，不能为空
    • 

  • <p>
    • 

  • 1.全流量场景
    • 

  • 2.精选推广
    • 

  • 3.安装有礼
    • 

  • 4.开机必备
    • 

  • 5.搜索
    • 

  • 6.信息流
    • 

  • 7.banner
    • 

  • 8.开屏
    • 

  • 9.插屏
    • 

  • 10.原生
    • 

  • 11.激励视频
    • 

  • 12.通投类型
    • 

  • 20.品牌
    • 

  • 



*/

private Integer flowScene;


/**


    

  • 模板ID
    • 

  • <p>
    • 

  • 需要加extensionFlow、flowScene同时筛选
    
*/
    
private Integer tid;

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是 application/x-www-form-urlencoded

Query

参数名称 必须 示例 备注
extensionFlow 否 0 推广流量
推广流量为“全流量场景”时，会忽略流量场景


1.全流量场景
2.自有流量
3.联盟流量
flowScene 否 0 流量场景
推广流量不是“全流量场景”时生效，不能为空


1.全流量场景
2.精选推广
3.安装有礼
4.开机必备
5.搜索
6.信息流
7.banner
8.开屏
9.插屏
10.原生
11.激励视频
12.通投类型
20.品牌
tid 否 0 模板ID


需要加extensionFlow、flowScene同时筛选

返回数据

名称类型必须默认值备注
code
integer否
msg
string否
data
object []否
h5Id
integer否模板ID
h5Name
string否模板名称
bizId
integer否业务ID
bizAdSource
string否业务内部广告来源

contract feeds general oppo_adx oppo_cpd union_advert

h5Url
string否模板地址
demoUrl
string否模板demo地址
ext
string否扩展字段
insertTime
integer否新增时间
updateTime
integer否更新时间
delFlag
integer否删除标识 0:正常 1:删除

13. 定向相关接口

13.1 人群包/定向包创建操作指引流程

一、在广告组中使用含人群属性的定向包进行定向投放流程图：
 投放流程.png 
二、人群包创建
1、人群包释义：
人群包为定向包的一种特殊类型；
同时，普通的定向包中可以引用状态为【可使用】的人群包作为其定向属性。
2、具体创建流程
2.png
a.使用/v2/communal/target/imei/upload接口上传人群包文件，具体所需参数参考接口文档。
b.上传文件成功后，获取接口返回字段：audience-人群包地址；audienceCount-人群包受众数量，作为创建人群包时的必填请求参数。
c.使用/v2/communal/target/add接口创建人群包，具体所需参数参考接口文档。
由于该接口既可以创建人群包，也可以创建定向包，故通过type字段区分创建普通定向包或是不同类型的人群包。
image.png
d.由于imei人群包、OAID包中包含不同的类型，使用imeiType来区分人群包类型，该字段必传(具体类型枚举见下图)；
示例：如上传的人群包类型为imei-MD5包
传参：type=2; imeiType=1 (注：还需补全接口文档中其他必填参数)
image.png
e.人群包创建成功后会返回人群包ID（也是定向包ID，targetId）
注：完成人群包创建后，该人群包才可在营销平台前端展示，只上传文件未创建人群包时不会展示。
三、定向包创建、绑定广告组
1、创建含有人群包的定向包
由于广告组只能绑定普通类型的定向包，所以需要将人群包绑定定向包后再绑定广告组进行投放。
4.png
 
使用/v2/communal/target/add接口创建定向包
pTargetId参数传入可使用的人群包ID，引用该人群（由人群包接口创建成功后返回）
oppAudienceId传入可使用的人群包ID，排除该人群
创建成功后会返回定向包ID
注：定向包只能引用状态为【可使用】的人群包，如上传imei人群包需等待校验后方可使用；引用的人群包和排除的人群包不能为同一个人群包
2、创建广告组，绑定已创建的定向包即可进行定向投放

13.2 创建定向

基本信息

Path： /v2/communal/target/add

Method： POST

接口描述：

SDK接入，请求方法：

 omniAds.adsTarget().v2CommunalTargetAdd(data)

SDK接入，请求参数：


AdsTargetVo data；
data.setXxx;

private Long targetId; // 定向编号


private Long openTargetId; // 第三方定向编号


private String openV2TargetId; // 第三方定向id


private String ownerId; // 广告主


@NotNull(groups = {Groups.Edit.class, Groups.Add.class})@Size(min = 0, max = 30, groups = {Groups.Edit.class, Groups.Add.class})

@Pattern(groups = {Groups.Add.class,

Groups.Edit.class}, regexp = "(^[A-Za-z0-9\u4e00-\u9fa5！@#￥%……~|!@#$^《》？ ，。：；【】”“（）——\[\]、{}·&()-_+=,.;:'"<>/]$)|(^$)")private String targetName; // 定向名称


@NotNull(groups = {Groups.Edit.class, Groups.Add.class})@Size(min = 0, max = 300, groups = {Groups.Edit.class, Groups.Add.class})

@Pattern(groups = {Groups.Add.class,

Groups.Edit.class}, regexp = "(^[A-Za-z0-9\u4e00-\u9fa5！@#￥%……~|!@#$^《》？，。：；【】”“（）——\[\]、{}·&()-_+=,.;:'"<>/]$)|(^$)")private String targetDesc; // 定向描述


@Range(min = 0, max = 1, groups = {Groups.Edit.class})private int delStatus; // 删除状态：0, 正常；1,删除.


private Integer createTime; // 创建时间


private Integer updateTime; // 修改时间


@Pattern(groups = {Groups.Add.class, Groups.Edit.class, Groups.Query.class}, regexp = "^\d{1,5}(?:,\d{1,5}){0,500}|(^$)")private String region;// 地域


@Pattern(groups = {Groups.Add.class, Groups.Edit.class, Groups.Query.class}, regexp = "^\d{1,5}(?:,\d{1,5}){0,500}|(^$)")private String brandRegion;// 品牌当前地定向


@Pattern(groups = {Groups.Add.class, Groups.Edit.class}, regexp = "^\d+(,\d+)*|(^$)")private String appCatActive;// app分类活跃


@Pattern(groups = {Groups.Add.class, Groups.Edit.class}, regexp = "^-?\d+(,-?\d+)*|(^$)")private String mobileModel;// 机型


@Pattern(groups = {Groups.Add.class, Groups.Edit.class, Groups.Query.class}, regexp = "[0-2]|999|(^$)")private String sex;// 性别


@Pattern(groups = {Groups.Add.class, Groups.Edit.class, Groups.Query.class}, regexp = "^([0-6][,])*[0-6]|999|(^$)")private String age;// 年龄段


@Pattern(groups = {Groups.Add.class,

Groups.Edit.class}, regexp = "^((WIFI|2G|3G|4G|5G|999)[,])*(WIFI|2G|3G|4G|5G|999)$|(^$)")private String network;// 网络


@Pattern(groups = {Groups.Add.class, Groups.Edit.class}, regexp = "^([1-4][,])*[1-4]|999|(^$)")private String mobilePrice;// 机型价格


@Pattern(groups = {Groups.Add.class, Groups.Edit.class}, regexp = "^\d+(,\d+)*|(^$)")private String installAppList;// 应用已安装


@Pattern(groups = {Groups.Add.class, Groups.Edit.class}, regexp = "^\d+(,\d+)*|(^$)")private String preInstallAppList;// 应用预安装


@Pattern(groups = {Groups.Add.class, Groups.Edit.class}, regexp = "^\d+(,\d+)*|(^$)")private String unPreInstallAppList;// 应用非预安装


@Pattern(groups = {Groups.Add.class, Groups.Edit.class}, regexp = "^\d+(,\d+)*|(^$)")private String notInstallAppList;// 应用未安装


@Pattern(groups = {Groups.Add.class, Groups.Edit.class}, regexp = "^\d{1,6}(?:,\d{1,6}){0,500}|(^$)")private String permanentRegion;// 常驻地


@Pattern(groups = {Groups.Add.class, Groups.Edit.class}, regexp = "^\d+(,\d+)(\|\d+)|(^$)")private String appActive;// 应用活跃


@Pattern(groups = {Groups.Add.class, Groups.Edit.class}, regexp = "^\d+(,\d+)(\|\d+)|(^$)")private String appNotActive;// 应用非活跃


@Pattern(groups = {Groups.Add.class, Groups.Edit.class, Groups.Query.class}, regexp = "^\d+(,\d+)*|(^$)")private String interestTags;// 兴趣标签


@Pattern(groups = {Groups.Add.class, Groups.Edit.class, Groups.Query.class}, regexp = "^\d+(,\d+)*|(^$)")private String interestTagsV2;// 兴趣标签新版本


@Pattern(groups = {Groups.Add.class, Groups.Edit.class, Groups.Query.class}, regexp = "^\d+(,\d+)*|(^$)")private String tagsSystemRecommend;// 标签系统推荐


@Pattern(groups = {Groups.Add.class, Groups.Edit.class}, regexp = "^\d+(,\d+)|^(([A-Za-z0-9])+:[0-9])(,([A-Za-z0-9])+:[0-9])|(^$)")private String unionAppId;// 联盟AppId


@Pattern(groups = {Groups.Add.class, Groups.Edit.class}, regexp = "^\d+(,\d+)|^(([A-Za-z0-9])+:[0-9])(,([A-Za-z0-9])+:[0-9])|(^$)")private String unionAppIdRe;// 联盟App反向


@Pattern(groups = {Groups.Add.class, Groups.Edit.class}, regexp = "^\d+(,\d+)*|(^$)")private String flowAppCatActive;// 流量类别

@Min(value = 0, groups = {Groups.Add.class, Groups.Edit.class})@Max(value = 1, groups = {Groups.Add.class, Groups.Edit.class})

private int immutable;// 是否可以修改.默认0-可修改

@Min(groups = {Groups.Add.class, Groups.Edit.class}, value = 1)@Max(groups = {Groups.Add.class, Groups.Edit.class}, value = 12)

private int type;// 定向类型,参考-TargetTypeEnum


private String audience;// 人群定向属性


private String oppAudience;//逆向定向人群(排除)


private Long pTargetId;// 父类定向id，继承该父类的定向属性.


private Long oppAudienceId;//逆向定向人群(排除)ID


private Integer appActiveDays;// 应用活跃天数.


private Integer appNotActiveDays;// 应用非活跃天数.


private Long audienceCount;// 人群包受众数量

@Min(groups = {Groups.Add.class, Groups.Edit.class}, value = 1)@Max(groups = {Groups.Add.class, Groups.Edit.class}, value = 2)

private Integer version;// 1-原始版本.2-V2


private Integer lookalikeTaskId;// lookalike任务ID.


private Integer deleteSeed;// 删除种子包.0-不删除.1-删除.


private Integer expansionStatus;// 拓展状态.0-默认.1-待拓展.2-拓展中.3-拓展完成.4-拓展失败


private Long expansionCount;// 拓展数量.

@Length(max = 64)private String seedFileName;// imei原文件名.


private Integer showStatus;// 展示状态.1-可使用,2-拓展中,3-拓展异常,4-已删除


private String longitude;// 经度


private String latitude;// 纬度


private Long radius;// 半径.

private String locationName;// 地点名称.

private String address;// 地址

private String mapLocations;// 地图点

@Range(groups = {Groups.Add.class}, max = 6, min = 0)private Integer imeiType; // imei类型

private String yesterdayInstalledApp;// 前一天已安装

private Long sizeLimit;//人群包大小限制


@Pattern(groups = {Groups.Add.class, Groups.Edit.class}, regexp = "^[A-Z]{2}(?:,[A-Z]{2}){0,500}|999|(^$)")private String countryOrRegion;// 国家或地区

@Pattern(groups = {Groups.Add.class, Groups.Edit.class}, regexp = "^\d{1,3}(?:,\d{1,3}){0,10}|(^$)")private String weatherCode;//天气定向：限制10种天气类型


@Pattern(groups = {Groups.Add.class, Groups.Edit.class}, regexp = "^\d+(,\d+)*|(^$)")private String instantInstallList;// 快应用已添加


@Pattern(groups = {Groups.Add.class, Groups.Edit.class}, regexp = "^\d+(,\d+)*|(^$)")private String instantNotInstallList;// 快应用未添加


/**


    

  • 种子ID列表
    
/
    
@Pattern(groups = {Groups.Add.class}, regexp = "^\d+(,\d+)    |(^$)")private String seedIdList;
    
/**
    • 

  • 扩展人群类型：1lookalike 2MD5校验 3人群交集 4人群并集 5 效果人群
    
/
    
@Min(groups = {Groups.Add.class}, value = 1)@Max(groups = {Groups.Add.class}, value = 12)
    
private Integer taskType;
    
/    *
    • 

  • APP已安装未激活列表
    
/
    
@Pattern(groups = {Groups.Add.class, Groups.Edit.class}, regexp = "^\d+(,\d+)    |(^$)")private String installedNeverActiveAppList;
    • 



/**


    

  • 是否过滤已转化的广告:1广告2广告组3广告计划4广告主5公司主体
    
*/
    
@Pattern(groups = {Groups.Add.class, Groups.Edit.class}, regexp = "999|[1-6]")private String filterConvertedAd;
    • 



/**


    

  • 过滤已转化广告的过滤时间
    • 

  • 0-当天
    • 

  • 7-7天
    • 

  • 30-一个月
    • 

  • 90-3个月
    • 

  • 180-6个月
    
*/
    
@Range(groups = {Groups.Add.class}, max = 180)private Integer filterConvertedAdDays = 0;
    • 



/**


    

  • 应用未安装天数,0历史未安装
    
*/
    
@Range(groups = {Groups.Add.class}, max = 365)private Integer appUninstallDays = 0;
    • 



/**


    

  • 用户画像类型：
    
*/
    
private Integer portraitStatus;
    • 



/**


    

  • 用户画像更新时间
    
*/
    
private Integer portraitUpdateTime;
    • 



/**


    

  • 联盟流量包
    
/
    
@Length(groups = {Groups.Add.class, Groups.Edit.class}, max = 4500, message = "流量包定向条件超过最大限制")@Pattern(groups = {Groups.Add.class, Groups.Edit.class}, regexp = "999|^(([A-Za-z0-9])+([A-Za-z0-9]+){3})(,([A-Za-z0-9])+([A-Za-z0-9]+){3})    |(^$)")
    
private String unionMediaFlag;
    • 



/**


    

  • 联盟流量标签
    
/
    
@Length(groups = {Groups.Add.class, Groups.Edit.class}, max = 4500, message = "流量标签超过最大限制")@Pattern(groups = {Groups.Add.class, Groups.Edit.class}, regexp = "^\d+(,\d+)    |(^$)", message = "流量标签数据格式不正确")
    
private String unionMediaTag;
    • 



/**


    

  • 关键词天数
    
*/
    
@Range(groups = {Groups.Add.class}, max = 180)private Integer keyWordDay;
    • 



/**


    

  • 行为类型:1 搜索,2 浏览
    
/
    
@Pattern(groups = {Groups.Add.class}, regexp = "^\d+(,\d+)    |(^$)")private String behaviorType;
    • 



/**


    

  • 应用id
    
*/
    
private Long appId;
    • 



/**


    

  • 计划id
    
*/
    
private Long planId;
    • 



/**


    

  • 渠道id: 1:cpd，2:feeds, 3:lm
    
*/
    
private Integer chnId;
    • 



/**


    

  • 标签系统推荐状态：0:默认值，1:更新成功，2:更新失败，3:已失效
    
*/
    
private Integer recommendStatusType;
    • 



/**


    

  • 标签id结果
    
*/
    
private String resultTagIds;
    • 



/**


    

  • 推荐策略类型，默认值为0（该字段的枚举值由标签侧确定）
    
*/
    
private Integer recommendType;
    • 



/**


    

  • 标签系统推荐id
    
/
    
private Long recommendId;
    
/    *
    • 

  • App推荐埋点数据
    
/
    
private String appActiveAndRecType;
    
/    *
    • 

  • App推荐埋点数据
    
*/
    
private String appNotActiveAndRecType;
    • 



/**


    

  • 来源
    
*/
    
private Integer source;
    • 



/**


    

  • 是否可授权， 1.可授权 0.不可授权
    
*/
    
private Integer canShare;
    • 



/**


    

  • 推广应用安装
    • 

  • 999=不限
    • 

  • 1=已安装该应用
    
*/
    
@Pattern(groups = {Groups.Add.class, Groups.Edit.class}, regexp = "^(999)|1$", message = "推广应用安装不在可选范围内")private String promoteAppInstall;
    • 



/**


    

  • 推广应用安装-未安装应用
    • 

  • 0=0
    • 

  • 7=7天
    • 

  • 15=15天
    • 

  • 30=30天
    • 

  • 90=90天
    • 

  • 180=180天
    
*/
    
@Pattern(groups = {Groups.Add.class, Groups.Edit.class}, regexp = "^(999)|0|7|(15)|(30)|(90)|(180)$", message = "推广应用安装不在可选范围内")private String promoteAppNotInstalled;
    • 



/**


    

  • 推广应用启动-当日未启动
    • 

  • 999=不限
    • 

  • 1=当日未启动
    
*/
    
@Pattern(groups = {Groups.Add.class, Groups.Edit.class}, regexp = "^(999)|1$", message = "推广应用启动不在可选范围")private String promoteAppStartTodayNotStart;
    • 



/**


    

  • OPPO有数人群包id
    • 

  • 999=无
    
*/
    
private String openDataAudience;
    • 



/**


    

  • OPPO有数人群包id（排除）
    • 

  • 999=无
    
*/
    
private String oppOpenDataAudience;

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是 application/x-www-form-urlencoded

Query

参数名称 必须 示例 备注
ownerId 否 子账户ID
直客和子客户非必填；代理商使用必填，用于指定查询某个子客户
targetName 是 定向名称
targetDesc 是 定向描述
delStatus 否 0 删除状态：0, 正常；1,删除.
region 否 地域,通过元数据接口获取
mobileModel 否 机型,通过元数据接口获取
sex 否 性别：
1:女
2:男
age 否 年龄：
1:<18
2:18-24
3:25-29
4:30-34
5:35~49
6:>=50
network 否 网络：
WIFI:wifi
2G:2G
3G:3G
4G:4G
5G:5G
installAppList 否 应用已安装，通过定向APP元数据接口获取
preInstallAppList 否 应用预安装，通过定向APP元数据接口获取
unPreInstallAppList 否 应用非预安装，通过定向APP元数据接口获取
notInstallAppList 否 应用未安装，通过定向APP元数据接口获取
permanentRegion 否 常驻地,通过元数据接口获取
appActive 否 应用活跃.appId逗号分隔，通过定向APP元数据接口获取
在不限情况底下-传递999.
appNotActive 否 应用非活跃，通过定向APP元数据接口获取
在不限情况底下-传递999.
interestTagsV2 否 兴趣标签新版本，通过兴趣接口获取
unionAppId 否 联盟AppId 【联盟专用】
参数构造方式：
调用定向联盟App元数据接口获取应用列表，根据${id1}:${platform1},${id2}:${platform},
如：160:0,180:0
unionAppIdRe 否 联盟App反向【联盟专用】
参数构造方式：同上
immutable 是 0 0:另存为的定向(可编辑定向)
1:创建不可编辑定向(无法编辑的定向)
type 是 0 定向类型
1:普通定向包
2:IMEI人群定向包
6:电话包
11:OAID
audience 否 人群定向
pTargetId 否 0 引用人群定向,需要传递人群定向包的ID过来
oppAudienceId 否 0 排除人群包ID
appActiveDays 否 0 应用活跃天数
appNotActiveDays 否 0 应用非活跃天数
audienceCount 否 0 人群包受众数量
imeiType 否 0 imei类型
0:imei明文
1:IMEI-MD5
2:手机号码
3:OAID明文
4:OAID-MD5
yesterdayInstalledApp 否 前一天已安装，通过定向APP元数据接口获取
weatherCode 否 天气，通过元数据接口获取
installedNeverActiveAppList 否 应用已安装未激活，通过定向APP元数据接口获取
filterConvertedAd 否 屏蔽已转化用户
1广告2广告组3广告计划4广告主
appUninstallDays 否 0 应用历史未安装天数
与应用从未安装配合使用，最大值为365。
对应于营销平台中未安装时段选择。
neverInstallAppList 否 应用从未安装，通过定向APP元数据接口获取

返回数据

名称类型必须默认值备注
code
integer否
msg
string否
data
object否
targetId
integer是定向编号
ownerId
string否子账户ID 直客和子客户非必填；代理商使用必填，用于指定查询某个子客户
targetName
string是定向名称
targetDesc
string是定向描述
delStatus
integer否删除状态：0, 正常；1,删除.
region
string否地域
mobileModel
string否机型
sex
string否性别： 1:女 2:男
age
string否年龄： 1:<18 2:18-24 3:25-29 4:30-34 5:35~49 6:>=50
network
string否网络： WIFI:wifi 2G:2G 3G:3G 4G:4G 5G:5G
installAppList
string否应用已安装.调用应用APP接口
preInstallAppList
string否应用预安装.调用应用APP接口
unPreInstallAppList
string否应用非预安装.调用应用APP接口
notInstallAppList
string否应用未安装.调用应用APP接口
permanentRegion
string否常驻地
appActive
string否应用活跃.appId逗号分隔。 在不限情况底下-传递999.
appNotActive
string否应用非活跃. 在不限情况底下-传递999.
interestTagsV2
string否兴趣标签新版本
unionAppId
string否联盟AppId
unionAppIdRe
string否联盟App反向
immutable
integer是0:另存为的定向(可编辑定向) 1:创建不可编辑定向(无法编辑的定向)
type
integer是定向类型1:普通定向包2:IMEI人群定向包 6:电话包 11:OAID
audience
string否人群定向
pTargetId
integer否引用人群定向,需要传递人群定向包的ID过来
oppAudienceId
integer否排除人群包ID
appActiveDays
integer否应用活跃天数
appNotActiveDays
integer否应用非活跃天数
audienceCount
integer否人群包受众数量
imeiType
integer否imei类型0:IMEI1:IMEI-MD52:电话包（默认为0）3:OAID明文 4:OAID-MD5
yesterdayInstalledApp
string否前一天已安装
weatherCode
string否天气
installedNeverActiveAppList
string否应用已安装未激活
filterConvertedAd
string否屏蔽已转化用户2广告组3广告计划4广告主5-公司主体6-APP
filterConvertedAdDays
number否屏蔽已转化用户的过滤时间（只有公司主体和APP维度会需要通过时间进行过滤），最大为180天
appUninstallDays
integer否0应用历史未安装天数 与应用从未安装配合使用，最大值为365。 对应于营销平台中未安装时段选择。
neverInstallAppList
string否应用从未安装.

13.3 获取定向详情

基本信息

Path： /v2/communal/target/get

Method： GET

接口描述：

SDK接入，请求方法：

omniAds.adsTarget.v2CommunalTargetGet

SDK请求参数：

AdsTargetForm data；
data.setXxx;

private Long id; // 定向id

private Integer delStatus; // 删除标识

private Integer bizType; // 展示类型:信息流,品牌,联盟

private String openV2TargetId; // 外部定向id

请求参数

Query

参数名称 必须 示例 备注
id 是 0 定向id
delStatus 否 0 删除标识
0:未删除
1:删除
ownerId 否 子账户ID
直客和子客户非必填；代理商使用必填，用于指定查询某个子客户

返回数据

名称类型必须默认值备注
code
integer否
msg
string否
data
object否
targetId
integer是定向编号
ownerId
string否子账户ID 直客和子客户非必填；代理商使用必填，用于指定查询某个子客户
targetName
string是定向名称
targetDesc
string是定向描述
delStatus
integer否删除状态：0, 正常；1,删除.
region
string否地域
mobileModel
string否机型
sex
string否性别： 1:女 2:男
age
string否年龄： 1:<18 2:18-24 3:25-29 4:30-34 5:35~49 6:>=50
network
string否网络： WIFI:wifi 2G:2G 3G:3G 4G:4G 5G:5G
mobilePrice
string否机型价格： 1:0-1000 2:1000-1999 3:2000-2999 3:>3000
installAppList
string否应用已安装
preInstallAppList
string否应用预安装
unPreInstallAppList
string否应用非预安装
notInstallAppList
string否应用未安装
permanentRegion
string否常驻地
appActive
string否应用活跃.appId逗号分隔。 在不限情况底下-传递999.
appNotActive
string否应用非活跃. 在不限情况底下-传递999.
interestTagsV2
string否兴趣标签新版本
unionAppId
string否联盟AppId
unionAppIdRe
string否联盟App反向
immutable
integer是0:另存为的定向(可编辑定向) 1:创建不可编辑定向(无法编辑的定向)
type
integer是定向类型1:普通定向包2:IMEI人群定向包 6:电话包 11:OAID
audience
string否人群定向
pTargetId
integer否引用人群定向,需要传递人群定向包的ID过来
oppAudienceId
integer否排除人群包ID
appActiveDays
integer否应用活跃天数
appNotActiveDays
integer否应用非活跃天数
audienceCount
integer否人群包受众数量
imeiType
integer否imei类型0:IMEI1:IMEI-MD52:电话包（默认为0）3:OAID明文 4:OAID-MD5
yesterdayInstalledApp
string否前一天已安装
weatherCode
string否天气
installedNeverActiveAppList
string否应用已安装未激活
filterConvertedAd
string否屏蔽已转化用户 1广告2广告组3广告计划4广告主
appUninstallDays
integer否0应用历史未安装天数 与应用从未安装配合使用，最大值为365。 对应于营销平台中未安装时段选择。
neverInstallAppList
string否应用从未安装.

13.4 删除定向

基本信息

Path： /v2/communal/target/del

Method： GET

接口描述：

SDK接入，请求方法：

omniAds.adsTarget.v2CommunalTargetDel

SDK接入请求参数：

AdsTargetForm data；
data.setXxx;

private Long id; // 定向id

private Integer delStatus; // 删除标识

private Integer bizType; // 展示类型:信息流,品牌,联盟

private String openV2TargetId; // 外部定向id

请求参数

Query

参数名称 必须 示例 备注
id 是 0 定向id
ownerId 否 子账户ID
直客和子客户非必填；代理商使用必填，用于指定查询某个子客户

返回数据

名称类型必须默认值备注
code
integer否
msg
string否
data
integer否

13.5 更新定向

基本信息

Path： /v2/communal/target/update

Method： POST

接口描述：

SDK接入，请求方法：

omniAds.adsTargrt().v2CommunalTargetUpdate(data)

SDK请求参数：

AdsTargetVo data;
data.setXxx;

private Long targetId; // 定向编号

private Long openTargetId; // 第三方定向编号

private String openV2TargetId; // 第三方定向id

private String ownerId; // 广告主

private String targetName; // 定向名称   不能为空

private String targetDesc; // 定向描述   不能为空

private int delStatus; // 删除状态：0, 正常；1,删除.

private Integer createTime; // 创建时间

private Integer updateTime; // 修改时间

private String brandRegion;// 品牌当前地定向

private String sex;// 性别

private String age;// 年龄段

private String interestTags;// 兴趣标签

private String unionAppId;// 联盟AppId

private Integer taskType;  扩展人群类型：1lookalike 2MD5校验 3人群交集 4人群并集 5 效果人群

private String filterConvertedAd;  是否过滤已转化的广告:1广告2广告组3广告计划4广告主

private Long appId;  应用id

private Long planId; 计划id

private Integer chnId; 渠道id: 1:cpd，2:feeds, 3:lm

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
targetId 是 0 定向编号
ownerId 是 子账户ID
直客和子客户非必填；代理商使用必填，用于指定查询某个子客户
targetName 是 定向名称
targetDesc 是 定向描述
region 否 地域,通过元数据接口获取
mobileModel 否 机型,通过元数据接口获取
sex 否 性别：
1:女
2:男
age 否 年龄：
1:<18
2:18-24
3:25-29
4:30-34
5:35~49
6:>=50
network 否 网络：
WIFI:wifi
2G:2G
3G:3G
4G:4G
5G:5G
installAppList 否 应用已安装，通过定向APP元数据接口获取
preInstallAppList 否 应用预安装，通过定向APP元数据接口获取
unPreInstallAppList 否 应用非预安装，通过定向APP元数据接口获取
notInstallAppList 否 应用未安装，通过定向APP元数据接口获取
permanentRegion 否 常驻地,通过元数据接口获取
appActive 否 应用活跃.appId逗号分隔，通过定向APP元数据接口获取
在不限情况底下-传递999.
appNotActive 否 应用非活跃，通过定向APP元数据接口获取
在不限情况底下-传递999.
interestTagsV2 否 兴趣标签新版本，通过兴趣接口获取
unionAppId 否 联盟AppId
参数构造方式：
调用定向联盟App元数据接口获取应用列表，根据${id1}:${platform1},${id2}:${platform},
如：160:0,180:0
unionAppIdRe 否 联盟App反向
参数构造方式：同上
immutable 是 0 0:另存为的定向(可编辑定向)
1:创建不可编辑定向(无法编辑的定向)
type 是 0 定向类型
1:普通定向包
2:IMEI人群定向包
6:电话包
11:OAID
audience 否 人群定向
pTargetId 否 0 引用人群定向,需要传递人群定向包的ID过来
oppAudienceId 否 0 排除人群包ID
appActiveDays 否 0 应用活跃天数
appNotActiveDays 否 0 应用非活跃天数
audienceCount 否 0 人群包受众数量
imeiType 否 0 0:imei明文
1:IMEI-MD5
2:手机号码
3:OAID明文
4:OAID-MD5
yesterdayInstalledApp 否 前一天已安装，通过定向APP元数据接口获取
weatherCode 否 天气，通过元数据接口获取
installedNeverActiveAppList 否 应用已安装未激活，通过定向APP元数据接口获取
filterConvertedAd 否 屏蔽已转化用户
1广告2广告组3广告计划4广告主
appUninstallDays 否 0 应用历史未安装天数
与应用从未安装配合使用，最大值为365。
对应于营销平台中未安装时段选择。
neverInstallAppList 否 应用从未安装，通过定向APP元数据接口获取

返回数据

名称类型必须默认值备注
code
integer否
msg
string否
data
object否
targetId
integer是定向编号
ownerId
string否子账户ID 直客和子客户非必填；代理商使用必填，用于指定查询某个子客户
targetName
string是定向名称
targetDesc
string是定向描述
delStatus
integer否删除状态：0, 正常；1,删除.
region
string否地域
mobileModel
string否机型
sex
string否性别： 1:女 2:男
age
string否年龄： 1:<18 2:18-24 3:25-29 4:30-34 5:35~49 6:>=50
network
string否网络： WIFI:wifi 2G:2G 3G:3G 4G:4G 5G:5G
installAppList
string否应用已安装
preInstallAppList
string否应用预安装
unPreInstallAppList
string否应用非预安装
notInstallAppList
string否应用未安装
permanentRegion
string否常驻地
appActive
string否应用活跃.appId逗号分隔。 在不限情况底下-传递999.
appNotActive
string否应用非活跃. 在不限情况底下-传递999.
interestTagsV2
string否兴趣标签新版本
unionAppId
string否联盟AppId
unionAppIdRe
string否联盟App反向
immutable
integer是0:另存为的定向(可编辑定向) 1:创建不可编辑定向(无法编辑的定向)
type
integer是定向类型1:普通定向包2:IMEI人群定向包 6:电话包 11:OAID
audience
string否人群定向
pTargetId
integer否引用人群定向,需要传递人群定向包的ID过来
oppAudienceId
integer否排除人群包ID
appActiveDays
integer否应用活跃天数
appNotActiveDays
integer否应用非活跃天数
audienceCount
integer否人群包受众数量
imeiType
integer否imei类型0:IMEI1:IMEI-MD52:电话包（默认为0）3:OAID明文 4:OAID-MD5
yesterdayInstalledApp
string否前一天已安装
weatherCode
string否天气，通过元数据接口获取
installedNeverActiveAppList
string否应用已安装未激活
filterConvertedAd
string否屏蔽已转化用户 1广告2广告组3广告计划4广告主
appUninstallDays
integer否0应用历史未安装天数 与应用从未安装配合使用，最大值为365。 对应于营销平台中未安装时段选择。
neverInstallAppList
string否应用从未安装.

13.6 获取定向列表

基本信息

Path： /v2/communal/target/list

Method： POST

接口描述：

SDK接入，请求方法：

omniAds.adsTargrt().v2CommunalTargetList（data）

SDK请求参数：

TargetFilterVo data；
data.setXxx;

private Integer page; // 第几页

private Integer pageCount; // 每页数量

private String idAndName;//id名称模糊过滤条件

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是 multipart/form-data

Body

参数名称 参数类型 必须 示例 备注
ownerId 文本 否 0 子账户ID 直客和子客户非必填；代理商使用必填，用于指定查询某个子客户
delStatus 文本 否 0 删除状态：0, 正常；1,删除。
version 文本 否 0 1-原始版本.2-V2
type 文本 否 0 指定单个定向、人群包类型：1:普通定向，2:普通人群包，3:扩展人群包，4:运算人群包（人群交并），5:效果人群包，6:电话包。
types 文本 否 指定多个定向、人群包类型，格式：type1,type2,type3，例如：2,3,4,5,6。 1:普通定向，2:普通人群包，3:扩展人群包，4:运算人群包（人群交并），5:效果人群包，6:电话包。
bizType 文本 否 0 业务过滤条件
immutable 文本 否 0 不可修改条件
pTargetId 文本 否 0 父定向ID.
showType 文本 否 0 展示类型
extensionType 文本 否 0 推广目的
flowScene 文本 否 0 流量场景
showType 文本 否 showType推广样式,从广告组上获取

返回数据

名称类型必须默认值备注
code
integer否
msg
string否
data
object []否返回数据对象为空，可能是没有相应权限权限
targetId
integer是定向编号
ownerId
string否子账户ID 直客和子客户非必填；代理商使用必填，用于指定查询某个子客户
targetName
string是定向名称
targetDesc
string是定向描述
delStatus
integer否删除状态：0, 正常；1,删除.
region
string否地域
mobileModel
string否机型
sex
string否性别： 1:女 2:男
age
string否年龄： 1:<18； 2:18-24 3:25-34 4:35-49 5:>50
network
string否网络： WIFI:wifi 2G:2G 3G:3G 4G:4G 5G:5G
mobilePrice
string否机型价格： 1:0-1000 2:1000-1999 3:2000-2999 3:>3000
installAppList
string否应用已安装
preInstallAppList
string否应用预安装
unPreInstallAppList
string否应用非预安装
notInstallAppList
string否应用未安装
permanentRegion
string否常驻地
appActive
string否应用活跃.appId逗号分隔。 在不限情况底下-传递999.
appNotActive
string否应用非活跃. 在不限情况底下-传递999.
interestTagsV2
string否兴趣标签新版本
unionAppId
string否联盟AppId
unionAppIdRe
string否联盟App反向
immutable
integer是0:另存为的定向(可编辑定向) 1:创建不可编辑定向(无法编辑的定向)
type
integer是定向类型1:普通定向包2:IMEI人群定向包 6:电话包 11:OAID
audience
string否人群定向
pTargetId
integer否引用人群定向,需要传递人群定向包的ID过来
oppAudienceId
integer否排除人群包ID
appActiveDays
integer否应用活跃天数
appNotActiveDays
integer否应用非活跃天数
audienceCount
integer否人群包受众数量
imeiType
integer否imei类型0:IMEI1:IMEI-MD52:电话包（默认为0）3:OAID明文 4:OAID-MD5
yesterdayInstalledApp
string否前一天已安装
weatherCode
string否天气
installedNeverActiveAppList
string否应用已安装未激活
filterConvertedAd
string否屏蔽已转化用户 1广告2广告组3广告计划4广告主
appUninstallDays
integer否0应用历史未安装天数 与应用从未安装配合使用，最大值为365。 对应于营销平台中未安装时段选择。
neverInstallAppList
string否应用从未安装.
showStatus
string否展示状态.1-可使用,2-处理中,3-处理异常,4-已删除, 5 校验中 6 校验完成 7 无可用人群（人群包） 8 不可用（DMP标签人群包/DMP标签运算包/效果包自动更新7天未曝光）

13.7 定向App元数据接口

基本信息

Path： /v2/communal/target/get/metadata/app/list

Method： GET

接口描述：

SDK接入，请求方法：

omniAds.adsTargrt().v2CommunalTargetGetMetadataAppList（showType,extensionType,isTop,flowScene）

请求参数：


Integer showType, 推广样式
* 1:banner
* 2:插屏
* 4:开屏
* 8:原生(联盟）
* 16:信息流
* 32:搜索直达(搜索推广)
* 64:激励视频
* 128:分发推广
Integer extensionType,  推广目的(1:H5,2:APP,3：快应用)
boolean isTop,          是否停止
Integer flowScene       流量场景(2:精选推荐,3:安装有礼,4:开机必备,5:搜索,6:信息流,7:banner,8:开屏,9:插屏,10:原生，11：激励视屏）

请求参数

Query

参数名称 必须 示例 备注
extensionType 否 0 推广目的
flowScene 否 0 流量场景
ownerId 否 子账户ID
直客和子客户非必填；代理商使用必填，用于指定查询某个子客户
showType 否 showType推广样式,从广告组上获取

返回数据

名称类型必须默认值备注
code
integer否
msg
string否
data
object否
apps
object []否app列表
id
integer否应用ID
name
string是应用名称

13.8 获取元数据

基本信息

Path： /v2/communal/target/get/metadata

Method： GET

接口描述：

查询定向元数据接口,定向相关数据&用户权限
SDK接入请求方法：

omniAds.adsTarget().v2CommunalTargetGetMetadata(showType,extensionType.flowScene)

SDK请求参数：


Integer showType, 推广样式
* 1:banner
* 2:插屏
* 4:开屏
* 8:原生(联盟）
* 16:信息流
* 32:搜索直达(搜索推广)
* 64:激励视频
* 128:分发推广
Integer extensionType,  推广目的(1:H5,2:APP,3：快应用)
Integer flowScene       流量场景(2:精选推荐,3:安装有礼,4:开机必备,5:搜索,6:信息流,7:banner,8:开屏,9:插屏,10:原生，11：激励视屏）

请求参数

Query

参数名称 必须 示例 备注
extensionType 否 1:应用推广
2:链接推广
3.快应用		 推广目的
flowScene 否 1-全流量场景
2-精选推荐，
3-安装有礼，
4-开机必备，
5-搜索，
6-信息流，
7-Banner，
8-开屏，
9-插屏，
10-原生，
11-激励视频，
12-联盟通投		 流量场景
ownerId 否 子账户ID
直客和子客户非必填；代理商使用必填，用于指定查询某个子客户
showType 否 1:banner
2:插屏
4:开屏
8:原生(联盟）
16:信息流
32:搜索直达(搜索推广)
64:激励视频
128:分发推广		 showType推广样式,从广告组上获取

返回数据

名称类型必须默认值备注
code
integer否
msg
string否
data
object否
appCats
object []否app分类.
id
integer是ID
level
string是等级
name
string是名称
pid
integer是父ID
interestedTags
object []否兴趣标签(旧版本)
id
integer否ID
level
string是等级
name
string是名称
pid
string是父ID
interestedTagsV2
object []否兴趣标签(新版本)
id
integer否ID
level
string是等级
name
string是名称
pid
string是父ID
mobiles
object []否手机型号属性
id
integer否ID
name
string是名称
parentId
string是父id
series
string是系列
fseries
string是父系列
height
string是高
width
string是宽
apps
object []否app列表
id
integer否ID
name
string是名称
permissions
integer []否用户权限
targetMgeConfig
object否定向配置
limitCount
integer否创建定向限制数量
proValueCountLimit
object否属性个数约束
key
integer否
mutualexPros
object []否互斥属性配置
pro
integer否定向维度的上限
exPro
integer否定向维度值个数上限
msg
string否定向互斥维度说明
appInstallMutualexSwitch
boolean否引用安装互斥开关.
weatherShowList
object []否天气编码列表
weatherCode
string否天气ID
weatherName
string是天气名称

13.9 定向联盟App元数据接口

基本信息

Path： /v2/communal/target/get/metadata/newUapp/list

Method： GET

接口描述：

SDK接入，请求方法：

omniAds.adsTargrt().v2NewUappList(data)

SDK请求参数：

AdsUAppQueryForm data;
data.setXxx;

private Integer showType;

private String appName;

private Integer mediaPlatform;   媒体平台

private String appIds;

private boolean onlySelected;    是否仅查询已选中项

private Integer extensionType;   推广目的(1:H5,2:APP,3：快应用)

private Integer flowScene;       流量场景(2:精选推荐,3:安装有礼,4:开机必备,5:搜索,6:信息流,7:banner,8:开屏,9:插屏,10:原生，11：激励视屏）

private Integer page;            分页查找，页数

private Integer rows;            分页查找，行数

请求参数

Query

参数名称 必须 示例 备注
extensionType 否 0 推广目的
flowScene 否 0 流量场景
ownerId 否 子账户ID
直客和子客户非必填；代理商使用必填，用于指定查询某个子客户
showType 否 showType推广样式,从广告组上获取
page 否 分页查找，页数
rows 否 分页查找，行数,最大1000

返回数据

名称类型必须默认值备注
code
integer否
msg
string否
data
object否
unionApps
object []否联盟app
id
integer是应用ID
name
string是应用名称
platform
integer是媒体平台
platformName
string是媒体平台名称

13.10 用户兴趣标签新版本

基本信息

Path： /v2/communal/target/get/metadata/userInterestTagV2

Method： GET

接口描述：

SDK接入，请求方法：

omniAds.adsTarget().getUserInterestTagV2(showType, extensionType, flowScene)

SDK请求参数：

Integer showType  推广样式 1:banner2:插屏 4:开屏8:原生(联盟）16:信息流32:搜索直达(搜索推广)64:激励视频128:分发推广
Integer extensionType 推广目的(1:H5,2:APP,3：快应用)
Integer flowScene 流量场景(2:精选推荐,3:安装有礼,4:开机必备,5:搜索,6:信息流,7:banner,8:开屏,9:插屏,10:原生，11：激励视屏）

请求参数

Query

参数名称 必须 示例 备注
extensionType 否 0 推广目的
flowScene 否 0 流量场景
ownerId 否 子账户ID
直客和子客户非必填；代理商使用必填，用于指定查询某个子客户
showType 否 showType推广样式,从广告组上获取

返回数据

名称类型必须默认值备注
code
integer否
msg
string否
data
object []否
id
integer否兴趣标签id
pid
integer否父id
name
string否兴趣标签名称
level
integer否等级
comments
string否标签注释
delStatus
integer否删除标识：0未删除，1已删除

13.11 IMEI文件上传

基本信息

Path： /v2/communal/target/imei/upload

Method： POST

接口描述：

SDK接入，请求方法：

omniAds.adsTarget().v2TargetImeiUpload(AdsTargetImeiForm data)

SDK请求参数：
AdsTargetImeiForm data;

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type multipart/form-data 是 multipart/form-data

Query

参数名称 必须 示例 备注
imeiType 否 0 0:imei明文
1:IMEI-MD5
2:手机号码
3:OAID明文
4:OAID-MD5
ownerId 否 子账户ID
直客和子客户非必填；代理商使用必填，用于指定查询某个子客户

Body

参数名称 参数类型 必须 示例 备注
file 文件 是 图片文件

返回数据

名称类型必须默认值备注
code
integer否
msg
string否
data
object否
delStatus
integer否删除状态：0, 正常；1,删除.
immutable
integer是0:另存为的定向(可编辑定向) 1:创建不可编辑定向(无法编辑的定向)
audience
string否人群定向
audienceCount
integer否数量

13.12 运算人群包（人群包交并）

基本信息

Path： /v2/communal/target/addExpansionTask

Method： POST

接口描述：

SDK接入，请求方法：

omniAds.adsTarget().v2TargetAddExpansionTask(AdsTargetTaskForm data)

SDK请求参数：
AdsTargetTaskForm data；

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是 application/x-www-form-urlencoded

Query

参数名称 必须 示例 备注
targetName 是 定向名称
targetDesc 是 定向描述
type 是 type=4，运算包
taskType 是 任务类型：
3:人群交集
4:人群并集
seedIdList 是 种子包ID，例如:111,222,333
ownerId 否 子账户ID
直客和子客户非必填；代理商使用必填，用于指定查询某个子客户

返回数据

名称类型必须默认值备注
code
integer否
msg
string否
data
object否
targetId
integer是定向编号

13.13 获取地区元数据

基本信息

Path： /v2/communal/target/getAreaInfo

Method： POST

接口描述：

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
queryType 是 0 0-查询全部数据
1-查询指定区域id的数据
areaIds 否 1001%2C1002%2C3244%2C3245 queryType=1时需要传指定的区域id
例如：
1001,1002,3244,3245
实际需要通过URL编码后传参：
1001%2C1002%2C3244%2C3245

返回数据

名称类型必须默认值备注
code
number是请求返回状态码：0-成功
msg
string否报错信息
data
object []否具体数据
code
string是区域id
name
string是区域名称：省份名称/城市名称
available
string是
children
object []是下一层级的区域
code
string是区域id
name
string是区域名称
available
string是

13.14 获取省市元数据

基本信息

Path： /v2/communal/target/provinceAndCityMapping

Method： POST

接口描述：

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

返回数据

名称类型必须默认值备注
code
number否请求状态码。0-成功
msg
string是报错信息
data
object []否具体数据
code
string是省级行政区id
name
string是省级行政区名称
available
string是
children
object []否省级省级行政区下的城市，直辖市该属性为空
code
string是城市id
name
string是城市名称
available
string是

14. 应用相关

14.1 校验并返回快应用相关信息

基本信息

Path： /v3/communal/instant/check

Method： POST

接口描述：

校验并返回快应用相关信息：
SDK接入，请求方法;

omniAds.adsInstantApp()v3CommunalInstantCheck(data)

SDK请求参数：

AdV3InstantAppForm data;
data.setXxx;

private Integer instantAppId;  快应用AppId

private String instantAppUrl;  快应用直达链接

private Long adGroupId;        广告组Id

请求参数：

instantAppId: 12000288

响应报文：

{
    "code": 124015, 
    "msg": "快应用地址应和ID保持一致"
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
instantAppId 是 快应用AppId
instantAppUrl 是 快应用直达链接

返回数据

名称类型必须默认值备注
code
integer否
data
object否
appName
string否快应用名称
iconUrl
string否快应用icon
instantAppId
integer否快应用Id
msg
string否错误信息
oneWordDesc
string否一句话描述该应用
status
integer否状态码
msg
string否

14.2 查询应用信息

基本信息

Path： /v2/communal/group/appInfo

Method： POST

接口描述：

查询应用信息：
SDK接入，请求方法：

omniAds.adsCommunal().v2CommunalGroupAppInfo(appId，pkgName，bizType，flowScene)

SDK请求参数：

Integer appId    应用ID
String pkgName   应用包名
Integer bizType  业务类型 1：cpd广告产品，2：feeds广告，3：合约广告，" "4：招商活动广告，5：智能短信广告，6：联盟广告，7：搜索，100：外部ADX，101：业务公共类型，102：融合，201：电商
Integer flowScene  流量场景：1-全流量场景，2-精选推广，3-安装有礼，4-开机必备 "5-搜索，6-信息流，7-Banner，8-开屏，9-插屏，10-原生，11-激励视频，12-联盟通投

请求参数：

appId: 2321

响应报文：

{
    "code": 0, 
    "data": {
        "appId": 2321, 
        "appName": "大众点评", 
        "appPackage": "com.dianping.v1", 
        "iconUrl": "https://image-c.wanyol.com/cdo-test-store/openplat/photo/201807/27/f1c29597ba6de2c8629d813fe0e578dc.png", 
        "status": 0, 
        "resourceStatus": 1, 
        "onewordDesc": "广告描述Aa", 
        "categoryId": 7, 
        "secondCategoryId": 81, 
        "thirdCategoryId": 6845, 
        "appAuth": 0
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
appId 是 应用id
pkgName 否 应用包名

返回数据

名称类型必须默认值备注
code
integer否
data
object否
appAuth
integer否应用权限(按位或),1-游戏注册权限位(0-无权限，1-有权限),2-待扩展权限位(0-无权限，1-有权限),4-待扩展权限位(0-无权限，1-有权限)
appId
integer否应用id
appName
string否应用名称
appPackage
string否包名
categoryId
integer否分类id
iconUrl
string否应用iconUrl地址
msg
string否异常信息
onewordDesc
string否一句话描述
region
string否国家区域
resourceStatus
integer否资源状态，1-上架，2-下架，10-删除
status
integer否应用状态 0-正常，1-异常
msg
string否

14.3 查询快应用信息

基本信息

Path： /v2/communal/instant/appInfo

Method： POST

接口描述：

查询快应用信息：
SDK接入，请求方法：

omniAds.adsInstantApp().v2CommunalInstantAppInfo(data)

SDK请求参数：

AdInstantAppForm data;
data.setXxx;

private Integer instantAppId;  快应用AppId
private String instantAppUrl;  快应用直达链接
private int type;              状态类别 0：广告，1：广告组，2：计划  必传
private Long adGroupId;        广告组Id
private String instantAppNameLike;  快应用名称，模糊查询

请求参数：

instantAppId: 12000288
type: 1

响应报文：

{
    "code": 0, 
    "data": {
        "iconUrl": "http://fs-store-test.wanyol.com/openplat/photo/201903/06/db10bb38e2d7b463c5fedd0516d14131.png", 
        "appName": "小白战纪", 
        "instantAppId": 12000288, 
        "status": 0, 
        "oneWordDesc": "eqwrewrqrq"
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
instantAppId 是 快应用AppId
type 是 状态类别 0：广告，1：广告组，2：计划

返回数据

名称类型必须默认值备注
code
integer否
data
object否
appName
string否快应用名称
iconUrl
string否快应用icon
instantAppId
integer否快应用Id
msg
string否错误信息
oneWordDesc
string否一句话描述该应用
status
integer否状态码
msg
string否

15. 配置相关

15.1 根据配置类型获取配置项

基本信息

Path： /v3/communal/config/getList

Method： POST

接口描述：

见：典型场景举例 ——> 通用-根据配置类型获取配置项
SDK接入，请求方法：

omniAds.adsCommunal().v3CommunalConfigGetList(data)

SDK请求参数：

AdsConfigReq data;
data.setXxx;

@ApiParam(value = "配置类型，获取配置列表，配置类型不能为空，EXTENSION_TYPE：推广目的，EXTENSION_FLOW：推广流量，FLOW_SCENE：流量场景，BILLING_TYPE：出价方式，OCPC_TYPE：转化类型，DEEP_OCPC_TYPE：深度转化类型，SPEC_TYPE：规格，URL_TYPE：监测链接，SMART_EXPAND_TYPE；智能拓量，FIREFLY_APP_DOWN_PAGE：萤火虫应用下载页，PAGE_TYPE：落地页类型，REQUIRED_SPEC_TYPE：全流量必填规格")

private String type;


@ApiParam(value = "配置类型列表，批量获取配置项，配置类型列表不能为空，EXTENSION_TYPE：推广目的，EXTENSION_FLOW：推广流量，FLOW_SCENE：流量场景，BILLING_TYPE：出价方式，OCPC_TYPE：转化类型，DEEP_OCPC_TYPE：深度转化类型，SPEC_TYPE：规格，URL_TYPE：监测链接，SMART_EXPAND_TYPE；智能拓量，FIREFLY_APP_DOWN_PAGE：萤火虫应用下载页，PAGE_TYPE：落地页类型，REQUIRED_SPEC_TYPE：全流量必填规格")

private List<String> typeList;


@ApiParam(value = "推广目标 1：链接推广 2：应用推广 3: 快应用推广 7: 小程序推广", required = false)

@AdRange(values = {1, 2, 3}, message = "extensionType取值范围为1、2、3、7")

private Integer extensionType;


@ApiParam(value = "推广流量：1-全流量场景，2-自有流量，3-联盟流量", required = false)

@AdRange(values = {1, 2, 3}, message = "extensionFlow取值范围为1、2、3")

private Integer extensionFlow;


@ApiParam(value = "流量场景：1-全流量场景，2-精选推广，3-安装有礼，4-开机必备，5-搜索，6-信息流，7-Banner，8-开屏，9-插屏，10-原生，11-激励视频，12-联盟通投。修改出价，流量场景不能为空", required = false)

@AdRange(values = {1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12}, message = "flowScene取值范围为1~12")

private Integer flowScene;

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
extensionFlow 否 推广流量：1-全流量场景，2-自有流量，3-联盟流量
extensionType 否 推广目标 1：链接推广 2：应用推广 3: 快应用推广 7: 小程序推广
flowScene 否 流量场景：1-全流量场景，2-精选推广，3-安装有礼，4-开机必备，5-搜索，6-信息流，7-Banner，8-开屏，9-插屏，10-原生，11-激励视频，12-联盟通投。修改出价，流量场景不能为空
type 否 配置类型，获取配置列表，配置类型不能为空，EXTENSION_TYPE：推广目的，EXTENSION_FLOW：推广流量，FLOW_SCENE：流量场景，BILLING_TYPE：出价方式，OCPC_TYPE：转化类型，DEEP_OCPC_TYPE：深度转化类型，SPEC_TYPE：规格，URL_TYPE：监测链接，SMART_EXPAND_TYPE；智能拓量，FIREFLY_APP_DOWN_PAGE：萤火虫应用下载页，PAGE_TYPE：落地页类型，REQUIRED_SPEC_TYPE：全流量必填规格，AD_EACH_SPEC_NUM_LIMIT：每个规格下的创意数量限制，AD_ALL_SPEC_NUM_LIMIT：所有规格的创意总数量限制
typeList 否 配置类型列表，批量获取配置项，配置类型列表不能为空，EXTENSION_TYPE：推广目的，EXTENSION_FLOW：推广流量，FLOW_SCENE：流量场景，BILLING_TYPE：出价方式，OCPC_TYPE：转化类型，DEEP_OCPC_TYPE：深度转化类型，SPEC_TYPE：规格，URL_TYPE：监测链接，SMART_EXPAND_TYPE；智能拓量，FIREFLY_APP_DOWN_PAGE：萤火虫应用下载页，PAGE_TYPE：落地页类型，REQUIRED_SPEC_TYPE：全流量必填规格，AD_EACH_SPEC_NUM_LIMIT：每个规格下的创意数量限制，AD_ALL_SPEC_NUM_LIMIT：所有规格的创意总数量限制

返回数据

名称类型必须默认值备注
code
integer否
data
object []否
ext
string否配置扩展信息
value
string否元配置值
msg
string否

15.2 根据配置类型批量获取配置项

基本信息

Path： /v3/communal/config/getMap

Method： POST

接口描述：

根据配置类型批量获取配置项：
SDK接入，请求方法：

omniAds.adsCommunal().v3CommunalConfigGetMap(data)

SDK请求参数：

AdsConfigReq data;
data.setXxx;

@ApiParam(value = "配置类型，获取配置列表，配置类型不能为空，EXTENSION_TYPE：推广目的，EXTENSION_FLOW：推广流量，FLOW_SCENE：流量场景，BILLING_TYPE：出价方式，OCPC_TYPE：转化类型，DEEP_OCPC_TYPE：深度转化类型，SPEC_TYPE：规格，URL_TYPE：监测链接，SMART_EXPAND_TYPE；智能拓量，FIREFLY_APP_DOWN_PAGE：萤火虫应用下载页，PAGE_TYPE：落地页类型，REQUIRED_SPEC_TYPE：全流量必填规格")

private String type;


@ApiParam(value = "配置类型列表，批量获取配置项，配置类型列表不能为空，EXTENSION_TYPE：推广目的，EXTENSION_FLOW：推广流量，FLOW_SCENE：流量场景，BILLING_TYPE：出价方式，OCPC_TYPE：转化类型，DEEP_OCPC_TYPE：深度转化类型，SPEC_TYPE：规格，URL_TYPE：监测链接，SMART_EXPAND_TYPE；智能拓量，FIREFLY_APP_DOWN_PAGE：萤火虫应用下载页，PAGE_TYPE：落地页类型，REQUIRED_SPEC_TYPE：全流量必填规格")

private List<String> typeList;


@ApiParam(value = "推广目标 1：链接推广 2：应用推广 3: 快应用推广 7: 小程序推广", required = false)

@AdRange(values = {1, 2, 3}, message = "extensionType取值范围为1、2、3、7")

private Integer extensionType;


@ApiParam(value = "推广流量：1-全流量场景，2-自有流量，3-联盟流量", required = false)

@AdRange(values = {1, 2, 3}, message = "extensionFlow取值范围为1、2、3")

private Integer extensionFlow;


@ApiParam(value = "流量场景：1-全流量场景，2-精选推广，3-安装有礼，4-开机必备，5-搜索，6-信息流，7-Banner，8-开屏，9-插屏，10-原生，11-激励视频，12-联盟通投。修改出价，流量场景不能为空", required = false)

@AdRange(values = {1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12}, message = "flowScene取值范围为1~12")

private Integer flowScene;

请求参数：

typeList: DEEP_OCPC_TYPE
extensionType: 2
extensionFlow: 2
flowScene: 5

响应报文：

{
    "code": 0, 
    "data": {
        "DEEP_OCPC_TYPE": [
            {
                "value": "4-23", 
                "ext": "{"name":"游戏付费ROI1","value":23,"ocpcType":4}"
            }, 
            {
                "value": "5-23", 
                "ext": "{"name":"游戏付费ROI1","value":23,"ocpcType":5}"
            }
        ]
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
extensionFlow 否 推广流量：1-全流量场景，2-自有流量，3-联盟流量
extensionType 否 推广目标 1：链接推广 2：应用推广 3: 快应用推广 7: 小程序推广
flowScene 否 流量场景：1-全流量场景，2-精选推广，3-安装有礼，4-开机必备，5-搜索，6-信息流，7-Banner，8-开屏，9-插屏，10-原生，11-激励视频，12-联盟通投。修改出价，流量场景不能为空
type 否 配置类型，获取配置列表，配置类型不能为空，EXTENSION_TYPE：推广目的，EXTENSION_FLOW：推广流量，FLOW_SCENE：流量场景，BILLING_TYPE：出价方式，OCPC_TYPE：转化类型，DEEP_OCPC_TYPE：深度转化类型，SPEC_TYPE：规格，URL_TYPE：监测链接，SMART_EXPAND_TYPE；智能拓量，FIREFLY_APP_DOWN_PAGE：萤火虫应用下载页，PAGE_TYPE：落地页类型，REQUIRED_SPEC_TYPE：全流量必填规格AD_EACH_SPEC_NUM_LIMIT：每个规格下的创意数量限制，AD_ALL_SPEC_NUM_LIMIT：所有规格的创意总数量限制
typeList 否 配置类型列表，批量获取配置项，配置类型列表不能为空，EXTENSION_TYPE：推广目的，EXTENSION_FLOW：推广流量，FLOW_SCENE：流量场景，BILLING_TYPE：出价方式，OCPC_TYPE：转化类型，DEEP_OCPC_TYPE：深度转化类型，SPEC_TYPE：规格，URL_TYPE：监测链接，SMART_EXPAND_TYPE；智能拓量，FIREFLY_APP_DOWN_PAGE：萤火虫应用下载页，PAGE_TYPE：落地页类型，REQUIRED_SPEC_TYPE：全流量必填规格AD_EACH_SPEC_NUM_LIMIT：每个规格下的创意数量限制，AD_ALL_SPEC_NUM_LIMIT：所有规格的创意总数量限制

返回数据

名称类型必须默认值备注
code
integer否
data
object否
msg
string否

15.3 出价方式及限定范围查询

基本信息

Path： /v3/communal/interval/config/groupPrice

Method： POST

接口描述：

出价方式及限定范围查询：
SDK接入，请求方法：

omniAds.adsCommunal().v3GroupPrice(flowScene，ocpcType，extensionType)

SDK请求参数：

Integer flowScene   流量场景
Integer ocpcType    目标转化类型
Integer extensionType  推广目的 1：链接推广 2：应用推广 3: 快应用推广 7: 小程序推广

请求参数：

flowScene: 1
ocpcType: 0

响应报文：

{
    "code": 0, 
    "data": {
        "flowScene": 1, 
        "ocpcType": 0, 
        "floorBid": 10, 
        "maxBid": 10000, 
        "oFloorBid": 120, 
        "oMaxBid": 20000, 
        "dFloorBid": 120, 
        "dMaxBid": 300000
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 必须 示例 备注
flowScene 是 流量场景：1-全流量场景，2-精选推广，3-安装有礼，4-开机必备，5-搜索，6-信息流，7-Banner，8-开屏，9-插屏，10-原生，11-激励视频，12-联盟通投
ocpcType 是 目标转化类型
extensionType 否 标的物类型 1：链接推广 2：应用推广 3: 快应用推广 7: 小程序推广

返回数据

名称类型必须默认值备注
code
integer否
data
object否
dFloorBid
integer否深度转化出价下限
dMaxBid
integer否深度转化出价上限
fFloorBid
integer否更随出价下限
fMaxBid
integer否跟随出价上限
floorBid
integer否基础出价下限
flowScene
integer否流量场景
maxBid
integer否基础出价上限
oFloorBid
integer否转化出价下限
oMaxBid
integer否转化出价上限
ocpcType
integer否转化类型
msg
string否

16. 资质相关

16.1 投放资质信息查询（审核结果）

基本信息

Path： /v3/communal/owner/customer/qualification/get

Method： POST

接口描述：

请求接口不需要具体参数，不过需要客户登陆的cookie和session信息
auditStatus 返回资质审核具体状态

auditStatus
0 审核中
1 通过
2 失败


响应报文：

{
    "code":0,
    "data":{
        "id":11,
        "ownerId":1100017731,
        "industryCategoryFirst":"26",
        "industryCategoryFirstRemark":"文体娱乐",
        "industryCategorySecond":"26006",
        "industryCategorySecondRemark":"室内娱乐",
        "industryCategoryThird":"260062",
        "industryCategoryThirdRemark":"密室逃脱",
        "qualificationDetails":{
            "base":{
                "qualificationList":[
                    {
                        "qualificationName":"《营业执照》",
                        "files":[
                            "/images/res/user_pic/202211/02/1100017731/325epw7c2dvywo6lg7wuom4b4_1080X2400_1667388267037.jpg"
                        ]
                    },
                    {
                        "qualificationName":"ICP备案截图",
                        "files":[

                        ]

                    },

                    {

                        "qualificationName":"《增值电信业务许可证》",

                        "files":[


                        ]

                    }

                ]

            },

            "industry":[

                {

                    "qualificationCategoryName":"",

                    "qualificationList":[

                        {

                            "qualificationName":"《卫生许可证》",

                            "files":[

                                "/images/res/user_pic/202211/02/1100017731/325epw7c2dvywo6lg7wuom4b4_1080X2400_1667388271520.jpg"

                            ]

                        },

                        {

                            "qualificationName":"《娱乐经营许可证》",

                            "files":[

                                "/images/res/user_pic/202211/02/1100017731/325epw7c2dvywo6lg7wuom4b4_1080X2400_1667388273934.jpg"

                            ]

                        }

                    ]

                }

            ],

            "ext":{

                "qualificationList":[


                ]

            }

        },

        "remark":"测试jins1234567",

        "pageFlag":0,

        "auditStatus":0

    }

}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

返回数据

名称类型必须默认值备注
code
number否
data
object否
id
number否
ownerId
number否
industryCategoryFirst
string否一级行业code
industryCategoryFirstRemark
string否一级行业名称
industryCategorySecond
string否二级行业code
industryCategorySecondRemark
string否二级行业名称
industryCategoryThird
string否三级行业code
industryCategoryThirdRemark
string否三级行业名称
qualificationDetails
object否资质详情
base
object否基础资质
qualificationList
object []否
qualificationName
string是
files
string []是
industry
object []否行业资质
qualificationCategoryName
string否
qualificationList
object []否
qualificationName
string否
files
string []否
ext
object否额外资质
qualificationList
object []否
qualificationName
string否
files
string []否
remark
string否
pageFlag
number否
auditStatus
number否
auditRemark
string否

16.6 用户投放资质信息（资质图片绝对路径URL）

基本信息

Path： /v3/communal/owner/customer/qualification/info

Method： POST

接口描述：

请求接口不需要具体参数，不过需要客户登陆的cookie和session信息
auditStatus 返回资质审核具体状态

auditStatus
0 审核中
1 通过
2 失败


响应报文：

{
    "code":0,
    "data":{
        "id":86,
        "ownerId":1000001009,
        "industryCategoryFirst":"24",
        "industryCategoryFirstRemark":"食品饮料",
        "industryCategorySecond":"24006",
        "industryCategorySecondRemark":"乳制品及乳制品饮料",
        "industryCategoryThird":"240062",
        "industryCategoryThirdRemark":"乳制品及乳制品饮料ss",
        "qualificationDetails":{
            "base":{
                "qualificationList":[
                    {
                        "qualificationName":"《营业执照》",
                        "files":[
                                "http://xxxrfwe.xfadfw",
                                "http://xxxrfwe.xfadfw"
                        ]
                    },
                    {
                        "qualificationName":"ICP备案截图",
                        "files":[
                                "http://xxxrfwe.xfadfw",
                                "http://xxxrfwe.xfadfw"
                        ]
                    },
                    {
                        "qualificationName":"《增值电信业务许可证》",
                        "files":[
                                "http://xxxrfwe.xfadfw"
                        ]
                    }
                ]
            },
            "industry":[
                {
                    "qualificationCategoryName":"普通食品",
                    "qualificationList":[
                        {
                            "qualificationName":"《食品生产许可证》",
                            "files":[
                                "http://xxxrfwe.xfadfw"
                            ]
                        },
                        {
                            "qualificationName":"《食品经营许可证》",
                            "files":[
                                "http://xxxrfwe.xfadfw"
                            ]
                        },
                        {
                            "qualificationName":"《食品服务许可证》",
                            "files":[
                                "http://xxxrfwe.xfadfw"
                            ]
                        }
                    ]
                }
            ],
            "ext":{
                "qualificationList":[
                ]
            }
        },
        "remark":"",
        "auditStatus":0
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

返回数据

名称类型必须默认值备注
code
number否
data
object否
id
number否
ownerId
number否
industryCategoryFirst
string否
industryCategoryFirstRemark
string否
industryCategorySecond
string否
industryCategorySecondRemark
string否
qualificationDetails
object否
base
object否
qualificationList
object []否
qualificationName
string是
files
string []是
industry
object []否
qualificationCategoryName
string否
qualificationList
object []否
qualificationName
string是
files
string []是
ext
object否
qualificationList
string []否
remark
string否
auditStatus
number否

16.2 行业查询

基本信息

Path： /v3/communal/qualification/industry

Method： POST

接口描述：

响应报文：

{
  "code": 0,
  "data": {
    "baseQualificationList": [
      {
        "sort": 0,
        "required": 1,
        "groupFlag": 0,
        "files": [
          "《营业执照》"
        ]
      },
      {
        "sort": 1,
        "required": 0,
        "groupFlag": 0,
        "files": [
          "ICP备案截图"
        ],
        "remark": "建站链接投放无需提交该资质，此项资质仅针对外链投放"
      },
      {
        "sort": 2,
        "required": 0,
        "groupFlag": 0,
        "files": [
          "《增值电信业务许可证》"
        ],
        "remark": "外链：如落地页涉及在线售卖，需提交《增值电信业务许可证》"
      }
    ],
    "firstIndustryCategoryList": [
      {
        "firstIndustryCategoryName": "社会公共",
        "firstIndustryCategoryCode": "22",
        "secondIndustryCategoryList": [
          {
            "secondIndustryCategoryName": "其他社会公共",
            "secondIndustryCategoryCode": "22001",
            "thirdIndustryCategoryList": [
              {
                "thirdIndustryCategoryName": "其他社会公共",
                "thirdIndustryCategoryCode": "220011"
              }
            ]
          },
          {
            "secondIndustryCategoryName": "社会组织",
            "secondIndustryCategoryCode": "22002",
            "thirdIndustryCategoryList": [
              {
                "thirdIndustryCategoryName": "社会组织",
                "thirdIndustryCategoryCode": "220021"
              }
            ]
          },
          {
            "secondIndustryCategoryName": "市政建设",
            "secondIndustryCategoryCode": "22003",
            "thirdIndustryCategoryList": [
              {
                "thirdIndustryCategoryName": "市政建设",
                "thirdIndustryCategoryCode": "220031"
              }
            ]
          },
          {
            "secondIndustryCategoryName": "政府政务环境安全",
            "secondIndustryCategoryCode": "22004",
            "thirdIndustryCategoryList": [
              {
                "thirdIndustryCategoryName": "政府政务环境安全",
                "thirdIndustryCategoryCode": "220041"
              }
            ]
          },
          {
            "secondIndustryCategoryName": "政府政务科教卫生",
            "secondIndustryCategoryCode": "22005",
            "thirdIndustryCategoryList": [
              {
                "thirdIndustryCategoryName": "政府政务科教卫生",
                "thirdIndustryCategoryCode": "220051"
              }
            ]
          },
          {
            "secondIndustryCategoryName": "政府政务文化旅游",
            "secondIndustryCategoryCode": "22006",
            "thirdIndustryCategoryList": [
              {
                "thirdIndustryCategoryName": "政府政务文化旅游",
                "thirdIndustryCategoryCode": "220061"
              }
            ]
          }
        ]
      },
      {
        "firstIndustryCategoryName": "商务服务",
        "firstIndustryCategoryCode": "21",
        "secondIndustryCategoryList": [
          {
            "secondIndustryCategoryName": "安全安保",
            "secondIndustryCategoryCode": "21001",
            "thirdIndustryCategoryList": [
              {
                "thirdIndustryCategoryName": "防盗报警",
                "thirdIndustryCategoryCode": "210011"
              },
              {
                "thirdIndustryCategoryName": "保安安保",
                "thirdIndustryCategoryCode": "210012"
              },
              {
                "thirdIndustryCategoryName": "警用装备",
                "thirdIndustryCategoryCode": "210013"
              },
              {
                "thirdIndustryCategoryName": "门禁考勤",
                "thirdIndustryCategoryCode": "210014"
              },
              {
                "thirdIndustryCategoryName": "交通消防",
                "thirdIndustryCategoryCode": "210015"
              },
              {
                "thirdIndustryCategoryName": "其他安全安保",
                "thirdIndustryCategoryCode": "210016"
              }
            ]
          },
          {
            "secondIndustryCategoryName": "包装印刷",
            "secondIndustryCategoryCode": "21002",
            "thirdIndustryCategoryList": [
              {
                "thirdIndustryCategoryName": "包装印刷",
                "thirdIndustryCategoryCode": "210021"
              }
            ]
          },
          {
            "secondIndustryCategoryName": "出版传媒",
            "secondIndustryCategoryCode": "21003",
            "thirdIndustryCategoryList": [
              {
                "thirdIndustryCategoryName": "出版传媒",
                "thirdIndustryCategoryCode": "210031"
              }
            ]
          },
          {
            "secondIndustryCategoryName": "代办服务",
            "secondIndustryCategoryCode": "21004",
            "thirdIndustryCategoryList": [
              {
                "thirdIndustryCategoryName": "代办服务",
                "thirdIndustryCategoryCode": "210041"
              }
            ]
          },
          {
            "secondIndustryCategoryName": "法律服务",
            "secondIndustryCategoryCode": "21005",
            "thirdIndustryCategoryList": [
              {
                "thirdIndustryCategoryName": "个人律师",
                "thirdIndustryCategoryCode": "210051"
              },
              {
                "thirdIndustryCategoryName": "律所",
                "thirdIndustryCategoryCode": "210052"
              },
              {
                "thirdIndustryCategoryName": "其他法律服务",
                "thirdIndustryCategoryCode": "210053"
              }
            ]
          },
          {
            "secondIndustryCategoryName": "管理咨询",
            "secondIndustryCategoryCode": "21006",
            "thirdIndustryCategoryList": [
              {
                "thirdIndustryCategoryName": "管理咨询",
                "thirdIndustryCategoryCode": "210061"
              }
            ]
          },
          {
            "secondIndustryCategoryName": "广告服务",
            "secondIndustryCategoryCode": "21007",
            "thirdIndustryCategoryList": [
              {
                "thirdIndustryCategoryName": "广告服务",
                "thirdIndustryCategoryCode": "210071"
              }
            ]
          },
          {
            "secondIndustryCategoryName": "会计税务",
            "secondIndustryCategoryCode": "21008",
            "thirdIndustryCategoryList": [
              {
                "thirdIndustryCategoryName": "会计税务",
                "thirdIndustryCategoryCode": "210081"
              }
            ]
          },
          {
            "secondIndustryCategoryName": "其他商务服务",
            "secondIndustryCategoryCode": "21009",
            "thirdIndustryCategoryList": [
              {
                "thirdIndustryCategoryName": "其他商务服务",
                "thirdIndustryCategoryCode": "210091"
              }
            ]
          },
          {
            "secondIndustryCategoryName": "人力资源服务",
            "secondIndustryCategoryCode": "21010",
            "thirdIndustryCategoryList": [
              {
                "thirdIndustryCategoryName": "招聘服务",
                "thirdIndustryCategoryCode": "210101"
              },
              {
                "thirdIndustryCategoryName": "劳务外包服务",
                "thirdIndustryCategoryCode": "210102"
              },
              {
                "thirdIndustryCategoryName": "其他人力资源服务",
                "thirdIndustryCategoryCode": "210103"
              }
            ]
          },
          {
            "secondIndustryCategoryName": "商演会展",
            "secondIndustryCategoryCode": "21011",
            "thirdIndustryCategoryList": [
              {
                "thirdIndustryCategoryName": "商演会展",
                "thirdIndustryCategoryCode": "210111"
              },
              {
                "thirdIndustryCategoryName": "婚博会",
                "thirdIndustryCategoryCode": "210112"
              },
              {
                "thirdIndustryCategoryName": "车展会",
                "thirdIndustryCategoryCode": "210113"
              },
              {
                "thirdIndustryCategoryName": "茶博会",
                "thirdIndustryCategoryCode": "210114"
              },
              {
                "thirdIndustryCategoryName": "活动庆典",
                "thirdIndustryCategoryCode": "210115"
              }
            ]
          },
          {
            "secondIndustryCategoryName": "设计",
            "secondIndustryCategoryCode": "21012",
            "thirdIndustryCategoryList": [
              {
                "thirdIndustryCategoryName": "设计",
                "thirdIndustryCategoryCode": "210121"
              }
            ]
          },
          {
            "secondIndustryCategoryName": "营销推广",
            "secondIndustryCategoryCode": "21013",
            "thirdIndustryCategoryList": [
              {
                "thirdIndustryCategoryName": "网络营销",
                "thirdIndustryCategoryCode": "210131"
              },
              {
                "thirdIndustryCategoryName": "网店运营",
                "thirdIndustryCategoryCode": "210132"
              },
              {
                "thirdIndustryCategoryName": "其他营销推广",
                "thirdIndustryCategoryCode": "210133"
              }
            ]
          },
          {
            "secondIndustryCategoryName": "中介服务",
            "secondIndustryCategoryCode": "21014",
            "thirdIndustryCategoryList": [
              {
                "thirdIndustryCategoryName": "中介服务",
                "thirdIndustryCategoryCode": "210141"
              }
            ]
          }
        ]
      }
    ]
  }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是

返回数据

名称类型必须默认值备注
code
number否
data
object否
baseQualificationList
object []否基础资质
sort
number是
required
number是
groupFlag
number是
files
string []是
remark
string是
firstIndustryCategoryList
object []否一级行业列表
firstIndustryCategoryName
string是一级行业名称
firstIndustryCategoryCode
string是一级行业code
secondIndustryCategoryList
object []是二级行业列表
secondIndustryCategoryName
string是二级行业名称
secondIndustryCategoryCode
string是二级行业code
thirdIndustryCategoryList
object []是三级行业列表
thirdIndustryCategoryName
string是三级行业名称
thirdIndustryCategoryCode
string是三级行业code

16.3 行业所需资质文件查询

基本信息

Path： /v3/communal/qualification/elements

Method： POST

接口描述：

groupFlag：
如果groupFlag=1 说明是一个组 ，一个组内的文件至少填写一个证书的材料 如下 这里 2个材料是必填1个。
然后冕下哪个sort2的第二个材料 化妆品许可证 required =1 那也是必填的。
image.png
响应报文：

{
  "code": 0,
  "data": [
    {
      "industryLabel": "普通食品",
      "sort": 1,
      "required": 1,
      "groupFlag": 1,
      "files": [
        "《食品生产许可证》",
        "《食品经营许可证》",
        "《食品服务许可证》"
      ],
      "remark": ""
    },
    {
      "industryLabel": "进口食品",
      "sort": 1,
      "required": 1,
      "groupFlag": 1,
      "files": [
        "《食品生产许可证》",
        "《食品经营许可证》",
        "《食品服务许可证》"
      ],
      "remark": ""
    },
    {
      "industryLabel": "进口食品",
      "sort": 2,
      "required": 1,
      "groupFlag": 0,
      "files": [
        "《商品出入境检验检疫合格证明》"
      ],
      "remark": ""
    },
    {
      "industryLabel": "有机食品",
      "sort": 1,
      "required": 1,
      "groupFlag": 1,
      "files": [
        "《食品生产许可证》",
        "《食品经营许可证》",
        "《食品服务许可证》"
      ],
      "remark": ""
    },
    {
      "industryLabel": "有机食品",
      "sort": 2,
      "required": 1,
      "groupFlag": 0,
      "files": [
        "《有机食品认证证书》"
      ],
      "remark": ""
    },
    {
      "industryLabel": "绿色食品",
      "sort": 1,
      "required": 1,
      "groupFlag": 1,
      "files": [
        "《食品生产许可证》",
        "《食品经营许可证》",
        "《食品服务许可证》"
      ],
      "remark": ""
    },
    {
      "industryLabel": "绿色食品",
      "sort": 2,
      "required": 1,
      "groupFlag": 0,
      "files": [
        "《绿色食品标志使用证书》"
      ],
      "remark": ""
    },
    {
      "industryLabel": "无公害农产品",
      "sort": 1,
      "required": 1,
      "groupFlag": 1,
      "files": [
        "《食品生产许可证》",
        "《食品经营许可证》",
        "《食品服务许可证》"
      ],
      "remark": ""
    },
    {
      "industryLabel": "无公害农产品",
      "sort": 2,
      "required": 1,
      "groupFlag": 1,
      "files": [
        "《无公害农产品产地认定证书》",
        "《无公害农产品认证证书》"
      ],
      "remark": ""
    }
  ]
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 必须 示例 备注
secondIndustryCode 文本 是 17008 二级标签code
thirdIndustryCode 文本 是 170081 三级标签code

返回数据

名称类型必须默认值备注
code
number否
data
object []否
industryLabel
string是行业标签
sort
number是顺序
required
number是是否必填 1必填 0非必填
groupFlag
number是是否证书为一组 1是 0 否
files
string []是文件列表
remark
string是

16.4 资质送审（新增)

基本信息

Path： /v3/communal/owner/customer/qualification/add

Method： POST

接口描述：

注意：
资质图片 url 需要调用https://yapi-ads.wanyol.com/project/68/interface/api/8228文档 /v2/communal/owner/customer/uploadBusiLicenceImg 接口上传图片获取到 图片的路径填写到对应的file字段中。
只能使用v2接口不要使用v3

请求实例：

{
        "ownerId":1000001009,
        "industryCategoryFirst":"17",
        "industryCategoryFirstRemark":"快速消费品",
        "industryCategorySecond":"17008",
        "industryCategorySecondRemark":"一般化妆品",
        "industryCategoryThird":"170081",
        "industryCategoryThirdRemark":"一般化妆品1",
        "qualificationDetails":{
            "base":{
                "qualificationList":[
                    {
                        "qualificationName":"《营业执照》",
                        "files":[
                            "/images/res/user_pic/202203/21/1000001009/4_1647860665009.png",
                            "/images/res/user_pic/202203/21/1000001009/bg_1647860672884.png"
                        ]
                    },
                    {
                        "qualificationName":"ICP备案截图",
                        "files":[
                            "/images/res/user_pic/202203/24/1000001009/cicle04_1648106344461.png",
                            "/images/res/user_pic/202203/24/1000001009/cicle4_1648106348085.png"
                        ]
                    },
                    {
                        "qualificationName":"《增值电信业务许可证》",
                        "files":[

                    ]
                }
            ]
        },
        "industry":[
            {
                "qualificationCategoryName":" 国产特殊用途化妆品",
                "qualificationList":[
                    {
                        "qualificationName":"《国产非特殊用途化妆品备案登记凭证》",
                        "files":[
                            "/images/res/user_pic/202208/16/1000001009/icon_48_1660648176002.png"
                        ]
                    },
                    {
                        "qualificationName":"食药监局网上公示页面截图",
                        "files":[
                            "/images/res/user_pic/202208/16/1000001009/icon_48_1660648178916.png"
                        ]
                    },
                    {
                        "qualificationName":"《化妆品生产许可证》",
                        "files":[
                            "/images/res/user_pic/202208/16/1000001009/icon_48_1660648182409.png"
                        ]
                    }
                ]
            },
            {
                "qualificationCategoryName":"进口特殊用途化妆品",
                "qualificationList":[
                    {
                        "qualificationName":"《化妆品生产许可证》",
                        "files":[
                            "/images/res/user_pic/202208/16/1000001009/icon_48_1660648190868.png"
                        ]
                    },
                    {
                        "qualificationName":"《进口非特殊用途化妆品备案凭证》",
                        "files":[
                            "/images/res/user_pic/202208/16/1000001009/icon_16_1660648193369.png"
                        ]
                    }
                ]
            }
        ],
        "ext":{
            "qualificationList":[


            ]
        }
    },
    "pageFlag":0,
    "auditStatus":0
}



}

响应报文：

{
    "code":0,
    "data":{
        "id":86,
        "ownerId":1000001009,
        "industryCategoryFirst":"17",
        "industryCategoryFirstRemark":"快速消费品",
        "industryCategorySecond":"17008",
        "industryCategorySecondRemark":"一般化妆品",
        "industryCategoryThird":"170081",
        "industryCategoryThirdRemark":"一般化妆品1",
        "qualificationDetails":{
            "base":{
                "qualificationList":[
                    {
                        "qualificationName":"《营业执照》",
                        "files":[
                            "/images/res/user_pic/202203/21/1000001009/4_1647860665009.png",
                            "/images/res/user_pic/202203/21/1000001009/bg_1647860672884.png"
                        ]
                    },
                    {
                        "qualificationName":"ICP备案截图",
                        "files":[
                            "/images/res/user_pic/202203/24/1000001009/cicle04_1648106344461.png",
                            "/images/res/user_pic/202203/24/1000001009/cicle4_1648106348085.png"
                        ]
                    },
                    {
                        "qualificationName":"《增值电信业务许可证》",
                        "files":[

                    ]
                }
            ]
        },
        "industry":[
            {
                "qualificationCategoryName":" 国产特殊用途化妆品",
                "qualificationList":[
                    {
                        "qualificationName":"《国产非特殊用途化妆品备案登记凭证》",
                        "files":[
                            "/images/res/user_pic/202208/16/1000001009/icon_48_1660648176002.png"
                        ]
                    },
                    {
                        "qualificationName":"食药监局网上公示页面截图",
                        "files":[
                            "/images/res/user_pic/202208/16/1000001009/icon_48_1660648178916.png"
                        ]
                    },
                    {
                        "qualificationName":"《化妆品生产许可证》",
                        "files":[
                            "/images/res/user_pic/202208/16/1000001009/icon_48_1660648182409.png"
                        ]
                    }
                ]
            },
            {
                "qualificationCategoryName":"进口特殊用途化妆品",
                "qualificationList":[
                    {
                        "qualificationName":"《化妆品生产许可证》",
                        "files":[
                            "/images/res/user_pic/202208/16/1000001009/icon_48_1660648190868.png"
                        ]
                    },
                    {
                        "qualificationName":"《进口非特殊用途化妆品备案凭证》",
                        "files":[
                            "/images/res/user_pic/202208/16/1000001009/icon_16_1660648193369.png"
                        ]
                    }
                ]
            }
        ],
        "ext":{
            "qualificationList":[

            ]
        }
    }



}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是

Body

名称类型必须默认值备注
code
number否
data
object否
ownerId
number否客户id
industryCategoryFirst
string否一级行业标签code
industryCategoryFirstRemark
string否一级行业标签名称
industryCategorySecond
string否二级行业标签code
industryCategorySecondRemark
string否二级行业标签名称
qualificationDetails
object否证书详情
base
object否基础资质证书
qualificationList
object []否
qualificationName
string是资质名称
files
string []是资质图片url
industry
object []否行业资质证书
qualificationCategoryName
string是三级标签名称
qualificationList
object []是资质列表
qualificationName
string是资质名称
files
string []是资质图片url
ext
object否
qualificationList
string []否
pageFlag
number否
auditStatus
number否

返回数据

名称类型必须默认值备注
code
number否
data
object否
id
number否
ownerId
number否
industryCategoryFirst
string否一级行业标签code
industryCategoryFirstRemark
string否一级行业标签名称
industryCategorySecond
string否二级行业标签code
industryCategorySecondRemark
string否二级行业标签名称
qualificationDetails
object否证书详情
base
object否基础资质证书
qualificationList
object []否
qualificationName
string是资质名称
files
string []是资质图片url
industry
object []否行业资质证书
qualificationCategoryName
string是三级标签名称
qualificationList
object []是资质列表
qualificationName
string是资质名称
files
string []是资质图片url
ext
object否额外资质信息
qualificationList
string []否证书列表
pageFlag
number否
auditStatus
number否审核标记

16.5 资质送审（编辑）

基本信息

Path： /v3/communal/owner/customer/qualification/edit

Method： POST

接口描述：

注意：
1、资质图片 url 需要调用https://yapi-ads.wanyol.com/project/68/interface/api/8228文档 /v2/communal/owner/customer/uploadBusiLicenceImg 接口上传图片获取到 图片的路径填写到对应的file字段中。
只能使用v2接口不要使用v3
2、id必填 必须是该用户的资质id 用户资质id 需要根据用户id 查询现有资质返回报文中获取
请求实例：

{
        "id":86,
        "ownerId":1000001009,
        "industryCategoryFirst":"17",
        "industryCategoryFirstRemark":"快速消费品",
        "industryCategorySecond":"17008",
        "industryCategorySecondRemark":"一般化妆品",
        "qualificationDetails":{
            "base":{
                "qualificationList":[
                    {
                        "qualificationName":"《营业执照》",
                        "files":[
                            "/images/res/user_pic/202203/21/1000001009/4_1647860665009.png",
                            "/images/res/user_pic/202203/21/1000001009/bg_1647860672884.png"
                        ]
                    },
                    {
                        "qualificationName":"ICP备案截图",
                        "files":[
                            "/images/res/user_pic/202203/24/1000001009/cicle04_1648106344461.png",
                            "/images/res/user_pic/202203/24/1000001009/cicle4_1648106348085.png"
                        ]
                    },
                    {
                        "qualificationName":"《增值电信业务许可证》",
                        "files":[

                    ]
                }
            ]
        },
        "industry":[
            {
                "qualificationCategoryName":" 国产特殊用途化妆品",
                "qualificationList":[
                    {
                        "qualificationName":"《国产非特殊用途化妆品备案登记凭证》",
                        "files":[
                            "/images/res/user_pic/202208/16/1000001009/icon_48_1660648176002.png"
                        ]
                    },
                    {
                        "qualificationName":"食药监局网上公示页面截图",
                        "files":[
                            "/images/res/user_pic/202208/16/1000001009/icon_48_1660648178916.png"
                        ]
                    },
                    {
                        "qualificationName":"《化妆品生产许可证》",
                        "files":[
                            "/images/res/user_pic/202208/16/1000001009/icon_48_1660648182409.png"
                        ]
                    }
                ]
            },
            {
                "qualificationCategoryName":"进口特殊用途化妆品",
                "qualificationList":[
                    {
                        "qualificationName":"《化妆品生产许可证》",
                        "files":[
                            "/images/res/user_pic/202208/16/1000001009/icon_48_1660648190868.png"
                        ]
                    },
                    {
                        "qualificationName":"《进口非特殊用途化妆品备案凭证》",
                        "files":[
                            "/images/res/user_pic/202208/16/1000001009/icon_16_1660648193369.png"
                        ]
                    }
                ]
            }
        ],
        "ext":{
            "qualificationList":[


            ]
        }
    },
    "pageFlag":0,
    "auditStatus":0
}



}

响应报文：

{
    "code":0,
    "data":{
        "id":86,
        "ownerId":1000001009,
        "industryCategoryFirst":"17",
        "industryCategoryFirstRemark":"快速消费品",
        "industryCategorySecond":"17008",
        "industryCategorySecondRemark":"一般化妆品",
        "qualificationDetails":{
            "base":{
                "qualificationList":[
                    {
                        "qualificationName":"《营业执照》",
                        "files":[
                            "/images/res/user_pic/202203/21/1000001009/4_1647860665009.png",
                            "/images/res/user_pic/202203/21/1000001009/bg_1647860672884.png"
                        ]
                    },
                    {
                        "qualificationName":"ICP备案截图",
                        "files":[
                            "/images/res/user_pic/202203/24/1000001009/cicle04_1648106344461.png",
                            "/images/res/user_pic/202203/24/1000001009/cicle4_1648106348085.png"
                        ]
                    },
                    {
                        "qualificationName":"《增值电信业务许可证》",
                        "files":[

                    ]
                }
            ]
        },
        "industry":[
            {
                "qualificationCategoryName":" 国产特殊用途化妆品",
                "qualificationList":[
                    {
                        "qualificationName":"《国产非特殊用途化妆品备案登记凭证》",
                        "files":[
                            "/images/res/user_pic/202208/16/1000001009/icon_48_1660648176002.png"
                        ]
                    },
                    {
                        "qualificationName":"食药监局网上公示页面截图",
                        "files":[
                            "/images/res/user_pic/202208/16/1000001009/icon_48_1660648178916.png"
                        ]
                    },
                    {
                        "qualificationName":"《化妆品生产许可证》",
                        "files":[
                            "/images/res/user_pic/202208/16/1000001009/icon_48_1660648182409.png"
                        ]
                    }
                ]
            },
            {
                "qualificationCategoryName":"进口特殊用途化妆品",
                "qualificationList":[
                    {
                        "qualificationName":"《化妆品生产许可证》",
                        "files":[
                            "/images/res/user_pic/202208/16/1000001009/icon_48_1660648190868.png"
                        ]
                    },
                    {
                        "qualificationName":"《进口非特殊用途化妆品备案凭证》",
                        "files":[
                            "/images/res/user_pic/202208/16/1000001009/icon_16_1660648193369.png"
                        ]
                    }
                ]
            }
        ],
        "ext":{
            "qualificationList":[

            ]
        }
    }



}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是

Body

名称类型必须默认值备注
code
number否
data
object否
id
number否
ownerId
number否客户id
industryCategoryFirst
string否一级行业标签code
industryCategoryFirstRemark
string否一级行业标签名称
industryCategorySecond
string否二级行业标签code
industryCategorySecondRemark
string否二级行业标签名称
qualificationDetails
object否证书详情
base
object否基础资质证书
qualificationList
object []否
qualificationName
string是资质名称
files
string []是资质图片url
industry
object []否行业资质证书
qualificationCategoryName
string是三级标签名称
qualificationList
object []是资质列表
qualificationName
string是资质名称
files
string []是资质图片url
ext
object否
qualificationList
string []否
pageFlag
number否
auditStatus
number否

返回数据

名称类型必须默认值备注
code
number否
data
object否
id
number否需要修改用户资质信息id
ownerId
number否
industryCategoryFirst
string否一级行业标签code
industryCategoryFirstRemark
string否一级行业标签名称
industryCategorySecond
string否二级行业标签code
industryCategorySecondRemark
string否二级行业标签名称
qualificationDetails
object否证书详情
base
object否基础资质证书
qualificationList
object []否
qualificationName
string是资质名称
files
string []是资质图片url
industry
object []否行业资质证书
qualificationCategoryName
string是三级标签名称
qualificationList
object []是资质列表
qualificationName
string是资质名称
files
string []是资质图片url
ext
object否额外资质信息
qualificationList
string []否证书列表
pageFlag
number否
auditStatus
number否审核标记

17.程序化广告管理

17.1 新增程序化广告

基本信息

Path： /v3/ad/program/add

Method： POST

接口描述：

1.基本规则
程序化广告所使用字段，需符合普通广告的校验规则，如文案、名称、规格与图片的校验等。
2.程序化广告校验规则
（1）需先开通程序化广告权限，才能通过页面或者api创建程序化广告。
（2）当前仅规格支持横版大图规格，即globalSpecId=1，globalSpecName=“横版大图”。
（3）广告组相关：需先创建一个普通广告组，流量场景为信息流（当前仅支持信息流），下面必须无普通广告才能新建程序化广告，一键继承、游戏预约广告组等均不支持创建程序化广告。
（4）文案（copywriterValues）、图片（imgIds）数量至少1个，至多3个。
（5）除了文案与图片外，其他所传字段，属于该组广告共用的，如品牌名称、logo、各种监测链接等，不能单独修改。创建后会为每个广告生成一个默认的名称，可以通过/v3/ad/batch接口修改名称，只有名称可以单独修改，其他字段不能单独修改，需通过/v3/ad/program/edit修改

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是 multipart/form-data

Body

参数名称 参数类型 必须 示例 备注
adPlanId 文本 是 200272119 计划id
adGroupId 文本 是 300459130 广告组id
creativeReqs[0].copywriterValues[0] 文本 是 文案a,文案b 文案内容列表
creativeReqs[0].imgIds[0] 文本 是 44234272,44233618 图片id列表
creativeReqs[0].brandLogoImgId 文本 是 44238896 品牌logo的图片id
creativeReqs[0].brandName 文本 是 品牌名称1 品牌名称
creativeReqs[0].globalSpecId 文本 是 1 规格id
creativeReqs[0].globalSpecName 文本 是 横版大图 规格名称
creativeReqs[0].exposeUrl 文本 否 曝光监测链接
creativeReqs[0].clickUrl 文本 否 点击监测链接
creativeReqs[0].exposeEndUrl 文本 否 曝光结束监测链接
creativeReqs[0].playBeginUrl 文本 否 开始播放监测链接
creativeReqs[0].playEndUrl 文本 否 结束播放监测链接
creativeReqs[0].downloadUrl 文本 否 下载监测链接

返回数据

名称类型必须默认值备注
code
integer否
msg
string否
data
integer []否
否新建成功的广告id

17.2 编辑程序化广告

基本信息

Path： /v3/ad/program/edit

Method： POST

接口描述：

1.基本规则
创建所使用字段，需符合普通广告的规则，如文案、名称、规格与图片的校验等
2.程序化广告校验规则
（1）需先开通程序化广告权限，才能通过页面或者api创建程序化广告。
（2）当前仅规格支持横版大图规格，即globalSpecId=1，globalSpecName=“横版大图”。
（3）广告组相关：需先创建一个普通广告组，流量场景为信息流（当前仅支持信息流），下面必须无普通广告才能新建程序化广告，一键继承、游戏预约广告组等均不支持创建程序化广告。
（4）文案（copywriterValues）、图片（imgIds）数量至少1个，至多3个。
（5）除了文案与图片外，其他所传字段，属于该组广告共用的，如品牌名称、logo、各种监测链接等，不能单独修改。创建后会为每个广告生成一个默认的名称，可以通过/v3/ad/batch接口修改名称，只有名称可以单独修改，其他字段不能单独修改，需通过/v3/ad/program/edit修改
（6）编辑时，文案与图片相乘的最终数量，不能比原来该批程序化广告的数量少，只能增加或一样不能减

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/x-www-form-urlencoded 是 multipart/form-data

Body

参数名称 参数类型 必须 示例 备注
adPlanId 文本 是 200272119 计划id
adGroupId 文本 是 300459130 广告组id
creativeReqs[0].copywriterValues[0] 文本 是 文案a,文案b 文案内容列表，注意文案与图片的组合数量不能少于原广告
creativeReqs[0].imgIds[0] 文本 是 44234272,44233618,44233619 图片id列表，注意文案与图片的组合数量不能少于原广告
creativeReqs[0].brandLogoImgId 文本 是 44236579 品牌logo的图片id
creativeReqs[0].brandName 文本 是 品牌名称2 品牌名称
creativeReqs[0].globalSpecId 文本 是 1 规格id
creativeReqs[0].globalSpecName 文本 是 横版大图 规格名称
creativeReqs[0].exposeUrl 文本 否 曝光监测链接
creativeReqs[0].clickUrl 文本 否 点击监测链接
creativeReqs[0].exposeEndUrl 文本 否 曝光结束监测链接
creativeReqs[0].playBeginUrl 文本 否 开始播放监测链接
creativeReqs[0].playEndUrl 文本 否 结束播放监测链接
creativeReqs[0].downloadUrl 文本 否 下载监测链接

返回数据

名称类型必须默认值备注
code
integer否
msg
string否
data
integer []否
否修改成功的广告id

17.3 查询程序化广告组详情

基本信息

Path： /v3/ad/program/get

Method： GET

接口描述：

请求参数：

groupId=300442120

返回示例：

{
    "code": 0,
    "data": {
        "planId": 200261483,
        "groupId": 300442120,
        "ownerId": 1100050114,
        "sourceList": [
            {
                "copywriters": {
                    "30020": "还在纠结车买哪款车？汽车专用，轻松驾驭！",
                    "30021": "汽车玻璃别再用高仿了！这款防雾剂，2秒安装，防雾不伤车漆！",
                    "30022": "汽车一次性保养终身维护服务，让你的爱车更加舒适！"
                },

                "copywriterList": ["还在纠结车买哪款车？汽车专用，轻松驾驭！","汽车玻璃别再用高仿了！这款防雾剂，2秒安装，防雾不伤车漆！","汽车一次性保养终身维护服务，让你的爱车更加舒适！"],

                "imgs": {

                    "44236576": "https://adsfs-ads-test.wanyol.com/ads-material-depot/image/967e7925a3d6d581414323e189aa2c8e.jpg",

                    "44236534": "https://adsfs-ads-test.wanyol.com/ads-material-depot/image/beb15c8b6043c4c22003afd1b838dbb7.jpg",

                    "44236581": "https://adsfs-ads-test.wanyol.com/ads-material-depot/image/9c5694c8f73c5804d00f7ea8318e6040.jpg"

                },

                "brandLogoImgId": 44231018,

                "brandLogoUrl": "https://adsfs-ads-test.wanyol.com/ads-material-depot/image/2d2ae567e4e5265b56fba9b1b2a8eb6e.jpg",

                "brandName": "test",

                "globalSpecId": 1,

                "exposeUrl": "",

                "clickUrl": "",

                "exposeEndUrl": null,

                "playBeginUrl": null,

                "playEndUrl": null,

                "downloadUrl": ""

            }

        ]

    }

}

请求参数

Query

参数名称 必须 示例 备注
groupId 是 300442120 广告组id

返回数据

名称类型必须默认值备注
code
integer否
msg
string否
data
object否
planId
integer否广告计划id
groupId
integer否广告组id
ownerId
integer否广告主id
sourceList
object []否素材数据源list
copywriters
object否文案及id列表(过期，不再使用)
0
string否
copywriterList
string []否文案列表
imgs
object否图片列表
0
string否
brandLogoImgId
integer否品牌logo的图片id
brandLogoUrl
string否品牌logo的图片url
brandName
string否品牌名称
globalSpecId
integer否规格id
exposeUrl
string否曝光监测链接
clickUrl
string否点击监测链接
exposeEndUrl
string否曝光结束监测链接
playBeginUrl
string否开始播放监测链接
playEndUrl
string否结束播放监测链接
downloadUrl
string否下载监测链接

18. 商品库

18.1 商品批量入库接口

基本信息

Path： /dpa/v2/product/batchSave

Method： POST

接口描述：

接口描述：
商品批量入库，如果id不存在，将插入，如果id已存在，将更新。单次调用商品数量上限100条，单个商品库内商品数量上限100w

DPA与SDPA使用说明：
DPA与SDPA都可使用该批量更新或添加商品，DPA与SDPA大部分字段相同，SDPA增加了投放的一些额外必填字段

测试环境域名：https://sapi-ads-test.wanyol.com
线上环境域名：https://sapi.ads.heytapmobi.com

普通广告商品库的商品字段枚举：
1、地区：

地区
内地
中国香港
中国台湾
韩国
印度
美国
英国
日本
俄罗斯
泰国
其他

2、短剧细分类目：
image.png
image.png

3、小说细分类目：
image.png
image.png
image.png
请求示例：

{
  "dtoList": [
    {
      "productId": "998877",
      "productName": "名称修改1",
      "imgUrl": "https://adsfs-ads-test.wanyol.com/cdn/marketing/res/v2/dpa/common/mat_pic/1000120102/9064/9976f3f3c3e6e232b1667f2bccbc4af5.jpg",
      "price":25,
      "brandName":"nihao"
    },
    {
      "productId": "778899",
      "productName": "名称修改2",
      "imgUrl": "https://adsfs-ads-test.wanyol.com/cdn/marketing/res/v2/dpa/common/mat_pic/1000120102/9070/4051d067f16a8eacaf0b2cfe4b931dd2.jpg",
      "price":80,
      "brandName":"n66ihao"
    }
  ],
  "houseId": 9109
}

响应报文：

{
    "code": 0,
    "msg": "success",
    "data": {
        "insertIdSet": [],
        "updateIdSet": [
            "998877",
            "778899"
        ],
        "unChangeIdSet": []
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是

Body

名称类型必须默认值备注
dtoList
object []是商品列表，单次最多100个
productId
string是商品id
productName
string是商品名称
imgUrl
string是商品图片（主图）
imgWidth
integer是商品图片宽（主图）， 1、SDPA投放使用；2、SDPA模板模式投放或DPA非必填
imgHeight
integer是商品图片高（主图），1、SDPA投放使用；2、SDPA模板模式投放或DPA非必填
imgDescription
string是商品图片描述（主图），1、SDPA投放使用；2、SDPA模板模式投放或DPA非必填
images
object []否商品扩展图列表（SDPA投放使用）
url
string是扩展图url
width
integer是扩展图宽
height
integer是扩展图高
description
string是扩展图描述
videos
object []否商品扩展视频列表（SDPA投放使用）
url
string是扩展视频url
width
integer是扩展视频宽
height
integer是扩展视频高
description
string是扩展视频描述
duration
integer是扩展视频时长，单位秒
imgUrl
string是视频图片url
imgWidth
integer是视频图片宽
imgHeight
integer是视频图片高
size
integer是视频大小，单位为Byte
targetUrl
string否落地页链接
deepLinkUrl
string否商品deepLink链接
brandName
string否品牌名称（SDPA直投模式必填）
brandLogo
string否品牌logo图片地址（SDPA直投模式必填）
brandH5Url
string否品牌url
title
string否标题
subTitle
string否子标题
price
integer否商品原价格,单位:分
promotionPrice
integer否商品促销价格,单位:分
discountRate
number否促销折扣
slogan
string否商品slogan
provinceName
string否省份名称
cityName
string否城市名称
countyName
string否区县名称
priceShow
string否商品价格展示文字
promotionPriceShow
string否折扣价格展示文字
category
string否一级分类，普通广告商品库下的商品必填
subCategory
string否二级分类，普通广告商品库下的商品必填
thirdCategory
string否三级分类
categoryId
number否Long型，一级分类id
subCategoryId
number否Long型，二级分类id
thirdCategoryId
number否Long型，三级分类id
merchantName
string否商家名称
description
string否商品描述
onlineTimestamp
number否Long型，商品上架时间戳
offlineTimestamp
number否Long型，商品下架时间戳
tags
string否标签
spuId
string否商品组id
author
string否作者/发布者
authorFansCount
integer否作者粉丝数
showCount
integer否曝光次数
favoriteCount
integer否收藏用户数
likeCount
integer否被喜欢或点赞数
commentCount
integer否评论数量
forwardCount
integer否转发数量
semanticLabel
string否语义标签
fullText
string否全文内容,最多100字
customLabel1
string否自定义标签1
customLabel2
string否自定义标签2
customLabel3
string否自定义标签3
customLabel4
string否自定义标签4
customLabel5
string否自定义标签5
gender
string否性别频道，0：不限，1：男频，2：女频，必填，备注：普通广告商品库（小说、短剧）的商品新增字段
area
string否区域，备注：普通广告商品库（小说、短剧）的商品新增字段
totalBytes
string否小说总字数，小说行业必填，备注：普通广告商品库（小说）的商品新增字段
totalSubjects
string否小说总章节或短剧总集数，备注：普通广告商品库（小说、短剧）的商品新增字段
timePerSubject
string否短剧单集时长（秒）短剧行业必填，备注：普通广告商品库（短剧）的商品新增字段
paymentType
string否付费/免费 1：付费，2：免费，必填，备注：普通广告商品库（小说、短剧）的商品新增字段
startPaySubject
string否小说起始付费章节，短剧起始付费集数，备注：普通广告商品库（小说、短剧）的商品新增字段
minAmount
string否小说最低付费金额（分），短剧最低充值档位（分），备注：普通广告商品库（小说、短剧）的商品新增字段
maxAmount
string否最高付费金额（分），短剧最高充值档位（分，备注：普通广告商品库（小说、短剧）的商品新增字段
amountPerSubject
string否小说每章付费金额（分），短剧单集付费金额（分），备注：普通广告商品库（小说、短剧）的商品新增字段
label
string否标签，多个标签以英文逗号隔开，最多传入10个标签，备注：普通广告商品库（小说、短剧）的商品新增字段
houseId
number是商品库id

返回数据

名称类型必须默认值备注
code
number是0-成功，其余为失败
msg
string否
data
object否
insertIdSet
string []否新增的id列表
updateIdSet
string []否更新的id列表
unChangeIdSet
string []否不变的id列表

18.2 通过XML导入商品对接文档

基本信息

Path： /

Method： POST

接口描述：

1.名词解释

1.1 商品库，商品文件，商品

商品库是商品的集合，一个账户只能建立10个商品库，一个商品库下可建10个商品文件，一个商品文件对应多个商品，一个商品库最多有100w个商品，一个商品有多种属性（图片，名称，价格等）。

1.2 商品数据xml文件，索引数据xml文件

商品数据xml文件保存的是商品的字段信息，系统解析该文件对商品库进行更新。
索引数据xml文件保存的是商品数据xml文件的拉取地址，可以存放多个。
 

2.商品对接

2.1 创建商品库

在 营销平台->商品广告界面 新建商品库，一个账户最多可以建10个商品库，商品库有直投模式和模板模式，选择后无法更改。

2.2 模板制作与合成

我们支持将商品中的某些文字和图片合成在模板上，可支持合成的字段具体有：
product_name，img_url，brand_name，brand_logo，price，promotion_price，discount_rate，slogan，price_show，promotion_price_show（字段定义见下方xml格式说明）

客户可以在 商品广告->模板管理页面 下，创建和管理自己的模板，一个广告主最多有5个模板，模板需要绑定商品库，且状态为发布，在定时任务执行时才会合成。可以用过预览界面，可以查看模板合成后的效果图

其中需注意的是，价格展示优先级规则：价格会优先取price_show，promotion_price_show 这两个字段，如对价格的展示有特殊需求，如：100元/个，1分钱起等，可以将自定义的价格展示文字填入该字段，我们会直接取该文字合成展示。
如果price_show，promotion_price_show没有值，则取price，promotion_price字段，该价格会将小数点最后的0去除，如1.20 -> 1.2，1.00 -> 1，折扣会保留到整数，如6.5折 -> 6折。客户可以联系对接人员提供已有的模板示例和合成效果，便于确定自己的设计效果

如果已经定义的字段，无法满足客户合成需求的，客户可以自定义扩展合成字段，以ext_compose_img开头的字段表示合成图片，以ext_compose_text开头的字段标识合成文字。比如除了已经定义的图片，还想给商品加2张图片合成，可在xml中填充ext_compose_img_1, ext_compose_img_2，将需要合成的图片地址填入，这样即可支持合成

2.3 DPA+LBS定向推荐

需要进行LBS定向推荐的，在商品对接字段中，需将市、区县的名称填入对应字段，可以只填市级，不可只填区级，名称以oppo提供的省市区县文件为准，由对接人提供。
在广告播放的时候，会根据对应设备的地域随机出一个商品素材。需要注意，不是每个设备都能定位到区县

3.权限

3.1 定时拉取的方式，在客户上传文件链接前，需提供客户的域名给oppo配置域名白名单（必需）
3.2 鉴权token会在拉取xml文件时，放在请求头Authorization中，客户可用此字段进行token验证，若无则不填
3.3 如果客户方有ip白名单限制，请对以下ip段添加白名单：
北京汇天 电信：106.39.217.128-106.39.217.159
北京汇天 联通：123.58.102.128-123.58.102.159
北京汇天 移动：223.70.235.32-223.70.235.63
北京昌平 联通：111.206.203.64-111.206.203.79 111.206.203.96-111.206.203.126
北京昌平 电信：106.3.19.224-106.3.19.255 106.3.19.64-106.3.19.79

4.xml文件对接

4.1 页面操作

在商品库页面新建商品文件，有2种接入方式。
（1）手动上传：上传本地xml文件，系统将解析其中的商品数据。适用于商品规模不大，且不需要经常更新数据的场景，xml文件大小限制50MB内，手动上传时会立即对该商品文件进行解析，该文件为一次性读取，后面不会再读取
（2）定时拉取：录入定时拉取xml的信息，系统会在每天定时去拉取对应的商品数据并解析更新，适用于商品规模大的场景。支持录入xml(商品数据xml文件)和xml siteMap(索引数据xml文件)两种格式的拉取信息录入。
定时拉取需先校验成功才能提交，token如有则填写。文件校验会请求填写的链接地址，拉取商品文件，对该商品文件第一组商品标签进行解析，若正确则校验通过

4.2 xml商品字段说明

其中重点关注字段：product_id，product_name，img_url，target_url，deeplink_url，title ，需要合成的字段，以及需要LBS定向的字段。
xml示例文件由对接人提供：
https://odocs.myoas.com/file/47kgJOlx4nuGE8qV
https://odocs.myoas.com/file/m8AZVlg5KzUm7aAb
字段名 类型 必填 描述 是否支
持合成
product_id String 是 商品id，一个商品库内必须唯一 否
product_name String 是 商品名称 是
img_url String 是 商品图片地址（主图） 是
img_width Integer 是 商品图片宽（主图）
1、SDPA投放使用
2、SDPA模板模式投放或DPA非必填		 否
img_height Integer 是 商品图片高（主图）
1、SDPA投放使用
2、SDPA模板模式投放或DPA非必填		 否
img_description String 是 商品图片描述（主图）
1、SDPA投放使用
2、SDPA模板模式投放或DPA非必填		 否
images Object[] 否 商品扩展图列表，详情见商品扩展图字段（SDPA投放使用） 是
videos Object[] 否 商品扩展视频列表，详情见商品扩展视频字段（SDPA投放使用） 是
target_url String 否 商品图片跳转地址，播放时经过DPA将会替换为该值，为空则不替换 否
deeplink_url String 否 deeplink链接，播放时经过DPA将会替换为该值，为空则不替换 否
brand_name String 否 品牌名称（SDPA直投模式必填） 是
brand_logo String 否 品牌图片地址（SDPA直投模式必填） 是
brand_h5_url String 否 品牌跳转链接 否
title String 否 标题 否
sub_title String 否 子标题 否
price String 否 商品原价，单位：元 是
promotion_price String 否 商品促销价，单位：元 是
discount_rate Double 否 折扣 是
slogan String 否 商品标语 是
city_name String 否 市名称（例:广州） 是
county_name String 否 区县名称（例:从化区） 是
price_show String 否 商品原价显示文字 是
promotion_price_show String 否 商品促销价显示文字 是
ext_compose_img_开头的 String 否 扩展合成图片，如ext_compose_img_1，用于填充需要合成的其他字段，含义由客户自定义，数量20个以内 是
ext_compose_text_开头的 String 否 扩展合成文字，如ext_compose_text_1，用于填充需要合成的其他字段，含义由客户自定义，数量20个以内 是
category String 否 一级分类 否
sub_category String 否 二级分类 否
third_category String 否 三级分类 否
category_id Long 否 一级分类id 否
sub_category_id Long 否 二级分类id 否
third_category_id Long 否 三级分类id 否
merchant_name String 否 商家名称 否
description String 否 商品描述 否
online_time Long 否 商品上架时间戳 否
offline_time Long 否 商品下架时间戳 否
tags String 否 标签 否
spuId String 否 商品组id 否
author String 否 作者/发布者 否
author_fans_count Integer 否 作者粉丝数 否
show_count Integer 否 曝光次数 否
favorite_count Integer 否 收藏用户数 否
like_count Integer 否 被喜欢或点赞数 否
comment_count Integer 否 评论数量 否
forward_Count Integer 否 转发数量 否
semantic_label String 否 语义标签 否
full_text String 否 全文内容,最多100字 否
custom_label_1 String 否 自定义标签1 否
custom_label_2 String 否 自定义标签2 否
custom_label_3 String 否 自定义标签3 否
custom_label_4 String 否 自定义标签4 否
custom_label_5 String 否 自定义标签5 否

商品扩展图字段（通过<img></img>标签区分具体图片）：
字段名 类型 必填 描述 是否支
持合成
url String 是 扩展图url 是
width Integer 是 扩展图宽 否
height Integer 是 扩展图高 否
description String 是 扩展图描述 否

商品扩展视频字段（通过<video></video>标签区分具体视频）：
字段名 类型 必填 描述 是否支
持合成
url String 是 扩展视频url 否
width Integer 是 扩展视频宽 否
height Integer 是 扩展视频高 否
duration Integer 是 扩展视频时长，单位秒 否
description String 是 扩展视频描述 否
img_url String 是 视频图片url 否
img_width Integer 是 视频图片宽 否
img_height Integer 是 视频图片高 否
size Integer 是 视频大小，单位为Byte 否
4.3 特殊符号

如果填写的xml内容中包含特殊符号：& < >" '，需要用"文本"]]>将文本包起来，不然无法正常解析

5.其他

  1. 在解析商品时，如果本次解析商品id在商品库中不存在，则插入，如果商品id已存在，将商品数据更新为最新的。如果本次解析没有，此前已存在的商品，状态不变
  2. 定时拉取，商品数据xml文件大小最好在50MB内，文件太大将影响解析速度，大文件建议拆分为多个放到索引数据xml文件中
  3. 定时拉取时间在每日凌晨1点，商品数据需在此时间点前放到对应的拉取地址
  4. 如果某标签确定没有值，那么直接将该标签去掉，可以加快解析速度

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是

18.3 商品批量删除接口

基本信息

Path： /dpa/v2/product/deleteByIds

Method： POST

接口描述：

备注：
商品被删除后，将无法在营销平台查询到该商品，如果通过手动上传或定时拉取的xml中依然包含该商品，将被视为新增了该商品
请求示例：

{
    "hId":9327,
    "pIdList":["3ksdj2s2fse5e38888888","3ksdj2s2fse5e3999999"]
}

响应报文：

{
    "code": 0,
    "msg": "success",
    "data": 1
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是

Body

名称类型必须默认值备注
hId
number是商品库ID
pIdList
string []是商品ID列表
否商品ID

返回数据

名称类型必须默认值备注
code
number是0-成功，其余为失败
msg
string否
data
integer否删除成功的商品条数

18.4 商品库商品查询接口

基本信息

Path： /dpa/v2/product/page

Method： POST

接口描述：

响应报文：

{
    "code": 0,
    "msg": "msg",
    "data": {
        "lastMinId": "3ksdj2s2fse5e3111212",
        "pageSize": 10,
        "records": [
            {
                "imgUrl": "https://adsfs-ads-test.wanyol.com/cdn/marketing/res/v2/dpa/common/mat_pic/1100047375/9075/edfb00eb9058bf15ad02819694a33179.jpg",
                "insertTime": 1698809508424,
                "updateTime": 1698809508424,
                "pId": "3ksdj2s2fse5e38888888",
                "pName": "商品二测试28"
            },
            {
                "imgUrl": "https://adsfs-ads-test.wanyol.com/cdn/marketing/res/v2/dpa/common/mat_pic/1100047375/9075/edfb00eb9058bf15ad02819694a33179.jpg",
                "insertTime": 1698809508424,
                "updateTime": 1698809508424,
                "pId": "3ksdj2s2fse5e3111212",
                "pName": "创新晶体30"
            }
        ]
    }
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是

Body

名称类型必须默认值备注
hId
number是商品库ID
pIdList
string []否商品ID列表，精确匹配
pName
string否商品名称
lastMinId
string否上一次查询返回的lastMinId，第一次查询则不传
pageSize
string否查询大小，默认10
filterUsed
string否是否过滤已投放商品，0或不传：返回全量商品 1：只返回未投放的商品 2: 只返回已投放的商品

返回数据

名称类型必须默认值备注
code
number否
msg
string否
data
object否
lastMinId
string否本次查询返回的商品列表中最后的商品ID
pageSize
number否查询数量大小
records
object []否商品列表
imgUrl
string否商品原始图片
insertTime
number否商品入库时间
updateTime
number否商品更新时间
pId
string否商品id
pName
string否商品名称
composeComplete
string否商品是否与绑定的所有模板完成合成，0-未完成，1-已完成

18.5 商品库授权

基本信息

Path： /dpa/v2/house/authorize

Method： POST

接口描述：

请求示例：

{
    "hId":9327,
    "ownerIds":[38888888,3999999]
}

响应报文：

{
    "code": 0,
    "msg": "success",
    "data": 1
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是

Body

名称类型必须默认值备注
hId
number是商品库ID
ownerIds
number []是商品ID列表
否要授权的广告主ID列表

返回数据

名称类型必须默认值备注
code
number是0-成功，其余为失败
msg
string否
data
integer否授权成功的广告主个数

18.6 商品库取消授权

基本信息

Path： /dpa/v2/house/cancel_authorize

Method： POST

接口描述：

请求示例：

{
    "hId":9327,
    "ownerIds":[38888888,3999999]
}

响应报文：

{
    "code": 0,
    "msg": "success",
    "data": 1
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是

Body

名称类型必须默认值备注
hId
number是商品库ID
ownerIds
number []是商品ID列表
否取消授权的广告主ID列表

返回数据

名称类型必须默认值备注
code
number是0-成功，其余为失败
msg
string否
data
integer否取消授权成功的广告主个数

18.7 查询商品库授权列表

基本信息

Path： /dpa/v2/house/authorizzation/list

Method： GET

接口描述：

响应报文：

{
    "code": 0,
    "msg": "msg",
    "data": [
        {
            "ownerId": 1100050114,
            "authorizeTime": 1700569596000
        }
    ]
}

请求参数

Headers

参数名称 参数值 必须 示例 备注
Content-Type application/json 是

Query

参数名称 必须 示例 备注
hId 是 商品库ID

返回数据

名称类型必须默认值备注
code
number是0-成功，其余为失败
msg
string否
data
object否授权成功的广告主个数
ownerId
string是授权的广告主ID
authorizeTime
string是授权时间

附录

附录

1 返回码定义

1 返回码定义
  code msg 备注
正常返回 0 操作成功，没有错误 接口正常返回，若是查询接口，判断data为空表示数据不存在
业务异常 >0 ${具体业务异常信息} 接口出现业务异常，如必填参数缺失等，需要将msg提示出来
系统相关 -1 未知系统错误，请重试。 如稳定复现请保留请求信息并向OPPO侧反馈
权限相关 100001 HttpHeader的Authorization不存在  
100002 Token不存在  
100003 Token错误  
100004 Token中的广告主ID不是数字  
100005 Token中广告主ID错误  
100006 Token中时间不是数值  
100007 广告主非审核通过状态  
100008 Token过期  
100009 Token签名错误  
100010 操作的广告主与当前代理商不存在代理关系  
100012 不允许代理直接操作该接口，请传入操作的子账号ownerId  
100013 未授权的请求  
100016 token参数错误，时间戳单位应为秒  
请求头格式 100014 应为表单格式请求，Content-type=application/x-www-form-urlencoded  
100015 json格式请求头错误，Content-type=application/json  

 

2 枚举定义

1 推广目标

extensionType - 广告计划层级、广告组层级、广告层级会冗余
枚举值 枚举名称
0 默认值（无含义）
1 链接推广（网页推广） 
2 应用推广
3 快应用推广
7 小程序推广
8 直播推广

2 推广流量

extensionFlow - 广告组层级、广告层级会冗余）：全流量场景、自有流量、联盟流量
枚举值 枚举名称
0 默认值（无含义）
1 全流量场景 
2 自有流量
3 联盟流量

3 流量场景

flowScene - 广告组层级、广告层级会冗余）：精选推广、安装有礼、开机必备、搜索、信息流、Banner、开屏、插屏等
枚举值 枚举名称
0 默认值（无含义）
1 全流量场景 
2 精选推广
3 安装有礼
4 开机必备
5 搜索
6 信息流
7 Banner
8 开屏
9 插屏
10 原生
11 激励视频
12 联盟通投
13 展示优选

4 广告版本

计划、广告组、广告层级都会有这个字段区分。
枚举 含义
2 旧版本广告（默认值）
3 融合投放3.0广告

5 转化类型
转化类型 ocpcType 备注
下载 1 download
激活 2 active
其他 3 other ，占位字段 (需要有个值来表示空)
游戏注册 4 register
游戏付费 5 pay
表单注册 6 h5register
注册 7 app_register
回传激活 8 return_active
应用付费 9 apppay
回传留存 10 Retention
应用内自定义转化 11  
应用内授信 12  
应用内下单（电商） 13  
deeplink拉活 14  
系统留存（OS次留） 15  
deeplink回传激活 16  
deeplink回传注册 17  
deeplink应用付费 18  
deeplink应用内自定义转化 19  
deeplink应用内授信 20  
deeplink应用内下单 21  
快应用付费 22  
游戏付费ROI1 23  

6 落地页类型
枚举 含义
0 自定义落地页
1 一叶智能
2 云脑建站
4 萤火虫建站
5 快应用建站
6 广告主自建页面 JS SDK
7 广告主自建页面 H5 API 回传
8 信息流 线索直达
9 商店详情页
11 萤火虫应用模板下载页
12 互动落地页

7 定向属性ID映射名称关系
值 描述
1 年龄
2 性别
3 区域
4 应用活跃
14 应用非活跃
5 应用类别活跃
6 人群
7 机型
8 网络
9 价格
10 应用已安装
11 应用未安装
12 用户常驻地
13 兴趣标签
15 App定向
16 APP逆定向
17 APP分类流量定向
18 应用从安装

8 性别（sex）
值 描述
0 未知
1 女
2 男
999 不限

9 年龄（age）
值 描述
0 未知
1 10~17
2 18~24
3 25~34
4 35~49
5 50~70
999 不限

10 机型价格(price)
值 描述
1 <1000
2 1000-1999
3 2000-2999
4 3000+

11 地域（area），见附件编码表
值 描述
999 不限

12 地域编码对照表
0 其他 1 北京 2 上海 3 天津 4 广东
5 福建 8 海南 9 安徽 10 贵州 11 甘肃
12 广西 13 河北 14 河南 15 黑龙江 16 湖北
17 湖南 18 吉林 19 江苏 20 江西 21 辽宁
22 内蒙古 23 宁夏 24 青海 25 山东 26 山西
27 陕西 28 四川 29 西藏 30 新疆 31 云南
32 浙江 33 重庆 34 香港 35 台湾 36 澳门
38 吉林市 39 白城 40 长春 41 辽源 42 白山
43 四平 44 松原 45 通化 47 延边朝鲜族自治州 48 莆田
49 南平 50 龙岩 51 宁德 52 泉州 53 淮安
54 常州 55 南京 56 南通 57 连云港 58 徐州
59 苏州 60 宿迁 61 泰州 62 无锡 63 盐城
64 扬州 65 镇江 66 三明 67 九江 68 吉安
69 景德镇 70 厦门 71 萍乡 72 南昌 73 新余
74 上饶 75 宜春 76 鹰潭 77 赣州 78 抚州
80 漳州 81 福州 82 江门 83 揭阳 84 广州
85 潮州 86 茂名 88 梅州 89 清远 90 佛山
91 汕头 92 汕尾 93 深圳 94 韶关 95 桂林
96 贵港 98 防城港 99 南宁 100 来宾 101 柳州
102 钦州 103 梧州 104 北海 105 玉林 106 河池
107 贺州 108 百色 109 阳江 110 湛江 111 云浮
112 中山 113 珠海 114 肇庆 115 河源 116 东莞
117 惠州 118 贵阳 119 安顺 120 六盘水 121 黔南布依族苗族自治州
122 黔东南苗族侗族自治州 123 黔西南布依族苗族自治州 124 毕节 125 铜仁 126 遵义
127 淮北 128 安庆 130 池州 131 滁州 132 黄山
133 淮南 134 马鞍山 135 六安 136 宣城 137 宿州
138 铜陵 139 芜湖 140 阜阳 141 蚌埠 142 合肥
143 亳州 144 丹东 145 本溪 146 锦州 147 朝阳
148 辽阳 149 盘锦 150 阜新 151 鞍山 152 抚顺
153 沈阳 154 铁岭 155 大连 156 营口 157 葫芦岛
158 赤峰 159 阿拉善盟 160 兴安盟 161 通辽 162 巴彦淖尔
163 乌兰察布 164 乌海 165 锡林郭勒盟 166 呼伦贝尔 167 呼和浩特
168 鄂尔多斯 169 包头 170 固原 171 石嘴山 172 吴忠
173 中卫 174 银川 175 西宁 176 海东 177 海西蒙古族藏族自治州
178 玉树藏族自治州 179 哈密 180 博尔塔拉蒙古自治州 181 昌吉回族自治州 182 阿勒泰地区
183 喀什地区 184 克拉玛依 185 阿克苏地区 186 克孜勒苏柯尔克孜自治州 187 石河子
188 塔城地区 189 五家渠 190 吐鲁番 191 巴音郭楞蒙古自治州 192 乌鲁木齐
193 伊犁哈萨克自治州 195 和田地区 196 济南 197 济宁 199 聊城
200 德州 201 临沂 202 青岛 203 日照 204 潍坊
205 晋城 206 晋中 207 淄博 208 泰安 209 长治
210 吕梁 211 临汾 212 忻州 213 朔州 214 太原
215 阳泉 216 运城 217 大同 218 威海 219 烟台
220 东营 221 枣庄 222 菏泽 223 滨州 224 广安
225 广元 226 成都 227 眉山 228 凉山彝族自治州 229 绵阳
230 攀枝花 231 南充 232 德阳 233 乐山 234 泸州
235 内江 236 甘孜藏族自治州 237 遂宁 238 资阳 239 宝鸡
240 安康 241 商洛 242 铜川 243 渭南 244 西安
245 咸阳 246 延安 247 巴中 248 汉中 249 榆林
250 达州 251 雅安 252 阿坝藏族羌族自治州 253 自贡 254 宜宾
255 酒泉 256 金昌 257 嘉峪关 258 兰州 259 陇南
260 平凉 261 临夏回族自治州 262 庆阳 263 定西 264 武威
265 天水 266 张掖 267 白银 268 那曲 269 拉萨
270 林芝 271 日喀则 272 金华 273 嘉兴 274 衢州
275 丽水 276 宁波 277 绍兴 278 温州 279 台州
280 杭州 281 舟山 282 湖州 283 楚雄彝族自治州 284 昆明
285 丽江 286 德宏傣族景颇族自治州 287 临沧 288 曲靖 289 保山
290 普洱 291 文山壮族苗族自治州 292 大理白族自治州 293 红河哈尼族彝族自治州 294 昭通
295 玉溪 296 东方 297 琼海 298 三亚 299 文昌
300 五指山 301 万宁 302 海口 303 儋州 304 保定
305 沧州 306 承德 307 廊坊 308 焦作 309 安阳
310 开封 311 洛阳 312 漯河 313 平顶山 314 驻马店
315 南阳 316 濮阳 317 新乡 318 信阳 319 许昌
320 商丘 321 三门峡 322 郑州 323 鹤壁 324 周口
325 秦皇岛 326 邢台 327 石家庄 329 唐山 330 邯郸
331 张家口 332 衡水 333 鸡西 334 佳木斯 335 哈尔滨
336 牡丹江 337 齐齐哈尔 338 七台河 339 绥化 340 双鸭山
341 伊春 342 大庆 343 大兴安岭地区 344 鹤岗 345 黑河
346 荆门 347 荆州 348 黄石 349 黄冈 350 怀化
351 常德 352 长沙 353 郴州 354 娄底 355 邵阳
356 湘潭 357 湘西土家族苗族自治州 358 张家界 359 益阳 360 衡阳
361 岳阳 362 永州 363 株洲 364 潜江 365 孝感
366 恩施土家族苗族自治州 367 随州 368 神农架林区 369 十堰 370 襄阳
371 武汉 372 仙桃 373 天门 375 咸宁 376 宜昌
377 鄂州 476 济源 477 甘南藏族自治州 479 海南藏族自治州 480 昌都
481 怒江傈僳族自治州 482 迪庆藏族自治州 483 西双版纳傣族自治州 484 定安县 485 屯昌县
486 陵水黎族自治县 487 澄迈县 488 保亭黎族苗族自治县 489 琼中黎族苗族自治县 490 乐东黎族自治县
491 临高县 492 昌江黎族自治县 493 白沙黎族自治县 494 海北藏族自治州 495 黄南藏族自治州
496 果洛藏族自治州 497 山南 498 阿里地区 499 阿拉尔 500 图木舒克
501 北屯 502 双河 503 三沙 504 铁门关 505 可克达拉
506 昆玉 507 胡杨河 1001 东城区 1002 丰台区 1003 大兴区
1004 密云区 1005 平谷区 1006 延庆区 1007 怀柔区 1008 房山区
1009 昌平区 1010 朝阳区 1011 海淀区 1012 石景山区 1013 西城区
1014 通州区 1015 门头沟区 1016 顺义区 1017 嘉定区 1018 奉贤区
1019 宝山区 1020 崇明区 1021 徐汇区 1022 普陀区 1023 杨浦区
1024 松江区 1025 浦东新区 1026 虹口区 1027 金山区 1028 长宁区
1029 闵行区 1030 青浦区 1031 静安区 1032 黄浦区 1033 东丽区
1034 北辰区 1035 南开区 1036 和平区 1037 宁河区 1038 宝坻区
1039 武清区 1040 河东区 1041 河北区 1042 河西区 1043 津南区
1044 滨海新区 1045 红桥区 1046 蓟州区 1047 西青区 1048 静海区
1049 台山市 1050 开平市 1051 恩平市 1052 新会区 1053 江海区
1054 蓬江区 1055 鹤山市 1056 惠来县 1057 揭东区 1058 揭西县
1059 普宁市 1060 榕城区 1061 从化区 1062 南沙区 1063 增城区
1064 天河区 1065 海珠区 1066 番禺区 1067 白云区 1068 花都区
1069 荔湾区 1070 越秀区 1071 黄埔区 1072 湘桥区 1073 潮安区
1074 饶平县 1075 信宜市 1076 化州市 1077 电白区 1078 茂南区
1079 高州市 1080 丰顺县 1081 五华县 1082 兴宁市 1083 大埔县
1084 平远县 1085 梅县区 1086 梅江区 1087 蕉岭县 1088 佛冈县
1089 清城区 1090 清新区 1091 英德市 1092 连南瑶族自治县 1093 连山壮族瑶族自治县
1094 连州市 1095 阳山县 1096 三水区 1097 南海区 1098 禅城区
1099 顺德区 1100 高明区 1101 南澳县 1102 潮南区 1103 潮阳区
1104 澄海区 1105 濠江区 1106 金平区 1107 龙湖区 1108 城区
1109 海丰县 1110 陆丰市 1111 陆河县 1112 光明区 1113 南山区
1114 坪山区 1115 宝安区 1116 盐田区 1117 福田区 1118 罗湖区
1119 龙华区 1120 龙岗区 1121 乐昌市 1122 乳源瑶族自治县 1123 仁化县
1124 南雄市 1125 始兴县 1126 新丰县 1127 曲江区 1128 武江区
1129 浈江区 1130 翁源县 1131 江城区 1132 阳东区 1133 阳春市
1134 阳西县 1135 吴川市 1136 坡头区 1137 廉江市 1138 徐闻县
1139 赤坎区 1140 遂溪县 1141 雷州市 1142 霞山区 1143 麻章区
1144 云城区 1145 云安区 1146 新兴县 1147 罗定市 1148 郁南县
1150 斗门区 1151 金湾区 1152 香洲区 1153 四会市 1154 封开县
1155 广宁县 1156 德庆县 1157 怀集县 1158 端州区 1159 高要区
1160 鼎湖区 1161 东源县 1162 和平县 1163 源城区 1164 紫金县
1165 连平县 1166 龙川县 1167 博罗县 1168 惠东县 1169 惠城区
1170 惠阳区 1171 龙门县 1172 仙游县 1173 城厢区 1174 涵江区
1175 秀屿区 1176 荔城区 1177 光泽县 1178 延平区 1179 建瓯市
1180 建阳区 1181 政和县 1182 松溪县 1183 武夷山市 1184 浦城县
1185 邵武市 1186 顺昌县 1187 上杭县 1188 新罗区 1189 武平县
1190 永定区 1191 漳平市 1192 连城县 1193 长汀县 1194 古田县
1195 周宁县 1196 寿宁县 1197 屏南县 1198 柘荣县 1199 福安市
1200 福鼎市 1201 蕉城区 1202 霞浦县 1203 丰泽区 1204 南安市
1205 安溪县 1206 德化县 1207 惠安县 1208 晋江市 1209 永春县
1210 泉港区 1211 洛江区 1212 石狮市 1213 金门县 1214 鲤城区
1215 三元区 1216 大田县 1217 宁化县 1218 将乐县 1219 尤溪县
1220 建宁县 1221 明溪县 1222 梅列区 1223 永安市 1224 沙县
1225 泰宁县 1226 清流县 1227 同安区 1228 思明区 1229 海沧区
1230 湖里区 1231 翔安区 1232 集美区 1233 东山县 1234 云霄县
1235 华安县 1236 南靖县 1237 平和县 1238 漳浦县 1239 芗城区
1240 诏安县 1241 长泰县 1242 龙文区 1243 龙海市 1244 仓山区
1245 台江区 1246 平潭县 1247 晋安区 1248 永泰县 1249 福清市
1250 罗源县 1251 连江县 1252 长乐区 1253 闽侯县 1254 闽清县
1255 马尾区 1256 鼓楼区 1257 东方市 1258 琼海市 1259 吉阳区
1260 天涯区 1261 崖州区 1262 海棠区 1264 琼山区 1265 秀英区
1266 美兰区 1267 龙华区 1279 中沙群岛的岛礁及其海域 1280 南沙群岛 1281 西沙群岛
1282 杜集区 1283 濉溪县 1284 烈山区 1285 相山区 1286 大观区
1287 太湖县 1288 宜秀区 1289 宿松县 1290 岳西县 1291 怀宁县
1292 望江县 1293 桐城市 1294 潜山市 1295 迎江区 1296 东至县
1297 石台县 1298 贵池区 1299 青阳县 1300 全椒县 1301 凤阳县
1302 南谯区 1303 天长市 1304 定远县 1305 明光市 1306 来安县
1307 琅琊区 1308 休宁县 1309 屯溪区 1310 徽州区 1311 歙县
1312 祁门县 1313 黄山区 1314 黟县 1315 八公山区 1316 凤台县
1317 大通区 1318 寿县 1319 潘集区 1320 田家庵区 1321 谢家集区
1322 博望区 1323 含山县 1324 和县 1325 当涂县 1326 花山区
1327 雨山区 1328 叶集区 1329 舒城县 1330 裕安区 1331 金安区
1332 金寨县 1333 霍山县 1334 霍邱县 1335 宁国市 1336 宣州区
1337 广德市 1338 旌德县 1339 泾县 1340 绩溪县 1341 郎溪县
1342 埇桥区 1343 泗县 1344 灵璧县 1345 砀山县 1346 萧县
1347 义安区 1348 枞阳县 1349 郊区 1350 铜官区 1351 三山区
1352 南陵县 1353 弋江区 1354 无为市 1355 繁昌县 1356 芜湖县
1357 镜湖区 1358 鸠江区 1359 临泉县 1360 太和县 1361 界首市
1362 阜南县 1363 颍上县 1364 颍东区 1365 颍州区 1366 颍泉区
1367 五河县 1368 固镇县 1369 怀远县 1370 淮上区 1371 禹会区
1372 蚌山区 1373 龙子湖区 1374 包河区 1375 巢湖市 1376 庐江县
1377 庐阳区 1378 瑶海区 1379 肥东县 1380 肥西县 1381 蜀山区
1382 长丰县 1383 利辛县 1384 涡阳县 1385 蒙城县 1386 谯城区
1387 乌当区 1388 云岩区 1389 修文县 1390 南明区 1391 开阳县
1392 息烽县 1393 清镇市 1394 白云区 1395 花溪区 1396 观山湖区
1397 关岭布依族苗族自治县 1398 平坝区 1399 普定县 1400 紫云苗族布依族自治县 1401 西秀区
1402 镇宁布依族苗族自治县 1403 六枝特区 1404 水城县 1405 盘州市 1406 钟山区
1407 三都水族自治县 1408 平塘县 1409 惠水县 1410 独山县 1411 瓮安县
1412 福泉市 1413 罗甸县 1414 荔波县 1415 贵定县 1416 都匀市
1417 长顺县 1418 龙里县 1419 三穗县 1420 丹寨县 1421 从江县
1422 凯里市 1423 剑河县 1424 台江县 1425 天柱县 1426 岑巩县
1427 施秉县 1428 榕江县 1429 锦屏县 1430 镇远县 1431 雷山县
1432 麻江县 1433 黄平县 1434 黎平县 1435 兴义市 1436 兴仁市
1437 册亨县 1438 安龙县 1439 普安县 1440 晴隆县 1441 望谟县
1442 贞丰县 1443 七星关区 1444 大方县 1445 威宁彝族回族苗族自治县 1446 纳雍县
1447 织金县 1448 赫章县 1449 金沙县 1450 黔西县 1451 万山区
1452 印江土家族苗族自治县 1453 德江县 1454 思南县 1455 松桃苗族自治县 1456 江口县
1457 沿河土家族自治县 1458 玉屏侗族自治县 1459 石阡县 1460 碧江区 1461 习水县
1462 仁怀市 1463 余庆县 1464 凤冈县 1465 务川仡佬族苗族自治县 1466 播州区
1467 桐梓县 1468 正安县 1469 汇川区 1470 湄潭县 1471 红花岗区
1472 绥阳县 1473 赤水市 1474 道真仡佬族苗族自治县 1475 敦煌市 1476 玉门市
1477 瓜州县 1478 肃北蒙古族自治县 1479 肃州区 1480 金塔县 1481 阿克塞哈萨克族自治县
1482 永昌县 1483 金川区 1484 嘉峪关市 1485 七里河区 1486 城关区
1487 安宁区 1488 榆中县 1489 永登县 1490 皋兰县 1491 红古区
1492 西固区 1493 两当县 1494 宕昌县 1495 康县 1496 徽县
1497 成县 1498 文县 1499 武都区 1500 礼县 1501 西和县
1502 华亭市 1503 崆峒区 1504 崇信县 1505 庄浪县 1506 泾川县
1507 灵台县 1508 静宁县 1509 东乡族自治县 1510 临夏县 1511 临夏市
1512 和政县 1513 广河县 1514 康乐县 1515 永靖县 1516 积石山保安族东乡族撒拉族自治县
1517 华池县 1518 合水县 1519 宁县 1520 庆城县 1521 正宁县
1522 环县 1523 西峰区 1524 镇原县 1525 临洮县 1526 安定区
1527 岷县 1528 渭源县 1529 漳县 1530 通渭县 1531 陇西县
1532 凉州区 1533 古浪县 1534 天祝藏族自治县 1535 民勤县 1536 张家川回族自治县
1537 武山县 1538 清水县 1539 甘谷县 1540 秦安县 1541 秦州区
1542 麦积区 1543 临泽县 1544 山丹县 1545 民乐县 1546 甘州区
1547 肃南裕固族自治县 1548 高台县 1549 会宁县 1550 平川区 1551 景泰县
1552 白银区 1553 靖远县 1554 临潭县 1555 卓尼县 1556 合作市
1557 夏河县 1558 玛曲县 1559 碌曲县 1560 舟曲县 1561 迭部县
1562 七星区 1563 临桂区 1564 全州县 1565 兴安县 1566 叠彩区
1567 平乐县 1568 恭城瑶族自治县 1569 永福县 1570 灌阳县 1571 灵川县
1572 秀峰区 1573 荔浦市 1574 象山区 1575 资源县 1576 阳朔县
1577 雁山区 1578 龙胜各族自治县 1579 平南县 1580 桂平市 1581 港北区
1582 港南区 1583 覃塘区 1584 上思县 1585 东兴市 1586 港口区
1587 防城区 1588 上林县 1589 兴宁区 1590 宾阳县 1591 横县
1592 武鸣区 1593 江南区 1594 良庆区 1595 西乡塘区 1596 邕宁区
1597 隆安县 1598 青秀区 1599 马山县 1600 兴宾区 1601 合山市
1602 忻城县 1603 武宣县 1604 象州县 1605 金秀瑶族自治县 1606 三江侗族自治县
1607 城中区 1608 柳北区 1609 柳南区 1610 柳城县 1611 柳江区
1612 融安县 1613 融水苗族自治县 1614 鱼峰区 1615 鹿寨县 1616 浦北县
1617 灵山县 1618 钦北区 1619 钦南区 1620 万秀区 1621 岑溪市
1622 苍梧县 1623 蒙山县 1624 藤县 1625 长洲区 1626 龙圩区
1627 合浦县 1628 海城区 1629 铁山港区 1630 银海区 1631 兴业县
1632 北流市 1633 博白县 1634 容县 1635 玉州区 1636 福绵区
1637 陆川县 1638 东兰县 1639 凤山县 1640 南丹县 1641 大化瑶族自治县
1642 天峨县 1643 宜州区 1644 巴马瑶族自治县 1645 环江毛南族自治县 1646 罗城仫佬族自治县
1647 都安瑶族自治县 1648 金城江区 1649 八步区 1650 富川瑶族自治县 1651 平桂区
1652 昭平县 1653 钟山县 1654 乐业县 1655 凌云县 1656 右江区
1657 平果市 1658 德保县 1659 田东县 1660 田林县 1661 田阳区
1662 西林县 1663 那坡县 1664 隆林各族自治县 1665 靖西市 1666 凭祥市
1667 大新县 1668 天等县 1669 宁明县 1670 扶绥县 1671 江州区
1672 龙州县 1673 博野县 1674 唐县 1675 安国市 1676 安新县
1677 定兴县 1678 定州市 1679 容城县 1680 徐水区 1681 易县
1682 曲阳县 1683 望都县 1684 涞水县 1685 涞源县 1686 涿州市
1687 清苑区 1688 满城区 1689 竞秀区 1690 莲池区 1691 蠡县
1692 阜平县 1693 雄县 1694 顺平县 1695 高碑店市 1696 高阳县
1697 东光县 1698 任丘市 1699 南皮县 1700 吴桥县 1701 孟村回族自治县
1702 新华区 1703 沧县 1704 河间市 1705 泊头市 1706 海兴县
1707 献县 1708 盐山县 1709 肃宁县 1710 运河区 1711 青县
1712 黄骅市 1713 丰宁满族自治县 1714 兴隆县 1715 双桥区 1716 双滦区
1717 围场满族蒙古族自治县 1718 宽城满族自治县 1719 平泉市 1720 承德县 1721 滦平县
1722 隆化县 1723 鹰手营子矿区 1724 三河市 1725 固安县 1726 大厂回族自治县
1727 大城县 1728 安次区 1729 广阳区 1730 文安县 1731 永清县
1732 霸州市 1733 香河县 1734 北戴河区 1735 卢龙县 1736 山海关区
1737 抚宁区 1738 昌黎县 1739 海港区 1740 青龙满族自治县 1741 临城县
1742 临西县 1743 任县 1744 内丘县 1745 南和县 1746 南宫市
1747 威县 1748 宁晋县 1749 巨鹿县 1750 平乡县 1751 广宗县
1752 新河县 1753 柏乡县 1754 桥东区 1755 桥西区 1756 沙河市
1757 清河县 1758 邢台县 1759 隆尧县 1760 井陉县 1761 井陉矿区
1762 元氏县 1763 平山县 1764 新乐市 1765 新华区 1766 无极县
1767 晋州市 1768 栾城区 1769 桥西区 1770 正定县 1771 深泽县
1772 灵寿县 1773 藁城区 1774 行唐县 1775 裕华区 1776 赞皇县
1777 赵县 1778 辛集市 1779 长安区 1780 高邑县 1781 鹿泉区
1782 丰南区 1783 丰润区 1784 乐亭县 1785 古冶区 1786 开平区
1787 曹妃甸区 1788 滦南县 1789 滦州市 1790 玉田县 1791 路北区
1792 路南区 1793 迁安市 1794 迁西县 1795 遵化市 1796 丛台区
1797 临漳县 1798 复兴区 1799 大名县 1800 峰峰矿区 1801 广平县
1802 成安县 1803 曲周县 1804 武安市 1805 永年区 1806 涉县
1807 磁县 1808 肥乡区 1809 邯山区 1810 邱县 1811 馆陶县
1812 魏县 1813 鸡泽县 1814 万全区 1815 下花园区 1816 宣化区
1817 尚义县 1818 崇礼区 1819 康保县 1820 张北县 1821 怀安县
1822 怀来县 1823 桥东区 1824 桥西区 1825 沽源县 1826 涿鹿县
1827 蔚县 1828 赤城县 1829 阳原县 1830 冀州区 1831 安平县
1832 故城县 1833 景县 1834 枣强县 1835 桃城区 1836 武强县
1837 武邑县 1838 深州市 1839 阜城县 1840 饶阳县 1841 中站区
1842 修武县 1843 博爱县 1844 孟州市 1845 山阳区 1846 武陟县
1847 沁阳市 1848 温县 1849 解放区 1850 马村区 1851 内黄县
1852 北关区 1853 安阳县 1854 文峰区 1855 林州市 1856 殷都区
1857 汤阴县 1858 滑县 1859 龙安区 1860 兰考县 1861 尉氏县
1862 杞县 1863 祥符区 1864 禹王台区 1865 通许县 1866 顺河回族区
1867 鼓楼区 1868 龙亭区 1869 伊川县 1870 偃师市 1871 吉利区
1872 孟津县 1873 宜阳县 1874 嵩县 1875 新安县 1876 栾川县
1877 汝阳县 1878 洛宁县 1879 洛龙区 1880 涧西区 1881 瀍河回族区
1882 老城区 1883 西工区 1884 临颍县 1885 召陵区 1886 源汇区
1887 舞阳县 1888 郾城区 1889 卫东区 1890 叶县 1891 宝丰县
1892 新华区 1893 汝州市 1894 湛河区 1895 石龙区 1896 舞钢市
1897 郏县 1898 鲁山县 1899 上蔡县 1900 平舆县 1901 新蔡县
1902 正阳县 1903 汝南县 1904 泌阳县 1905 确山县 1906 西平县
1907 遂平县 1908 驿城区 1909 内乡县 1910 南召县 1911 卧龙区
1912 唐河县 1913 宛城区 1914 新野县 1915 方城县 1916 桐柏县
1917 淅川县 1918 社旗县 1919 西峡县 1920 邓州市 1921 镇平县
1922 华龙区 1923 南乐县 1924 台前县 1925 清丰县 1926 濮阳县
1927 范县 1928 凤泉区 1929 卫滨区 1930 卫辉市 1931 原阳县
1932 封丘县 1933 延津县 1934 新乡县 1935 牧野区 1936 红旗区
1937 获嘉县 1938 辉县市 1939 长垣市 1940 光山县 1941 商城县
1942 固始县 1943 平桥区 1944 息县 1945 新县 1946 浉河区
1947 淮滨县 1948 潢川县 1949 罗山县 1950 建安区 1951 禹州市
1952 襄城县 1953 鄢陵县 1954 长葛市 1955 魏都区 1956 夏邑县
1957 宁陵县 1958 柘城县 1959 梁园区 1960 民权县 1961 永城市
1962 睢县 1963 睢阳区 1964 虞城县 1965 义马市 1966 卢氏县
1967 渑池县 1968 湖滨区 1969 灵宝市 1970 陕州区 1971 上街区
1972 中原区 1973 中牟县 1974 二七区 1975 巩义市 1976 惠济区
1977 新密市 1978 新郑市 1979 登封市 1980 管城回族区 1981 荥阳市
1982 金水区 1983 山城区 1984 浚县 1985 淇县 1986 淇滨区
1987 鹤山区 1988 商水县 1989 太康县 1990 川汇区 1991 扶沟县
1992 沈丘县 1993 淮阳区 1994 西华县 1995 郸城县 1996 项城市
1997 鹿邑县 1998 济源市 1999 城子河区 2000 密山市 2001 恒山区
2002 梨树区 2003 滴道区 2004 虎林市 2005 鸡东县 2006 鸡冠区
2007 麻山区 2008 东风区 2009 前进区 2010 同江市 2011 向阳区
2012 富锦市 2013 抚远市 2014 桦南县 2015 桦川县 2016 汤原县
2017 郊区 2018 五常市 2019 依兰县 2020 南岗区 2021 双城区
2022 呼兰区 2023 宾县 2024 尚志市 2025 巴彦县 2026 平房区
2027 延寿县 2028 方正县 2029 木兰县 2030 松北区 2031 通河县
2032 道外区 2033 道里区 2034 阿城区 2035 香坊区 2036 东宁市
2037 东安区 2038 宁安市 2039 林口县 2040 海林市 2041 爱民区
2042 穆棱市 2043 绥芬河市 2044 西安区 2045 阳明区 2046 依安县
2047 克东县 2048 克山县 2049 富拉尔基区 2050 富裕县 2051 建华区
2052 拜泉县 2053 昂昂溪区 2054 梅里斯达斡尔族区 2055 泰来县 2056 甘南县
2057 碾子山区 2058 讷河市 2059 铁锋区 2060 龙江县 2061 龙沙区
2062 勃利县 2063 新兴区 2064 桃山区 2065 茄子河区 2066 兰西县
2067 北林区 2068 安达市 2069 庆安县 2070 明水县 2071 望奎县
2072 海伦市 2073 绥棱县 2074 肇东市 2075 青冈县 2076 友谊县
2077 四方台区 2078 宝山区 2079 宝清县 2080 尖山区 2081 岭东区
2082 集贤县 2083 饶河县 2084 丰林县 2085 乌翠区 2086 伊美区
2087 南岔县 2088 友好区 2089 嘉荫县 2090 大箐山县 2091 汤旺县
2092 金林区 2093 铁力市 2094 大同区 2095 杜尔伯特蒙古族自治县 2096 林甸县
2097 红岗区 2098 肇州县 2099 肇源县 2100 萨尔图区 2101 让胡路区
2102 龙凤区 2103 加格达奇区 2104 呼玛县 2105 塔河县 2106 漠河市
2107 东山区 2108 兴安区 2109 兴山区 2110 南山区 2111 向阳区
2112 工农区 2113 绥滨县 2114 萝北县 2115 五大连池市 2116 北安市
2117 嫩江市 2118 孙吴县 2119 爱辉区 2120 逊克县 2121 东宝区
2122 京山市 2123 掇刀区 2124 沙洋县 2125 钟祥市 2126 公安县
2127 松滋市 2128 江陵县 2129 沙市区 2130 洪湖市 2131 监利县
2132 石首市 2133 荆州区 2134 下陆区 2135 大冶市 2136 西塞山区
2137 铁山区 2138 阳新县 2139 黄石港区 2140 团风县 2141 武穴市
2142 浠水县 2143 红安县 2144 罗田县 2145 英山县 2146 蕲春县
2147 麻城市 2148 黄州区 2149 黄梅县 2150 云梦县 2151 大悟县
2152 孝南区 2153 孝昌县 2154 安陆市 2155 应城市 2156 汉川市
2157 利川市 2158 咸丰县 2159 宣恩县 2160 巴东县 2161 建始县
2162 恩施市 2163 来凤县 2164 鹤峰县 2165 广水市 2166 曾都区
2167 随县 2169 丹江口市 2170 张湾区 2171 房县 2172 竹山县
2173 竹溪县 2174 茅箭区 2175 郧西县 2176 郧阳区 2177 保康县
2178 南漳县 2179 宜城市 2180 枣阳市 2181 樊城区 2182 老河口市
2183 襄城区 2184 襄州区 2185 谷城县 2186 东西湖区 2187 新洲区
2188 武昌区 2189 汉南区 2190 汉阳区 2191 江夏区 2192 江岸区
2193 江汉区 2194 洪山区 2195 硚口区 2196 蔡甸区 2197 青山区
2198 黄陂区 2199 咸安区 2200 嘉鱼县 2201 崇阳县 2202 赤壁市
2203 通城县 2204 通山县 2205 五峰土家族自治县 2206 伍家岗区 2207 兴山县
2208 夷陵区 2209 宜都市 2210 当阳市 2211 枝江市 2212 点军区
2213 猇亭区 2214 秭归县 2215 西陵区 2216 远安县 2217 长阳土家族自治县
2218 华容区 2219 梁子湖区 2220 鄂城区 2221 中方县 2222 会同县
2223 新晃侗族自治县 2224 沅陵县 2225 洪江市 2226 溆浦县 2227 芷江侗族自治县
2228 辰溪县 2229 通道侗族自治县 2230 靖州苗族侗族自治县 2231 鹤城区 2232 麻阳苗族自治县
2233 临澧县 2234 安乡县 2235 桃源县 2236 武陵区 2237 汉寿县
2238 津市市 2239 澧县 2240 石门县 2241 鼎城区 2242 天心区
2243 宁乡市 2244 岳麓区 2245 开福区 2246 望城区 2247 浏阳市
2248 芙蓉区 2249 长沙县 2250 雨花区 2251 临武县 2252 北湖区
2253 嘉禾县 2254 安仁县 2255 宜章县 2256 桂东县 2257 桂阳县
2258 永兴县 2259 汝城县 2260 苏仙区 2261 资兴市 2262 冷水江市
2263 双峰县 2264 娄星区 2265 新化县 2266 涟源市 2267 北塔区
2268 双清区 2269 城步苗族自治县 2270 大祥区 2271 新宁县 2272 新邵县
2273 武冈市 2274 洞口县 2275 绥宁县 2276 邵东市 2277 邵阳县
2278 隆回县 2279 岳塘区 2280 湘乡市 2281 湘潭县 2282 雨湖区
2283 韶山市 2284 保靖县 2285 凤凰县 2286 古丈县 2287 吉首市
2288 永顺县 2289 泸溪县 2290 花垣县 2291 龙山县 2292 慈利县
2293 桑植县 2294 武陵源区 2295 永定区 2296 南县 2297 安化县
2298 桃江县 2299 沅江市 2300 资阳区 2301 赫山区 2302 南岳区
2303 常宁市 2304 珠晖区 2305 石鼓区 2306 祁东县 2307 耒阳市
2308 蒸湘区 2309 衡东县 2310 衡南县 2311 衡山县 2312 衡阳县
2313 雁峰区 2314 临湘市 2315 云溪区 2316 华容县 2317 君山区
2318 岳阳县 2319 岳阳楼区 2320 平江县 2321 汨罗市 2322 湘阴县
2323 东安县 2324 冷水滩区 2325 双牌县 2326 宁远县 2327 新田县
2328 江华瑶族自治县 2329 江永县 2330 祁阳县 2331 蓝山县 2332 道县
2333 零陵区 2334 天元区 2335 攸县 2336 渌口区 2337 炎陵县
2338 石峰区 2339 芦淞区 2340 茶陵县 2341 荷塘区 2342 醴陵市
2343 丰满区 2344 昌邑区 2345 桦甸市 2346 永吉县 2347 磐石市
2348 舒兰市 2349 船营区 2350 蛟河市 2351 龙潭区 2352 大安市
2353 洮北区 2354 洮南市 2355 通榆县 2356 镇赉县 2357 九台区
2358 二道区 2359 农安县 2360 南关区 2361 双阳区 2362 宽城区
2363 德惠市 2364 朝阳区 2365 榆树市 2366 绿园区 2367 东丰县
2368 东辽县 2369 西安区 2370 龙山区 2371 临江市 2372 抚松县
2373 江源区 2374 浑江区 2375 长白朝鲜族自治县 2376 靖宇县 2377 伊通满族自治县
2378 公主岭市 2379 双辽市 2380 梨树县 2381 铁东区 2382 铁西区
2383 乾安县 2384 前郭尔罗斯蒙古族自治县 2385 宁江区 2386 扶余市 2387 长岭县
2388 东昌区 2389 二道江区 2390 柳河县 2391 梅河口市 2392 辉南县
2393 通化县 2394 集安市 2395 和龙市 2396 图们市 2397 安图县
2398 延吉市 2399 敦化市 2400 汪清县 2401 珲春市 2402 龙井市
2403 洪泽区 2404 涟水县 2405 淮安区 2406 淮阴区 2407 清江浦区
2408 盱眙县 2409 金湖县 2410 天宁区 2411 新北区 2412 武进区
2413 溧阳市 2414 金坛区 2415 钟楼区 2416 六合区 2417 建邺区
2418 栖霞区 2419 江宁区 2420 浦口区 2421 溧水区 2422 玄武区
2423 秦淮区 2424 雨花台区 2425 高淳区 2426 鼓楼区 2427 启东市
2428 如东县 2429 如皋市 2430 崇川区 2431 海安市 2432 海门市
2433 港闸区 2434 通州区 2435 东海县 2436 海州区 2437 灌云县
2438 灌南县 2439 赣榆区 2440 连云区 2441 丰县 2442 云龙区
2443 新沂市 2444 沛县 2445 泉山区 2446 睢宁县 2447 贾汪区
2448 邳州市 2449 铜山区 2450 鼓楼区 2451 吴中区 2452 吴江区
2453 太仓市 2454 姑苏区 2455 常熟市 2456 张家港市 2457 昆山市
2458 相城区 2459 苏州工业园区 2460 虎丘区 2461 宿城区 2462 宿豫区
2463 沭阳县 2464 泗洪县 2465 泗阳县 2466 兴化市 2467 姜堰区
2468 泰兴市 2469 海陵区 2470 靖江市 2471 高港区 2472 宜兴市
2473 惠山区 2474 新吴区 2475 梁溪区 2476 江阴市 2477 滨湖区
2478 锡山区 2479 东台市 2480 亭湖区 2481 响水县 2482 大丰区
2483 射阳县 2484 建湖县 2485 滨海县 2486 盐都区 2487 阜宁县
2488 仪征市 2489 宝应县 2490 广陵区 2491 江都区 2492 邗江区
2493 高邮市 2494 丹徒区 2495 丹阳市 2496 京口区 2497 句容市
2498 扬中市 2499 润州区 2500 修水县 2501 共青城市 2502 庐山市
2503 彭泽县 2504 德安县 2505 柴桑区 2506 武宁县 2507 永修县
2508 浔阳区 2509 湖口县 2510 濂溪区 2511 瑞昌市 2512 都昌县
2513 万安县 2514 井冈山市 2515 吉安县 2516 吉州区 2517 吉水县
2518 安福县 2519 峡江县 2520 新干县 2521 永丰县 2522 永新县
2523 泰和县 2524 遂川县 2525 青原区 2526 乐平市 2527 昌江区
2528 浮梁县 2529 珠山区 2530 上栗县 2531 安源区 2532 湘东区
2533 芦溪县 2534 莲花县 2535 东湖区 2536 南昌县 2537 安义县
2538 新建区 2539 红谷滩区 2540 西湖区 2541 进贤县 2542 青云谱区
2543 青山湖区 2544 分宜县 2545 渝水区 2546 万年县 2547 余干县
2548 信州区 2549 婺源县 2550 广丰区 2551 广信区 2552 弋阳县
2553 德兴市 2554 横峰县 2555 玉山县 2556 鄱阳县 2557 铅山县
2558 万载县 2559 上高县 2560 丰城市 2561 奉新县 2562 宜丰县
2563 樟树市 2564 袁州区 2565 铜鼓县 2566 靖安县 2567 高安市
2568 余江区 2569 月湖区 2570 贵溪市 2571 上犹县 2572 于都县
2573 会昌县 2574 信丰县 2575 全南县 2576 兴国县 2577 南康区
2578 大余县 2579 宁都县 2580 安远县 2581 定南县 2582 寻乌县
2583 崇义县 2584 瑞金市 2585 石城县 2586 章贡区 2587 赣县区
2588 龙南县 2589 东乡区 2590 临川区 2591 乐安县 2592 南丰县
2593 南城县 2594 宜黄县 2595 崇仁县 2596 广昌县 2597 资溪县
2598 金溪县 2599 黎川县 2600 东港市 2601 元宝区 2602 凤城市
2603 宽甸满族自治县 2604 振兴区 2605 振安区 2606 南芬区 2607 平山区
2608 明山区 2609 本溪满族自治县 2610 桓仁满族自治县 2611 溪湖区 2612 义县
2613 凌河区 2614 凌海市 2615 北镇市 2616 古塔区 2617 太和区
2618 黑山县 2619 凌源市 2620 北票市 2621 双塔区 2622 喀喇沁左翼蒙古族自治县
2623 建平县 2624 朝阳县 2625 龙城区 2626 太子河区 2627 宏伟区
2628 弓长岭区 2629 文圣区 2630 灯塔市 2631 白塔区 2632 辽阳县
2633 兴隆台区 2634 双台子区 2635 大洼区 2636 盘山县 2637 太平区
2638 彰武县 2639 新邱区 2640 海州区 2641 清河门区 2642 细河区
2643 阜新蒙古族自治县 2644 千山区 2645 台安县 2646 岫岩满族自治县 2647 海城市
2648 立山区 2649 铁东区 2650 铁西区 2651 东洲区 2652 抚顺县
2653 新宾满族自治县 2654 新抚区 2655 望花区 2656 清原满族自治县 2657 顺城区
2658 于洪区 2659 和平区 2660 大东区 2661 康平县 2662 新民市
2663 沈北新区 2664 沈河区 2665 法库县 2666 浑南区 2667 皇姑区
2668 苏家屯区 2669 辽中区 2670 铁西区 2671 开原市 2672 昌图县
2673 清河区 2674 西丰县 2675 调兵山市 2676 铁岭县 2677 银州区
2678 中山区 2679 庄河市 2680 旅顺口区 2681 普兰店区 2682 沙河口区
2683 瓦房店市 2684 甘井子区 2685 西岗区 2686 金州区 2687 长海县
2688 大石桥市 2689 盖州市 2690 站前区 2691 老边区 2692 西市区
2693 鲅鱼圈区 2694 兴城市 2695 南票区 2696 建昌县 2697 绥中县
2698 连山区 2699 龙港区 2700 元宝山区 2701 克什克腾旗 2702 喀喇沁旗
2703 宁城县 2704 巴林右旗 2705 巴林左旗 2706 敖汉旗 2707 松山区
2708 林西县 2709 红山区 2710 翁牛特旗 2711 阿鲁科尔沁旗 2712 阿拉善右旗
2713 阿拉善左旗 2714 额济纳旗 2715 乌兰浩特市 2716 扎赉特旗 2717 科尔沁右翼中旗
2718 科尔沁右翼前旗 2719 突泉县 2720 阿尔山市 2721 奈曼旗 2722 库伦旗
2723 开鲁县 2724 扎鲁特旗 2725 科尔沁区 2726 科尔沁左翼中旗 2727 科尔沁左翼后旗
2728 霍林郭勒市 2729 临河区 2730 乌拉特中旗 2731 乌拉特前旗 2732 乌拉特后旗
2733 五原县 2734 杭锦后旗 2735 磴口县 2736 丰镇市 2737 兴和县
2738 凉城县 2739 化德县 2740 卓资县 2741 商都县 2742 四子王旗
2743 察哈尔右翼中旗 2744 察哈尔右翼前旗 2745 察哈尔右翼后旗 2746 集宁区 2747 乌达区
2748 海勃湾区 2749 海南区 2750 东乌珠穆沁旗 2751 二连浩特市 2752 多伦县
2753 太仆寺旗 2754 正蓝旗 2755 正镶白旗 2756 苏尼特右旗 2757 苏尼特左旗
2758 西乌珠穆沁旗 2759 锡林浩特市 2760 镶黄旗 2761 阿巴嘎旗 2762 扎兰屯市
2763 扎赉诺尔区 2764 新巴尔虎右旗 2765 新巴尔虎左旗 2766 根河市 2767 海拉尔区
2768 满洲里市 2769 牙克石市 2770 莫力达瓦达斡尔族自治旗 2771 鄂伦春自治旗 2772 鄂温克族自治旗
2773 阿荣旗 2774 陈巴尔虎旗 2775 额尔古纳市 2776 和林格尔县 2777 回民区
2778 土默特左旗 2779 托克托县 2780 新城区 2781 武川县 2782 清水河县
2783 玉泉区 2784 赛罕区 2785 东胜区 2786 乌审旗 2787 伊金霍洛旗
2788 准格尔旗 2789 康巴什区 2790 杭锦旗 2791 达拉特旗 2792 鄂托克前旗
2793 鄂托克旗 2794 东河区 2795 九原区 2796 固阳县 2797 土默特右旗
2798 昆都仑区 2799 白云鄂博矿区 2800 石拐区 2801 达尔罕茂明安联合旗 2802 青山区
2803 原州区 2804 彭阳县 2805 泾源县 2806 西吉县 2807 隆德县
2808 大武口区 2809 平罗县 2810 惠农区 2811 利通区 2812 同心县
2813 盐池县 2814 红寺堡区 2815 青铜峡市 2816 中宁县 2817 沙坡头区
2818 海原县 2819 兴庆区 2820 永宁县 2821 灵武市 2822 西夏区
2823 贺兰县 2824 金凤区 2825 城东区 2826 城中区 2827 城北区
2828 城西区 2829 大通回族土族自治县 2830 湟中区 2831 湟源县 2832 乐都区
2833 互助土族自治县 2834 化隆回族自治县 2835 平安区 2836 循化撒拉族自治县 2837 民和回族土族自治县
2838 乌兰县 2839 天峻县 2840 德令哈市 2841 格尔木市 2842 海西蒙古族藏族自治州直辖
2843 茫崖市 2844 都兰县 2845 囊谦县 2846 曲麻莱县 2847 杂多县
2848 治多县 2849 玉树市 2850 称多县 2851 共和县 2852 兴海县
2853 同德县 2854 贵南县 2855 贵德县 2856 刚察县 2857 海晏县
2858 祁连县 2859 门源回族自治县 2860 同仁县 2861 尖扎县 2862 河南蒙古族自治县
2863 泽库县 2864 久治县 2865 玛多县 2866 玛沁县 2867 班玛县
2868 甘德县 2869 达日县 2870 历下区 2871 历城区 2872 商河县
2873 天桥区 2874 市中区 2875 平阴县 2876 槐荫区 2877 济阳区
2878 章丘区 2879 莱芜区 2880 钢城区 2881 长清区 2882 任城区
2883 兖州区 2884 嘉祥县 2885 微山县 2886 曲阜市 2887 梁山县
2888 汶上县 2889 泗水县 2890 邹城市 2891 金乡县 2892 鱼台县
2893 东昌府区 2894 东阿县 2895 临清市 2896 冠县 2897 茌平区
2898 莘县 2899 阳谷县 2900 高唐县 2901 临邑县 2902 乐陵市
2903 夏津县 2904 宁津县 2905 平原县 2906 庆云县 2907 德城区
2908 武城县 2909 禹城市 2910 陵城区 2911 齐河县 2912 临沭县
2913 兰山区 2914 兰陵县 2915 平邑县 2916 沂南县 2917 沂水县
2918 河东区 2919 罗庄区 2920 莒南县 2921 蒙阴县 2922 费县
2923 郯城县 2924 即墨区 2925 城阳区 2926 崂山区 2927 市北区
2928 市南区 2929 平度市 2930 李沧区 2931 胶州市 2932 莱西市
2933 黄岛区 2934 东港区 2935 五莲县 2936 岚山区 2937 莒县
2938 临朐县 2939 坊子区 2940 奎文区 2941 安丘市 2942 寒亭区
2943 寿光市 2944 昌乐县 2945 昌邑市 2946 潍城区 2947 诸城市
2948 青州市 2949 高密市 2950 临淄区 2951 博山区 2952 周村区
2953 张店区 2954 桓台县 2955 沂源县 2956 淄川区 2957 高青县
2958 东平县 2959 宁阳县 2960 岱岳区 2961 新泰市 2962 泰山区
2963 肥城市 2964 乳山市 2965 文登区 2966 环翠区 2967 荣成市
2968 招远市 2969 栖霞市 2970 海阳市 2971 牟平区 2972 福山区
2973 芝罘区 2974 莱山区 2975 莱州市 2976 莱阳市 2977 蓬莱市
2978 长岛县 2979 龙口市 2980 东营区 2981 利津县 2982 垦利区
2983 广饶县 2984 河口区 2985 台儿庄区 2986 山亭区 2987 峄城区
2988 市中区 2989 滕州市 2990 薛城区 2991 东明县 2992 单县
2993 定陶区 2994 巨野县 2995 成武县 2996 曹县 2997 牡丹区
2998 郓城县 2999 鄄城县 3000 博兴县 3001 惠民县 3002 无棣县
3003 沾化区 3004 滨城区 3005 邹平市 3006 阳信县 3007 城区
3008 沁水县 3009 泽州县 3010 阳城县 3011 陵川县 3012 高平市
3013 介休市 3014 和顺县 3015 太谷区 3016 寿阳县 3017 左权县
3018 平遥县 3019 昔阳县 3020 榆次区 3021 榆社县 3022 灵石县
3023 祁县 3024 上党区 3025 壶关县 3026 屯留区 3027 平顺县
3028 武乡县 3029 沁县 3030 沁源县 3031 潞城区 3032 潞州区
3033 襄垣县 3034 长子县 3035 黎城县 3036 中阳县 3037 临县
3038 交口县 3039 交城县 3040 兴县 3041 孝义市 3042 岚县
3043 文水县 3044 方山县 3045 柳林县 3046 汾阳市 3047 石楼县
3048 离石区 3049 乡宁县 3050 侯马市 3051 古县 3052 吉县
3053 大宁县 3054 安泽县 3055 尧都区 3056 曲沃县 3057 永和县
3058 汾西县 3059 洪洞县 3060 浮山县 3061 翼城县 3062 蒲县
3063 襄汾县 3064 隰县 3065 霍州市 3066 五台县 3067 五寨县
3068 代县 3069 保德县 3070 偏关县 3071 原平市 3072 宁武县
3073 定襄县 3074 岢岚县 3075 忻府区 3076 河曲县 3077 神池县
3078 繁峙县 3079 静乐县 3080 右玉县 3081 山阴县 3082 平鲁区
3083 应县 3084 怀仁市 3085 朔城区 3086 万柏林区 3087 古交市
3088 娄烦县 3089 小店区 3090 尖草坪区 3091 晋源区 3092 杏花岭区
3093 清徐县 3094 迎泽区 3095 阳曲县 3096 城区 3097 平定县
3098 盂县 3099 矿区 3100 郊区 3101 万荣县 3102 临猗县
3103 垣曲县 3104 夏县 3105 平陆县 3106 新绛县 3107 永济市
3108 河津市 3109 盐湖区 3110 稷山县 3111 绛县 3112 芮城县
3113 闻喜县 3114 云冈区 3115 云州区 3116 天镇县 3117 左云县
3118 平城区 3119 广灵县 3120 新荣区 3121 浑源县 3122 灵丘县
3123 阳高县 3124 凤县 3125 凤翔县 3126 千阳县 3127 太白县
3128 岐山县 3129 扶风县 3130 渭滨区 3131 眉县 3132 金台区
3133 陇县 3134 陈仓区 3135 麟游县 3136 宁陕县 3137 岚皋县
3138 平利县 3139 旬阳县 3140 汉滨区 3141 汉阴县 3142 白河县
3143 石泉县 3144 紫阳县 3145 镇坪县 3146 丹凤县 3147 商南县
3148 商州区 3149 山阳县 3150 柞水县 3151 洛南县 3152 镇安县
3153 印台区 3154 宜君县 3155 王益区 3156 耀州区 3157 临渭区
3158 华州区 3159 华阴市 3160 合阳县 3161 大荔县 3162 富平县
3163 潼关县 3164 澄城县 3165 白水县 3166 蒲城县 3167 韩城市
3168 临潼区 3169 周至县 3170 新城区 3171 未央区 3172 灞桥区
3173 碑林区 3174 莲湖区 3175 蓝田县 3176 鄠邑区 3177 长安区
3178 阎良区 3179 雁塔区 3180 高陵区 3181 三原县 3182 乾县
3183 兴平市 3184 彬州市 3185 旬邑县 3186 杨陵区 3187 武功县
3188 永寿县 3189 泾阳县 3190 淳化县 3191 渭城区 3192 礼泉县
3193 秦都区 3194 长武县 3195 吴起县 3196 子长市 3197 安塞区
3198 宜川县 3199 宝塔区 3200 富县 3201 延川县 3202 延长县
3203 志丹县 3204 洛川县 3205 甘泉县 3206 黄陵县 3207 黄龙县
3208 佛坪县 3209 勉县 3210 南郑区 3211 城固县 3212 宁强县
3213 汉台区 3214 洋县 3215 留坝县 3216 略阳县 3217 西乡县
3218 镇巴县 3219 佳县 3220 吴堡县 3221 子洲县 3222 定边县
3223 府谷县 3224 榆阳区 3225 横山区 3226 清涧县 3227 神木市
3228 米脂县 3229 绥德县 3230 靖边县 3231 前锋区 3232 华蓥市
3233 岳池县 3234 广安区 3235 武胜县 3236 邻水县 3237 利州区
3238 剑阁县 3239 旺苍县 3240 昭化区 3241 朝天区 3242 苍溪县
3243 青川县 3244 双流区 3245 大邑县 3246 崇州市 3247 彭州市
3248 成华区 3249 新津县 3250 新都区 3251 武侯区 3252 温江区
3253 简阳市 3254 蒲江县 3255 邛崃市 3256 郫都区 3257 都江堰市
3258 金堂县 3259 金牛区 3260 锦江区 3261 青白江区 3262 青羊区
3263 龙泉驿区 3264 东坡区 3265 丹棱县 3266 仁寿县 3267 彭山区
3268 洪雅县 3269 青神县 3270 会东县 3271 会理县 3272 冕宁县
3273 喜德县 3274 宁南县 3275 布拖县 3276 德昌县 3277 昭觉县
3278 普格县 3279 木里藏族自治县 3280 甘洛县 3281 盐源县 3282 美姑县
3283 西昌市 3284 越西县 3285 金阳县 3286 雷波县 3287 三台县
3288 北川羌族自治县 3289 安州区 3290 平武县 3291 梓潼县 3292 江油市
3293 涪城区 3294 游仙区 3295 盐亭县 3296 东区 3297 仁和区
3298 盐边县 3299 米易县 3300 西区 3301 仪陇县 3302 南部县
3303 嘉陵区 3304 营山县 3305 蓬安县 3306 西充县 3307 阆中市
3308 顺庆区 3309 高坪区 3310 中江县 3311 什邡市 3312 广汉市
3313 旌阳区 3314 绵竹市 3315 罗江区 3316 五通桥区 3317 井研县
3318 夹江县 3319 峨眉山市 3320 峨边彝族自治县 3321 市中区 3322 沐川县
3323 沙湾区 3324 犍为县 3325 金口河区 3326 马边彝族自治县 3327 叙永县
3328 古蔺县 3329 合江县 3330 江阳区 3331 泸县 3332 纳溪区
3333 龙马潭区 3334 东兴区 3335 威远县 3336 市中区 3337 资中县
3338 隆昌市 3339 丹巴县 3340 九龙县 3341 乡城县 3342 巴塘县
3343 康定市 3344 得荣县 3345 德格县 3346 新龙县 3347 泸定县
3348 炉霍县 3349 理塘县 3350 甘孜县 3351 白玉县 3352 石渠县
3353 稻城县 3354 色达县 3355 道孚县 3356 雅江县 3357 大英县
3358 安居区 3359 射洪市 3360 船山区 3361 蓬溪县 3362 乐至县
3363 安岳县 3364 雁江区 3365 南江县 3366 巴州区 3367 平昌县
3368 恩阳区 3369 通江县 3370 万源市 3371 大竹县 3372 宣汉县
3373 开江县 3374 渠县 3375 达川区 3376 通川区 3377 名山区
3378 天全县 3379 宝兴县 3380 汉源县 3381 石棉县 3382 芦山县
3383 荥经县 3384 雨城区 3385 九寨沟县 3386 壤塘县 3387 小金县
3388 松潘县 3389 汶川县 3390 理县 3391 红原县 3392 若尔盖县
3393 茂县 3394 金川县 3395 阿坝县 3396 马尔康市 3397 黑水县
3398 大安区 3399 富顺县 3400 沿滩区 3401 自流井区 3402 荣县
3403 贡井区 3404 兴文县 3405 南溪区 3406 叙州区 3407 屏山县
3408 江安县 3409 珙县 3410 筠连县 3411 翠屏区 3412 长宁县
3413 高县 3414 双湖县 3415 嘉黎县 3416 安多县 3417 尼玛县
3418 巴青县 3419 比如县 3420 班戈县 3421 申扎县 3422 索县
3423 聂荣县 3424 色尼区 3425 城关区 3426 堆龙德庆区 3427 墨竹工卡县
3428 尼木县 3429 当雄县 3430 曲水县 3431 林周县 3432 达孜区
3433 墨脱县 3434 察隅县 3435 工布江达县 3436 巴宜区 3437 朗县
3438 波密县 3439 米林县 3440 亚东县 3441 仁布县 3442 仲巴县
3443 南木林县 3444 吉隆县 3445 定日县 3446 定结县 3447 岗巴县
3448 康马县 3449 拉孜县 3450 昂仁县 3451 桑珠孜区 3452 江孜县
3453 白朗县 3454 聂拉木县 3455 萨嘎县 3456 萨迦县 3457 谢通门县
3458 丁青县 3459 八宿县 3460 卡若区 3461 察雅县 3462 左贡县
3463 江达县 3464 洛隆县 3465 类乌齐县 3466 芒康县 3467 贡觉县
3468 边坝县 3469 乃东区 3470 加查县 3471 扎囊县 3472 措美县
3473 曲松县 3474 桑日县 3475 洛扎县 3476 浪卡子县 3477 琼结县
3478 贡嘎县 3479 错那县 3480 隆子县 3481 噶尔县 3482 措勤县
3483 改则县 3484 日土县 3485 普兰县 3486 札达县 3487 革吉县
3488 伊吾县 3489 伊州区 3490 巴里坤哈萨克自治县 3491 博乐市 3492 温泉县
3493 精河县 3494 阿拉山口市 3495 吉木萨尔县 3496 呼图壁县 3497 奇台县
3498 昌吉市 3499 木垒哈萨克自治县 3500 玛纳斯县 3501 阜康市 3502 吉木乃县
3503 哈巴河县 3504 富蕴县 3505 布尔津县 3506 福海县 3507 阿勒泰市
3508 青河县 3509 伽师县 3510 叶城县 3511 喀什市 3512 塔什库尔干塔吉克自治县
3513 岳普湖县 3514 巴楚县 3515 泽普县 3516 疏勒县 3517 疏附县
3518 英吉沙县 3519 莎车县 3520 麦盖提县 3521 乌尔禾区 3522 克拉玛依区
3523 独山子区 3524 白碱滩区 3525 乌什县 3526 库车市 3527 拜城县
3528 新和县 3529 柯坪县 3530 沙雅县 3531 温宿县 3532 阿克苏市
3533 阿瓦提县 3534 乌恰县 3535 阿克陶县 3536 阿合奇县 3537 阿图什市
3538 石河子市 3539 乌苏市 3540 和布克赛尔蒙古自治县 3541 塔城市 3542 托里县
3543 沙湾县 3544 裕民县 3545 额敏县 3546 五家渠市 3547 托克逊县
3548 鄯善县 3549 高昌区 3550 且末县 3551 博湖县 3552 和硕县
3553 和静县 3554 尉犁县 3555 库尔勒市 3556 焉耆回族自治县 3557 若羌县
3558 轮台县 3559 乌鲁木齐县 3560 天山区 3561 头屯河区 3562 新市区
3563 水磨沟区 3564 沙依巴克区 3565 米东区 3566 达坂城区 3567 伊宁县
3568 伊宁市 3569 奎屯市 3570 察布查尔锡伯自治县 3571 尼勒克县 3572 巩留县
3573 新源县 3574 昭苏县 3575 特克斯县 3576 霍城县 3577 霍尔果斯市
3578 于田县 3579 和田县 3580 和田市 3581 墨玉县 3582 民丰县
3583 洛浦县 3584 皮山县 3585 策勒县 3586 阿拉尔市 3587 图木舒克市
3588 北屯市 3589 双河市 3590 铁门关市 3591 可克达拉市 3592 昆玉市
3593 胡杨河市 3594 元谋县 3595 南华县 3596 双柏县 3597 大姚县
3598 姚安县 3599 楚雄市 3600 武定县 3601 永仁县 3602 牟定县
3603 禄丰县 3604 东川区 3605 五华区 3606 呈贡区 3607 安宁市
3608 官渡区 3609 宜良县 3610 富民县 3611 寻甸回族彝族自治县 3612 嵩明县
3613 晋宁区 3614 盘龙区 3615 石林彝族自治县 3616 禄劝彝族苗族自治县 3617 西山区
3618 华坪县 3619 古城区 3620 宁蒗彝族自治县 3621 永胜县 3622 玉龙纳西族自治县
3623 梁河县 3624 瑞丽市 3625 盈江县 3626 芒市 3627 陇川县
3628 临翔区 3629 云县 3630 凤庆县 3631 双江拉祜族佤族布朗族傣族自治县 3632 永德县
3633 沧源佤族自治县 3634 耿马傣族佤族自治县 3635 镇康县 3636 会泽县 3637 宣威市
3638 富源县 3639 师宗县 3640 沾益区 3641 罗平县 3642 陆良县
3643 马龙区 3644 麒麟区 3645 施甸县 3646 昌宁县 3647 腾冲市
3648 隆阳区 3649 龙陵县 3650 墨江哈尼族自治县 3651 孟连傣族拉祜族佤族自治县 3652 宁洱哈尼族彝族自治县
3653 思茅区 3654 景东彝族自治县 3655 景谷傣族彝族自治县 3656 江城哈尼族彝族自治县 3657 澜沧拉祜族自治县
3658 西盟佤族自治县 3659 镇沅彝族哈尼族拉祜族自治县 3660 丘北县 3661 富宁县 3662 广南县
3663 文山市 3664 砚山县 3665 西畴县 3666 马关县 3667 麻栗坡县
3668 云龙县 3669 剑川县 3670 南涧彝族自治县 3671 大理市 3672 宾川县
3673 巍山彝族回族自治县 3674 弥渡县 3675 永平县 3676 洱源县 3677 漾濞彝族自治县
3678 祥云县 3679 鹤庆县 3680 个旧市 3681 元阳县 3682 屏边苗族自治县
3683 建水县 3684 开远市 3685 弥勒市 3686 河口瑶族自治县 3687 泸西县
3688 石屏县 3689 红河县 3690 绿春县 3691 蒙自市 3692 金平苗族瑶族傣族自治县
3693 大关县 3694 威信县 3695 巧家县 3696 彝良县 3697 昭阳区
3698 水富市 3699 永善县 3700 盐津县 3701 绥江县 3702 镇雄县
3703 鲁甸县 3704 元江哈尼族彝族傣族自治县 3705 华宁县 3706 峨山彝族自治县 3707 新平彝族傣族自治县
3708 易门县 3709 江川区 3710 澄江市 3711 红塔区 3712 通海县
3713 兰坪白族普米族自治县 3714 泸水市 3715 福贡县 3716 贡山独龙族怒族自治县 3717 德钦县
3718 维西傈僳族自治县 3719 香格里拉市 3720 勐海县 3721 勐腊县 3722 景洪市
3723 东阳市 3724 义乌市 3725 兰溪市 3726 婺城区 3727 武义县
3728 永康市 3729 浦江县 3730 磐安县 3731 金东区 3732 南湖区
3733 嘉善县 3734 平湖市 3735 桐乡市 3736 海宁市 3737 海盐县
3738 秀洲区 3739 常山县 3740 开化县 3741 柯城区 3742 江山市
3743 衢江区 3744 龙游县 3745 云和县 3746 庆元县 3747 景宁畲族自治县
3748 松阳县 3749 缙云县 3750 莲都区 3751 遂昌县 3752 青田县
3753 龙泉市 3754 余姚市 3755 北仑区 3756 奉化区 3757 宁海县
3758 慈溪市 3759 江北区 3760 海曙区 3761 象山县 3762 鄞州区
3763 镇海区 3764 上虞区 3765 嵊州市 3766 新昌县 3767 柯桥区
3768 诸暨市 3769 越城区 3770 乐清市 3771 平阳县 3772 文成县
3773 永嘉县 3774 泰顺县 3775 洞头区 3776 瑞安市 3777 瓯海区
3778 苍南县 3779 鹿城区 3780 龙港市 3781 龙湾区 3782 三门县
3783 临海市 3784 仙居县 3785 天台县 3786 椒江区 3787 温岭市
3788 玉环市 3789 路桥区 3790 黄岩区 3791 上城区 3792 下城区
3793 临安区 3794 余杭区 3795 富阳区 3796 建德市 3797 拱墅区
3798 桐庐县 3799 江干区 3800 淳安县 3801 滨江区 3802 萧山区
3803 西湖区 3804 定海区 3805 岱山县 3806 嵊泗县 3807 普陀区
3808 南浔区 3809 吴兴区 3810 安吉县 3811 德清县 3812 长兴县
3813 万州区 3814 丰都县 3815 九龙坡区 3816 云阳县 3817 北碚区
3818 南岸区 3819 南川区 3820 合川区 3821 垫江县 3822 城口县
3823 大渡口区 3824 大足区 3825 奉节县 3826 巫山县 3827 巫溪县
3828 巴南区 3829 开州区 3830 彭水苗族土家族自治县 3831 忠县 3832 梁平区
3833 武隆区 3834 永川区 3835 江北区 3836 江津区 3837 沙坪坝区
3838 涪陵区 3839 渝中区 3840 渝北区 3841 潼南区 3842 璧山区
3843 石柱土家族自治县 3844 秀山土家族苗族自治县 3845 綦江区 3846 荣昌区 3847 酉阳土家族苗族自治县
3848 铜梁区 3849 长寿区 3850 黔江区

 

规格

1 推广目的、推广流量、流量场景  -> 规格映射关系

备注：extensionType、extensionFlow、flowScene枚举含义参考附录部分。
+----------------+----------------+------------+-------+
| EXTENSION TYPE | EXTENSION FLOW | FLOW SCENE | VALUE |
+----------------+----------------+------------+-------+
|              2 |              2 |          2 |    71 |
|              2 |              2 |          4 |    71 |
|              2 |              2 |          3 |    71 |
|              2 |              2 |          5 |    71 |
|              2 |              2 |          5 |     1 |
|              2 |              2 |          5 |    35 |
|              2 |              2 |          5 |    30 |
|              2 |              2 |          6 |    60 |
|              2 |              2 |          6 |    63 |
|              2 |              2 |          6 |     1 |
|              2 |              2 |          6 |    20 |
|              2 |              2 |          6 |    30 |
|              2 |              2 |          6 |    50 |
|              2 |              3 |         12 |    71 |
|              2 |              3 |          7 |    71 |
|              2 |              3 |          7 |     4 |
|              2 |              3 |          7 |     1 |
|              2 |              3 |          7 |    20 |
|              2 |              3 |          9 |     1 |
|              2 |              3 |          9 |    20 |
|              2 |              3 |          9 |    30 |
|              2 |              3 |          9 |    60 |
|              2 |              3 |          9 |    71 |
|              2 |              3 |          8 |     5 |
|              2 |              3 |          8 |    71 |
|              2 |              3 |          8 |    63 |
|              2 |              3 |          8 |    34 |
|              2 |              3 |         10 |     1 |
|              2 |              3 |         10 |    20 |
|              2 |              3 |         10 |    30 |
|              2 |              3 |         10 |    60 |
|              2 |              3 |         10 |    71 |
|              2 |              3 |         11 |    60 |
|              1 |              2 |          6 |     1 |
|              1 |              2 |          6 |    50 |
|              1 |              2 |          6 |    20 |
|              1 |              2 |          6 |    30 |
|              1 |              2 |          6 |    60 |
|              1 |              2 |          6 |    63 |
|              1 |              2 |          5 |    71 |
|              1 |              2 |          5 |    30 |
|              1 |              2 |          5 |     1 |
|              1 |              3 |          7 |     1 |
|              1 |              3 |          7 |    20 |
|              1 |              3 |          7 |     4 |
|              1 |              3 |          7 |    71 |
|              1 |              3 |          9 |     1 |
|              1 |              3 |          9 |    20 |
|              1 |              3 |          9 |    30 |
|              1 |              3 |          9 |    60 |
|              1 |              3 |          9 |    71 |
|              1 |              3 |          8 |     5 |
|              1 |              3 |          8 |    71 |
|              1 |              3 |          8 |    63 |
|              1 |              3 |          8 |    34 |
|              1 |              3 |         10 |     1 |
|              1 |              3 |         10 |    20 |
|              1 |              3 |         10 |    30 |
|              1 |              3 |         10 |    60 |
|              1 |              3 |         10 |    71 |
|              1 |              3 |         11 |    60 |
|              3 |              2 |          6 |     1 |
|              3 |              2 |          6 |    20 |
|              3 |              2 |          6 |    30 |
|              3 |              2 |          6 |    60 |
|              3 |              2 |          5 |    71 |
|              3 |              2 |          5 |    30 |
|              3 |              2 |          5 |     1 |
|              2 |              2 |         12 |    71 |
|              3 |              3 |          7 |     1 |
|              3 |              3 |          7 |    20 |
|              3 |              3 |          7 |     4 |
|              3 |              3 |          7 |    71 |
|              3 |              3 |          9 |     1 |
|              3 |              3 |          9 |    20 |
|              3 |              3 |          9 |    30 |
|              3 |              3 |          9 |    60 |
|              3 |              3 |          9 |    71 |
|              3 |              3 |          8 |     5 |
|              3 |              3 |          8 |    71 |
|              3 |              3 |          8 |    63 |
|              3 |              3 |          8 |    34 |
|              3 |              3 |         10 |     1 |
|              3 |              3 |         10 |    20 |
|              3 |              3 |         10 |    30 |
|              3 |              3 |         10 |    60 |
|              3 |              3 |         10 |    71 |
|              3 |              3 |         11 |    60 |
|              3 |              3 |         12 |    71 |
|              2 |              1 |          1 |     1 |
|              2 |              1 |          1 |    30 |
|              2 |              1 |          1 |    71 |
|              2 |              1 |          1 |    50 |
|              2 |              1 |          1 |    20 |
|              2 |              1 |          1 |    60 |
|              2 |              1 |          1 |    63 |
|              2 |              1 |          1 |     5 |
|              2 |              1 |          1 |    34 |
|              2 |              1 |          1 |     4 |
|              2 |              1 |          1 |    35 |
+----------------+----------------+------------+-------+
2 规格id -> 规格名称映射关系
1 横版大图
4 通知栏
5 开屏横图
20 横版小图
30 横版组图
34 开屏竖图
35 横版两图
50 竖版大图
60 横版视频
63 竖版视频
71 图标大图
在线客服
公众号反馈
关注微信公众号，快速了解平台近况，若有任何问题和意见也可直接在公众号反馈。