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