营销平台3.0 Omni API

公共部分

【重要】对接必读

基本信息

Path： /0

Method： HEAD

接口描述：

修订记录

日期	修订版本	修改描述
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 接口添加快应用打开并加桌参数

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-关闭

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

基本信息

Path： /1

Method： GET

接口描述：

新版流量划分						旧版流量划分
推广目的	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

1. 公告

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

基本信息

Path： /1.1

Method： HEAD

接口描述：

兼容性考虑

为了减少对广告主的影响，元改分上线后，我们会在网关层增加一个过滤器，把这次涉及到的字段单位改回元。意思就是使用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 计划-新建计划

基本信息

Path： /2

Method： HEAD

接口描述：

1 获取支持的推广目的
curl "https://e.heytap.com/v3/communal/config/getList" ^
  -H "authority: e.heytap.com" ^
  -H "sec-ch-ua: ^^" Not;A Brand^^";v=^^"99^^", ^^"Google Chrome^^";v=^^"91^^", ^^"Chromium^^";v=^^"91^^"" ^
  -H "accept: application/json, text/plain, /" ^
  -H "sec-ch-ua-mobile: ?0" ^
  -H "tk: 0f85c3b8f9eeabcb1139c35b24a34ba8" ^
  -H "user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" ^
  -H "content-type: application/x-www-form-urlencoded" ^
  -H "origin: https://e.heytap.com" ^
  -H "sec-fetch-site: same-origin" ^
  -H "sec-fetch-mode: cors" ^
  -H "sec-fetch-dest: empty" ^
  -H "referer: https://e.heytap.com/markets/creative/create?type=create&level=plan" ^
  -H "accept-language: zh-CN,zh;q=0.9" ^
  -H "cookie: _dx_uzZo5y=f06782e4f086b5fba2b364f8bac0b82ce483d3115db45ef71a3cbc445d4d6efb2963e4c5; _dx_app_43768f2ab87180b2cbe718f62d4bc5fa=60efb2d5f7t3ngBT2eovAqJ7I44JeuwOrWWfNoI1; login-access-id=1000039147; _dx_captcha_vid=17AAA0A572A43768F2AB89FEC9DD2554F4CC6B3CDE738E99EB3AC^%^40bj; adstk=0f85c3b8f9eeabcb1139c35b24a34ba8; oadsk=c4ad011a83114968b65804ce3eab263b; JSESSIONID=3f3d57f6151440938521460d9919943d; WEBTOKEN=eyJhbGciOiJIUzUxMiIsInppcCI6IkRFRiJ9.eNqqViouTVKyUjI0AAJjS0MTcyUdpdSKAiUrQzMjM2NTczMTo1oAAAAA__8.yvzTWukhhHDxKxqkRbT9z0tkw6nJ3RXcwS-rg2uHSsqB5wsPuVT6B4Camt-YeS51a2RG428M79eB15jEIgotAQ" ^
  --data-raw "type=EXTENSION_TYPE" ^
  --compressed

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

2 新建带预算的应用推广类型计划
curl "https://e.heytap.com/v3/plan/add" ^
  -H "authority: e.heytap.com" ^
  -H "sec-ch-ua: ^^" Not;A Brand^^";v=^^"99^^", ^^"Google Chrome^^";v=^^"91^^", ^^"Chromium^^";v=^^"91^^"" ^
  -H "accept: application/json, text/plain, /" ^
  -H "sec-ch-ua-mobile: ?0" ^
  -H "tk: 0f85c3b8f9eeabcb1139c35b24a34ba8" ^
  -H "user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" ^
  -H "content-type: application/x-www-form-urlencoded" ^
  -H "origin: https://e.heytap.com" ^
  -H "sec-fetch-site: same-origin" ^
  -H "sec-fetch-mode: cors" ^
  -H "sec-fetch-dest: empty" ^
  -H "referer: https://e.heytap.com/markets/creative/create?type=create&level=plan" ^
  -H "accept-language: zh-CN,zh;q=0.9" ^
  -H "cookie: _dx_uzZo5y=f06782e4f086b5fba2b364f8bac0b82ce483d3115db45ef71a3cbc445d4d6efb2963e4c5; _dx_app_43768f2ab87180b2cbe718f62d4bc5fa=60efb2d5f7t3ngBT2eovAqJ7I44JeuwOrWWfNoI1; login-access-id=1000039147; _dx_captcha_vid=17AAA0A572A43768F2AB89FEC9DD2554F4CC6B3CDE738E99EB3AC^%^40bj; adstk=0f85c3b8f9eeabcb1139c35b24a34ba8; oadsk=c4ad011a83114968b65804ce3eab263b; JSESSIONID=3f3d57f6151440938521460d9919943d; WEBTOKEN=eyJhbGciOiJIUzUxMiIsInppcCI6IkRFRiJ9.eNqqViouTVKyUjI0AAJjS0MTcyUdpdSKAiUrQzMjM2NTczMTo1oAAAAA__8.yvzTWukhhHDxKxqkRbT9z0tkw6nJ3RXcwS-rg2uHSsqB5wsPuVT6B4Camt-YeS51a2RG428M79eB15jEIgotAQ" ^
  --data-raw "planId=&extensionType=2&planName=^%^E5^%^BA^%^94^%^E7^%^94^%^A8^%^E6^%^8E^%^A8^%^E5^%^B9^%^BF_2021^%^2F07^%^2F15_20^%^3A11^%^3A43&dayLimit=1&dayBudget=200000" ^
  --compressed

传参明细：
planId:
extensionType: 2
planName: 应用推广_2021/07/15_20:11:43
dayLimit: 1
dayBudget: 200000

返回： {"code":0,"data":{"planId":200012854}}

3 新建不带预算的链接推广类型计划
curl "https://e.heytap.com/v3/plan/add" ^
  -H "authority: e.heytap.com" ^
  -H "sec-ch-ua: ^^" Not;A Brand^^";v=^^"99^^", ^^"Google Chrome^^";v=^^"91^^", ^^"Chromium^^";v=^^"91^^"" ^
  -H "accept: application/json, text/plain, /" ^
  -H "sec-ch-ua-mobile: ?0" ^
  -H "tk: 0f85c3b8f9eeabcb1139c35b24a34ba8" ^
  -H "user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" ^
  -H "content-type: application/x-www-form-urlencoded" ^
  -H "origin: https://e.heytap.com" ^
  -H "sec-fetch-site: same-origin" ^
  -H "sec-fetch-mode: cors" ^
  -H "sec-fetch-dest: empty" ^
  -H "referer: https://e.heytap.com/markets/creative/create?type=create&level=plan" ^
  -H "accept-language: zh-CN,zh;q=0.9" ^
  -H "cookie: _dx_uzZo5y=f06782e4f086b5fba2b364f8bac0b82ce483d3115db45ef71a3cbc445d4d6efb2963e4c5; _dx_app_43768f2ab87180b2cbe718f62d4bc5fa=60efb2d5f7t3ngBT2eovAqJ7I44JeuwOrWWfNoI1; login-access-id=1000039147; _dx_captcha_vid=17AAA0A572A43768F2AB89FEC9DD2554F4CC6B3CDE738E99EB3AC^%^40bj; adstk=0f85c3b8f9eeabcb1139c35b24a34ba8; oadsk=c4ad011a83114968b65804ce3eab263b; JSESSIONID=3f3d57f6151440938521460d9919943d; WEBTOKEN=eyJhbGciOiJIUzUxMiIsInppcCI6IkRFRiJ9.eNqqViouTVKyUjI0AAJjS0MTcyUdpdSKAiUrQzMjM2NTczMTo1oAAAAA__8.yvzTWukhhHDxKxqkRbT9z0tkw6nJ3RXcwS-rg2uHSsqB5wsPuVT6B4Camt-YeS51a2RG428M79eB15jEIgotAQ" ^
  --data-raw "planId=&extensionType=1&planName=^%^E7^%^BD^%^91^%^E9^%^A1^%^B5^%^E6^%^8E^%^A8^%^E5^%^B9^%^BF_2021^%^2F07^%^2F15_20^%^3A27^%^3A12&dayLimit=0&dayBudget=0" ^
  --compressed

传参明细：
planId:
extensionType: 1
planName: 网页推广_2021/07/15_20:27:12
dayLimit: 0
dayBudget: 0

返回：{"code":0,"data":{"planId":200012858}}

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

基本信息

Path： /1

Method： HEAD

接口描述：

1 获取当前支持的推广目的：
curl "https://e.heytap.com/v3/communal/config/getList" ^
  -H "authority: e.heytap.com" ^
  -H "sec-ch-ua: ^^" Not;A Brand^^";v=^^"99^^", ^^"Google Chrome^^";v=^^"91^^", ^^"Chromium^^";v=^^"91^^"" ^
  -H "accept: application/json, text/plain, /" ^
  -H "sec-ch-ua-mobile: ?0" ^
  -H "tk: fe147810e22dd1ef931b0b5a50634787" ^
  -H "user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" ^
  -H "content-type: application/x-www-form-urlencoded" ^
  -H "origin: https://e.heytap.com" ^
  -H "sec-fetch-site: same-origin" ^
  -H "sec-fetch-mode: cors" ^
  -H "sec-fetch-dest: empty" ^
  -H "referer: https://e.heytap.com/markets/creative/create?type=create&level=group" ^
  -H "accept-language: zh-CN,zh;q=0.9" ^
  -H "cookie: _dx_uzZo5y=f06782e4f086b5fba2b364f8bac0b82ce483d3115db45ef71a3cbc445d4d6efb2963e4c5; _dx_app_43768f2ab87180b2cbe718f62d4bc5fa=60efb2d5f7t3ngBT2eovAqJ7I44JeuwOrWWfNoI1; login-access-id=1000039147; _dx_captcha_vid=17AA92310BB43768F2AB8156384572F86409B91C4999BBAD02019^%^40bj; adstk=fe147810e22dd1ef931b0b5a50634787; oadsk=ca0e7f0cd3e44fcc8e914d08841432d2; JSESSIONID=c6065975836a474783593b00309c41c3; WEBTOKEN=eyJhbGciOiJIUzUxMiIsInppcCI6IkRFRiJ9.eNqqViouTVKyUjI0AAJjS0MTcyUdpdSKAiUrQzMjM2MTIxMLs1oAAAAA__8.thCAho7bcuCmufEIaDBxVvtVo_bqOmMwHor_3QBNm8cJTJsRvOS9UIA2GTVcp_JLCIwtsJTwdwnsOZM22ufZ3Q" ^
  --data-raw "type=EXTENSION_TYPE" ^
  --compressed

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

2 获取当前支持的推广流量：
curl "https://e.heytap.com/v3/communal/config/getList" ^
  -H "authority: e.heytap.com" ^
  -H "sec-ch-ua: ^^" Not;A Brand^^";v=^^"99^^", ^^"Google Chrome^^";v=^^"91^^", ^^"Chromium^^";v=^^"91^^"" ^
  -H "accept: application/json, text/plain, /" ^
  -H "sec-ch-ua-mobile: ?0" ^
  -H "tk: fe147810e22dd1ef931b0b5a50634787" ^
  -H "user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" ^
  -H "content-type: application/x-www-form-urlencoded" ^
  -H "origin: https://e.heytap.com" ^
  -H "sec-fetch-site: same-origin" ^
  -H "sec-fetch-mode: cors" ^
  -H "sec-fetch-dest: empty" ^
  -H "referer: https://e.heytap.com/markets/creative/create?type=create&level=group" ^
  -H "accept-language: zh-CN,zh;q=0.9" ^
  -H "cookie: _dx_uzZo5y=f06782e4f086b5fba2b364f8bac0b82ce483d3115db45ef71a3cbc445d4d6efb2963e4c5; _dx_app_43768f2ab87180b2cbe718f62d4bc5fa=60efb2d5f7t3ngBT2eovAqJ7I44JeuwOrWWfNoI1; login-access-id=1000039147; _dx_captcha_vid=17AA92310BB43768F2AB8156384572F86409B91C4999BBAD02019^%^40bj; adstk=fe147810e22dd1ef931b0b5a50634787; oadsk=ca0e7f0cd3e44fcc8e914d08841432d2; JSESSIONID=c6065975836a474783593b00309c41c3; WEBTOKEN=eyJhbGciOiJIUzUxMiIsInppcCI6IkRFRiJ9.eNqqViouTVKyUjI0AAJjS0MTcyUdpdSKAiUrQzMjM2MTIxMLs1oAAAAA__8.thCAho7bcuCmufEIaDBxVvtVo_bqOmMwHor_3QBNm8cJTJsRvOS9UIA2GTVcp_JLCIwtsJTwdwnsOZM22ufZ3Q" ^
  --data-raw "type=EXTENSION_FLOW&extensionType=2" ^
  --compressed

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

3 获取支持的流量场景：
curl "https://e.heytap.com/v3/communal/config/getList" ^
  -H "authority: e.heytap.com" ^
  -H "sec-ch-ua: ^^" Not;A Brand^^";v=^^"99^^", ^^"Google Chrome^^";v=^^"91^^", ^^"Chromium^^";v=^^"91^^"" ^
  -H "accept: application/json, text/plain, /" ^
  -H "sec-ch-ua-mobile: ?0" ^
  -H "tk: fe147810e22dd1ef931b0b5a50634787" ^
  -H "user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" ^
  -H "content-type: application/x-www-form-urlencoded" ^
  -H "origin: https://e.heytap.com" ^
  -H "sec-fetch-site: same-origin" ^
  -H "sec-fetch-mode: cors" ^
  -H "sec-fetch-dest: empty" ^
  -H "referer: https://e.heytap.com/markets/creative/create?type=create&level=group" ^
  -H "accept-language: zh-CN,zh;q=0.9" ^
  -H "cookie: _dx_uzZo5y=f06782e4f086b5fba2b364f8bac0b82ce483d3115db45ef71a3cbc445d4d6efb2963e4c5; _dx_app_43768f2ab87180b2cbe718f62d4bc5fa=60efb2d5f7t3ngBT2eovAqJ7I44JeuwOrWWfNoI1; login-access-id=1000039147; _dx_captcha_vid=17AA92310BB43768F2AB8156384572F86409B91C4999BBAD02019^%^40bj; adstk=fe147810e22dd1ef931b0b5a50634787; oadsk=ca0e7f0cd3e44fcc8e914d08841432d2; JSESSIONID=c6065975836a474783593b00309c41c3; WEBTOKEN=eyJhbGciOiJIUzUxMiIsInppcCI6IkRFRiJ9.eNqqViouTVKyUjI0AAJjS0MTcyUdpdSKAiUrQzMjM2MTIxMLs1oAAAAA__8.thCAho7bcuCmufEIaDBxVvtVo_bqOmMwHor_3QBNm8cJTJsRvOS9UIA2GTVcp_JLCIwtsJTwdwnsOZM22ufZ3Q" ^
  --data-raw "type=FLOW_SCENE&extensionType=2&extensionFlow=3" ^
  --compressed

返回：{"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 获取应用信息：
curl "https://e.heytap.com/v2/communal/group/appInfo" ^
  -H "authority: e.heytap.com" ^
  -H "sec-ch-ua: ^^" Not;A Brand^^";v=^^"99^^", ^^"Google Chrome^^";v=^^"91^^", ^^"Chromium^^";v=^^"91^^"" ^
  -H "accept: application/json, text/plain, /" ^
  -H "sec-ch-ua-mobile: ?0" ^
  -H "tk: fe147810e22dd1ef931b0b5a50634787" ^
  -H "user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" ^
  -H "content-type: application/x-www-form-urlencoded" ^
  -H "origin: https://e.heytap.com" ^
  -H "sec-fetch-site: same-origin" ^
  -H "sec-fetch-mode: cors" ^
  -H "sec-fetch-dest: empty" ^
  -H "referer: https://e.heytap.com/markets/creative/create?type=create&level=group" ^
  -H "accept-language: zh-CN,zh;q=0.9" ^
  -H "cookie: _dx_uzZo5y=f06782e4f086b5fba2b364f8bac0b82ce483d3115db45ef71a3cbc445d4d6efb2963e4c5; _dx_app_43768f2ab87180b2cbe718f62d4bc5fa=60efb2d5f7t3ngBT2eovAqJ7I44JeuwOrWWfNoI1; login-access-id=1000039147; _dx_captcha_vid=17AA92310BB43768F2AB8156384572F86409B91C4999BBAD02019^%^40bj; adstk=fe147810e22dd1ef931b0b5a50634787; oadsk=ca0e7f0cd3e44fcc8e914d08841432d2; JSESSIONID=c6065975836a474783593b00309c41c3; WEBTOKEN=eyJhbGciOiJIUzUxMiIsInppcCI6IkRFRiJ9.eNqqViouTVKyUjI0AAJjS0MTcyUdpdSKAiUrQzMjM2MTIxMLs1oAAAAA__8.thCAho7bcuCmufEIaDBxVvtVo_bqOmMwHor_3QBNm8cJTJsRvOS9UIA2GTVcp_JLCIwtsJTwdwnsOZM22ufZ3Q" ^
  --data-raw "appId=30383853" ^
  --compressed

返回：{"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 获取当前支持的落地页类型：
curl "https://e.heytap.com/v3/communal/config/getList" ^
  -H "authority: e.heytap.com" ^
  -H "sec-ch-ua: ^^" Not;A Brand^^";v=^^"99^^", ^^"Google Chrome^^";v=^^"91^^", ^^"Chromium^^";v=^^"91^^"" ^
  -H "accept: application/json, text/plain, /" ^
  -H "sec-ch-ua-mobile: ?0" ^
  -H "tk: fe147810e22dd1ef931b0b5a50634787" ^
  -H "user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" ^
  -H "content-type: application/x-www-form-urlencoded" ^
  -H "origin: https://e.heytap.com" ^
  -H "sec-fetch-site: same-origin" ^
  -H "sec-fetch-mode: cors" ^
  -H "sec-fetch-dest: empty" ^
  -H "referer: https://e.heytap.com/markets/creative/create?type=create&level=group" ^
  -H "accept-language: zh-CN,zh;q=0.9" ^
  -H "cookie: _dx_uzZo5y=f06782e4f086b5fba2b364f8bac0b82ce483d3115db45ef71a3cbc445d4d6efb2963e4c5; _dx_app_43768f2ab87180b2cbe718f62d4bc5fa=60efb2d5f7t3ngBT2eovAqJ7I44JeuwOrWWfNoI1; login-access-id=1000039147; _dx_captcha_vid=17AA92310BB43768F2AB8156384572F86409B91C4999BBAD02019^%^40bj; adstk=fe147810e22dd1ef931b0b5a50634787; oadsk=ca0e7f0cd3e44fcc8e914d08841432d2; JSESSIONID=c6065975836a474783593b00309c41c3; WEBTOKEN=eyJhbGciOiJIUzUxMiIsInppcCI6IkRFRiJ9.eNqqViouTVKyUjI0AAJjS0MTcyUdpdSKAiUrQzMjM2MTIxMLs1oAAAAA__8.thCAho7bcuCmufEIaDBxVvtVo_bqOmMwHor_3QBNm8cJTJsRvOS9UIA2GTVcp_JLCIwtsJTwdwnsOZM22ufZ3Q" ^
  --data-raw "type=PAGE_TYPE&extensionFlow=3&extensionType=2&flowScene=12" ^
  --compressed

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

6 获取萤火虫应用下载模板页：
curl "https://e.heytap.com/v3/communal/h5Template/list" ^
  -H "authority: e.heytap.com" ^
  -H "sec-ch-ua: ^^" Not;A Brand^^";v=^^"99^^", ^^"Google Chrome^^";v=^^"91^^", ^^"Chromium^^";v=^^"91^^"" ^
  -H "accept: application/json, text/plain, /" ^
  -H "sec-ch-ua-mobile: ?0" ^
  -H "tk: fe147810e22dd1ef931b0b5a50634787" ^
  -H "user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" ^
  -H "content-type: application/x-www-form-urlencoded" ^
  -H "origin: https://e.heytap.com" ^
  -H "sec-fetch-site: same-origin" ^
  -H "sec-fetch-mode: cors" ^
  -H "sec-fetch-dest: empty" ^
  -H "referer: https://e.heytap.com/markets/creative/create?type=create&level=group" ^
  -H "accept-language: zh-CN,zh;q=0.9" ^
  -H "cookie: _dx_uzZo5y=f06782e4f086b5fba2b364f8bac0b82ce483d3115db45ef71a3cbc445d4d6efb2963e4c5; _dx_app_43768f2ab87180b2cbe718f62d4bc5fa=60efb2d5f7t3ngBT2eovAqJ7I44JeuwOrWWfNoI1; login-access-id=1000039147; _dx_captcha_vid=17AA92310BB43768F2AB8156384572F86409B91C4999BBAD02019^%^40bj; adstk=fe147810e22dd1ef931b0b5a50634787; oadsk=ca0e7f0cd3e44fcc8e914d08841432d2; JSESSIONID=c6065975836a474783593b00309c41c3; WEBTOKEN=eyJhbGciOiJIUzUxMiIsInppcCI6IkRFRiJ9.eNqqViouTVKyUjI0AAJjS0MTcyUdpdSKAiUrQzMjM2MTIxMLs1oAAAAA__8.thCAho7bcuCmufEIaDBxVvtVo_bqOmMwHor_3QBNm8cJTJsRvOS9UIA2GTVcp_JLCIwtsJTwdwnsOZM22ufZ3Q" ^
  --data-raw "extensionFlow=3&flowScene=12" ^
  --compressed

返回：{"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支持的萤火虫落地页：
curl "https://e.heytap.com/v2/communal/ad/sparkPageNew/list" ^
  -H "authority: e.heytap.com" ^
  -H "sec-ch-ua: ^^" Not;A Brand^^";v=^^"99^^", ^^"Google Chrome^^";v=^^"91^^", ^^"Chromium^^";v=^^"91^^"" ^
  -H "accept: application/json, text/plain, /" ^
  -H "sec-ch-ua-mobile: ?0" ^
  -H "tk: fe147810e22dd1ef931b0b5a50634787" ^
  -H "user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" ^
  -H "content-type: application/x-www-form-urlencoded" ^
  -H "origin: https://e.heytap.com" ^
  -H "sec-fetch-site: same-origin" ^
  -H "sec-fetch-mode: cors" ^
  -H "sec-fetch-dest: empty" ^
  -H "referer: https://e.heytap.com/markets/creative/create?type=create&level=group" ^
  -H "accept-language: zh-CN,zh;q=0.9" ^
  -H "cookie: _dx_uzZo5y=f06782e4f086b5fba2b364f8bac0b82ce483d3115db45ef71a3cbc445d4d6efb2963e4c5; _dx_app_43768f2ab87180b2cbe718f62d4bc5fa=60efb2d5f7t3ngBT2eovAqJ7I44JeuwOrWWfNoI1; login-access-id=1000039147; _dx_captcha_vid=17AA92310BB43768F2AB8156384572F86409B91C4999BBAD02019^%^40bj; adstk=fe147810e22dd1ef931b0b5a50634787; oadsk=ca0e7f0cd3e44fcc8e914d08841432d2; JSESSIONID=c6065975836a474783593b00309c41c3; WEBTOKEN=eyJhbGciOiJIUzUxMiIsInppcCI6IkRFRiJ9.eNqqViouTVKyUjI0AAJjS0MTcyUdpdSKAiUrQzMjM2MTIxMLs1oAAAAA__8.thCAho7bcuCmufEIaDBxVvtVo_bqOmMwHor_3QBNm8cJTJsRvOS9UIA2GTVcp_JLCIwtsJTwdwnsOZM22ufZ3Q" ^
  --data-raw "pageType=4&appId=30383853" ^
  --compressed

8 获取对应流量场景支持的转化类型：
curl "https://e.heytap.com/v3/communal/config/getList" ^
  -H "authority: e.heytap.com" ^
  -H "sec-ch-ua: ^^" Not;A Brand^^";v=^^"99^^", ^^"Google Chrome^^";v=^^"91^^", ^^"Chromium^^";v=^^"91^^"" ^
  -H "accept: application/json, text/plain, /" ^
  -H "sec-ch-ua-mobile: ?0" ^
  -H "tk: fe147810e22dd1ef931b0b5a50634787" ^
  -H "user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" ^
  -H "content-type: application/x-www-form-urlencoded" ^
  -H "origin: https://e.heytap.com" ^
  -H "sec-fetch-site: same-origin" ^
  -H "sec-fetch-mode: cors" ^
  -H "sec-fetch-dest: empty" ^
  -H "referer: https://e.heytap.com/markets/creative/create?type=create&level=group" ^
  -H "accept-language: zh-CN,zh;q=0.9" ^
  -H "cookie: _dx_uzZo5y=f06782e4f086b5fba2b364f8bac0b82ce483d3115db45ef71a3cbc445d4d6efb2963e4c5; _dx_app_43768f2ab87180b2cbe718f62d4bc5fa=60efb2d5f7t3ngBT2eovAqJ7I44JeuwOrWWfNoI1; login-access-id=1000039147; _dx_captcha_vid=17AA92310BB43768F2AB8156384572F86409B91C4999BBAD02019^%^40bj; adstk=fe147810e22dd1ef931b0b5a50634787; oadsk=ca0e7f0cd3e44fcc8e914d08841432d2; JSESSIONID=c6065975836a474783593b00309c41c3; WEBTOKEN=eyJhbGciOiJIUzUxMiIsInppcCI6IkRFRiJ9.eNqqViouTVKyUjI0AAJjS0MTcyUdpdSKAiUrQzMjM2MTIxMLs1oAAAAA__8.thCAho7bcuCmufEIaDBxVvtVo_bqOmMwHor_3QBNm8cJTJsRvOS9UIA2GTVcp_JLCIwtsJTwdwnsOZM22ufZ3Q" ^
  --data-raw "type=OCPC_TYPE&extensionType=2&flowScene=12" ^
  --compressed

返回：{"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 获取对应流量场景支持的深度转化类型：
curl "https://e.heytap.com/v3/communal/config/getList" ^
  -H "authority: e.heytap.com" ^
  -H "sec-ch-ua: ^^" Not;A Brand^^";v=^^"99^^", ^^"Google Chrome^^";v=^^"91^^", ^^"Chromium^^";v=^^"91^^"" ^
  -H "accept: application/json, text/plain, /" ^
  -H "sec-ch-ua-mobile: ?0" ^
  -H "tk: fe147810e22dd1ef931b0b5a50634787" ^
  -H "user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" ^
  -H "content-type: application/x-www-form-urlencoded" ^
  -H "origin: https://e.heytap.com" ^
  -H "sec-fetch-site: same-origin" ^
  -H "sec-fetch-mode: cors" ^
  -H "sec-fetch-dest: empty" ^
  -H "referer: https://e.heytap.com/markets/creative/create?type=create&level=group" ^
  -H "accept-language: zh-CN,zh;q=0.9" ^
  -H "cookie: _dx_uzZo5y=f06782e4f086b5fba2b364f8bac0b82ce483d3115db45ef71a3cbc445d4d6efb2963e4c5; _dx_app_43768f2ab87180b2cbe718f62d4bc5fa=60efb2d5f7t3ngBT2eovAqJ7I44JeuwOrWWfNoI1; login-access-id=1000039147; _dx_captcha_vid=17AA92310BB43768F2AB8156384572F86409B91C4999BBAD02019^%^40bj; adstk=fe147810e22dd1ef931b0b5a50634787; oadsk=ca0e7f0cd3e44fcc8e914d08841432d2; JSESSIONID=c6065975836a474783593b00309c41c3; WEBTOKEN=eyJhbGciOiJIUzUxMiIsInppcCI6IkRFRiJ9.eNqqViouTVKyUjI0AAJjS0MTcyUdpdSKAiUrQzMjM2MTIxMLs1oAAAAA__8.thCAho7bcuCmufEIaDBxVvtVo_bqOmMwHor_3QBNm8cJTJsRvOS9UIA2GTVcp_JLCIwtsJTwdwnsOZM22ufZ3Q" ^
  --data-raw "type=DEEP_OCPC_TYPE&ocpcType=0&extensionType=2&extensionFlow=3&flowScene=12" ^
  --compressed

返回：{"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-15","ext":"{"name":"系统留存","value":15,"ocpcType":8}"}]}

10 获取价格限制配置：
curl "https://e.heytap.com/v3/communal/interval/config/groupPrice?flowScene=12&ocpcType=0" ^
  -H "authority: e.heytap.com" ^
  -H "sec-ch-ua: ^^" Not;A Brand^^";v=^^"99^^", ^^"Google Chrome^^";v=^^"91^^", ^^"Chromium^^";v=^^"91^^"" ^
  -H "accept: application/json, text/plain, /" ^
  -H "sec-ch-ua-mobile: ?0" ^
  -H "tk: fe147810e22dd1ef931b0b5a50634787" ^
  -H "user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" ^
  -H "content-type: application/json" ^
  -H "sec-fetch-site: same-origin" ^
  -H "sec-fetch-mode: cors" ^
  -H "sec-fetch-dest: empty" ^
  -H "referer: https://e.heytap.com/markets/creative/create?type=create&level=group" ^
  -H "accept-language: zh-CN,zh;q=0.9" ^
  -H "cookie: _dx_uzZo5y=f06782e4f086b5fba2b364f8bac0b82ce483d3115db45ef71a3cbc445d4d6efb2963e4c5; _dx_app_43768f2ab87180b2cbe718f62d4bc5fa=60efb2d5f7t3ngBT2eovAqJ7I44JeuwOrWWfNoI1; login-access-id=1000039147; _dx_captcha_vid=17AA92310BB43768F2AB8156384572F86409B91C4999BBAD02019^%^40bj; adstk=fe147810e22dd1ef931b0b5a50634787; oadsk=ca0e7f0cd3e44fcc8e914d08841432d2; JSESSIONID=c6065975836a474783593b00309c41c3; WEBTOKEN=eyJhbGciOiJIUzUxMiIsInppcCI6IkRFRiJ9.eNqqViouTVKyUjI0AAJjS0MTcyUdpdSKAiUrQzMjM2MTIxMLs1oAAAAA__8.thCAho7bcuCmufEIaDBxVvtVo_bqOmMwHor_3QBNm8cJTJsRvOS9UIA2GTVcp_JLCIwtsJTwdwnsOZM22ufZ3Q" ^
  --compressed

返回：{"code":0,"data":{"flowScene":12,"ocpcType":0,"floorBid":10,"maxBid":10000,"oFloorBid":120,"oMaxBid":20000,"dFloorBid":120,"dMaxBid":300000}}

--------------------------- 最终新建广告组 ------------------------

新建一个ocpc激活类型、应用下载模板页为萤火虫沉浸式B版，app为绝世仙王、且设置了推广日期和播放时段的的联盟banner广告组：
curl "https://e.heytap.com/v3/group/add" ^
  -H "authority: e.heytap.com" ^
  -H "sec-ch-ua: ^^" Not;A Brand^^";v=^^"99^^", ^^"Google Chrome^^";v=^^"91^^", ^^"Chromium^^";v=^^"91^^"" ^
  -H "accept: application/json, text/plain, /" ^
  -H "sec-ch-ua-mobile: ?0" ^
  -H "tk: fe147810e22dd1ef931b0b5a50634787" ^
  -H "user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" ^
  -H "content-type: application/x-www-form-urlencoded" ^
  -H "origin: https://e.heytap.com" ^
  -H "sec-fetch-site: same-origin" ^
  -H "sec-fetch-mode: cors" ^
  -H "sec-fetch-dest: empty" ^
  -H "referer: https://e.heytap.com/markets/creative/create?type=create&level=group" ^
  -H "accept-language: zh-CN,zh;q=0.9" ^
  -H "cookie: _dx_uzZo5y=f06782e4f086b5fba2b364f8bac0b82ce483d3115db45ef71a3cbc445d4d6efb2963e4c5; _dx_app_43768f2ab87180b2cbe718f62d4bc5fa=60efb2d5f7t3ngBT2eovAqJ7I44JeuwOrWWfNoI1; login-access-id=1000039147; _dx_captcha_vid=17AA92310BB43768F2AB8156384572F86409B91C4999BBAD02019^%^40bj; adstk=fe147810e22dd1ef931b0b5a50634787; oadsk=ca0e7f0cd3e44fcc8e914d08841432d2; JSESSIONID=c6065975836a474783593b00309c41c3; WEBTOKEN=eyJhbGciOiJIUzUxMiIsInppcCI6IkRFRiJ9.eNqqViouTVKyUjI0AAJjS0MTcyUdpdSKAiUrQzMjM2MTIxMLs1oAAAAA__8.thCAho7bcuCmufEIaDBxVvtVo_bqOmMwHor_3QBNm8cJTJsRvOS9UIA2GTVcp_JLCIwtsJTwdwnsOZM22ufZ3Q" ^
  --data-raw "planId=200001707&adGroupId=&adGroupName=^%^E5^%^BA^%^94^%^E7^%^94^%^A8^%^E6^%^8E^%^A8^%^E5^%^B9^%^BF_^%^E8^%^81^%^94^%^E7^%^9B^%^9F^%^E6^%^B5^%^81^%^E9^%^87^%^8F_2021^%^2F07^%^2F15_15^%^3A53^%^3A11&appId=30383853&deepUrl=&instantAppId=&instantAppUrl=&extensionFlow=3&flowScene=7&pageType=11&pageId=5&pageUrl=https^%^3A^%^2F^%^2Fadsfs.heytapimage.com^%^2Fmarketing^%^2Ftemplate^%^2Funion^%^2FB^%^2Findex.html^%^3Fpagebgcolor^%^3Dimmerse^%^26pkg^%^3Dcom.syzh.jsxw.nearme.gamecenter&smartExpandType=0&timeLimit=1&dayLimit=1&beginTime=20210715&endTime=20210717&timeSet=^%^7B^%^221^%^22^%^3A^%^221^%^2C2^%^22^%^2C^%^222^%^22^%^3A^%^22^%^22^%^2C^%^223^%^22^%^3A^%^22^%^22^%^2C^%^224^%^22^%^3A^%^22^%^22^%^2C^%^225^%^22^%^3A^%^22^%^22^%^2C^%^226^%^22^%^3A^%^22^%^22^%^2C^%^227^%^22^%^3A^%^22^%^22^%^7D&billingType=5&adServingType=0&followMaxPrice=&price=100&ocpcType=2&ocpcPrice=200&targetId=0&extensionType=2&groupPrice=1&autoOpenFlag=0&targetSource=1&followAppIdList=&oldTarget=0&smartExpandBreakthrough=" ^
  --compressed

传参为：
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

返回：
{"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 创意-创建广告创意

基本信息

Path： /3

Method： HEAD

接口描述：

1 获取按钮文案（可选）
curl "https://e.heytap.com/v3/communal/config/getList" ^
  -H "authority: e.heytap.com" ^
  -H "sec-ch-ua: ^^" Not;A Brand^^";v=^^"99^^", ^^"Google Chrome^^";v=^^"91^^", ^^"Chromium^^";v=^^"91^^"" ^
  -H "accept: application/json, text/plain, /" ^
  -H "sec-ch-ua-mobile: ?0" ^
  -H "tk: 04f89b3ea43b6989dd1f96b883adc6fd" ^
  -H "user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" ^
  -H "content-type: application/x-www-form-urlencoded" ^
  -H "origin: https://e.heytap.com" ^
  -H "sec-fetch-site: same-origin" ^
  -H "sec-fetch-mode: cors" ^
  -H "sec-fetch-dest: empty" ^
  -H "referer: https://e.heytap.com/markets/creative/create?type=create&level=plan" ^
  -H "accept-language: zh-CN,zh;q=0.9" ^
  -H "cookie: _dx_uzZo5y=f06782e4f086b5fba2b364f8bac0b82ce483d3115db45ef71a3cbc445d4d6efb2963e4c5; _dx_app_43768f2ab87180b2cbe718f62d4bc5fa=60efb2d5f7t3ngBT2eovAqJ7I44JeuwOrWWfNoI1; _dx_captcha_vid=17AADEB152543768F2AB86A51732DAB534ED98317126251AEA23A^%^40bj; adstk=04f89b3ea43b6989dd1f96b883adc6fd; oadsk=8b26213c8c5b49898ee46307067a04fd; JSESSIONID=392bb473b8f64a92bf4f8bf0e7651a5b; WEBTOKEN=eyJhbGciOiJIUzUxMiIsInppcCI6IkRFRiJ9.eNqqViouTVKyUjI0AAJjS0MTcyUdpdSKAiUrQzMjMxMjI3MD41oAAAAA__8.OOrsZcKV3hPT4qElDDAnMBPPJu1oF9XYKkfQg5xtgaGkH0kznsaSuU7h2yuAQG00Lg2z7yih3ezh5_a4T_yTFw; login-access-id=1000039147" ^
  --data-raw "type=BUTTON_TITLE" ^
  --compressed
{"code":0,"data":[{"value":"0","ext":"["打开","下载","去看看","了解详情","参与活动","领取优惠","立即打开","立即下载","立即查看","立即体验","立即申请","立即抢购","立即领取","立即加入","获取报价","点击咨询"]"}]}

2 获取广告组下每个规格下支持可创建的创意数量上限（必须）
curl "https://e.heytap.com/v3/communal/config/getList" ^
  -H "authority: e.heytap.com" ^
  -H "sec-ch-ua: ^^" Not;A Brand^^";v=^^"99^^", ^^"Google Chrome^^";v=^^"91^^", ^^"Chromium^^";v=^^"91^^"" ^
  -H "accept: application/json, text/plain, /" ^
  -H "sec-ch-ua-mobile: ?0" ^
  -H "tk: 04f89b3ea43b6989dd1f96b883adc6fd" ^
  -H "user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" ^
  -H "content-type: application/x-www-form-urlencoded" ^
  -H "origin: https://e.heytap.com" ^
  -H "sec-fetch-site: same-origin" ^
  -H "sec-fetch-mode: cors" ^
  -H "sec-fetch-dest: empty" ^
  -H "referer: https://e.heytap.com/markets/creative/create?type=create&level=plan" ^
  -H "accept-language: zh-CN,zh;q=0.9" ^
  -H "cookie: _dx_uzZo5y=f06782e4f086b5fba2b364f8bac0b82ce483d3115db45ef71a3cbc445d4d6efb2963e4c5; _dx_app_43768f2ab87180b2cbe718f62d4bc5fa=60efb2d5f7t3ngBT2eovAqJ7I44JeuwOrWWfNoI1; _dx_captcha_vid=17AADEB152543768F2AB86A51732DAB534ED98317126251AEA23A^%^40bj; adstk=04f89b3ea43b6989dd1f96b883adc6fd; oadsk=8b26213c8c5b49898ee46307067a04fd; JSESSIONID=392bb473b8f64a92bf4f8bf0e7651a5b; WEBTOKEN=eyJhbGciOiJIUzUxMiIsInppcCI6IkRFRiJ9.eNqqViouTVKyUjI0AAJjS0MTcyUdpdSKAiUrQzMjMxMjI3MD41oAAAAA__8.OOrsZcKV3hPT4qElDDAnMBPPJu1oF9XYKkfQg5xtgaGkH0kznsaSuU7h2yuAQG00Lg2z7yih3ezh5_a4T_yTFw; login-access-id=1000039147" ^
  --data-raw "type=AD_EACH_SPEC_NUM_LIMIT" ^
  --compressed

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

3 获取广告组下所有规格支持的可创建创意数量上限（必须）
curl "https://e.heytap.com/v3/communal/config/getList" ^
  -H "authority: e.heytap.com" ^
  -H "sec-ch-ua: ^^" Not;A Brand^^";v=^^"99^^", ^^"Google Chrome^^";v=^^"91^^", ^^"Chromium^^";v=^^"91^^"" ^
  -H "accept: application/json, text/plain, /" ^
  -H "sec-ch-ua-mobile: ?0" ^
  -H "tk: 04f89b3ea43b6989dd1f96b883adc6fd" ^
  -H "user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" ^
  -H "content-type: application/x-www-form-urlencoded" ^
  -H "origin: https://e.heytap.com" ^
  -H "sec-fetch-site: same-origin" ^
  -H "sec-fetch-mode: cors" ^
  -H "sec-fetch-dest: empty" ^
  -H "referer: https://e.heytap.com/markets/creative/create?type=create&level=plan" ^
  -H "accept-language: zh-CN,zh;q=0.9" ^
  -H "cookie: _dx_uzZo5y=f06782e4f086b5fba2b364f8bac0b82ce483d3115db45ef71a3cbc445d4d6efb2963e4c5; _dx_app_43768f2ab87180b2cbe718f62d4bc5fa=60efb2d5f7t3ngBT2eovAqJ7I44JeuwOrWWfNoI1; _dx_captcha_vid=17AADEB152543768F2AB86A51732DAB534ED98317126251AEA23A^%^40bj; adstk=04f89b3ea43b6989dd1f96b883adc6fd; oadsk=8b26213c8c5b49898ee46307067a04fd; JSESSIONID=392bb473b8f64a92bf4f8bf0e7651a5b; WEBTOKEN=eyJhbGciOiJIUzUxMiIsInppcCI6IkRFRiJ9.eNqqViouTVKyUjI0AAJjS0MTcyUdpdSKAiUrQzMjMxMjI3MD41oAAAAA__8.OOrsZcKV3hPT4qElDDAnMBPPJu1oF9XYKkfQg5xtgaGkH0kznsaSuU7h2yuAQG00Lg2z7yih3ezh5_a4T_yTFw; login-access-id=1000039147" ^
  --data-raw "type=AD_ALL_SPEC_NUM_LIMIT" ^
  --compressed

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

4 获取动态词包（可选）
curl "https://e.heytap.com/v2/communal/dynamic/symbol/list" ^
  -H "authority: e.heytap.com" ^
  -H "sec-ch-ua: ^^" Not;A Brand^^";v=^^"99^^", ^^"Google Chrome^^";v=^^"91^^", ^^"Chromium^^";v=^^"91^^"" ^
  -H "accept: application/json, text/plain, /" ^
  -H "sec-ch-ua-mobile: ?0" ^
  -H "tk: 04f89b3ea43b6989dd1f96b883adc6fd" ^
  -H "user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" ^
  -H "content-type: application/x-www-form-urlencoded" ^
  -H "origin: https://e.heytap.com" ^
  -H "sec-fetch-site: same-origin" ^
  -H "sec-fetch-mode: cors" ^
  -H "sec-fetch-dest: empty" ^
  -H "referer: https://e.heytap.com/markets/creative/create?type=create&level=plan" ^
  -H "accept-language: zh-CN,zh;q=0.9" ^
  -H "cookie: _dx_uzZo5y=f06782e4f086b5fba2b364f8bac0b82ce483d3115db45ef71a3cbc445d4d6efb2963e4c5; _dx_app_43768f2ab87180b2cbe718f62d4bc5fa=60efb2d5f7t3ngBT2eovAqJ7I44JeuwOrWWfNoI1; _dx_captcha_vid=17AADEB152543768F2AB86A51732DAB534ED98317126251AEA23A^%^40bj; adstk=04f89b3ea43b6989dd1f96b883adc6fd; oadsk=8b26213c8c5b49898ee46307067a04fd; JSESSIONID=392bb473b8f64a92bf4f8bf0e7651a5b; WEBTOKEN=eyJhbGciOiJIUzUxMiIsInppcCI6IkRFRiJ9.eNqqViouTVKyUjI0AAJjS0MTcyUdpdSKAiUrQzMjMxMjI3MD41oAAAAA__8.OOrsZcKV3hPT4qElDDAnMBPPJu1oF9XYKkfQg5xtgaGkH0kznsaSuU7h2yuAQG00Lg2z7yih3ezh5_a4T_yTFw; login-access-id=1000039147" ^
  --data-raw "page=1&pageCount=20&ownerId=1000039147" ^
  --compressed

返回：{"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 获取当前流量场景下每个规格所需的元素配置（必须，重要！！！）
curl "https://e.heytap.com/v3/communal/spec/list" ^
  -H "authority: e.heytap.com" ^
  -H "sec-ch-ua: ^^" Not;A Brand^^";v=^^"99^^", ^^"Google Chrome^^";v=^^"91^^", ^^"Chromium^^";v=^^"91^^"" ^
  -H "accept: application/json, text/plain, /" ^
  -H "sec-ch-ua-mobile: ?0" ^
  -H "tk: 04f89b3ea43b6989dd1f96b883adc6fd" ^
  -H "user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" ^
  -H "content-type: application/x-www-form-urlencoded" ^
  -H "origin: https://e.heytap.com" ^
  -H "sec-fetch-site: same-origin" ^
  -H "sec-fetch-mode: cors" ^
  -H "sec-fetch-dest: empty" ^
  -H "referer: https://e.heytap.com/markets/creative/create?type=create&level=plan" ^
  -H "accept-language: zh-CN,zh;q=0.9" ^
  -H "cookie: _dx_uzZo5y=f06782e4f086b5fba2b364f8bac0b82ce483d3115db45ef71a3cbc445d4d6efb2963e4c5; _dx_app_43768f2ab87180b2cbe718f62d4bc5fa=60efb2d5f7t3ngBT2eovAqJ7I44JeuwOrWWfNoI1; _dx_captcha_vid=17AADEB152543768F2AB86A51732DAB534ED98317126251AEA23A^%^40bj; adstk=04f89b3ea43b6989dd1f96b883adc6fd; oadsk=8b26213c8c5b49898ee46307067a04fd; JSESSIONID=392bb473b8f64a92bf4f8bf0e7651a5b; WEBTOKEN=eyJhbGciOiJIUzUxMiIsInppcCI6IkRFRiJ9.eNqqViouTVKyUjI0AAJjS0MTcyUdpdSKAiUrQzMjMxMjI3MD41oAAAAA__8.OOrsZcKV3hPT4qElDDAnMBPPJu1oF9XYKkfQg5xtgaGkH0kznsaSuU7h2yuAQG00Lg2z7yih3ezh5_a4T_yTFw; login-access-id=1000039147" ^
  --data-raw "flowScene=6&extensionType=1&extensionFlow=2" ^
  --compressed

返回：
{"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\]\(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\]\(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\]\(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\]\(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}"}]}

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

6 素材上传（可选）
curl "https://e.heytap.com/v3/creative/material/communal/upload" ^
  -H "authority: e.heytap.com" ^
  -H "sec-ch-ua: ^^" Not;A Brand^^";v=^^"99^^", ^^"Google Chrome^^";v=^^"91^^", ^^"Chromium^^";v=^^"91^^"" ^
  -H "sec-ch-ua-mobile: ?0" ^
  -H "tk: 04f89b3ea43b6989dd1f96b883adc6fd" ^
  -H "user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" ^
  -H "content-type: multipart/form-data; boundary=----WebKitFormBoundary5YH7rugskQjuFFTg" ^
  -H "accept: /" ^
  -H "origin: https://e.heytap.com" ^
  -H "sec-fetch-site: same-origin" ^
  -H "sec-fetch-mode: cors" ^
  -H "sec-fetch-dest: empty" ^
  -H "referer: https://e.heytap.com/markets/creative/create?type=create&level=plan" ^
  -H "accept-language: zh-CN,zh;q=0.9" ^
  -H "cookie: _dx_uzZo5y=f06782e4f086b5fba2b364f8bac0b82ce483d3115db45ef71a3cbc445d4d6efb2963e4c5; _dx_app_43768f2ab87180b2cbe718f62d4bc5fa=60efb2d5f7t3ngBT2eovAqJ7I44JeuwOrWWfNoI1; _dx_captcha_vid=17AADEB152543768F2AB86A51732DAB534ED98317126251AEA23A^%^40bj; adstk=04f89b3ea43b6989dd1f96b883adc6fd; oadsk=8b26213c8c5b49898ee46307067a04fd; JSESSIONID=392bb473b8f64a92bf4f8bf0e7651a5b; WEBTOKEN=eyJhbGciOiJIUzUxMiIsInppcCI6IkRFRiJ9.eNqqViouTVKyUjI0AAJjS0MTcyUdpdSKAiUrQzMjMxMjI3MD41oAAAAA__8.OOrsZcKV3hPT4qElDDAnMBPPJu1oF9XYKkfQg5xtgaGkH0kznsaSuU7h2yuAQG00Lg2z7yih3ezh5_a4T_yTFw; login-access-id=1000039147" ^
  --data-raw ^"------WebKitFormBoundary5YH7rugskQjuFFTg^

Content-Disposition: form-data; name=^^"file^^"; filename=^^"rrrrz.jpg^^"^

Content-Type: image/jpeg^

7 查询素材中心素材（可选）
curl "https://e.heytap.com/creative/material/image/getList?nameOrID=&size=102400&dimension=200^%^2A200&page=1&pageSize=10&suffixes=jpg&suffixes=png&suffixes=jpeg" ^
  -H "authority: e.heytap.com" ^
  -H "sec-ch-ua: ^^" Not;A Brand^^";v=^^"99^^", ^^"Google Chrome^^";v=^^"91^^", ^^"Chromium^^";v=^^"91^^"" ^
  -H "accept: application/json, text/plain, /" ^
  -H "sec-ch-ua-mobile: ?0" ^
  -H "tk: 04f89b3ea43b6989dd1f96b883adc6fd" ^
  -H "user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" ^
  -H "content-type: application/x-www-form-urlencoded" ^
  -H "sec-fetch-site: same-origin" ^
  -H "sec-fetch-mode: cors" ^
  -H "sec-fetch-dest: empty" ^
  -H "referer: https://e.heytap.com/markets/creative/create?type=create&level=plan" ^
  -H "accept-language: zh-CN,zh;q=0.9" ^
  -H "cookie: _dx_uzZo5y=f06782e4f086b5fba2b364f8bac0b82ce483d3115db45ef71a3cbc445d4d6efb2963e4c5; _dx_app_43768f2ab87180b2cbe718f62d4bc5fa=60efb2d5f7t3ngBT2eovAqJ7I44JeuwOrWWfNoI1; _dx_captcha_vid=17AADEB152543768F2AB86A51732DAB534ED98317126251AEA23A^%^40bj; adstk=04f89b3ea43b6989dd1f96b883adc6fd; oadsk=8b26213c8c5b49898ee46307067a04fd; JSESSIONID=392bb473b8f64a92bf4f8bf0e7651a5b; WEBTOKEN=eyJhbGciOiJIUzUxMiIsInppcCI6IkRFRiJ9.eNqqViouTVKyUjI0AAJjS0MTcyUdpdSKAiUrQzMjMxMjI3MD41oAAAAA__8.OOrsZcKV3hPT4qElDDAnMBPPJu1oF9XYKkfQg5xtgaGkH0kznsaSuU7h2yuAQG00Lg2z7yih3ezh5_a4T_yTFw; login-access-id=1000039147" ^
  --compressed

详细传参：
size: 153600
dimension: 1280*720
page: 1
pageSize: 10
suffixes: png
suffixes: jpg
suffixes: jpeg

返回：
{"code":0,"data":{"totalCount":2,"itemCount":2,"items":[{"id":39108003,"ownerId":1000039147,"openMaterialId":"fb0734b9b8f169a71b8400d73123ef82","materialName":"rBAoMGCE0NmAORuAAAACYkvAl40197.png","materialUrl":"https://adsfs.heytapimage.com/ads-material-depot/image/8af3ea946324e8d9144ca6a09b5282a2.png","coverUrl":"","width":200,"height":200,"type":1,"suffix":"png","uploadWay":1,"size":610,"duration":0,"md5":"fb0734b9b8f169a71b8400d73123ef82","extJson":"","insertTime":1619316981,"updateTime":0,"deleteFlag":0,"webpMd5":"","webpMUrl":null,"compressedUrl":"","compressedMd5":"","compressedSize":0},{"id":38704057,"ownerId":1000039147,"openMaterialId":"84ef9d6c03c0377bb1d6f003e92e199d","materialName":"997187.jpg","materialUrl":"https://adsfs.heytapimage.com/ads-material-depot/image/06beaff00ca93854ba1eb77628a3ec02.jpg","coverUrl":"","width":200,"height":200,"type":1,"suffix":"jpg","uploadWay":1,"size":8189,"duration":0,"md5":"84ef9d6c03c0377bb1d6f003e92e199d","extJson":"","insertTime":1619081088,"updateTime":0,"deleteFlag":0,"webpMd5":"","webpMUrl":null,"compressedUrl":"","compressedMd5":"","compressedSize":0}]}}

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

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

8 创建广告创意

下面例子同时创建两个竖版大图创意，以及一个横版视频创意。
curl "https://e.heytap.com/v3/ad/batch" ^
  -H "authority: e.heytap.com" ^
  -H "sec-ch-ua: ^^" Not;A Brand^^";v=^^"99^^", ^^"Google Chrome^^";v=^^"91^^", ^^"Chromium^^";v=^^"91^^"" ^
  -H "accept: application/json, text/plain, /" ^
  -H "sec-ch-ua-mobile: ?0" ^
  -H "tk: 04f89b3ea43b6989dd1f96b883adc6fd" ^
  -H "user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" ^
  -H "content-type: application/x-www-form-urlencoded" ^
  -H "origin: https://e.heytap.com" ^
  -H "sec-fetch-site: same-origin" ^
  -H "sec-fetch-mode: cors" ^
  -H "sec-fetch-dest: empty" ^
  -H "referer: https://e.heytap.com/markets/creative/create?type=create&level=plan" ^
  -H "accept-language: zh-CN,zh;q=0.9" ^
  -H "cookie: _dx_uzZo5y=f06782e4f086b5fba2b364f8bac0b82ce483d3115db45ef71a3cbc445d4d6efb2963e4c5; _dx_app_43768f2ab87180b2cbe718f62d4bc5fa=60efb2d5f7t3ngBT2eovAqJ7I44JeuwOrWWfNoI1; _dx_captcha_vid=17AADEB152543768F2AB86A51732DAB534ED98317126251AEA23A^%^40bj; adstk=04f89b3ea43b6989dd1f96b883adc6fd; oadsk=8b26213c8c5b49898ee46307067a04fd; JSESSIONID=392bb473b8f64a92bf4f8bf0e7651a5b; WEBTOKEN=eyJhbGciOiJIUzUxMiIsInppcCI6IkRFRiJ9.eNqqViouTVKyUjI0AAJjS0MTcyUdpdSKAiUrQzMjMxMjI3MD41oAAAAA__8.OOrsZcKV3hPT4qElDDAnMBPPJu1oF9XYKkfQg5xtgaGkH0kznsaSuU7h2yuAQG00Lg2z7yih3ezh5_a4T_yTFw; login-access-id=1000039147" ^
  --data-raw "addList^%^5B0^%^5D.adGroupId=300026777&addList^%^5B0^%^5D.adName=^%^E7^%^BD^%^91^%^E9^%^A1^%^B5^%^E6^%^8E^%^A8^%^E5^%^B9^%^BF_^%^E4^%^BF^%^A1^%^E6^%^81^%^AF^%^E6^%^B5^%^81_^%^E7^%^AB^%^96^%^E7^%^89^%^88^%^E5^%^A4^%^A7^%^E5^%^9B^%^BE_^%^E5^%^88^%^9B^%^E6^%^84^%^8F1_2021^%^2F07^%^2F16_14^%^3A16^%^3A52&addList^%^5B0^%^5D.adPlanId=200013226&addList^%^5B0^%^5D.adSource=1&addList^%^5B0^%^5D.brandLogoImgId=38704057&addList^%^5B0^%^5D.brandName=^%^E8^%^AB^%^B7^%^E5^%^BE^%^B7^%^E8^%^AA^%^A6^%^E5^%^8A^%^9F&addList^%^5B0^%^5D.buttonTxt=&addList^%^5B0^%^5D.copywriter=fodlord^%^E5^%^BD^%^B1^%^E9^%^99^%^A2^%^E3^%^80^%^81gps^%^E3^%^80^%^81gf^%^E6^%^89^%^8B^%^E6^%^9C^%^BA^%^E7^%^AD^%^89^%^E9^%^83^%^BD^%^E5^%^8F^%^AF^%^E4^%^BB^%^A5^%^EF^%^BC^%^81&addList^%^5B0^%^5D.copywriterId=275876&addList^%^5B0^%^5D.industryId=null&addList^%^5B0^%^5D.globalSpecId=50&addList^%^5B0^%^5D.videoBgImgId=&addList^%^5B0^%^5D.videoImgId=&addList^%^5B0^%^5D.imgMatIds=43449718&addList^%^5B0^%^5D.exposeUrl=&addList^%^5B0^%^5D.clickUrl=&addList^%^5B0^%^5D.downloadUrl=&addList^%^5B1^%^5D.adGroupId=300026777&addList^%^5B1^%^5D.adName=^%^E7^%^BD^%^91^%^E9^%^A1^%^B5^%^E6^%^8E^%^A8^%^E5^%^B9^%^BF_^%^E4^%^BF^%^A1^%^E6^%^81^%^AF^%^E6^%^B5^%^81_^%^E7^%^AB^%^96^%^E7^%^89^%^88^%^E5^%^A4^%^A7^%^E5^%^9B^%^BE_^%^E5^%^88^%^9B^%^E6^%^84^%^8F2_2021^%^2F07^%^2F16_14^%^3A16^%^3A52&addList^%^5B1^%^5D.adPlanId=200013226&addList^%^5B1^%^5D.adSource=1&addList^%^5B1^%^5D.brandLogoImgId=38704057&addList^%^5B1^%^5D.brandName=^%^E6^%^89^%^8B^%^E5^%^8A^%^A8^%^E9^%^98^%^80&addList^%^5B1^%^5D.buttonTxt=&addList^%^5B1^%^5D.copywriter=^%^E7^%^AC^%^AC^%^E4^%^B8^%^89^%^E6^%^96^%^B9&addList^%^5B1^%^5D.copywriterId=275972&addList^%^5B1^%^5D.industryId=null&addList^%^5B1^%^5D.globalSpecId=50&addList^%^5B1^%^5D.videoBgImgId=&addList^%^5B1^%^5D.videoImgId=&addList^%^5B1^%^5D.imgMatIds=43449718&addList^%^5B1^%^5D.exposeUrl=&addList^%^5B1^%^5D.clickUrl=&addList^%^5B1^%^5D.downloadUrl=&addList^%^5B2^%^5D.adGroupId=300026777&addList^%^5B2^%^5D.adName=^%^E7^%^BD^%^91^%^E9^%^A1^%^B5^%^E6^%^8E^%^A8^%^E5^%^B9^%^BF_^%^E4^%^BF^%^A1^%^E6^%^81^%^AF^%^E6^%^B5^%^81_^%^E6^%^A8^%^AA^%^E7^%^89^%^88^%^E8^%^A7^%^86^%^E9^%^A2^%^91_^%^E5^%^88^%^9B^%^E6^%^84^%^8F1_2021^%^2F07^%^2F16_14^%^3A16^%^3A52&addList^%^5B2^%^5D.adPlanId=200013226&addList^%^5B2^%^5D.adSource=1&addList^%^5B2^%^5D.brandLogoImgId=38704057&addList^%^5B2^%^5D.brandName=^%^E6^%^89^%^8B^%^E5^%^8A^%^A8^%^E9^%^98^%^80&addList^%^5B2^%^5D.buttonTxt=&addList^%^5B2^%^5D.copywriter=^%^E5^%^8F^%^8C^%^E6^%^96^%^B9^%^E9^%^83^%^BD&addList^%^5B2^%^5D.copywriterId=275973&addList^%^5B2^%^5D.industryId=null&addList^%^5B2^%^5D.globalSpecId=60&addList^%^5B2^%^5D.videoBgImgId=&addList^%^5B2^%^5D.videoImgId=39107956&addList^%^5B2^%^5D.videoMatIds=38703350&addList^%^5B2^%^5D.exposeUrl=&addList^%^5B2^%^5D.clickUrl=&addList^%^5B2^%^5D.playBeginUrl=&addList^%^5B2^%^5D.playEndUrl=&addList^%^5B2^%^5D.downloadUrl=" ^
  --compressed

详细传参：
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:

2.4 创意-编辑广告创意

基本信息

Path： /5

Method： HEAD

接口描述：

1 首先查询当前广告组下面的所有广告创意列表
curl "https://e.heytap.com/v3/ad/list" ^
  -H "authority: e.heytap.com" ^
  -H "sec-ch-ua: ^^" Not;A Brand^^";v=^^"99^^", ^^"Google Chrome^^";v=^^"91^^", ^^"Chromium^^";v=^^"91^^"" ^
  -H "accept: application/json, text/plain, /" ^
  -H "sec-ch-ua-mobile: ?0" ^
  -H "tk: 04f89b3ea43b6989dd1f96b883adc6fd" ^
  -H "user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" ^
  -H "content-type: application/x-www-form-urlencoded" ^
  -H "origin: https://e.heytap.com" ^
  -H "sec-fetch-site: same-origin" ^
  -H "sec-fetch-mode: cors" ^
  -H "sec-fetch-dest: empty" ^
  -H "referer: https://e.heytap.com/markets/creative/create?type=edit&level=creative&groupId=300026777&adId=400080301" ^
  -H "accept-language: zh-CN,zh;q=0.9" ^
  -H "cookie: _dx_uzZo5y=f06782e4f086b5fba2b364f8bac0b82ce483d3115db45ef71a3cbc445d4d6efb2963e4c5; _dx_app_43768f2ab87180b2cbe718f62d4bc5fa=60efb2d5f7t3ngBT2eovAqJ7I44JeuwOrWWfNoI1; _dx_captcha_vid=17AADEB152543768F2AB86A51732DAB534ED98317126251AEA23A^%^40bj; adstk=04f89b3ea43b6989dd1f96b883adc6fd; oadsk=8b26213c8c5b49898ee46307067a04fd; JSESSIONID=392bb473b8f64a92bf4f8bf0e7651a5b; WEBTOKEN=eyJhbGciOiJIUzUxMiIsInppcCI6IkRFRiJ9.eNqqViouTVKyUjI0AAJjS0MTcyUdpdSKAiUrQzMjMxMjI3MD41oAAAAA__8.OOrsZcKV3hPT4qElDDAnMBPPJu1oF9XYKkfQg5xtgaGkH0kznsaSuU7h2yuAQG00Lg2z7yih3ezh5_a4T_yTFw; login-access-id=1000039147" ^
  --data-raw "adGroupId=300026777" ^
  --compressed

返回：
{"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","mid":43449718}\],"brandLogoImg":{"materialUrl":"https://adsfs.heytapimage.com/ads-material-depot/image/06beaff00ca93854ba1eb77628a3ec02.jpg","mid":38704057},"exposeUrl":"","clickUrl":"","playBeginUrl":"","playEndUrl":"","downloadUrl":""},{"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","mid":38703350}\],"brandLogoImg":{"materialUrl":"https://adsfs.heytapimage.com/ads-material-depot/image/06beaff00ca93854ba1eb77628a3ec02.jpg","mid":38704057},"videoImg":{"materialUrl":"https://adsfs.heytapimage.com/ads-material-depot/image/a12f5e677eaeaafcd292fa58570ca5f1.jpg","mid":39107956},"exposeUrl":"","clickUrl":"","playBeginUrl":"","playEndUrl":"","downloadUrl":""},{"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","mid":29519483}\],"brandLogoImg":{"materialUrl":"https://adsfs.heytapimage.com/ads-material-depot/image/06beaff00ca93854ba1eb77628a3ec02.jpg","mid":38704057},"exposeUrl":"","clickUrl":"","playBeginUrl":"","playEndUrl":"","downloadUrl](https://adsfs.heytapimage.com/ads-material-depot/image/538884a95dd9376a90cd00b9ea560c0d.jpg","mid":43449718}],"brandLogoImg":{"materialUrl":"https://adsfs.heytapimage.com/ads-material-depot/image/06beaff00ca93854ba1eb77628a3ec02.jpg","mid":38704057},"exposeUrl":"","clickUrl":"","playBeginUrl":"","playEndUrl":"","downloadUrl":""},{"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","mid":38703350}],"brandLogoImg":{"materialUrl":"https://adsfs.heytapimage.com/ads-material-depot/image/06beaff00ca93854ba1eb77628a3ec02.jpg","mid":38704057},"videoImg":{"materialUrl":"https://adsfs.heytapimage.com/ads-material-depot/image/a12f5e677eaeaafcd292fa58570ca5f1.jpg","mid":39107956},"exposeUrl":"","clickUrl":"","playBeginUrl":"","playEndUrl":"","downloadUrl":""},{"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","mid":29519483}],"brandLogoImg":{"materialUrl":"https://adsfs.heytapimage.com/ads-material-depot/image/06beaff00ca93854ba1eb77628a3ec02.jpg","mid":38704057},"exposeUrl":"","clickUrl":"","playBeginUrl":"","playEndUrl":"","downloadUrl)":""}]}

2 编辑广告创意
备注：这是一个批量接口，可以批量操作同一个广告组下面的广告创意，包含新增/编辑/删除等操作，可以同时进行。
下面基于原有的广告组下面的创意的基础上，添加一个创意，并删除一个创意：
curl "https://e.heytap.com/v3/ad/batch" ^
  -H "authority: e.heytap.com" ^
  -H "sec-ch-ua: ^^" Not;A Brand^^";v=^^"99^^", ^^"Google Chrome^^";v=^^"91^^", ^^"Chromium^^";v=^^"91^^"" ^
  -H "accept: application/json, text/plain, /" ^
  -H "sec-ch-ua-mobile: ?0" ^
  -H "tk: 04f89b3ea43b6989dd1f96b883adc6fd" ^
  -H "user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" ^
  -H "content-type: application/x-www-form-urlencoded" ^
  -H "origin: https://e.heytap.com" ^
  -H "sec-fetch-site: same-origin" ^
  -H "sec-fetch-mode: cors" ^
  -H "sec-fetch-dest: empty" ^
  -H "referer: https://e.heytap.com/markets/creative/create?type=edit&level=creative&groupId=300026777&adId=400080301" ^
  -H "accept-language: zh-CN,zh;q=0.9" ^
  -H "cookie: _dx_uzZo5y=f06782e4f086b5fba2b364f8bac0b82ce483d3115db45ef71a3cbc445d4d6efb2963e4c5; _dx_app_43768f2ab87180b2cbe718f62d4bc5fa=60efb2d5f7t3ngBT2eovAqJ7I44JeuwOrWWfNoI1; _dx_captcha_vid=17AADEB152543768F2AB86A51732DAB534ED98317126251AEA23A^%^40bj; adstk=04f89b3ea43b6989dd1f96b883adc6fd; oadsk=8b26213c8c5b49898ee46307067a04fd; JSESSIONID=392bb473b8f64a92bf4f8bf0e7651a5b; WEBTOKEN=eyJhbGciOiJIUzUxMiIsInppcCI6IkRFRiJ9.eNqqViouTVKyUjI0AAJjS0MTcyUdpdSKAiUrQzMjMxMjI3MD41oAAAAA__8.OOrsZcKV3hPT4qElDDAnMBPPJu1oF9XYKkfQg5xtgaGkH0kznsaSuU7h2yuAQG00Lg2z7yih3ezh5_a4T_yTFw; login-access-id=1000039147" ^
  --data-raw "addList^%^5B0^%^5D.adGroupId=300026777&addList^%^5B0^%^5D.adName=^%^E7^%^BD^%^91^%^E9^%^A1^%^B5^%^E6^%^8E^%^A8^%^E5^%^B9^%^BF_^%^E4^%^BF^%^A1^%^E6^%^81^%^AF^%^E6^%^B5^%^81_^%^E6^%^A8^%^AA^%^E7^%^89^%^88^%^E5^%^B0^%^8F^%^E5^%^9B^%^BE_^%^E5^%^88^%^9B^%^E6^%^84^%^8F1_2021^%^2F07^%^2F16_14^%^3A37^%^3A27&addList^%^5B0^%^5D.adPlanId=200013226&addList^%^5B0^%^5D.adSource=1&addList^%^5B0^%^5D.brandLogoImgId=38704057&addList^%^5B0^%^5D.brandName=^%^E6^%^89^%^8B^%^E5^%^8A^%^A8^%^E9^%^98^%^80&addList^%^5B0^%^5D.buttonTxt=&addList^%^5B0^%^5D.copywriter=^%^E8^%^BF^%^99^%^E6^%^89^%^8D^%^E6^%^98^%^AF^%^E4^%^BB^%^99^%^E4^%^BE^%^A0^%^E6^%^89^%^8B^%^E6^%^B8^%^B8^%^EF^%^BC^%^8C^%^E8^%^A3^%^85^%^E5^%^A4^%^87^%^E5^%^85^%^A8^%^E9^%^9D^%^A0^%^E6^%^89^%^93^%^EF^%^BC^%^8C^%^E5^%^9D^%^90^%^E9^%^AA^%^91^%^E5^%^85^%^A8^%^E9^%^9D^%^A0^%^E6^%^8A^%^93&addList^%^5B0^%^5D.copywriterId=276198&addList^%^5B0^%^5D.industryId=null&addList^%^5B0^%^5D.globalSpecId=20&addList^%^5B0^%^5D.videoBgImgId=&addList^%^5B0^%^5D.videoImgId=&addList^%^5B0^%^5D.imgMatIds=29519483&addList^%^5B0^%^5D.exposeUrl=&addList^%^5B0^%^5D.clickUrl=&addList^%^5B0^%^5D.downloadUrl=&editList^%^5B0^%^5D.adGroupId=300026777&editList^%^5B0^%^5D.adName=^%^E7^%^BD^%^91^%^E9^%^A1^%^B5^%^E6^%^8E^%^A8^%^E5^%^B9^%^BF_^%^E4^%^BF^%^A1^%^E6^%^81^%^AF^%^E6^%^B5^%^81_^%^E7^%^AB^%^96^%^E7^%^89^%^88^%^E5^%^A4^%^A7^%^E5^%^9B^%^BE_^%^E5^%^88^%^9B^%^E6^%^84^%^8F1_2021^%^2F07^%^2F16_14^%^3A16^%^3A52&editList^%^5B0^%^5D.adPlanId=200013226&editList^%^5B0^%^5D.adSource=1&editList^%^5B0^%^5D.brandLogoImgId=38704057&editList^%^5B0^%^5D.brandName=^%^E8^%^AB^%^B7^%^E5^%^BE^%^B7^%^E8^%^AA^%^A6^%^E5^%^8A^%^9F&editList^%^5B0^%^5D.buttonTxt=&editList^%^5B0^%^5D.copywriter=fodlord^%^E5^%^BD^%^B1^%^E9^%^99^%^A2^%^E3^%^80^%^81gps^%^E3^%^80^%^81gf^%^E6^%^89^%^8B^%^E6^%^9C^%^BA^%^E7^%^AD^%^89^%^E9^%^83^%^BD^%^E5^%^8F^%^AF^%^E4^%^BB^%^A5^%^EF^%^BC^%^81&editList^%^5B0^%^5D.copywriterId=275876&editList^%^5B0^%^5D.industryId=null&editList^%^5B0^%^5D.globalSpecId=50&editList^%^5B0^%^5D.videoBgImgId=&editList^%^5B0^%^5D.videoImgId=&editList^%^5B0^%^5D.imgMatIds=43449718&editList^%^5B0^%^5D.adId=400080299&editList^%^5B0^%^5D.exposeUrl=&editList^%^5B0^%^5D.clickUrl=&editList^%^5B0^%^5D.downloadUrl=&editList^%^5B1^%^5D.adGroupId=300026777&editList^%^5B1^%^5D.adName=^%^E7^%^BD^%^91^%^E9^%^A1^%^B5^%^E6^%^8E^%^A8^%^E5^%^B9^%^BF_^%^E4^%^BF^%^A1^%^E6^%^81^%^AF^%^E6^%^B5^%^81_^%^E6^%^A8^%^AA^%^E7^%^89^%^88^%^E8^%^A7^%^86^%^E9^%^A2^%^91_^%^E5^%^88^%^9B^%^E6^%^84^%^8F1_2021^%^2F07^%^2F16_14^%^3A16^%^3A52&editList^%^5B1^%^5D.adPlanId=200013226&editList^%^5B1^%^5D.adSource=1&editList^%^5B1^%^5D.brandLogoImgId=38704057&editList^%^5B1^%^5D.brandName=^%^E6^%^89^%^8B^%^E5^%^8A^%^A8^%^E9^%^98^%^80&editList^%^5B1^%^5D.buttonTxt=&editList^%^5B1^%^5D.copywriter=^%^E5^%^8F^%^8C^%^E6^%^96^%^B9^%^E9^%^83^%^BD&editList^%^5B1^%^5D.copywriterId=275973&editList^%^5B1^%^5D.industryId=null&editList^%^5B1^%^5D.globalSpecId=60&editList^%^5B1^%^5D.videoBgImgId=&editList^%^5B1^%^5D.videoImgId=39107956&editList^%^5B1^%^5D.videoMatIds=38703350&editList^%^5B1^%^5D.adId=400080301&editList^%^5B1^%^5D.exposeUrl=&editList^%^5B1^%^5D.clickUrl=&editList^%^5B1^%^5D.playBeginUrl=&editList^%^5B1^%^5D.playEndUrl=&editList^%^5B1^%^5D.downloadUrl=&delList^%^5B0^%^5D.adGroupId=300026777&delList^%^5B0^%^5D.adId=400080300" ^
  --compressed

详细参数：
addList[0].adGroupId: 300026777
addList[0].adName: 网页推广_信息流_横版小图_创意1_2021/07/16_14:37:27
addList[0].adPlanId: 200013226
addList[0].adSource: 1
addList[0].brandLogoImgId: 38704057
addList[0].brandName: 手动阀
addList[0].buttonTxt:
addList[0].copywriter: 这才是仙侠手游，装备全靠打，坐骑全靠抓
addList[0].copywriterId: 276198
addList[0].industryId: null
addList[0].globalSpecId: 20
addList[0].videoBgImgId:
addList[0].videoImgId:
addList[0].imgMatIds: 29519483
addList[0].exposeUrl:
addList[0].clickUrl:
addList[0].downloadUrl:
editList[0].adGroupId: 300026777
editList[0].adName: 网页推广_信息流_竖版大图_创意1_2021/07/16_14:16:52
editList[0].adPlanId: 200013226
editList[0].adSource: 1
editList[0].brandLogoImgId: 38704057
editList[0].brandName: 諷德誦功
editList[0].buttonTxt:
editList[0].copywriter: fodlord影院、gps、gf手机等都可以！
editList[0].copywriterId: 275876
editList[0].industryId: null
editList[0].globalSpecId: 50
editList[0].videoBgImgId:
editList[0].videoImgId:
editList[0].imgMatIds: 43449718
editList[0].adId: 400080299
editList[0].exposeUrl:
editList[0].clickUrl:
editList[0].downloadUrl:
editList[1].adGroupId: 300026777
editList[1].adName: 网页推广_信息流_横版视频_创意1_2021/07/16_14:16:52
editList[1].adPlanId: 200013226
editList[1].adSource: 1
editList[1].brandLogoImgId: 38704057
editList[1].brandName: 手动阀
editList[1].buttonTxt:
editList[1].copywriter: 双方都
editList[1].copywriterId: 275973
editList[1].industryId: null
editList[1].globalSpecId: 60
editList[1].videoBgImgId:
editList[1].videoImgId: 39107956
editList[1].videoMatIds: 38703350
editList[1].adId: 400080301
editList[1].exposeUrl:
editList[1].clickUrl:
editList[1].playBeginUrl:
editList[1].playEndUrl:
editList[1].downloadUrl:
delList[0].adGroupId: 300026777
delList[0].adId: 400080300

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

基本信息

Path： /4

Method： HEAD

接口描述：

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

1 获取推广目的
curl "https://e.heytap.com/v3/communal/config/getList" ^
  -H "authority: e.heytap.com" ^
  -H "sec-ch-ua: ^^" Not;A Brand^^";v=^^"99^^", ^^"Google Chrome^^";v=^^"91^^", ^^"Chromium^^";v=^^"91^^"" ^
  -H "accept: application/json, text/plain, /" ^
  -H "sec-ch-ua-mobile: ?0" ^
  -H "tk: 0f85c3b8f9eeabcb1139c35b24a34ba8" ^
  -H "user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" ^
  -H "content-type: application/x-www-form-urlencoded" ^
  -H "origin: https://e.heytap.com" ^
  -H "sec-fetch-site: same-origin" ^
  -H "sec-fetch-mode: cors" ^
  -H "sec-fetch-dest: empty" ^
  -H "referer: https://e.heytap.com/markets/creative/create?type=create&level=plan" ^
  -H "accept-language: zh-CN,zh;q=0.9" ^
  -H "cookie: _dx_uzZo5y=f06782e4f086b5fba2b364f8bac0b82ce483d3115db45ef71a3cbc445d4d6efb2963e4c5; _dx_app_43768f2ab87180b2cbe718f62d4bc5fa=60efb2d5f7t3ngBT2eovAqJ7I44JeuwOrWWfNoI1; login-access-id=1000039147; _dx_captcha_vid=17AAA0A572A43768F2AB89FEC9DD2554F4CC6B3CDE738E99EB3AC^%^40bj; adstk=0f85c3b8f9eeabcb1139c35b24a34ba8; oadsk=c4ad011a83114968b65804ce3eab263b; JSESSIONID=3f3d57f6151440938521460d9919943d; WEBTOKEN=eyJhbGciOiJIUzUxMiIsInppcCI6IkRFRiJ9.eNqqViouTVKyUjI0AAJjS0MTcyUdpdSKAiUrQzMjM2NTczMTo1oAAAAA__8.yvzTWukhhHDxKxqkRbT9z0tkw6nJ3RXcwS-rg2uHSsqB5wsPuVT6B4Camt-YeS51a2RG428M79eB15jEIgotAQ" ^
  --data-raw "type=EXTENSION_TYPE" ^
  --compressed

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

2 获取推广目的下支持的推广流程
curl "https://e.heytap.com/v3/communal/config/getList" ^
  -H "authority: e.heytap.com" ^
  -H "sec-ch-ua: ^^" Not;A Brand^^";v=^^"99^^", ^^"Google Chrome^^";v=^^"91^^", ^^"Chromium^^";v=^^"91^^"" ^
  -H "accept: application/json, text/plain, /" ^
  -H "sec-ch-ua-mobile: ?0" ^
  -H "tk: 0f85c3b8f9eeabcb1139c35b24a34ba8" ^
  -H "user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" ^
  -H "content-type: application/x-www-form-urlencoded" ^
  -H "origin: https://e.heytap.com" ^
  -H "sec-fetch-site: same-origin" ^
  -H "sec-fetch-mode: cors" ^
  -H "sec-fetch-dest: empty" ^
  -H "referer: https://e.heytap.com/markets/creative/create?type=create&level=plan" ^
  -H "accept-language: zh-CN,zh;q=0.9" ^
  -H "cookie: _dx_uzZo5y=f06782e4f086b5fba2b364f8bac0b82ce483d3115db45ef71a3cbc445d4d6efb2963e4c5; _dx_app_43768f2ab87180b2cbe718f62d4bc5fa=60efb2d5f7t3ngBT2eovAqJ7I44JeuwOrWWfNoI1; login-access-id=1000039147; _dx_captcha_vid=17AAA0A572A43768F2AB89FEC9DD2554F4CC6B3CDE738E99EB3AC^%^40bj; adstk=0f85c3b8f9eeabcb1139c35b24a34ba8; oadsk=c4ad011a83114968b65804ce3eab263b; JSESSIONID=3f3d57f6151440938521460d9919943d; WEBTOKEN=eyJhbGciOiJIUzUxMiIsInppcCI6IkRFRiJ9.eNqqViouTVKyUjI0AAJjS0MTcyUdpdSKAiUrQzMjM2NTczMTo1oAAAAA__8.yvzTWukhhHDxKxqkRbT9z0tkw6nJ3RXcwS-rg2uHSsqB5wsPuVT6B4Camt-YeS51a2RG428M79eB15jEIgotAQ" ^
  --data-raw "type=EXTENSION_FLOW&extensionType=1" ^
  --compressed

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

3 获取推广目的+推广流量下对应的流量场景：
curl "https://e.heytap.com/v3/communal/config/getList" ^
  -H "authority: e.heytap.com" ^
  -H "sec-ch-ua: ^^" Not;A Brand^^";v=^^"99^^", ^^"Google Chrome^^";v=^^"91^^", ^^"Chromium^^";v=^^"91^^"" ^
  -H "accept: application/json, text/plain, /" ^
  -H "sec-ch-ua-mobile: ?0" ^
  -H "tk: 0f85c3b8f9eeabcb1139c35b24a34ba8" ^
  -H "user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" ^
  -H "content-type: application/x-www-form-urlencoded" ^
  -H "origin: https://e.heytap.com" ^
  -H "sec-fetch-site: same-origin" ^
  -H "sec-fetch-mode: cors" ^
  -H "sec-fetch-dest: empty" ^
  -H "referer: https://e.heytap.com/markets/creative/create?type=create&level=plan" ^
  -H "accept-language: zh-CN,zh;q=0.9" ^
  -H "cookie: _dx_uzZo5y=f06782e4f086b5fba2b364f8bac0b82ce483d3115db45ef71a3cbc445d4d6efb2963e4c5; _dx_app_43768f2ab87180b2cbe718f62d4bc5fa=60efb2d5f7t3ngBT2eovAqJ7I44JeuwOrWWfNoI1; login-access-id=1000039147; _dx_captcha_vid=17AAA0A572A43768F2AB89FEC9DD2554F4CC6B3CDE738E99EB3AC^%^40bj; adstk=0f85c3b8f9eeabcb1139c35b24a34ba8; oadsk=c4ad011a83114968b65804ce3eab263b; JSESSIONID=3f3d57f6151440938521460d9919943d; WEBTOKEN=eyJhbGciOiJIUzUxMiIsInppcCI6IkRFRiJ9.eNqqViouTVKyUjI0AAJjS0MTcyUdpdSKAiUrQzMjM2NTczMTo1oAAAAA__8.yvzTWukhhHDxKxqkRbT9z0tkw6nJ3RXcwS-rg2uHSsqB5wsPuVT6B4Camt-YeS51a2RG428M79eB15jEIgotAQ" ^
  --data-raw "type=FLOW_SCENE&extensionType=1&extensionFlow=2" ^
  --compressed

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

4 获取流量场景下支持的计费类型
curl "https://e.heytap.com/v3/communal/config/getList" ^
  -H "authority: e.heytap.com" ^
  -H "sec-ch-ua: ^^" Not;A Brand^^";v=^^"99^^", ^^"Google Chrome^^";v=^^"91^^", ^^"Chromium^^";v=^^"91^^"" ^
  -H "accept: application/json, text/plain, /" ^
  -H "sec-ch-ua-mobile: ?0" ^
  -H "tk: 0f85c3b8f9eeabcb1139c35b24a34ba8" ^
  -H "user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" ^
  -H "content-type: application/x-www-form-urlencoded" ^
  -H "origin: https://e.heytap.com" ^
  -H "sec-fetch-site: same-origin" ^
  -H "sec-fetch-mode: cors" ^
  -H "sec-fetch-dest: empty" ^
  -H "referer: https://e.heytap.com/markets/creative/create?type=create&level=plan" ^
  -H "accept-language: zh-CN,zh;q=0.9" ^
  -H "cookie: _dx_uzZo5y=f06782e4f086b5fba2b364f8bac0b82ce483d3115db45ef71a3cbc445d4d6efb2963e4c5; _dx_app_43768f2ab87180b2cbe718f62d4bc5fa=60efb2d5f7t3ngBT2eovAqJ7I44JeuwOrWWfNoI1; login-access-id=1000039147; _dx_captcha_vid=17AAA0A572A43768F2AB89FEC9DD2554F4CC6B3CDE738E99EB3AC^%^40bj; adstk=0f85c3b8f9eeabcb1139c35b24a34ba8; oadsk=c4ad011a83114968b65804ce3eab263b; JSESSIONID=3f3d57f6151440938521460d9919943d; WEBTOKEN=eyJhbGciOiJIUzUxMiIsInppcCI6IkRFRiJ9.eNqqViouTVKyUjI0AAJjS0MTcyUdpdSKAiUrQzMjM2NTczMTo1oAAAAA__8.yvzTWukhhHDxKxqkRbT9z0tkw6nJ3RXcwS-rg2uHSsqB5wsPuVT6B4Camt-YeS51a2RG428M79eB15jEIgotAQ" ^
  --data-raw "type=BILLING_TYPE&flowScene=6&extensionType=1" ^
  --compressed

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

5 获取流量场景下对应的ocpx转化类型
curl "https://e.heytap.com/v3/communal/config/getList" ^
  -H "authority: e.heytap.com" ^
  -H "sec-ch-ua: ^^" Not;A Brand^^";v=^^"99^^", ^^"Google Chrome^^";v=^^"91^^", ^^"Chromium^^";v=^^"91^^"" ^
  -H "accept: application/json, text/plain, /" ^
  -H "sec-ch-ua-mobile: ?0" ^
  -H "tk: 0f85c3b8f9eeabcb1139c35b24a34ba8" ^
  -H "user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" ^
  -H "content-type: application/x-www-form-urlencoded" ^
  -H "origin: https://e.heytap.com" ^
  -H "sec-fetch-site: same-origin" ^
  -H "sec-fetch-mode: cors" ^
  -H "sec-fetch-dest: empty" ^
  -H "referer: https://e.heytap.com/markets/creative/create?type=create&level=plan" ^
  -H "accept-language: zh-CN,zh;q=0.9" ^
  -H "cookie: _dx_uzZo5y=f06782e4f086b5fba2b364f8bac0b82ce483d3115db45ef71a3cbc445d4d6efb2963e4c5; _dx_app_43768f2ab87180b2cbe718f62d4bc5fa=60efb2d5f7t3ngBT2eovAqJ7I44JeuwOrWWfNoI1; login-access-id=1000039147; _dx_captcha_vid=17AAA0A572A43768F2AB89FEC9DD2554F4CC6B3CDE738E99EB3AC^%^40bj; adstk=0f85c3b8f9eeabcb1139c35b24a34ba8; oadsk=c4ad011a83114968b65804ce3eab263b; JSESSIONID=3f3d57f6151440938521460d9919943d; WEBTOKEN=eyJhbGciOiJIUzUxMiIsInppcCI6IkRFRiJ9.eNqqViouTVKyUjI0AAJjS0MTcyUdpdSKAiUrQzMjM2NTczMTo1oAAAAA__8.yvzTWukhhHDxKxqkRbT9z0tkw6nJ3RXcwS-rg2uHSsqB5wsPuVT6B4Camt-YeS51a2RG428M79eB15jEIgotAQ" ^
  --data-raw "type=OCPC_TYPE&extensionType=1&flowScene=6" ^
  --compressed

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

6 获取流量场景下支持的深度转化类型
curl "https://e.heytap.com/v3/communal/config/getList" ^
  -H "authority: e.heytap.com" ^
  -H "sec-ch-ua: ^^" Not;A Brand^^";v=^^"99^^", ^^"Google Chrome^^";v=^^"91^^", ^^"Chromium^^";v=^^"91^^"" ^
  -H "accept: application/json, text/plain, /" ^
  -H "sec-ch-ua-mobile: ?0" ^
  -H "tk: 0f85c3b8f9eeabcb1139c35b24a34ba8" ^
  -H "user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" ^
  -H "content-type: application/x-www-form-urlencoded" ^
  -H "origin: https://e.heytap.com" ^
  -H "sec-fetch-site: same-origin" ^
  -H "sec-fetch-mode: cors" ^
  -H "sec-fetch-dest: empty" ^
  -H "referer: https://e.heytap.com/markets/creative/create?type=create&level=plan" ^
  -H "accept-language: zh-CN,zh;q=0.9" ^
  -H "cookie: _dx_uzZo5y=f06782e4f086b5fba2b364f8bac0b82ce483d3115db45ef71a3cbc445d4d6efb2963e4c5; _dx_app_43768f2ab87180b2cbe718f62d4bc5fa=60efb2d5f7t3ngBT2eovAqJ7I44JeuwOrWWfNoI1; login-access-id=1000039147; _dx_captcha_vid=17AAA0A572A43768F2AB89FEC9DD2554F4CC6B3CDE738E99EB3AC^%^40bj; adstk=0f85c3b8f9eeabcb1139c35b24a34ba8; oadsk=c4ad011a83114968b65804ce3eab263b; JSESSIONID=3f3d57f6151440938521460d9919943d; WEBTOKEN=eyJhbGciOiJIUzUxMiIsInppcCI6IkRFRiJ9.eNqqViouTVKyUjI0AAJjS0MTcyUdpdSKAiUrQzMjM2NTczMTo1oAAAAA__8.yvzTWukhhHDxKxqkRbT9z0tkw6nJ3RXcwS-rg2uHSsqB5wsPuVT6B4Camt-YeS51a2RG428M79eB15jEIgotAQ" ^
  --data-raw "type=DEEP_OCPC_TYPE&ocpcType=0&extensionType=1&extensionFlow=2&flowScene=6" ^
  --compressed

7 获取流量场景下支持的落地页类型
curl "https://e.heytap.com/v3/communal/config/getList" ^
  -H "authority: e.heytap.com" ^
  -H "sec-ch-ua: ^^" Not;A Brand^^";v=^^"99^^", ^^"Google Chrome^^";v=^^"91^^", ^^"Chromium^^";v=^^"91^^"" ^
  -H "accept: application/json, text/plain, /" ^
  -H "sec-ch-ua-mobile: ?0" ^
  -H "tk: 0f85c3b8f9eeabcb1139c35b24a34ba8" ^
  -H "user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" ^
  -H "content-type: application/x-www-form-urlencoded" ^
  -H "origin: https://e.heytap.com" ^
  -H "sec-fetch-site: same-origin" ^
  -H "sec-fetch-mode: cors" ^
  -H "sec-fetch-dest: empty" ^
  -H "referer: https://e.heytap.com/markets/creative/create?type=create&level=plan" ^
  -H "accept-language: zh-CN,zh;q=0.9" ^
  -H "cookie: _dx_uzZo5y=f06782e4f086b5fba2b364f8bac0b82ce483d3115db45ef71a3cbc445d4d6efb2963e4c5; _dx_app_43768f2ab87180b2cbe718f62d4bc5fa=60efb2d5f7t3ngBT2eovAqJ7I44JeuwOrWWfNoI1; login-access-id=1000039147; _dx_captcha_vid=17AAA0A572A43768F2AB89FEC9DD2554F4CC6B3CDE738E99EB3AC^%^40bj; adstk=0f85c3b8f9eeabcb1139c35b24a34ba8; oadsk=c4ad011a83114968b65804ce3eab263b; JSESSIONID=3f3d57f6151440938521460d9919943d; WEBTOKEN=eyJhbGciOiJIUzUxMiIsInppcCI6IkRFRiJ9.eNqqViouTVKyUjI0AAJjS0MTcyUdpdSKAiUrQzMjM2NTczMTo1oAAAAA__8.yvzTWukhhHDxKxqkRbT9z0tkw6nJ3RXcwS-rg2uHSsqB5wsPuVT6B4Camt-YeS51a2RG428M79eB15jEIgotAQ" ^
  --data-raw "type=PAGE_TYPE&extensionFlow=2&extensionType=1&flowScene=6" ^
  --compressed

返回：{"code":0,"data":[{"value":"4","ext":"{"name":"萤火虫建站","value":4}"},{"value":"3","ext":"{"name":"波文建站","value":3}"},{"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

接口描述：

请求实例：

curl -X POST
https://e.oppomobile.com/v3/plan/add
-H 'Content-Type: application/x-www-form-urlencoded'
-d 'extensionType=2&dayBudget=155500&planName=%E5%BA%94%E7%94%A8%E6%8E%A8%E5%B9%BF_2021%2F07%2F20_14%3A34%3A11&dayLimit=1'

响应报文：

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

请求参数

Headers

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

Query

参数名称	是否必须	示例	备注
dayBudget	否		日预算 (限制日预算时必填 单位（分）)
dayLimit	是		是否限制日预算 0 不限制 1 限制, 当dayLimit=1时dayBudget必填
extensionType	是		推广目标 1-网页推广 2-应用推广 3-快应用推广
planName	是		计划名称 最大长度不能超过100字符

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
├─ planId	integer	非必须		广告计划ID	format: int64
msg	string	非必须

3.2 批量设置或修改日预算

基本信息

Path： /v3/plan/dayBudget

Method： POST

接口描述：

请求实例：

curl -X POST
  https://e.oppomobile.com/v3/plan/dayBudget
  -H 'Content-Type: application/x-www-form-urlencoded'
  -d 'planIds=200012330%2C200014945&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
        }
    ]
}

请求参数

Headers

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

Query

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

返回数据

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

3.3 批量删除计划

基本信息

Path： /v3/plan/delete

Method： POST

接口描述：

请求实例：

curl -X POST
  https://e.oppomobile.com/v3/plan/delete
  -H 'Content-Type: application/x-www-form-urlencoded'
  -d 'planIds=200011041%2C200012235'

响应报文：

{
    "code": 0
}

请求参数

Headers

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

Query

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

返回数据

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

3.4 编辑单个计划信息

基本信息

Path： /v3/plan/edit

Method： POST

接口描述：

请求实例：

curl -X POST
  https://e.oppomobile.com/v3/plan/edit
  -H 'Content-Type: application/x-www-form-urlencoded'
  -d 'planIds=200011041%2C200012235&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
    }
}

请求参数

Headers

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

Query

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

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
├─ leftTimes	integer	非必须		剩余次数	format: int32
├─ msg	string	非必须		失败原因, 冗余信息
├─ planId	integer	非必须		计划id	format: int64
├─ planName	string	非必须		计划名称
├─ ret	integer	非必须		更新是否成功 0 成功 1 失败	format: int32
├─ totalTimes	integer	非必须		总次数	format: int32
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 达到计划预算

请求实例：

curl -X GET
'https://sapi.ads.heytapmobi.com/v3/plan/get?planId=200012330'
-H 'Content-Type: application/x-www-form-urlencoded'

响应报文：

{
  "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": "余额不足"
  }
}

请求参数

Headers

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

Query

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

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
├─ dayBudget	integer	非必须		计划日预算（分）
├─ dayLimit	integer	非必须		是否限额0不限制 1限制	format: int32
├─ deleteFlag	integer	非必须		删除状态	format: int32
├─ extensionType	integer	非必须		推广目标	format: int32
├─ extensionTypeName	string	非必须		推广目标名称
├─ planId	integer	非必须		广告计划ID	format: int64
├─ planName	string	非必须		广告计划名称
├─ showStatus	integer	非必须		前端展示状态	format: int32
├─ showStatusName	string	非必须		前端展示状态描述
├─ status	integer	非必须		详细状态	format: int32
├─ status2	integer	非必须		投放开关 0-开启 1-关闭	format: int32
├─ subShowStatusName	string	非必须		详细状态描述
├─ insertTime	integer	非必须		插入时间(秒级时间戳)
├─ updateTime	integer	非必须		更新时间(秒级时间戳)
msg	string	非必须

3.6 批量启停计划

基本信息

Path： /v3/plan/status

Method： POST

接口描述：

请求实例：

curl -X POST
https://e.oppomobile.com/v3/plan/dayBudget
-H 'Content-Type: application/x-www-form-urlencoded'
-d 'planIds=200012239%2C200012238&dayBudget=40000&dayLimit=1'

响应报文：

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

请求参数

Headers

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

Query

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

返回数据

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

3.7 分页查询广告计划列表

基本信息

Path： /v3/plan/page

Method： POST

接口描述：

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 达到计划预算

请求实例：

curl -X POST
https://sapi.ads.heytapmobi.com/v3/plan/page
-H 'Content-Type: application/x-www-form-urlencoded'
-d '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-快应用推广 (选择多个目标以逗号分隔)
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	非必须			format: int32
data	object	非必须
├─ pageNum	integer	非必须		页码	format: int32
├─ pageSize	integer	非必须		每页大小	format: int32
├─ records	object []	非必须		数据集合	item 类型: 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	非必须		删除状态	format: int32
├─ 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	非必须		推广流量	format: int32
├─ extensionFlowName	string	非必须		推广流量名称
├─ extensionType	integer	非必须		推广目标	format: int32
├─ extensionTypeName	string	非必须		推广目标名称
├─ formCnt	string	非必须		表单提交量
├─ formCntPrice	string	非必须		表单提交成本
├─ planId	integer	非必须		广告计划ID	format: int64
├─ planName	string	非必须		广告计划名称
├─ quickAppPay	string	非必须		快应用付费
├─ quickAppPayPrice	string	非必须		快应用付费成本
├─ showStatus	integer	非必须		前端展示状态	format: int32
├─ showStatusName	string	非必须		前端展示状态描述
├─ status	integer	非必须		详细状态	format: int32
├─ status2	integer	非必须		投放开关	format: int32
├─ subShowStatusName	string	非必须		详细状态描述
├─ targetROI	string	非必须		目标ROI系数
├─ insertTime	integer	非必须		插入时间(秒级时间戳)
├─ updateTime	integer	非必须		更新时间(秒级时间戳)
├─ total	integer	非必须		数据总条数	format: int32
├─ totalPage	integer	非必须		总页数	format: int32
msg	string	非必须

4.【推广】广告组管理

4.1 添加单个广告组

基本信息

Path： /v3/group/add

Method： POST

接口描述：

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

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

元数据配置相关：
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:广告主手动上传(出价词包)
appId	否		应用id，应用推广时必填
autoOpenFlag	否		下载并打开 0-未开启 1-开启
beginTime	否		推广开始时间，格式：YYYYMMDD
billingType	是		计费方式.1:CPD 2:CPC 5:OCPX
dayLimit	是		推广日期限制 0-不限制推广日期 1-限制推广日期，当为1时，beginTime和endTime必传
deepOcpcPrice	否		深度ocpc转化出价（单位：分）
deepOcpcType	否		深度ocpc转换类型， 0-默认, 1-下载, 2-激活, 4-游戏注册, 5-游戏付费, 6-表单注册, 7-注册, 8-回传激活, 9-应用付费, 10-回传留存, 11-应用内自定义转化, 12-应用内授信, 13-应用内下单, 14-deepLink拉活, 15-系统留存, 16-deeplink回传激活, 17-deeplink回传注册, 18-deeplink应用付费, 19-deeplink应用内自定义转化, 20-deeplink应用内授信, 21-deeplink应用内下单, 22-快应用付费, 23-游戏付费ROI1
deepUrl	否		直达链接
endTime	否		推广截止时间，格式：YYYYMMDD
extensionFlow	是		推广流量：1-全流量场景，2-自有流量，3-联盟流量
extensionType	是		标的物类型 1：链接推广 2：应用推广 3: 快应用推广
flowScene	是		流量场景：1-全流量场景，2-精选推荐，3-安装有礼，4-开机必备，5-搜索，6-信息流，7-Banner，8-开屏，9-插屏，10-原生，11-激励视频，12-联盟通投
instantAppId	否		快应用Id，快应用推广时必填
instantAppUrl	否		快应用落地链接，快应用推广时必填
ocpcOptmType	否		区分ocpc出价类型. 默认为0，0-单出价，1-双出价，2-两阶段
ocpcPrice	否		目标转化出价（单位：分）
ocpcType	否		目标转化类型，0-默认, 1-下载, 2-激活, 4-游戏注册, 5-游戏付费, 6-表单注册, 7-注册, 8-回传激活, 9-应用付费, 10-回传留存, 11-应用内自定义转化, 12-应用内授信, 13-应用内下单, 14-deepLink拉活, 15-系统留存, 16-deeplink回传激活, 17-deeplink回传注册, 18-deeplink应用付费, 19-deeplink应用内自定义转化, 20-deeplink应用内授信, 21-deeplink应用内下单, 22-快应用付费, 23-游戏付费ROI1
pageId	否		落地页id。若为萤火虫应用下载模板页，则传递模板id，可通/v3/communal/h5Template/list接口获取模板id和url，也可参考《典型场景举例-新建应用下载模板页广告组》
pageType	否		落地页建站类型: 0：自定义落地页 1：一叶智能 2：云脑建站 3：达尔文建站 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

返回数据

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

4.2 编辑单个广告组

基本信息

Path： /v3/group/edit

Method： POST

接口描述：

curl "https://e.heytap.com/v3/group/edit"   -X POST -H "content-type: application/x-www-form-urlencoded"

传参明细：
planId: 200008260
adGroupId: 300087873
adGroupName: 应用推广_自有流量_2021/07/17_17:34:321
appId: 21279
deepUrl:
instantAppId: 0
instantAppUrl:
extensionFlow: 2
flowScene: 3
pageType: 9
pageId: 0
pageUrl:
smartExpandType: 0
timeLimit: 0
dayLimit: 0
billingType: 5
followMaxPrice:
price: 150
ocpcType: 4
ocpcPrice: 250
deepOcpcType: 5
deepOcpcPrice: 1000
targetId: 834313
ocpcOptmType: 1
extensionType: 2
groupPrice: 1
autoOpenFlag: 0
followAppIdList:
oldTarget: 1
beginTime:
endTime:

返回数据：

{
    "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转换类型， 0-默认, 1-下载, 2-激活, 4-游戏注册, 5-游戏付费, 6-表单注册, 7-注册, 8-回传激活, 9-应用付费, 10-回传留存, 11-应用内自定义转化, 12-应用内授信, 13-应用内下单, 14-deepLink拉活, 15-系统留存, 16-deeplink回传激活, 17-deeplink回传注册, 18-deeplink应用付费, 19-deeplink应用内自定义转化, 20-deeplink应用内授信, 21-deeplink应用内下单, 22-快应用付费, 23-游戏付费ROI1
deepUrl	否		直达链接
endTime	否		推广截止时间，格式：YYYYMMDD
extensionFlow	否		推广流量：1-全流量场景，2-自有流量，3-联盟流量
extensionType	否		标的物类型 1：链接推广 2：应用推广 3: 快应用推广
flowScene	否		流量场景：1-全流量场景，2-精选推荐，3-安装有礼，4-开机必备，5-搜索，6-信息流，7-Banner，8-开屏，9-插屏，10-原生，11-激励视频，12-联盟通投。修改出价，流量场景不能为空
groupPrice	否		是否支持广告组出价 1-支持，要么不传，要么传1，修改出价信息、落地页信息时groupPrice必填
instantAppId	否		快应用Id
instantAppUrl	否		快应用落地链接
ocpcOptmType	否		区分ocpc出价类型. 默认为0，0-单出价，1-双出价，2-两阶段
ocpcPrice	否		目标转化出价（单位：分）
ocpcType	否		目标转化类型，0-默认, 1-下载, 2-激活, 4-游戏注册, 5-游戏付费, 6-表单注册, 7-注册, 8-回传激活, 9-应用付费, 10-回传留存, 11-应用内自定义转化, 12-应用内授信, 13-应用内下单, 14-deepLink拉活, 15-系统留存, 16-deeplink回传激活, 17-deeplink回传注册, 18-deeplink应用付费, 19-deeplink应用内自定义转化, 20-deeplink应用内授信, 21-deeplink应用内下单, 22-快应用付费, 23-游戏付费ROI1
pageId	否		落地页id
pageType	否		落地页建站类型: 0：自定义落地页 1：一叶智能 2：云脑建站 3：达尔文建站 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

返回数据

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

4.3 获取单个广告组信息

基本信息

Path： /v3/group/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 已结束
5 未开始
6 不在推广时段
7 规格投放暂停

curl "https://sapi.ads.heytapmobi.com/v3/group/get"   -X GET -H "content-type: application/x-www-form-urlencoded"

传参明细：
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,
        "linkDeskFlag": 0
    }
}

请求参数

Headers

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

Query

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

返回数据

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

4.4 分页查询广告组列表

基本信息

Path： /v3/group/page

Method： POST

接口描述：

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 规格投放暂停

curl "https://sapi.ads.heytapmobi.com/v3/group/delete"  -X POST  -H "content-type: application/x-www-form-urlencoded"

传参明细：
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": "-"
            }
        ]
    }
}

请求参数

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-快应用推广，多个推广目标通过英文逗号隔开，例如：1,2
flowScenes	否		流量场景列表 1-全流量场景，2-精选推荐，3-安装有礼，4-开机必备，5-搜索，6-信息流，7-Banner，8-开屏，9-插屏，10-原生，11-激励视频，12-联盟通投，多个流量场景通过英文逗号隔开，例如：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	非必须			format: int32
data	object	非必须
├─ pageNum	integer	非必须		页码	format: int32
├─ pageSize	integer	非必须		每页大小	format: int32
├─ records	object []	非必须		数据集合	item 类型: object
├─ adGroupId	integer	非必须		广告组ID	format: int64
├─ adGroupName	string	非必须		广告组名称
├─ adId	integer	非必须		广告ID	format: int64
├─ adName	string	非必须		广告名称
├─ adServingType	string	非必须		投放模式
├─ auditDesc	string	非必须		审核原因
├─ auditStatus	integer	非必须		审核状态	format: int32
├─ 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	非必须		深度转化类型	format: int32
├─ deepOcpcTypeName	string	非必须		深度转化类型名称
├─ deleteFlag	integer	非必须		删除状态	format: int32
├─ 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	非必须		动态出价	format: int32
├─ ecpm	string	非必须		ecpm
├─ expose	string	非必须		曝光量
├─ extensionFlow	integer	非必须		推广流量	format: int32
├─ extensionFlowName	string	非必须		推广流量名称
├─ extensionType	integer	非必须		推广目标	format: int32
├─ extensionTypeName	string	非必须		推广目标名称
├─ flowScene	integer	非必须		流量场景	format: int32
├─ flowSceneName	string	非必须		流量场景名称
├─ followAppIdList	integer []	非必须		跟随appId列表	item 类型: integer
├─		非必须
├─ followMaxPrice	string	非必须		更随最高价格
├─ formCnt	string	非必须		表单提交量
├─ formCntPrice	string	非必须		表单提交成本
├─ globalSpecId	integer	非必须		创意规格	format: int32
├─ globalSpecName	string	非必须		创意规格名称
├─ ocpcPrice	string	非必须		转化出价
├─ ocpcType	integer	非必须		转化类型	format: int32
├─ ocpcTypeName	string	非必须		转化类型名称
├─ planId	integer	非必须		广告计划ID	format: int64
├─ planName	string	非必须		广告计划名称
├─ price	string	非必须		基础出价
├─ quickAppPay	string	非必须		快应用付费
├─ quickAppPayPrice	string	非必须		快应用付费成本
├─ showStatus	integer	非必须		前端展示状态	format: int32
├─ showStatusName	string	非必须		前端展示状态描述
├─ status	integer	非必须		详细状态	format: int32
├─ status2	integer	非必须		投放开关	format: int32
├─ subShowStatusName	string	非必须		详细状态描述
├─ targetROI	string	非必须		目标ROI系数
├─ insertTime	integer	非必须		插入时间(秒级时间戳)
├─ updateTime	integer	非必须		更新时间(秒级时间戳)
├─ total	integer	非必须		数据总条数	format: int32
├─ totalPage	integer	非必须		总页数	format: int32
msg	string	非必须

4.5 批量删除广告组

基本信息

Path： /v3/group/delete

Method： POST

接口描述：

curl "https://e.heytap.com/v3/group/delete"  -X POST -H "content-type: application/x-www-form-urlencoded"

传参明细：
groupIds: 300088058,300088057

返回数据：

{
    "code": 0
}

请求参数

Headers

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

Query

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

返回数据

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

4.6 批量启停广告组

基本信息

Path： /v3/group/status

Method： POST

接口描述：

curl "https://e.heytap.com/v3/group/status"  -X POST -H "content-type: application/x-www-form-urlencoded"

传参明细：
groupIds[0]: 300088219
status2: 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	非必须			format: int32
data	object []	非必须			item 类型: object
├─ adGroupId	integer	非必须		广告组id	format: int64
├─ adGroupName	string	非必须		广告组名称
├─ leftTimes	integer	非必须		剩余修改次数	format: int32
├─ maxPrice	integer	非必须		最大价格	format: int32
├─ minPrice	integer	非必须		最小价格	format: int32
├─ modifyType	integer	非必须		修改类型：1-推广时段，2-基础出价，3-转化出价，4-深度转化出价，5-目标ROI系数	format: int32
├─ msg	string	非必须		失败原因
├─ ret	integer	非必须		更新是否成功 0-成功 1-失败	format: int32
├─ totalTimes	integer	非必须		总修改次数	format: int32
msg	string	非必须

4.7 批量修改排期

基本信息

Path： /v3/group/batchSchedule

Method： POST

接口描述：

curl "https://e.heytap.com/v3/group/batchSchedule"  -X POST -H "content-type: application/x-www-form-urlencoded"

传参明细：
groupIds: 300088219
beginTime: 20210721
endTime: 20210723
timeSet: {"1":"","2":"4,7","3":"11","4":"","5":"","6":"","7":""}
timeLimit: 1
dayLimit: 1

返回数据：

{
    "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	非必须			format: int32
data	object []	非必须		返回更新信息数组	item 类型: object
├─ adGroupId	integer	非必须		广告组id	format: int64
├─ adGroupName	string	非必须		广告组名称
├─ leftTimes	integer	非必须		剩余修改次数	format: int32
├─ maxPrice	integer	非必须		最大价格	format: int32
├─ minPrice	integer	非必须		最小价格	format: int32
├─ modifyType	integer	非必须		修改类型：1-推广时段，2-基础出价，3-转化出价，4-深度转化出价，5-目标ROI系数	format: int32
├─ msg	string	非必须		失败原因
├─ ret	integer	非必须		更新是否成功 0-成功 1-失败	format: int32
├─ totalTimes	integer	非必须		总修改次数	format: int32
msg	string	非必须

4.8 批量修改定向包

基本信息

Path： /v3/group/batchTarget

Method： POST

接口描述：

1、通过接口获取定向包信息（详情见 定向相关接口 -> 获取定向列表）
curl "https://e.heytap.com/v2/communal/target/list/page"  -X POST -H "content-type: application/x-www-form-urlencoded"

传参明细：
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、调用修改定向包接口
curl "https://e.heytap.com/v3/group/batchTarget" -X POST -H "content-type: application/x-www-form-urlencoded"
传参明细：
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	非必须			format: int32
data	object []	非必须		返回更新信息数组	item 类型: object
├─ adGroupId	integer	非必须		广告组id	format: int64
├─ adGroupName	string	非必须		广告组名称
├─ leftTimes	integer	非必须		剩余修改次数	format: int32
├─ maxPrice	integer	非必须		最大价格	format: int32
├─ minPrice	integer	非必须		最小价格	format: int32
├─ modifyType	integer	非必须		修改类型：1-推广时段，2-基础出价，3-转化出价，4-深度转化出价，5-目标ROI系数	format: int32
├─ msg	string	非必须		失败原因
├─ ret	integer	非必须		更新是否成功 0-成功 1-失败	format: int32
├─ totalTimes	integer	非必须		总修改次数	format: int32
msg	string	非必须

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

基本信息

Path： /v3/group/price

Method： POST

接口描述：

curl "https://e.heytap.com/v3/group/price"  -X POST -H "content-type: application/x-www-form-urlencoded"

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	非必须			format: int32
data	object []	非必须		返回更新信息数组	item 类型: object
├─ adGroupId	integer	非必须		广告组id	format: int64
├─ adGroupName	string	非必须		广告组名称
├─ leftTimes	integer	非必须		剩余修改次数	format: int32
├─ maxPrice	integer	非必须		最大价格（单位：分）	format: int32
├─ minPrice	integer	非必须		最小价格（单位：分）	format: int32
├─ modifyType	integer	非必须		修改类型：1-推广时段，2-基础出价，3-转化出价，4-深度转化出价，5-目标ROI系数	format: int32
├─ msg	string	非必须		失败原因
├─ ret	integer	非必须		更新是否成功 0-成功 1-失败	format: int32
├─ totalTimes	integer	非必须		总修改次数	format: int32
msg	string	非必须

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

基本信息

Path： /v3/group/ocpcPrice

Method： POST

接口描述：

curl "https://e.heytap.com/v3/group/ocpcPrice" -X POST -H "content-type: application/x-www-form-urlencoded"

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	非必须			format: int32
data	object []	非必须		返回更新信息数组	item 类型: object
├─ adGroupId	integer	非必须		广告组id	format: int64
├─ adGroupName	string	非必须		广告组名称
├─ leftTimes	integer	非必须		剩余修改次数	format: int32
├─ maxPrice	integer	非必须		最大价格（单位：分）	format: int32
├─ minPrice	integer	非必须		最小价格（单位：分）	format: int32
├─ modifyType	integer	非必须		修改类型：1-推广时段，2-基础出价，3-转化出价，4-深度转化出价，5-目标ROI系数	format: int32
├─ msg	string	非必须		失败原因
├─ ret	integer	非必须		更新是否成功 0-成功 1-失败	format: int32
├─ totalTimes	integer	非必须		总修改次数	format: int32
msg	string	非必须

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

基本信息

Path： /v3/group/deepOcpcPrice

Method： POST

接口描述：

curl "https://e.heytap.com/v3/group/deepOcpcPrice" -X POST -H "content-type: application/x-www-form-urlencoded"

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	非必须			format: int32
data	object []	非必须		返回更新信息数组	item 类型: object
├─ adGroupId	integer	非必须		广告组id	format: int64
├─ adGroupName	string	非必须		广告组名称
├─ leftTimes	integer	非必须		剩余修改次数	format: int32
├─ maxPrice	integer	非必须		最大价格（单位：分）	format: int32
├─ minPrice	integer	非必须		最小价格（单位：分）	format: int32
├─ modifyType	integer	非必须		修改类型：1-推广时段，2-基础出价，3-转化出价，4-深度转化出价，5-目标ROI系数	format: int32
├─ msg	string	非必须		失败原因
├─ ret	integer	非必须		更新是否成功 0-成功 1-失败	format: int32
├─ totalTimes	integer	非必须		总修改次数	format: int32
msg	string	非必须

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

5.1 批量启停广告创意

基本信息

Path： /v3/ad/status

Method： POST

接口描述：

批量启停广告创意

curl "https://e.heytap.com/v3/ad/status"   -H "content-type: application/x-www-form-urlencoded"
传参：
adIds[0]: 400092045
adIds[1]: 400091199
status2: 1
响应报文：
{
"code": 0
}

请求参数

Headers

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

Query

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

返回数据

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

5.2 获取单个广告创意详情

基本信息

Path： /v3/ad/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 计划暂停

获取单个广告创意详情

curl "https://sapi.ads.heytapmobi.com/v3/ad/get?adId=400080377"  -H "content-type: application/x-www-form-urlencoded"
响应报文：
{
"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",
"mid": 29519483
}],
"brandLogoImg": {
"materialUrl": "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	是

Query

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

返回数据

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

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

基本信息

Path： /v3/ad/list

Method： POST

接口描述：

获取广告组下广告详情列表(创意编辑时调用)

curl "https://e.heytap.com/v3/ad/list"   -H "content-type: application/x-www-form-urlencoded"  --data-raw "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",
"mid": 43449718
}],
"brandLogoImg": {
"materialUrl": "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",
"mid": 38703350
}],
"brandLogoImg": {
"materialUrl": "https://adsfs.heytapimage.com/ads-material-depot/image/06beaff00ca93854ba1eb77628a3ec02.jpg",
"mid": 38704057
},
"videoImg": {
"materialUrl": "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",
"mid": 29519483
}],
"brandLogoImg": {
"materialUrl": "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	是

Query

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

返回数据

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

5.4 分页获取广告创意列表

基本信息

Path： /v3/ad/page

Method： POST

接口描述：

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 计划暂停

分页获取广告创意列表

curl "https://sapi.ads.heytapmobi.com/v3/ad/page"  -H "content-type: application/x-www-form-urlencoded"
传参：
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	是

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-投类型
globalSpecIds	否		创意规格列表，/spec/list规格查询接口返回，另可参考附录-规格部分
limit	是		页大小，取值范围[1,1000]
orderByColumn	否		排序的数据列： adId：广告Id adName：广告名称 price：基础出价 ocpcPrice:转化出价 deepOcpcPrice：深度转化出价
page	是		页号
planIds	否		广告计划ID列表
showStatusSet	否		展示状态列表，启动中-0 暂停中-1 广告组暂停-2 计划暂停-3
needStats	否	0	是否查询数据字段，0表示不查询，1表示查询（推荐使用0以提高性能）

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
├─ pageNum	integer	非必须		页码	format: int32
├─ pageSize	integer	非必须		每页大小	format: int32
├─ records	object []	非必须		数据集合	item 类型: object
├─ adGroupId	integer	非必须		广告组ID	format: int64
├─ adGroupName	string	非必须		广告组名称
├─ adId	integer	非必须		广告ID	format: int64
├─ adName	string	非必须		广告名称
├─ adServingType	string	非必须		投放模式
├─ auditDesc	string	非必须		审核原因
├─ auditStatus	integer	非必须		审核状态	format: int32
├─ 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	非必须		深度转化类型	format: int32
├─ deepOcpcTypeName	string	非必须		深度转化类型名称
├─ deleteFlag	integer	非必须		删除状态	format: int32
├─ 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	非必须		动态出价	format: int32
├─ ecpm	string	非必须		ecpm
├─ expose	string	非必须		曝光量
├─ extensionFlow	integer	非必须		推广流量	format: int32
├─ extensionFlowName	string	非必须		推广流量名称
├─ extensionType	integer	非必须		推广目标	format: int32
├─ extensionTypeName	string	非必须		推广目标名称
├─ flowScene	integer	非必须		流量场景	format: int32
├─ flowSceneName	string	非必须		流量场景名称
├─ followAppIdList	integer []	非必须		跟随appId列表	item 类型: integer
├─		非必须
├─ followMaxPrice	string	非必须		更随最高价格
├─ formCnt	string	非必须		表单提交量
├─ formCntPrice	string	非必须		表单提交成本
├─ globalSpecId	integer	非必须		创意规格	format: int32
├─ globalSpecName	string	非必须		创意规格名称
├─ ocpcPrice	string	非必须		转化出价
├─ ocpcState	string	非必须		转化阶段
├─ ocpcType	integer	非必须		转化类型	format: int32
├─ ocpcTypeName	string	非必须		转化类型名称
├─ planId	integer	非必须		广告计划ID	format: int64
├─ planName	string	非必须		广告计划名称
├─ price	string	非必须		基础出价
├─ quickAppPay	string	非必须		快应用付费
├─ quickAppPayPrice	string	非必须		快应用付费成本
├─ showStatus	integer	非必须		前端展示状态	format: int32
├─ showStatusName	string	非必须		前端展示状态描述
├─ status	integer	非必须		详细状态	format: int32
├─ status2	integer	非必须		投放开关	format: int32
├─ subShowStatusName	string	非必须		详细状态描述
├─ targetROI	string	非必须		目标ROI系数
├─ insertTime	integer	非必须		插入时间(秒级时间戳)
├─ updateTime	integer	非必须		更新时间(秒级时间戳)
├─ total	integer	非必须		数据总条数	format: int32
├─ totalPage	integer	非必须		总页数	format: int32
msg	string	非必须

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

基本信息

Path： /v3/ad/batch

Method： POST

接口描述：

批量操作(新增/编辑/删除)广告创意(新增和编辑限制同一个广告组下，删除不限制，可操作1-50个)
###前置调用接口###：
【1.查询规格详情】
调用接口：curl "https://e.heytap.com/v3/communal/spec/list --data-raw 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选填，3无需关注，format部分为规格限制详情，更多参考/spec/list接口文档

【2.从素材库查询素材（非必须）】
调用接口：curl "https://e.heytap.com/creative/material/image/getList?nameOrID=&size=102400&dimension=200*200&page=1&pageSize=10&suffixes=jpg&suffixes=png&suffixes=jpeg

【3.上传素材(非必须)】
调用接口：curl "https://e.heytap.com/creative/material/v3/communal/upload -H content-type: multipart/form-data; Content-Disposition: form-data; name=file; filename=22.jpg

【4.获取按钮文案】
调用接口：curl "https://e.heytap.com/v3/communal/config/getList --data-raw type=BUTTON_TITLE

【5.获取必填规格】
调用接口：curl "https://e.heytap.com/v3/communal/config/getList --data-raw 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	是

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[新增时必填]
addList[0].imgMatIds	否		图片素材id
addList[0].playBeginUrl	否		开始播放监测链接
addList[0].playEndUrl	否		结束播放监测链接
addList[0].status	否		广告状态(按位或)1:广告启停位(1:暂停;0:启用)
addList[0].videoBgImgId	否		视频结束背景图id
addList[0].videoImgId	否		视频封面图id
addList[0].videoMatIds	否		视频素材id
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[新增时必填]
editList[0].imgMatIds	否		图片素材id
editList[0].playBeginUrl	否		开始播放监测链接
editList[0].playEndUrl	否		结束播放监测链接
editList[0].status	否		广告状态(按位或)1:广告启停位(1:暂停;0:启用)
editList[0].videoBgImgId	否		视频结束背景图id
editList[0].videoImgId	否		视频封面图id
editList[0].videoMatIds	否		视频素材id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	integer []	非必须			item 类型: integer
├─		非必须
msg	string	非必须

6.【数据】数据相关

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

基本信息

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

Method： POST

接口描述：

请求参数示例：
{
  "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两种 不可取其他值 支持大小写
timeLevel	string	非必须	DAY	时间粒度 聚合粒度 有HOUR DAY WEEK MONTH ALL五个粒度具体支持到那个粒度和具体业务相关 取值如前 必须大写
page	integer	非必须	1	分页起始
pageCount	integer	非必须	10	分页大小
paraMap	object	非必须		与业务相关的具体参数
├─ adGroupIds	string []	非必须		广告组ID集合	item 类型: string
├─		非必须
├─ extensionFlowList	string []	非必须		推广流量集合	item 类型: string
├─		非必须		1.全流量场景，2自由流量，3联盟流量
├─ extensionTypeList	string []	非必须		推广目标集合	item 类型: string
├─		非必须		1:链接推广 2:应用推广 3:快应用推广
├─ flowSceneList	string []	非必须		流量场景集合	item 类型: string
├─		非必须		流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频等
├─ planIds	string []	非必须		计划id集合	item 类型: string
├─		非必须
├─ filter_zero	integer	非必须		是否过滤真实消耗等于0的数据，1：过滤； 其余不过滤
├─ adIds	string []	非必须		广告id集合	item 类型: string
├─		非必须
├─ 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	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	非必须		回传拉活量
├─ convert_dp_price	integer	非必须		回传拉活均价（单位：分）
├─ 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_credit_nums	integer	非必须		dp应用内授信量
├─ dp_app_credit_price	integer	非必须		dp应用内授信均价（单位：分）
├─ dp_app_order_nums	integer	非必须		dp应用内下单量
├─ dp_app_order_price	integer	非必须		dp应用内下单均价（单位：分）
├─ dp_app_pay_nums	integer	非必须		dp应用内付费量
├─ dp_app_pay_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快应用
├─ flow_scene	string	非必须		流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频等
├─ 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	非必须		快应用付费均价（单位：分）

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。

请求参数示例：
{
  "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 WEEK MONTH ALL五个粒度具体支持到那个粒度和具体业务相关 取值如前 必须大写
paraMap	object	非必须		与业务相关的具体参数
├─ adGroupIds	string []	非必须		广告组ID集合	item 类型: string
├─		非必须
├─ extensionFlowList	string []	非必须		推广流量集合	item 类型: string
├─		非必须		1.全流量场景，2自由流量，3联盟流量
├─ extensionTypeList	string []	非必须		推广目标集合	item 类型: string
├─		非必须		1:链接推广 2:应用推广 3:快应用推广
├─ flowSceneList	string []	非必须		流量场景集合	item 类型: string
├─		非必须		流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频等
├─ planIds	string []	非必须		计划id集合	item 类型: string
├─		非必须
├─ filter_zero	integer	非必须		是否过滤真实消耗等于0的数据，1：过滤； 其余不过滤
├─ adIds	string []	非必须		广告id集合	item 类型: string
├─		非必须
├─ 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 广告明细数据总量查询-子客户”进行获取。

请求参数示例：
{
  "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 WEEK MONTH ALL五个粒度具体支持到那个粒度和具体业务相关 取值如前 必须大写
page	integer	非必须	1	分页起始
pageCount	integer	非必须	10	分页大小
paraMap	object	非必须		与业务相关的具体参数
├─ adGroupIds	string []	非必须		广告组ID集合	item 类型: string
├─		非必须
├─ extensionFlowList	string []	非必须		推广流量集合	item 类型: string
├─		非必须		1.全流量场景，2自由流量，3联盟流量
├─ extensionTypeList	string []	非必须		推广目标集合	item 类型: string
├─		非必须		1:链接推广 2:应用推广 3:快应用推广
├─ flowSceneList	string []	非必须		流量场景集合	item 类型: string
├─		非必须		流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频等
├─ planIds	string []	非必须		计划id集合	item 类型: string
├─		非必须
├─ filter_zero	integer	非必须		是否过滤真实消耗等于0的数据，1：过滤； 其余不过滤
├─ adIds	string []	非必须		广告id集合	item 类型: string
├─		非必须
├─ 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 []	非必须			item 类型: 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	非必须		回传拉活量
├─ convert_dp_price	integer	非必须		回传拉活均价（单位：分）
├─ 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_credit_nums	integer	非必须		dp应用内授信量
├─ dp_app_credit_price	integer	非必须		dp应用内授信均价（单位：分）
├─ dp_app_order_nums	integer	非必须		dp应用内下单量
├─ dp_app_order_price	integer	非必须		dp应用内下单均价（单位：分）
├─ dp_app_pay_nums	integer	非必须		dp应用内付费量
├─ dp_app_pay_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快应用
├─ flow_scene	string	非必须		流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频等
├─ 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	非必须		快应用付费均价（单位：分）

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}

请求参数示例：
{
  "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	时间粒度 聚合粒度 有HOUR DAY WEEK MONTH ALL五个粒度具体支持到那个粒度和具体业务相关 取值如前 必须大写 此业务可不填
paraMap	object	非必须		与业务相关的具体参数
├─ adGroupIds	string []	非必须		广告组ID集合	item 类型: string
├─		非必须
├─ extensionFlowList	string []	非必须		推广流量集合	item 类型: string
├─		非必须		1.全流量场景，2.自有流量，3联盟流量
├─ planIds	string []	非必须		计划id集合	item 类型: string
├─		非必须
├─ adIds	string []	非必须		广告id集合	item 类型: string
├─		非必须
├─ appIdList	string []	非必须		应用集合，如果要查各个应用明细数据，则orderByColumns需要添加app_id	item 类型: string
├─		非必须
├─ app_id	string	非必须		应用id
├─ app_name	string	非必须		支持模糊查询应用名称
├─ flowSceneList	string []	非必须		流量场景集合	item 类型: string
├─		非必须		流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频等
├─ 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 小游戏明细数据总量查询-子客户”进行获取。

请求参数示例：
{
  "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	时间粒度 聚合粒度 有HOUR DAY WEEK MONTH ALL五个粒度具体支持到那个粒度和具体业务相关 取值如前 必须大写 此业务可不填
page	integer	非必须	1	分页起始
pageCount	integer	非必须	10	分页大小，最大500
paraMap	object	非必须		与业务相关的具体参数
├─ adGroupIds	string []	非必须		广告组ID集合	item 类型: string
├─		非必须
├─ extensionFlowList	string []	非必须		推广流量集合	item 类型: string
├─		非必须		1.全流量场景，2.自有流量，3联盟流量
├─ planIds	string []	非必须		计划id集合	item 类型: string
├─		非必须
├─ adIds	string []	非必须		广告id集合	item 类型: string
├─		非必须
├─ appIdList	string []	非必须		应用集合，如果要查各个应用明细数据，则orderByColumns需要添加app_id	item 类型: string
├─		非必须
├─ app_id	string	非必须		应用id
├─ app_name	string	非必须		支持模糊查询应用名称
├─ flowSceneList	string []	非必须		流量场景集合	item 类型: string
├─		非必须		流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频等
├─ 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 []	非必须			item 类型: 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激励视频等
├─ 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	integer	非必须		内购ROI1（单位：元）
├─ inter_buy_roi3	integer	非必须		内购ROI3（单位：元）
├─ inter_buy_roi7	integer	非必须		内购ROI7（单位：元）
├─ inter_buy_roi30	integer	非必须		内购ROI30（单位：元）
├─ inter_buy_pay	integer	非必须		内购付费流水（单位：分）
├─ acc_cost	integer	非必须		卖扣金额（单位：分）
├─ ecpm	integer	非必须		小数
├─ click_price	integer	非必须		点击均价（单位：分）
├─ active_cost	integer	非必须		新增用户成本（单位：分）
├─ new_user_buy_ltv1	integer	非必须		广告变现LTV1（单位：分）
├─ new_user_buy_ltv3	integer	非必须		广告变现LTV3（单位：分）
├─ new_user_buy_ltv7	integer	非必须		广告变现LTV7（单位：分）
├─ new_user_buy_ltv30	integer	非必须		广告变现LTV30，小数
├─ pay_cost	string	非必须		付费成本（单位：分）
├─ inter_buy_ltv1	integer	非必须		内购LTV1（单位：分）
├─ inter_buy_ltv3	integer	非必须		内购LTV3（单位：分）
├─ inter_buy_ltv7	integer	非必须		内购LTV7（单位：分）
├─ inter_buy_ltv30	integer	非必须		内购LTV30（单位：分）
├─ ltv1_pay	string	非必须		新增用户首日产生的分成前内购收入（单位：分）

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}

请求参数示例：
{
  "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 WEEK MONTH ALL五个粒度具体支持到那个粒度和具体业务相关 取值如前 必须大写 此业务支持HOUR,DAY粒度查询，默认按天粒度
page	integer	非必须	1	分页起始
pageCount	integer	非必须	10	分页大小，最大500
paraMap	object	非必须		与业务相关的具体参数
├─ adGroupIds	string []	非必须		广告组ID集合	item 类型: string
├─		非必须
├─ extensionFlowList	string []	非必须		推广流量集合	item 类型: string
├─		非必须		1.全流量场景，2自由流量，3联盟流量
├─ planIds	string []	非必须		计划id集合	item 类型: string
├─		非必须
├─ adIds	string []	非必须		广告id集合	item 类型: string
├─		非必须
├─ appIdList	string []	非必须		应用集合，如果要查各个应用明细数据，则orderByColumns需要添加app_id	item 类型: string
├─		非必须
├─ flowSceneList	string []	非必须		流量场景集合	item 类型: string
├─		非必须		0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频等
├─ 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 游戏实时明细数据总量查询-子客户”进行获取。

请求参数示例：
{
  "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"
}]
}
}

请求参数

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 WEEK MONTH ALL五个粒度具体支持到那个粒度和具体业务相关 取值如前 必须大写 此业务支持HOUR,DAY粒度查询，默认按天粒度
page	integer	非必须	1	分页起始
pageCount	integer	非必须	10	分页大小，最大500
paraMap	object	非必须		与业务相关的具体参数
├─ adGroupIds	string []	非必须		广告组ID集合	item 类型: string
├─		非必须
├─ extensionFlowList	string []	非必须		推广流量集合	item 类型: string
├─		非必须		1.全流量场景，2自由流量，3联盟流量
├─ planIds	string []	非必须		计划id集合	item 类型: string
├─		非必须
├─ adIds	string []	非必须		广告id集合	item 类型: string
├─		非必须
├─ appIdList	string []	非必须		应用集合，如果要查各个应用明细数据，则orderByColumns需要添加app_id	item 类型: string
├─		非必须
├─ flowSceneList	string []	非必须		流量场景集合	item 类型: string
├─		非必须		0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频等
├─ 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 []	非必须			item 类型: 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	非必须		点击率,小数
├─ convertDpsPrice	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	非必须		回传拉活量
├─ convert_register	integer	非必须		回传注册量
├─ convert_register_price	integer	非必须		回传注册均价（单位：分）
├─ convert_retention	integer	非必须		回传次留量
├─ convert_retention_price	integer	非必须		回传次留均价（单位：分）
├─ cost	integer	非必须		实扣（单位：分）
├─ download	integer	非必须		下载量
├─ download_price	integer	非必须		下载均价（单位：分）
├─ download_rate	integer	非必须		下载率，小数
├─ ecpm	integer	非必须
├─ expose	integer	非必须		曝光量
├─ extension_flow	string	非必须		推广流量：0默认值无意义，1全流量，2自有流量，3联盟流量
├─ extension_type	string	非必须		推广类型：1链接推广，2应用推广，3快应用
├─ flow_scene	string	非必须		流量场景:0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频等
├─ form_cnt	integer	非必须		表单量
├─ form_price	integer	非必须		表单均价（单位：分）
├─ ftime	integer	非必须		数据记录时间戳
├─ game_activate	integer	非必须		平台激活人数
├─ game_activate_price	integer	非必须		平台激活均价（单位：分）
├─ game_activate_rate	integer	非必须		平台激活率，小数
├─ game_new_pay	integer	非必须		游戏新增付费用户数
├─ game_new_pay_price	integer	非必须		游戏新增付费均价（单位：分）
├─ game_new_pay_rate	integer	非必须		游戏新增付费率，小数
├─ game_register	integer	非必须		游戏注册人数
├─ game_register_price	integer	非必须		游戏注册均价（单位：分）
├─ game_register_rate	integer	非必须		游戏注册率，小数
├─ global_spec_id	string	非必须		统一规格id
├─ owner_id	string	非必须		广告主id
├─ owner_name	string	非必须		广告主名称
├─ plan_id	string	非必须		计划id
├─ plan_name	string	非必须		计划名称

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

基本信息

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

Method： POST

接口描述：

请求参数示例：
{
   "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"
}
}

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
orderByColumns	string	非必须		正序逆序 可取值 ASC DESC两种 不可取其他值 支持大小写 建议：ftime
ascDesc	string	非必须	DESC	正序逆序 可取值 ASC DESC两种 不可取其他值 必须大写 建议配合orderByColumns一起使用， 如orderByColumns: "ftime",ascDesc: "DESC"
timeLevel	string	非必须	DAY	时间粒度 聚合粒度 有HOUR DAY WEEK MONTH ALL五个粒度取值如前 必须大写 汇总查询可不传
page	integer	非必须	1	分页起始
pageCount	integer	非必须	10	分页大小，最大500
paraMap	object	非必须		与业务相关的具体参数
├─ adGroupIds	string []	非必须		广告组ID集合	item 类型: string
├─		非必须
├─ extensionFlowList	string []	非必须		推广流量集合	item 类型: string
├─		非必须		1.全流量场景，2自由流量，3联盟流量
├─ planIds	string []	非必须		计划id集合	item 类型: string
├─		非必须
├─ adIds	string []	非必须		广告id集合	item 类型: string
├─		非必须
├─ appIdList	string []	非必须		应用集合，如果要查各个应用明细数据，则orderByColumns需要添加app_id	item 类型: string
├─		非必须
├─ flowSceneList	string []	非必须		流量场景集合	item 类型: string
├─		非必须		0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频等
├─ 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	integer	必须		点击均价（单位：元）
├─ click_rate	integer	必须		点击率，小数
├─ convertDpsPrice	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	必须		回传拉活量
├─ convert_register	integer	必须		回传注册量
├─ convert_register_price	integer	必须		回传注册均价（单位：元）
├─ convert_retention	integer	必须		回传次留量
├─ convert_retention_price	integer	必须		回传次留均价（单位：元）
├─ cost	integer	必须		实扣（单位：元）
├─ download	integer	必须		下载量
├─ download_price	integer	必须		下载均价（单位：元）
├─ download_rate	integer	必须		下载率，小数
├─ ecpm	integer	必须
├─ expose	integer	必须		曝光量
├─ extension_flow	string	必须		推广流量：0默认值无意义，1全流量，2自有流量，3联盟流量
├─ extension_type	string	必须		推广类型：1链接推广，2应用推广，3快应用
├─ flow_scene	string	必须		流量场景:0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频等
├─ form_cnt	integer	必须		表单量
├─ form_price	integer	必须		表单均价（单位：元）
├─ ftime	integer	必须		数据记录时间戳
├─ game_activate	integer	必须		平台激活人数
├─ game_activate_price	integer	必须		平台激活均价（单位：元）
├─ game_activate_rate	integer	必须		平台激活率，小数
├─ game_new_pay	integer	必须		游戏新增付费用户数
├─ game_new_pay_price	integer	必须		游戏新增付费均价（单位：元）
├─ game_new_pay_rate	integer	必须		游戏新增付费率，小数
├─ game_register	integer	必须		游戏注册人数
├─ game_register_price	integer	必须		游戏注册均价（单位：元）
├─ game_register_rate	integer	必须		游戏注册率，小数
├─ global_spec_id	string	必须		统一规格id
├─ owner_id	string	必须		广告主id
├─ owner_name	string	必须		广告主名称
├─ plan_id	string	必须		计划id
├─ plan_name	string	必须		计划名称

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

基本信息

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

Method： POST

接口描述：

请求参数示例：
{
  "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	时间粒度 聚合粒度 有HOUR DAY WEEK MONTH ALL五个粒度具体支持到那个粒度和具体业务相关 取值如前 必须大写 此业务支持DAY,WEEK,MONTH三个粒度查询 默认按DAY粒度查询
paraMap	object	非必须		与业务相关的具体参数
├─ adGroupIds	string []	非必须		广告组ID集合	item 类型: string
├─		非必须
├─ extensionFlowList	string []	非必须		推广流量集合	item 类型: string
├─		非必须		1.全流量场景，2自由流量，3联盟流量
├─ planIds	string []	非必须		计划id集合	item 类型: string
├─		非必须
├─ 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集合	item 类型: string
├─		非必须
├─ appIdList	string []	非必须		应用集合，如果要查各个应用明细数据，则orderByColumns需要添加app_id	item 类型: string
├─		非必须
├─ app_id	string	非必须		应用id
├─ app_name	string	非必须		支持模糊查询应用名称
├─ flowSceneList	string []	非必须		流量场景集合	item 类型: string
├─		非必须		0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频等

返回数据

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

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

基本信息

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

Method： POST

接口描述：

注：
1.如果想提高查询的响应速度，可以将参数"extra"设置为"skip_total"，使用该选项不会返回totalCount的值。如果需要该值的话，需要使用接口“6.9 游戏明细数据总量查询-子客户”进行获取。

请求参数示例：
{
  "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
}, {
"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"
}, {
"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"
}]
}
}

请求参数

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	时间粒度 聚合粒度 有HOUR DAY WEEK MONTH ALL五个粒度具体支持到那个粒度和具体业务相关 取值如前 必须大写 此业务支持DAY,WEEK,MONTH三个粒度查询 默认按DAY粒度查询
page	integer	非必须	1	分页起始
pageCount	integer	非必须	10	分页大小，最大500
paraMap	object	非必须		与业务相关的具体参数
├─ adGroupIds	string []	非必须		广告组ID集合	item 类型: string
├─		非必须
├─ extensionFlowList	string []	非必须		推广流量集合	item 类型: string
├─		非必须		1.全流量场景，2自由流量，3联盟流量
├─ planIds	string []	非必须		计划id集合	item 类型: string
├─		非必须
├─ 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集合	item 类型: string
├─		非必须
├─ appIdList	string []	非必须		应用集合，如果要查各个应用明细数据，则orderByColumns需要添加app_id	item 类型: string
├─		非必须
├─ app_id	string	非必须		应用id
├─ app_name	string	非必须		支持模糊查询应用名称
├─ flowSceneList	string []	非必须		流量场景集合	item 类型: string
├─		非必须		0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频等
├─ 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 []	非必须			item 类型: 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快应用
├─ 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激励视频等
├─ total_pay	number	非必须		广告用户总付费流水，分
├─ ad_new_ssoid	string	非必须		广告新增用户
├─ ad_new_pay_ssoid	string	非必须		广告新增付费用户
├─ ad_new_pay	string	非必须		广告新增付费（单位：分）
├─ down_cnt	string	非必须		下载次数（搜索&分发：实扣下载；信息流合联盟：总下载）
├─ expose_nums	integer	非必须		曝光数
├─ click_nums	integer	非必须		点击数
├─ click_rate	integer	非必须		点击率，小数
├─ down_rate	string	非必须		下载率，小数
├─ register_rate	string	非必须		注册率，小数
├─ register_price	string	非必须		注册成本
├─ new_pay_price	string	非必须		付费成本
├─ active_nums	integer	非必须		激活人数，通过买量下载最近180天激活的用户
├─ active_rate	integer	非必须		激活率，小数
├─ new_pay_rate	string	非必须		付费转化率，小数
├─ ad_price	string	非必须		广告实扣金额（单位：分）
├─ new_user_ltv1	integer	非必须		内购LVT1（单位：元）
├─ new_user_ltv3	integer	非必须		内购LVT3（单位：元）
├─ new_user_ltv7	integer	非必须		内购LVT7（单位：元）
├─ new_user_ltv30	integer	非必须		内购LVT30（单位：元）
├─ buy_user_income0	integer	非必须		当日活跃用户产生的广告变现流水（单位：分）
├─ inter_buy_roi1	integer	非必须		广告变现ROI1（单位：元）
├─ inter_buy_roi3	integer	非必须		广告变现ROI3（单位：元）
├─ inter_buy_roi7	integer	非必须		广告变现ROI7（单位：元）
├─ inter_buy_roi30	integer	非必须		广告变现ROI30（单位：元）
├─ new_user_roi1	string	非必须		内购ROI1（单位：元）
├─ new_user_roi3	string	非必须		内购ROI3（单位：元）
├─ new_user_roi7	string	非必须		内购ROI7（单位：元）
├─ new_user_roi30	string	非必须		内购ROI30（单位：元）
├─ ecpm	integer	非必须
├─ click_price	integer	非必须		点击均价（单位：分）
├─ down_price	string	非必须		下载成本（单位：分）
├─ active_price	string	非必须		激活成本（单位：分）
├─ inter_buy_ltv1	integer	非必须		广告变现LTV1（单位：分）
├─ inter_buy_ltv3	integer	非必须		广告变现LTV3（单位：分）
├─ inter_buy_ltv7	integer	非必须		广告变现LTV7（单位：分）
├─ inter_buy_ltv30	integer	非必须		广告变现LTV30（单位：分）
├─ 10per_total_pay	number	非必须		1-9分成付费流水（单位：分）
├─ 50per_total_pay	number	非必须		5-5分成付费流水（单位：分）

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}

请求参数示例：
{
  "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 WEEK MONTH ALL五个粒度具体支持到那个粒度和具体业务相关 取值如前 必须大写 同时支持查询离线跟实时数据，返回 开始时间跟结束时间跨越当日，实时数据（支持DAY粒度）+离线数据（支持DAY,WEEK,MONTH粒度），默认DAY
paraMap	object	非必须		与业务相关的具体参数
├─ adGroupIds	string []	非必须		广告组ID集合	item 类型: string
├─		非必须
├─ extensionFlowList	string []	非必须		推广流量集合	item 类型: string
├─		非必须		1.全流量场景，2自由流量，3联盟流量
├─ extensionTypeList	string []	非必须		推广目标集合	item 类型: string
├─		非必须		1:链接推广 2:应用推广 3:快应用推广
├─ flowSceneList	string []	非必须		流量场景集合	item 类型: string
├─		非必须		流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频等
├─ planIds	string []	非必须		计划id集合	item 类型: string
├─		非必须
├─ filter_zero	integer	非必须		是否过滤真实消耗等于0的数据，1：过滤； 其余不过滤
├─ adIds	string []	非必须		广告id集合	item 类型: string
├─		非必须
├─ 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 关键词明细数据总量查询-子客户”进行获取。

请求参数示例：
{
  "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 WEEK MONTH ALL五个粒度具体支持到那个粒度和具体业务相关 取值如前 必须大写 同时支持查询离线跟实时数据，返回 开始时间跟结束时间跨越当日，实时数据（支持DAY粒度）+离线数据（支持DAY,WEEK,MONTH粒度），默认DAY
page	integer	非必须	1	分页起始
pageCount	integer	非必须	10	分页大小,最大500
paraMap	object	非必须		与业务相关的具体参数
├─ adGroupIds	string []	非必须		广告组ID集合	item 类型: string
├─		非必须
├─ extensionFlowList	string []	非必须		推广流量集合	item 类型: string
├─		非必须		1.全流量场景，2自由流量，3联盟流量
├─ extensionTypeList	string []	非必须		推广目标集合	item 类型: string
├─		非必须		1:链接推广 2:应用推广 3:快应用推广
├─ flowSceneList	string []	非必须		流量场景集合	item 类型: string
├─		非必须		流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频等
├─ planIds	string []	非必须		计划id集合	item 类型: string
├─		非必须
├─ filter_zero	integer	非必须		是否过滤真实消耗等于0的数据，1：过滤； 其余不过滤
├─ adIds	string []	非必须		广告id集合	item 类型: string
├─		非必须
├─ groupByColumn	string	非必须		数据查询分组字段，参考keywords 其他字段可根据返回字段名类比，不可随意传递 可以进行分组的字段： plan_id，ad_group_id，ad_id，app_id 注意：设置了用该字段后，返回的数据时是已经经过聚合后的数据，所以只能关注该维度字段和指标字段的值，其他维度的值是随机的。
├─ extra	string	非必须		额外选项，可选： 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	integer	非必须		点击均价（单位：分）
├─ click_rate	integer	非必须		点击率，小数
├─ cost	integer	非必须		消耗（单位：分）
├─ download	integer	非必须		下载量
├─ download_price	integer	非必须		下载均价（单位：分）
├─ download_rate	integer	非必须		下载率，小数
├─ ecpm	integer	非必须
├─ expose	string	非必须		曝光量
├─ extension_flow	string	非必须		推广流量：0默认值无意义，1全流量场景、2自有流量、3联盟流量
├─ extension_type	string	非必须		1:链接推广 2:应用推广 3:快应用
├─ flow_scene	string	非必须		流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频等
├─ 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

接口描述：

请求参数示例：
{
  "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"
timeLevel	string	非必须	DAY	时间粒度 聚合粒度 有HOUR DAY WEEK MONTH ALL五个粒度具体支持到那个粒度和具体业务相关 取值如前 必须大写 同时支持查询离线跟实时数据，返回 开始时间跟结束时间跨越当日，实时数据（支持HOUR,DAY粒度）+离线数据（支持DAY,WEEK,MONTH粒度），默认DAY
page	integer	非必须	1	分页起始
pageCount	integer	非必须	10	分页大小,最大500
paraMap	object	非必须		与业务相关的具体参数
├─ adGroupIds	string []	非必须		广告组ID集合	item 类型: string
├─		非必须
├─ extensionFlowList	string []	非必须		推广流量集合	item 类型: string
├─		非必须		1.全流量场景，2自由流量，3联盟流量
├─ extensionTypeList	string []	非必须		推广目标集合	item 类型: string
├─		非必须		1:链接推广 2:应用推广 3:快应用推广
├─ flowSceneList	string []	非必须		流量场景集合	item 类型: string
├─		非必须		流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频等
├─ planIds	string []	非必须		计划id集合	item 类型: string
├─		非必须
├─ filter_zero	integer	非必须		是否过滤真实消耗等于0的数据，1：过滤； 其余不过滤
├─ adIds	string []	非必须		广告id集合	item 类型: string
├─		非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
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	integer	必须		点击均价（单位：分）
├─ click_rate	integer	必须		点击率，小数
├─ cost	integer	必须		消耗（单位：分）
├─ download	integer	必须		下载量
├─ download_price	integer	必须		下载均价（单位：分）
├─ download_rate	integer	必须		下载率
├─ ecpm	integer	必须
├─ expose	string	必须		曝光量
├─ extension_flow	string	必须		推广流量：0默认值无意义，1全流量场景、2自有流量、3联盟流量
├─ extension_type	string	必须		推广目的[1:链接推广 2:应用推广 3:快应用推广]
├─ flow_scene	string	必须		流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频等
├─ 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"

请求参数示例：
{
    "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
        ],
        "groupByColumn": "owner_id,sub_acc,extension_flow"
    }
}

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
endTime	integer	非必须		结束时间 不填的话默认是当天如20201001beginTime endTime须配合使用
timeLevel	string	非必须		时间粒度 聚合粒度 有HOUR DAY WEEK MONTH 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

返回数据

名称	类型	是否必须	默认值	备注	其他信息
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"

参数示例：
{
    "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
        ],
        "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	必须		时间粒度 聚合粒度 有HOUR DAY WEEK MONTH 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	非必须		额外选项，可选： skip_total，传入该值时，返回的数据中不再包含totalCount数据，可以提高查询响应速度

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须		状态码0请求正常1系统异常11001:服务端异常110000：参数错误110002：用户不存在或已过期，请重新登录110003：无效的接口查询路径110101：查询天数不合法，具体见msg110104：超过批量查询最大限制，默认500其余请看msg
data	object	非必须		数据
├─ totalCount	number	非必须		总条数
├─ itemCount	number	非必须		本次请求条数
├─ items	object []	非必须		返回数据的数组	item 类型: 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激励视频等
├─ company_name	string	必须		公司主体
├─ fdate	number	必须		日期，格式YYYYMMDD
├─ extension_type	string	必须		标的物类型[1:链接推广 2:应用推广 3:快应用]',
├─ 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"

参数示例：
{
    "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 WEEK MONTH ALL五个粒度具体支持到那个粒度和具体业务相关 取值如前 必须大写
paraMap	object	非必须		与业务相关的具体参数
├─ owner_type	integer	非必须		客户类型:0子客户,1一级代理商,2二级代理商,3三级代理商
├─ extensionTypeList	string	非必须		标的物类型[1:链接推广 2:应用推广 3:快应用]
├─ flowSceneList	string	非必须		流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频等
├─ 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 []	非必须		返回数据的数组	item 类型: 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激励视频等
├─ download	number	必须		下载数
├─ download_rate	number	必须		下载率
├─ ecpm	number	必须		千次曝光收益
├─ fdate	number	必须		日期，格式YYYYMMDD
├─ click_price	number	必须		点击单价
├─ extension_type	string	必须		标的物类型[1:链接推广2:应用推广 3:快应用]
├─ 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"

参数示例：
{
    "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 WEEK MONTH ALL五个粒度具体支持到那个粒度和具体业务相关 取值如前 必须大写
orderByColumns	string	非必须		数据排序字段，不传则按默认排序
ascDesc	string	非必须		正序逆序 可取值 ASC DESC两种 不可取其他值 支持大小写
paraMap	object	非必须		与业务相关的具体参数
├─ owner_type	integer	非必须		客户类型:0子客户,1一级代理商,2二级代理商,3三级代理商
├─ extensionTypeList	string	非必须		标的物类型[1:链接推广 2:应用推广 3:快应用]
├─ flowSceneList	string	非必须		流量场景：0默认值无意义、1全流量推广、2精选推广、3安装有礼、4开机必备、5搜索、6信息流、7Banner、8开屏、9插屏、10原生、11激励视频等
├─ 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 []	非必须		返回数据的数组	item 类型: 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激励视频等
├─ download	number	必须		下载数
├─ download_rate	number	必须		下载率
├─ ecpm	number	必须		千次曝光收益
├─ fdate	number	必须		日期，格式YYYYMMDD
├─ click_price	number	必须		点击单价，单位分
├─ extension_type	string	必须		标的物类型[1:链接推广2:应用推广 3:快应用]
├─ owner_type	number	必须		客户类型:0子客户,1一级代理商,2二级代理商,3三级代理商

7. 搜索关键词相关

7.1 查询行业类目

基本信息

Path： /v3/communal/searchKeyWord/listCategoryKws

Method： POST

接口描述：

curl -X POST
https://e.oppomobile.com/v3/communal/searchKeyWord/listCategoryKws
-H 'Content-Type: application/x-www-form-urlencoded'
-d 'categoryId=10000'

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

返回数据：

{
    "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	text	否	10000	行业类目ID，categoryId=0或为空表示查询根目录，否则查询指定的层级目录

返回数据

名称	类型	是否必须	默认值	备注	其他信息
	object []	非必须			item 类型: 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

接口描述：

curl -X POST
https://e.oppomobile.com/v3/communal/searchKeyWord/listPremiumKws
-H 'Content-Type: application/x-www-form-urlencoded'
-d 'adGroupId=300582205&sourceSet=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 []	非必须			item 类型: 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

接口描述：

curl -X POST
https://e.oppomobile.com/v3/communal/searchKeyWord/listGroupKwPkg
-H 'Content-Type: application/x-www-form-urlencoded'
-d '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 []	非必须			item 类型: 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

接口描述：

curl -X POST
https://e.oppomobile.com/v3/communal/searchKeyWord/addCustomOrNoPkg
-H 'Content-Type: application/x-www-form-urlencoded'
-d '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

接口描述：

curl -X POST
https://e.oppomobile.com/v3/communal/searchKeyWord/deleteKwInPkg
-H 'Content-Type: application/x-www-form-urlencoded'
-d '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

接口描述：

curl -X POST
https://e.oppomobile.com/v3/communal/searchKeyWord/addKwToPkg
-H 'Content-Type: application/x-www-form-urlencoded'
-d '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

接口描述：

curl -X POST
https://e.oppomobile.com/v3/communal/searchKeyWord/editCustomOrNoPkg
-H 'Content-Type: application/x-www-form-urlencoded'
-d '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

接口描述：

curl -X POST
https://e.oppomobile.com/v3/communal/searchKeyWord/batchDeleteKwPkg
-H 'Content-Type: application/x-www-form-urlencoded'
-d '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

接口描述：

curl -X POST
https://e.oppomobile.com/v3/communal/searchKeyWord/addGroupKw
-H 'Content-Type: application/x-www-form-urlencoded'
-d 'adGroupId=12342344&searchKeywords[0].keyword=testKeyword&searchKeywords[0].matchType=1&searchKeywords[0].price=100&categoryPackages[0].categoryId=34745958&categoryPackages[0].matchType=3&categoryPackages[0].price=200&customOrNoPackages[0].kwPackageId=98978682&customOrNoPackages[0].price=3000'

返回数据：

{
    "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
categoryPackages[0].categoryId	否		行业类目ID
categoryPackages[0].matchType	否		匹配类型 1：精准匹配，2：词组匹配，3：模糊匹配，默认值为1
categoryPackages[0].price	否		行业类目在广告组出价
customOrNoPackages[0].kwPackageId	否		词包ID
customOrNoPackages[0].price	否		词包在广告组出价，只有自定义词包才能设置出价

返回数据

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

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

基本信息

Path： /v3/communal/searchKeyWord/deleteGroupKw

Method： POST

接口描述：

curl -X POST
https://e.oppomobile.com/v3/communal/searchKeyWord/deleteGroupKw
-H 'Content-Type: application/x-www-form-urlencoded'
-d '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

接口描述：

curl -X POST
https://e.oppomobile.com/v3/communal/searchKeyWord/editGroupKw
-H 'Content-Type: application/x-www-form-urlencoded'
-d 'adGroupId=12342344&searchKeywords[0].keyword=testKeyword&searchKeywords[0].kwPackageId=789899879882&searchKeywords[0].matchType=1&searchKeywords[0].price=100&categoryPackages[0].categoryId=34745958&categoryPackages[0].kwPackageId=978868767873&categoryPackages[0].matchType=3&categoryPackages[0].price=200&customPackages[0].id=98978682&customPackages[0].price=3000'

返回数据：

{
    "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].matchType	否		关键词匹配类型 1：精准匹配，2：词组匹配，3：模糊匹配，默认值为1
categoryPackages[0].categoryId	否		行业类目ID
categoryPackages[0].kwPackageId	否		词包ID
categoryPackages[0].price	否		行业类目在广告组出价
categoryPackages[0].matchType	否		关键词匹配类型 1：精准匹配，2：词组匹配，3：模糊匹配，默认值为1
customPackages[0].id	否		自定义词包绑定关系id
customPackages[0].price	否		词包在广告组出价，只有自定义词包才能设置出价

返回数据

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

7.12 获取账户下的所有词包

基本信息

Path： /v3/communal/searchKeyWord/queryKwPackageByOwner

Method： POST

接口描述：

curl -X POST
https://e.oppomobile.com/v3/communal/searchKeyWord/queryKwPackageByOwner
-H 'Content-Type: application/x-www-form-urlencoded'
-d 'kwPackageType=2'

返回数据：

{
    "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 []	非必须		返回数据	item 类型: 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

接口描述：

curl -X POST
https://e.oppomobile.com/v3/communal/searchKeyWord/queryKwByPackageId
-H 'Content-Type: application/x-www-form-urlencoded'
-d '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 []	非必须		返回数据	item 类型: 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

接口描述：

（代理商+管理员权限运营）

查询所有子客户和次级代理商
请求示例：
curl --location --request POST 'https://sapi-ads-test.wanyol.com/v2/communal/agency/customer/list'
--header 'Authorization: Bearer MTEwMDA0NzQ0OCx6ZW5nanVhbiwxNjI2ODY5NDE3LGE2ZmQxMDE2NWYxZDkxZjhlNjJmZjI0ZmI4OTM1NzBlZDI3ZmFiZWM='
--header 'Content-Type: application/x-www-form-urlencoded'
--data-urlencode 'page=1'
--data-urlencode 'pageCount=1'

响应报文
{
    "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 []	非必须			item 类型: object
├─ ownerId	integer	非必须		广告主ID
├─ ownerName	string	非必须		广告主名称
├─ ownerType	integer	非必须		广告主类型
├─ loginAcc	string	非必须		账务ID
├─ auditStatus	integer	非必须		审核状态
├─ insertTime	integer	非必须		创建时间(秒)
├─ updateTime	integer	非必须		更新时间(秒)
├─ openId	string	非必须		第三方Id
├─ 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	非必须		昨日消耗

8.2 广告主权限查询

基本信息

Path： /v2/communal/auth/query

Method： POST

接口描述：

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

请求示例：
curl --location --request POST 'https://sapi-ads-test.wanyol.com/v2/communal/auth/query'
--header 'Authorization: Bearer MTEwMDA0NzQ0OCx6ZW5nanVhbiwxNjI2ODY5NDE3LGE2ZmQxMDE2NWYxZDkxZjhlNjJmZjI0ZmI4OTM1NzBlZDI3ZmFiZWM='
--header 'Content-Type: application/x-www-form-urlencoded'
--data-urlencode 'loginType=1'

相应报文
{
    "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 []	非必须		菜单权限	item 类型: string
├─		非必须
├─ dataTree	string []	非必须		数据权限	item 类型: string
├─		非必须

8.3 账务流水查询

基本信息

Path： /v2/communal/finance/billHis

Method： POST

接口描述：

账务流水
财务流水
请求示例：
curl --location --request POST 'https://sapi-ads-test.wanyol.com/v2/communal/finance/billHis'
--header 'Authorization: Bearer MTEwMDA0NzQ0OCx6ZW5nanVhbiwxNjI2ODY5OTQyLGE4NGY2ZmViY2RjOWY5ZjVkN2Y1YTE1MzRmYzBkYjAxZWE2OWFjNzE='
--header 'Content-Type: application/x-www-form-urlencoded'
--data-urlencode 'page=1'
--data-urlencode 'pageCount=2'
--data-urlencode '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	查询开始时间 开始时间
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:广告主
page	是	0	当前页
pageCount	是	0	一页个数
loginType	是	0	登陆类型1-代理商登录；2- 代理商登录子账号； 3-子账号自己登录；4-直客登录

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须
msg	string	非必须
data	object	非必须
├─ totalCount	integer	非必须
├─ itemCount	integer	非必须
├─ items	object []	非必须			item 类型: 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

接口描述：

用户基础信息接口

请求示例：
curl --location --request POST 'https://sapi-ads-test.wanyol.com/v2/communal/owner/info'
--header 'Authorization: Bearer MTEwMDA0NzM3NSx6ZW5nanVhbiwxNjI2ODcwMjk1LGY1NzhmNTA5MjVmNjEyMWU2OTA4NGRlMTJiMGZlODQ0YjAxZjJhYTc='
--header 'Content-Type: application/x-www-form-urlencoded'

响应报文
{
    "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

接口描述：

从账户或者直客 账务情况

curl --location --request POST 'https://sapi-ads-test.wanyol.com/v2/communal/owner/balance'
--header 'Authorization: Bearer MTEwMDA0NzM3NSx6ZW5nanVhbiwxNjI2ODcwMzg2LDVmMjhlYjM1NTE5NDBhMGVkNThhMGNiYTUxNzQ0YTA0YzkyMDAxYzk='
--header 'Content-Type: application/x-www-form-urlencoded'

{
    "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)
请求示例
curl --location --request POST 'https://sapi-ads-test.wanyol.com/v2/communal/owner/setAccDayBudget'
--header 'Authorization: Bearer MTEwMDA0NzM3NSx6ZW5nanVhbiwxNjI2ODcwMzg2LDVmMjhlYjM1NTE5NDBhMGVkNThhMGNiYTUxNzQ0YTA0YzkyMDAxYzk='
--header 'Content-Type: application/x-www-form-urlencoded'
--data-urlencode '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

接口描述：

代理商账务情况 - 包含总余额,各个子账户余额以及预算

代理商、以及具备管理权权限的运营调用

请求示例：
curl --location --request POST 'https://sapi-ads-test.wanyol.com/v2/communal/agency/balance'
--header 'Authorization: Bearer MTEwMDA0NzQ0OCx6ZW5nanVhbiwxNjI2OTE2MDgyLDUzNmNjZDZhOGEyYTk5NzM1MmViN2VhNDA0YzM4NmZlNjhjNWEwNmQ='
--header 'Content-Type: application/x-www-form-urlencoded'

响应示例：
{
    "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

接口描述：

代理商基础信息接口
请求示例
curl --location --request POST 'https://sapi-ads-test.wanyol.com/v2/communal/agency/info'
--header 'Authorization: Bearer MTEwMDA0NzQ0OCx6ZW5nanVhbiwxNjI2OTE2MDgyLDUzNmNjZDZhOGEyYTk5NzM1MmViN2VhNDA0YzM4NmZlNjhjNWEwNmQ='
--header 'Content-Type: application/x-www-form-urlencoded'

响应示例：
{
    "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

接口描述：

账务流水导出

请求示例
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

接口描述：

获取有效动态词通配符

请求参数

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 []	非必须		当前数据	item 类型: 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 []	非必须			item 类型: 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用于新建创意

请求示例：
curl --location --request POST 'http://sapi.ads.heytapmobi.com/v3/creative/material/communal/upload'
--header 'Content-Type: multipart/form-data'
--header 'Authorization: Bearer MTM4NDA1NDI0LDdiNDM4ZWM4YzhhNDQyOTM5ZTQxYjc2OTNmN2I2ZjJhLDE2MjU3OTY0NjksMzhlMGE3OWZkNDYyZDEyOGMyMDA3MzVlODE0YjRiZGIyZmYxZGY4Ng=='
--form 'files=@"/F:/4s.mp4"'
--form 'matSpecId="60"'

响应：
{
    "code": 0,
    "data": {
        "url": "https://adsfs.heytapimage.com/ads-material-depot/video/1dfb03215c47bf738c82747cef8f930c.mp4",
        "id": 43312306,
        "coverUrl": "https://adsfs.heytapimage.com/ads-material-depot/video/1dfb03215c47bf738c82747cef8f930c_thumb.jpg"
    }
}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	multipart/form-data	是

Body

参数名称	参数类型	是否必须	示例	备注
files	file	是		支持文件格式限目前所有规格里的格式（jpg/jpeg/png/mp4）
matSpecId	text	是		取自对应广告创意的规格id即globalSpecId字段
picType	text	否		指示图片字段的名称，默认取全部图片类型。支持的取值包括：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

接口描述：

请求示例：
curl --location --request GET 'http://sapi.ads.heytapmobi.com/v3/creative/material/communal/query?pageSize=1&pageNum=1'
--header 'Authorization: Bearer MTM4NDA1NDI0LDdiNDM4ZWM4YzhhNDQyOTM5ZTQxYjc2OTNmN2I2ZjJhLDE2MjU3OTY0NjksMzhlMGE3OWZkNDYyZDEyOGMyMDA3MzVlODE0YjRiZGIyZmYxZGY4Ng=='

响应：
{
    "code": 0,
    "data": {
        "items": [
            {
                "id": 43306095,
                "ownerId": 138405424,
                "openMaterialId": "16c3d6209be4c611e18cc8886ac21c10",
                "materialName": "156d68f4953f0e8ec60dde920e4a6471.jpg",
                "materialUrl": "https://adsfs.heytapimage.com/ads-material-depot/image/272a4bef140084e783caffb3827a74dc.jpg",
                "coverUrl": "",
                "width": 320,
                "height": 210,
                "type": 1,
                "suffix": "jpg",
                "uploadWay": 1,
                "size": 11704,
                "duration": 0,
                "md5": "16c3d6209be4c611e18cc8886ac21c10",
                "extJson": "",
                "insertTime": 1625742540,
                "updateTime": 0,
                "deleteFlag": 0,
                "webpMd5": "",
                "webpMUrl": null,
                "compressedUrl": "",
                "compressedMd5": "",
                "compressedSize": 0
            }
        ],
        "totalCount": 587,
        "itemCount": 1
    }
}

请求参数

Query

参数名称	是否必须	示例	备注
id	否		素材id
materialName	否		素材名称，支持模糊查询
width	否		素材宽度
height	否		素材宽度
aspectRatio	否	16:9	宽高比
aspectRatios	否	[“16:0”, “9:16”]	多个宽高比，按数组形式传递
size	否	1024768	素材大小，单位字节
duration	否		视频素材最大时长，单位秒
type	否	2	1-图片, 2-视频 默认按图片查询
suffixes	否	["jpg", "png"]	素材文件后缀名，按数组形式传递
pageNum	否		默认1，最大10
pageSize	否		默认10，最大100

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	必须		0-成功 | 其他-失败
msg	string	非必须		失败时提示错误信息
data	object	必须
├─ itemCount	number	必须		返回结果数量
├─ totalCount	number	必须		符合当前查询条件的全部素材数量
├─ items	object []	必须			item 类型: 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	必须
├─ ownerId	number	必须

10.4 创意中心-上传素材到素材库

基本信息

Path： /v3/creative/material/communal/uploadDepot

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	multipart/form-data	是

Body

参数名称	参数类型	是否必须	示例	备注
file	file	是		图片或视频文件，暂不支持互动素材

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	必须
msg	string	非必须
data	object	非必须
├─ id	number	必须
├─ url	string	必须
├─ coverUrl	string	非必须

11. 规格相关

11.1 查询规格列表

基本信息

Path： /v3/communal/spec/list

Method： POST

接口描述：

根据条件查询获取规格列表

请求参数

Headers

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

Query

参数名称	是否必须	示例	备注
extensionType	是	0	推广类型 1.链接推广 2.应用推广 3.快应用
extensionFlow	是	0	推广流量 1.全流量场景 2.自有流量 3.联盟流量
flowScene	是	0	流量场景 1.全流量场景 2.精选推广 3.安装有礼 4.开机必备 5.搜索 6.信息流 7.banner 8.开屏 9.插屏 10.原生 11.激励视频 12.通投类型 20.品牌

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须
msg	string	非必须
data	object []	非必须			item 类型: object
├─ mSpecName	string	非必须		规格名称
├─ extensionType	integer	非必须		推广类型
├─ flowScene	integer	非必须		流量场景
├─ globalSpecId	integer	非必须		全局规格id
├─ format	string	非必须		规格详情JSON字符串 一、外层字段： TitleFmt title;// 标题格式要求 DescFmt desc;// 描述格式要求 BdNameFmt bdName;// 品牌名称格式要求 List videoList;// 视频格式要求 List imgs;// 图片格式要求集合 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：不校验 示例：{"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"]}]} *
├─ demoUrl	string	非必须		demoUrl
├─ required	string	非必须		指定相关字段是否必填描述 1-必填，2-选填，其他-隐藏 示例：{"videoList":1,"videoImg":1,"title":1,"bdName":1,"brandLogo":1}

12. 落地页相关

12.1 查询建站落地页

基本信息

Path： /v2/communal/ad/sparkPageNew/list

Method： POST

接口描述：

请求参数

Headers

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

Query

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

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须
msg	string	非必须
data	object []	非必须			item 类型: 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

接口描述：

请求参数

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 []	非必须			item 类型: 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 创建定向

基本信息

Path： /v2/communal/target/add

Method： POST

接口描述：

创建定向
/**
* 创建定向
* @link AdsTargetVo
* @param vo 参数.
* @return 新增结果, 包含定向ID.
* @throws Exception
*/

请求参数

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
mobilePrice	否		机型价格： 1:0-1000 2:1000-1999 3:2000-2999 3:>3000
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
├─ mobilePrice	string	非必须		机型价格： 1:0-1000 2:1000-1999 3:2000-2999 3:>3000
├─ 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:创建不可编辑定向(无法编辑的定向)	mock: @integer(0,1)
├─ type	integer	必须		定向类型1:普通定向包2:IMEI人群定向包 6:电话包 11:OAID	mock: @integer(1,11)
├─ 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.2 获取定向详情

基本信息

Path： /v2/communal/target/get

Method： GET

接口描述：

获取定向详情
/**
* 获取定向详情
* @param targetForm 定向ID
* @return
* @throws Exception
/

请求参数

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:创建不可编辑定向(无法编辑的定向)	mock: @integer(0,1)
├─ type	integer	必须		定向类型1:普通定向包2:IMEI人群定向包 6:电话包 11:OAID	mock: @integer(1,11)
├─ 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.3 删除定向

基本信息

Path： /v2/communal/target/del

Method： GET

接口描述：

删除定向
/**
* 删除定向
* @return
* @throws Exception
/

请求参数

Query

参数名称	是否必须	示例	备注
id	是	0	定向id
ownerId	否		子账户ID 直客和子客户非必填；代理商使用必填，用于指定查询某个子客户

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须
msg	string	非必须
data	integer	非必须

13.4 更新定向

基本信息

Path： /v2/communal/target/update

Method： POST

接口描述：

更新定向
/**
* 更新定向
* @param vo
* @return
* @throws Exception
*/

请求参数

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
mobilePrice	否		机型价格： 1:0-1000 2:1000-1999 3:2000-2999 3:>3000
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
├─ 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:创建不可编辑定向(无法编辑的定向)	mock: @integer(0,1)
├─ type	integer	必须		定向类型1:普通定向包2:IMEI人群定向包 6:电话包 11:OAID	mock: @integer(1,11)
├─ 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.5 获取定向列表

基本信息

Path： /v2/communal/target/list

Method： POST

接口描述：

获取定向列表
/**
* 获取定向列表
* @param param 删除标识.
* @return
* @throws Exception
*/

请求参数

Headers

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

Body

参数名称	参数类型	是否必须	示例	备注
ownerId	text	否	0	子账户ID 直客和子客户非必填；代理商使用必填，用于指定查询某个子客户
delStatus	text	否	0	删除状态：0, 正常；1,删除。
version	text	否	0	1-原始版本.2-V2
type	text	否	0	指定单个定向、人群包类型：1:普通定向，2:普通人群包，3:扩展人群包，4:运算人群包（人群交并），5:效果人群包，6:电话包。
types	text	否		指定多个定向、人群包类型，格式：type1,type2,type3，例如：2,3,4,5,6。 1:普通定向，2:普通人群包，3:扩展人群包，4:运算人群包（人群交并），5:效果人群包，6:电话包。
bizType	text	否	0	业务过滤条件
immutable	text	否	0	不可修改条件
pTargetId	text	否	0	父定向ID.
showType	text	否	0	展示类型
extensionType	text	否	0	推广目的
flowScene	text	否	0	流量场景
showType	text	否		showType推广样式,从广告组上获取

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须
msg	string	非必须
data	object []	非必须		返回数据对象为空，可能是没有相应权限权限	item 类型: 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:创建不可编辑定向(无法编辑的定向)	mock: @integer(0,1)
├─ type	integer	必须		定向类型1:普通定向包2:IMEI人群定向包 6:电话包 11:OAID	mock: @integer(1,11)
├─ 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 定向App元数据接口

基本信息

Path： /v2/communal/target/get/metadata/app/list

Method： GET

接口描述：

定向App元数据接口
/**
* 定向App元数据接口
* @return response包含元数据
* @throws Exception 错误信息
*/

请求参数

Query

参数名称	是否必须	示例	备注
extensionType	否	0	推广目的
flowScene	否	0	流量场景
ownerId	否		子账户ID 直客和子客户非必填；代理商使用必填，用于指定查询某个子客户
showType	否		showType推广样式,从广告组上获取

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须
msg	string	非必须
data	object	非必须
├─ apps	object []	非必须		app列表	item 类型: object
├─ id	integer	非必须		应用ID
├─ name	string	必须		应用名称

13.7 获取元数据

基本信息

Path： /v2/communal/target/get/metadata

Method： GET

接口描述：

查询定向元数据接口,定向相关数据&用户权限
/**
* 查询定向元数据接口,定向相关数据&用户权限
* @return response包含元数据
* @throws Exception 错误信息
*/

请求参数

Query

参数名称	是否必须	示例	备注
extensionType	否	0	推广目的
flowScene	否	0	流量场景
ownerId	否		子账户ID 直客和子客户非必填；代理商使用必填，用于指定查询某个子客户
showType	否		showType推广样式,从广告组上获取

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须
msg	string	非必须
data	object	非必须
├─ appCats	object []	非必须		app分类.	item 类型: object
├─ id	integer	必须		ID
├─ level	string	必须		等级
├─ name	string	必须		名称
├─ pid	integer	必须		父ID
├─ interestedTags	object []	非必须		兴趣标签(旧版本)	item 类型: object
├─ id	integer	非必须		ID
├─ level	string	必须		等级
├─ name	string	必须		名称
├─ pid	string	必须		父ID
├─ interestedTagsV2	object []	非必须		兴趣标签(新版本)	item 类型: object
├─ id	integer	非必须		ID
├─ level	string	必须		等级
├─ name	string	必须		名称
├─ pid	string	必须		父ID
├─ mobiles	object []	非必须		手机型号属性	item 类型: object
├─ id	integer	非必须		ID
├─ name	string	必须		名称
├─ parentId	string	必须		父id
├─ series	string	必须		系列
├─ fseries	string	必须		父系列
├─ height	string	必须		高
├─ width	string	必须		宽
├─ apps	object []	非必须		app列表	item 类型: object
├─ id	integer	非必须		ID
├─ name	string	必须		名称
├─ permissions	integer []	非必须		用户权限	item 类型: integer
├─		非必须
├─ targetMgeConfig	object	非必须		定向配置
├─ limitCount	integer	非必须		创建定向限制数量
├─ proValueCountLimit	object	非必须		属性个数约束
├─ key	integer	非必须
├─ mutualexPros	object []	非必须		互斥属性配置	item 类型: object
├─ pro	integer	非必须		定向维度的上限
├─ exPro	integer	非必须		定向维度值个数上限
├─ msg	string	非必须		定向互斥维度说明
├─ appInstallMutualexSwitch	boolean	非必须		引用安装互斥开关.
├─ weatherShowList	object []	非必须		天气编码列表	item 类型: object
├─ weatherCode	string	非必须		天气ID
├─ weatherName	string	必须		天气名称

13.8 定向联盟App元数据接口

基本信息

Path： /v2/communal/target/get/metadata/newUapp/list

Method： GET

接口描述：

定向联盟App元数据接口
/**
* 定向联盟App元数据接口
* @return
* @throws Exception
*/

请求参数

Query

参数名称	是否必须	示例	备注
extensionType	否	0	推广目的
flowScene	否	0	流量场景
ownerId	否		子账户ID 直客和子客户非必填；代理商使用必填，用于指定查询某个子客户
showType	否		showType推广样式,从广告组上获取
page	否		分页查找，页数
rows	否		分页查找，行数,最大1000

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须
msg	string	非必须
data	object	非必须
├─ unionApps	object []	非必须		联盟app	item 类型: object
├─ id	integer	必须		应用ID
├─ name	string	必须		应用名称
├─ platform	integer	必须		媒体平台
├─ platformName	string	必须		媒体平台名称

13.9 用户兴趣标签新版本

基本信息

Path： /v2/communal/target/get/metadata/userInterestTagV2

Method： GET

接口描述：

用户兴趣标签新版本
/**
* 用户兴趣标签新版本
* @param showType
* @return
*/

请求参数

Query

参数名称	是否必须	示例	备注
extensionType	否	0	推广目的
flowScene	否	0	流量场景
ownerId	否		子账户ID 直客和子客户非必填；代理商使用必填，用于指定查询某个子客户
showType	否		showType推广样式,从广告组上获取

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须
msg	string	非必须
data	object []	非必须			item 类型: object
├─ id	integer	非必须		兴趣标签id
├─ pid	integer	非必须		父id
├─ name	string	非必须		兴趣标签名称
├─ level	integer	非必须		等级
├─ comments	string	非必须		标签注释
├─ delStatus	integer	非必须		删除标识：0未删除，1已删除

13.10 IMEI文件上传

基本信息

Path： /v2/communal/target/imei/upload

Method： POST

接口描述：

IMEI文件上传
/**
* IMEI文件上传
* @param file 图片文件
* @throws Exception
*/

请求参数

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	file	是		图片文件

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须
msg	string	非必须
data	object	非必须
├─ delStatus	integer	非必须		删除状态：0, 正常；1,删除.
├─ immutable	integer	必须		0:另存为的定向(可编辑定向) 1:创建不可编辑定向(无法编辑的定向)	mock: @integer(0,1)
├─ audience	string	非必须		人群定向
├─ audienceCount	integer	非必须		数量

13.11 运算人群包（人群包交并）

基本信息

Path： /v2/communal/target/addExpansionTask

Method： POST

接口描述：

运算人群包（人群包交并）
/**
* 运算人群包（人群包交并）
* @param vo 参数.
* @return 新增结果, 包含定向ID.
* @throws Exception
*/

请求参数

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	必须		定向编号

14. 应用相关

14.1 校验并返回快应用相关信息

基本信息

Path： /v3/communal/instant/check

Method： POST

接口描述：

curl "https://e.heytap.com/v2/communal/instant/check" -X POST -H "content-type: application/x-www-form-urlencoded"

传参明细：
instantAppId: 12000288
instantAppUrl:

返回数据：

{
    "code": 124015, 
    "msg": "快应用地址应和ID保持一致"
}

请求参数

Headers

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

Query

参数名称	是否必须	示例	备注
instantAppId	是		快应用AppId
instantAppUrl	是		快应用直达链接

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
├─ appName	string	非必须		快应用名称
├─ iconUrl	string	非必须		快应用icon
├─ instantAppId	integer	非必须		快应用Id	format: int32
├─ msg	string	非必须		错误信息
├─ oneWordDesc	string	非必须		一句话描述该应用
├─ status	integer	非必须		状态码	format: int32
msg	string	非必须

14.2 查询应用信息

基本信息

Path： /v2/communal/group/appInfo

Method： POST

接口描述：

curl "https://e.heytap.com/v2/communal/group/appInfo" -X POST -H "content-type: application/x-www-form-urlencoded"

传参明细：
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	非必须			format: int32
data	object	非必须
├─ appAuth	integer	非必须		应用权限(按位或),1-游戏注册权限位(0-无权限，1-有权限),2-待扩展权限位(0-无权限，1-有权限),4-待扩展权限位(0-无权限，1-有权限)	format: int32
├─ appId	integer	非必须		应用id	format: int32
├─ appName	string	非必须		应用名称
├─ appPackage	string	非必须		包名
├─ categoryId	integer	非必须		分类id	format: int32
├─ iconUrl	string	非必须		应用iconUrl地址
├─ msg	string	非必须		异常信息
├─ onewordDesc	string	非必须		一句话描述
├─ region	string	非必须		国家区域
├─ resourceStatus	integer	非必须		资源状态，1-上架，2-下架，10-删除	format: int32
├─ status	integer	非必须		应用状态 0-正常，1-异常	format: int32
msg	string	非必须

14.3 查询快应用信息

基本信息

Path： /v2/communal/instant/appInfo

Method： POST

接口描述：

curl "https://e.heytap.com/v2/communal/instant/appInfo" -X POST -H "content-type: application/x-www-form-urlencoded"

传参明细：
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	非必须			format: int32
data	object	非必须
├─ appName	string	非必须		快应用名称
├─ iconUrl	string	非必须		快应用icon
├─ instantAppId	integer	非必须		快应用Id	format: int32
├─ msg	string	非必须		错误信息
├─ oneWordDesc	string	非必须		一句话描述该应用
├─ status	integer	非必须		状态码	format: int32
msg	string	非必须

15. 配置相关

15.1 根据配置类型获取配置项

基本信息

Path： /v3/communal/config/getList

Method： POST

接口描述：

见：典型场景举例 ——> 通用-根据配置类型获取配置项

请求参数

Headers

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

Query

参数名称	是否必须	示例	备注
extensionFlow	否		推广流量：1-全流量场景，2-自有流量，3-联盟流量
extensionType	否		推广目标 1：链接推广 2：应用推广 3: 快应用推广
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：全流量必填规格
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：全流量必填规格

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object []	非必须			item 类型: object
├─ ext	string	非必须		配置扩展信息
├─ value	string	非必须		元配置值
msg	string	非必须

15.2 根据配置类型批量获取配置项

基本信息

Path： /v3/communal/config/getMap

Method： POST

接口描述：

curl "https://e.heytap.com/v3/communal/config/getMap" -X POST -H "content-type: application/x-www-form-urlencoded"

传参明细：
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: 快应用推广
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：全流量必填规格
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：全流量必填规格

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
msg	string	非必须

15.3 出价方式及限定范围查询

基本信息

Path： /v3/communal/interval/config/groupPrice

Method： POST

接口描述：

curl "https://e.heytap.com/v3/communal/interval/config/groupPrice" -X POST -H "content-type: application/x-www-form-urlencoded"

传参明细：
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	是		目标转化类型，0-默认, 1-APP下载, 2-APP拉活, 4-游戏注册, 5-游戏付费, 6-表单注册, 7-注册, 8-回传激活, 9-应用付费, 10-回传留存, 11-应用内自定义转化, 12-应用内授信, 13-应用内下单, 14-deepLink拉活, 15-系统留存, 16-deeplink回传激活, 17-deeplink回传注册, 18-deeplink应用付费, 19-deeplink应用内自定义转化, 20-deeplink应用内授信, 21-deeplink应用内下单, 22-快应用付费, 23-游戏付费ROI1
extensionType	否		标的物类型 1：链接推广 2：应用推广 3: 快应用推广

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
├─ dFloorBid	integer	非必须		深度转化出价下限	format: int32
├─ dMaxBid	integer	非必须		深度转化出价上限	format: int32
├─ fFloorBid	integer	非必须		更随出价下限	format: int32
├─ fMaxBid	integer	非必须		跟随出价上限	format: int32
├─ floorBid	integer	非必须		基础出价下限	format: int32
├─ flowScene	integer	非必须		流量场景	format: int32
├─ maxBid	integer	非必须		基础出价上限	format: int32
├─ oFloorBid	integer	非必须		转化出价下限	format: int32
├─ oMaxBid	integer	非必须		转化出价上限	format: int32
├─ ocpcType	integer	非必须		转化类型	format: int32
msg	string	非必须

附录

附录

基本信息

Path： /empty

Method： GET

接口描述：

1 返回码定义

• 2 枚举定义
• 1 推广目标
• 2 推广流量
• 3 流量场景
• 4 广告版本
• 5 新旧流量映射
• 6 转化类型
• 7 落地页类型
• 8 定向属性ID映射名称关系
• 9 性别（sex）
• 10 年龄（age）
• 11 机型价格(price)
• 12 地域（area），见附件编码表
• 13 地域编码对照表 

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	快应用推广

2 推广流量

extensionFlow - 广告组层级、广告层级会冗余）：全流量场景、自有流量、联盟流量

枚举值	枚举名称
0	默认值（无含义）
1	全流量场景
2	自有流量
3	联盟流量

3 流量场景

flowScene - 广告组层级、广告层级会冗余）：精选推广、安装有礼、开机必备、搜索、信息流、Banner、开屏、插屏等

枚举值	枚举名称
0	默认值（无含义）
1	全流量场景
2	精选推广
3	安装有礼
4	开机必备
5	搜索
6	信息流
7	Banner
8	开屏
9	插屏
10	原生
11	激励视频
12	联盟通投

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	云脑建站
3	达尔文建站
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	通化		46	延吉
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	安庆		129	巢湖
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	济宁		198	莱芜
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	甘南		478	崇左
479	海南		480	昌都		481	怒江		482	迪庆
483	西双版纳		484	定安县		485	屯昌县		486	陵水黎族自治县
487	澄迈县		488	保亭黎族苗族自治县		489	琼中黎族苗族自治县		490	乐东黎族自治县
491	临高县		492	昌江黎族自治县		493	白沙黎族自治县		494	海北
495	黄南		496	果洛		497	山南		498	阿里
499	阿拉尔		500	图木舒克

 

规格

基本信息

Path： /spec

Method： GET

接口描述：

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	图标大图