营销平台3.0OmniAPI

674 680

publicstaticvoidmain(String[]a){inttimestamp=unixTime();longownerId=1000001622;StringapiId="64";StringapiKey="8aa8696140aa412bb188e157fa4afd37";System.out.println(generateToken(apiId,apiKey,ownerId,timestamp));}privatestaticStringgenerateToken(StringapiId,StringapiKey,longownerId,inttimestamp){Stringsign=Hashing.sha1().hashString(apiId+apiKey+timestamp,Charset.defaultCharset()).toString();Stringtoken=BaseEncoding.base64().encode((ownerId+","+apiId+","+timestamp+","+sign).getBytes());returntoken;}

publicstaticintunixTime(){BigDecimalnum=newBigDecimal(System.currentTimeMillis()/1000L);returnnum.intValue();}

II.配额和频次控制

Content-Type:application/jsonAuthorization:BearerTOKEN_VALUE其他接口HTTPHeader示例

Content-Type:application/x-www-form-urlencodedAuthorization:BearerTOKEN_VALUE1.5API应答HTTP状态码支持HTTP标准状态码，具体如下：

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

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

没有变化

有变化

本次新增接口

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

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

涉及接口：

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

com.heytap.ads.omniomni-api-sdk1.0.2OPPOOmniAPISDK如何使用SDK数组参数调用的方法名与API接口一一对应，如v3/ad/get接口就对应OmniAds.getInstance().ads().v3AdGet()方法。

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

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

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

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

/v3/communal/config/getList请求参数：

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

omniAds.adsCommunal().v3CommunalConfigGetList(data)SDK请求参数：

{"code":0,"data":[{"value":"2","ext":{"name":"应用推广","value":2}},{"value":"1","ext":{"name":"网页推广","value":1}},{"value":"3","ext":{"name":"快应用推广","value":3}}]}2新建带预算的应用推广类型计划请求地址：

/v3/plan/add请求参数：

extensionType:2planName:应用推广_2021/07/15_20:11:43dayLimit:1dayBudget:200000SDK请求方法：（使用SDK接入）

omniAds.adsPlan().v3PlanAdd(data)SDK请求参数：

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

{"code":0,"data":{"planId":200012854}}3新建不带预算的链接推广类型计划请求地址：

extensionType:1planName:网页推广_2021/12/01_10:10:48dayLimit:0dayBudget:0SDK请求方法：（使用SDK接入）

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

{"code":0,"data":[{"value":"2","ext":"{"name":"应用推广","value":2}"},{"value":"1","ext":"{"name":"网页推广","value":1}"},{"value":"3","ext":"{"name":"快应用推广","value":3}"}]}2获取当前支持的推广流量请求地址：

type:EXTENSION_FLOWextensionType:2SDK请求方法：（使用SDK接入）

{"code":0,"data":[{"value":"2","ext":"{"name":"自有流量","value":2}"},{"value":"3","ext":"{"name":"联盟流量","value":3}"}]}3获取支持的流量场景请求地址：

type:FLOW_SCENEextensionType:2extensionFlow:3SDK请求方法：（使用SDK接入）

{"code":0,"data":[{"value":"12","ext":"{"name":"不限","value":12}"},{"value":"7","ext":"{"name":"banner","value":7}"},{"value":"9","ext":"{"name":"插屏","value":9}"},{"value":"8","ext":"{"name":"开屏","value":8}"},{"value":"10","ext":"{"name":"原生","value":10}"},{"value":"11","ext":"{"name":"激励视频","value":11}"}]}4获取应用信息请求地址：

/v2/communal/group/appInfo请求参数：

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

omniAds.adsCommunal().v2CommunalGroupAppInfo(appId,pkgName,bizType,flowScence)SDK请求参数：

type:PAGE_TYPEextensionFlow:3extensionType:2flowScene:12SDK请求方法：（使用SDK接入）

{"code":0,"data":[{"value":"11","ext":"{"name":"萤火虫模板","value":11}"},{"value":"4","ext":"{"name":"萤火虫建站","value":4}"}]}6获取萤火虫应用下载模板页请求地址：

/v3/communal/h5Template/list请求参数：

extensionFlow:3flowScene:12SDK请求方法：（使用SDK接入）

omniAds.adsMaterial().v3CommunalH5Template(data)SDK请求参数：

/v2/communal/ad/sparkPageNew/list请求参数：

pageType:4appId:30383853SDK请求方法：（使用SDK接入）

omniAds.adsCommunal().v2CommunalAdSparkPageNewList(data)SDK请求参数：

{"code":0,"data":[{"pageId":"95058","pageUrl":"","pageName":"竖版视频","pageType":9,"ocpcType":0,"targetType":0,"appId":"2297"},{"pageId":"95102","pageUrl":"","pageName":"蘑菇街","pageType":9,"ocpcType":0,"targetType":0,"appId":"23896"}]}8获取对应流量场景支持的转化类型请求地址：

/v3/communal/config/getListSDK请求方法：（使用SDK接入）

omniAds.adsCommunal().v3CommunalConfigGetList(data)请求参数：

type:OCPC_TYPEextensionType:2flowScene:12响应报文：

{"code":0,"data":[{"value":"5-1","ext":"{"name":"下载","value":1,"billingType":5}"},{"value":"5-2","ext":"{"name":"激活","value":2,"billingType":5}"},{"value":"5-4","ext":"{"name":"游戏注册","value":4,"billingType":5}"},{"value":"5-8","ext":"{"name":"回传激活","value":8,"billingType":5}"}]}备注：5-1取-后面的1，标识转化类型枚举值1.

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

type:DEEP_OCPC_TYPEocpcType:0extensionType:2extensionFlow:3flowScene:12响应报文：

{"code":0,"data":[{"value":"2-8","ext":"{"name":"回传激活","value":8,"ocpcType":2}"},{"value":"2-7","ext":"{"name":"注册","value":7,"ocpcType":2}"},{"value":"4-5","ext":"{"name":"游戏付费","value":5,"ocpcType":4}"},{"value":"8-10","ext":"{"name":"回传留存","value":10,"ocpcType":8}"},{"value":"8-10","ext":"{"name":"系统留存","value":15,"ocpcType":8}"}]}10获取价格限制配置请求地址：

/v3/communal/interval/config/groupPrice请求参数：

flowScene=12ocpcType=0SDK请求方法：（使用SDK接入）

omniAds.adsCommunal().v3GroupPrice(extensionType,flowScene,ocpcType)SDK请求参数：

/v3/group/add请求参数：

omniAds.adsGroup().v3GroupAdd(data)SDK请求参数：

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

type=AD_EACH_SPEC_NUM_LIMIT返回：

type=AD_ALL_SPEC_NUM_LIMIT响应报文：

{"code":0,"data":[{"value":"100"}]}4获取动态词包（可选）请求地址：

/v2/communal/dynamic/symbol/list请求参数：

page=1pageCount=20ownerId=1000039147SDK请求方法：（使用SDK接入）

omniAds.adsCommunal().v2CommunalDynamicSymbolList(data)SDK请求参数：

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

/v3/communal/spec/list请求参数：

flowScene:8extensionType:1extensionFlow:3SDK请求方法：（使用SDK接入）

omniAds.adsCommunal().v3CommunalSpecList(data)SDK请求参数：

/v3/creative/material/communal/upload请求参数：

file:(binary)matSpecId:71picType:imgs响应报文：

/creative/material/image/getList请求参数：

size:102400dimension:512*512page:1pageSize:10suffixes:jpgsuffixes:pngsuffixes:jpeg响应报文：

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

/v3/ad/batch请求参数：

omniAds.ads().v3AdBatch(dataSDK请求参数：

/v3/ad/list请求参数：

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

omniAds.ads().v3AdList(data)SDK请求参数：

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

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

请求地址：

type=EXTENSION_FLOWextensionType=1响应报文：

{"code":0,"data":[{"value":"2","ext":{"name":"自有流量","value":2}},{"value":"3","ext":{"name":"联盟流量","value":3}}]}3获取推广目的+推广流量下对应的流量场景：请求地址：

type=FLOW_SCENEextensionType=1extensionFlow=2响应报文：

{"code":0,"data":[{"value":"5","ext":{"name":"搜索","value":5}},{"value":"6","ext":{"name":"信息流","value":6}}]}4获取流量场景下支持的计费类型请求地址：

type=BILLING_TYPEflowScene=6extensionType=1响应报文：

{"code":0,"data":[{"value":"2","ext":{"name":"CPC","value":2}},{"value":"5","ext":{"name":"oCPC","value":5}}]}5获取流量场景下对应的ocpx转化类型请求地址：

type=OCPC_TYPEextensionType=1flowScene=6响应报文：

{"code":0,"data":[{"value":"5-6","ext":{"name":"线索提交","value":6,"billingType":5}}]}6获取流量场景下支持的深度转化类型请求地址：

type:DEEP_OCPC_TYPEextensionType:2extensionFlow:3flowScene:12响应报文：

{"code":0,"data":[{"value":"2-8","ext":"{\"name\":\"回传激活\",\"value\":8,\"ocpcType\":2,\"ocpcOptmType\":2}"},{"value":"2-7","ext":"{\"name\":\"注册\",\"value\":7,\"ocpcType\":2,\"ocpcOptmType\":2}"},{"value":"4-5","ext":"{\"name\":\"游戏付费\",\"value\":5,\"ocpcType\":4,\"ocpcOptmType\":1}"},{"value":"8-10","ext":"{\"name\":\"回传留存\",\"value\":10,\"ocpcType\":8,\"ocpcOptmType\":1}"},{"value":"8-15","ext":"{\"name\":\"系统留存\",\"value\":15,\"ocpcType\":8,\"ocpcOptmType\":1}"}]}7获取流量场景下支持的落地页类型

type=PAGE_TYPEextensionFlow=2extensionType=1flowScene=6响应报文：

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

Path：/v3/plan/add

Method：POST

接口描述：

请求实例：

extensionType=2dayBudget=155500deliveryMode=0planName=%E5%BA%94%E7%94%A8%E6%8E%A8%E5%B9%BF_2021%2F07%2F20_14%3A34%3A11dayLimit=1响应报文：

{"code":0,"data":{"planId":200163758}}SDK请求方法：（使用SDK方法接入）

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

Query

Path：/v3/plan/dayBudget

planIds=200012330,200014945dayBudget=22225200dayLimit=1响应参数：

{"code":0,"data":[{"planId":200014945,"planName":"编辑网页推广_2021/07/19_19:06:38","leftTimes":7,"totalTimes":10,"ret":0,"msg":null},{"planId":200012330,"planName":"应用推广_2021/07/15_14:16:55","leftTimes":8,"totalTimes":10,"ret":0,"msg":null}]}SDK请求方法：（使用SDK方法接入）

omniAds.adsPlan().v3PlanDayBudget(data)SDK请求参数：

AdsPlanBudgetFormdatadata.setXxx;1.ListplanIds计划planIds不能为空2.LongdayBudget日预算(dayLimit=1时dayBudget必填单位（分）)3.IntegerdayLimit是否限制日预算0不限制1限制,当dayLimit=1时dayBudget必填

Headers

Path：/v3/plan/delete

planIds=200011041,200012235响应报文：

{"code":0}SDK请求方法：（使用SDK方法接入）

omniAds.adsPlan().v3PlanDelete(planIds)请求参数Headers

Path：/v3/plan/edit

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

{"code":0,"data":{"planId":200008991,"planName":"应用推广_2021/07/12_15:32:121111","leftTimes":9,"totalTimes":10,"ret":0,"msg":null}}SDK请求方法：（使用SDK方法接入）

omniAds.adsPlan().v3PlanEdit(data);SDK请求参数：

Path：/v3/plan/get

Method：GET

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

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

planId=200012330响应报文：

{"code":0,"data":{"planId":200012330,"status":2,"extensionType":2,"deleteFlag":0,"planName":"应用推广_2021/07/15_14:16:55","dayLimit":0,"dayBudget":"9999999999999","showStatus":2,"status2":0,"statusName":"余额不足"}}SDK请求方法：（使用SDK方法接入）

omniAds.adsPlan().v3PlanGet(planId)请求参数Headers

Path：/v3/plan/status

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

omniAds.adsPlan().v3PlanStatus(data);SDK请求参数:

AdsPlanStatusFormdata参数data.setXxx;ListplanIds计划ids多个id以逗号分隔必传Integerstatus2投放开关标识0-开1-关必传**请求实例：**planIds=200012239,200012238dayBudget=40000dayLimit=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   } ]}

Path：/v3/plan/page

omniAds.adsPlan().v3PlanPage(data)SDK请求参数：

LongdayBudgetFloor;日预算下限LongdayBudgetCeiling;日预算上限

@ApiParam(value="消耗金额下限",hidden=true)privateStringcostFloor;@ApiParam(value="消耗金额上限",hidden=true)privateStringcostCeiling;@ApiParam(value="曝光量下限",hidden=true)privateStringexposeFloor;@ApiParam(value="曝光量上限",hidden=true)privateStringexposeCeiling;@ApiParam(value="点击量下限",hidden=true)privateStringclickFloor;@ApiParam(value="点击量上限",hidden=true)privateStringclickCeiling;@ApiParam(value="点击率下限",hidden=true)privateStringclickRateFloor;@ApiParam(value="点击率下限",hidden=true)privateStringclickRateCeiling;@ApiParam(value="下载量下限",hidden=true)privateStringdownloadFloor;@ApiParam(value="下载量上限",hidden=true)

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

extensionType=2dayLimit=1page=1limit=1deleteFlag=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

Path：/4.0

{"PUSH_BEGIN_END_TIME":"20240408_20240409","PUSH_TIME_SET":"{\"1\":\"1,2\",\"2\":\"1,2\",\"3\":\"1,2,8,9\",\"4\":\"8,9\",\"5\":\"8,9\",\"6\":\"\",\"7\":\"\"}"}下面针对扩展字段中的key，value进行说明：

备注：

Path：/v3/group/add

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

omniAds.adsGroup().v3GroupAdd(data);SDK请求参数：

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

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

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

Path：/v3/group/edit

omniAds.adsGroup().v3GroupEdit(data)SDK请求参数：

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

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

Path：/v3/group/get

omniAds.adsGroup().v3GroupPage(adGroupId)SDK请求参数：adGroupId请求参数：

adGroupId:300087873响应报文：

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

Path：/v3/group/page

omniAds.adsGroup().v3GroupPage()SDK请求参数：

AdsGroupListFormdata；请求参数：

page:1limit:25beginTime:20210719endTime:20210719extensionTypes:1,2,3extensionFlows:1,2,3flowScenes:1,5,6,7,8,9,10,11,12adServingType:deleteFlag:1showStatusSet:0,1,2,3,4,5,6,7,8orderByColumn:ad_group_idasc:DESC响应报文：

{"code":0,"data":{"pageNum":1,"pageSize":25,"total":1,"totalPage":1,"records":[{"status":0,"statusName":"","showStatus":0,"showStatusName":"启动中","status2":0,"deleteFlag":0,"planId":200008260,"planName":"应用推广_2021/07/17_17:34:29","extensionType":2,"extensionTypeName":"应用推广","dayBudget":"不限","adGroupId":300087873,"adGroupName":"应用推广_自有流量_2021/07/17_17:34:32","extensionFlow":2,"extensionFlowName":"自有流量","flowScene":3,"flowSceneName":"安装有礼","price":"150","ocpcPrice":"250","ocpcType":4,"ocpcTypeName":"游戏注册","deepOcpcPrice":"1000","deepOcpcType":5,"deepOcpcTypeName":"游戏付费","ocpcState":"点击阶段","dynamicPrice":2,"adServingType":"普通投放","followMaxPrice":"-"}]}}status字段是按照二进制位来表示内容含义的，下面表格的数字代表是第几个二进制位：

Path：/v3/group/delete

omniAds.adsGroup().v3GroupDelete(data)SDK请求参数：

AdsBatchGroupDeleteFormdata；请求参数：

groupIds:300088058,300088057响应报文：

{"code":0}请求参数Headers

Path：/v3/group/status

omniAds.adsGroup().v3GroupStatus(data)SDK请求参数：

AdsBatchGroupStatusFormdata；请求参数：

groupIds[0]:300088219groupIds[1]:300088218status2:1开关状态0开启1关闭响应报文：

Path：/v3/group/batchSchedule

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

omniAds.adsGroup().v3GroupBatchSchedule(data)SDK请求参数：

AdsBatchGroupScheduleFormdata；请求参数：

{"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}]}

Path：/v3/group/batchTarget

omniAds.adsGroup().v3GroupBatchTargetSDK请求参数：

immutable:0type:1delStatus:0version:2page:1pageCount:20响应报文：

groupIds[0]:300088219percent: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

Path：/v3/group/price

omniAds.adsGroup().v3GroupPrice()SDK请求参数：

groupIds[0]:300088219price: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、按比例修改价格：请求参数：

{"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

Path：/v3/group/ocpcPrice

omniAds.adsGroup().v3GroupOcpcPrice(data)SDK请求参数：

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

groupIds[0]:300088219ocpcPrice: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]:300088219ocpcPercent:150响应报文：

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

Path：/v3/group/deepOcpcPrice

omniAds.adsGroup().v3GroupDeepOcpcPrice(data);SDK请求参数：

groupIds[0]:300088219deepPcpcPrice: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]:300088219deepOcpcPercent: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

Path：/v3/channelPkg/list

响应报文：

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

Path：/v3/group/batchOpenDefaultSecondStage

Path：/v3/group/batchUpdateDp

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

Body

Path：/v3/group/batchUpdateChannelPkgId

Path：/v3/ad/status

omniAds.ads().v3AdStatus(data)SDK请求参数：

请求参数：

adIds[0]:400092045adIds[1]:400091199status2:1响应报文：

Path：/v3/ad/dpa_strategy/detail

Path：/v3/ad/dpa_strategy/edit

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

{"code":0,"data":1}请求参数Headers

Path：/00

Path：/v3/ad/batchMonitorUrl

请求响应示例：

{"code":0,"msg":"添加成功","data":[1234,234454,83784]}请求参数Headers

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

{"code":0,"msg":"推送成功","data":{"messageId":"test"}}请求参数Headers

Path：/v3/ad/get

SDK接入，请求方法：

adId=400080377响应报文：

Path：/v3/ad/list

adGroupId=300026777响应报文：

Path：/v3/ad/page

omniAds.ads().v3AdPage(data)SDK请求参数：

AdsAdListFormdata;data.setXxx;page:1分页页号必传limit:25分页大小必传

beginTime:20210720

endTime:20210720

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

StringorderByColumn:ad_id排序的数据列

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

page:1limit:25beginTime:20210720endTime:20210720deleteFlag:0orderByColumn:ad_idasc:DESC响应报文：

Path：/v3/ad/batch

flowScene=1extensionType=2extensionFlow=1响应报文：

size=102400dimension=200*200page=1pageSize=10suffixes=jpgsuffixes=pngsuffixes=jpeg【3.上传素材(非必须)】请求地址：

/creative/material/v3/communal/upload【4.获取按钮文案】请求地址：

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

type=REQUIRED_SPEC_TYPEextensionFlow=1flowScene=1举例：1批量删除请求参数：

delList[0].adId:400091099delList[1].adId:400091092响应报文：

Path：/v3/ad/deriveMapping

响应参数解释：

Path：/v3/ad/dpa_strategy/get

Path：/v3/ad/dpa_strategy/add

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

SDK接入请求方法：

omniAds.adsData().v3QueryAdData(map);请求参数示例：（同SDK请求参数）

{"endTime":20210531,"beginTime":20210401,"timeLevel":"DAY","paraMap":{"filter_zero":0}}返回参数示例：

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

omniAds.adsData().v3TotalQueryAdData（map）请求参数示例：(同SDK请求参数)

{"page":1,"ascDesc":"ASC","endTime":20210531,"pageCount":10,"timeLevel":"DAY","beginTime":20210401,"orderByColumns":"ftime","paraMap":{"filter_zero":0,"groupByColumn":"ad_id"}}返回参数示例：

{"code":0,"msg":"","data":100}请求参数Headers

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

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

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

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

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

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

{"beginTime":20210620,"endTime":20210621,"orderByColumns":"dt","ascDesc":"DESC","timeLevel":"DAY","paraMap":{"adGroupIds":["12431","14435"],"extensionFlowList":["2","1"],"planIds":["12431","14435"],"adIds":["12431","14435"],"appIdList":["adipisicinganimlaboretempor","reprehenderitfugiatUt","exercitation","doLoremet"],"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

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

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

{"beginTime":20210620,"endTime":20210621,"orderByColumns":"dt","ascDesc":"DESC","timeLevel":"DAY","page":1,"pageCount":10,"paraMap":{"adGroupIds":["12431","14435"],"extensionFlowList":["2","1"],"planIds":["12431","14435"],"adIds":["12431","14435"],"appIdList":["adipisicinganimlaboretempor","reprehenderitfugiatUt","exercitation","doLoremet"],"app_id":"4132","app_name":"consequ","flowSceneList":["1","2"],"exposeFloor":-67280287,"exposeCeiling":41164553,"clickFloor":-89015186,"clickCeiling":-95405039,"ecpmFloor":-74395941,"ecpmCeiling":24198488,"groupByColumn":"app_id"}}返回参数示例：

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

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

{"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"}}返回示例：

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

{"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"}}返回示例：

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

{"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/1816: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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

{"page":1,"pageCount":10,"beginTime":"20210825","endTime":"20210825",}请求参数Headers

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

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

请求参数示例：

{"paraMap":{"queryOwnerType":0}}返回参数示例：

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

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

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

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

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

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

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

request

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

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

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

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

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

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

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

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

Path：/v3/communal/searchKeyWord/listCategoryKws

查询行业类目：

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

categoryId:10000SDK接入请求方法：

omniAds.adsSearchKeyWord.V3CommunalSearchKeyWordListCategoryKws(data)SDK请求参数：

AdSearchCategoryKwQueryDTOdata；data.setXxx;privateLongcategoryId;类目id不能小于0privateLongappId;appId必须大于0

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

Path：/v3/communal/searchKeyWord/listPremiumKws

adGroupId:300582205sourceSet:0SDK接入请求方法：

omniAds.adsSearchKeyWord.V3CommunalSearchKeyWordListPremiumKws(data)请求参数：

{"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

Path：/v3/communal/searchKeyWord/listGroupKwPkg

omniAds.adsSearchKeyWord.v3ListGroupKwPkg(data)SDK请求参数：

ListGroupKwPkgFormdata;请求参数：

adGroupId:300582205type: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

Path：/v3/communal/searchKeyWord/addCustomOrNoKwPkg

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

omniAds.adsSearchKeyWord.v3AddCustomOrNoKwPkg(data)SDK请求参数：

AddCustomKwPkgForm请求参数：

kwPackageName:onePackagekwPackageType:1pkgKeywords[0].keyword:nihaopkgKeywords[0].matchType:2响应报文：

Path：/v3/communal/searchKeyWord/deleteKwInPkg

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

omniAds.adsSearchKeyWord.v3DeleteKwInPkg（data）SDK请求参数：

DeleteKwInPkgFormdata;请求参数：

kwPackageId:300582205keywords[0].keyword:nihaokeywords[1].keyword:test1024响应报文：

Path：/v3/communal/searchKeyWord/addKwToPkg

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

omniAds.adsSearchKeyWord.v3AddKwToPkg(data)SDK请求参数：

AddKwToPkgFormdata;请求参数：

kwPackageId:12345567pkgKeywords[0].keyword:nihaopkgKeywords[0].matchType:2响应报文：

Path：/v3/communal/searchKeyWord/editCustomOrNoKwPkg

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

omniAds.adsSearchKeyWord.v3EditCustomOrNoKwPkg(data)SDK请求参数：

EditKwPkgFormdata;请求参数：

kwPackageId:12345343455kwPackageName:testPackagepkgKeywords[0].keyword:nihaopkgKeywords[0].matchType:2响应报文：

Path：/v3/communal/searchKeyWord/batchDeleteKwPkg

omniAds.adsSearchKeyWord.v3BatchDeleteKwPkg（data）SDK请求参数：

BatchDeleteKwPkgFormdata；请求参数：

kwPkgIdList[0]:300582205kwPkgIdList[1]:878772833响应报文：

Path：/v3/communal/searchKeyWord/addGroupKw

omniAds.adsSearchKeyWord.v3AddGroupKw(data)SDK请求参数：

AddGroupKwForm请求参数：

adGroupId:12342344searchKeywords[0].keyword:testKeywordsearchKeywords[0].matchType:1searchKeywords[0].price:100searchKeywords[0].ocpcPrice:100searchKeywords[0].deepOcpcPrice:100searchKeywords[0].targetROI:6

categoryPackages[0].categoryId:34745958categoryPackages[0].matchType:3categoryPackages[0].price:200categoryPackages[0].ocpcPrice:100categoryPackages[0].deepOcpcPrice:100categoryPackages[0].targetROI:6

customOrNoPackages[0].kwPackageId:98978682customOrNoPackages[0].price:3000customOrNoPackages[0].ocpcPrice:100customOrNoPackages[0].deepOcpcPrice:100customOrNoPackages[0].targetROI:6

Path：/v3/communal/searchKeyWord/deleteGroupKw

adGroupId:12342344searchKeywords[0].keyword:testKeywordsearchKeywords[0].kwPackageId:1989893

categoryPackages[0].categoryId:34745958categoryPackages[0].kwPackageId:3989893

customOrNoPackages[0].id:4938923

Path：/v3/communal/searchKeyWord/editGroupKw

adGroupId=1234234searchKeywords[0].keyword:testKeywordsearchKeywords[0].kwPackageId:789899879882searchKeywords[0].matchType:1searchKeywords[0].price:100searchKeywords[0].ocpcPrice:100searchKeywords[0].deepOcpcPrice:100searchKeywords[0].targetROI:6

categoryPackages[0].categoryId:34745958categoryPackages[0].kwPackageId:978868767873categoryPackages[0].matchType:3categoryPackages[0].price:200categoryPackages[0].ocpcPrice:100categoryPackages[0].deepOcpcPrice:100categoryPackages[0].targetROI:6

customPackages[0].id:98978682customPackages[0].price:3000customOrNoPackages[0].ocpcPrice:100customOrNoPackages[0].deepOcpcPrice:100customOrNoPackages[0].targetROI:6

Path：/v3/communal/searchKeyWord/queryKwPackageByOwner

获取账户下的所有词包：

kwPackageType:2SDK接入请求方法：

omniAds.adsSearchKeyWord.V3CommunalSearchKeyWordQueryPackageByOwner(data)请求参数：

PremiumCustomKwDTOdata；data.setXxx;ListkwPackageIdList;ListkeywordList;

{"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

Path：/v3/communal/searchKeyWord/queryKwByPackageId

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

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

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

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

page=1pageCount=1SDK请求方法：（使用SDK方法接入）

omniAds.adsAgency().V2AgencyCustomerList(data)SDK请求参数：

{"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

Path：/v2/communal/owner/unifiedInfo

Path：/v2/communal/auth/query

loginType=1SDK接入请求方法：

omniAds.adsAgency().V2CommunalAuthQuery(data)SDK请求参数：

响应报文:

{"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

Path：/v2/communal/finance/billHis

page=1pageCount=2loginType=1SDK接入请求方法：

omniAds.adsAgency().V2FinanceBillHis(data,page,pageCount,loginType)SDK请求参数：

Integerpage=1;IntegerpageCount=10;IntegerloginType=1;

{"code":0,"data":{"totalCount":4,"itemCount":2,"items":[{"billTime":"2021-07-0816:31:40","subAcc":0,"billType":1,"billMoney":1000000,"billDesc":"代理商划账","accId":800047321,"relateAccId":800050006,"relateOwnerId":1100050133,"relateOwnerName":"商品","relateOwnerType":0,"billSub":300},{"billTime":"2021-07-0711:14:14","subAcc":0,"billType":1,"billMoney":100000,"billDesc":"代理商划账","accId":800047321,"relateAccId":800049958,"relateOwnerId":1100050085,"relateOwnerName":"master测试","relateOwnerType":0,"billSub":300}]}}请求参数Headers

Path：/v2/communal/owner/info

用户基础信息接口无请求参数：SDK接入请求方法：

omniAds.adsOwner().v2CommunalOwnerInfo()响应报文：

{"code":0,"data":{"ownerId":1100047375,"accId":800047248,"loginType":3,"ownerType":1,"maxLevel":3}}

Path：/v2/communal/owner/balance

omniAds.adsAgency().V2OwnerBalance()从账户或者直客账务情况

{"code":0,"data":{"accId":800047248,"cashBal":79081073,"cashLockBal":0,"cashCost":6400,"rebateBal":0,"rebateCost":0,"virBal":0,"virCost":0,"accDayBudget":123412,"budgetType":1,"accDayBudgetLimit":20000,"totalBalance":79081073}}请求参数Headers

Path：/v2/communal/owner/setAccDayBudget

设置账户日预算(new)SDK接入请求方法：

omniAds.adsOwner().v2CommunalOwnerSetAccDayBudget(accDayBudget,budgetType)SDK请求参数：

LongaccDayBudget日预算IntegerbudgetType账户日预算类型，0：额度不限请求参数示例：

accDayBudget=40000响应示例

Path：/v2/communal/agency/balance

代理商账务情况-包含总余额,各个子账户余额以及预算SDK接入请求方法：

omniAds.adsAgency().V2AgencyBalance()无请求参数：

响应示例：

{"code":0,"data":{"accId":800047321,"cashBal":8899800,"cashLockBal":0,"cashCost":600,"rebateBal":0,"rebateCost":0,"virBal":0,"virCost":0,"accDayBudget":0,"budgetType":1,"totalBalance":8899800}}请求参数Headers

Path：/v2/communal/agency/info

代理商基础信息接口无请求参数SDK接入请求方法：

omniAds.adsAgency().V2AgencyInfo()响应示例：

{"code":0,"data":{"ownerId":1100047448,"accId":800047321,"loginType":1,"ownerType":0,"maxLevel":3}}请求参数Headers

Path：/v2/communal/finance/billHisExport

账务流水导出SDK接入请求方法：

omniAds.adsAgency().V2FinanceBillHisExport(data,loginType);SDK请求参数：

响应为文件

Path：/v2/communal/dynamic/symbol/list

获取有效动态词通配符SDK接入，请求方法：

omniAds.adsSearchKeyWord().getSymbolList(data)SDK请求参数：

Path：/v2/communal/material/pageList

此接口主要用于查询2.0素材，若要查询素材中心素材（即可用于投放的素材），可通过接口：/v3/creative/material/communal/query

Path：/v3/creative/material/communal/upload

素材上传方式包括新建创意和上传创意中心两种场景，本接口用于新建创意时上传素材的情况。1.新建创意场景：当前创意新建时直接上传，需要传入matSpecId参数，校验上传文件和matSpecId标示的规格是否匹配2.上传创意中心：目前暂不支持API上传，可先前往创意中心上传，然后新建创意时通过素材统一查询接口从创意中心查询素材id用于新建创意

请求示例:

files:@"/F:/4s.mp4"matSpecId:60响应：

Path：/v3/creative/material/communal/query

请求示例：

pageSize:1pageNum:1aspectRatios:1:1aspectRatios:3:2suffixes:pngsuffixes:jpg响应：

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

file:@"/test.mp4"响应示例:

Path：/v3/communal/spec/list

根据条件查询获取规格列表SDK接入，请求方法：

omniAds.adsCommunal().getSpec（data）SDK请求参数：

一、外层字段：TitleFmttitle;//标题格式要求DescFmtdesc;//描述格式要求BdNameFmtbdName;//品牌名称格式要求ListvideoList;//视频格式要求Listimgs;//图片格式要求集合Listinteractives;//互动创意格式要求集合booleanrepeat=false;//是否多张图片IntegerminImgNum;//当repeat=true时表示限制最少minImgNum张imgs[0]指定的图片IntegermaxImgNum;//当repeat=true时表示限制最多maxImgNum张imgs[0]指定的图片ImgFmtbrandLogo;//品牌Logo图片.TitleFmtbuttonTxt;//按钮文案.ImgFmtvideoBgImg;//视频结束背景图.ImgFmtvideoImg;//视频封面.

二、内层字段：TitleFmt:Integerlen;//字数限制Booleanneed;//是否必填IntegerminLen;//字数最小值IntegermaxLen;//字数最大值

DescFmt:Integerlen;//字数限制Booleanneed;//是否必填IntegerminLen;//字数最小值IntegermaxLen;//字数最大值

BdNameFmt:Integerlen;//字数限制Booleanneed;//是否必填IntegerminLen;//字数最小值IntegermaxLen;//字数最大值

VideoFmt:LongmaxDrt;//最大时长，sLongminDrt;//最小时长，sListwhSc;//视频宽高比集合(宽：高,如16:9)Integerw;//视频宽Integerh;//视频高Longs;//视频大小Listfmt;//视频文件格式集合

ImgFmt:Integerw;//图片宽Integerh;//图片高Floatrate;//图片宽高比(保留两位小数)ListwhSc;//图片宽高比集合(宽：高,如16:9)Longs;//图片大小Listfmt;//图片文件格式集合IntegertitleNum;//标题字数限制IntegersubTitleNum;//副标题字数限制IntegervalidateFlag;//校验标识null、1：校验2：不校验

InteractFmt:Integerw;//宽（图片型互动素材）Integerh;//高（图片型互动素材）Listmode;//互动模式集合Listtype;//互动zip包类型集合ListwhSc;//宽高比集合(宽:高,如16:9)Longs;//素材大小Listfmt;//文件格式集合

示例：{"bdName":{"maxLen":8,"minLen":1},"brandLogo":{"fmt":["jpg","png","jpeg"],"h":200,"s":100,"w":200},"buttonTxt":{"maxLen":4,"minLen":1},"imgs":[],"repeat":false,"title":{"maxLen":23,"minLen":1},"videoBgImg":{"fmt":["png","jpg","jpeg"],"h":1280,"s":150,"w":720},"videoImg":{"fmt":["png","jpg","jpeg"],"h":720,"s":150,"w":1280},"videoList":[{"fmt":["mp4"],"h":0,"maxDrt":60000,"minDrt":0,"s":25600,"w":0,"whSc":["16:9"]}],"interactives":[{"fmt":["zip"],"s":5120,"w":1080,"h":1920,"whSc":[]}]}

总结：required对当前规格下各元素的必填、选填做了要求，没有描述就不能传。format对当前规格下各元素的各种详细规范做了描述。/v3/ad/batch接口参数是传递的具体元素

required字段与format外层字段与/v3/ad/batch接口参数映射关系如下：title->title->addList[0].copywriterbdName->bdName->addList[0].brandNamevideoList->videoList->addList[0].videoMatIdsimgs->imgs->addList[0].imgMatIdsbrandLogo->brandLogo->addList[0].brandLogoImgIdbuttonTxt->buttonTxt->addList[0].buttonTxtvideoBgImg->videoBgImg->addList[0].videoBgImgIdvideoImg->videoImg->addList[0].videoImgIdinteractives->interactives->addList[0].interactMatIds

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

SDK接入，请求参数：

AdsAdPageFormdata；data.setXxx;privateStringpageId;落地页idprivateStringpageUrl;落地页url与pageType不能同时为空/**

/privateIntegerpageType;/*

适用于应用推广场景，起校验作用，传入appId参数确保只返回该应用的落地页不能单独使用，需要与pageType、pageUrl配合使用

Path：/v3/communal/h5Template/list

AdsV3H5TemplateFormdata;data.setXxx;/**

/privateIntegerextensionFlow;/*

*/privateIntegerflowScene;

/**

1.全流量场景2.自有流量3.联盟流量

需要加extensionFlow、flowScene同时筛选

contractfeedsgeneraloppo_adxoppo_cpdunion_advert

Path：/v2/communal/target/add

omniAds.adsTarget().v2CommunalTargetAdd(data)SDK接入，请求参数：

AdsTargetVodata；data.setXxx;privateLongtargetId;//定向编号

privateLongopenTargetId;//第三方定向编号

privateStringopenV2TargetId;//第三方定向id

@NotNull(groups={Groups.Edit.class,Groups.Add.class})@Size(min=0,max=30,groups={Groups.Edit.class,Groups.Add.class})@Pattern(groups={Groups.Add.class,Groups.Edit.class},regexp="(^[A-Za-z0-9\u4e00-\u9fa5！@#￥%……~|!@#$^《》？，。：；【】”“（）——\[\]、{}·&()-_+=,.;:'"<>/]$)|(^$)")privateStringtargetName;//定向名称

@NotNull(groups={Groups.Edit.class,Groups.Add.class})@Size(min=0,max=300,groups={Groups.Edit.class,Groups.Add.class})@Pattern(groups={Groups.Add.class,Groups.Edit.class},regexp="(^[A-Za-z0-9\u4e00-\u9fa5！@#￥%……~|!@#$^《》？，。：；【】”“（）——\[\]、{}·&()-_+=,.;:'"<>/]$)|(^$)")privateStringtargetDesc;//定向描述

@Range(min=0,max=1,groups={Groups.Edit.class})privateintdelStatus;//删除状态：0,正常；1,删除.

@Pattern(groups={Groups.Add.class,Groups.Edit.class,Groups.Query.class},regexp="^\d{1,5}(:,\d{1,5}){0,500}|(^$)")privateStringregion;//地域

@Pattern(groups={Groups.Add.class,Groups.Edit.class,Groups.Query.class},regexp="^\d{1,5}(:,\d{1,5}){0,500}|(^$)")privateStringbrandRegion;//品牌当前地定向

@Pattern(groups={Groups.Add.class,Groups.Edit.class},regexp="^\d+(,\d+)*|(^$)")privateStringappCatActive;//app分类活跃

@Pattern(groups={Groups.Add.class,Groups.Edit.class},regexp="^-\d+(,-\d+)*|(^$)")privateStringmobileModel;//机型

@Pattern(groups={Groups.Add.class,Groups.Edit.class,Groups.Query.class},regexp="[0-2]|999|(^$)")privateStringsex;//性别

@Pattern(groups={Groups.Add.class,Groups.Edit.class,Groups.Query.class},regexp="^([0-6][,])*[0-6]|999|(^$)")privateStringage;//年龄段

@Pattern(groups={Groups.Add.class,Groups.Edit.class},regexp="^((WIFI|2G|3G|4G|5G|999)[,])*(WIFI|2G|3G|4G|5G|999)$|(^$)")privateStringnetwork;//网络

@Pattern(groups={Groups.Add.class,Groups.Edit.class},regexp="^([1-4][,])*[1-4]|999|(^$)")privateStringmobilePrice;//机型价格

@Pattern(groups={Groups.Add.class,Groups.Edit.class},regexp="^\d+(,\d+)*|(^$)")privateStringinstallAppList;//应用已安装

@Pattern(groups={Groups.Add.class,Groups.Edit.class},regexp="^\d+(,\d+)*|(^$)")privateStringpreInstallAppList;//应用预安装

@Pattern(groups={Groups.Add.class,Groups.Edit.class},regexp="^\d+(,\d+)*|(^$)")privateStringunPreInstallAppList;//应用非预安装

@Pattern(groups={Groups.Add.class,Groups.Edit.class},regexp="^\d+(,\d+)*|(^$)")privateStringnotInstallAppList;//应用未安装

@Pattern(groups={Groups.Add.class,Groups.Edit.class},regexp="^\d{1,6}(:,\d{1,6}){0,500}|(^$)")privateStringpermanentRegion;//常驻地

@Pattern(groups={Groups.Add.class,Groups.Edit.class},regexp="^\d+(,\d+)(\|\d+)|(^$)")privateStringappActive;//应用活跃

@Pattern(groups={Groups.Add.class,Groups.Edit.class},regexp="^\d+(,\d+)(\|\d+)|(^$)")privateStringappNotActive;//应用非活跃

@Pattern(groups={Groups.Add.class,Groups.Edit.class,Groups.Query.class},regexp="^\d+(,\d+)*|(^$)")privateStringinterestTags;//兴趣标签

@Pattern(groups={Groups.Add.class,Groups.Edit.class,Groups.Query.class},regexp="^\d+(,\d+)*|(^$)")privateStringinterestTagsV2;//兴趣标签新版本

@Pattern(groups={Groups.Add.class,Groups.Edit.class,Groups.Query.class},regexp="^\d+(,\d+)*|(^$)")privateStringtagsSystemRecommend;//标签系统推荐

@Pattern(groups={Groups.Add.class,Groups.Edit.class},regexp="^\d+(,\d+)|^(([A-Za-z0-9])+:[0-9])(,([A-Za-z0-9])+:[0-9])|(^$)")privateStringunionAppId;//联盟AppId

@Pattern(groups={Groups.Add.class,Groups.Edit.class},regexp="^\d+(,\d+)|^(([A-Za-z0-9])+:[0-9])(,([A-Za-z0-9])+:[0-9])|(^$)")privateStringunionAppIdRe;//联盟App反向

@Pattern(groups={Groups.Add.class,Groups.Edit.class},regexp="^\d+(,\d+)*|(^$)")privateStringflowAppCatActive;//流量类别@Min(value=0,groups={Groups.Add.class,Groups.Edit.class})@Max(value=1,groups={Groups.Add.class,Groups.Edit.class})privateintimmutable;//是否可以修改.默认0-可修改@Min(groups={Groups.Add.class,Groups.Edit.class},value=1)@Max(groups={Groups.Add.class,Groups.Edit.class},value=12)privateinttype;//定向类型,参考-TargetTypeEnum

privateStringaudience;//人群定向属性

privateStringoppAudience;//逆向定向人群(排除)

privateLongpTargetId;//父类定向id，继承该父类的定向属性.

privateLongoppAudienceId;//逆向定向人群(排除)ID

privateIntegerappActiveDays;//应用活跃天数.

privateIntegerappNotActiveDays;//应用非活跃天数.

privateLongaudienceCount;//人群包受众数量@Min(groups={Groups.Add.class,Groups.Edit.class},value=1)@Max(groups={Groups.Add.class,Groups.Edit.class},value=2)privateIntegerversion;//1-原始版本.2-V2

privateIntegerlookalikeTaskId;//lookalike任务ID.

privateIntegerdeleteSeed;//删除种子包.0-不删除.1-删除.

privateIntegerexpansionStatus;//拓展状态.0-默认.1-待拓展.2-拓展中.3-拓展完成.4-拓展失败

privateLongexpansionCount;//拓展数量.@Length(max=64)privateStringseedFileName;//imei原文件名.

privateIntegershowStatus;//展示状态.1-可使用,2-拓展中,3-拓展异常,4-已删除

privateStringlongitude;//经度

privateStringlatitude;//纬度

privateLongradius;//半径.privateStringlocationName;//地点名称.privateStringaddress;//地址privateStringmapLocations;//地图点@Range(groups={Groups.Add.class},max=6,min=0)privateIntegerimeiType;//imei类型privateStringyesterdayInstalledApp;//前一天已安装privateLongsizeLimit;//人群包大小限制

@Pattern(groups={Groups.Add.class,Groups.Edit.class},regexp="^[A-Z]{2}(:,[A-Z]{2}){0,500}|999|(^$)")privateStringcountryOrRegion;//国家或地区@Pattern(groups={Groups.Add.class,Groups.Edit.class},regexp="^\d{1,3}(:,\d{1,3}){0,10}|(^$)")privateStringweatherCode;//天气定向：限制10种天气类型

@Pattern(groups={Groups.Add.class,Groups.Edit.class},regexp="^\d+(,\d+)*|(^$)")privateStringinstantInstallList;//快应用已添加

@Pattern(groups={Groups.Add.class,Groups.Edit.class},regexp="^\d+(,\d+)*|(^$)")privateStringinstantNotInstallList;//快应用未添加

Path：/v2/communal/target/get

omniAds.adsTarget.v2CommunalTargetGetSDK请求参数：

AdsTargetFormdata；data.setXxx;privateLongid;//定向idprivateIntegerdelStatus;//删除标识privateIntegerbizType;//展示类型:信息流,品牌,联盟privateStringopenV2TargetId;//外部定向id

Path：/v2/communal/target/del

omniAds.adsTarget.v2CommunalTargetDelSDK接入请求参数：

Path：/v2/communal/target/update

omniAds.adsTargrt().v2CommunalTargetUpdate(data)SDK请求参数：

Path：/v2/communal/target/list

omniAds.adsTargrt().v2CommunalTargetList（data）SDK请求参数：

TargetFilterVodata；data.setXxx;privateIntegerpage;//第几页privateIntegerpageCount;//每页数量privateStringidAndName;//id名称模糊过滤条件

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

omniAds.adsTargrt().v2CommunalTargetGetMetadataAppList（showType,extensionType,isTop,flowScene）请求参数：

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

omniAds.adsTarget().v2CommunalTargetGetMetadata(showType,extensionType.flowScene)SDK请求参数：

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

omniAds.adsTargrt().v2NewUappList(data)SDK请求参数：

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

omniAds.adsTarget().getUserInterestTagV2(showType,extensionType,flowScene)SDK请求参数：

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

omniAds.adsTarget().v2TargetImeiUpload(AdsTargetImeiFormdata)SDK请求参数：AdsTargetImeiFormdata;

Path：/v2/communal/target/addExpansionTask

omniAds.adsTarget().v2TargetAddExpansionTask(AdsTargetTaskFormdata)SDK请求参数：AdsTargetTaskFormdata；

Path：/v2/communal/target/getAreaInfo

Path：/v2/communal/target/provinceAndCityMapping

Path：/v3/communal/instant/check

omniAds.adsInstantApp()v3CommunalInstantCheck(data)SDK请求参数：

instantAppId:12000288响应报文：

{"code":124015,"msg":"快应用地址应和ID保持一致"}请求参数Headers

Path：/v2/communal/group/appInfo

查询应用信息：SDK接入，请求方法：

omniAds.adsCommunal().v2CommunalGroupAppInfo(appId，pkgName，bizType，flowScene)SDK请求参数：

appId:2321响应报文：

Path：/v2/communal/instant/appInfo

查询快应用信息：SDK接入，请求方法：

omniAds.adsInstantApp().v2CommunalInstantAppInfo(data)SDK请求参数：

instantAppId:12000288type:1响应报文：

Path：/v3/communal/config/getList

见：典型场景举例——>通用-根据配置类型获取配置项SDK接入，请求方法：

AdsConfigReqdata;data.setXxx;@ApiParam(value="配置类型，获取配置列表，配置类型不能为空，EXTENSION_TYPE：推广目的，EXTENSION_FLOW：推广流量，FLOW_SCENE：流量场景，BILLING_TYPE：出价方式，OCPC_TYPE：转化类型，DEEP_OCPC_TYPE：深度转化类型，SPEC_TYPE：规格，URL_TYPE：监测链接，SMART_EXPAND_TYPE；智能拓量，FIREFLY_APP_DOWN_PAGE：萤火虫应用下载页，PAGE_TYPE：落地页类型，REQUIRED_SPEC_TYPE：全流量必填规格")privateStringtype;

@ApiParam(value="配置类型列表，批量获取配置项，配置类型列表不能为空，EXTENSION_TYPE：推广目的，EXTENSION_FLOW：推广流量，FLOW_SCENE：流量场景，BILLING_TYPE：出价方式，OCPC_TYPE：转化类型，DEEP_OCPC_TYPE：深度转化类型，SPEC_TYPE：规格，URL_TYPE：监测链接，SMART_EXPAND_TYPE；智能拓量，FIREFLY_APP_DOWN_PAGE：萤火虫应用下载页，PAGE_TYPE：落地页类型，REQUIRED_SPEC_TYPE：全流量必填规格")privateListtypeList;

@ApiParam(value="推广目标1：链接推广2：应用推广3:快应用推广7:小程序推广",required=false)@AdRange(values={1,2,3},message="extensionType取值范围为1、2、3、7")privateIntegerextensionType;

@ApiParam(value="推广流量：1-全流量场景，2-自有流量，3-联盟流量",required=false)@AdRange(values={1,2,3},message="extensionFlow取值范围为1、2、3")privateIntegerextensionFlow;

Path：/v3/communal/config/getMap

根据配置类型批量获取配置项：SDK接入，请求方法：

omniAds.adsCommunal().v3CommunalConfigGetMap(data)SDK请求参数：

typeList:DEEP_OCPC_TYPEextensionType:2extensionFlow:2flowScene: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

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

出价方式及限定范围查询：SDK接入，请求方法：

omniAds.adsCommunal().v3GroupPrice(flowScene，ocpcType，extensionType)SDK请求参数：

IntegerflowScene流量场景IntegerocpcType目标转化类型IntegerextensionType推广目的1：链接推广2：应用推广3:快应用推广7:小程序推广请求参数：

flowScene:1ocpcType:0响应报文：

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

Path：/v3/communal/owner/customer/qualification/get

请求接口不需要具体参数，不过需要客户登陆的cookie和session信息auditStatus返回资质审核具体状态

]}]},"industry":[{"qualificationCategoryName":"","qualificationList":[{"qualificationName":"《卫生许可证》","files":["/images/res/user_pic/202211/02/1100017731/325epw7c2dvywo6lg7wuom4b4_1080X2400_1667388271520.jpg"]},{"qualificationName":"《娱乐经营许可证》","files":["/images/res/user_pic/202211/02/1100017731/325epw7c2dvywo6lg7wuom4b4_1080X2400_1667388273934.jpg"]}]}],"ext":{"qualificationList":[

]}},"remark":"测试jins1234567","pageFlag":0,"auditStatus":0}}

Path：/v3/communal/owner/customer/qualification/info

Path：/v3/communal/qualification/industry

Path：/v3/communal/qualification/elements

Path：/v3/communal/owner/customer/qualification/add

Path：/v3/communal/owner/customer/qualification/edit

Path：/v3/ad/program/add

Path：/v3/ad/program/edit

Path：/v3/ad/program/get

groupId=300442120返回示例：

Path：/dpa/v2/product/batchSave

接口描述：商品批量入库，如果id不存在，将插入，如果id已存在，将更新。单次调用商品数量上限100条，单个商品库内商品数量上限100w

DPA与SDPA使用说明：DPA与SDPA都可使用该批量更新或添加商品，DPA与SDPA大部分字段相同，SDPA增加了投放的一些额外必填字段

{"code":0,"msg":"success","data":{"insertIdSet":[],"updateIdSet":["998877","778899"],"unChangeIdSet":[]}}请求参数Headers

Path：/

商品库是商品的集合，一个账户只能建立10个商品库，一个商品库下可建10个商品文件，一个商品文件对应多个商品，一个商品库最多有100w个商品，一个商品有多种属性（图片，名称，价格等）。

商品数据xml文件保存的是商品的字段信息，系统解析该文件对商品库进行更新。索引数据xml文件保存的是商品数据xml文件的拉取地址，可以存放多个。

我们支持将商品中的某些文字和图片合成在模板上，可支持合成的字段具体有：product_name，img_url，brand_name，brand_logo，price，promotion_price，discount_rate，slogan，price_show，promotion_price_show（字段定义见下方xml格式说明）

其中需注意的是，价格展示优先级规则：价格会优先取price_show，promotion_price_show这两个字段，如对价格的展示有特殊需求，如：100元/个，1分钱起等，可以将自定义的价格展示文字填入该字段，我们会直接取该文字合成展示。如果price_show，promotion_price_show没有值，则取price，promotion_price字段，该价格会将小数点最后的0去除，如1.20->1.2，1.00->1，折扣会保留到整数，如6.5折->6折。客户可以联系对接人员提供已有的模板示例和合成效果，便于确定自己的设计效果

如果已经定义的字段，无法满足客户合成需求的，客户可以自定义扩展合成字段，以ext_compose_img开头的字段表示合成图片，以ext_compose_text开头的字段标识合成文字。比如除了已经定义的图片，还想给商品加2张图片合成，可在xml中填充ext_compose_img_1,ext_compose_img_2，将需要合成的图片地址填入，这样即可支持合成

3.1定时拉取的方式，在客户上传文件链接前，需提供客户的域名给oppo配置域名白名单（必需）3.2鉴权token会在拉取xml文件时，放在请求头Authorization中，客户可用此字段进行token验证，若无则不填3.3如果客户方有ip白名单限制，请对以下ip段添加白名单：北京汇天电信：106.39.217.128-106.39.217.159北京汇天联通：123.58.102.128-123.58.102.159北京汇天移动：223.70.235.32-223.70.235.63北京昌平联通：111.206.203.64-111.206.203.79111.206.203.96-111.206.203.126北京昌平电信：106.3.19.224-106.3.19.255106.3.19.64-106.3.19.79

在商品库页面新建商品文件，有2种接入方式。（1）手动上传：上传本地xml文件，系统将解析其中的商品数据。适用于商品规模不大，且不需要经常更新数据的场景，xml文件大小限制50MB内，手动上传时会立即对该商品文件进行解析，该文件为一次性读取，后面不会再读取（2）定时拉取：录入定时拉取xml的信息，系统会在每天定时去拉取对应的商品数据并解析更新，适用于商品规模大的场景。支持录入xml(商品数据xml文件)和xmlsiteMap(索引数据xml文件)两种格式的拉取信息录入。定时拉取需先校验成功才能提交，token如有则填写。文件校验会请求填写的链接地址，拉取商品文件，对该商品文件第一组商品标签进行解析，若正确则校验通过

商品扩展图字段（通过标签区分具体图片）：

商品扩展视频字段（通过标签区分具体视频）：

如果填写的xml内容中包含特殊符号：&<>"'，需要用"文本"]]>将文本包起来，不然无法正常解析

Path：/dpa/v2/product/deleteByIds

备注：商品被删除后，将无法在营销平台查询到该商品，如果通过手动上传或定时拉取的xml中依然包含该商品，将被视为新增了该商品请求示例：

{"hId":9327,"pIdList":["3ksdj2s2fse5e38888888","3ksdj2s2fse5e3999999"]}响应报文：

{"code":0,"msg":"success","data":1}请求参数Headers

Path：/dpa/v2/product/page

Path：/dpa/v2/house/authorize

{"hId":9327,"ownerIds":[38888888,3999999]}响应报文：

Path：/dpa/v2/house/cancel_authorize

Path：/dpa/v2/house/authorizzation/list

{"code":0,"msg":"msg","data":[{"ownerId":1100050114,"authorizeTime":1700569596000}]}请求参数Headers

1返回码定义

备注：extensionType、extensionFlow、flowScene枚举含义参考附录部分。

THE END

有哪些高效的社群营销平台？好用社群营销平台推荐！

神策营销云

博阳全渠道会员营销平台产品包括会员系统,小程序商城,企微智慧导购助手。通过SCRM会员营销互动,积分商城,小程序商城,经营会员,实现私域流量变现

营销平台3.0OmniAPI

小程序商城售卖多类别产品的用户增长策略有哪些？电商资讯

爱奇艺20亿元收购天象互动娱乐；作业帮完成3.5亿美元D轮融资；挖财完成1.4亿美元D轮融资……

1.十大推广软件排行推广营销软件有哪些引流推广软件哪个好→十大推广营销软件榜单中,买购网小编主要总结了一批国内使用频率较高、较主流的营销工具,其中包括推广软件,和营销/运营分析平台,主要依据其普及度、知名度、功能优势、用户推荐量等因素,并综合参考互联网相关排行榜进行总结。榜单仅供参考,如有疑问,欢迎在末尾评论/交流。 为我喜欢的投票>> 本榜单仅供参考使用,如果对于https://www.maigoo.com/top/419916.html
2.互联网营销平台有哪些?十大常用的互联网营销平台推荐十大常用的互联网营销平台推荐 互联网营销平台有哪些? 互联网营销平台是随着互联网的发展而兴起的一种新型营销手段,它能够帮助企业快速提升宣传效果,增加销售额。但是,面对市面上众多的互联网营销平台,哪些是比较好用的呢?下面为大家总结了十大常用的互联网营销平台,希望对大家有所帮助。https://www.chuhai-club.com/article/95964.html
3.如何选择适合自己的推广app平台十大推广app平台解析新浪微博是一个开放性社交平台,用户可以自由发布内容。品牌可以利用微博进行话题营销,通过互动和分享,提升品牌的曝光度和用户参与度。 6. 小红书 小红书以社区分享为核心,用户在平台上分享购物体验和使用心得,品牌可以通过用户生成内容来提升可信度,吸引更多者关注和购买。 http://www.beautyflooringsh.com/bfgl/59811.html
4.免费推广引流平台社交媒体平台是当前最受欢迎的引流工具之一。无论是Facebook、Instagram、Twitter还是LinkedIn,这些平台都拥有亿万级的用户基础,能够帮助您快速扩大受众。利用社交媒体,您可以发布内容、互动、分享信息以及开展各种活动来吸引粉丝,从而实现引流的目的。同时,社交媒体广告类目尽管是收费的,但良好的内容营销策略可以帮助您在免费http://xlxxlx.com/post/77671.html
5.kol营销推广平台有哪些?这几个平台资源超多!以上六个平台都具有丰富的KOL资源,品牌可以根据自身需求和预算,选择合适的平台进行合作。在进行KOL营销推广时,品牌要注重与KOL的互动,确保推广内容的真实性和有效性。同时,品牌还需关注用户反馈,及时调整营销策略,以实现的推广效果。在互联网时代,善于利用KOL营销,将为品牌带来无限可能。 http://news.xnnews.com.cn/taoyitui/Article-xiaoxiaoYi-488.html
6.网络营销促销方案(精选11篇)2)投放平台推荐: (二)互动营销 1、营销目的 (1)增加关键字被搜索引擎收录的几率,提供xxx装饰相关关键字的信息的位置 (2)可以很好的宣传xxx装饰的品牌形象 “例如:xx装饰获得过那些荣誉?” “20xx年xxx十大装修公司有xx装饰吗?” “xxx装饰和xx装饰哪个更好?” https://www.ruiwen.com/word/wangluoyingxiaocuxiaofangan.html
7.微信营销活动方案10篇赛风微赢-微信营销平台内置多种新颖、好玩、有趣的微活动,如摁死小情侣、刮刮卡、砸金蛋、大转盘等,可以做到与粉丝进行双方的互动,通过整合多方资源,进行营销,不仅可以令粉丝持续增加,更可以提升粉丝的体验程度和营销的效果,让商家的国庆活动进行得如火如荼。https://www.unjs.com/huodongfangan/202304/6979088.html
8.互动营销平台以互动创意为核心,结合SaaS游戏平台和智慧大屏硬件,让顾客在数智零售场景获得更丰富多元的体验,加速链接品牌与顾客,助力实现营销降本增效。立即咨询 标准营销游戏平台 独立的【toB toC全域泛会员营销平台】,多终端硬件适配,可快速搭建线上/线下营销活动/游戏场景,帮助品牌实现品宣、引流、聚客、消费转化等营销目的,并能https://www.rongyi.com/interaction/marketing/
9.网络营销10大平台以下是我为您归纳的网络营销10大平台: 微信:作为中国最大的社交媒体平台之一,微信不仅拥有庞大的用户群体,还提供了朋友圈、公众号、小程序、企业微信等多种营销工具,能够帮助企业实现全方位的营销布局。 微博:微博是一个基于用户关系的社交媒体平台,具有强大的传播力和互动性。企业可以通过微博发布信息、与用户互动,https://agents.baidu.com/content/question/502c29abf138e411f01a9735
10.直播营销是什么?直播营销是利用实时的视频直播技术,通过与观众进行实时互动,实现品牌宣传、产品推广和销售增长的营销策略。本文将介绍直播营销的概念和重要性,并结尾推荐263企业直播营销平台作为实施直播营销的理想选择。 直播营销是一种利用实时视频直播技术与观众进行实时互动的营销方式。通过直播平台,企业可以实时展示产品特点、演示使用方https://www.263.net/blog/5311.html
11.投资者提问:公司旗下多彩互动的OPPO营销平台,是否已经投入使用投资者提问:公司旗下多彩互动的OPPO营销平台,是否已经投入使用,是否开始 投资者提问: 公司旗下多彩互动的OPPO营销平台,是否已经投入使用,是否开始盈利? 董秘回答(佳云科技SZ300242): 投资者您好,OPPO是公司多年合作媒体,公司为OPPO阅读行业独家代理,感谢您的关注。https://finance.sina.cn/stock/relnews/dongmiqa/2022-11-07/detail-imqqsmrp5199610.d.html
12.埋点神策小程序神策营销云,一款基于全域标签的数字化营销平台,它覆盖公域私域、线上线下全场景,基于全触点数据构建全域标签体系,助力企业在自营平台、微信生态等全渠道上精准触达用户,自动化营销互动,实时反馈效果,真正实现营销数字化。 1. 覆盖全渠道的有效互动与触达 https://blog.csdn.net/weixin_29009081/article/details/112467068
13.广告文案策划案例通用12篇网络营销顾名思义就是借助各种网络营销平台传播信息以达到促进销售或者提升形象的过程,它包括:一是要网络营销平台的选择,比如博客,论坛,第三方电子商务平台等;二是网络营销的传播具有口碑性,而不是简单的发外链;三是网络营销的实质是信息的传播,这些信息应该包含重要的商业元素;四是网络营销的目的是促进销售或提升形象https://xiandaiwuye.xueshu.com/haowen/47371.html
14.部分新书推介(续)皖江工学院从短视频拍摄前的准备与必备技能到短视频脚本的编写,从常见短视频剪辑制作工具到使用剪映、快剪辑、爱剪辑编辑视频,从抖音短视频的推荐机制到拍摄高质量的短视频,从快手短视频平台推荐机制到使用快手拍摄短视频,从微信视频号的推荐机制到视频号引流方法和运营技巧,从西瓜视频、淘宝短视频、B站短视频平台到短视频营销吸粉https://www.wjut.edu.cn/tu-shu-guan/good-book/pageinfo16146.html
15.推荐2018年创业者必备的105种工具Promo 是一个适用于所有企业的视频营销平台。你可以在几分钟时间内,用音乐、文本以及企业图标制作一个长达 15 秒时间的高质视频。每段视频都需要付费,但是价格可低至每 20 美元一个视频。Promo 还提供高质的视频和音乐库,内含 350 多万条片段。你无须为了视频或音频片段额外付费——这些都包含在单个视频的制作费https://www.51cto.com/article/567660.html
16.社交媒体营销新趋势:如何利用短视频引爆粉丝增长短视频已成为社交媒体营销的热门趋势,通过短视频的形式,可以快速吸引大量粉丝。通过评论区回复、点赞、分享等方式,鼓励观众参与互动,可以提升视频的热度和传播效果。通过互推、联名拍摄等方式,可以借助对方的粉丝基础,…https://m.sohu.com/a/791914740_121987886
17.微信公众平台有哪些营销互动活动公众号运营自媒体所谓微信互动营销,指的是企业和消费者在微信公众平台上互动起来,双方之间为了某一利益点默契的配合,企业从中得到销量,消费者得到需要的产品或服务,是一种共同的互利行为。 二、微信公众平台有哪些营销互动活动呢? 在移动互联网时代,人的想象力是无限的,新的互动方式总是不停出现。接下来小编就为大家推荐6款微信互动https://www.jb51.net/zimeiti/873990.html
18.如何进行用户群体画像,提升用户活跃度进行用户群体画像,提升用户活跃度的步骤包括:一、采集用户数据;二、清洗用户数据;三、分析用户数据;四、建立用户画像;五、进行个性化推荐;六、进行精准营销;七、打造社区互动平台;八、优化用户体验;九、不断迭代和改进。 一、采集用户数据 采集用户数据是用户群体画像的第一步,通过收集用户在平台上的行为数据、个人信https://www.linkflowtech.com/news/3557
19.微楼盘大趋势真正的房地产微信营销平台腾空出世如今,真正的微信营销平台已经腾空出世了,楼盘网“微楼盘”产品正式上线,“微楼盘”是一款专门方便房地产开发企业通过微信与购房者进行微营销搭建的智能平台,这是业内首个专为房地产行业研发的微信平台。从此,开发商与购房者之间多了一个互动新平台,沟通的新渠道,服务的新方式!https://m.loupan.com/leshan/news/201809/1132570
20.互动营销平台互动营销平台h5页面有奖活动 在线抽奖活动助力解决私域流量运营,实现爆发式增长 扶摇互动营销平台认为从运营层面分析属于用户运营的问题,互动营销活动、活动门槛、活动奖品、活动真实性,是做好在线抽奖活动,解决用户运营,轻松激活现有用户,实现爆发式增长的关键点。 https://www.fuyaoyx.com/tag-15
21.人人秀互动互动营销平台互动小游戏人人秀互动,一个免费的互动营销制作平台,提供100款互动营销玩法,上千款互动营销模板,免费试用,一键创建。无需门槛,操作简单,3分钟轻松制作上线,你要的互动功能这里都有!https://hd.rrx.cn/
22.微赞直播微赞直播是一家专注于微信生态的企业级直播营销服务提供商。它主要提供建立于微信生态之上的专业企业直播平台,帮助企业进行获客和品牌营销。该平台内置了多种互动营销方式、数据 微赞直播简介: 微赞直播是一家专注于微信生态的企业级直播营销服务提供商。它主要提供建立于微信生态之上的专业企业直播平台,帮助企业进行获https://pidoutv.com/sites/18951.html
23.《网络反不正当竞争暂行规定》发布澎湃号·政务澎湃新闻(二)通过直播、平台推荐、网络文案等方式,实施商业营销活动; (三)通过热搜、热评、热转、榜单等方式,实施商业营销活动; (四)其他虚假或者引人误解的商业宣传。 经营者不得帮助其他经营者实施前款虚假或者引人误解的商业宣传行为。 第九条 经营者不得实施下列行为,对商品生产经营主体以及商品销售状况、交易信息、经营https://www.thepaper.cn/newsDetail_forward_27362971
24.中万互联中万互联,极速在线建站平台,免费注册即拥“电脑+手机+微信”网站一站式专业建站平台,为您提供免费网站模板,免费网站建设、免费自助建站、免费网站、免费做网站、网页制作等建站服务http://www.zwhl.net.cn/
25.什么是互动营销?互动营销的平台有哪些?随着互联网发展越来越深入,消费者在进行网络信息浏览时会时常接触到各种营销信息,甚至在无意识的情况下与营销信息进行了互动,进而在思想中形成对某些消费性事物的潜在印象,可以说这就是互动营销的主要作用;那么互动营销到底是什么?可以进行互动营销的平台又有哪些呢?下面的文章将对此进行说明。 https://www.sgpjbg.com/info/34046.html
26.汇世信息科技Mintegral:程序化互动式移动广告平台Mintegral是程序化互动式移动广告平台,为全球开发者提供用户获取、广告变现和创意解决方案,助力解决跨区域营销难题,实现全球增长。https://www.mintegral.com/
27.小学一年级科学上册教学工作总结(通用15篇)最新的营销平台主要有: 1、内容类的:头条号、大鱼号、百家号、一点资讯、大风号、搜狐号等自媒体内容型平台。 2、视频类:抖音、快手、微视、美拍、西瓜视频、皮皮虾等短视频平台 3、直播类:抖音直播、快手直播、美拍直播、腾讯直播等这些最新的平台我们要学习怎么样运营?怎么样做最优质的内容输出,要学习平台规则https://www.diyifanwen.com/fanwen/jiaoxuegongzuozongjie/13601601.html