巨量引擎更新日志
巨量千川更新日志
更新日志

2022年6月23日

尊敬的开发者:

为了提供更好的服务,本次针对以下内容做改动。麻烦辛苦您提前关注更新内容,及时评估对您现有使用的影响以及改动。

  1. 授权流程更新(支持代理商按名下客户主体维度授权)

本逻辑将计划于「6月23日开始逐步灰度上线,直至全量上线」。本部分逻辑涉及到账户授权部分改造,请开发者密切关注,核心改动点可以参考 Marketing-API 代理授权逻辑升级接入文档 ,主要包括:

  • 代理授权链路下原逻辑仅支持通过agent_id授权其下所有adv,新逻辑将支持授权agent下的具体客户层级
  • 对于无代理授权需求,理论上本次改动无感;对于有代理授权场景下,若开发者需要感知到对应的授权粒度,需要进行改造处理

接口模块

接口名

path

更新字段

更新逻辑

Oauth2.0授权

Oauth

/open_api/oauth2/advertiser/get/

company_list

新增参数 company_list

账号服务

账户

/open_api/2/agent/advertiser/select/

company_list

新增参数 company_list

  1. 建站类型site_type新增支持类型托管落地页DEPOSITE。

接口模块

接口名

path

更新字段

更新逻辑

建站管理

获取橙子建站站点详细信息

/open_api/2/tools/site/read/

site_type

新增支持类型-托管落地页DEPOSITE

获取橙子建站站点列表

/open_api/2/tools/site/get/

site_type

新增支持类型-托管落地页DEPOSITE

  1. 调用【查询动态创意词包】接口时,支持返回替换词最小长度。

接口模块

接口名

path

新增字段

动态创意词包管理

查询动态创意词包

/open_api/2/tools/creative_word/select/

min_word_len

  1. 商品创建接口升级

接口模块

接口名

path

改动点

商品管理

创建DPA商品(无商品id)

/open_api/2/dpa/product/create/

补充了具体的使用场景

创建DPA商品(已有商品id)/修改DPA商品

/open_api/2/dpa/product/update/

原「修改DPA商品」接口

新增支持当商品id不存在时,直接使用广告主传入的商品id创建商品

【创建DPA商品(无商品id)】支持场景:

  1. 创建商品,并由媒体侧自动生成商品id

【创建DPA商品(已有商品id)/修改DPA商品】支持场景:

  1. 基于已有商品id 创建商品:广告主侧已有商品id,希望媒体侧直接该商品id作为商品索引
  1. 更新商品:已知某商品的商品id,对已有的商品信息进行修改


2022年6月21日

尊敬的开发者:

为了提供更好的服务,本次针对以下更新内容进行通知,请您提前关注,及时评估对您现有使用的影响以及改动。

1、销售线索投放链路(landing_type=link)2022-06-21正式下线「转化跟踪」能力并全部迁移至事件管理,已创建计划不受影响。

2、管家过滤已转化字段支持「组织」枚举值

接口模块

接口名

path

更新字段

更新逻辑

投放管家

设置项目计划信息

/open_api/v1.0/ad_lab/ad/create/

hide_if_converted

新增「ORGANIZATION」枚举值

获取项目信息

/open_api/v1.0/ad_lab/group/get/

2022年6月15日

尊敬的开发者:

为了提供更好的服务,本次针对以下更新内容进行通知,请您提前关注,及时评估对您现有使用的影响以及改动。

1、销售线索投放链路(landing_type=link)将于2022-06-21下线「转化跟踪」能力并全部迁移至事件管理,已创建计划不受影响。

2、再次通知您及时对接【获取低效素材】接口,避免无效创建,提升素材管理效率。

如果新建创意下视频素材全部为低效素材,那么创意将无法创建成功,建议更换其他素材,创建广告创意接口的拦截功能已于2022-06-14上线

接口模块

接口名

path

字段

更新逻辑

广告投放

创建自定义创意(营销链路)

/open_api/2/creative/custom_creative/create/

error_message

如果新建创意下视频素材全部为低效素材,那么创意将无法创建成功,并报错提示:所有视频素材均为低效素材,系统预估难以起量,建议更换。

修改自定义创意(营销链路)

/open_api/2/creative/custom_creative/update/

创建程序化创意(营销链路)

/open_api/2/creative/procedural_creative/create/

修改程序化创意(营销链路)

/open_api/2/creative/procedural_creative/update/

创建广告创意

/open_api/2/creative/create_v2/

修改创意信息

/open_api/2/creative/update_v2/

投放管家

设置项目创意信息

/open_api/v1.0/ad_lab/creative/create/

2022年6月10日

尊敬的开发者:

您好!

本次内容主要对SPI订阅服务支持「在投计划配额」进行通知,请关注。

开发者管理后台-订阅服务-SPI订阅中,新增支持「事件推送-在投计划配额」,您可以通过创建订阅任务,及时收到授权广告账户因健康度问题的被预警、被处罚和解除处罚通知。

目前支持事件:

event

事件名称

事件描述

事件所需要的权限

触发时机

QUOTA_WARN

账户健康

广告账户因健康度问题的被预警、被处罚和解除处罚通知

广告投放及其下任意子权限

事件发生时发送一次

详见SPI订阅-订阅服务类型


2022年6月9日

敬的开发者:

为了提供更好的服务,本次在营销链路上新增穿山甲轻互动组件,您可在创编时调用穿山甲轻互动组件,并可对该附加组件进行创建、更新和查询等操作。麻烦辛苦您提前关注更新内容,及时评估对您现有使用的影响以及改动。

围绕创意层级(营销链路)进行字段更新,附加组件增加「穿山甲轻互动组件」枚举值。

支持投放场景:

  • 投放位置:首选媒体->穿山甲
  • 投放形式:激励视频
  • 支持系统:iOS和安卓系统均支持

接口模块

更新类型

接口名称

接口

涉及字段(已有字段)

广告投放

新增支持类型

创建自定义创意(营销链路)

/open_api/2/creative/custom_creative/create/

component_materials

新增支持类型

修改自定义创意(营销链路)

open_api/2/creative/custom_creative/update/

component_materials

新增支持类型

创建程序化创意(营销链路)

open_api/2/creative/procedural_creative/create/

component_materials

新增支持类型

修改程序化自定义创意(营销链路)

open_api/2/creative/procedural_creative/update/

component_materials

可在【资产】下创建穿山甲轻互动组件,并更新和查询互动组件信息。

接口模块

更新类型

接口名称

接口

涉及字段(已有字段)

资产

新增支持类型

创建组件

open_api/2/assets/creative_component/create/

component_type、component_data

新增支持类型

更新组件

open_api/2/assets/creative_component/update/

component_type、component_data

新增支持类型

查询组件列表

open_api/2/assets/creative_component/get/

component_type、component_data


2022年6月8日

尊敬的开发者:

您好!

为提高平台广告探索效率,引导更正确的投放方式,巨量广告平台已上线「在投计划配额」机制。我们鼓励大家新建更有效的计划,在「在投计划配额」机制下,有助于广告主更有效地新建优质计划,并能养成及时关停低效计划的好习惯。

您可以通过【获取广告计划】和【获取项目信息】接口中的应答字段“广告计划操作状态(opt_status)”来识别因广告账户的在投广告配额达限、因此被系统暂停的广告计划或管家项目

接口模块

接口名

接口

应答字段

更新逻辑

广告投放

获取广告计划

/open_api/2/ad/get/

opt_status

广告计划操作状态(opt_status)的枚举值新增AD_STATUS_DISABLE_BY_QUOTA,表示当前账户的在投广告配额达限、因此系统暂停该广告

投放管家

获取项目信息

/open_api/v1.0/ad_lab/group/get/

opt_status

操作状态(opt_status)的枚举值新增DISABLE_BY_QUOTA,表示当前账户的在投广告配额达限、因此系统暂停该项目

获取项目列表

/open_api/2/adlab/groups/get/

opt_status

操作状态(opt_status)的枚举值新增DISABLE_BY_QUOTA,表示当前账户的在投广告配额达限、因此系统暂停该项目

若广告账户的在投广告配额达限,调用【更新广告计划】和【更新项目状态】接口时,若为启用且启用后计划/项目有可能占用配额,将启用失败,并提示“启用失败,当前账户的在投计划/广告配额达限”。您还可以通过已上线的【查询在投计划配额】接口,查询广告账户的在投计划配额和使用进度。


同时,再次通知您及时对接【获取低效素材】接口,避免无效创建,提升素材管理效率。

如果新建创意下素材全部为低效素材,那么创意将无法创建成功,建议更换其他素材。创建广告创意相关接口的拦截功能将于2022年6月中旬(预计2022年6月14日)上线。请务必提前关注【获取低效素材】接口,进行低效素材识别和管理。


2022年6月7日

尊敬的开发者:

为了提供更好的服务,本次针对事件管理感知共享应用资产相关字段进行上线。辛苦您提前关注更新内容,及时评估对您现有使用的影响以及改动。

注意:该字段只用于感知区分已有资产是共享的还是自己创建的,API暂时没有支持共享资产创建事件

接口模块

接口名

接口path

应答参数

更新逻辑

资产

获取已创建资产列表

/open_api/2/tools/event/assets/get/

role

字段上线

2022年5月30日

尊敬的开发者:

为了提供更好的服务,本次针对账户优选起量相关接口进行上线。辛苦您提前关注更新内容,及时评估对您现有使用的影响以及改动。

接口模块

接口名

path

更新逻辑

工具

新建优选起量任务

/open_api/2/tools/task_raise/create/

接口上线

查询优选起量任务

/open_api/2/tools/task_raise/get/

接口上线

关闭优选起量任务

/open_api/2/tools/task_raise/status/stop/

接口上线

查询优选起量状态

/open_api/2/tools/task_raise/optimization_ids/get/

接口上线

查询优选起量任务数据

/open_api/2/tools/task_raise/data/get/

接口上线

2022年5月27日

尊敬的开发者:

您好,

一、为了提升素材管理效率,【获取低效素材】接口正式上线:

接口模块

接口名

接口

字段

更新逻辑

素材管理

获取低效素材

open_api/2/file/video/efficiency/get/

全部

新增接口

1. 什么是低效素材? 

在一定历史投放周期内,素材累积消耗低于系统标准,即定义为低效素材。

目前低效素材仅针对视频素材进行识别。

2. 低效素材有什么影响?

根据整体数据分析,无论是复用低效素材新建计划或将低效素材稍加修改后重新使用,低效素材起量的可能性较小,进而影响计划的跑量能力;

如计划下出现大量低效素材,则该计划预计跑量困难,占用在投计划配额、投放人力和投放预算,建议更换素材。

3. 如依然使用低效素材会产生哪些问题?

如果新建创意下素材全部为低效素材,那么创意将无法创建成功,建议更换其他素材。创建广告创意相关接口的拦截功能将于2022年6月中旬上线。请务必提前关注【获取低效素材】接口,进行低效素材识别和管理。


二、为了提供更好的服务,本次针对MAPI支持字节小程序广告投放链路做出如下改动:

接口模块

接口名

接口

字段

更新逻辑

广告投放

创建广告计划(营销链路)

/open_api/2/ad/create/

asset_ids

事件管理资产id数组:

  1. 正常情况下数组限制上限为1个;当landing_type=link时上限为2个
  1. 若数组长度为2,需保证有一个小程序资产+落地页资产,顺序不强限制

创建自定义创意(营销链路)

/open_api/2/creative/custom_creative/create/

mini_program_info 字节小程序信息

-app_id 小程序/小游戏id

-start_path 启动路径

-params 页面监测参数

-type 小程序类型

-url 字节小程序调起链接

字段上线

创建程序化创意(营销链路)

/open_api/2/creative/procedural_creative/create/

获取创意详情

/open_api/2/creative/read_v2/

事件管理

事件管理资产获取

/open_api/2/tools/event/assets/get/

asset_type

新增枚举值:MINI_PROGRAME

mini_program 字节小程序快应用资产

-asset_name字节小程序资产名称

字段上线

mini_program

-asset_id 字节小程序资产ID

-asset_name 字节小程序资产名称

-mini_program_id 字节小程序ID

字段上线

获取可用优化目标

/open_api/2/tools/event_convert/optimized_goal/get/

mini_program_id

字段上线

asset_types

新增枚举值:MINI_PROGRAME字节小程序

2022年5月26日

尊敬的开发者:

为了提供更好的服务,本次针对「资产下创建事件」、「获取资产下已创建事件列表」接口的【statistical_type】字段下线进行正式通知。辛苦您提前关注更新内容,及时评估对您现有使用的影响以及改动。

模块

接口名

path

字段

更新逻辑

资产

资产下创建事件

/open_api/2/event_manager/events/create/

statistical_type

正式下线

资产

获取资产下已创建事件列表

/open_api/2/event_manager/event_configs/get/

statistical_type

正式下线

字段下线后针对计划层级上使用「每一次付费」和「仅一次付费」将由「deep_bid_type」深度优化方式字段来选择:

名称

external_action

deep_bid_type

每一次付费

AD_CONVERT_TYPE_PAY

BID_PER_ACTION

仅一次付费

AD_CONVERT_TYPE_PAY

不传

2022年5月23日

尊敬的开发者:

为了提供更好的服务,本次针对DPA商品库相关创建和修改接口对相关字段进行更新。麻烦辛苦您提前关注更新内容,及时评估对您现有使用的影响以及改动。

接口模块

接口名

接口

更新字段

更新逻辑

商品广告

创建DPA商品

/open_api/2/dpa/product/create/

sub_category、third_category

sub_category和third_category两个字段新增条件必填,当商品库类型为小说库时,必填。

修改DPA商品

/open_api/2/dpa/product/update/

sub_category、third_category

sub_category和third_category两个字段新增条件必填,当商品库类型为小说库时,必填。

2022年5月17日

尊敬的开发者:

为了提供更好的服务,本次更新针对

  1. 【重要通知】授权流程更新(支持代理商按名下客户主体维度授权)进行预通知
  2. 「资产下创建事件」接口的【statistical_type】字段下线进行预通知

请您提前关注更新内容,及时评估对您现有使用的影响以及改动。具体更新内容如下:

一、授权流程更新(支持代理商按名下客户主体维度授权)

本部分逻辑将计划于6月7日上线,本部分逻辑涉及到账户授权部分改造,请开发者密切关注,核心改动点可以参考 Marketing-API 代理授权逻辑升级接入文档 ,主要包括:

  • 代理授权链路下原逻辑仅支持通过agent_id授权其下所有adv,新逻辑将支持授权agent下的具体客户层级
  • 对于无代理授权需求,理论上本次改动无感;对于有代理授权场景下,若开发者需要感知到对应的授权粒度,需要进行改造处理

模块

接口名

path

更新逻辑

Oauth

获取已授权账户

/open_api/oauth2/advertiser/get/

新增参数 company_list

账户

代理商管理账户列表

/open_api/2/agent/advertiser/select/

新增参数 company_list

二、「资产下创建事件」下线【statistical_type】

本字段将于2022年5月26日进行下线

模块

接口名

path

字段

更新逻辑

资产

资产下创建事件

/open_api/2/event_manager/events/create/

statistical_type

下线

字段下线后针对计划层级上使用「每一次付费」和「仅一次付费」将由「deep_bid_type」深度优化方式字段来选择:

名称

external_action

deep_bid_type

每一次付费

AD_CONVERT_TYPE_PAY

BID_PER_ACTION

仅一次付费

AD_CONVERT_TYPE_PAY

不传

2022年5月12日

尊敬的开发者:

为了提供更好的服务,本次针对MAPI能力更新做出以下改动:

  1. 我们正式通知老版链路中landing_type=SHOP(电商店铺)已下线非营销链路的创编流程将不再能创建推广目的为电商店铺的组-计划-创意,新版营销链不影响
  1. RDS数据推送服务功能上线,提供更实时的报表数据获取方案,具体可关注使用指南

麻烦辛苦您提前关注更新内容,及时评估对您现有使用的影响以及改动。

接口模块

接口名

接口

下线逻辑

广告投放

创建广告组

open_api/2/campaign/create/

老版链路去除电商店铺SHOP(营销链路不受影响)

创建广告计划

open_api/2/ad/create/

修改广告计划

open_api/2/ad/update/

创建广告创意

open_api/2/creative/create_v2/

修改广告创意

open_api/2/creative/update_v2/


2022年5月10日

尊敬的开发者:

为了提供更好的服务,我们正式通知「获取音乐列表」接口完成下线,请您提前关注更新内容,及时评估对您现有使用的影响以及改动。

接口模块

接口名

接口path

工具

获取音乐列表

/open_api/2/tools/pic_to_video/music/get/

2022年5月9日

尊敬的开发者:

为了提供更好的服务,随着5G标签覆盖用户量级越来越大,MAPI配合新增网络类型“5G”枚举值。麻烦辛苦您提前关注更新内容,及时评估对您现有使用的影响以及改动。

在进行广告创编选择用户定向时,网络类型新增支持“5G"。

接口模块

接口名

接口

更新字段

新增枚举值

广告创编

获取广告计划

open_api/2/ad/get/ 

ac

5G

创建广告计划(营销链路)

/open_api/2/ad/create/ 

ac

5G

修改广告计划(营销链路)

/open_api/2/ad/update/

ac

5G


2022年5月6日

尊敬的开发者:

为了提供更好的服务,广告创编新增游戏预约链路,麻烦辛苦您提前关注更新内容,及时评估对您现有使用的影响以及改动。

  • 该游戏预约链路主要在landing_type=APP应用推广下支持,转化目标新增「预约下载」和「预约表单」。
    • 若下载方式选择下载链接,优化目标支持「预约下载」
    • 若下载方式为落地页时,优化目标支持「预约下载」和「预约表单」

1、围绕创编链路中创意层级(营销链路)进行字段更新,附加组件增加「游戏预约按钮」枚举值

更新类型

接口名称

接口

涉及字段

字段新增

创建自定义创意(营销链路)

/open_api/2/creative/custom_creative/create/

component_materials

字段新增

修改自定义创意(营销链路)

open_api/2/creative/custom_creative/update/

component_materials

字段新增

创建程序化创意(营销链路)

open_api/2/creative/procedural_creative/create/

component_materials

字段新增

修改程序化自定义创意(营销链路)

open_api/2/creative/procedural_creative/update/

component_materials

2、可在【资产】下创建「游戏预约按钮」组件,并更新和查询组件信息。

更新类型

接口名称

接口

涉及字段

字段新增

创建组件

open_api/2/assets/creative_component/create/

component_type、component_data

字段新增

更新组件

open_api/2/assets/creative_component/update/

component_type、component_data

字段新增

查询组件列表

open_api/2/assets/creative_component/get/

component_type、component_data

3、可在广告创意模块查看「游戏预约按钮」组件的适应逻辑。

组件名称

组件类型

展示/互动/转化

组件类型type

适用投放范围

广告组类型campaign_type

适配的创意类型 image_mode

可用的推广目的landing_type

下载链接

其他限制

一级行业

二级行业

游戏预约按钮

附加创意组件

转化组件

RESER

VATION_BUTTOM

INVENTORY_AWEME_FEED 抖音

SMART 优选广告位

信息流广告

CREATIVE_IMAGE_MODE_VIDEO横版视频CREATIVE_IMAGE_MODE_VIDEO_VERTICAL竖版视频

CREATIVE_IMAGE_MODE_GROUP组图CREATIVE_IMAGE_MODE_SMALL小图

CREATIVE_IMAGE_MODE_LARGE_VERTICAL大图竖图

CREATIVE_IMAGE_MODE_LARGE大图横图

应用推广

下载链接/落地页

当为ios应用:

  • 若下载方式选择下载链接,优化目标支持「预约下载」
  • 若下载方式为落地页时,优化目标支持「预约下载」和「预约表单」

当为安卓应用:

  • 下载方式选择下载链接时,优化目标支持「预约下载」
  • 若下载方式为落地页时,优化目标支持「预约下载」和「预约表单」

暂无要求

暂无要求


2022年4月26日

尊敬的开发者:

您好!

为提高平台广告探索效率,引导更正确的投放方式,巨量广告平台将上线「在投计划配额」机制。我们鼓励大家新建更有效的计划,在「在投计划配额」机制下,有助于广告主更有效地新建优质计划,并能养成及时关停低效计划的好习惯。

「在投计划配额」是每个广告主账户内可处于投放中状态的计划数量。

  • 每个广告主账户都有平等的「在投计划配额」起始值。系统将根据账户历史月度消耗确定所属档位,分配更多的「在投计划配额」。档位计算和升级规则请进入「巨量广告投放平台-工具-在投计划配额」界面查看。
  • 无论账户是否超出「在投计划配额」,都可正常新建计划送审;当开启计划投放时,若「投放中」计划数量小于「在投计划配额」,可正常开启投放,反之则开启失败。
  • 重要提示:4月26日上线的是查询功能,而非「在投计划配额」完整机制,预计6月6日巨量广告平台会正式上线「在投计划配额」缓冲版。

开放平台上线「查询在投计划配额」接口,该接口用于查询广告账户的在投计划配额和使用进度。

接口模块

接口名

接口

新增字段

工具-查询工具

查询在投计划配额

/open_api/2/tools/quota/get/

全部


2022年4月21日

尊敬的开发者:

为了提供更好的服务,本次针对MAPI能力更新做出以下改动:

1.销售线索支持微信小游戏投放

2.深度转化目标新增arpu枚举值、新增arpu出价字段

请您提前关注更新内容,及时评估对您现有使用的影响以及改动。

微信小游戏MAPI投放:

1.使用橙子建站生成的微信小游戏的落地页,可通过「获取优化目标」接口的site_id字段传入获取:

请求参数:(只提及涉及的相关字段,其他字段正常传入)

字段

类型

含义

site_id

number

建站site_id,当asset_type为建站TETRIS_EXTERNAL时必填,site_id可以通过【获取橙子建站站点列表】接口获得

返回参数(data部分):

字段

类型

含义

asset_ids

number[]

资产 id

2.在创编上,可通过「创建广告计划(营销链路)」接口,且landing_type=LINK(销售线索)的条件下,数据对接方式选择事件管理时进行微信小游戏的投放

请求参数:(只提及涉及的相关字段,其他字段正常传入)

字段

类型

含义

asset_ids

number[]

资产 id,可通过【获取推广内容】接口获取 当使用事件管理时必填

external_action

string

优化目标,可通过【获取优化目标】接口获取

deep_external_action

string

深度转化目标,可通过【获取优化目标】接口获取

3.投放微信小游戏支持的external_action, deep_external_action, deep_bid_type:

出价产品名

external_action

deep_external_action

deep_bid_type

付费直投

AD_CONVERT_TYPE_PAY(值:14)



关键行为

AD_CONVERT_TYPE_GAME_ADDICTION(值:25)



激活

AD_CONVERT_TYPE_ACTIVE(值:8)



次留双出价

AD_CONVERT_TYPE_ACTIVE(值:8)

AD_CONVERT_TYPE_NEXT_DAY_OPEN 次留

AUTO_MIN_SECOND_STAGE(自定义双出价 )

每次付费

(白名单使用)

AD_CONVERT_TYPE_PAY(值:14)


BID_PER_ACTION (每次付费 )

深度转化目标新增arpu枚举值、新增arpu出价字段:

1.deep_external_action新增枚举值:

接口模块

接口名

接口

涉及字段

新增枚举值

资产

获取优化目标

/open_api/2/tools/event_convert/optimized_goal/get/

deep_external_action

AD_CONVERT_TYPE_ARPU0

广告投放

创建广告计划(营销链路)

/open_api/2/ad/create/

修改广告计划(营销链路)

/open_api/2/ad/update/

获取广告计划

/open_api/2/ad/get/

2.新增arpu出价字段及其出价逻辑:

当使用arpu深度优化方式出价时,deep_bid_type=DEEP_BID_MIN,需同时设置cpa_bid、deep_cpabid、retention_bid才可出价成功。

接口模块

接口名

接口

新增字段

广告投放

创建广告计划(营销链路)

/open_api/2/ad/create/

retention_bid 留存出价

修改广告计划(营销链路)

/open_api/2/ad/update/

获取广告计划

/open_api/2/ad/get/

2022年4月18日

尊敬的开发者:

为了提供更好的服务,本次针对MAPI能力更新做出以下改动:

  1. 支持原生广告链路上,直接选取抖音号上视频作为投放素材
  1. 在营销链路新增轻互动组件(仅限抖音端)
  1. 查询应用分包列表接口中,应用状态枚举值更新

请您提前关注更新内容,及时评估对您现有使用的影响以及改动。

原生广告投放

原生广告的投放主要涉及到广告账户与抖音号或者单个视频的授权,以及对于已授权的视频的投放。在广告创编时,可以通过【获取抖音授权关系】、【获取抖音主页视频】接口获取能用于投放自定义创意的抖音短视频,以下为具体更新内容:

接口模块

更新类型

接口名

接口

工具

接口上线

获取抖音授权关系

/open_api/2/tools/aweme_auth_list/

查询视频是否挂载下载类锚点

/open_api/2/tools/video/check_available_anchor/

素材管理

获取抖音主页视频

/open_api/2/file/video/aweme/get/

创编上新增使用已授权的抖音短视频作为原生广告自定义创意的相关字段:

接口模块

更新类型

接口名

接口

涉及字段

广告投放

字段新增

创建自定义创意(营销链路)

/open_api/2/creative/custom_creative/create/

ies_core_user_id 抖音号

is_feed_and_fav_see 主页作品列表隐藏广告内容

aweme_item_id 抖音短视频ID

修改自定义创意(营销链路)

/open_api/2/creative/custom_creative/update/

获取创意列表

/open_api/2/creative/get/

aweme_item_id 抖音短视频ID

创意详细信息

/open_api/2/creative/read_v2/

互动组件:

围绕创意层级(营销链路)进行字段更新,附加组件增加「轻互动组件」枚举值

接口模块

更新类型

接口名称

接口

涉及字段

广告投放

字段新增

创建自定义创意(营销链路)

/open_api/2/creative/custom_creative/create/

component_materials

字段新增

修改自定义创意(营销链路)

open_api/2/creative/custom_creative/update/

component_materials

字段新增

创建程序化创意(营销链路)

open_api/2/creative/procedural_creative/create/

component_materials

字段新增

修改程序化自定义创意(营销链路)

open_api/2/creative/procedural_creative/update/

component_materials

可在【资产】下创建互动组件,并更新和查询互动组件信息。

接口模块

更新类型

接口名称

接口

涉及字段

资产

字段新增

创建组件

open_api/2/assets/creative_component/create/

component_type、component_data

字段新增

更新组件

open_api/2/assets/creative_component/update/

component_type、component_data

字段新增

查询组件列表

open_api/2/assets/creative_component/get/

component_type、component_data

字段新增

修改程序化自定义创意(营销链路)

open_api/2/creative/procedural_creative/update/

component_materials

应用分包

在【查询应用分包列表 (支持所有账户体系)】接口下,应用状态UDIT_DOING 审核中、AUDIT_REJECTED 审核失败、AUDIT_ACCEPTED 审核成功三个枚举值将在5月19日下线。此外,新增应用状态相关枚举值。

接口模块

更新类型

接口名称

接口

涉及字段

相关枚举值

工具

字段更新

查询应用分包列表 (支持所有账户体系)

/open_api/2/tools/app_management/extend_package/list_v2/

status

下线枚举值(5月19日):

AUDIT_DOING 审核中、AUDIT_REJECTED 审核失败、AUDIT_ACCEPTED 审核成功,即待发布

字段更新

查询应用分包列表 (支持所有账户体系)

/open_api/2/tools/app_management/extend_package/list_v2/

status

新增枚举值:

CREATING创建中、UPDATING更新中、CREATION_FAILED创建失败、UPDATE_FAILED更新失败

2022年4月13日

尊敬的开发者:

为了提供更好的服务,本次内容针对投放管家字段更新进行通知、针对获取音乐列表接口下线进行预通知、针对电商店铺下线进行预通知,请您提前关注更新内容,及时评估对您现有使用的影响以及改动。

  1. 重要通知:老版链路landing_type=SHOP(电商店铺),将于2022.5.10进行下线,涉及的创编流程将不再能创建推广目的为电商店铺的组-计划-创意;新版营销链路landing_type=SHOP(电商店铺)不影响

接口模块

接口名

接口

下线逻辑

广告投放

创建广告组

open_api/2/campaign/create/

老版链路去除电商店铺SHOP(营销链路不受影响)

创建广告计划

open_api/2/ad/create/

修改广告计划

open_api/2/ad/update/

创建广告创意

open_api/2/creative/create_v2/

修改广告创意

open_api/2/creative/update_v2/

  1. 对于投放管家模块,在「设置项目计划信息」、「获取项目信息」接口新增过滤已转化相关字段:

接口模块

接口名

接口

新增字段

投放管家

设置项目计划信息

/open_api/v1.0/ad_lab/ad/create/

过滤已转换对象类型:hide_if_converted

过滤时间范围:converted_time_duration

获取项目信息

/open_api/v1.0/ad_lab/group/get/

  1. 「获取音乐列表」接口将于2022.5.10进行下线

接口模块

接口名

接口

工具

获取音乐列表

/open_api/2/tools/pic_to_video/music/get/

2022年4月8日

尊敬的开发者:

为了提供更好的服务,新增转化目标枚举值以及相关数据指标,请您提前关注更新内容,及时评估对您现有使用的影响以及改动。

  1. 使用事件管理中的应用推广,当external_action=active时,新增枚举值:retention_7d 7日留存

接口模块

接口名

接口

涉及字段

新增枚举值

广告投放

创建广告计划(营销链路)

/open_api/2/ad/create/

deep_external_action

retention_7d 7日留存

获取广告计划

/open_api/2/ad/get/

deep_external_action

retention_7d 7日留存

资产

获取优化目标

/open_api/2/tools/event_convert/optimized_goal/get/

deep_external_action

retention_7d 7日留存

  1. 使用事件管理中的应用推广,当external_action=active 时,新增deep_external_action 字段枚举值、新增 deep_bid_type 字段枚举值

接口模块

接口名

接口

涉及字段

新增枚举值

广告投放

创建广告计划(营销链路)

/open_api/2/ad/create/

deep_external_action

RETENTION_DAYS 留存天数

deep_bid_type

DEEP_BID_TYPE_RETENTION_DAYS

获取广告计划

/open_api/2/ad/get/

deep_external_action

RETENTION_DAYS 留存天数

deep_bid_type

DEEP_BID_TYPE_RETENTION_DAYS

资产

获取优化目标

/open_api/2/tools/event_convert/optimized_goal/get/

deep_external_action

RETENTION_DAYS 留存天数

  1. 新增「7日留存」与「每日留存」数据指标

接口模块

接口名

接口

新增字段内容

数据报表

广告主数据

/open_api/2/report/advertiser/get/

attribution_retention_2d_cnt 应用下载广告数据-2日留存数

attribution_retention_2d_cost 应用下载广告数据-2日留存成本

attribution_retention_2d_rate 应用下载广告数据-2日留存率

attribution_retention_3d_cnt 应用下载广告数据-3日留存数

attribution_retention_3d_cost 应用下载广告数据-3日留存成本

attribution_retention_3d_rate 应用下载广告数据-3日留存率

attribution_retention_4d_cnt 应用下载广告数据-4日留存数

attribution_retention_4d_cost 应用下载广告数据-4日留存成本

attribution_retention_4d_rate 应用下载广告数据-4日留存率

attribution_retention_5d_cnt 应用下载广告数据-5日留存数

attribution_retention_5d_cost 应用下载广告数据-5日留存成本

attribution_retention_5d_rate 应用下载广告数据-5日留存率

attribution_retention_6d_cnt 应用下载广告数据-6日留存数

attribution_retention_6d_cost 应用下载广告数据-6日留存成本

attribution_retention_6d_rate 应用下载广告数据-6日留存率

attribution_retention_7d_cnt 应用下载广告数据-7日留存数

attribution_retention_7d_cost 应用下载广告数据-7日留存成本

attribution_retention_7d_rate 应用下载广告数据-7日留存率

attribution_retention_7d_sum_cnt 应用下载广告数据-7日留存总数

attribution_retention_7d_total_cost 应用下载广告数据-7日留存总成本

广告组数据

/open_api/2/report/campaign/get/

广告计划数据

/open_api/2/report/ad/get/

广告创意数据

/open_api/2/report/creative/get/

多合一数据报表

/open_api/2/report/integrated/get/

2022年4月7日

尊敬的开发者:

本次内容主要对「获取广告账户关联云图账户信息」接口和「推送dmp人群包到云图账户」接口上线进行正式通知,请您提前关注更新内容,及时评估对您现有使用的影响以及改动。

一、「获取广告账户关联云图账户信息」接口上线,通过此接口,可根据真实的客户adv_id 获取有权限的云图品牌列表信息,信息包括:品牌id、品牌名称、虚拟advid。

一级分类

二级分类

接口名称

接口地址

接口增加逻辑

DMP人群包管理

云图相关接口

获取广告账户关联云图账户信息

/open_api/2/dmp/brand/get/

接口上线

二、「推送dmp人群包到云图账户」接口上线,通过此接口,可将DMP人群包复制一个后,并推送至对应的云图账号内,可在人群模块自定义分析查看和应用。

一级分类

二级分类

接口名称

接口地址

接口增加逻辑

DMP人群包管理

云图相关接口

推送dmp人群包到云图账户

/open_api/2/dmp/brand/get/

接口上线

请再次关注更新内容。

2022年3月30日

尊敬的开发者:

本次更新日志为重要通知,为了提供更好的服务,主要针对「转化追踪」相关能力的变更进行更新预通知

变更内容:

1.从2022年4月20日起,「创建转化目标」接口将无法创建新的应用类转化目标;

2.从2022年4月29日起,调用创建计划,且当推广目的为应用推广(landing_type=APP)时,数据对接方式将不再支持「转化跟踪」,请使用「事件管理」作为数据对接方式。

请您提前关注更新内容,及时评估对您现有使用的影响以及改动。

2022年3月28日

尊敬的开发者:

为了提供更好的服务,主要围绕诊断,投放管家进行了更新,请您提前关注更新内容,及时评估对您现有使用的影响以及改动。

1.针对采纳计划诊断建议的场景,新增了返回建议采纳失败的原因以及采纳失败的建议类型字段,进一步的提供准确的采纳建议信息。

更新类型

接口名称

接口

涉及字段

字段上线

采纳计划诊断建议

/open_api/2/tools/diagnosis/suggestion/accept/

suggestion_type、fail_reason

2.针对投放管家,正式下线与管家计划相关的接口,新建的管家计划将不披露计划层级的信息。

更新类型

接口名称

接口

接口下线

更新计划状态

/open_api/2/adlab/ad_status/update/

批量查询计划信息

/open_api/2/adlab/ads/get/

更新计划目标成本

/open_api/2/adlab/ad_bid/update/

获取可操作计划列表

/open_api/2/adlab/group_ads/get/

优质计划保护

/open_api/2/adlab/ad_superior/set/

2022年3月23日

尊敬的开发者:

为了提供更好的服务,主要围绕营销链路,事件管理进行了更新,麻烦辛苦您提前关注更新内容,及时评估对您现有使用的影响以及改动。

  1. 营销链路 - 电商店铺推广目的上线 (3月23日) 支持新营销链路上创建电商店铺推广目的计划 支持电商店铺推广目的的店铺停留时长,目标转化率等新能力

更新类型

接口名称

接口

涉及字段

字段更新

创建广告组

/open_api/2/campaign/create/

landing_type、marketing_purpose

字段更新

查询广告组

/open_api/2/campaign/get/

landing_type、marketing_purpose

字段新增

创建广告计划

/open_api/2/ad/create/

landing_page_stay_time、target_cvr

字段新增

修改广告计划

/open_api/2/ad/update/

landing_page_stay_time、target_cvr

字段新增

查询广告计划

/open_api/2/ad/get/

landing_page_stay_time、target_cvr

字段新增

创建程序化创意

/open_api/2/creative/procedural_creative/create/

ad_data.open_url

字段新增

创建自定义创意

/open_api/2/creative/custom_creative/create/

ad_data.open_url

字段新增

修改程序化创意

/open_api/2/creative/procedural_creative/update/

ad_data.open_url

字段新增

修改自定义创意

/open_api/2/creative/custom_creative/update/

ad_data.open_url

字段更新

查询创意详情

/open_api/2/creative/read_v2/

open_url

字段更新

获取优化目标

/open_api/2/tools/event_convert/optimized_goal/get/

landing_type

  1. 支持事件管理管理应用、快应用资产 支持在事件管理下增删应用资产/事件、快应用资产/事件

更新类型

接口名称

接口

涉及字段

字段新增

创建事件管理资产

/open_api/2/event_manager/assets/create/

quick_app_asset、app_asset

字段更新

获取已创建资产列表

/open_api/2/campaign/get/

asset_type、filtering.app、filtering.quick_app、quick_app、app

枚举值新增

获取资产下已创建事件列表

/open_api/2/event_manager/event_configs/get/

statistical_type

字段新增

在资产下创建事件

/open_api/2/tools/event/assets/get/

statistical_type、track_types

接口上线

创建监测链接

/open_api/2/event_manager/track_url/create/

-

接口上线

获取监测链接

/open_api/2/event_manager/track_url/get/

-

接口上线

更新监测链接

/open_api/2/event_manager/track_url/update/

-

  1. 支持在应用推广,快应用推广下使用事件管理资产 获取优化目标可以获取到快应用,应用下的资产id和转化目标 创建计划时可以使用事件管理的资产id、转化目标创建计划

更新类型

接口名称

接口

涉及字段

字段新增

创建广告计划

/open_api/2/ad/create/

track_url_group_id、track_url_group_type

字段更新

获取优化目标

/open_api/2/tools/event_convert/optimized_goal/get/

asset_type、package_name、app_type

2022年3月18日

      尊敬的开发者:

本次内容主要对搜索广告动态化创意字段新增枚举值变动进行通知,以及部分接口默认值下线(4.5下线旧允许值)进行预通知,请您提前关注更新内容,及时评估对您现有使用的影响以及改动。

一级分类

二级分类

接口名称

接口请求地址

参数类型

字段

字段描述

增加逻辑

搜索广告投放

搜索广告创意模块

创建广告创意

/open_api/2/creative/create_v2/

请求参数

dynamic_creative_switch

旧允许值:DYNAMIC_CREATIVE_TITLE, DYNAMIC_CREATIVE_ABSTRACT,DYNAMIC_CREATIVE_SUBLINK,新新允许值:DYNAMIC_CREATIVE_ON (4.5下线旧允许值

默认值:DYNAMIC_CREATIVE_ON(4.5下线默认值

当传入不为空时,等同于传入DYNAMIC_CREATIVE_ON

当传入 [ ] 时,关闭动态创意

增加枚举值

修改创意信息

/open_api/2/creative/update_v2/

广告投放

广告创意模块

创建自定义创意(营销链路)

/open_api/2/creative/custom_creative/create/

旧允许值:DYNAMIC_CREATIVE_TITLE, DYNAMIC_CREATIVE_ABSTRACT,DYNAMIC_CREATIVE_SUBLINK,

新允许值:DYNAMIC_CREATIVE_ON (4.5下线旧允许值

默认值:DYNAMIC_CREATIVE_ON

当传入不为空时,等同于传入DYNAMIC_CREATIVE_ON

当传入 [ ] 时,关闭动态创意

修改自定义创意(营销链路)

/open_api/2/creative/custom_creative/update/

旧允许值:DYNAMIC_CREATIVE_TITLE, DYNAMIC_CREATIVE_ABSTRACT,DYNAMIC_CREATIVE_SUBLINK,

新允许值:DYNAMIC_CREATIVE_ON (4.5下线旧允许值

当传入不为空时,等同于传入DYNAMIC_CREATIVE_ON

当传入 [ ] 时,关闭动态创意

不传时,不改变已有的值

注意:该字段为【增量更新】

创建程序化创意(营销链路)

/open_api/2/creative/procedural_creative/create/

旧允许值:DYNAMIC_CREATIVE_TITLE, DYNAMIC_CREATIVE_ABSTRACT,DYNAMIC_CREATIVE_SUBLINK,

新允许值:DYNAMIC_CREATIVE_ON (4.5下线旧允许值

默认值:DYNAMIC_CREATIVE_ON

当传入不为空时,等同于传入DYNAMIC_CREATIVE_ON

当传入 [ ] 时,关闭动态创意

修改程序化创意

(营销链路)

/open_api/2/creative/procedural_creative/update/

旧允许值:DYNAMIC_CREATIVE_TITLE, DYNAMIC_CREATIVE_ABSTRACT,DYNAMIC_CREATIVE_SUBLINK,新新允许值:DYNAMIC_CREATIVE_ON (4.5下线旧允许值

当传入不为空时,等同于传入DYNAMIC_CREATIVE_ON

当传入 [ ] 时,关闭动态创意

不传时,不改变已有的值

注意:该字段为【增量更新】

创意详细信息

/open_api/2/creative/read_v2/

旧允许值:DYNAMIC_CREATIVE_TITLE, DYNAMIC_CREATIVE_ABSTRACT,DYNAMIC_CREATIVE_SUBLINK,新新允许值:DYNAMIC_CREATIVE_ON (4.5下线旧允许值

默认值:DYNAMIC_CREATIVE_ON(4.5下线默认值

当传入不为空时,等同于传入DYNAMIC_CREATIVE_ON

当传入 [ ] 时,关闭动态创意

修改创意信息

/open_api/2/creative/update_v2/

2022年3月14日

尊敬的开发者:

您好!为了提供更优质的服务,提高开发文档的阅读交互体验,巨量引擎开放平台现已完成开发文档的结构升级优化,搭建业务标签体系。此次更新的重要升级点如下:

1、新版文档以「业务线+使用场景」结构划分(例如应用管理/线索回收管理业务、应用推广/线索获取场景),开发者可根据自身接入场景进一步筛选符合需求的接口,极大程度减少信息检索成本,精准定位。

2、新增「近期上线」模块,该模块直接提供接口新能力的支持,并适配相应场景的解决方案介绍。实现特定能力单点切入,降低开发者对新能力的接入门槛。

3、新增「Marketing UI」前端解决方案模块,以更直观的可交互试用落地页为开发者提供各类前端组件,有效助力搭建自有系统。


2022年3月10日

 尊敬的开发者:

         本次内容主要对诊断工具新增诊断场景、结论字段、场景类型字段、工具枚举值和工具参数详细说明、广告数据报表下新增24h指标字段、SPI创意审核状态实时推送变动进行通知,请您提前关注更新内容,及时评估对您现有使用的影响以及改动。

更新内容:

  1. 工具模块下对【获取计划诊断信息】的「获取计划诊断建议」「采纳计划诊断建议」接口新增诊断场景和工具,场景类型字段,结论字段、工具枚举值和工具参数详细说明。

一级分类

二级分类

接口名称

接口请求地址

参数类型

字段名称

增加逻辑

工具模块

获取计划诊断信息

获取计划诊断建议

/open_api/2/tools/diagnosis/suggestion/get/

请求参数

scene

希望获取建议的场景,新增允许值:

PROBLEM问题场景

应答参数


-scene_list

计划对应的场景列表

scene

场景名称,新增允许值:PROBLEM问题场景

-suggestions

建议列表


conclusion


诊断结论,当scene=POTENTIAL时,该字段为空


scene_type


场景下的细分类型,允许值:

当 scene=CLEAN时,值为学习期失败率高,空耗,活跃度低,创意挤压严重

当 scene=POTENTIAL时,值为潜力计划

当 scene=PROBLEM时,值为起量困难,掉量,衰减,优化潜力

name


新增值:

  • 开启一键起量
  • 使用系统推荐定向
  • 程序化创意
  • 智能放量
  • 一键优化原计划
  • 暂停
  • 一键优化并新建
  • 开启自动派生
  • 修改预算
  • 开启优先跑量
  • 开启智能调控
  • 一键继承并新建
  • 开启放量投放
  • 开启一键继承

-tools

工具列表

tool


新增枚举值:

  • feed_deliver_search 开启搜索快投
  • modify_bid 修改出价
  • modify_budget 修改预算
  • smart_control 智能调控
  • interfere_raise 一键起量
  • flow_control_mode_fast 开启优先跑量
  • auto_extend 开启智能放量
  • ad_inherit 开启一键继承
  • auto_bid 自动出价
  • new_ad_with_procedural_creative 程序化创意推荐
  • smart_target 系统推荐定向

-params

工具参数列表

param_name


工具参数名称,新增枚举:

  • budget 预算
  • target 放开的定向
  • optimize_cost 自动出价优化成本
  • daily_budget 日预算
  • ad_name 一键优化并新建新计划名字
  • title_materials 一键优化并新建标题素材
  • image_materials 一键优化并新建图片素材
  • video_materials 一键优化并新建视频素材


-param_value


list_param

列表类型参数

object_list_param

对象列表类型参数,详细信息见【工具参数名称&工具参数值 对应说明】

工具参数名称&工具参数值 对应说明

工具参数名

工具参数值类型

描述

title_materials

object_list_param

【必传】标题对象的list,一个标题对象有两个属性:

title :标题文案

word_ids :标题文案中如果有词包时,传入词包ID,多个词包ID用英文都好 , 分隔

image_materials

object_list_param

【至少一个图片/视频素材】图片素材对象的list,一个图片素材对象有两个属性:

image_mode :素材类型枚举值

image_id :图片素材URI

video_materials


object_list_param

【至少一个图片/视频素材】视频素材对象的list,一个视频素材对象有三个属性:

image_mode :素材类型枚举值

video_id :视频vid

cover_image_id :封面图片URI

一级分类

二级分类

接口名称

接口请求地址

参数类型

字段名称

增加逻辑

工具模块

获取计划诊断信息

采纳计划诊断建议

/open_api/2/tools/diagnosis/suggestion/accept/

请求参数


-tools

工具列表

tool

新增枚举值:

  • feed_deliver_search 开启搜索快投
  • modify_bid 修改出价
  • modify_budget 修改预算
  • smart_control 智能调控
  • interfere_raise 一键起量
  • flow_control_mode_fast 开启优先跑量
  • auto_extend 开启智能放量
  • ad_inherit 开启一键继承
  • auto_bid 自动出价
  • new_ad_with_procedural_creative 程序化创意推荐
  • smart_target 系统推荐定向

-params

工具参数列表

param_name

工具参数名称,新增枚举:

  • budget 预算
  • target 放开的定向
  • optimize_cost 自动出价优化成本
  • daily_budget 日预算
  • ad_name 一键优化并新建新计划名字
  • title_materials 一键优化并新建标题素材
  • image_materials 一键优化并新建图片素材
  • video_materials 一键优化并新建视频素材


-param_value必填

工具参数值

list_param 条件必填

列表类型参数

object_list_param 条件必填

对象列表类型参数,详细信息见【工具参数名称&工具参数值 对应说明】

  1. 广告数据报表下【广告主数据】、【广告组数据】、【广告计划数据】、【广告创意数据】接口新增5个24h数据指标字段

一级分类

二级分类

接口名称

接口请求地址

参数类型

字段名称

增加逻辑


数据报表


广告数据报表

广告主数据

/open_api/2/report/advertiser/get/


应答参数

  • attribution_active_pay_intra_one_day_count(游戏行业-激活后24h首次付费数)
  • attribution_active_pay_intra_one_day_cost(游戏行业-激活后24h首次付费成本)
  • attribution_active_pay_intra_one_day_rate(游戏行业-激活后24h首次付费率)
  • attribution_active_pay_intra_one_day_amount(游戏行业-激活后24h付费金额)
  • attribution_active_pay_intra_one_day_roi(游戏行业-激活后24小时付费roi)


字段上线

广告组数据

/open_api/2/report/campaign/get/

广告计划数据

/open_api/2/report/ad/get/

广告创意数据

/open_api/2/report/creative/get/

  1. SPI消息订阅【创意审核状态实时推送】增加返回归属ad_id

订阅类型

data(订阅类型对应推送数据信息)

备注

audit.creative.realtime


增加ad_id

一次创意变更推送一次

2022年3月8日

尊敬的开发者:

        本次内容主要对商品广告下「获取商品列表」接口新增字段、「DPA商品增删改」相关接口上线、投放管家「批量查询计划信息」接口下线(下线时间2022.3.11)、搜索广告「创建广告创意」「修改创意信息」接口和广告投放模块「创建自定义创意」「修改自定义创意」字段旧枚举值下线(下线时间2022.4.5)、搜索广告「创建广告创意」「修改创意信息」接口和广告投放模块「创建自定义创意」「修改自定义创意」字段新枚举值上线(上线时间2022.3.15)进行通知及预通知,请您提前关注更新内容,及时评估对您现有使用的影响以及改动。

更新内容

  1. 商品广告模块下「获取商品列表」接口新增字段。

一级分类

接口名称

接口请求地址

增加逻辑

商品广告

获取商品列表

/open_api/2/dpa/detail/get/

新增应答字段

  1. 商品广告模块下「创建DPA商品」「修改DPA商品」「批量修改DPA商品状态」「删除DPA商品」接口上线。

一级分类

接口名称

接口请求地址

增加逻辑


商品广告

创建DPA商品

/open_api/2/dpa/product/create/

接口上线

修改DPA商品

/open_api/2/dpa/product/update/

接口上线

批量修改DPA商品状态

/open_api/2/dpa/product_status/batch_update/

接口上线

删除DPA商品

/open_api/2/dpa/product/delete/

接口上线

  1. 投放管家模块「批量查询计划信息」接口下线。

一级分类

二级分类

接口名称

接口请求地址

增加逻辑

投放管家

项目查询

批量查询计划信息

/open_api/2/adlab/ads/get/

接口下线

  1. 下线搜索广告创意模块「创建广告创意」、「修改创意信息」接口和广告投放模块「创建自定义创意」「修改自定义创意」接口的【dynamic_creative_switch】动态创意类型旧枚举值并且新增枚举值。

一级分类

二级分类

接口名称

接口请求地址

字段

字段描述

参数类型

增加逻辑

搜索广告投放

搜索广告创意模块

创建广告创意

/open_api/2/creative/create_v2/

dynamic_creative_switch

启用动态创意类型,详见【附录-动态创意类型】 允许值:DYNAMIC_CREATIVE_TITLE, DYNAMIC_CREATIVE_ABSTRACT,DYNAMIC_CREATIVE_SUBLINK,默认全选


请求参数


下线3个枚举值

修改创意信息

/open_api/2/creative/update_v2/

广告投放


广告创意模块

创建自定义创意(营销链路)

/open_api/2/creative/custom_creative/create/

修改自定义创意(营销链路)

/open_api/2/creative/custom_creative/update/

搜索广告投放

搜索广告创意模块

创建广告创意

/open_api/2/creative/create_v2/

dynamic_creative_switch


增加新枚举值:DYNAMIC_CREATIVE_ON


请求参数

新增枚举值

修改创意信息

/open_api/2/creative/update_v2/

广告投放


广告创意模块

创建自定义创意(营销链路)

/open_api/2/creative/custom_creative/create/

修改自定义创意(营销链路)

/open_api/2/creative/custom_creative/update/

2022年3月2日

尊敬的开发者:

         本次内容主要对「查询人群包详细信息」接口新增字段、橙子建站模块下部分接口新增字段、投放管家下部分接口将于2022.3.7日下线、企业号评论管理功能上线进行正式通知,请您提前关注更新内容,及时评估对您现有使用的影响以及改动。

更新内容

  1. 「查询人群包详细信息」接口新增字段【exist_pull_off_tag】,用来判断人群包是否包含下线标签,包含已下线标签的人群包无法继续使用。

一级分类

接口名称

接口请求地址

字段

字段描述

参数类型

增加逻辑

DMP人群管理

人群包详细信息

/open_api/2/dmp/custom_audience/read/

exist_pull_off_tag

人群包是否包含下线标签,枚举值:

0不包含,1包含

应答参数

字段上线

  1. 建站管理-橙子建站模块下「基于站点创建模板」「基于模板创建站点」「获取站点模板列表」新增【wechat_game】字段

一级分类

二级分类

接口名称

接口请求地址

新增字段


字段类型

参数类型

增加逻辑


建站管理



橙子建站模版管理


基于站点创建模版

//open_api/2/tools/site_template/create/


wechat_game


object

应答参数

微信小游戏组件

-

instance_id


number


应答参数


微信小游戏组件ID,当wechat_game不为空时,有返回值。用户可以通过【青鸟线索通平台】获取微信小游戏组件ID

items

array[string]

应答参数

标签,个数不超过2,字数不超过5

introduction

string

应答参数

简介,长度不超过40

logo

string

应答参数

logo链接地址

基于模板创建站点


/open_api/2/tools/site_template/site/create/


wechat_game


object

请求参数

微信小游戏组件,当typeWECHAT_GAME时,必填

-

instance_id

number

请求参数

微信小游戏组件ID,当wechat_game不为空时,有返回值。用户可以通过【青鸟线索通平台】获取微信小游戏组件ID

items

array[string]

请求参数

标签,个数不超过2,字数不超过5

introduction

string

请求参数

简介,长度不超过40

logo

string

请求参数

logo链接地址

获取站点模版列表

/open_api/2/tools/site_template/get/

wechat_game


object

应答参数

微信小游戏组件

-


instance_id

number

应答参数


微信小游戏组件ID,当wechat_game不为空时,有返回值。用户可以通过【青鸟线索通平台】获取微信小游戏组件ID

items

array[string]

应答参数

标签,个数不超过2,字数不超过5

introduction

string

应答参数

简介,长度不超过40

logo

string

应答参数

logo链接地址

  1. 对投放管家的「更新计划状态」「更新计划目标成本」「获取可操作计划列表」「优质计划保护」接口下线(下线日期:2022.3.7)

一级分类

二级分类

接口名称

接口请求地址

增加逻辑

投放管家

项目修改

更新计划状态

/open_api/2/adlab/ad_status/update/

下线


计划分析报表

更新计划目标成本

/open_api/2/adlab/ad_bid/update/

下线

获取可操作计划列表

/open_api/2/adlab/group_ads/get/

下线

优质计划保护

/open_api/2/adlab/ad_superior/set/


下线


  1. 面向企业号开发者开放企业号评论管理能力。

一级分类

二级分类

接口名称

接口请求地址

增加逻辑

企业号

评论管理


获取评论列表

/open_api/v1.0/enterprise/comment/list/get/

接口上线

获取评论的回复

/open_api/v1.0/enterprise/comment/reply/list/

接口上线

获取评论从属信息

/open_api/v1.0/enterprise/comment/detail/

接口上线

回复评论

/open_api/v1.0/enterprise/comment/reply/

接口上线

获取企业号视频列表

/open_api/v1.0/enterprise/item/list/

接口上线

2022年2月24日

尊敬的开发者:

本次内容主要对「查询账户可转余额」接口上线、「查询程序化创意包」接口下线、广告创意模块下程序化创意包相关字段下线进行正式通知,请您提前关注更新内容,及时评估对您现有使用的影响以及改动。

一、「查询可转账余额」接口上线,通过此接口可获取广告主、代理商或组织账户下的各类可转资金余额信息

一级分类

二级分类

接口名称

接口请求地址

增加逻辑

帐号服务

资金和流水管理

查询账户可转余额

open_api/2/advertiser/transferable_fund/get/

接口上线

二、「查询程序化创意包」接口正式下线(已于2021年12月17日进行预通知)

一级分类

二级分类

接口名称

接口请求地址

增加逻辑

工具

查询工具

查询程序化创意包

open_api/2/tools/procedural_package/get/

接口下线

三、广告创意模块下程序化创意包相关字段正式下线(已于2021年12月17日进行预通知)

一级分类

二级分类

接口名称

接口请求地址

字段

参数类型

增加逻辑


广告投放



广告创意模块


创建程序化创意(营销链路)


open_api/2/creative/procedural_creative/create/


procedural_package

  • package_id



请求参数


字段下线


修改程序化创意(营销链路)

open_api/2/creative/procedural_creative/update/

创建广告创意

open_api/2/creative/create_v2/


  • procedural_package_id


修改创意信息

open_api/2/creative/update_v2/

创意详细信息

open_api/2/creative/read_v2/ 

  • procedural_package_id
  • procedural_package_version

应答参数

请再次关注更新内容。


2022年2月22日

尊敬的开发者:

本次内容主要对「代理商转账」、「代理商退款」接口transfer_type字段【CASH】枚举值下线、SPI支持广告主报表实时数据、SPI支持获取推送数据列表、SPI推送失败数据查询接口预下线进行正式通知,请您提前关注更新内容,及时评估对您现有使用的影响以及改动。

更新内容

  1. 「代理商转账」、「代理商退款」接口转账类型transfer_type字段【CASH】枚举值已正式下线(已于2022年1月19日进行预通知)

一级分类

二级分类

接口名称

接口请求地址

字段

参数类型

增加逻辑


账号服务



资金和流水管理

代理商转账

open_api/2/agent/advertiser/recharge/


transfer_type


请求参数


CASH 现金】枚举值已下线

代理商退款

open_api/2/agent/advertiser/refund/

  1. SPI支持广告主报表实时数据,当广告主维度报表数据发生变更时,通过订阅的数据推送任务接收变更的广告主id
  1. SPI支持获取推送数据列表,该接口用于查询2天内SPI推送给开发者回调地址的数据,包含推送成功和失败的数据,同时针对“推送失败数据查询接口”该接口会于2022.3.31号下线

请再次关注更新内容。


2022年2月17日

尊敬的开发者:

        本次更新针对【搜索广告自动加词功能】和【一键继承优质计划功能】进行通知:

       1.【创建广告计划】【查询广告计划】接口支持一键继承优质计划,请注意该变化在只投穿山甲下不可用,请您提前关注更新内容,及时评估对您现有使用的影响以及改动。

一级分类

二级分类

接口名称

接口请求地址

新增字段

字段类型

参数类型

增加逻辑


广告投放



广告计划模块


获取广告计划


/open_api/2/ad/get/


auto_inherit_switch

string

应答参数

一键继承开关,ON表示开启一键继承,OFF表示关闭一键继承

inherit_type

string

应答参数

一键继承账户类型,auto_inherit_switch为ON时有意义,INHERIT_FROM_ACCOUNT表示从同账户下的优质计划中继承,INHERIT_FROM_CUSTOMER表示从同账户所在组织下的其他账户的优质计划中继承

inherited_advertiser_id

number[]

应答参数

一键继承的同组织账户id的list,inherit_type等于INHERIT_FROM_CUSTOMER时有意义


      广告投放


广告计划模块


创建广告计划(营销链路)


/open_api/2/ad/create/ 


inherit_type

string

请求参数

一键继承账户类型,在auto_inherit_switch为ON时有意义,允许值INHERIT_FROM_ACCOUNT表示从同账户下的优质计划中继承,INHERIT_FROM_CUSTOMER表示从同账户所在组织下的其他账户的优质计划中继承

auto_inherit_switch

string

请求参数

一键继承开关,允许值OFF表示不开启一键继承,ON表示使用开启一键继承。 默认值: OFF

inherited_advertiser_id

number[]

请求参数

一键继承的同组织下其他广告主id,在inherit_type为INHERIT_FROM_CUSTOMER时有意义,限制数量1-3个


        2.搜索广告的【获取广告计划】【创建广告计划】【修改计划状态】接口新增自动加词功能,请注意该变化仅在搜索广告下可用,请您提前关注更新内容,及时评估对您现有使用的影响以及改动。

一级分类

二级分类

接口名称

接口请求地址

新增字段

字段类型

参数类型

增加逻辑

广告投放

广告计划模块

获取广告计划

/open_api/2/ad/get/ 

auto_update_keyword

string

返回参数

是否开启自动加词,允许值:ON(开启),OFF(关闭)

广告投放

广告计划模块

修改广告计划(营销链路)

/open_api/2/ad/update/ 

auto_update_keyword

string

请求参数

是否开启自动加词,允许值:ON(开启),OFF(关闭)

广告投放

广告计划模块

创建广告计划

(营销链路)

/open_api/2/ad/create/

auto_update_keyword

string

请求参数

是否开启自动加词,允许值:ON(开启),OFF(关闭)

请再次关注更新日志。


2022年2月10日

尊敬的开发者:

本次更新主要针对「获取广告计划」「创建广告计划」「修改广告计划」接口新增支持RTA定向字段进行通知,请注意该变化仅在DPA推广目的下可用,请您提前关注更新内容,及时评估对您现有使用的影响以及改动。

一级分类

二级分类

接口名称

接口请求地址

新增字段

字段类型

参数类型

增加逻辑

广告投放

广告计划模块

获取广告计划

/open_api/2/ad/get/ 

dpa_rta_switch

string

返回参数

RTA重定向选项:

值:ON(开启)/OFF(关闭)





dpa_rta_recommend_type

string

返回参数

RTA推荐逻辑:

ONLY:仅RTA推荐商品

MORE:基于RTA推荐更多商品

广告投放

广告计划模块

创建广告计划

/open_api/2/ad/create/

dpa_rta_switch

string

请求参数

RTA重定向选项

值:ON(开启)/OFF(关闭)





dpa_rta_recommend_type

string

请求参数

RTA推荐逻辑:

ONLY:仅RTA推荐商品

MORE:基于RTA推荐更多商品

广告投放

广告计划模块

修改广告计划

/open_api/2/ad/update/ 

dpa_rta_switch

string

请求参数

RTA重定向选项

值:ON(开启)/OFF(关闭)





dpa_rta_recommend_type

string

请求参数

RTA推荐逻辑:

ONLY:仅RTA推荐商品

MORE:基于RTA推荐更多商品

请再次关注更新日志。


2022年1月24日

尊敬的开发者:

本次内容主要针对广告计划状态的SPI消息推送,麻烦辛苦您提前关注更新内容,及时评估对您现有使用的影响以及改动

更新内容:

上线“广告计划状态实时推送”服务,您可在“开发者管理后台-订阅服务”订阅该消息,当广告计划状态发生变更时,我们会第一时间给您发送通知,具体见广告计划状态实时推送

请再次关注更新日志。


2022年1月19日

尊敬的开发者:

本次内容主要对「代理商转账」、「代理商退款」接口transfer_type字段枚举值变动进行通知,请您提前关注更新内容,及时评估对您现有使用的影响以及改动。

更新内容

  1. 代理商转账退款接口转账类型【transfer_type】字段新增6项枚举值:预付通用、预付竞价专用、预付品牌专用、授信通用、授信竞价专用、授信品牌专用(生效时间:1月18日)
  1. 代理商转账退款接口转账类型【transfer_type】字段将于2月8日下线现金枚举值

一级分类

二级分类

接口名称

接口请求地址

字段

参数类型

增加逻辑

账号服务

资金和流水管理

代理商转账

open_api/2/agent/advertiser/recharge/

transfer_type

请求参数

新增枚举值:

PREPAY_UNIVERSAL 通用预付 PREPAY_BRAND 品牌预付 PREPAY_BID 竞价预付 CREDIT_UNIVERSAL 通用授信 CREDIT_BRAND 品牌授信 CREDIT_BID 竞价授信

原枚举值:

CASH 现金(将于2.8下线)

GRANT 赠款


代理商退款

open_api/2/agent/advertiser/refund/

请再次关注更新内容。


2022年1月11日

尊敬的开发者:

本次内容主要对SPI支持订阅创意报表数据变更消息通知、「老版链路 销售线索收集」下线进行通知,请您提前关注更新内容,及时评估对您现有使用的影响以及改动。

更新内容

  1. 【新能力】SPI支持订阅创意报表数据变更消息通知,开发者在管理后台订阅该消息后,当创意数据发生变更后,开发者将会收到数据变更的创意ID列表/计划ID列表。
  2. 老版链路 销售线索收集 目前已下线,涉及的创编流程将不再能创建推广目的为销售线索收集的组-计划-创意;新版营销链路 销售线索不影响(已于2021年12月7日进行预通知)

类别

接口名称

接口地址

字段

字段类型

参数类型

增加逻辑

创编

创建广告组

open_api/2/campaign/create/

landing_type

string

请求参数

允许值:

老版链路去除销售线索LINK

(营销链路不受影响)

创建广告计划

open_api/2/ad/create/

修改广告计划

open_api/2/ad/update/

创建广告创意

open_api/2/creative/create_v2/

修改广告创意

open_api/2/creative/update_v2/

请再次关注更新内容。


2022年1月7日

尊敬的开发者:

本次更新内容包括:

1.「计划/创意获取接口」分页规则限制更新正通知,请在及时调整对应范围,避免届时请求失败

一、「计划/创意获取接口」接口更新(生效时间为:2022年1月6日)

一级分类

二级分类

接口名称

接口请求地址

更新内容

广告投放

广告计划

获取广告计划列表

/open_api/2/ad/get/

  • page_size 范围调整为[1,100]
  • page 范围调整为[1,99999]


广告创意

获取创意列表

/open_api/2/creative/get/

  • page_size 范围调整为[1,100]
  • page 范围调整为[1,99999]

2022年1月4日

尊敬的开发者:

本次内容主要对行业目录更新进行通知,麻烦辛苦您提前关注更新内容,及时评估对您现有使用的影响以及改动。

更新内容

行业目录已进行升级,开发者将会从 获取行业列表 接口中自动获取升级后的新的行业类目,并且使用到行业类目的接口将进行参数校验(已于2021年12月3日进行预通知)

涉及接口

传入行业API

一级分类

二级分类

接口名称

接口请求地址

字段

增加逻辑


广告投放


广告创意模块

创建自定义创意(营销链路)

open_api/2/creative/custom_creative/create/


third_industry_id


三级行业id,需要传入升级后的行业id

修改自定义创意(营销链路)

open_api/2/creative/custom_creative/update/

创建程序化创意(营销链路)

open_api/2/creative/procedural_creative/create/

修改程序化创意(营销链路)

open_api/2/creative/procedural_creative/update/

创建广告创意

open_api/2/creative/create_v2/ 

修改创意信息

open_api/2/creative/update_v2/


数据报表


广告数据报表


代理商数据


open_api/2/report/agent/get_v2/

first_industry

一级行业名称,需要传入升级后的行业名称

second_industry

二级行业名称,需要传入升级后的行业名称


账号服务


代理商账号管理


创建广告主


open_api/2/agent/advertiser/create_v2/

first_industry_id

一级行业id,需要传入升级后的行业id

second_industry_id

二级行业id,需要传入升级后的行业id

投放管家

创建项目

设置项目创意信息

open_api/v1.0/ad_lab/creative/create/

third_industry_id

三级行业id,需要传入升级后的行业id

获取行业API

一级分类

二级分类

接口名称

接口请求地址

字段

增加逻辑

工具

查询工具

获取行业列表

open_api/2/tools/industry/get/

全部

2022/01/04进行接口升级,接口升级后,行业列表也将获取最新的行业列表

请再次关注更新内容。


2021年12月29日

尊敬的开发者:

您好!本次通知主要针对广告创意展现方式和是否开启衍生计划相关字段的下线,下线时间为:2022年1月6号。

【涉及接口】

一级分类

二级分类

接口名称

接口请求地址

附加信息

广告投放

广告创意

创建自定义创意

open_api/2/creative/custom_creative/create/

字段下线

创意展现方式下线,系统默认选择优选模式,无需传入

修改自定义创意

open_api/2/creative/custom_creative/update/

字段下线

创意展现方式下线

创建程序化创意

open_api/2/creative/procedural_creative/create/

字段下线

是否开启衍生计划功能下线

创意展现方式下线,系统默认选择优选模式,无需传入

修改程序化创意

open_api/2/creative/procedural_creative/update/

字段下线

是否开启衍生计划功能下线

创意展现方式下线

创建广告创意

open_api/2/creative/create_v2/

字段下线

是否开启衍生计划功能下线

创意展现方式下线

修改广告创意

open_api/2/creative/update_v2/

字段下线

是否开启衍生计划功能下线,

创意展现方式下线

【更新内容】

创意信息中,关于衍生计划功能和创意展示形式将进行变动,两功能均将于2022/01/06 下线

补充信息:该信息已经于2021/09/16 更新日志进行过通知,原定2021/09/22下线,现变更为2022/01/06

类别

接口名称

接口地址

字段

字段类型

参数类型

增加逻辑

广告投放

创建自定义创意

open_api/2/creative/custom_creative/create/

creative_display_mode

string

请求参数

字段下线

创意展现方式下线,系统默认选择优选模式,无需传入

修改自定义创意

open_api/2/creative/custom_creative/update/

creative_display_mode

string

请求参数

字段下线

创意展现方式下线

创建程序化创意

open_api/2/creative/procedural_creative/create/

generate_derived_ad

number

请求参数

字段下线

是否开启衍生计划功能下线

creative_display_mode

string

请求参数

字段下线

创意展现方式下线,系统默认选择优选模式,无需传入

修改程序化创意

open_api/2/creative/procedural_creative/update/

generate_derived_ad

number

请求参数

字段下线

是否开启衍生计划功能下线

creative_display_mode

string

请求参数

字段下线

创意展现方式下线

创建广告创意

open_api/2/creative/create_v2/

generate_derived_ad

number

请求参数

字段下线

是否开启衍生计划功能下线

creative_display_mode

string

请求参数

字段下线

创意展现方式下线

修改广告创意

open_api/2/creative/update_v2/

generate_derived_ad

number

请求参数

字段下线

是否开启衍生计划功能下线

creative_display_mode

string

请求参数

字段下线

创意展现方式下线

2021年12月28日

尊敬的开发者:

本次内容主要针对互动广告数据报表更新进行通知,请关注更新内容。

【涉及接口】

一级分类

二级分类

接口名称

接口地址

增加逻辑

数据报表

互动广告数据

互动广告报表查询

open_api/2/report/rubeex/get/

更新接口

请求参数的过滤字段新增data_scope、ad_ids、creative_ids、campaign_ids、type,支持查询互动作品应用到不同的广告主、计划、创意、计划组下的数据。

工具

互动广告管理

获取互动作品关联的试玩素材列表

open_api/2/tools/rubeex/playable/list

新增接口

支持查询广告主名下的互动作品(project_id)推送到广告投放平台生成的试玩素材(playable_id)列表。

获取试玩素材关联的广告计划列表

open_api/2/tools/rubeex/playable/ad/list

新增接口

支持查询广告主名下的试玩素材(playable_id)关联的广告计划列表。

请再次关注更新内容。


2021年12月24日

尊敬的开发者:

本次内容主要对商品广告相关接口部分字段下线进行预通知,麻烦辛苦您提前关注更新内容,及时评估对您现有使用的影响以及改动

更新内容:

商品广告下涉及出入参「商品所处三级行业ID」的字段下线(生效时间为:2022年1月12日),后续会上线相应字段支持

一级分类

接口名称

接口请求地址

字段

参数类型

增加逻辑

商品广告

获取商品列表

open_api/2/dpa/detail/get/

third_category_id

应答参数

字段下线

获取商品详情

open_api/2/dpa/product/detail/get/

请再次关注更新内容。


2021年12月21日

尊敬的开发者:

本次内容主要针对创意审核状态的SPI消息推送,麻烦辛苦您提前关注更新内容,及时评估对您现有使用的影响以及改动

更新内容:

上线“创意审核状态实时推送”服务,您可在“开发者管理后台-订阅服务”订阅该消息,当创意的审核状态发生变更时,我们会第一时间给您发送通知,具体见创意审核状态实时推送

请再次关注更新日志。


2021年12月17日

本次内容主要为「查询程序化创意包」接口下线、广告创意相关接口部分字段下线进行预通知,以及对「旧版链路抖音号推广能力(非营销链路)」下线进行正式通知,麻烦辛苦您提前关注更新内容,及时评估对您现有使用的影响以及改动。

一、「查询程序化创意包」接口下线(生效时间为:2022年1月17日)

一级分类

二级分类

接口名称

接口请求地址

增加逻辑

工具

查询工具

查询程序化创意包

open_api/2/tools/procedural_package/get/

接口下线

二、广告创意模块下涉及出入参「程序化创意包id」的字段下线(生效时间为:2022年1月17日)

一级分类

二级分类

接口名称

接口请求地址

字段

参数类型

增加逻辑

广告投放

广告创意模块

创建程序化创意(营销链路)

open_api/2/creative/procedural_creative/create/

procedural_package

  • package_id

请求参数

字段下线

修改程序化创意(营销链路)

open_api/2/creative/procedural_creative/update/

创建广告创意

open_api/2/creative/create_v2/

procedural_package_id

修改创意信息

open_api/2/creative/update_v2/

创意详细信息

open_api/2/creative/read_v2/ 

procedural_package_id

应答参数

三、旧版链路抖音号推广能力(非营销链路)(已于2021/12/14正式下线)

类别

接口名称

接口地址

字段

字段类型

参数类型

增加逻辑

创编

创建广告组

open_api/2/campaign/create/

landing_type

string

请求参数

逻辑变更

旧版链路不允许创建AWEME抖音号推广(marketing_purpose不传即为旧链路)

创建广告计划

open_api/2/ad/create/

aweme_account

string

请求参数

已于2021/12/14字段下线

promotion_type

string

请求参数

修改广告计划

open_api/2/ad/update/




创建广告创意

open_api/2/creative/create_v2/




修改广告创意

open_api/2/creative/update_v2/




请再次关注更新内容。


2021年12月15日

尊敬的开发者:

本次内容主要针对放量投放下“是否自动调整出价”字段逻辑变更及直播间推广新增直播间转化、应用下载、线索收集三种投放类型。麻烦辛苦您提前关注更新内容,及时评估对您现有使用的影响以及改动。

【涉及接口】

一级分类

二级分类

接口名称

接口地址

附加信息

广告投放

广告计划模块

创建广告计划

open_api/2/ad/create/

adjust_cpa字段逻辑变更

修改广告计划

open_api/2/ad/update/

工具

转化目标管理

查询可用优化目标

open_api/2/tools/ad_convert/optimized_target/get/

新增字段

广告投放

广告计划模块

获取广告计划

/open_api/2/ad/get/

新增字段

资产

事件管理

获取优化目标

/open_api/2/tools/event_convert/optimized_goal/get/

landing_type字段新增枚举值

【涉及内容】

  1. 放量投放下“是否自动调整出价”逻辑变更

放量投放下是否调整自动出价参数adjust_cpa将仅支持传入1,即放量投放下必须传入cpa_bid,该策略将会于1月4号全量生效,部分nobid测试客户策略将提前生效,请提前评估影响并改动。

一级分类

二级分类

接口名称

接口请求地址

字段

解释

参数类型

变更逻辑

广告投放

广告计划模块

创建广告计划

open_api/2/ad/create/

adjust_cpa

是否自动调整出价

请求参数

允许值:1

修改广告计划

open_api/2/ad/update/

  1. 直播间推广新增直播间转化、应用下载、线索收集三种投放类型,可通过设置转化目标来表达(上线时间为:12月15日)

一级分类

二级分类

接口名称

接口请求地址

字段

解释

参数类型

增加逻辑

工具

转化目标管理

查询可用优化目标

open_api/2/tools/ad_convert/optimized_target/get/

launch_target_type

投放类型,允许值:LIVE_CONVERT 直播间转化、

APP 应用下载、

EXTERNAL 线索收集

请求参数

字段上线

广告投放

广告计划模块

获取广告计划

/open_api/2/ad/get/

  • datalistlaunch_target_type

返回参数

字段上线

资产

事件管理

获取优化目标

/open_api/2/tools/event_convert/optimized_goal/get/

landing_type

推广目的

请求参数

新增枚举值

LIVE 直播间推广

-

external_action

转化类型

请求参数/返回参数

新增枚举值

  • AD_CONVERT_TYPE_LIVE_OTO_CLICK直播间团购点击
  • AD_CONVERT_TYPE_LIVE_OTO_PAY直播间团购支付
  • AD_CONVERT_TYPE_LIVE_OTO_PAY_CLICK直播间团购发起支付

请再次关注更新内容。


2021年12月7日

尊敬的开发者:

本次内容主要针对旧版链路销售线索收集能力(非营销链路)下线以及「转化跟踪」所适用推广内容的逻辑变更。麻烦辛苦您提前关注更新内容,及时评估对您现有使用的影响以及改动。


更新内容:

  1. 当推广目的为销售线索收集,数据对接方式为转化跟踪时,新建计划时推广内容将不可选“自研落地页”,已创建计划不受影响,本逻辑将于2021/12/6生效。
  1. 老版链路 销售线索收集,将于 2022/1/9 下线,涉及的创编流程将不再能创建推广目的为销售线索收集的组-计划-创意;新版营销链路 销售线索不影响

类别

接口名称

接口地址

字段

字段类型

参数类型

增加逻辑

创编

创建广告组

open_api/2/campaign/create/

landing_type

string

请求参数

允许值:

老版链路去除销售线索LINK

(营销链路不受影响)

创建广告计划

open_api/2/ad/create/




修改广告计划

open_api/2/ad/update/




创建广告创意

open_api/2/creative/create_v2/




修改广告创意

open_api/2/creative/update_v2/




请再次关注更新日志。


2021年12月3日

尊敬的开发者:

本次更新内容包括:1.「计划/创意获取接口」分页规则限制更新预通知,请在生效时点前调整对应范围,避免届时请求失败、2. 行业目录更新预通知,请务必关注更新内容。

一、「计划/创意获取接口」接口更新(预计生效时间为:2022年1月6日)

一级分类

二级分类

接口名称

接口请求地址

更新内容

广告投放

广告计划

获取广告计划列表

/open_api/2/ad/get/

  • page_size 范围调整为[1,100]
  • page 范围调整为[1,99999]


广告创意

获取创意列表

/open_api/2/creative/get/

  • page_size 范围调整为[1,100]
  • page 范围调整为[1,99999]

二、行业目录更新(预计生效时间为:2022年1月4日)

行业目录将会进行升级,开发者将会从 获取行业目录 接口中自动获取升级后的新的行业类目,并且使用到行业类目的接口将进行参数校验

2021年12月1日

尊敬的开发者:

本次内容主要为「应用下载链接支持优先调起普通试玩」、「获取纵横组织下资产账户列表(分页)」接口功能更新、「获取鲁班商品列表」接口下线进行通知和预通知,请务必关注更新内容。

一、「获取纵横组织下资产账户列表(分页)」接口更新(生效时间为:2021年12月1日)

【涉及接口】

一级分类

二级分类

接口名称

接口请求地址

附加信息

账号服务

纵横组织账户管理

获取纵横组织下资产账户列表(分页)

open_api/2/customer_center/advertiser/list/

新增字段

【更新内容】

一、「获取纵横组织下资产账户列表(分页)」接口更新

「获取纵横组织下资产账户列表(分页)」接口返回参数,新增字段advertiser_type,字段名称为广告主类型,枚举值为DOU+-DOU+类广告主账号、NORMAL-普通广告主帐号。其中,DOU+类广告主账号不支持任何调用接口操作。

二、推广目的为应用时,下载链接支持优先调起普通试玩

【涉及接口】

一级分类

二级分类

接口名称

接口请求地址

附加信息

广告投放

广告创意模块

创建自定义创意

open_api/2/creative/custom_creative/create/

新增字段

修改自定义创意

open_api/2/creative/custom_creative/update/

新增字段

创建程序化创意

open_api/2/creative/procedural_creative/create/

新增字段

更新程序化创意

open_api/2/creative/procedural_creative/update/

新增字段

创意详细信息

open_api/2/creative/read_v2/

新增字段

【更新内容】

应用下载链接下支持优先调起普通试玩(生效时间为:2021年12月1日)

一级分类

二级分类

接口名称

接口请求地址

字段

参数类型

增加逻辑

广告投放

广告创意模块

创建自定义创意

open_api/2/creative/custom_creative/create/

priority_trial

请求参数/返回参数

字段上线

修改自定义创意

open_api/2/creative/custom_creative/update/

创建程序化创意

open_api/2/creative/procedural_creative/create/

更新程序化创意

open_api/2/creative/procedural_creative/update/

创意详细信息

open_api/2/creative/read_v2/

三、「获取鲁班商品列表」接口下线(生效时间为:2021年12月31日)

一级分类

二级分类

接口名称

接口请求地址

增加逻辑

工具

查询工具

获取鲁班商品列表

open_api/2/tools/advertiser_goods/list/

接口下线

请再次关注更新内容。


2021年11月30日

尊敬的开发者:

本次内容主要针对AB实验工具接口上线进行通知。AB实验工具是一款用于满足广告主/优化师高效验证测试决策诉求的产品工具,本次开放的接口功能包含创建、更新、关停、删除实验,获取实验列表、详情与报告,请关注更新内容。

【新增接口】

一级分类

二级分类

接口名称

接口地址

增加逻辑

工具

AB实验工具

创建实验

open_api/2/tools/ab_test/create/

新增接口

该接口用于创建AB实验。

更新实验

open_api/2/tools/ab_test/update/

新增接口

该接口用于修改AB实验。

关停实验

open_api/2/tools/ab_test/stop/

新增接口

该接口用于关停AB实验。

删除实验

open_api/2/tools/ab_test/delete/

新增接口

该接口用于删除AB实验。

获取实验列表

open_api/2/tools/ab_test_list/get/

新增接口

该接口用于获取广告主账户下创建的AB实验。

获取实验详情及报告

open_api/2/tools/ab_test_info/get/

新增接口

该接口用于获取AB实验的详细信息与实验数据报告。

请再次关注更新内容。


2021年11月23日

本次内容主要针对「SPI数据订阅服务新增“落地页授权账户事件的推送”」、「搜索广告两阶段出价」功能上线进行预通知。

【涉及接口】

一级分类

二级分类

接口名称

接口请求地址

附加信息

广告投放

广告计划模块

创建广告计划(营销链路)

open_api/2/ad/create/

字段逻辑变更

修改广告计划(营销链路)

open_api/2/ad/update/

字段逻辑变更

获取广告计划

open_api/2/ad/get/

新增字段

更新计划出价

open_api/2/ad/update/bid/

字段逻辑变更

搜索广告投放

关键词管理(新版)

创建关键词

open_api/2/keyword/create_v2/

字段逻辑变更

更新关键词

open_api/2/keyword/update_v2/

字段逻辑变更

【更新内容】

  1. SPI数据订阅服务新增“落地页授权账户事件的推送”(上线时间为:11月23日)

SPI数据订阅服务新增“落地页授权账户事件的推送”,目前支持对落地页变更的事件进行推送。开发者可通过创建订阅任务,及时收到授权广告主的落地页信息变更通知。

  1. 「搜索广告两阶段出价」功能上线(上线时间为:11月23日)

类别

接口名称

接口地址

字段

字段类型

参数类型

增加逻辑

广告投放-广告计划模块

创建广告计划(营销链路)

open_api/2/ad/create/

flow_control_mode

string

请求参数

新增允许值:

FLOW_CONTROL_MODE_TWO_PHASES两阶段投放

新增逻辑:

当出价方式选择PRICING_CPC_OCPM时,竞价策略必须选择FLOW_CONTROL_MODE_TWO_PHASES

pricing

string

请求参数

新增逻辑:

仅搜索广告可以使用PRICING_CPC_OCPM两阶段出价。

bid

string

请求参数

新增逻辑:

pricing为PRICING_CPC_OCPM时,范围为0.2-999元

cpa_bid

string

请求参数

新增逻辑:

pricing为PRICING_CPC_OCPM时,范围为0.1-10000元

修改广告计划(营销链路)

open_api/2/ad/update/

flow_control_mode

string

请求参数

新增允许值:

FLOW_CONTROL_MODE_TWO_PHASES两阶段投放

新增逻辑:

当出价方式选择PRICING_CPC_OCPM时,竞价策略必须选择FLOW_CONTROL_MODE_TWO_PHASES

bid

string

请求参数

新增逻辑:

pricing为PRICING_CPC_OCPM时取值范围:0.2-999元,若投放阶段为第二阶段时不允许修改点击出价。

cpa_bid

string

请求参数

新增逻辑:

pricing为PRICING_CPC_OCPM时取值范围:0.1-10000元

获取广告计划

open_api/2/ad/get/

delivery_phase

string

返回参数

新增字段:

计划所处阶段

  • 允许值:FIRST_PHASE第一阶段,SECOND_PHASE第二阶段。
  • 当pricing为PRICING_CPC_OCPM时有值

更新计划出价

open_api/2/ad/update/bid/

bid

string

请求参数

新增逻辑:

pricing为"PRICING_CPC_OCPM"时不允许修改

搜索广告投放-关键词管理(新版)

创建关键词

open_api/2/keyword/create_v2/

keyword

string

请求参数

新增逻辑:

当计划的出价类型为PRICING_CPC_OCPM时无法对关键词进行出价。

更新关键词

open_api/2/keyword/update_v2/

keyword

string

请求参数

新增逻辑:

当计划的出价类型为PRICING_CPC_OCPM时无法对关键词进行出价。

请再次关注更新内容。


2021年11月19日

尊敬的开发者:

本次内容主要针对企业号经营分析能力开放、订阅服务新增企业号评论通知事件、境外IP请求限制进行通知,请关注更新内容。


一、面向企业号开发者开放企业号经营分析能力。企业号经营分析主要包括企业号推广操作记录、企业号基础数据、企业号流量来源与视频分析,全方位的满足企业号运营的数据分析诉求。

【新增接口】

一级分类

二级分类

接口名称

接口地址

增加逻辑

企业号

经营分析

获取广告主关联的企业号列表

open_api/v1.0/enterprise/bind/list/get/

新增接口

该接口用于获取广告主账号关联的企业号open_id等相关信息

获取企业号推广操作记录

open_api/v1.0/enterprise/operation/log/get/

新增接口

该接口用于获取企业号在特定日期的推广操作记录

获取企业号基础数据

open_api/v1.0/enterprise/overview/data/get/

新增接口

该接口用于获取企业号的基础数据,含主页访问人数、总粉丝数、新增粉丝人数等

获取企业号流量来源数据

open_api/v1.0/enterprise/flow/category/get/

新增接口

该接口用于获取企业号的分流量来源数据表现,流量来源渠道包括自然流量、DOU+、品牌广告、竞价广告

获取企业号视频分析数据

open_api/2/enterprise/video/info/get/

新增接口

该接口用于获取企业号的视频分析数据


二、SPI订阅服务中的“企业号事件推送”模块,新增“评论”事件。开发者可通过创建订阅任务,及时收到抖音用户在已授权企业号视频下的评论事件通知。


三、为更好保障数据安全,以下接口不支持境外IP地址请求,请使用中国大陆IP地址进行尝试。

【涉及接口】

一级分类

二级分类

接口名称

接口地址

增加逻辑

飞鱼线索管理

飞鱼线索管理

获取线索列表

open_api/2/tools/clue/get/

不支持境外IP地址请求

对应返回码code为403,msg为Forbidden。

巨量星图

巨量星图

获取星图订单投后线索

open_api/2/star/clue/get/

不支持境外IP地址请求

对应返回码code为403,msg为Forbidden。

企业号

用户分析

企业号意向用户列表查询

open_api/v1.0/enterprise/leads/user/list/

不支持境外IP地址请求

对应返回码code为403,msg为Forbidden。

企业号

用户分析

企业号意向用户互动记录查询

open_api/v1.0/enterprise/leads/user/interaction/list/

不支持境外IP地址请求

对应返回码code为403,msg为Forbidden。

数据报表

直播分析数据报表

直播受众分析报表

open_api/2/report/live_room/audience/portrait/get/

不支持境外IP地址请求

对应返回码code为403,msg为Forbidden。

请再次关注更新内容。


2021年11月18日

尊敬的开发者:

本次内容主要针对「商圈定向重构」涉及到的字段下线、「获取/采纳诊断建议」接口上线、「投放管家项目预算修改」接口上线进行预通知。麻烦辛苦您提前关注更新内容,及时评估对您现有使用的影响以及改动。

【涉及接口】

一级分类

二级分类

接口名称

接口请求地址

附加信息

广告投放

广告计划模块

创建广告计划(营销链路)

open_api/2/ad/create/

字段下线

修改广告计划(营销链路)

open_api/2/ad/update/

创建广告计划

open_api/2/ad/create/

修改广告计划

open_api/2/ad/update/

工具

定向包管理

创建定向包

open_api/2/audience_package/create/

更新定向包

open_api/2/audience_package/update/

工具

诊断信息获取与采纳

获取诊断信息

open_api/2/tools/diagnosis/suggestion/get/

接口上线

采纳诊断信息

open_api/2/tools/diagnosis/suggestion/accept/

投放管家

项目修改

更改项目预算

open_api/2/ad_lab/group/budget/update/

接口上线

【更新内容】

  1. 商圈定向重构(生效时间:12月18日)

一级分类

二级分类

接口名称

接口请求地址

字段

参数类型

增加逻辑

广告投放

广告计划模块

创建广告计划(营销链路)

open_api/2/ad/create/

  • business_ids
  • geolocation部分字段下线 city street_number street district province

请求参数

字段下线

修改广告计划(营销链路)

open_api/2/ad/update/

创建广告计划

open_api/2/ad/create/

修改广告计划

open_api/2/ad/update/

工具

定向包管理

创建定向包

open_api/2/audience_package/create/

更新定向包

open_api/2/audience_package/update/

  1. 「获取/采纳诊断建议」接口上线(上线日期:11月18日)

一级分类

二级分类

接口名称

接口请求地址

增加逻辑

工具

诊断信息获取与采纳

获取诊断信息

open_api/2/tools/diagnosis/suggestion/get/

接口上线

采纳诊断信息

open_api/2/tools/diagnosis/suggestion/accept/

  1. 「投放管家项目预算修改」接口上线(上线日期:11月18日)

一级分类

二级分类

接口名称

接口请求地址

增加逻辑

投放管家

项目修改

更改项目预算

open_api/2/ad_lab/group/budget/update/

接口上线

请再次关注更新内容。


2021年11月11日

尊敬的开发者:

本次内容主要针对旧版链路抖音号推广能力(非营销链路)下线、搜索快投关键词、直播分析数据报表更新进行预通知。麻烦辛苦您提前关注更新内容,及时评估对您现有使用的影响以及改动。

更新内容:

  1. 抖音号推广,将于 2021/12/14 下线,涉及的创编流程将不再能创建推广目的为抖音号的组-计划-创意

类别

接口名称

接口地址

字段

字段类型

参数类型

增加逻辑

创编

创建广告组

open_api/2/campaign/create/

landing_type


string

请求参数

允许值:

去除抖音号AWEME

创建广告计划

open_api/2/ad/create/

aweme_account


string

请求参数

将于2021/12/14字段下线

promotion_type


string

请求参数

修改广告计划

open_api/2/ad/update/





创建广告创意

open_api/2/creative/create_v2/





修改广告创意

open_api/2/creative/update_v2/





  1. 自2021/11/25起,搜索快投关键词功能将支持推广目的为“抖音号推广、快应用推广”

类别

接口名称

接口地址

字段

字段类型

参数类型

增加逻辑

创编

创建广告计划(营销链路)

open_api/2/ad/create/

feed_delivery_search

string

请求参数

搜索快投使用条件

  • 推广目的增加:抖音号推广、快应用推广

修改广告计划(营销链路)

open_api/2/ad/update/

创建广告计划

open_api/2/ad/create/

修改广告计划

open_api/2/ad/update/

  1. 直播分析数据报表,支持获取非同主体抖音号直播数据

类别

接口名称

接口地址

字段

增加逻辑

数据报表

直播间属性报表

open_api/2/report/live_room/attribute/get/

全部返回参数

直播分析数据报表,历史仅支持获取与广告主账号同主体的抖音号直播数据,目前可查询范围已取消同主体限制

直播间分析报表

open_api/2/report/live_room/analysis/get/

直播间流量来源报表

/open_api/2/report/live_room/flow_category/get/

直播间商品分析报表

open_api/2/report/live_room/product/get/

直播受众分析报表

open_api/2/report/live_room/audience/portrait/get/

请您及时关注开放平台更新日志及相关通知,并尽快安排对接,避免后续接口调整对您的广告投放产生影响。如您仍然存在疑惑或有相关建议,可在开放平台提交工单联系我们。


2021年11月5日

尊敬的开发者:

您好!本次通知主要针对巨量引擎开放平台对应用母包更新相关能力进行升级,请及时关注更新内容。


【更新内容】

「应用包更新」相关接口上线

自2021年11月5日起,第三方应用或系统的开发者可通过调用应用母包更新相关接口创建异步文件上传任务、查询文件异步上传任务、获取应用细分分类及题材标签、更新安卓应用母包、查询安卓应用母包、发布安卓应用母包。

类别

二级类别

接口名称

接口地址

增加逻辑

工具

应用包更新

创建异步文件上传任务

open_api/2/tools/app_management/upload_task/create/

新增接口

查询文件异步上传任务

open_api/2/tools/app_management/upload_task/list/

新增接口

获取应用细分分类及题材标签

open_api/2/tools/app_management/industry_info/list/

新增接口

更新安卓应用母

open_api/2/tools/app_management/android_basic_package/update/

新增接口

查询安卓应用母包

open_api/2/tools/app_management/android_basic_package/get/

新增接口

发布安卓应用母包

open_api/2/tools/app_management/android_basic_package/publish/

新增接口

请再次关注更新内容。


2021年11月4日

尊敬的开发者:

您好!商业开放平台将于北京时间11月4日晚上21:00-22:00点对「素材管理」相关接口进行升级维护,届时接口写入超过10s会失败,接口读取会有一定延迟。为避免本次升级对您的使用带来影响,建议您合理安排接口调用时间,感谢您对本次升级的积极配合。

本次通知还针对「获取试玩素材可推送的广告主列表」接口下线,请及时关注更新内容。

【涉及接口】

一级分类

二级分类

接口名称

接口请求地址

附加信息

工具

试玩素材管理

获取试玩素材可推送的广告主列表

open_api/2/tools/playable/grantable/adv_list/

2021/12/04

接口下线

【更新内容】

「获取试玩素材可推送列表」接口整体下线,下线时间为:2021年12月4日

类别

接口名称

接口地址

变更逻辑

工具-试玩素材管理

获取试玩素材可推送的广告主列表

open_api/2/tools/playable/grantable/adv_list/

接口下线

请再次关注更新内容。


2021年10月29日

尊敬的开发者:

巨量引擎商业开放平台,面向企业号开发者开放意向用户管理能力,实现获取企业号的意向用户列表、意向用户互动记录、对意向用户进行标签分组管理,满足精细化的客户分析与客户管理诉求!

【新增接口】

一级分类

二级分类

接口名称

接口地址

增加逻辑

企业号

用户分析

企业号意向用户标签创建

open_api/v1.0/enterprise/leads/tag/create/

新增接口,该接口用于创建标签。标签列表由企业号运营者自定义,用于后续给意向用户打标签。

企业号意向用户标签编辑

open_api/v1.0/enterprise/leads/tag/update/

新增接口,该接口用于编辑标签。标签列表由企业号运营者自定义,用于后续给意向用户打标签。

企业号意向用户标签删除

open_api/v1.0/enterprise/leads/tag/delete/

新增接口,该接口用于删除标签。标签列表由企业号运营者自定义。

企业号意向用户标签查询

open_api/v1.0/enterprise/leads/tag/list/

新增接口,该接口用于查询企业自定义的全部标签,含标签ID、标签名称、标签总数。

企业号意向用户列表查询

open_api/v1.0/enterprise/leads/user/list/

新增接口,该接口用于读取授权企业号的意向用户列表,获取内容与抖音企业服务中心-用户管理-用户信息-预约用户列表内容一致。

企业号意向用户打标签或取消标签

open_api/v1.0/enterprise/leads/user/tag/update/

新增接口,该接口用于对意向用户进行打标签或取消标签

企业号意向用户互动记录查询

open_api/v1.0/enterprise/leads/user/interaction/list/

新增接口,该接口用于读取授权企业号的意向用户互动行为记录。

企业号

消息管理

企业号私信消息卡片删除接口

open_api/v1.0/enterprise/im/card/delete/

新增接口,删除授权企业号的消息卡片。

企业号

素材管理

企业号素材删除接口

open_api/v1.0/enterprise/media/delete/

新增接口,此接口用于删除企业号历史上传的、不再使用的图片和PDF素材。


2021年10月28日

尊敬的开发者:

您好!本次通知主要针对「创建异步任务」、「查询转化目标详细信息」相关字段的变化以及「查询是否支持通投智选」接口的上线,相关字段的变更逻辑将于11月28日生效,「查询是否支持通投智选」接口于10月28日上线,请关注更新内容。

【涉及接口】

一级分类

二级分类

接口名称

接口请求地址

附加信息

数据报表

异步数据报表

创建异步任务

open_api/2/async_task/create/

字段下线

工具

转化目标管理

查询转化目标详细信息

open_api/2/tools/ad_convert/read/

字段下线

工具

校验查询工具

查询是否支持通投智选

open_api/2/tools/is_support_universal/get/

接口上线

【更新内容】

  1. 「创建异步任务」接口fields字段下线指标:

类别

接口名称

接口地址

字段

字段类型

参数类型

描述

增加逻辑

数据报表-异步数据报表

创建异步任务

open_api/2/async_task/create/

fields

string[]

请求参数

指定需要的消耗相关指标名称

下线部分指标:

luban_live_pay_order_count、luban_live_pay_order_stat_cost

  1. 「查询转化目标详细信息」接口下线字段:

类别

接口名称

接口地址

字段

字段类型

参数类型

描述

增加逻辑

工具-转化目标管理

查询转化目标详细信息

open_api/2/tools/ad_convert/read/

modify_time

string

返回参数

更新时间

字段下线

  1. 新增「查询是否支持通投智选」接口

类别

接口名称

接口地址

字段

字段类型

参数类型

描述

增加逻辑

工具-校验查询工具

查询是否支持通投智选

open_api/2/tools/is_support_universal/get/

advertiser_id

number

请求参数

广告主id

新增字段

landing_type

string

请求参数

广告组推广目的

新增字段

external_action

string

请求参数

优化目标

新增字段

deep_external_action

string

请求参数

深度转化目标

新增字段

deep_bid_type

string

请求参数

深度优化方式

新增字段

message

string

返回参数

返回信息

新增字段

data

object

返回参数

返回数据

新增字段

is_support_universal

string

返回参数

是否支持通投

新增字段

请再次关注更新内容。


2021年10月15日

尊敬的开发者:

您好!本次通知主要针对「广告创意数据」相关字段的变化,变更逻辑将于11月14日生效,请关注更新内容。

【涉及接口】

一级分类

二级分类

接口名称

接口请求地址

附加信息

数据报表

广告数据报表

广告创意数据

open_api/2/report/creative/get/

新增字段

新增字段判断逻辑

【更新内容】

类别

接口名称

接口地址

字段

字段类型

参数类型

描述

增加逻辑

数据报表-广告数据报表

广告创意数据

open_api/2/report/creative/get/

fields

string[]

请求参数

指定需要的指标名称

  • 默认值:cost、show、avg_show_cost、click、ctr、avg_click_cost、convert、convert_rate、convert_cost

新增字段

time_granularity

string

请求参数

时间粒度

  • 默认值:STAT_TIME_GRANULARITY_DAILY
  • 允许值: STAT_TIME_GRANULARITY_DAILY(按天维度), STAT_TIME_GRANULARITY_HOURLY(按小时维度)

新增判断逻辑:

小时维度聚合仅支持时间跨度为一天的数据查询

请再次关注更新内容。


2021年10月11日

尊敬的开发者,

您好!为给您提供更优质的服务,巨量引擎开放平台Marketing API将于北京时间2021年10月19日凌晨 01:00 ~ 06:00进行系统维护。在此期间,API接口数据获取、广告组创建及更新、预算更新类接口可能存在延迟,但不影响在投计划的正常投放。请规避上述时段以下接口的调用请求,避免影响您的投放。

详细接口列表如下:

巨量广告:

  1. 代理商帐号管理 - 创建广告主:/open_api/2/agent/advertiser/create_v2/
  2. 资金和流水管理 - 代理商转账:/open_api/2/agent/advertiser/recharge/
  3. 资金和流水管理 - 代理商退款:/open_api/2/agent/advertiser/refund/
  4. 广告账户预算 - 更新账户日预算:/open_api/2/advertiser/update/budget/
  5. 广告组创建:/open_api/2/campaign/create/
  6. 广告组更新:/open_api/2/campaign/update/
  7. 创建广告计划:/open_api/2/ad/create/
  8. 修改广告计划:/open_api/2/ad/update/
  9. 更新计划预算:/open_api/2/ad/update/budget/


更多细节详见:更新日志(巨量广告)

感谢您的支持,巨量引擎开放平台愿与您携手共建健康、优质的开放生态。


2021年10月09日

尊敬的开发者,

您好!为给您提供更优质的服务,巨量引擎开放平台Marketing API预计将于2021年11月17日进行升级,仅允许来自【安全传输层协议(TLS)v1.2或v1.3】的HTTPS TLS协议的代码请求。届时,TLS v1.0、TLS v1.1 版本请求将会失败。

请在【2021年11月17日零点】前,将您代码中请求API接口的HTTP Client指定TLS协议版本升级为:【TLSv1.2或TLSv1.3】 ,以免造成请求失败,对您的使用及投放造成影响。

您可参考以下代码示例进行TLS协议版本升级:

Java Apache HttpClient Demo :

SSLConnectionSocketFactory ssl = new SSLConnectionSocketFactory(

SSLContexts.createDefault(),

new String[] { "TLSv1.2", "TLSv1.3" },

null,

SSLConnectionSocketFactory.getDefaultHostnameVerifier());

CloseableHttpClient httpClient = HttpClients.custom().setSSLSocketFactory(ssl).build();

感谢您的支持,巨量引擎开放平台愿与您携手共建健康、优质的开放生态。

2021年09月29日

尊敬的开发者:

您好!本次通知主要针对游戏应用须录入防沉迷信息及「查看rit数据」相关字段默认值的变化,请关注更新内容。

【涉及接口】

一级分类

二级分类

接口名称

接口请求地址

附加信息

广告投放

广告计划模块

创建广告计划

open_api/2/ad/create/

增加校验逻辑

增加应用下载相关信息校验

修改广告计划

open_api/2/ad/update/

广告创意模块

创建自定义创意(营销链路)

open_api/2/creative/custom_creative/create/

修改自定义创意(营销链路)

open_api/2/creative/custom_creative/update/

创建程序化创意

open_api/2/creative/procedural_creative/create/

修改程序化创意

open_api/2/creative/procedural_creative/update/

创建广告创意

open_api/2/creative/create_v2/

修改创意信息

open_api/2/creative/update_v2/

工具

穿山甲流量包

查看rit数据

open_api/2/tools/union/flow_package/report/

逻辑变更

增加查询默认时间区间

【更新内容】

  1. 游戏须录入防沉迷信息相关变动
  • 对于暂未上传防沉迷信息的游戏应用,其广告计划/创意的创建/修改近期将受到影响,建议您尽快于应用管理中心上传防沉迷信息,避免影响正常的广告投放。

类别

接口名称

接口地址

字段

字段类型

参数类型

描述

增加逻辑

广告投放-广告计划模块

创建广告计划

open_api/2/ad/create/

download_url

external_url

string

请求参数

下载链接

落地页链接

  • 针对游戏应用,在应用管理平台上传时会新增要求录入游戏防沉迷信息(适龄信息、实名注册、防沉迷三项内容截图,时长3分钟的游戏玩法录屏)
  • 针对未完成信息录入的游戏应用,在创建广告计划的过程中,录入下载链接/落地页链接/Android应用下载详情页时会提示“游戏防沉迷信息不完整,请前往应用管理中心补充相应信息”
  • 历史不合规广告计划由审核侧离线进行下线

修改广告计划

open_api/2/ad/update/

广告投放-广告创意模块

创建自定义创意(营销链路)

open_api/2/creative/custom_creative/create/

web_url

external_url

Android应用下载详情页

落地页链接

修改自定义创意(营销链路)

open_api/2/creative/custom_creative/update/

创建程序化创意

open_api/2/creative/procedural_creative/create/

修改程序化创意

open_api/2/creative/procedural_creative/update/

创建广告创意

open_api/2/creative/create_v2/

修改创意信息

open_api/2/creative/update_v2/

  1. 「查看rit数据」相关变动(10月28号起生效

类别

接口名称

接口地址

字段

字段类型

参数类型

描述

增加逻辑

工具-穿山甲流量包

查看rit数据

open_api/2/tools/union/flow_package/report/

start_time

string

请求参数

开始时间

默认:7天前(含第7天)

end_time

string

请求参数

结束时间

默认:昨天

请再次关注更新内容。


2021年09月22日

尊敬的开发者:

您好!本次通知主要针对巨量引擎投放管家能力整体升级相关变动,请及时关注更新内容。

【涉及接口】

  • 投放管家

一级分类

二级分类

接口名称

接口请求地址

附加信息

投放管家

创建项目

创建管家项目

open_api/v1.0/ad_lab/group/create/

2021/09/17 新增接口

设置项目计划信息

open_api/v1.0/ad_lab/ad/create/

创建或编辑创意信息

open_api/v1.0/ad_lab/creative/create/

项目查询

获取项目信息

open_api/v1.0/ad_lab/group/get/

获取项目信息(旧)下线

open_api/2/adlab/group/get/

2021/08/27接口下线

【更新内容】

  1. 投放管家新创编流程已经于2021/09/17 进行更新,请关注相关变动 业务部分-创编能力:原创建项目步骤由5步变为3步(原5个接口下线,新上线3个接口),查询项目能力替换(原接口下线,新增接口字段结构变更) 业务部分-数据能力:管家数据能力,后续查看管家数据,可以通过基础报表进行查看,相关能力已经于2021/09/14更新,新增通过投放模式筛选(详见2021/09/16更新日志) 整体时间线:
  • 2021/08/06通过更新日志预通知(详见2021/08/06 更新日志 )
  • 2021/08/27 老版本投放管家能力正式停止服务下线(详见2021/08/31 更新日志 )
  • 2021/09/17 新版本投放管家能力正式上线均已经完成

类别

接口名称

接口地址

字段

字段类型

参数类型

增加逻辑

投放管家

创建管家项目

open_api/v1.0/ad_lab/group/create/

全部

全部

请求+应答

新增接口

设置项目计划信息

open_api/v1.0/ad_lab/ad/create/

全部

全部

请求+应答

创建或编辑创意信息

open_api/v1.0/ad_lab/creative/create/

全部

全部

请求+应答

获取项目信息

open_api/v1.0/ad_lab/group/get/

全部

全部

请求+应答

获取项目信息(旧)下线

open_api/2/adlab/group/get/

全部

全部

请求+应答

2021/08/27接口下线

本次通知信息极其重要,请再次提前关注更新内容,及时评估对现有使用的影响以及改动。


2021年09月17日

尊敬的开发者:

您好!本次通知主要针对橙子建站应用下载相关产品能力升级及「数据报表」新增字段,包括已通知的变动点、即将生效的新变动点,请关注更新内容。

【涉及接口】

一级分类

二级分类

接口名称

接口请求地址

附加信息

建站管理

橙子建站落地页管理

创建橙子建站站点

open_api/2/tools/site/create/

影响字段

单图组件

组图组件

按钮组件

修改橙子建站站点

open_api/2/tools/site/update/

影响字段

单图组件

组图组件

按钮组件

数据报表

广告数据报表

广告主数据

open_api/2/report/advertiser/get/

字段新增

直播间组件点击相关指标

广告组数据

open_api/2/report/campaign/get/

字段新增

直播间组件点击相关指标

广告计划数据

open_api/2/report/ad/get/

字段新增

直播间组件点击相关指标

广告创意数据

open_api/2/report/creative/get/

字段新增

直播间组件点击相关指标

【更新内容】

  1. 橙子建站相关变动


9.23

8.27

8.1

升级前

橙子建站

  • 落地页暂不支持添加二维码
  • 影响范围包括图片组件、组图组件、按钮组件
  • 1个落地页仅支持填写同1个应用下载链接,ios\安卓均仅支持应用管理中心审核通过的下载链接;
  • 橙子建站落地页内展示的内容须与下载的应用一致,不建议在创意及橙子建站落地页中自行添加应用五要素信息,避免因五要素信息错误造成拒审影响投放;
  • 橙子建站中,非下载、非预约组件不能配置ios/安卓下载链接;
  • 游戏预约组件不能填写安卓下载链接,仅能填写ios下载链接
  • 不能修改已经绑定计划的落地页中下载链接
  • 下载链接未限定必须来源于应用管理中心未限定图片、文本等组件添加下载链接游戏预约ios、安卓均支持

9月23日前,需完成上述要求的应用管理中心及橙子建站的升级工作,在创建计划时通过接口传入升级后要求的信息。此后,巨量引擎开放平台仅支持按以上规范创建新计划,不符合规范的计划将统一做下线处理。

  1. 基础报表(广告主、广告组、广告计划、广告创意)已经于2021/09/17 新增直播间组件点击相关指标

类别

接口名称

接口地址

字段

字段类型

参数类型

描述

增加逻辑

数据报表-广告数据报表

广告主数据

open_api/2/report/advertiser/get/

live_component_click_count

number

应答字段

直播间组件点击数

新增字段

live_component_click_cost

float

应答字段

直播间组件点击成本

新增字段

live_component_click_rate

float

应答字段

直播间组件点击率

新增字段

广告组数据

open_api/2/report/campaign/get/

live_component_click_count

number

应答字段

直播间组件点击数

新增字段

live_component_click_cost

float

应答字段

直播间组件点击成本

新增字段

live_component_click_rate

float

应答字段

直播间组件点击率

新增字段

广告计划数据

open_api/2/report/ad/get/

live_component_click_count

number

应答字段

直播间组件点击数

新增字段

live_component_click_cost

float

应答字段

直播间组件点击成本

新增字段

live_component_click_rate

float

应答字段

直播间组件点击率

新增字段

广告创意数据

open_api/2/report/creative/get/

live_component_click_count

number

应答字段

直播间组件点击数

新增字段

live_component_click_cost

float

应答字段

直播间组件点击成本

新增字段

live_component_click_rate

float

应答字段

直播间组件点击率

新增字段

请再次关注更新内容。


2021年09月16日

尊敬的开发者:您好!本次通知主要针对巨量引擎开放平台创编能力功能变更。

【涉及接口】

一级分类

二级分类

接口名称

接口请求地址

附加信息

广告投放

广告计划

创建广告计划

open_api/2/ad/create/

字段下线+枚举下线

用户定向中:文章分类定向下线

平台定向中:下线PC枚举

修改广告计划

open_api/2/ad/update/

字段下线+枚举下线

用户定向中:文章分类定向下线

平台定向中:下线PC枚举

广告创意

创建自定义创意

open_api/2/creative/custom_creative/create/

字段下线

创意展现方式下线,系统默认选择优选模式,无需传入

修改自定义创意

open_api/2/creative/custom_creative/update/

字段下线

创意展现方式下线

创建程序化创意

open_api/2/creative/procedural_creative/create/

字段下线

是否开启衍生计划功能下线

创意展现方式下线,系统默认选择优选模式,无需传入

修改程序化创意

open_api/2/creative/procedural_creative/update/

字段下线

是否开启衍生计划功能下线

创意展现方式下线

创建广告创意

open_api/2/creative/create_v2/

字段下线

是否开启衍生计划功能下线

创意展现方式下线

修改广告创意

open_api/2/creative/update_v2/

字段下线

是否开启衍生计划功能下线,

创意展现方式下线

工具

定向包

创建定向包

open_api/2/audience_package/create/

字段下线+枚举下线

用户定向中:文章分类定向下线

平台定向中:下线PC枚举

更新定向包

open_api/2/audience_package/update/

字段下线+枚举下线

用户定向中:文章分类定向下线

平台定向中:下线PC枚举

数据报表

广告数据报标

广告主数据

open_api/2/report/advertiser/get/

字段新增:

新增过滤字段filtering:过滤字段下新增投放模式筛选

广告组数据

open_api/2/report/campaign/get/

字段新增:

过滤字段filtering:新增投放模式筛选

广告计划数据

open_api/2/report/ad/get/

字段新增:

过滤字段filtering:新增投放模式筛选

广告创意数据

open_api/2/report/creative/get/

字段新增:

过滤字段filtering:新增投放模式筛选

【更新内容】

  1. 基础报表(广告主、广告组、广告计划、广告创意)已经于2021/09/14 新增通过投放模式筛选

类别

接口名称

接口地址

字段

字段类型

参数类型

增加逻辑

工具-数据报表

广告主数据

open_api/2/report/advertiser/get/

filtering


object

请求参数

新增字段

-

delivery_mode

string[]

增加投放模式筛选。允许值:

STANDARD:标准投放

ADLAB_FREE:管家&省心投放

广告组数据:open_api/2/report/campaign/get/

广告计划数据:open_api/2/report/ad/get/

广告创意数据:open_api/2/report/creative/get/

filtering


object


-

delivery_mode

string[]

增加投放模式筛选。允许值:

STANDARD:标准投放

ADLAB_FREE:管家&省心投放

  1. 用户定向中部分功能将下线,预计将于10月上旬生效,请提前进行改造

类别

接口名称

接口地址

字段

字段类型

参数类型

增加逻辑

广告投放

创建广告计划:open_api/2/ad/create/

修改广告计划:open_api/2/ad/update/

创建定向包:open_api/2/audience_package/create/

更新定向包: open_api/2/audience_package/update/

article_category

string[]

请求参数

字段下线

platform

string[]

请求参数

枚举下线

下线枚举值PC

  1. 创意信息中,关于衍生计划功能和创意展示形式将进行变动,两功能均将于2021/09/22 下线

补充信息:该信息已经于2021/07/23 更新日志进行过通知,原定2021/08/24下线,现变更为2021/09/22

类别

接口名称

接口地址

字段

字段类型

参数类型

增加逻辑

广告投放

创建自定义创意

open_api/2/creative/custom_creative/create/

creative_display_mode

string

请求参数

字段下线

创意展现方式下线,系统默认选择优选模式,无需传入

修改自定义创意

open_api/2/creative/custom_creative/update/

creative_display_mode

string

请求参数

字段下线

创意展现方式下线

创建程序化创意

open_api/2/creative/procedural_creative/create/

generate_derived_ad

number

请求参数

字段下线

是否开启衍生计划功能下线

creative_display_mode

string

请求参数

字段下线

创意展现方式下线,系统默认选择优选模式,无需传入

修改程序化创意

open_api/2/creative/procedural_creative/update/

generate_derived_ad

number

请求参数

字段下线

是否开启衍生计划功能下线

creative_display_mode

string

请求参数

字段下线

创意展现方式下线

创建广告创意

open_api/2/creative/create_v2/

generate_derived_ad

number

请求参数

字段下线

是否开启衍生计划功能下线

creative_display_mode

string

请求参数

字段下线

创意展现方式下线

修改广告创意

open_api/2/creative/update_v2/

generate_derived_ad

number

请求参数

字段下线

是否开启衍生计划功能下线

creative_display_mode

string

请求参数

字段下线

创意展现方式下线

请再次关注更新内容,及时评估对现有使用的影响以及改动。


2021年09月14日

尊敬的开发者:

您好!本次通知主要针对巨量引擎开放平台对应用管理相关能力进行升级,请及时关注更新内容。

更新内容:

  1. 查询合作组织 可通过请求参数organization_id 巨量纵横组织id,查询巨量纵横组织下合作组织列表及详细信息

类别

二级类别

接口名称

接口地址

字段

字段含义

字段类型

参数类型

增加逻辑

账号服务

账号管家管理

查询合作组织

open_api/2/business_platform/partner_organization/list/

全部

全部

-

请求+应答

新增接口

  1. 第三方应用或系统的开发者,通过请求参数account_id 账户id(指可以接的账号体系如广告主id、bpid等)、account_type 账户类型和应用包id package_id,查询账户下安卓应用列表及应用详细信息、为应用包创建对应的分包信息、查询该应用包相关信息和包含的分包信息。

类别

二级类别

接口名称

接口地址

字段

字段含义

字段类型

参数类型

增加逻辑

工具

应用管理

查询安卓应用信息【支持所有账户体系】

open_api/2/tools/app_management/android_app/list/

全部

全部

-

请求+应答

新增接口

工具

应用管理

创建应用分包 【支持所有账户体系】

open_api/2/tools/app_management/extend_package/create_v2/

全部

全部

-

请求+应答

新增接口

工具

应用管理

查询应用分包列表 【支持所有账户体系】

open_api/2/tools/app_management/extend_package/list_v2/

全部

全部

-

请求+应答

新增接口

  1. 第三方应用或系统的开发者,可通过调用应用管理相关接口,查询巨量纵横组织下某个应用的共享范围、新增应用共享、取消应用共享。

类别

二级类别

接口名称

接口地址

字段

字段含义

字段类型

参数类型

增加逻辑

工具

应用管理

查看应用共享范围

open_api/2/tools/app_management/share_account/list/

全部

全部

-

请求+应答

新增接口

工具

应用管理

设置应用共享

open_api/2/tools/app_management/bp_share/

全部

全部

-

请求+应答

新增接口

工具

应用管理

取消应用共享

open_api/2/tools/app_management/extend_package/create_v2/

全部

全部

-

请求+应答

新增接口


2021年09月08日

尊敬的开发者:

你好,巨量引擎商业开放平台,面向企业号开发者开放企业经营相关能力,满足多场景的企业号经营服务诉求。

  1. 第三方应用或系统的开发者,请求管家管理员授权时,若管家账户下绑定了一个或多个企业号,可实现授权企业号相关权限,并调用以下接口,获取企业号信息;

类别

二级类别

接口名称

接口地址

字段

字段含义

字段类型

参数类型

增加逻辑

账号服务

账号管家管理

获取管家下资产账户列表(分页)

open_api/2/customer_center/advertiser/list/

account_source

账户类型,可选值:AD 广告主账号、ENTERPRISE企业号,默认值:AD

string

请求

新增功能:查询当前管家下的资产账户列表,含广告主和企业号账户类型

e_douyin_id

企业号ID

string

应答

e_douyin_name

企业号名称

string

应答

账号服务

企业号账号信息

获取企业号信息

open_api/v1.0/enterprise/info/

全部

全部

-

请求+应答

新增接口,获取企业号账户信息

  1. 第三方应用或系统的开发者,可进入商业开放平台-开发者管理后台-订阅服务,为应用创建"授权账户的事件推送"订阅任务,当应用开通"企业号-消息管理"权限,且获得企业号绑定的管家账户授权后,可实时获取企业号接收的会话动作和私信消息事件推送;
  2. 第三方应用或系统的开发者,可通过调用企业消息管理相关接口,实现读取并设置私信菜单、读取并设置私信自动回复规则、读取企业号群聊列表、经营工具列表、私信卡片列表、发送私信消息功能;

类别

二级类别

接口名称

接口地址

字段

字段含义

字段类型

参数类型

增加逻辑

企业号

基础信息

企业号用户权限读取接口

open_api/v1.0/enterprise/user/permission/list/

全部

全部

-

请求+应答

新增接口,读取授权企业号所拥有的企业号角色、企业号权限、拥有该权限的时间

企业号

素材管理

企业号用户素材列表接口

open_api/v1.0/enterprise/media/list/

全部

全部

-

请求+应答

新增接口,用于分页获取授权企业号上传的素材,获取内容包含素材ID、素材URL、素材审核状态

素材管理

企业号永久素材上传接口

open_api/v1.0/enterprise/media/upload/

全部

全部

-

请求+应答

新增接口,用于上传永久素材,上传成功后,可获取素材ID和素材URL

企业号

消息管理

企业号私信菜单保存接口

open_api/v1.0/enterprise/im/menu/save/

全部

全部

-

请求+应答

新增接口,设置授权企业号的私信菜单信息,包含私信菜单标题、跳转链接、回复内容、经营工具、子菜单等

企业号私信菜单读取接口

open_api/v1.0/enterprise/im/menu/list/

全部

全部

-

请求+应答

新增接口,读取授权企业号的私信菜单设置

企业号私信自动回复保存接口

open_api/v1.0/enterprise/im/auto/reply/save/

全部

全部

-

请求+应答

新增接口,设置授权企业号的自动回复内容,针对用户进入对话、关键词自动回复、电话拨打、主页留资、转化页留资情形,设置各类型自动回复内容

企业号私信自动回复读取接口

open_api/v1.0/enterprise/im/auto/reply/list/

全部

全部

-

请求+应答

新增接口,读取授权企业号的自动回复设置

企业号私信用户群聊读取接口

open_api/v1.0/enterprise/im/group/list/

全部

全部

-

请求+应答

新增接口,读取授权企业号所在群聊的列表以供私信发送相关接口使用

企业号私信经营工具读取接口

open_api/v1.0/enterprise/im/component/list/

全部

全部

-

请求+应答

新增接口,读取授权企业号创建的审核通过的经营工具列表供私信相关接口使用,经营工具类型包括联系我们、在线预约、线索收集、汽车线索收集、官网主页、团购商品聚合页、电商商品、电商卡券

企业号私信消息卡片读取接口

open_api/v1.0/enterprise/im/card/list/

全部

全部

-

请求+应答

新增接口,读取授权企业号创建的消息卡片,卡片类型包括图片链接、问题列表、电话拨打、留资组件等

企业号私信消息卡片保存接口

open_api/v1.0/enterprise/im/card/save/

全部

全部

-

请求+应答

新增接口,设置授权企业号的消息卡片

企业号私信发送消息接口

open_api/v1.0/enterprise/im/message/send/

全部

全部

-

请求+应答

新增接口,该接口用于主动发送私信至抖音用户,支持文本、消息卡片、群聊邀请、经营工具


2021年08月31日

尊敬的开发者:您好!本次通知主要针对巨量引擎开放平台对下载类广告产品能力、橙子建站落地页产品能力升级、投放管家创编能力下线以及其他常规功能变更。

应用下载整体变动规则已于2021/08/27号生效。


更新内容

  1. 应用下载 应用下载类广告能力升级部分,整体已经于2021/08/27号生效

场景

升级前

升级后

应用推广

  • 下载方式为:下载链接
    • iOS:仅传入下载链接
    • 安卓:传入下载链接、包名,应用下载详情页仅支持「橙子建站」
  • 下载方式为:落地页
    • 传入落地页链接,不传入下载链接
  • 下载方式为:下载链接
    • IOS:下载链接、包名
    • 安卓:下载链接、包名仅支持「应用管理中心」、应用详情仅支持「橙子建站」
  • 下载方式为:落地页
    • 下载链接、包名仅支持「应用管理中心」;应用详情仅支持「橙子建站」

应用推广-大推

  • 下载方式为:下载链接
    • iOS:仅传入下载链接
    • 安卓:传入下载链接、应用下载详情页
  • 下载方式为:落地页
    • 传入落地页链接,不传入下载链接
  • 下载方式为:下载链接
    • IOS:下载链接、包名
    • 安卓:下载链接、包名仅支持「应用管理中心」、应用详情仅支持「橙子建站」
  • 下载方式为:落地页
    • 下载链接、包名仅支持「应用管理中心」;应用详情仅支持「橙子建站」

应用推广-预约

  • 下载方式为:落地页下载
    • 链接、包名仅支持「应用管理中心」;落地页表单仅支持「橙子建站」
  • 下载方式为:落地页下载
    • 链接、包名仅支持「应用管理中心」;应用详情仅支持「橙子建站」

非应用推广目的


只有符合升级规范的落地页才能生效下载行为

  1. 橙子建站:落地页能力升级部分,已经于2021/08/27号生效

场景

升级前

升级后

橙子建站

安卓&IOS:

落地页中应用相关信息,下载链接支持手动输入自建落地页地址

落地页中的多跳场景,支持自建落地页,且不限制多跳行为中的一致性

安卓:

  • 下载链接类型,仅能够使用应用管理中心
  • 落地页内仅能够填写同一个下载链接(有多个下载链接时,须填写相同的链接)
  • 二跳和多跳行为,若存在下载行为,必须为橙子建站下载合规页,且二(多)跳页和一跳页的应用需一致
  • 限制手动录入安卓商店直投market的调起链接
  • 线索类组件,如表单后的跳转行为,同样必须使用橙子建站落地页
  • 程序化落地页组:组内落地页下载链接需一致

IOS:

  • 下载链接类型,仅能够使用应用管理中心链接
  • 落地页内仅能够填写同一个下载链接(多个链接不能使用不同链接)
  • 二跳和多跳行为,若存在下载行为,必须为符合规范的橙子建站下载页,且二(多)跳页和一跳页的应用需一致
  • 线索类组件,如表单后的跳转行为,同样必须使用橙子建站落地页
  • 程序化落地页组:组内落地页下载链接需一致
  1. 投放管家:投放管家创编部分已经于2021/08/27号下线

类别

二级类别

接口名称

接口地址

字段

字段含义

字段类型

参数类型

增加逻辑

投放管家

创建项目

新建投放管家项目

open_api/2/adlab/group/create/

全部

全部

全部

请求+应答

接口下线

设置项目转化信息

open_api/2/adlab/group_convert/update/

设置项目定向信息

open_api/2/adlab/group_audience/update/

设置项目创意信息

open_api/2/adlab/group_creative/update/

设置项目预算信息

open_api/2/adlab/group_budget/update/

  1. 其他内容

(1)数据报表 省级数据、市级数据、性别数据、年龄数据4个报表中id_type中按广告创意查询AUDIENCE_STAT_ID_TYPE_CREATIVE将于2021/09/23下线

类别

二级类别

接口名称

接口地址

字段

字段含义

字段类型

参数类型

增加逻辑

数据报表

受众分析数据报表

省级数据

open_api/2/report/audience/province/

id_type

查询ID类型

string

请求参数

下线枚举值

按广告创意查询AUDIENCE_STAT_ID_TYPE_CREATIVE

市级数据

open_api/2/report/audience/city/

性别数据

/open_api/2/report/audience/gender/

年龄数据

open_api/2/report/audience/age/

(2)云游戏试玩 能力已经于2021/08/24上线

类别

二级类别

接口名称

接口地址

字段

字段含义

字段类型

参数类型

增加逻辑

广告投放

广告创意

创建自定义创意:open_api/2/creative/custom_creative/create/

修改自定义创意

open_api/2/creative/procedural_creative/update/

创建程序化创意

open_api/2/creative/procedural_creative/create/

修改程序化创意

open_api/2/creative/procedural_creative/update/

supplements


云游戏

object[]

请求

新增字段

-

supplement_type

云游戏类型

string

请求

-

games

云游戏信息

object[]

请求

-

id

云游戏id

string

请求

-

orientation

云游戏素材方向

string

请求

创意详细信息

open_api/2/creative/read_v2/

collocation_type


云游戏类型

string

应答

supplements


云游戏素材

object[]

应答

-

game_id

云游戏id

string

应答

-

orientation

云游戏素材方向

string

应答

工具

试玩素材管理

获取云游戏试玩素材列表

open_api/2/tools/playable/cloud_game/list/

全部

全部

全部

请求

新增接口

(3)获取行政层级信息 能力已经于2021/08/31上线

类别

接口名称

接口地址

字段

字段含义

字段类型

参数类型

增加逻辑

工具

获取全球国家信息接口

/tools/country/info/

全部

全部

全部

请求+应答

新增接口

获取行政层级信息接口

/tools/admin/info/

全部

全部

全部

请求+应答

新增接口

请再次关注更新内容,及时评估对现有使用的影响以及改动。


2021年08月26日

尊敬的开发者:

本次内容主要针对 管家下广告主账户列表接口新增过滤字段 进行通知。请提前关注更新内容,及时评估对现有使用的影响以及改动。

【涉及接口】

管家广告主列表(分页)

一级分类

二级分类

接口名称

接口请求地址

附加信息

账号服务

账号管家管理

管家广告主列表(分页)

/open_api/2/customer_center/advertiser/list/

增加新的过滤字段,账户名称

【更新内容】

类别

接口名称

接口地址

字段

字段类型

参数类型

增加逻辑

账号服务

管家广告主列表(分页)

/open_api/2/customer_center/advertiser/list/

filtering



请求参数

将于8/26上线增加新的过滤字段,账户名称(选填)

-

account_name

string

请求参数


2021年08月17日

尊敬的开发者:您好!本次通知主要针对数据服务相关,包括订阅能力的能力推荐、数据报表自定义fileds能力推荐以及程序化落地页返回上限变更。


  1. 订阅服务

为缓解开发者潜在面临的【接口请求超频】问题,缓解您的技术资源压力,开放平台上线了【数据获取方案】,通过异步任务+SPI消息订阅的组合形式,不占用高额频控,实现历史/实时数据获取:

  • 首次获取数据时,建议可以通过创建「异步任务」的方式对历史数据进行获取。
  • 历史数据获取后,可通过接入「SPI消息订阅」的方式订阅实时更新数据的计划消息,对后续实时变更数据进行更新维护,避免无效请求(获取到没有变更的计划数据)。

通过以上两种方式对报表数据进行同步获取,可以大幅度降低您的请求频次和请求耗时,有效缓解您的频控压力。

详细使用方法见:数据获取方案,后续也将会通过该文档同步数据获取功能的实现接入方案。


  1. 基础报表自定义fileds

基础报表部分(广告主、广告组、广告计划),已于2021/07/06 支持自定义fileds,并将于2021/09/07 变更为:默认返回字段由返回全部,变更为返回默认值。

值得关注的是,传入自定义fileds时,仅在默认11个的场景下,基本的接口延时下降50%左右,数据包大小下降80%左右。

详见2021年07月07日更新日志。


  1. 程序化落地页管理返回数据上限变更

程序化落地页管理接口「获取落地页组」/tools/landing_group/get/ 没有设置page_size上限,存在部分page_size设置过高的情况,影响整体性能。故针对/tools/landing_group/get/ , page_size将在2021/09/23 增加限制为:100~500,针对超过限定的page_size数量,需要提前进行改造。


感谢您的支持,巨量引擎开放平台愿与您携手共建健康、优质的开放生态。


2021年08月13日

尊敬的开发者:

您好!本次通知主要针对橙子建站应用下载相关产品能力升级,包括已通知的变动点、即将生效的新变动点,请关注更新内容。

橙子建站相关变动


升级前

8.10

8.27

橙子建站

  • 下载链接未限定必须来源于应用管理中心
  • 未限定图片、文本等组件添加下载链接
  • 游戏预约ios、安卓均支持
  • 不能修改已经绑定计划的落地页中下载链接
  • 1个落地页仅支持填写同1个应用下载链接,ios\安卓均仅支持应用管理中心审核通过的下载链接
  • 橙子建站落地页内展示的内容须与下载的应用一致,不建议在创意及橙子建站落地页中自行添加应用五要素信息,避免因五要素信息错误造成拒审影响投放。
  • 橙子建站中,非下载、非预约组件不能配置ios/安卓下载链接
  • 游戏预约组件不能填写安卓下载链接,仅能填写ios下载链接

8月27日前,需完成上述要求的应用管理中心及橙子建站的升级工作,在创建计划时通过接口传入升级后要求的信息。此后,巨量引擎开放平台仅支持按以上规范创建新计划,不符合规范的计划将统一做下线处理。

请再次关注更新内容。


2021年08月10日

尊敬的开发者:

您好!本次通知主要针对应用下载广告产品能力及其他内容变动进行周知,请关注更新内容

  1. 应用下载广告能力变动:8月27日起,应用推广-IOS场景下载链接、包名仅支持【应用管理中心】。
  2. 优化目标部分字段规则变动。


1、应用下载内容变更

IOS应用同样需要录入应用管理中心,非应用管理中心会在变更生效后禁用。

推广目的

升级前

升级后

应用推广

  • 下载方式为:下载链接
    • iOS:仅传入下载链接
    • 安卓:传入下载链接、包名,应用下载详情页仅支持「橙子建站」
  • 下载方式为:落地页
    • 传入落地页链接,不传入下载链接
  • 下载方式为:下载链接
    • IOS:下载链接、包名仅支持「应用管理中心」
    • 安卓:下载链接、包名仅支持「应用管理中心」、应用详情仅支持「橙子建站」
  • 下载方式为:落地页
    • 下载链接、包名仅支持「应用管理中心」;应用详情仅支持「橙子建站」

应用推广-大推

  • 下载方式为:下载链接
    • iOS:仅传入下载链接
    • 安卓:传入下载链接、应用下载详情页
  • 下载方式为:落地页
    • 传入落地页链接,不传入下载链接
  • 下载方式为:下载链接
    • IOS:下载链接、包名仅支持「应用管理中心」
    • 安卓:下载链接、包名仅支持「应用管理中心」、应用详情仅支持「橙子建站」
  • 下载方式为:落地页
    • 下载链接、包名仅支持「应用管理中心」;应用详情仅支持「橙子建站」

应用推广-预约

  • 下载方式为:落地页
    • 下载链接、包名仅支持「应用管理中心」;落地页表单仅支持「橙子建站」
  • 下载方式为:落地页下载
    • 游戏表单收集
      • 无变动
    • 游戏预约按钮
      • 安卓应用预约下载:
        • 禁止创建该类计划
      • IOS应用预约下载:
        • 下载链接、包名仅支持「应用管理中心」


2、2021年8月10日起,通过开放平台接口新建广告计划时,需传入【应用管理中心审核通过的下载链接】,如使用落地页投放应用下载,需使用【橙子建站落地页】。

同时需要录入应用管理中心的安卓和IOS应用区分如下:

安卓应用:账户维度录入,即需要单个广告账户维度都为推广的应用录入

IOS应用:应用维度录入,即应用本身完成录入后,不同广告账户均可使用

  1. 1个落地页仅支持填写同1个应用下载链接,且仅支持应用管理中心审核通过的下载链接
  2. 落地页内的下载链接需和广告计划中的下载链接保持一致
  3. 8月10日前创建的应用下载类计划的下载链接和包名不支持修改
  4. 8月10日【修改转化目标】/tools/ad_convert/update/ 接口下线,转化跟踪中的下载链接不支持修改
  5. 8月27日前,需完成上述要求的应用管理中心及橙子建站的升级工作,在创建计划时通过接口传入升级后要求的信息
  6. 8月27日起,巨量引擎开放平台仅支持按以上规范创建新计划,不符合规范的计划将统一做下线处理


3、其他通知变动

2021年8月27日起,所有营销目的对应的所有计划均需要传入优化目标;

类别

二级类别

接口名称

接口地址

字段

字段含义

字段类型

参数类型

增加逻辑

广告投放

广告计划

创建广告计划

open_api/2/ad/create/

external_action/convert_id

转化目标

string

请求

自定义与预定义转化目标二选一,由逻辑必填变更为必填


2021年08月06日

尊敬的开发者:

您好!本次通知主要针对应用下载广告产品能力变动以及其他内容变动,(1)应用下载广告能力变动部分包括应用推广预约升级后规则变动以及投放管家创建项目能力整体下线;(2)其他内容包括包括地域定向、试玩素材变动生效时间后延。

关注更新内容,及时评估对现有使用的影响以及改动。


1、应用推广-预约场景,变动时点以及内容变更

2021年08月03日更新日志原文

推广目的

升级前

8月3日升级后

应用推广-预约

下载方式为:落地页下载链接、包名仅支持「应用管理中心」;落地页表单仅支持「橙子建站」

下载方式为:落地页下载链接、包名仅支持「应用管理中心」;应用详情仅支持「橙子建站」

变更后内容为(在2021年08月03日更新日志会同步更改

推广目的

升级前

升级后(8月10日生效)

应用推广-预约

下载方式为:

落地页下载链接、包名仅支持「应用管理中心」;落地页表单仅支持「橙子建站」

  • 下载方式为:落地页下载
    • 游戏表单收集
      • 无变动
    • 游戏预约按钮
      • 安卓应用预约下载:
        • 禁止创建该类计划
      • IOS应用预约下载:
        • ios下载链接、包名

2、详细变动中,投放管家部分创编能力改造方式变动

2021年08月03日更新日志原文,创建项目部分字段变动

类别

二级类别

接口名称

接口地址

字段

字段含义

字段类型

参数类型

增加逻辑

投放管家

创建项目

设置项目转化信息

open_api/2/adlab/group_convert/update/

url

landing_type=app并且download_type=DOWNLOAD_URL时,url字段表示应用下载链接

landing_type=LINK,或者download_type=EXTERNAL_URL时,url表示落地页链接

string

请求参数

字段下线

external_url

落地页链接

string

请求参数

新增字段

download_url

下载链接

string

请求参数

新增字段

设置项目创意信息

open_api/2/adlab/group_creative/update/

external_url

落地页链接

string

请求参数

新增校验

1、落地页必须来源「橙子建站落地页」

2、落地页中应用信息需要与项目汇总保持一致,否则会报错

项目查询

获取项目信息

open_api/2/adlab/group/get/

external_url

落地页链接

string

请求参数

新增字段

download_url

下载链接

string

请求参数

新增字段

变更后内容为,2021/08/27 创建项目部分下线

类别

二级类别

接口名称

接口地址

字段

字段含义

字段类型

参数类型

增加逻辑

投放管家

创建项目

新建投放管家项目

open_api/2/adlab/group/create/

全部

全部

全部

请求+应答

接口下线

设置项目转化信息

open_api/2/adlab/group_convert/update/

设置项目定向信息

open_api/2/adlab/group_audience/update/

设置项目创意信息

open_api/2/adlab/group_creative/update/

设置项目预算信息

open_api/2/adlab/group_budget/update/

项目查询

获取项目信息

open_api/2/adlab/group/get/

external_url

落地页链接

string

请求参数

新增字段

download_url

下载链接

string

请求参数

新增字段


3、其他通知变动

地域定向:根据2021/07/23更新日志,地域定向变更部分生效时间由2021/08/24 变更为2021/09月下旬。

试玩素材:根据2021/07/19 更新日志,基础试玩部分传参变化生效时间由2021/08/05 变更为2021/09中下旬。


请再次关注更新内容,及时评估对现有使用的影响以及改动。


2021年08月03日

尊敬的开发者:

您好!为了进一步保障用户权益,提升用户体验,巨量引擎开放平台将对下载类广告产品能力做出如下升级调整,详细相关字段及逻辑变动见下方。

本次变动时点:

  • 2021年8月3日起,应用推广场景下的产品升级如下:

推广目的

升级前

8月3日升级后

应用推广

  • 下载方式为:下载链接
    • iOS:仅传入下载链接
    • 安卓:传入下载链接、包名,应用下载详情页仅支持「橙子建站」
  • 下载方式为:落地页
    • 传入落地页链接,不传入下载链接
  • 下载方式为:下载链接
    • IOS:下载链接、包名
    • 安卓:下载链接、包名仅支持「应用管理中心」、应用详情仅支持「橙子建站」
  • 下载方式为:落地页
    • 下载链接、包名仅支持「应用管理中心」;应用详情仅支持「橙子建站」

应用推广-大推

  • 下载方式为:下载链接
    • iOS:仅传入下载链接
    • 安卓:传入下载链接、应用下载详情页
  • 下载方式为:落地页
    • 传入落地页链接,不传入下载链接
  • 下载方式为:下载链接
    • IOS:下载链接、包名
    • 安卓:下载链接、包名仅支持「应用管理中心」、应用详情仅支持「橙子建站」
  • 下载方式为:落地页
    • 下载链接、包名仅支持「应用管理中心」;应用详情仅支持「橙子建站」

应用推广-预约

  • 下载方式为:落地页
    • 下载链接、包名仅支持「应用管理中心」;落地页表单仅支持「橙子建站」
    • 下载方式为:落地页下载
      • 游戏表单收集
        • 无变动
      • 游戏预约按钮
        • 安卓应用预约下载:
          • 禁止创建该类计划
        • IOS应用预约下载:
          • ios下载链接、包名
  • 2021年8月10日起,通过开放平台接口新建广告计划时,需传入【应用管理中心审核通过的下载链接】;如使用落地页投放应用下载,需使用【橙子建站落地页】。同时:
    1. 不支持修改8月10日前创建的应用下载类计划的下载链接和包名
    2. 1个落地页仅支持填写同1个应用下载链接,且仅支持应用管理中心审核通过的下载链接
    3. 落地页内的下载链接需和广告计划中的下载链接保持一致
    4. 8月27日前,需完成上述要求的应用管理中心及橙子建站的升级工作,在创建计划时通过接口传入升级后要求的信息
    5. 8月27日起,巨量引擎开放平台仅支持按以上规范创建新计划,不符合规范的计划将统一做下线处理


基于本次变动的改造指引:

  1. 将应用信息录入【应用管理中心】:创建应用包的接口暂未对外开放,需在巨量引擎广告投放平台-应用管理中心手动上传应用包,完善/更新应用五要素信息。详细上传指引可参考应用管理中心相关内容。开放平台已有接口可见【应用管理】模块。
  2. 获取应用信息【查询应用信息:以此接口获取传入应用的相关信息。
  3. 创建橙子建站落地页【创建橙子建站站点】:如果有落地页投放诉求,可通过查询到的应用信息创建落地页。
  4. 获取橙子建站落地页信息【获取橙子建站站点列表:接入橙子建站相关接口,获取橙子建站落地页信息。
  5. 工具中应用信息来源:在工具中添加应用信息来源,同样需要来源于应用管理中心,可通过查询应用信息接口查询。
  6. 创编流程中应用信息完善:应用下载场景下,创建计划时应用下载、落地页下载均需要传入完整的应用信息,包括下载链接、包名,且须指向同一应用,可通过查询应用信息接口查询。以创建符合升级后要求的计划。
  7. 其他影响:应用下载投放流程、相关工具能力预期均会受本次升级影响,计划/工具/资产中应用信息来源及一致性校验(含计划、创意、管家、青鸟线索通、橙子建站、创意组件等)、计划中使用的工具能力、在工具中涉及到应用/落地页使用,都须严格保证应用信息一致。


相关字段及逻辑变动详情:以下字段/逻辑变动预计在8月27日全量生效,具体变动时间请以巨量引擎开放平台、巨量引擎广告投放平台正式通知为准。

类别

二级类别

接口名称

接口地址

字段

字段含义

字段类型

参数类型

增加逻辑

广告投放

广告计划

创建广告计划

open_api/2/ad/create/

download_url

下载链接

string

请求参数

1、应用信息必须来源于「应用管理中心」,否则报错

package

应用包名

string

请求参数

1、应用信息必须来源于「应用管理中心」,否则报错

2、应用包名必须与下载链接指向应用信息(包名)一致

external_url

落地页链接

string

请求参数

1、非营销链路流程下,落地页下载场景下,同应用下载场景,必须传入下载链接和包名,

2、落地页中设置的下载链接对应应用信息(包名)必须与传入应用包名一致

advanced_creative_type

附加创意类型

string

请求参数

下线非营销链路流程中,通过附加创意中使用游戏礼包码逻辑,枚举值中下线ATTACHED_CREATIVE_GAME_PACKAGE

game_package_desc

应用描述

string

请求参数

下线非营销链路流程中,通过附加创意中使用游戏礼包码逻辑

game_package_batch_id

游戏礼包码id

number

请求参数

下线非营销链路流程中,通过附加创意中使用游戏礼包码逻辑

game_package_thumbnail_ids

应用图片集

string[]

请求参数

下线非营销链路流程中,通过附加创意中使用游戏礼包码逻辑

subscribe_url

预约下载链接

string

请求参数

原本已限制,此处单独说明

应用信息必须来源于「应用管理中心」,否则报错

修改广告计划

open_api/2/ad/update/

download_url

下载链接

string

请求参数

不可修改

package

包名

string

请求参数

不可修改

external_url

落地页链接

string

请求参数

不可修改

advanced_creative_type

附加创意类型

string

请求参数

下线非营销链路流程中,通过附加创意中使用游戏礼包码逻辑,枚举值中下线ATTACHED_CREATIVE_GAME_PACKAGE

game_package_desc

应用描述

string

请求参数

下线非营销链路流程中,通过附加创意中使用游戏礼包码逻辑

game_package_batch_id

游戏礼包码id

number

请求参数

下线非营销链路流程中,通过附加创意中使用游戏礼包码逻辑

game_package_thumbnail_ids

应用图片集

string[]

请求参数

下线非营销链路流程中,通过附加创意中使用游戏礼包码逻辑

广告创意

创建广告创意

open_api/2/creative/create_v2/

web_url

Android应用下载详情页

string

请求参数

1、落地页必须来源「橙子建站落地页」

2、落地页中应用信息必须来自「应用管理中心」

3、落地页中应用信息必须与计划中应用信息(包名)保持一致

app_name

应用名

string

请求参数

1、应用名对应应用必须在「应用管理中心」录入

2、应用名在「应用管理中心」对应应用信息(包名)必须与计划中对应应用信息(包名)保持一致

component_id

组件id

string

请求参数

1、创意组件中涉及应用信息必须来「自应用管理中心」

2、创意组件中涉及应用信息必须与计划中添加的应用信息(包名)一致,为同一个应用

修改广告创意

open_api/2/creative/update_v2/

web_url

Android应用下载详情页

string

请求参数

不可修改

app_name

应用名

string

请求参数

不可修改

component_id

组件id

string

请求参数

1、创意组件中涉及应用信息必须来自「应用管理中心」

2、创意组件中涉及应用信息必须与计划中添加的应用信息(包名)一致,即为同一个应用

创建自定义创意(营销链路)

open_api/2/creative/custom_creative/create/

web_url

Android应用下载详情页

string

请求参数

1、落地页必须来源「橙子建站落地页」

2、落地页中应用信息必须来自「应用管理中心」

3、落地页中应用信息必须与计划中应用信息(包名)保持一致

app_name

应用名

string

请求参数

1、应用名对应应用必须在「应用管理中心」录入

2、应用名在「应用管理中心」对应应用信息(包名)必须与计划中对应应用信息(包名)保持一致

external_url

落地页链接

string


1、落地页必须来源「橙子建站落地页」

2、落地页中应用信息必须来自「应用管理中心」

3、落地页中应用信息必须与计划中应用信息(包名)保持一致

component_id

组件id

string

请求参数

1、创意组件中涉及应用信息必须来自「应用管理中心」

2、创意组件中涉及应用信息必须与计划中添加的应用信息(包名)一致,即为同一个应用

修改自定义创意(营销链路)

open_api/2/creative/custom_creative/update/

web_url

Android应用下载详情页

string

请求参数

落地页信息不可修改

app_name

应用名

string

请求参数

应用信息不可修改

external_url

落地页链接

string

请求参数

落地页信息不可修改

component_id

组件id

string

请求参数

1、创意组件中涉及应用信息必须来自「应用管理中心」

2、创意组件中涉及应用信息必须与计划中添加的应用信息(包名)一致,即为同一个应用

创建程序化创意(营销链路)

open_api/2/creative/procedural_creative/create/

web_url

Android应用下载详情页

string

请求参数

1、落地页必须来源「橙子建站落地页」

2、落地页中应用信息必须来自「应用管理中心」

3、落地页中应用信息必须与计划中应用信息(包名)保持一致

app_name

应用名

string

请求参数

1、应用名对应应用必须在「应用管理中心」录入

2、应用名在「应用管理中心」对应应用信息(包名)必须与计划中对应应用信息(包名)保持一致

external_url

落地页链接

string


1、落地页必须来源「橙子建站落地页」

2、落地页中应用信息必须来自「应用管理中心」

3、落地页中应用信息必须与计划中应用信息(包名)保持一致

component_id

组件id

string

请求参数

1、创意组件中涉及应用信息必须来自「应用管理中心」

2、创意组件中涉及应用信息必须与计划中添加的应用信息(包名)一致,即为同一个应用

修改程序化创意(营销链路)

open_api/2/creative/procedural_creative/update/

web_url

Android应用下载详情页

string

请求参数

不可修改

app_name

应用名

string

请求参数

不可修改

external_url

落地页链接

string


不可修改

component_id

组件id

string

请求参数

1、创意组件中涉及应用信息必须来自「应用管理中心」

2、创意组件中涉及应用信息必须与计划中添加的应用信息(包名)一致,即为同一个应用

投放管家

创建项目

设置项目转化信息

open_api/2/adlab/group_convert/update/

url

landing_type=app并且download_type=DOWNLOAD_URL时,url字段表示应用下载链接

landing_type=LINK,或者download_type=EXTERNAL_URL时,url表示落地页链接

string

请求参数

字段下线

external_url

落地页链接

string

请求参数

新增字段

download_url

下载链接

string

请求参数

新增字段

设置项目创意信息

open_api/2/adlab/group_creative/update/

external_url

落地页链接

string

请求参数

新增校验

1、落地页必须来源「橙子建站落地页」

2、落地页中应用信息需要与项目汇总保持一致,否则会报错

项目查询

获取项目信息

open_api/2/adlab/group/get/

external_url

落地页链接

string

请求参数

新增字段

download_url

下载链接

string

请求参数

新增字段

工具

橙子建站

创建橙子建站站点

open_api/2/tools/site/create/

url(android_link结构体中)

安卓链接信息

string

请求参数

7.30已经变更

应用信息必须来源于「应用管理中心」

应用管理

查询游戏信息

open_api/2/tools/app_management/booking/get/

全部


全部

请求+应答

无变更,本部分接口对接「应用管理中心」

需要注意的是本部分为应用信息获取来源,获取「应用管理中心」下应用的接口,需要接入后,才能完成在橙子建站,创编流程中使用

查询应用信息

open_api/2/tools/app_management/app/get/

全部


全部

请求+应答

查询应用预约记录

open_api/2/tools/app_management/booking_records/get/

全部


全部

请求+应答

资产

创意组件

创建组件

open_api/2/assets/creative_component/create/

app_name


string

请求

字段变更,以游戏礼包码为例,

1、应用信息必须来源于「应用管理中心」

2、应用信息与计划必须一致,否则计划创建失败

package_name


string

请求

app_download_url


string

请求

app_description


string

请求

更新组件

open_api/2/assets/creative_component/update/

app_name


string

请求

字段变更,以游戏礼包码为例,

1、应用信息必须来源于「应用管理中心」

2、应用信息与计划必须一致,否则计划操作失败

package_name


string

请求

app_download_url


string

请求

app_description


string

请求


2021年07月30日

尊敬的开发者:

本次内容主要针对新营销链路、旧版创编流程中长期变动,以及针对程序化创意包能力下线进行通知。本次更新将其重要,请提前关注更新内容,及时评估对现有使用的影响以及改动。

【涉及接口】

营销链路

接口信息略,涉及创编全流程

广告投放

一级分类

二级分类

接口名称

接口请求地址

附加信息

广告投放

广告创意

创建程序化创意(营销链路)

open_api/2/creative/procedural_creative/create/

程序化创意包功能下线

修改程序化创意(营销链路)

open_api/2/creative/procedural_creative/update/

创建广告创意

open_api/2/creative/create_v2/

修改广告创意

open_api/2/creative/update_v2/

【更新内容】

  1. 极其重要】营销链路&(旧版)创编流程,随着新营销链路上线,针对老版本推广目的对应投放能力进行变更:

(旧版)门店推广2021/08/03 下线,通过开放平台不再能进行门店推广目的广告投放(见历史通知2021/07/01更新日志)

(旧版)销售线索收集(销售线索收集依赖的线索组件将于8月上线)、(旧版)抖音号推广、(旧版)商品推广GOOD 3个推广目的将于10月下旬下线

(旧版)应用推广将于12月底下线(营销链路中游戏垂直化部分将于10月下支持)

(营销链路)商品目录推广DPA将于12月提供,(旧版)商品目录推广DPA将于2022年2月下线

  1. 程序化创意包功能下线,投放平台侧已经于2021/07/01下线,开放平台侧将于2021/08/24 下线;

类别

接口名称

接口地址

字段

字段类型

参数类型

增加逻辑

广告投放

创建程序化创意(营销链路)

open_api/2/creative/procedural_creative/create/

procedural_package

object

请求参数

字段下线

package_id

number

请求参数

字段下线

修改程序化创意(营销链路)

open_api/2/creative/procedural_creative/update/

procedural_package

object

请求参数

字段下线

package_id

number

请求参数

字段下线

创建广告创意

open_api/2/creative/create_v2/

procedural_package_id

number

请求参数

字段下线

procedural_package_id

number

请求参数

字段下线

procedural_package_version

number

请求参数

字段下线

修改广告创意

open_api/2/creative/update_v2/

procedural_package_id

number

请求参数

字段下线

procedural_package_id

number

请求参数

字段下线

procedural_package_version

number

请求参数

字段下线

本次通知信息极其重要,请再次提前关注更新内容,及时评估对现有使用的影响以及改动。


2021年07月23日

尊敬的开发者:

本次内容主要针对事件管理能力更新通知,以及针对地域定向和创意能力变更和下线部分能力进行通知。请提前关注更新内容,及时评估对现有使用的影响以及改动。

【涉及接口】

广告投放

一级分类

二级分类

接口名称

接口请求地址

附加信息

广告投放

广告计划

创建广告计划(营销链路)

open_api/2/ad/create/

2021/07/23新增字段 创编中事件管理、差异价值能力上线;

预计2021/08/24 地域定向变更

修改广告计划(营销链路)

open_api/2/ad/update/

获取广告计划

open_api/2/ad/get/

广告创意

创建自定义创意(营销链路)

open_api/2/creative/custom_creative/create/

预计2021/08/24 衍生计划和创意轮播下线

修改自定义创意(营销链路)

open_api/2/creative/custom_creative/update/

创建程序化创意(营销链路)

open_api/2/creative/procedural_creative/create/

修改程序化创意(营销链路)

open_api/2/creative/procedural_creative/update/

创建广告创意

open_api/2/creative/create_v2/

修改广告创意

open_api/2/creative/update_v2/

资产-事件管理

一级分类

二级分类

接口名称

接口请求地址

附加信息

资产

事件管理

获取推广内容

open_api/2/tools/event/assets/get/

2021/07/23 新增接口

获取优化目标

/open_api/2/tools/event_convert/optimized_goal/get/

2021/07/23 新增接口

工具-定向包

一级分类

二级分类

接口名称

接口请求地址

附加信息

工具

定向包

创建定向包

open_api/2/audience_package/create/

2021/08/24 地域定向中新增 按行政区域,下线省市、区县,行政区域传入不再使用离线json文件,将在近期新增获取行政层级接口,需要通过该接口查询传入

更新定向包

open_api/2/audience_package/update/

获取定向包

open_api/2/audience_package/get/

入参数据结构变化,出参数据结构变化

【更新内容】

  1. 转化跟踪升级事件管理,事件管理基础功能已经与2021/07/23更新,支持资产中查询到事件,在广告投放流程中添加事件,以及支持事件差异价值相关能力,详情如下;

类别

接口名称

接口地址

字段

字段类型

参数类型

增加逻辑

资产-事件管理

获取推广内容

open_api/2/tools/event/assets/get/

全部

全部

请求+应答

接口新增

获取优化目标

/open_api/2/tools/event_convert/optimized_goal/get/

全部

全部

请求+应答

广告投放

创建广告计划(营销链路)

open_api/2/ad/create/

asset_ids

number[]

请求参数

字段新增

value_optimized_type

number

请求参数

value_optimized_open

number

请求参数

roi_goal

float

请求参数

字段变更

修改广告计划(营销链路)

open_api/2/ad/update/

roi_goal

float

请求参数

字段变更

获取广告计划

open_api/2/ad/get/

asset_ids

number[]

应答参数

字段新增

value_optimized_type

number

应答参数

value_optimized_open

number

应答参数

  1. 用户定向中,涉及广告创编主流程以及定向包工具中的地域定向,将于2021/08/24变动;

类别

接口名称

接口地址

字段

字段类型

参数类型

增加逻辑

广告投放

创建广告计划(营销链路)

open_api/2/ad/create/

district

string

请求参数

字段变动:

district枚举变动,city数据源由json文件变为接口,

字段新增:

新增地域版本号字段

字段枚举下线:

district中下线省市、区县

city

number[]

请求参数

修改广告计划(营销链路)

open_api/2/ad/update/

district

string

请求参数

city

number[]

请求参数

获取广告计划

open_api/2/ad/get/

district

string

应答参数

city

number[]

应答参数

工具

创建定向包

open_api/2/audience_package/create/

district

string

请求参数

city

number[]

请求参数

更新定向包

open_api/2/audience_package/update/

district

string

请求参数

city

number[]

请求参数

获取定向包

open_api/2/audience_package/get/

district

string

应答参数

city

number[]

应答参数

  1. 创意能力中,衍生计划和创意展现方式(轮播)能力将于2021/08/24变动;

类别

接口名称

接口地址

字段

字段类型

参数类型

增加逻辑

广告投放

创建自定义创意(营销链路)

open_api/2/creative/custom_creative/create/

creative_display_mode

string

请求参数

枚举值下线:

轮播模式CREATIVE_DISPLAY_MODE_RANDOM下线

修改自定义创意(营销链路)

open_api/2/creative/custom_creative/update/

creative_display_mode

string

请求参数

创建程序化创意(营销链路)

open_api/2/creative/procedural_creative/create/

generate_derived_ad

number

请求参数

字段下线

creative_display_mode

string

请求参数

枚举值下线:

轮播模式CREATIVE_DISPLAY_MODE_RANDOM下线

修改程序化创意(营销链路)

open_api/2/creative/procedural_creative/update/

generate_derived_ad

number

请求参数

字段下线

creative_display_mode

string

请求参数

枚举值下线:

轮播模式CREATIVE_DISPLAY_MODE_RANDOM下线

创建广告创意

open_api/2/creative/create_v2/

generate_derived_ad

number

请求参数

字段下线

creative_display_mode

string

请求参数

枚举值下线:

轮播模式CREATIVE_DISPLAY_MODE_RANDOM下线

修改广告创意

open_api/2/creative/update_v2/

generate_derived_ad

number

请求参数

字段下线

creative_display_mode

string

请求参数

枚举值下线:

轮播模式CREATIVE_DISPLAY_MODE_RANDOM下线

请再次提前关注更新内容,及时评估对现有使用的影响以及改动。


2021年07月21日

尊敬的开发者:

为提升您在开放平台的体验,平台现差异化处理登录/非登录状态下的功能。登录后,导航栏将出现「进入开发者管理后台」按钮,点击后可进入「开发者管理后台」。原应用管理、健康度管理、订阅服务、消息中心、账号管理等服务统一收入至开发者管理后台,您可查看以上服务并进行相关操作。未登录时,开发者管理后台不可见。

如您仍然存在疑惑或有相关建议,可在开放平台提交工单联系我们。


2021年07月19日

尊敬的开发者:

本次内容主要针对基础试玩、工具中建站规则变动进行更新通知。请提前关注更新内容,及时评估对现有使用的影响以及改动。

【涉及接口】

创编

一级分类

二级分类

接口名称

接口请求地址

附加信息

创编

广告创意

创建自定义创意

open_api/2/creative/custom_creative/create/

将于2021/08/05 变更,基础试玩传参变化



修改自定义创意

open_api/2/creative/custom_creative/update/

工具-建站/试玩素材

一级分类

二级分类

接口名称

接口请求地址

附加信息

工具

橙子建站

创建橙子建站站点

open_api/2/tools/site/create/

逻辑变更

  1. 2021/07/21 审核规则先发后审变为先审后发
  2. 建站落地页创建/修改规则修改 高度限制 数量限制 透明度限制 下载文案限制

修改橙子建站站点

open_api/2/tools/site/update/

更改橙子建站站点状态

tools/site/update_status/

试玩素材

获取试玩素材列表

open_api/2/tools/playable_list/get/

将于2021/08/05,查询试玩素材信息中,新增封面预览地址

【更新内容】

  1. 基础试玩相关

创意中关于基础试玩,将于2021年08月05日发生变更,详情如下;

类别

接口名称

接口地址

字段

字段类型

参数类型

增加逻辑

创编-广告投放

创建自定义创意

open_api/2/creative/custom_creative/create/

playable_material





将于2021/08/05 变更,自定义创意中使用基础试玩,请求参数需要新增封面预览地址

-

playable_info




-

-

previewUrl

string

请求参数

修改自定义创意

open_api/2/creative/custom_creative/update/

playable_material





-

playable_info




-

-

previewUrl

string

请求参数

工具-试玩素材

获取试玩素材列表

open_api/2/tools/playable_list/get/

data





将于2021/08/05,查询试玩素材信息中,新增封面预览地址

-

list




-

-

previewUrl

string

应答参数

  1. 工具能力建站相关

变更1,已经于2021/07/18 已变更,落地页创建、修改中内容规则限制生效;

变更2,将于2021/07/21变更,审核规则先发后审变为先审后发。

类别

接口名称

接口地址

字段

字段类型

参数类型

增加逻辑

资产-创意组件

创建橙子建站站点

open_api/2/tools/site/create/

全部

全部

请求参数

逻辑变更

  1. 2021/07/21 审核规则先发后审变为先审后发 先审核后投放,落地页完全过审后,才能用于创建计划
  2. 2021/07/18 建站落地页创建/修改规则修改 高度限制 编辑落地页时,每个应用下载按钮(基本样式、顶部悬浮、底部悬浮3种)高度设置均不能超过48px 限制方式:如果应用下载按钮高度设置超过了48px,则在落地页保存时toast提示“应合规要求,应用下载组件-下载按钮高度不得超过48px”(该提示优先级最高) 数量限制 编辑落地页时,每个落地页上的应用下载按钮(仅指基本样式和自定义图片,不包括顶部悬浮和底部悬浮按钮)无法超过三个 各下载按钮之间的间距必须>80px 限制方式:同“高度限制”的限制方式,文案为“应合规要求,应用下载组件-下载按钮数量不得超过3个”(该提示优先级第二) 透明度限制 每个应用下载按钮的透明度(Alpha参数)不得低于0.50 限制方式:同“高度限制”的限制方式,文案为“应合规要求,应用下载组件-下载按钮透明度不得低于0.5”(该提示优先级第三) 下载文案限制 报错:普通下载按钮校验按钮文案,如无“下载”字样则报错,报错toast:“应合规要求,应用下载按钮文案必须包含“下载”字样” 提示 自定义图片组件旁添加提示方案:“应合规要求,应用下载按钮文案必须包含“下载”字样,一经发现违规,将强制下线计划”,颜色为红色 下载按钮文案旁加提示:“应合规要求,应用下载按钮文案必须包含“下载”字样”,颜色为红色 限制文案宽度不可超出按钮,所有文字内容都必须展示在按钮上

修改橙子建站站点

open_api/2/tools/site/update/

全部

全部

请求参数


更改橙子建站站点状态

tools/site/update_status/

全部

全部

请求参数

请再次提前关注更新内容,及时评估对现有使用的影响以及改动。


2021年07月14日

尊敬的开发者:

本次内容主要针对创编、数据报表、资产能力更新进行通知。麻烦辛苦您提前关注更新内容,及时评估对您现有使用的影响以及改动。

【涉及接口】

创编

一级分类

二级分类

接口名称

接口请求地址

附加信息

创编

广告计划

创建广告计划

open_api/2/ad/create/

2021/08/17,字段下线



更新广告计划

open_api/2/ad/update/

2021/08/17,涉及投放范围的scene_inventory计划禁止编辑

数据报表

一级分类

二级分类

接口名称

接口请求地址

附加信息

数据报表

数据报表

广告创意数据

open_api/2/report/creative/get/

逻辑变更

2021/08/17 创意报表以及多合一报表逻辑变动

group_by条件中将不再支持 按照省份、按照城市、按照性别、按照年龄、按照平台、按照网络类型

多合一数据报表

open_api/2/report/integrated/get/

资产能力

一级分类

二级分类

接口名称

接口请求地址

附加信息

资产

创意组件

创建组件

open_api/2/assets/creative_component/create/

组件类型增加推广卡片和游戏礼包码

更新组件

open_api/2/assets/creative_component/update/

查询组件列表

open_api/2/assets/creative_component/get/

【更新内容】

  1. 创编投放范围相关

投放范围中,将于2021年08月17日发生变更,投放范围使用首选场景广告位能力将下线,详情如下;

类别

接口名称

接口地址

字段

字段类型

参数类型

增加逻辑

创编-广告投放

创建广告计划

open_api/2/ad/create/、

scene_inventory

string

请求参数

将于2021/08/17字段下线,创建计划无法使用首选场景广告位

修改广告计划

open_api/2/ad/update/




将于2021/08/17字段进行限制,不允许编辑投放范围使用了首选场景广告位的计划

  1. 数据报表相关

报表部分(广告创意、多合一报表),将于2021年08月17日发生变更,分组条件group_by将有部分条件不再支持;

类别

接口名称

接口地址

字段

字段类型

参数类型

增加逻辑

数据报表

广告创意数据

open_api/2/report/creative/get/

group_by

string[]

请求参数

逻辑变更 将于2021/08/17变动

group_by条件中将不再支持

按照省份STAT_GROUP_BY_PROVINCE_NAME、

按照城市STAT_GROUP_BY_CITY_NAME、

按照性别STAT_GROUP_BY_GENDER、

按照年龄STAT_GROUP_BY_AGE、

按照平台STAT_GROUP_BY_PLATFORM、

按照网络类型STAT_GROUP_BY_AC

多合一数据报表

open_api/2/report/integrated/get/

group_by

string[]

请求参数

  1. 工具能力创意组件相关

已经于2021/07/13 变更,支持推广卡片、游戏礼包码类型的创意组件,详情如下。

类别

接口名称

接口地址

字段

字段类型

参数类型

增加逻辑

资产-创意组件

创建组件

open_api/2/assets/creative_component/create/

component_type

string

请求参数

2021/07/13 已变更,类型枚举新增推广卡片PROMOTION_CARD、游戏礼包码GAME_PACK

component_data

json

请求参数

2021/07/13 已变更,根据类型枚举新增推广卡片、游戏礼包码,新增对应结构体

更新组件

open_api/2/assets/creative_component/update/

component_type

string

请求参数

2021/07/13 已变更,类型枚举新增推广卡片PROMOTION_CARD、游戏礼包码GAME_PACK

component_data

json

请求参数

2021/07/13 已变更,根据类型枚举新增推广卡片、游戏礼包码,新增对应结构体

查询组件列表

open_api/2/assets/creative_component/get/

component_types

string[]

请求参数

2021/07/13 已变更,类型枚举新增推广卡片PROMOTION_CARD、游戏礼包码GAME_PACK

麻烦再次辛苦您提前关注更新内容,及时评估对您现有使用的影响以及改动。


2021年07月07日

尊敬的开发者:

本次内容主要针对创编、数据报表、工具能力更新进行通知,麻烦辛苦您提前关注更新内容,及时评估对您现有使用的影响以及改动。

【涉及接口】

创编

一级分类

二级分类

接口名称

接口请求地址

附加信息

创编

广告计划

创建广告计划

open_api/2/ad/create/

新增校验 定向规则已于2021/07/07发生变更,前置通知可见2021/04/08日通知,用户定向部分,在此基础上新增规则:

  • 选择商品目录推广且应用类型为不限时, 不支持已安装用户定向选择过滤
  • 选择了城市时不能同时选择地域定向类型为不限
  • 选择销售线索收集且投放范围为穿山甲时, 不支持网络运营商定向选择移动
  • 选择了手机品牌定向为苹果时, 必须选择平台定向为不限或IOS
  • 转化目标为点击量或展示量时, 不支持过滤已转化定向
  • 同一人群包无法同时定向与排除
  • 媒体包不存在



更新广告计划

open_api/2/ad/update/

数据报表

一级分类

二级分类

接口名称

接口请求地址

附加信息

数据报表

数据报表

广告主数据

open_api/2/report/advertiser/get/

新增字段 2021/07/06 新增fileds字段,默认返回全部

逻辑变更 2021/09/07 默认返回字段:由返回全部变更为返回默认值

广告组数据

open_api/2/report/campaign/get/

广告计划数据

open_api/2/report/ad/get/

工具能力

一级分类

二级分类

接口名称

接口请求地址

附加信息

工具

定向包

查询定向包

open_api/2/audience_package/get/

新增字段

创建定向包

open_api/2/audience_package/create/

新增字段

新增校验

飞鱼线索

获取线索列表

open_api/2/tools/clue/get/

新增字段

【更新内容】

  1. 创编用户定向相关

用户定向规则已经于2021年07月07日更新生效,详见2021年04月08日通知内容,在此基础上新增部分强校验(定向字段未按描述规则使用则会报错),详情如下

类别

接口名称

接口地址

字段

字段类型

参数类型

增加逻辑

创编-广告投放

创建广告计划、修改广告计划

open_api/2/ad/create/、

open_api/2/ad/update/

hide_if_exists

number

请求参数

选择商品目录推广且应用类型为不限时, 不支持已安装用户定向选择过滤

district

string

请求参数

选择了城市时不能同时选择地域定向类型为不限

carrier

string[]

请求参数

选择销售线索收集且投放范围为穿山甲时, 不支持网络运营商定向选择移动

device_brand

string[]

请求参数

选择了手机品牌定向为苹果时, 必须选择平台定向为不限或IOS

platform

string[]

请求参数

hide_if_converted

string

请求参数

转化目标为点击量或展示量时, 不支持过滤已转化定向

retargeting_tags_include

number[]

请求参数

同一人群包无法同时定向与排除

retargeting_tags_exclude

number[]

请求参数

flow_package

number[]

请求参数

媒体包不存在

exclude_flow_package

number[]

请求参数

  1. 数据报表相关

基础报表部分(广告主、广告组、广告计划),已经于2021/07/06 支持自定义fileds,返回fileds中定义的指标,且将于2021/09/07 变更,默认返回字段由返回全部,变更为返回默认值。

类别

接口名称

接口地址

字段

字段类型

参数类型

增加逻辑

数据报表

广告主数据

open_api/2/report/advertiser/get/

fileds

string[]

请求参数

新增字段 2021/07/06 新增fileds字段,默认返回全部

逻辑变更 2021/09/07 默认返回字段变动:由返回全部变更为返回默认值

默认值:cost、show、avg_show_cost、click、ctr、avg_click_cost、convert、convert_rate、convert_cost

广告组数据

open_api/2/report/campaign/get/

fileds

string[]

请求参数

广告计划数据

open_api/2/report/ad/get/

fileds

string[]

请求参数

  1. 工具能力定向包相关

已经于2021/07/06 支持定向包中,新推广目的对应定向包,以及与创编中对比缺失字段。定向字段未按描述规则使用则会报错。

类别

接口名称

接口地址

字段

字段类型

参数类型

增加逻辑

工具

查询定向包

open_api/2/audience_package/get/

landing_type

string

应答参数

增加枚举

aweme_fan_behaviors

string[]

应答参数

增加字段

superior_popularity_type

string

应答参数

增加字段

flow_package

number[]

应答参数

增加字段

exclude_flow_package

number[]

应答参数

增加字段

device_type

list[]

应答参数

增加字段

hide_if_converted

string

应答参数

增加字段

converted_time_duration

string

应答参数

增加字段

career

string[]

应答参数

增加字段

创建定向包

open_api/2/audience_package/create/

landing_type

string

请求参数

增加枚举

aweme_fan_behaviors

string[]

请求参数

增加字段

superior_popularity_type

string

请求参数

增加字段

flow_package

number[]

请求参数

增加字段

exclude_flow_package

number[]

请求参数

增加字段

device_type

list[]

请求参数

增加字段

hide_if_converted

string

请求参数

增加字段,

converted_time_duration

string

请求参数

增加字段

career

string[]

请求参数

增加字段

hide_if_exists

number

请求参数

选择商品目录推广且应用类型为不限时, 不支持已安装用户定向选择过滤

district

string

请求参数

选择了城市时不能同时选择地域定向类型为不限

carrier

string[]

请求参数

选择销售线索收集且投放范围为穿山甲时, 不支持网络运营商定向选择移动

device_brand

string[]

请求参数

选择了手机品牌定向为苹果时, 必须选择平台定向为不限或IOS

platform

string[]

请求参数

retargeting_tags_include

number[]

请求参数

同一人群包无法同时定向与排除

retargeting_tags_exclude

number[]

请求参数

flow_package

number[]

请求参数

媒体包不存在

exclude_flow_package

number[]

请求参数

  1. 工具能力飞鱼线索相关

已经于2021/07/06 进行变更,新增部分返回信息。

类别

接口名称

接口地址

字段

字段类型

参数类型

增加逻辑

工具

飞鱼-获取线索列表

open_api/2/tools/clue/get/

site_name

string

应答参数

增加字段

creative_id

string

应答参数

增加字段

intention_estimation

string

应答参数

增加字段


麻烦再次辛苦您提前关注更新内容,及时评估对您现有使用的影响以及改动。


2021年07月01日

尊敬的开发者:

本次内容主要针对电商广告(千川)部分变动生效通知,以及门店推广能力、万花筒能力功能进行预通知。麻烦辛苦您提前关注更新内容,及时评估对您现有使用的影响以及改动。

另外,系统将于2021.07.08 01:00-03:00 和 2021.07.20 01:00-05:00 进行维护,请提前做好准备。

【涉及接口】

一级分类

二级分类

接口名称

接口请求地址

附加信息

账号服务

账号管家

查询广告主列表

open_api/2/majordomo/advertiser/select/

将于2021/08/03接口下线

创编

广告组

创建广告组

open_api/2/campaign/create/

门店推广,将于2021/08/03下线,涉及的创编流程将不再能创建推广目的为门店的组-计划-创意

广告计划

创建广告计划

open_api/2/ad/create/

修改广告计划

open_api/2/ad/update/

广告创意

创建广告创意

open_api/2/creative/create_v2/

修改广告创意

open_api/2/creative/update_v2/

创意素材信息

open_api/2/creative/material/read/

将于2021/08/03接口下线

工具

万花筒创意

获取万花筒任务信息

open_api/2/kaleidoscope/job/result/get/

新建万花筒任务配置

open_api/2/kaleidoscope/job/conf/upload/

获取万花筒任务配置

open_api/2/kaleidoscope/job/conf/get/

微电影

open_api/2/kaleidoscope/job/smart_cut/submit/

图片超分

open_api/2/kaleidoscope/job/super_resolution/submit/

视频摘要

open_api/2/kaleidoscope/job/video_summarization/submit/

视频拼接

open_api/2/kaleidoscope/job/video_concat/submit/

根据音乐风格获取音乐列表

open_api/2/kaleidoscope/job/music_get_by_style/submit/

TopView方式的视频智能裁剪

open_api/2/kaleidoscope/job/zoom_video_retargeting_top_view/submit/

视频智能裁剪

open_api/2/kaleidoscope/job/magic_video_retargeting/submit/

视频边框裁剪

open_api/2/kaleidoscope/job/video_edge_cut/submit/

查询

查询门店

open_api/2/tools/advertiser_store/search/

将于2021/08/03接口下线

查询门店活动

open_api/2/tools/advertiser_store/search_pack/

【更新内容】

  1. 电商广告相关

为向您提供全方位的电商营销一体化服务,巨量引擎开放平台对【商品推广】(非DPA)和【评论管理】相关接口进行调整。

巨量引擎开放平台于7月1日正式更新【商品推广】(非DPA)和【评论管理】相关的接口,电商广告(原巨量鲁班)账户将涉及以下调整:

  1. 暂停现有接口中关于【商品推广】(非DPA)的广告组/计划/创意的新建操作。除投放中的广告组/计划/创意可操作暂停外,原有广告组/计划/创意下的新建、复制、编辑操作均不可用。如需投放,请至巨量千川开放能力查询相关接口。
  2. 暂停投放管家接口下关于【商品推广】(非DPA)的广告项目的新建操作。除投放中的广告项目/计划可操作查询/暂停外,原有广告项目下的新建、编辑操作均不可用,原有计划下的编辑操作不可用
  3. 暂停现有【评论管理】接口中关于评论、评论回复、屏蔽词、屏蔽用户等编辑操作。如需进行评论管理,后续请通过巨量千川广告平台进行投放。
  4. 现有【评论管理】接口中关于评论、评论回复、屏蔽词、屏蔽用户等读取操作将可继续正常获取。
  1. 门店推广能力下线

门店推广,将于2021/08/03下线,涉及的创编流程将不再能创建推广目的为门店的组-计划-创意,工具中不提供查询门店和门店活动能力

类别

接口名称

接口地址

字段

字段类型

参数类型

增加逻辑

创编

创建广告组

open_api/2/campaign/create/

landing_type


string

请求参数

允许值:

去除门店STORE

创建广告计划

open_api/2/ad/create/

storepro_unit


string

请求参数

将于2021/08/03字段下线

store_type


string

请求参数

advertiser_store_ids


number[]

请求参数

storepro_pack_id


number

请求参数

修改广告计划

open_api/2/ad/update/





创建广告创意

open_api/2/creative/create_v2/

promotion_card


object


-

enable_store_pack

bool

请求参数

修改广告创意

open_api/2/creative/update_v2/

promotion_card




-

enable_store_pack

bool

请求参数

工具

查询门店

open_api/2/tools/advertiser_store/search/

全部

全部

请求+应答

查询门店活动

open_api/2/tools/advertiser_store/search_pack/

全部

全部

请求+应答

  1. 万花筒能力下线

万花筒能力整体将于2021/08/03接口下线

类别

接口名称

接口地址

字段

字段类型

参数类型

增加逻辑

工具

获取万花筒任务信息

open_api/2/kaleidoscope/job/result/get/

全部

全部

请求+应答

将于2021/08/03接口下线

新建万花筒任务配置

open_api/2/kaleidoscope/job/conf/upload/

全部

全部

请求+应答

获取万花筒任务配置

open_api/2/kaleidoscope/job/conf/get/

全部

全部

请求+应答

微电影

open_api/2/kaleidoscope/job/smart_cut/submit/

全部

全部

请求+应答

图片超分

open_api/2/kaleidoscope/job/super_resolution/submit/

全部

全部

请求+应答

视频摘要

open_api/2/kaleidoscope/job/video_summarization/submit/

全部

全部

请求+应答

视频拼接

open_api/2/kaleidoscope/job/video_concat/submit/

全部

全部

请求+应答

根据音乐风格获取音乐列表

open_api/2/kaleidoscope/job/music_get_by_style/submit/

全部

全部

请求+应答

TopView方式的视频智能裁剪

open_api/2/kaleidoscope/job/zoom_video_retargeting_top_view/submit/

全部

全部

请求+应答

视频智能裁剪

open_api/2/kaleidoscope/job/magic_video_retargeting/submit/

全部

全部

请求+应答

视频边框裁剪

open_api/2/kaleidoscope/job/video_edge_cut/submit/

全部

全部

请求+应答

  1. 账号管理及广告创意部分接口下线

类别

接口名称

接口地址

字段

字段类型

参数类型

增加逻辑

账号管理

查询广告主列表

open_api/2/majordomo/advertiser/select/

全部

全部

请求+应答

将于2021/08/03接口下线,接口需要迁移到open_api/2/customer_center/advertiser/list/

创编

创意素材信息

open_api/2/creative/material/read/

全部

全部

请求+应答

将于2021/08/03接口下线

请您及时关注开放平台更新日志及相关通知,并尽快安排对接,避免后续接口调整对您的广告投放产生影响。如您仍然存在疑惑或有相关建议,可在开放平台提交工单联系我们。

麻烦再次辛苦您提前关注更新内容,及时评估对您现有使用的影响以及改动。


2021年06月25日

尊敬的开发者:

        本次更新极其重要,为了提供更好的服务,主要围绕营销链路进行了更新,麻烦辛苦您提前关注更新内容,及时评估对您现有使用的影响以及改动。

【涉及接口】

  1. 营销链路

一级分类

二级分类

接口名称

接口请求地址

附加信息

创编

广告组

创建广告组

open_api/2/campaign/create/

字段更新

查询广告组

open_api/2/campaign/get/

字段更新

广告计划

创建广告计划

open_api/2/ad/create/

字段更新

查询广告计划

open_api/2/ad/get/

字段更新

修改广告计划

open_api/2/ad/update/

字段更新

广告创意

创建程序化创意

open_api/2/creative/procedural_creative/create/

2021/06/04 新增接口,创建新营销链路下程序化创意

创建自定义创意

open_api/2/creative/custom_creative/create/

2021/06/04,创建新营销链路下自定义创意

查询创意列表

open_api/2/creative/get/


查询创意详情

open_api/2/creative/read_v2/


修改程序化创意

open_api/2/creative/procedural_creative/update/

2021/06/04 新增接口,修改新营销链路下程序化创意

修改自定义创意

open_api/2/creative/custom_creative/update/

2021/06/04 新增接口,修改新营销链路下自定义创意

工具

转化跟踪

获取优化目标

open_api/2/tools/ad_convert/optimized_target/get/

新增接口,查询新营销链路下可用优化目标

查询

授权直播达人

open_api/2/tools/live_authorize/list/

新增接口,查询直播间推广下授权达人

【更新内容】

  1. 营销链路
  • 营销链路下,支持应用推广、销售线索收集、抖音号、直播间5个推广目的(已2021/06/24 上线);
  • 非营销链路下(现有老接口),支持商品推广、电商店铺、门店(将于近期下线);
  • 2021/7/6 后,新版计划和创意的创建操作必须通过新的创建编辑流程完成,旧的计划和创意通过原有创建编辑流程完成,新流程无法操作旧版广告组/计划/创意;旧流程无法操作新版计划/创意;
  • 后续功能将基于新的营销链路下做变更(新流程),即需要接入新的创意接口跑通新链路,现有旧的推广目的下旧的广告组->广告计划->广告创意将不再做功能迭代和更新。

类别

接口名称

接口地址

字段

字段类型

参数类型

增加逻辑

工具

获取优化目标

open_api/2/tools/ad_convert/optimized_target/get/

全部

全部

请求+应答参数

新增接口查询新营销链路下可用优化目标

授权直播达人

open_api/2/tools/live_authorize/list/

全部

全部

请求+应答参数

新增接口查询直播间推广下授权达人

已更新内容查看【2021年6月4日 更新日志】

麻烦再次辛苦您提前关注更新内容,及时评估对您现有使用的影响以及改动。


2021年06月24日

尊敬的开发者:

为了提供更好的服务,本次更新内容较多,主要围绕巨量星图、直播间数据、共享钱包、订阅服务相关,麻烦辛苦您提前关注更新内容,及时评估对您现有使用的影响以及改动


【涉及接口】

1.巨量星图

一级分类

二级分类

接口名称

接口请求地址

附加信息

账号服务

代理商账号管理

代理商管理账户列表

/open_api/2/agent/advertiser/select/

2021/06/23已变动:支持星图代理商类型的账号授权,并获取代理商账号下的星图账号列表

巨量星图

-

获取星图订单投后线索

/open_api/2/star/clue/get/

2021/06/23新增接口:获取达人接单视频中所收集的线索列表

-

获取星图客户任务订单列表

open_api/2/star/demand/order/list/

2021/06/23新增字段

2.工具-数据报表

一级分类

二级分类

接口名称

接口请求地址

附加信息

数据报表

直播分析数据报表

直播间分析报表

/open_api/2/report/live_room/analysis/get/

2021/06/23新增字段

3.账号-资金和流水

一级分类

二级分类

接口名称

接口请求地址

附加信息

账号服务

资金和流水管理

查询账号日流水

/open_api/2/advertiser/fund/daily_stat/

2021/06/23新增字段:增加字段披露共享钱包支出

获取共享钱包余额

/open_api/2/fund/shared_wallet_balance/get/

2021/06/23新增接口:用于披露共享钱包余额信息

【更新内容】

1.巨量星图支持「获取星图订单投后线索」 2021/06/24 已更新,面向巨量星图品牌主客户,新增开放「获取星图订单投后线索」接口,并支持星图代理商类型的账号授权。若星图客户所发布的抖音传播任务,为线索收集类任务,则星图客户或代理商,可通过此接口,获取达人接单视频中所收集的线索列表。

类别

接口名称

接口地址

字段

字段类型

参数类型

增加逻辑

账号服务

代理商管理账户列表

open_api/2/agent/advertiser/select/

代理商管理账户列表




新增功能:支持星图代理商类型的账号授权,并获取代理商账号下的星图账号列表

巨量星图


open_api/2/star/clue/get/

全部

全部

请求+应答

新增接口


open_api/2/star/demand/order/list/

item_id

number

应答

新增字段

2.「直播间分析报表」指标更新 2021/06/24 已更新,面向在直播间挂载小风车组件,提供团购、预约、应用下载等服务的广告主,可以通过【数据报表-直播分析数据报表-直播间分析报表】接口,获取小风车组件展点数据、团购订单、线索提交、应用下载等深度转化数据,通过数据分析,更精确地找到变现过程中的阻碍,有效地对这些卡点进行治理和调整,完善变现路径。

类别

接口名称

接口地址

字段

字段类型

参数类型

增加逻辑

工具-数据报表

直播间分析报表

/open_api/2/report/live_room/analysis/get/

live_card_icon_component_show_count

number

应答参数

新增字段

live_card_icon_component_click_count

number

应答参数

新增字段

live_component_ctr

float

应答参数

新增字段

live_app_download_start_count

number

应答参数

新增字段

live_app_download_finish_count

number

应答参数

新增字段

live_app_install_finish_count

number

应答参数

新增字段

live_app_active_count

number

应答参数

新增字段

live_app_active_register_count

number

应答参数

新增字段

live_app_game_pay_count

number

应答参数

新增字段

live_app_active_pay_count

number

应答参数

新增字段

live_app_attribution_next_day_open_count

number

应答参数

新增字段

live_app_attribution_next_day_open_rate

float

应答参数

新增字段

live_groupbuy_order_count

number

应答参数

新增字段

stat_live_groupbuy_order_gmv

float

应答参数

新增字段

live_form_submit_count

number

应答参数

新增字段

3.共享钱包

单一客户下返货共享,新增共享钱包概念,账号日流水将披露共享钱包支出,以及增加获取共享钱包余额相关能力

类别

接口名称

接口地址

字段

字段类型

参数类型

增加逻辑

账号服务

查询账号日流水

open_api/2/advertiser/fund/daily_stat/

shared_wallet_cost

float

应答参数

新增字段

default_grant

float

应答参数

新增字段

common_grant

float

应答参数

新增字段

search_grant

float

应答参数

新增字段

union_grant

float

应答参数

新增字段

获取共享钱包余额

open_api/2/fund/shared_wallet_balance/get/

全部

全部

请求+应答参数

新增接口

4.订阅服务 上线广告主报表稳定性消息、广告计划实时数据两项订阅能力,可以分别获取: 广告主相关数据生产完成并进入稳定状态,数据稳定消息; 广告计划在时间窗口内指标变动,实时计划报表数据。

订阅更多内容请查看【SPI推送】相关


麻烦再次辛苦您提前关注更新内容,及时评估对您现有使用的影响以及改动。


2021年06月22日

尊敬的开发者:

您好,巨量引擎开放平台本期更新内容如下:

【更新内容】

(一)电商广告(原巨量鲁班)账户接口使用功能调整

巨量引擎开放平台预计于7月1日正式更新「评论管理」接口,电商广告(原巨量鲁班)账户将涉及以下调整:

  1. 暂停现有【评论管理】接口中关于评论、评论回复、屏蔽词、屏蔽用户等编辑操作。如需进行评论管理,后续请通过巨量千川广告平台进行投放。
  2. 现有【评论管理】接口中关于评论、评论回复、屏蔽词、屏蔽用户等读取操作将可继续正常获取。

【涉及接口】

一级分类

二级分类

接口名称

接口请求地址

更新内容

工具

评论管理

评论操作

/open_api/2/tools/comment/operate/

新增校验:暂停电商广告(原巨量鲁班)账户操作使用相关接口,如需进行评论管理,后续请通过巨量千川广告平台进行投放。

添加屏蔽词

/open_api/2/tools/comment/terms_banned/add/

删除屏蔽词

/open_api/2/tools/comment/terms_banned/delete/

更新屏蔽词

/open_api/2/tools/comment/terms_banned/update/

添加屏蔽用户

/open_api/2/tools/aweme_banned/create/

删除屏蔽用户

/open_api/2/tools/aweme_banned/delete/

接口字段下线时将发送正式通知,请您及时关注开放平台更新日志及相关通知,并尽快安排对接,避免后续接口调整对您的广告投放产生影响。如您仍然存在疑惑或有相关建议,可在开放平台提交工单联系我们。

2021年06月18日

尊敬的开发者:

本次针对创编中【所有广告】计划中搜索快投关键词功能进行更新通知。

【涉及接口】

一级分类

二级分类

接口名称

接口请求地址

附加信息

创编

广告计划

创建广告计划

open_api/2/ad/create/

于2021/6/17全量更新:

(1)普通广告计划搜索快投关键词,默认开启,关闭诉求需要传入关闭枚举;

(2)通投智选计划搜索快投关键词功能不受feed_delivery_search影响,默认开启,不可关闭;

修改广告计划

open_api/2/ad/update/

【更新内容】

(1)已经于2021/6/17更新,关于搜索快投关键词功能,变动内容如下

涉及API

类别

字段

字段类型

参数类型

增加逻辑

open_api/2/ad/create/ 创建广告计划

open_api/2/ad/update/ 修改广告计划

创编-广告计划

feed_delivery_search

string

请求参数

非通投计划搜索快投关键词功能默认开启,关闭需要传入DISABL

通投智选计划,搜索快投功能不依赖本字段,默认开启,不可关闭

麻烦再次辛苦您提前关注更新内容,及时评估对您现有使用的影响以及改动。


2021年06月17日

尊敬的开发者:

为向您提供全方位的电商营销一体化服务,巨量引擎开放平台计划对「商品推广(非DPA)」相关接口进行调整。

【涉及接口】

广告组

open_api/2/campaign/create/

open_api/2/campaign/update/

open_api/2/campaign/update/status/

广告计划

open_api/2/ad/create/

open_api/2/ad/update/

open_api/2/ad/update/status/

open_api/2/ad/update/budget/

open_api/2/ad/update/bid/

广告创意

open_api/2/creative/create_v2/

open_api/2/creative/update_v2/

open_api/2/creative/update/status/

投放管家

open_api/2/adlab/group/create/

open_api/2/adlab/group_creative/update/

open_api/2/adlab/group_budget/update/

open_api/2/adlab/group_status/update/

open_api/2/adlab/ad_status/update/

其他相关

open_api/2/tools/ad_convert/query/

【更新内容】

尊敬的开发者,您好!

为向您提供全方位的电商营销一体化服务,巨量引擎开放平台计划对【商品推广】(非DPA)相关接口进行调整。

巨量引擎开放平台预计于7月1日正式更新【商品推广】(非DPA)相关的接口,电商广告(原巨量鲁班)账户将涉及以下调整:

  1. 暂停现有接口中关于【商品推广】(非DPA)的广告组/计划/创意的新建操作。届时,除投放中的广告组/计划/创意可操作暂停外,原有广告组/计划/创意下的新建、复制、编辑操作均不可用。如需投放,请至巨量千川开放能力查询相关接口。
  2. 暂停投放管家接口下关于【商品推广】(非DPA)的广告项目的新建操作。届时,除投放中的广告项目/计划可操作查询/暂停外,原有广告项目下的新建、编辑操作不可用,原有计划下的编辑操作不可用。

接口字段下线时将发送正式通知,请您及时关注开放平台更新日志及相关通知,并尽快安排对接,避免后续接口调整对您的广告投放产生影响。

如您仍然存在疑惑或有相关建议,可在开放平台提交工单联系我们。


2021年06月11日

尊敬的开发者:

为了配合业务改造,在平台能力部分,平台工具中可视化调试工具会进行下线变动,在api能力方面针对创编流程中广告组、计划和工具中获取绑定抖音号,涉及部分字段进行变动,,辛苦您提前关注更新内容,及时评估对您现有使用的影响。

【涉及接口】

一级分类

二级分类

接口名称

接口请求地址

附加信息

创编

广告组

修改广告组

open_api/2/campaign/update/

2021/07/13 下线部分字段下线

查询广告组

open_api/2/campaign/get/

2021/07/13 下线部分字段下线

工具

查询

获取绑定的抖音号

open_api/2/tools/ies_account_search/

2021/07/13 下线部分字段下线

【更新内容】

  1. 开放平台将下线【工具辅助】-【可视化调试工具】将于2021/06/22 下线,届时该功能入口将停止访问;
  2. 获取广告组数据以及获取抖音号数据中部分字段将于2021/07/13 下线

涉及API

类别

字段

字段类型

参数类型

增加逻辑

open_api/2/campaign/update/

修改广告组

创编-广告组

modify_time


string

请求参数

字段下线

open_api/2/campaign/get/查询广告组

fields


string[]

请求参数

fields中

modify_time、retargeting_type、cpa_skip_first_phrase允许值下线

modify_time


string

应答参数

字段下线

open_api/2/tools/ies_account_search/

工具-获取绑定的抖音号

ies_id


int

应答参数

字段下线

ies_user_name


string

应答参数

字段下线

left_days


number

应答参数

字段下线

shared_advertiser_name


string

应答参数

字段下线

commerce_user_level


string

应答参数

字段下线

shared_advertisers

shared_advertiser_id

number

应答参数

字段下线

shared_advertiser_name

string

应答参数

字段下线

麻烦再次辛苦您提前关注更新内容,及时评估对您现有使用的影响以及改动。


2021年06月04日

尊敬的开发者:

为了提供更好的服务,主要针对新营销链路以及互动广告相关功能做了更新变动,本次更新内容极其重要,辛苦您提前关注更新内容,及时评估对您现有使用的影响。

【涉及接口】

因变动内容较多,涉及接口列表未全部列出,实际变动以开发文档为准

一级分类

二级分类

接口名称

接口请求地址

附加信息

创编

广告组

创建广告组

open_api/2/campaign/create/

字段更新

查询广告组

open_api/2/campaign/get/

字段更新

广告计划

创建广告计划

open_api/2/ad/create/

字段更新

查询广告计划

open_api/2/ad/get/

字段更新

修改广告计划

open_api/2/ad/update/

字段更新

广告创意

创建程序化创意

open_api/2/creative/procedural_creative/create/

新增接口,创建新营销链路下程序化创意

创建自定义创意

open_api/2/creative/custom_creative/create/

新增接口,创建新营销链路下自定义创意

查询创意列表

open_api/2/creative/get/


查询创意详情

open_api/2/creative/read_v2/


修改程序化创意

open_api/2/creative/procedural_creative/update/

新增接口,修改新营销链路下程序化创意

修改自定义创意

open_api/2/creative/custom_creative/update/

新增接口,修改新营销链路下自定义创意

【更新内容】

营销链路相关

1、新营销链路下,快应用推广目的已经于2021/6/4进行上线,可以通过开放平台接入相关接口进行使用

2、新营销链路下,应用推广、销售线索收集、抖音号、直播间 将于近期上线

3、新营销链路下

    • 计划维度有较大规模字段逻辑变动(新增&删除)
    • 创意维度新增接口,需要接入新的创意维度接口,才可以创建新的营销目的下 广告组->广告计划->广告创意全流程
    • 计划&创意维度有不少字段位置发生变更,需要关注

4、新营销链路下,广告组,广告计划,广告创意改动内容(极其重要

    • 进行新/旧版组、计划、创意标记,组和计划通过字段标示新/旧(提供新字段),创意通过接口标示(提供新接口)
    • 创建新创意必须通过新的创建和编辑接口进行
    • 新版广告组下,仅允许创建新版计划(已生效),新版广告计划下,将于2021/7/6 不再允许创建旧版创意
    • 旧版广告组下,仅允许创建旧版计划(已生效),旧版广告计划下,仅允许创建旧版创意(已生效)
    • 新计划只能通过新的编辑规则(传参)进行编辑;新创意只能通过新的编辑规则(新接口传参)进行编辑,将于2021/7/6 生效
    • 2021/7/6 后,新版计划和创意的创建操作必须通过新的创建编辑流程完成,旧的计划和创意通过原有创建编辑流程完成,新流程无法操作旧版广告组/计划/创意;旧流程无法操作新版计划/创意

5、后续功能将基于新的营销链路下做变更(新流程),即需要接入新的创意接口跑通新链路,现有旧的推广目的下旧的广告组->广告计划->广告创意将不再做功能迭代和更新


用户定向

1、在计划层面用户定向相关,已经于2021/6/4进行上线,定向相关缺失字段,缺失枚举进行了补充和同步,主要是抖音达人行为、粉丝互动行为时间、过滤时间、职业状态等


互动广告相关

1、主要提供了关于基于rubeex(https://rubeex.oceanengine.com)互动广告能力,目前支持获取广告主下互动广告作品相关信息以及获取互动广告数据。


本次更新极其重要,麻烦再次辛苦您提前关注更新内容,及时评估对您现有使用的影响以及改动。


2021年06月01日

尊敬的开发者:

为了提供更好的服务,对电商营销一体化服务以及账号管理相关进行了变动,辛苦您提前关注更新内容,及时评估对您现有使用的影响。

【涉及接口】

账号管理

open_api/2/advertiser/fund/daily_stat/ 查询账号日流水(将于2021/06/24 变更,部分字段进行下线

广告组

open_api/2/campaign/create/

open_api/2/campaign/update/

open_api/2/campaign/update/status/

广告计划

open_api/2/ad/create/

open_api/2/ad/update/

open_api/2/ad/update/status/

open_api/2/ad/update/budget/

open_api/2/ad/update/bid/

广告创意

open_api/2/creative/create_v2/

open_api/2/creative/update_v2/

open_api/2/creative/update/status/

其他相关

open_api/2/tools/ad_convert/query/

【更新内容】

1、巨量引擎开放平台于2021/06/01日起,根据您所授权的广告账户类别有以下调整:

  • 电商广告(原巨量鲁班)账户:暂停现有接口中关于「抖音号推广」的计划和创意新建操作,仅允许新接口下的「抖音号推广」计划/创意新建。届时,除历史计划可操作暂停外,原有接口下的新建、复制、编辑操作均不可用
  • 非电商广告(非原巨量鲁班)账户:暂停「直播间商品按钮点击」、「直播间成单」、「商品购买」三种优化目标下的新建计划和创意操作。同时,使用以上三个优化目标的历史计划仅可暂停,新建、复制、编辑等其他操作均不可执行

2、将于2021/06/24 变更,查询账号日流水接口中,部分字段进行下线

涉及API

类别

字段

字段类型

参数类型

增加逻辑

open_api/2/advertiser/fund/daily_stat/

资金流水

return_goods_cost

number

应答参数

字段下线

请您及时关注开放平台更新日志及相关通知,并尽快安排对接,避免后续接口调整对您的广告投放产生影响。

如您仍然存在疑惑或有相关建议,可在开放平台提交工单联系我们。


2021年05月31日

尊敬的开发者:

您好,因系统维护原因,6/3 0:00~6/5 24:00期间「修改广告主头像」功能将暂停使用。届时将无法修改广告主头像,给您带来的不便,敬请谅解!


2021年05月25日

尊敬的开发者:

您好,为了配合业务改造并且提供更好的服务,近期针对创编、用户定向、青鸟线索通等部分进行变动,辛苦您提前关注更新内容,及时评估对您现有使用的影响。

【涉及接口】

创编

open_api/2/ad/get 查询广告计划(将于2021/06/03变更,字段下线)

open_api/2/ad/update/ 修改广告计划(已变更,字段下线)

open_api/2/creative/status/update_v2/ (已变更,新增接口)

open_api/2/creative/update/status/ (将于2021/6/22 变更,老旧接口下线)

DMP

open_api/2/dmp/custom_audience/rule/ 规则人群包(2021/05/25已变更,接口下线)

飞鱼线索管理

open_api/2/tools/clue/get/ (2021/05/25已变更)

工具-诊断

open_api/2/tools/diagnosis/ad/get/ 获取计划诊断详情 (2021/05/25已变更,接口下线)

open_api/2/tools/diagnosis/ad/curve/获取计划诊断预估变化趋势(2021/05/25已变更,接口下线)

数据报表

open_api/2/report/audience/tag/

【更新内容】

(1)将于2021/06/03变更,查询和修改广告计划接口中,涉及字段以及允许值变化,如下

涉及API

类别

字段

字段类型

参数类型

增加逻辑

open_api/2/ad/get/

广告投放

fields

string[]

请求参数

字段中枚举下线
modify_time、
audit_reject_reason

modify_time

string

应答参数

字段下线

audit_reject_reason

string

应答参数

字段下线

(2)已变更,更新计划中部分字段已废弃,将于2021/06/03进行字段下线

涉及API

类别

字段

字段类型

参数类型

增加逻辑

open_api/2/ad/update/

广告投放

modify_time

string

请求参数

字段下线

(3)提供新的更新创意状态接口(已上线),老旧接口将于2021/06/22进行下线

涉及API

类别

字段

字段类型

参数类型

增加逻辑

open_api/2/creative/status/update_v2/

广告投放

全部

全部

请求+应答参数

新接口上线

open_api/2/creative/update/status/

全部

全部

请求+应答参数

接口下线

(4)已经于2021/5/25 更新,规则人群包接口下线,如下(预通知见5月12日更新日志)

涉及API

类别

字段

字段类型

参数类型

增加逻辑

/open_api/2/dmp/custom_audience/rule/

DMP人群管理

全部

全部

请求+应答参数

接口下线

(5)已经于2021/05/25变更,获取飞鱼线索部分,如下(预通知见04月30日更新日志)

涉及API

类别

字段

字段类型

参数类型

增加逻辑

open_api/2/tools/diagnosis/ad/get/

工具-诊断

全部

全部

请求+应答参数

接口下线

open_api/2/tools/diagnosis/ad/curve/

全部

全部

请求+应答参数

接口下线

(6)已经于2021/5/25 更新,诊断工具老接口下线,如下(预通知见03月05日更新日志)

涉及API

类别

字段

字段类型

参数类型

增加逻辑

open_api/2/tools/diagnosis/ad/get/

工具-诊断

全部

全部

请求+应答参数

接口下线

open_api/2/tools/diagnosis/ad/curve/

全部

全部

请求+应答参数

接口下线

(7)将于2021/6/22 更新,受众分析数据数据报表中-兴趣数据接口将下线

涉及API

类别

字段

字段类型

参数类型

增加逻辑

open_api/2/report/audience/tag/

报表-受众分析

全部

全部

请求+应答参数

接口下线

为了降低对您现有使用的影响,再次提示请您关注更新内容!


2021年05月14日

尊敬的开发者:

您好,巨量千川电商广告开放能力已经全面上线,本次上线共涉及巨量千川投放场景下的账户管理,投放管理,数据报表等共36个API接口,全方位满足巨量千川场景下的自动化投放管理诉求。

调用巨量千川开放能力,需要申请新的巨量千川投放场景App_id来调用相关接口,每位开发者将额外拥有10个巨量千川App_id申请额度,请您按需申请。

点击查看巨量千川文档

2021年05月12日

尊敬的开发者:

您好,为了配合业务改造并且提供更好的服务,近期针对DMP人群管理部分进行变动,辛苦您提前关注更新内容,及时评估对您现有使用的影响。

【涉及接口】

open_api/2/dmp/custom_audience/rule/ 规则人群包(将于2021/5/20 下线

【更新内容】

(1)将于 2021/5/20 变更,规则人群包接口将下线,如下

涉及API

类别

字段

字段类型

参数类型

增加逻辑

/open_api/2/dmp/custom_audience/rule/

DMP人群管理

全部

全部

请求+应答参数

接口下线

2021年05月11日

尊敬的开发者:

您好,为了配合业务改造并且提供更好的服务,近期针对代理商创建广告主部分进行变动,辛苦您提前关注更新内容,及时评估对您现有使用的影响。

【涉及接口】

账号管理

/open_api/2/agent/advertiser/create_v2/ (将于2021/05/13变更,字段下线)

广告投放

/open_api/2/creative/create_v2/ (2021/4/28已上线番茄广告位)

数据报表

/open_api/2/report/campaign/get/ (广告组数据,2021/4/28已增加番茄小说的报表数据)

/open_api/2/report/ad/get/ (广告计划数据,2021/4/28已增加番茄小说的报表数据)

/open_api/2/report/creative/get/ (广告创意数据,2021/4/28已增加番茄小说的报表数据)

/open_api/2/report/integrated/get(多合一报表数据,2021/4/28已增加番茄小说的报表数据)

/open_api/2/async_task/create/(创建异步任务,2021/4/28已增加番茄小说的报表数据过滤)

/open_api/2/async_task/download/(多合一报表数据,2021/4/28已增加番茄小说的报表数据)

【更新内容】

(1)将于2021/05/13变更,代理商创建广告主部分,涉及字段以及允许值变化,如下

涉及API

类别

字段

字段类型

参数类型

增加逻辑

/open_api/2/agent/advertiser/create_v2/

代理商账户管理

account_source

string

请求参数

下线 枚举值"TEMAI"

(2) 已经于2021/4/28 更新,上线番茄小说广告位相关能力,涉及字段以及允许值变化,如下

涉及API

类别

字段

字段类型

参数类型

增加逻辑

/open_api/2/creative/create_v2/

广告投放

inventory_type



string[]

请求参数

新增INVENTORY_TOMATO_NOVEL, 对应番茄小说

open_api/2/report/campaign/get/

数据报表

data



json

应答参数


list


list

应答参数


inventory

string

应答参数

首选投放广告位,增加番茄 INVENTORY_TOMATO_NOVEL数据返回

/open_api/2/report/ad/get/

data



json

应答参数


list


list

应答参数


inventory

string

应答参数

首选投放广告位,增加番茄 INVENTORY_TOMATO_NOVEL数据返回首选投放广告位

/open_api/2/report/creative/get/

filtering



object

请求参数


inventory_type


string[]

请求参数

新增INVENTORY_TOMATO_NOVEL, 对应番茄小说

/open_api/2/report/integrated/get

filtering



object

请求参数


inventory_type


string[]

请求参数

新增INVENTORY_TOMATO_NOVEL, 对应番茄小说

/open_api/2/async_task/create/






新增番茄小说相关数据

/open_api/2/async_task/download/






新增番茄小说相关数据

为了降低对您现有使用的影响,再次提示请您关注更新内容!

2021年04月30日

尊敬的开发者:

您好,为了配合业务改造并且提供更好的服务,近期针对获取飞鱼线索部分进行变动,辛苦您提前关注更新内容,及时评估对您现有使用的影响。

【涉及接口】

open_api/2/tools/clue/get/ (将于2021/05/25变更)

【更新内容】

(1)将于2021/05/25变更,涉及字段以及允许值变化,如下

涉及API

类别

字段

字段类型

参数类型

增加逻辑

open_api/2/tools/clue/get/

线索管理

start_time

string

请求参数

查询起始时间,从天维度变为支持到 秒维度

end_time

string

请求参数

查询截止时间,从天维度变为支持到 秒维度

clue_state

number

应答参数

字段变更

变更前,枚举值及对应文本

0:待分配、1:已分配未标记、2:待回访、3:已转换、4:无效-无意向、5:无效-非本人、6:无效-联系不上

变更后,枚举值及对应文本

1:未联系、2:待回访、3:转商机、4:无效

allocation_status

number

应答参数

字段新增,增加线索分配状态

0:待分配/1:已分配

为了降低对您现有使用的影响,再次提示请您关注更新内容!


2021年04月23日

尊敬的开发者:

您好,请您关注开发者健康度:

为了保障安全稳定高效营销,共同建设健康有序的开放生态,巨量引擎开放平台拟与开发者携手共建健康度机制。我们将每一位开发者在平台的核心行为与关键数据指标,进行了识别计算,形成了由多维度构成的健康度分值。

健康度分值反映开发者在活跃度、消耗贡献、效能效率、活动奖励、信息合规五个维度的行为与数据表现,每周三更新,分值越高,所匹配的权益与权限越高。

开发者可在巨量引擎开放平台官网-管理中心-健康度管理中,查询自身分值与提升建议。

期待和大家建设一个越来越健康、高效的开放平台!


2021年04月20日

尊敬的开发者:

为向您提供全方位的电商营销一体化服务,巨量引擎开放平台计划对「抖音号推广」相关接口进行调整。

【涉及接口】

广告组

open_api/2/campaign/create/

open_api/2/campaign/update/

open_api/2/campaign/update/status/

广告计划

open_api/2/ad/create/

open_api/2/ad/update/

open_api/2/ad/update/status/

open_api/2/ad/update/budget/

open_api/2/ad/update/bid/

广告创意

open_api/2/creative/create_v2/

open_api/2/creative/update_v2/

open_api/2/creative/update/status/

其他相关

open_api/2/tools/ad_convert/query/

【更新内容】

巨量引擎开放平台预计于5月10日正式上线「抖音号推广」相关的新接口,并预计于6月1日起,根据您所授权的广告账户类别有以下调整:

  1. 电商广告(原巨量鲁班)账户:暂停现有接口中关于「抖音号推广」的计划和创意新建操作,仅允许新接口下的「抖音号推广」计划/创意新建。届时,除历史计划可操作暂停外,原有接口下的新建、复制、编辑操作均不可用。
  2. 非电商广告(非原巨量鲁班)账户:暂停「直播间商品按钮点击」、「直播间成单」、「商品购买」三种优化目标下的新建计划和创意操作。同时,使用以上三个优化目标的历史计划仅可暂停,新建、复制、编辑等其他操作均不可执行。

接口正式上线、字段下线时将发送正式通知,请您及时关注开放平台更新日志及相关通知,并在新接口正式上线后尽快安排对接,避免后续接口调整对您的广告投放产生影响。

如您仍然存在疑惑或有相关建议,可提交工单联系我们。


2021年04月16日

尊敬的开发者:

您好,为了配合业务改造并且提供更好的服务,近期针对计划保障状态以及一键起量能力优化,辛苦您提前关注更新内容,及时评估对您现有使用的影响。

【涉及接口】

广告投放

open_api/2/ad/cost_protect_status/get/ 批量获取计划成本保障状态(2021/04/15已变更,新增接口)

open_api/2/tools/ad_raise_result/get/ 获取一键起量的后验数据 (2021/05/18即将变更,接口下线

open_api/2/tools/ad_raise_version/get/获取一键起量版本信息(2021/04/15已变更,新增接口)

数据报表

open_api/2/report/advertiser/get/ 广告主数据(2021/05/18即将变更,旧版行为兴趣定向返回字段下线

open_api/2/report/campaign/get/ 广告组数据(2021/05/18即将变更,旧版行为兴趣定向返回字段下线

open_api/2/report/ad/get/ 广告计划数据(2021/05/18即将变更,旧版行为兴趣定向返回字段下线

open_api/2/report/creative/get/ 广告创意数据(2021/05/18即将变更,旧版行为兴趣定向返回字段下线

open_api/2/report/misty/get/ 分级模糊数据(2021/05/18即将变更,旧版行为兴趣定向返回字段下线

open_api/2/report/integrated/get/ 多合一数据报表(2021/05/18即将变更,旧版行为兴趣定向返回字段下线

open_api/2/campaign/update/status/ 广告组更新状态 (2021/04/15已变更,返回参数变更)

open_api/2/ad/update/status/ 更新计划状态(2021/04/15已变更,返回参数变更)

open_api/2/ad/update/budget/ 更新计划预算(2021/04/15已变更,返回参数变更)

open_api/2/ad/update/bid/ 更新几乎出价(2021/04/15已变更,返回参数变更)

工具

open_api/2/tools/ad_raise_result/get/ 获取一键起量的后验数据(2021/05/18即将变更,接口下线

open_api/2/tools/ad_raise_result/get_v2/ 获取一键起量后验报告(2021/04/15已变更,新增接口)

open_api/2/tools/ad_raise/set/ 设置一键起量(2021/04/15已变更,字段下线

【更新内容】

(1)2021/04/15已变更,新增获取成本保障状态接口

涉及API

类别

字段

字段类型

参数类型

增加逻辑

open_api/2/ad/cost_protect_status/get/

广告投放

全部

全部

请求+应答参数

新增接口

(2)2021/04/15已变更,新增获取一键起量后验报告以及获取一键起量版本号接口;原获取起量后验数据接口将在2021/05/18下线

涉及API

类别

字段

字段类型

参数类型

增加逻辑

open_api/2/tools/ad_raise/set/

工具-一键起量

budget_value

number

请求参数

下线字段

请使用modify_value

opt_type

string

请求参数

字段枚举值,新增

STOP_RAISE,关停一键起量

open_api/2/tools/ad_raise_result/get_v2/

全部

全部

请求+应答参数

新增接口

open_api/2/tools/ad_raise_result/get/

全部

全部

请求+应答参数

下线接口

open_api/2/tools/ad_raise_version/get/

全部

全部

请求+应答参数

新增接口

(3)2021/04/15已变更,部分接口返回参数变更

涉及API

类别

字段

字段类型

参数类型

增加逻辑

open_api/2/campaign/update/status/

广告投放

errors


object[]

应答参数

增加失败信息字段


campaign_id

number

应答参数

增加失败信息字段


error_message

string

应答参数

增加失败信息字段

open_api/2/ad/update/status/

errors


object[]

应答参数

增加失败信息字段


ad_id

number

应答参数

增加失败信息字段


error_message

string

应答参数

增加失败信息字段

open_api/2/ad/update/budget/

errors


object[]

应答参数

增加失败信息字段



ad_id

number

应答参数

增加失败信息字段



error_message

string

应答参数

增加失败信息字段

open_api/2/ad/update/bid/

errors


object[]

应答参数

增加失败信息字段


ad_id

number

应答参数

增加失败信息字段


error_message

string

应答参数

增加失败信息字段








(4)数据报表行为兴趣定向(旧版)字段下线

涉及API

类别

字段

字段类型

参数类型

增加逻辑

open_api/2/report/advertiser/get/

数据报表

ad_tag

string

应答参数

字段下线

open_api/2/report/campaign/get/

ad_tag

string

应答参数

字段下线

open_api/2/report/ad/get/

ad_tag

string

应答参数

字段下线

open_api/2/report/creative/get/

ad_tag

string

应答参数

字段下线

open_api/2/report/misty/get/

ad_tag

string

应答参数

字段下线

interest_tag

string

应答参数

字段下线

open_api/2/report/integrated/get/

ad_tag

string

应答参数

字段下线

interest_tag

string

应答参数

字段下线


为了降低对您现有使用的影响,再次提示请您关注更新内容!


2021年04月08日

尊敬的开发者:

您好,为了配合业务改造并且提供更好的服务,近期针对广告投放流程中,

计划维度用户定向部分,进行部分规则变动,增加下列情况报错提示,新增规则会在4.15-4.30进行添加,建议在4.15号完成计划检查以及传参规则的限制,另外也会对部分接口以及接口中字段在5.6进行下线,在如果未能按时完成这部分改造,可能会对您的计划投放造成影响,出现大量的报错信息,影响广告投放的效果

【涉及接口】

用户定向规则变更:

open_api/2/ad/create 创建广告计划(2021/04/15 即将变更,用户定向规则校验变更)

open_api/2/ad/update/ 修改广告计划(2021/04/15 即将变更,用户定向规则校验变更)

接口下线:

账号服务

/advertiser/qualification/create/ 新增投放资质(2021/05/06 即将变更,接口下线)

广告投放

/creative/material/read/ 创意素材信息(2021/05/06 即将变更,接口下线)

工具

/tools/clue/form/detail/ 查询表单详情(2021/05/06 即将变更,接口下线)

/tools/clue/smart_phone/get/ 查询智能电话(2021/05/06 即将变更,接口下线)

/tools/interest_tags/select/ 获取兴趣关键词词包(2021/05/06 即将变更,接口下线)

/tools/interest_tags/word2id/ 兴趣关键词词转id(2021/05/06 即将变更,接口下线)

/tools/interest_tags/create/ 创建兴趣词包(2021/05/06 即将变更,接口下线)

/tools/interest_tags/delete/ 删除兴趣词包(2021/05/06 即将变更,接口下线)

/tools/interest_tags/id2word/ 兴趣关键词id转词(2021/05/06 即将变更,接口下线)

/tools/interest_tags/update/ 更新兴趣词包(2021/05/06 即将变更,接口下线)

字段下线:

tools/comment/get (2021/05/06 即将变更,部分字段下线)

tools/comment_reply/get/(2021/05/06 即将变更,部分字段下线)

【更新内容】

(1)2021/04/15 即将变更,用户定向规则校验变更

规则限定维度

限定项

新增限定内容

优先投放范围

优先投放范围选择穿山甲

  1. 不支持已转化过滤时间定向
  2. 不支持新用户首次激活时间定向
  3. 不支持网络运营商定向
  4. 不支持文章分类定向
  5. 不支持抖音达人定向包括以下三个定向字段 不支持抖音达人分类 不支持粉丝互动行为 不支持抖音达人账号

优先投放范围选择默认

  1. 不支持媒体包定向选择游戏优质媒体定向

优先投放范围选择通投智选

  1. 不支持媒体包定向
  2. 不支持已转化过滤时间定向

转化目标

转化目标为点击量

  1. 不支持过滤已转化定向

转化目标为展示量

  1. 不支持过滤已转化定向


涉及API

类别

字段

字段类型

参数类型

增加逻辑

open_api/2/ad/create

创建计划

open_api/2/ad/update/

修改计划

广告投放-用户定向

converted_time_duration

string

传入参数

过滤时间范围

应用推广且投放范围为穿山甲/穿山甲时

销售线索收集且投放范围为穿山甲时

商品推广且投放范围为通投智选时

以上均不支持已转化过滤时间定向选择

hide_if_converted

string

传入参数

转化目标为点击量或展示量时,

以上均不支持过滤已转化定向

android_osv

string

传入参数

下载方式为落地页时,

以上均不支持安卓版本定向选择

superior_popularity_type

string

传入参数

选择应用推广且投放范围为默认时,媒体包定向选择游戏优质媒体GAME

通投智选,不支持媒体包定向

flow_package

number[]

传入参数

通投智选,不支持媒体包定向

exclude_flow_package

number[]

传入参数

通投智选,不支持媒体包定向

carrier

string

传入参数

销售线索收集且投放范围为穿山甲时,

以上均不支持网络运营商定向选择移动MOBILE

ios_osv

string

传入参数

下载方式为落地页时,

以上均不支持iOS版本定向选择

activate_type

string[]

传入参数

销售线索收集且投放范围为穿山甲时, 不支持新用户首次激活时间定向选择一个月以内

应用推广且投放范围为穿山甲时, 不支持新用户首次激活时间定向选择一个月到三个月

(2)2021/05/06 即将变更,接口下线

涉及API

类别

字段

字段类型

参数类型

增加逻辑

/creative/material/read/

广告投放-创意素材信息

全部

全部

请求/应答

05/06接口下线

/advertiser/qualification/create/

账户资质-新增投放资质

全部

全部

请求/应答

05/06接口下线

/tools/clue/form/detail/

查询表单详情

全部

全部

请求/应答

05/06接口下线

/tools/clue/smart_phone/get/

查询智能电话

全部

全部

请求/应答

05/06接口下线

/tools/interest_tags/select/

获取兴趣关键词词包

全部

全部

请求/应答

05/06接口下线

/tools/interest_tags/word2id/

兴趣关键词词转id

全部

全部

请求/应答

05/06接口下线

/tools/interest_tags/create/

创建兴趣词包

全部

全部

请求/应答

05/06接口下线

/tools/interest_tags/delete/

删除兴趣词包

全部

全部

请求/应答

05/06接口下线

/tools/interest_tags/id2word/

兴趣关键词id转词

全部

全部

请求/应答

05/06接口下线

/tools/interest_tags/update/

更新兴趣词包

全部

全部

请求/应答

05/06接口下线

​​

(3)2021/05/06 即将变更,部分字段下线

涉及API

类别

字段

字段类型

参数类型

增加逻辑

tools/comment/get/

工具-评论管理

item_id

string

应答参数

字段下线

group_id

string

应答参数

字段下线

comment/operate/

item_id

string

应答参数

字段下线

group_id

string

应答参数

字段下线

tools/comment_reply/get/

item_id

string

应答参数

字段下线

group_id

string

应答参数

字段下线

为了降低对您现有使用的影响,再次提示请您关注更新内容!


2021年04月02日

尊敬的开发者:

您好,为了配合业务改造并且提供更好的服务,近期针对单商品广告能力进行了升级,并且对广告投放媒体和投放场景优化,辛苦您提前关注更新内容,及时评估对您现有使用的影响。

【涉及接口】

open_api/2/campaign/get 获取广告组 (2021/04/01已变更,增加广告组商品类型返回)

open_api/2/campaign/create 创建广告组(2021/04/01已变更,多个推广目的下支持单商品推广)

open_api/2/ad/get/ 获取广告计划(2021/04/01已变更,新增获取创建时添加的投放条件物件信息)

open_api/2/ad/create 创建广告计划(2021/04/01已变更,新增传入投放条件信息)

open_api/2/dpa/product/availables 获取商品库信息(2021/04/01已变更,新增返回商品库行业类型信息)

open_api/2/dpa/product/detail/get 获取商品详情(2021/04/01已变更,新增查询商品详情接口)

open_api/2/dpa/assets/list 获取投放条件列表(2021/04/01已变更,新增查询投放条件列表)

open_api/2/dpa/assets/detail/read 获取投放条件详情 (2021/04/01已变更,新增查询投放条件详情)


【更新内容】

(1)关于商品推广能力,2021/04/01已变更,支持多个推广目的

涉及API

类别

字段

字段类型

参数类型

增加逻辑

open_api/2/campaign/get/

广告投放

data



object


应答参数


增加应答参数delivery_related_num


list


object[]

delivery_related_num

string


open_api/2/campaign/create


delivery_related_num



string


请求参数


新增销售线索、APP应用、电商店铺推广目的下允许传入


open_api/2/ad/get/


data



object


应答参数


新增投放条件下物件信息返回


list


object[]

asset_id

number


open_api/2/ad/create

asset_id



number


请求参数


增加投放条件下,物件信息传入


open_api/2/dpa/product/availables


商品推广

product_industry



string


应答参数


product_industry新增商品库行业类型


open_api/2/dpa/product/detail/get

全部



全部


请求+应答


新增查询商品详情接口


open_api/2/dpa/assets/list

全部



全部


请求+应答


新查询投放条件列表


open_api/2/dpa/assets/detail/read

全部



全部


请求+应答


新增查询投放条件详情


(2)近期会对广告投放媒体和投放场景优化,如您已在巨量引擎广告平台或通过MAPI接口选择首选媒体或首选场景,您的广告将主要根据您选择的媒体或场景进行投放;同时为了向您提供更好的数据推广服务,巨量引擎可能对您的广告进行内容和格式上的优化并智能拓展投放到其他流量场景。

本次优化涉及广告投放模块相关接口的具体含义,如:delivery_range、inventory_type等,对接口调用无影响。若您有任何疑问,请使用广告主账号密码登陆巨量引擎广告平台查看详细信息。


为了降低对您现有使用的影响,再次提示请您关注更新内容!


2021年04月01日


尊敬的开发者:

您好,为了加强系统安全性和审核时效性,即日起,自助开户且暂无销售对接的客户,将无法使用巨量引擎开放平台(Marketing API)及其衍生产品的投放服务。

【涉及接口】

全部

【更新内容】

自助开户且暂无销售对接的客户下的广告账户,无法成功调用marketing api的的全部接口,对应错误码为61001


2021年03月29日

尊敬的开发者:

您好,为了对齐广告平台侧功能并且提供更好的功能,近期针对评论管理工具做了优化

【涉及接口】

open_api/2/tools/comment/get/评论管理-查询评论

【更新内容】

2021/3/28 已上线,查询评论接口增加评论状态,创意ID,抖音号三个返回参数

涉及API

类别

字段

增加逻辑

open_api/2/tools/comment/get/

评论管理-查询评论

返回参数

增加字段
reply-status;creative id;aweme_account


2021年03月23日

尊敬的开发者:

您好,为了配合业务改造并且提供更好的服务,近期针对数据报表部分支持了落地页洞察数据能力,账号服务、数据报表进行部分规则变动,需要特别注意2021/3/29 凌晨01:00-02:30进行服务维护升级

届时可能会造成部分请求的失败,本次升级对在投计划及数据无影响,请您合理安排接口调用时间,避免服务升级期间对接口的调用动作。


【涉及接口】

open_api/2/report/site/page/ 落地页数据报表-橙子建站落地页数据

/open_api/2/advertiser/qualification/select_v2/ 获取投放资质信息

open_api/2/report/advertiser/get/ 广告主数据

open_api/2/report/campaign/get/ 广告组数据

open_api/2/report/ad/get/ 广告计划数据

open_api/2/report/creative/get/ 广告创意数据


【更新内容】


(1)2021/3/23 已上线,提供“橙子建站落地页数据”能力,此接口用于根据广告主id和site_id,获取一段时间内该落地页的:页面访问量,用户访问量,转化率,平均加载时常,平均阅读比例,平均访问时长

涉及API

类别


字段

字段类型

参数类型

增加逻辑

open_api/2/report/site/page/

数据报表-落地页数据


全部

全部

请求+应答参数

新增接口


(2)2021/3/23 已上线,获取投放资质信息支持多图,原接口只支持单张图片,现支持多图获取。

涉及API

类别


字段

字段类型

参数类型

增加逻辑


/open_api/2/advertiser/qualification/select_v2/


账号服务-获取投放资质信息


list






image_list



object[]

应答参数

增加字段 mage_list




attachment_id


int

应答参数

增加字段 attachment_id




image_url


string

应答参数

增加字段 image_url

(3)2021/4/22即将变动上线,在基础成报表部分将不会返回任何metrics为空的数据。

涉及API

类别


字段

字段类型

参数类型

增加逻辑

open_api/2/report/advertiser/get/


数据报表-广告数据报表


全部

全部

请求+应答参数


将不会返回任何metrics为空的数据

open_api/2/report/campaign/get/


全部

全部

请求+应答参数

open_api/2/report/ad/get/


全部

全部

请求+应答参数

open_api/2/report/creative/get/


全部

全部

请求+应答参数

(4)2021/3/29 凌晨01:00-02:30进行服务维护升级,届时可能会造成部分请求的失败,本次升级对在投计划及数据无影响,请您合理安排接口调用时间,避免服务升级期间对接口的调用动作。


为了降低对您现有使用的影响,再次提示请您关注更新内容!


2021年03月18日

尊敬的开发者:

您好,巨量引擎商业开放平台,面对【巨量星图】品牌主客户,开放客户在星图平台发布任务后的效果数据,全方位满足星图客户对抖音达人传播任务的效果分析诉求,科学高效指导投放决策!


【更新内容】

(1)2021/3/18上线,用户授权流程中,支持授权星图客户账号;用户授权后,开发者可通过「获取已授权账户」接口查询授权的星图id;

涉及API

类别

字段

增加逻辑

open_api/oauth2/advertiser/get/

Oauth2.0授权-Token管理-获取已授权账户

应答参数

应答字段advertiser_role的返回值,增加“6-星图帐号”类型


(2)2021/3/18上线,提供「获取星图客户任务列表」接口;

此接口用于根据星图id,获取星图客户账号下的全部任务,包含星图任务id、任务名称、结算方式、组件类型、任务创建时间;

涉及API

类别

字段

增加逻辑

open_api/2/star/demand/list/


巨量星图能力-获取星图客户任务列表


全部

新增接口

(3)2021/3/18上线,提供「获取星图客户任务订单列表」接口;

此接口用于根据星图id和星图任务id,获取星图客户所发布任务的订单列表,包含订单总数、订单id、订单创建时间、订单状态、作品名称、作品封面图、视频id、视频链接、接单的达人id、达人名称、达人头像;

涉及API

类别

字段

增加逻辑

open_api/2/star/demand/order/list/

巨量星图能力-获取星图客户任务订单列表

全部

新增接口

(4)2021/3/18上线,提供「获取订单投后分析报表」接口;

此接口用于根据订单id,获取星图客户所发布任务的接单达人作品的创意表现、传播表现、舆情表现、组件转化表现、订单性价比等效果分析类数据;

涉及API

类别

字段

增加逻辑

open_api/2/star/report/order_overview/get/

巨量星图能力-获取订单投后分析报表

全部

新增接口

(5)2021/3/18上线,提供「获取订单投后受众报表」接口;

此接口用于根据订单id,获取星图客户所发布任务的接单达人作品的受众分析数据,包含性别、年龄、省份、城市、设备、兴趣、活跃度分布。

涉及API

类别

字段

增加逻辑

open_api/2/star/report/order_user_distribution/get


巨量星图能力-获取订单投后受众报表

全部

新增接口

2021年03月17日

尊敬的开发者:

您好,为了配合业务改造并且提供更好的服务,近期平台针对广告投放,提供了创意组件能力,并且配合变动,对创意审核,监测链接以及计划诊断部分进行部分规则变动,辛苦您提前关注更新内容,及时评估对您现有使用的影响。


【涉及接口】

open_api/2/creative/get/ 获取创意列表

open_api/2/creative/read_v2/ 创意详情信息

open_api/2/creative/create_v2/ 创建广告创意

open_api/2/creative/update_v2/ 修改广告创意

open_api/2/creative/reject_reason/ 获取创意审核建议

open_api/2/tools/diagnosis/ad/get_v2/ 获取计划诊断信息

open_api/2/assets/creative_component/create/ 创建创意组件

open_api/2/assets/creative_component/update/ 更新创意组件

open_api/2/assets/creative_component/get/ 查询组件列表


【更新内容】

(1)2021/3/16已更新,创编流程中,创意维度增加创意组件信息

涉及API

类别

字段

字段类型

参数类型

增加逻辑

open_api/2/creative/create_v2/


广告投放-创意

component_info


object[]


请求参数

增加字段,component_info组件信息



component_id

number

请求参数

增加字段,component_id组件id

open_api/2/creative/update_v2/

component_info


object[]

请求参数

增加字段,component_info组件信息



component_id

number

请求参数

增加字段,component_id组件id

open_api/2/creative/read_v2/

component_info


object[]

应答参数

增加字段,component_info组件信息



component_id

number

应答参数

增加字段,component_id组件id


(2)2021/3/16已更新,新增资产部分,资产部分部分增加创建组件,变更组件以及查询组件相关能力

涉及API

类别

字段

参数类型

增加逻辑

open_api/2/assets/creative_component/create/

资产-创意组件

全部

请求+应答

新增接口

open_api/2/assets/creative_component/update/

全部

请求+应答

新增接口

open_api/2/assets/creative_component/get/

全部

请求+应答

新增接口


(3)预计2021/3/25 更新,获取创意审核建议中,对于没有审核建议的创意,应答参数中会返回创意ID

涉及API

类别

字段

类型

增加逻辑

open_api/2/creative/reject_reason/

广告投放-获取创意审核建议

creative_id

应答参数

对于没有审核建议的创意,现状返回为空,变更后会返回creative_id


(4)将于20213月下旬更新,在创编流程中的监测链接部分,会进行校验规则新增,为防止校验生效后,对当前监测连接产生影响,需要对当前使用的监测连接的传输协议 由HTTP 改为HTTPS

涉及API

类别

字段

类型

增加逻辑

open_api/2/creative/

create_v2/


open_api/2/creative/

update_v2/


广告投放


track_url

请求参数

判空校验

正则校验URL基本格式

https协议校验

URL空格校验

URL ‘x’非法字符校验

入海广告主+港澳台广告主域名备案校验

action_track_url

请求参数

video_play_effective_track_url

请求参数

video_play_done_track_url

请求参数

video_play_track_url

请求参数

(5)诊断预计在2021/4/2上线,会对其中涉及的字段层级进行变更

涉及API

类别

字段

类型

描述

增加逻辑

open_api/2/tools/

diagnosis/ad/get_v2/


工具-获取计划

诊断信息


target_result


object[]

定向诊断结果

-


conclusion

string

定向诊断结果

参数名修改为"targeting_conclusion_detail"


targeting_suggestion

string

定向诊断优化建议

参数返回类型修改变更为"list"

budget_result



object[]


出价&预算诊断结果


-



conclusion_detail


string


出价诊断结果详细描述


参数名修改为"bid_conclusion_detail "



budget_suggestion


string


预算诊断建议


参数返回类型修改变更为"list"


bid_result



object[]


出价诊断结果


新增外层字段,下属"bid_conclusion_tag、bid_suggestion、bid_conclusion_detail quality_conclusion"



bid_conclusion_tag





bid_suggestion





bid_conclusion_detail




potential_result



object[]


潜力诊断结果


新增外层字段,下属"potential_ad_level、bid_incr_estimate"



potential_ad_level





bid_incr_estimate




quality_result



object[]


广告质量诊断结果


新增外层字段,下属"quality_conclusion_tag、quality_suggestion、 quality_conclusion"



quality_conclusion_tag





quality_suggestion





quality_conclusion




为了降低对您现有使用的影响,再次提示请您关注更新内容!


2021年03月10日

尊敬的开发者:

您好,为了配合业务改造并且提供更好的服务,近期对平台基本功能上线了平台公告,能力部分则会对账号管理以及资金流水有部分变动,麻烦提前关注更新内容及时评估对您现有使用的影响。


【涉及接口】

open_api/2/advertiser/info/

open_api/2/advertiser/fund/transaction/get/


【更新内容】

(1)2021/3/10 已更新,平台公告上线,查看平台公告可以进入【首页】,在【banner】下方找到平台公告信息,并且进入,旨在提供更清晰的消息触达方式


(2)转账流水部分数据回溯,2021/3/16,将进行逻辑变更,前置通知见,2021年2月24日更新日志,到时返回字段中将会出现数值正负的区分,为了保证更新逻辑后,您获取到的数据不受影响,需要开发者用户在2021/3/17 3/16 12:00-24:00之间请求的数据进行重新调用来回溯

涉及API

类别

字段

类型

增加逻辑


open_api/2/advertiser/
fund/transaction/get/


账号服务-查询账号
流水明细

amount

应答参数


接口中涉及到金额部分,流水中将增加正负值代表资金流向,不再是为绝对值

cash

应答参数

grant

应答参数

return_goods

应答参数

dealbase

应答参数

frozen

应答参数

字段废弃,下线

(3)2021/3/30 查询广告主接口中,部分字段返回逻辑修改以及部分字段下线;

涉及API

类别

字段

类型

增加逻辑


open_api/2/advertiser/
info/


账号服务-广告主信息

brand

应答参数


广告主类型如果是入海广告主,返回参数中将不返回这些应答参数

promotion_area

应答参数

promotion_center
_province

应答参数

promotion_center
_city

应答参数

balance

应答参数

字段下线


2021年03月05日

尊敬的开发者:

您好,为了配合业务改造并且提供更好的服务,近期上线了【工具-获取计划诊断信息】新接口,并且对诊断能力进行了全面升级,用户可以获取准确的计划诊断信息(计划诊断数据与优化建议两个方面),提升准确率

与有效性。并且会在近期对诊断相关老接口进行整体下线,为了降低对您现有使用的影响,麻烦提前关注更新内容及时评估对您现有使用的影响。


【涉及接口】

工具-获取计划诊断信息:

open_api/2/tools/diagnosis/ad/get/ 获取计划诊断详情 (老旧接口,预期2021/05/05下线,建议尽快迁移使用全面升级的新接口)

open_api/2/tools/diagnosis/ad/curve/获取计划诊断预估变化趋势(老旧接口,预期2021/05/05 下线,建议尽快迁移使用全面升级的新接口)


open_api/2/tools/diagnosis/ad/get_v2/获取计划诊断信息(新)(新增接口,2021/03/04已完成上线


【更新内容】

会下线目前的【工具-获取计划诊断信息】-【获取计划诊断详情/获取计划诊断预估变化趋势

上线新的【工具-获取计划诊断信息】-【获取计划诊断信息(新)】


为了降低对您现有使用的影响,再次麻烦提前关注更新内容及时迁移新接口,更好的进行计划诊断!


2021年02月24日

尊敬的开发者:

您好,为了配合业务改造并且提供更好的服务,近期上线了信息流广告搜索快投能力以及应用管理中创建分包能力进行了更新上线,并且会在近期

对部分老旧接口进行字段下线或者接口整体下线,为了降低对您现有使用的影响,麻烦提前关注更新内容及时评估对您现有使用的影响。


【涉及接口】

账号服务:

open_api/2/advertiser/fund/transaction/get/ 查询账号流水明细 (2021/03/15 规则更新)

广告投放:

open_api/campaign/read/ 广告组详情(老旧接口,开放平台无文档,2021/03/24 下线)

open_api/campaign/select/ 广告组列表(老旧接口,开放平台无文档,2021/03/24 下线)

open_api/ad/read/ 计划详情(老旧接口,开放平台无文档,2021/03/24 下线)

open_api/ad/select/ 计划列表(老旧接口,开放平台无文档,2021/03/24 下线)

open_api/2/ad/get/ 获取广告计划 (2021/2/24 更新功能)

open_api/2/ad/create/创建广告计划(2021/2/24 更新功能)

open_api/2/ad/reject_reason/ 获取计划审核建议(2021/3/24 字段下线)

open_api/2/creative/reject_reason/ 获取创意审核建议(2021/3/24 字段下线)

搜索广告投放:

open_api/2/keyword_feedads/suggest/ 搜索快投关键词推荐(2021/2/24更新功能)

DMP人群管理:

open_api/dmp/custom_audience/calc/ 运算人群包(2021/3/24接口下线)

open_api/dmp/custom_audience/lookalike/ 拓展人群包(2021/3/24接口下线)

工具:

open_api/tools/ad_convert/select/ 转化列表(2021/3/24接口下线)


【更新内容】

(1)2021/2/24 已更新,提供了信息广告中开启搜索快投功能

涉及API

类别

字段

类型

增加逻辑


open_api/2/ad/get/


广告投放-广告计划

fields

传入参数

查询字段集合新增
"feed_delivery_search","intelligent_flow_switch"

feed_delivery_search

应答参数

增加搜索快投功能字段

intelligent_flow_switch

应答参数

增加智选流量开关字段


open_api/2/ad/create/

feed_delivery_search

传入参数

增加搜索快投功能字段

intelligent_flow_switch

传入参数

增加智选流量开关字段


open_api/2/ad/update/

feed_delivery_search

传入参数

增加搜索快投功能字段

intelligent_flow_switch

传入参数

增加智选流量开关字段

open_api/2/keyword_feedads/suggest/

搜索关键词-搜索快投关键词推荐

全部

/

增加获取搜索快投关键词推荐这个接口

(2)2021/2/24 已更新,提供了通过应用包创建对应分包(子包)功能

涉及API

类别

字段

增加逻辑

open_api/2/tools/app_management/
extend_package/create/

工具-应用管理

全部

增加创建应用分包这个接口

(3)2021/03/15 将进行规则更新,目前在查询账号流水明细中查询到金额为绝对值(均为正),变更后金额将出现为负的值

涉及API

类别

字段

类型

增加逻辑


open_api/2/advertiser/
fund/transaction/get/


账号服务-查询账号流水明细

amount

应答参数


接口中涉及到金额部分,流水中将增加正负值代表资金流向,不再是绝对值

cash

应答参数

grant

应答参数

return_goods

应答参数

dealbase

应答参数

frozen

应答参数

字段废弃,下线

(4)2021/03/11 将进行规则更新,将对计划中用户定向部分中定向已安装进行规则变动,系统不再对不符合传入规则的字段进行处理,变更后会进行报错

涉及API

类别

字段

类型

增加逻辑

open_api/2/ad/create/

广告投放

hide_if_converted

传入参数

已安装用户这个定向只有在录入直达链接的情况下才会生效,之前的逻辑是如果不符合条件则后端置空不生效,变更后会进行后端报错

(5)2021/03/24 将对于枚举值中,在关于广告组状态的传入允许值中进行变动


涉及API

类别

字段

类型

增加逻辑

open_api/2/campaign/get/

广告投放

status

传入参数

允许的枚举值中下线:
超出广告主日预算CAMPAIGN_STATUS_ADVERTISER_BUDGET_EXCEED

(6)2021/03/24 将进行文档与接口同步下线,针对获取计划审核建议以及获取创意审核建议两个接口的返回参数中,部分字段进行下线.

material_type下线后可通过material_reject中返回的title、image_id和video_id是否有值判断审核失败素材类型

涉及API

类别

字段

类型

增加逻辑


open_api/2/ad/reject_reason/


广告投放-广告计划

material_type

应答参数

字段废弃,下线

is_procedual_ad

应答参数

字段废弃,下线

open_api/2/creative/reject_reason/

广告投放-广告创意

material_type

应答参数

字段废弃,下线

(7)2021/03/24 将针对部分接口进行统一下线


涉及API

类别

字段

增加逻辑


open_api/campaign/read/


广告投放-广告组


全部


停止访问,接口下线


open_api/campaign/select/


open_api/ad/read/


广告投放-广告计划


全部


open_api/ad/select/

open_api/dmp/custom_audience/calc/


DMP人群管理


全部

open_api/dmp/custom_audience/lookalike/


open_api/tools/ad_convert/select/

转化跟踪

全部

为了降低对您现有使用的影响,再次麻烦提前关注更新内容及时评估对您现有使用的影响!


2021年02月08日

【接口下线预通知】

尊敬的开发者:

您好,为了配合业务改造,巨量引擎开放平台将于2021年2月25日下线【查询极速下载列表】tools/advertiser_package/get/ 接口。

同时,极速下载服务将同步不可使用,相关通知请至 巨量引擎广告投放平台 消息中心查看


2021年02月01日

尊敬的开发者:

您好,巨量引擎开放平台预计在2月3日凌晨1-2点进行服务升级,期间异步任务相关接口(关键词报表/DPA报表)将无法进行下载操作。本次升级对在投计划及数据无影响,请您合理安排接口调用时间,避免服务升级期间对异步任务接口的调用动作。


2021年01月14日

尊敬的开发者:

您好,商业开放平台新增电商直播数据报表,全方位地满足直播中和直播后的数据分析需求;

帮助广告主和代理商,深入洞察账户内全部直播、单场直播、直播商品的详细数据,查看流量来源分布,进行受众分析,助力直播间精细化运营,指导直播广告投放!


【更新内容】

(1)2021/1/14上线,提供直播间属性报表接口;

此接口用于通过广告主id获取广告主账号绑定的抖音号的开播信息,包含主播信息和直播间信息,概览账号内全部直播进展,实时监控开播情况,便于直播后自动进行相关数据统计分析;


涉及API

类别

字段

增加逻辑

open_api/2/report/live_room/attribute/get/

数据报表-电商直播数据报表-直播间属性报表

全部

新增接口


(2)2021/1/14上线,提供直播间分析报表接口;

此接口用于获取直播间的基础分析数据、互动分析数据、商品转化数据,让你充分洞察直播间的流量转化漏斗,随时掌握直播间状态与指标变化趋势;


涉及API

类别

字段

增加逻辑

open_api/2/report/live_room/analysis/get/

数据报表-电商直播数据报表-直播间分析报表

全部

新增接口


(3)2021/1/14上线,提供直播间流量来源报表接口;

此接口用于获取直播间的流量来源数据,包含全站广告流量(竞价、品牌、DOU+)和自然流量,根据流量变化与各来源的用户表现,合理安排投放节奏、上品顺序、返场时机等;


涉及API

类别

字段

增加逻辑

open_api/2/report/live_room/flow_category/get/

数据报表-电商直播数据报表-直播间流量来源报表

全部

新增接口


(4)2021/1/14上线,提供直播间商品分析报表接口;

此接口用于获取直播间的商品分析数据,包含在售商品信息和商品转化数据,进行全面精准地带货分析;


涉及API

类别

字段

增加逻辑

open_api/2/report/live_room/product/get/

数据报表-电商直播数据报表-直播间商品分析报表

全部

新增接口


(5)2021/1/14上线,提供直播间受众分析报表接口;

新增直播受众分析报表,此接口用于进行直播间的受众分析、获取直播间用户画像数据,指导投放计划!


涉及API

类别

字段

增加逻辑

open_api/2/report/live_room/audience/portrait/get/

数据报表-电商直播数据报表-直播间受众分析报表

全部

新增接口


2021年01月12日

尊敬的开发者:

您好,为了配合业务改造并且提供更好的服务,在2021/1/12 对批量上传投放资质,转化监测链接部分做升级和改造 ,需要提前关注更新内容及注意对您现有使用的影响。


【涉及接口】

open_api/2/advertiser/qualification/create_v2/ 账号服务-广告主信息与资质管理-批量上传投放资质(2021/01/12 更新)

open_api/2/creative/update_v2/ 广告投放-广告创意-修改创意信息(2021/01/12 更新)

open_api/2/tools/ad_convert/track_url/update/ 工具-转化目标管理-修改转化监测链接(2021/01/12 更新)


【更新内容】

(1 )2021/01/12 更新,提供 批量上传投放资质 接口,利用此接口你可以批量上传投放资质;

涉及API

类别

字段

增加逻辑

open_api/2/advertiser/qualification/create_v2/

账号服务-广告主信息与资质管理-批量上传投放资质

全部

新增接口

(2)2021/01/12 更新,修改创意信息中监测链接;

涉及API

类别

字段

增加逻辑

open_api/2/creative/update_v2/

广告投放-广告创意-修改创意信息

action_track_url

允许修改action_track_url 点击监测链接

(3)2021/01/12 更新,提供 修改转化监测链接 接口,修改对象为转化跟踪中监测链接(对应投放平台 资产-转化跟踪-监测链接)。


涉及API

类别

字段

增加逻辑

open_api/2/tools/ad_convert/track_url/update/

工具-转化目标管理-修改转化监测链接

全部

新增接口


2021年01月07日

尊敬的开发者:

您好,为了配合业务改造,开放平台在2021/01/07进行更新,更新后不再允许出价方式为CPA的投放形式


【涉及接口】

ad/create/ 创建广告计划

ad/update/ 更新广告计划


【更新内容】

(1) ad/create 中的传入参数部分pricing,允许值不再有CPA

(2) ad/update 不再允许修改出价类型为CPA的的计划,会进行报错提示


附:预通知更新内容 2020年12月9日更新日志 中查看


2020年12月31日

尊敬的开发者:

您好,为了配合业务改造并且提供更好的服务,在12.24 对代理商创建广告主 以及 穿山甲流量包部分做了升级和改造,并且再次同步2021.1月 即将进行的一些改造,需要

提前关注更新内容及注意对您现有使用的影响。


【变更接口】

本期更新:

open_api/2/agent/advertiser/create_v2/ 代理商账号管理-创建广告主(新) (2020/12/24 已更新)

open_api/2/tools/union/flow_package/get/ 获取穿山甲流量包 (2020/12/24 已更新)

open_api/2/tools/union/flow_package/report/ 查看穿山甲rit数据 (2020/12/24 已更新)


近期即将变动:

open_api/2/ad/create/ 创建广告计划 (下线CPA出价方式) (2021/01/07

open_api/2/tools/industry/get/ 获取行业列表 (接口升级) (2021/01/04

open_api/2/advertiser/info/ 获取广告主账户详细信息 (下线部分字段) (2021/01 下旬


【更新内容】

(1)2020/12/24 已更新,提供了代理商 创建广告主接口(新)原接口 创建广告主 会在1.14进行下线

涉及API

类别

字段

字段值

增加逻辑

open_api/2/agent/advertiser/create_v2/

代理商账号管理-

创建广告主

全部



新上线接口,替换

open_api/2/agent/advertiser/create/

open_api/2/agent/advertiser/create/

全部


接口进行下线

(2)2020/12/24 已更新,提供了获取运营推荐的 穿山甲流量包,以及 查看穿山甲rit数据

涉及API

类别

字段

字段值

增加逻辑

open_api/2/tools/union/flow_package/

get/

工具-穿山甲流量包

flow_package_type


按照流量包类型过滤,允许值中增加

FEATURED:运营推荐

open_api/2/tools/union/flow_package/

report/


rits


广告位列表,最大数量限制:1000

campaign_ids


广告组列表,最大数量限制:1000

order_field


排序字段,所有的统计指标均可参与排序
默认按rit排序

order_type

枚举值:ASC(升序),DESC(降序)
默认:DESC

排序方式
枚举值:ASC(升序),DESC(降序)
默认:DESC


(3)2021/01/04 更新,

将会对行业目录进行升级,开发者将会从 获取行业目录 接口中自动获取升级后的新的行业类目,并且使用到行业类目的接口将进行参数校验,不建议使用旧的行业类目进行

参数传入操作


传入行业的API

涉及API

类别

字段

字段值

增加逻辑

open_api/2/creative/create_v2/

广告投放-创建创意

third_industry_id


三级行业id,需要传入升级后的行业id

open_api/2/creative/update_v2/

广告投放-修改创意

third_industry_id


三级行业id,需要传入升级后的行业id


open_api/2/report/agent/get_v2/

数据-代理商数据

first_industry


一级行业名称,需要传入升级后的行业名称

second_industry


二级行业名称,需要传入升级后的行业名称


open_api/2/agent/advertiser/create/

代理商账号-创建广告主

second_industry_id


二级行业id,需要传入升级后的行业id

open_api/2/adlab/group_creative/update/

投放管家-设置项目创意信息

third_industry_id


三级行业id,需要传入升级后的行业id

获取行业API

涉及API

类别

字段

字段值

增加逻辑

open_api/2/tools/industry/get/

工具-获取行业列表

全部


1.4会进行接口升级,接口升级后,行业列表也将获取最新的行业列表


(4)2021/01/07 更新,

对于创建计划,修改计划都会又影响,无法再创建出价方式为CPA的计划,且旧的CPA计划不允许编辑

涉及API

类别

字段

字段值

增加逻辑

open_api/2/ad/create/

广告投放-创建计划

pricing


限制PRICING_CPA传入,不再允许创建出价方式为CPA的计划;

open_api/2/ad/update/

广告投放-修改计划



旧CPA计划不允许进行编辑,操作时进行报错


(5)2021/01 下旬 更新

由于配合业务改造,将会在2021/1月下线 获取广告主信息以下广告主字段信息

涉及API

类别

字段

字段值

增加逻辑


open_api/2/advertiser/info/


账号服务-获取广告主信息

email 联系邮箱



返回参数中,将下线5个字段

contacter 联系人


phonenumber 手机号码


telephone 固定电话


address 地址



2020年12月23日

尊敬的开发者:

您好,为了提供更好的服务,本期2020/12/23 对于穿山甲流量包工具做了优化,

预计2021/01/14 对于获取广告创意详情信息进行部分变动,2021/01 月中对于定向包功能进行新增规则校验


【变更接口】

本期更新:

tools/union/flow_package/report/(2020/12/23已更新)

近期即将变动:

creative/read_v2(2021/01/14变更)

open_api/2/audience_package/create/(2021/01 月中变更)

open_api/2/audience_package/update/(2021/01 月中变更)

【更新内容】

(1)本期(2020/12/23)更新,优化了查看穿山甲广告位数据接口

涉及API

类别

字段

字段值

增加逻辑


tools/union/flow_package/report/


工具-穿山甲流量包

campaign_ids

广告组列表[]

广告 id 列表,最大数量限制:1000

rits

广告位列表[]

广告位列表,最大数量限制:1000

(2)2021/01/14更新

现有逻辑:返回参数中,image_mode是视频时,image_id(图片ID)和image_ids(图片ID列表)都返回;

变更后逻辑:返回参数中,当image_mode为视频时,image_ids无返回值;

涉及API

类别

字段

字段值

变更逻辑

creative/read_v2

广告投放-创意

image_ids

图片ID列表

当image_id为视频时,image_ids无返回值;

(3)2021/01月中更新,针对于定向包会进行服务迁移,到时会新增如下校验逻辑

涉及API

类别

字段

字段值

增加逻辑


audience_package/create/
audience_package/update/


工具-定向包

auto_extend_enabled

1: 启用 0: 不启用


在 auto_extend_enabled 为关闭的时候,会将 auto_extend_targets 置空

auto_extend_targets

interest_action: 兴趣关键词
custom_audience: 自定人群-定向
region: 地区
age: 年龄
gender: 性别
interest_tag: 旧版行为兴趣
ad_tag: 旧版系统推荐


2020年12月16日

尊敬的开发者:


您好,本次的信息非常重要,为了提供更好的服务,伴随业务调整,开放平台部分接口在1月上旬将会进行重要变动,请关注更新内容及注意对您现有使用的影响。


【更新内容】


  1. 行业体系类目迭代,由于整体在进行行业类目迭代,会涉及到整体行业类目结构有细微变化,会在1.4日后提供新的查询行业目录接口供使用,现接口文档地址:工具-查询工具-获取行业列表
  2. CPA出价方式下线,在1月初进行下线,见12.9发出的更新日志其他消息通知
  3. 代理商创建广告主接口替换,会在12月下旬提供新的接口,原接口会在1月上旬走接口下线流程,现接口文档地址:账号服务-代理商账号服务-创建广告主
  4. 定向包功能迭代,会在1月中旬新增部分规则校验,具体内容关注关于定向包单独通知,现接口文档地址:工具-定向包管理-创建定向包工具-定向包管理-更新定向包


2020年12月15日

尊敬的开发者:

您好,本期我们会新增【查询推广卡片推荐内容(新版)】接口。


【新增接口】

tools/promotion_card/recommend_title/get/ 工具——查询工具——查询推广卡片推荐内容(新版)

【更新内容】

该接口提供给用户用来查询广告创意推广卡片内推荐文案,包括推广卖点文案,卡片标题文案,行动号召文案。具体使用方法可点击上方链接进入开发文档阅读。同时原有推广卡片文案查询接口将逐渐停止更新文案库,并最终下线接口,希望各位开发者及时更新,接入新查询接口。


2020年12月10日

尊敬的开发者:

您好,商业开放平台将于北京时间12月15日凌晨01:00-05:00点进行服务升级,届时所有接口将出现超时现象,暂不可用。为避免本次升级对您的使用带来影响,建议在该时间段内停止调用行为,感谢您对本次升级的积极配合。


2020年12月9日

尊敬的开发者

您好,为了配合业务改造,开放平台会在1月上旬下线计划的CPA出价方式,届时将无法创建CPA出价方式的计划,为此次下线带来的影响对您说声抱歉,建议您提前对已经在进行投放或者预期投放的CPA计划进行调整

【涉及接口】

ad/create/ 创建广告计划

ad/update/ 修改广告计划

【更新内容】

1、ad/create 中的传入参数部分pricing,允许值将不再有CPA

2、ad/update 将不再允许修改出价类型为CPA的的计划,会进行报错提示


2020年11月27日

尊敬的开发者:

您好,为了提升系统的稳定性和易用性,保证双12期间系统稳定性,会停止在期间的服务迁移,故将原有开放平台服务迁移工作时间进行调整,12月16日-12月25日(原定11.26日),变更进行服务迁移,迁移期间会涉及对API做相应的服务调整,请关注更新内容及注意对您现有使用的影响。


【涉及接口】

  • ad/create 创建广告计划
  • ad/update 修改广告计划

【更新内容】

  1. ad/create 和ad/update中的部分字段后续将不再维护,会进行下线处理
    即将
    下线字段ad_tag(兴趣分类)、interest_tags(兴趣关键词)、app_behavior_target(APP行为)、app_ids(APP行为定向-按APP) 、app_category(APP行为定向-按分类)
  2. 11月17日我们会新增一些计划创编接口的错误校验,为了避免影响你的正常使用请提前检查您的代码中是否涉及相关参数。

新增校验及处理方式

序号

涉及API

大类

类别

类别

新增校验

错误场景

处理方式

1

ad/create


ad/update


权限

权限

权限

不能通过非投放管家方式修改投放管家平台或者投放管家API创建的计划

通过非投放管家方式修改投放管家平台或者投放管家API创建的计划,报错:该广告组已被智能托管,无法修改

通过投放管家方式修改

2

广告计划



投放目标


转化(整体转化跟踪)

未激活的转化id不能使用

convert_id对应的转化未激活,报错:转化不可用

激活对应转化id

3

转化(整体转化跟踪)


预定义的转化目标必须为当前计划可用


convert_id对应的预定义转化当前计划无该转化目标,报错:转化目标不可用


用接口查询: https://ad.oceanengine.com/openapi/doc/index.html?id=1696710727725056

4

下载链接

url类型参数校验url的合法性

参数中包含参数中非合法的url,报错:'Not a valid URL.'

请传入正确可用的url

5

转化目标

external_actions和convert_id不能同时存在

同时传入external_actions和convert_id字段,报错:“转化与转化目标只能传一个”

根据需要使用的转化目标,确定传“external_actions”和“convert_id”中的一个

6

用户定向


安卓版本

ios应用不能定向安卓版本


ios应用推广传入安卓版本android_osv,报错: iOS应用只能选择iOS版本

应用推广时,设置应用版本号时应该与系统版本相对应。安卓应用不可传IOS版本,IOS应用不可传安卓版本

7

智能放量

auto_extend_targets不再支持 ad_tag, interest_tag

如果auto_extend_targets字段传入ad_tag, interest_tag两个值,报错:“智能放量校验-校验不通过-智能放量选项不合法”


auto_extend_targets目前仅支持 "custom_audience", "age", "gender", "region", "interest_action"


8


行为兴趣


旧版行为兴趣定向已下线,请使用新版行为兴趣定向


传入已下线字段“ad_tag”,“interest_tags”,报错:“旧版行为兴趣定向已下线,请使用新版行为兴趣定向”


旧版行为兴趣定向已下线,请使用新版行为兴趣定向


9


旧版app行为定向已下线


传入已下线字段“app_behavior_target”,“new_app_category”,“new_app_ids”,报错:“【app行为定向】功能目前已经下线,请返回上一步去除app行为定向的勾选,才能提交成功。”


旧版app行为定向已下线


10


预算与出价


深度转化
与深度转化出价


如无深度转化目标不能填写deep_bid_type": "PACING"


如无深度转化目标填写deep_bid_type": "PACING",报错:目标转化价格不能小于0.1


出价方式为OCPM/OCPC时,cpa_bid需要传入合法的目标转化出价


11


深度出价价格需在0.1~10000(闭区间)


deep_cpa_bid值小于0.1,大于10000,报错:“深度出价价格不在允许范围内”


调整deep_cpa_bid值为0.1~10000(闭区间)


12


深度转化出价(deep_cpa_bid)不能低于目标转化出价(cpa_bid)


deep_cpa_bid传值小于cpa_bid,报错:“深度转化出价不能低于目标转化出价”


调整cpa_bid<=deep_cpa_bid


13


deep_bid_type值需要和深度转化目标相匹配


deep_bid_type和传入的convert_id对应的深度转化目标不匹配,报错为对应的业务报错,“
请选择对应深度转化方式,当前可用的深度转化方式为xxxxx”


deep_bid_type值需要和深度转化目标相匹配


14


计划无可用的深度转化方式


如果根据传入的转化参数和出价参数,不能获取到可用的深度转化方式,则报错:“
深度转化方式不可用


deep_bid_type需要在有可用深度转化方式时传入


2020年11月24日

尊敬的开发者您好,本期我们会对建站管理模块相关功能做升级

建站管理

【新增接口】

【更新内容】

  1. 用户可以调用 【建站工具—建站转增】实现站点的转赠功能,将某一广告主的站点共享给其他特定的广告主,转赠成功后,广告主们拥有站点的共同使用权。
  2. 用户可以调用 【建站工具—建站复制】实现站点的复制功能,成功后生成一个新站点id,站点内容和原站点一致


2020年11月22日

尊敬的开发者您好,

2020年12月18日我们会新增二个错误校验,具体如下,历史逻辑会忽略这些校验依然正常创建,当严格的校验生效后会报错返回,为了避免影响你的正常使用请提前check你的代码中是否涉及相关参数,并且当你遇到以下问题时可以参考处理方式进行处理:


涉及接口

新增校验

错误场景

处理方式


创建广告创意/修改创意信息

promotion_card 字段 新增条件必填校验
在满足创建推广卡片条件下必填(不满足创建条件则不传)

创建/修改广告创意时,满足创建推广卡片的条件(具体条件可见【创建广告创意】接口promotion_card 字段),未传promotion_card 字段,会报错:promotion_card不能为空

在满足创建推广卡片的创建条件时,传入promotion_card字段相关信息


创建转化id


app_name 字段 新增必填校验

创建转化id时,未传app_name 字段,会报错:app_name不能为空

创建转化id时,传入app_name字段相关信息


2020年11月20日

尊敬的开发者您好,

商业开放平台将于北京时间11月24凌晨01:00-05:00点进行服务升级,该时间段内本次升级所涉及的接口可能出现短时波动。

主要涉及接口包括:

【广告投放模块】

【数据报表模块】

【工具——异步任务管理】

为避免此次升级给您带来影响,建议尽量避免在升级时间段内调用相关接口。为您带来的问题敬请谅解,感谢您对本次升级的配合。


2020年11月12日

尊敬的开发者您好,本期我们会对投放管家模块相关功能做升级

投放管家

【新增接口】

【更新内容】

1.API支持投放管家优质计划保护,对于转化数>6的计划可以设置为优质计划,启用更为宽松的超成本关停策略,避免小幅成本波动导致计划被自动关停。

2.API支持查询投放管家计划的系统操作日志,可显示计划的调整内容和原因(仅深度合作大客户可用,如需获得使用权限可联系相关运营)


【新增能力】

  • 访客召回更新说明:通过设置开启二次触达,拉动次留率涉及接口:设置项目转化信息
  • 新建电商店铺推广项目更新说明:支持客户在API侧使用投放管家项目类型-电商店铺推广涉及接口:新建投放管家项目
  • 素材监测链接更新说明:可以为不同的素材设置单独的监测链接。当某条计划产生广告展示或点击时,媒体会上报监测链接,然后广告主可跟踪到对应该计划的后端效果涉及接口:设置项目创意信息
  • 支持长期投放更新说明:新建项目支持选择长期投放涉及接口:设置项目预算信息
  • 获取项目信息新增出参(仅深度合作大客户可用,如需获得使用权限可联系相关运营 )更新说明:通过该接口可以查询组维度预期成本和展示量涉及接口:获取项目信息
  • 批量查询计划信息新增出参(仅深度合作大客户可用,如需获得使用权限可联系相关运营 )更新说明:可以查询计划维度预期成本和展示量涉及接口:批量查询计划信息


2020年11月10日

尊敬的开发者您好,2020年11月16日,我们会针对授权相关功能进行升级:

【特别注意】 本次升级的时间为 11.16晚 22:00 - 24:00,期间不允许开发者申请授权操作,敬请谅解。

【更新内容】

  1. 管家(操作者)作为整体授权,不再单独勾选广告主
  2. 获取已授权账号返回信息区分管家(操作者)和管家(管理员)
  3. APPID重新授权广告账户只可做增量授权,取消授权账号的功能移至应用管理界面
  4. 新增支持基于用户(user)授权的功能
  5. 不再支持旧版代理商账号授权的功能

详细的更新内容和对开发者的影响可在 授权改版预通知(2020年11月16日生效)中查看


2020年11月06日

尊敬的开发者:

您好,为了提升系统的稳定性和易用性,开放平台将于11月17日-11月26日进行服务迁移,迁移期间会涉及对API做相应的服务调整,请关注更新内容及注意对您现有使用的影响。


【涉及接口】

  • ad/create 创建广告计划
  • ad/update 修改广告计划

【更新内容】

  1. ad/create 和ad/update中的部分字段后续将不再维护,会进行下线处理
    即将
    下线字段为 ad_tag(兴趣分类)、interest_tags(兴趣关键词)、app_behavior_target(APP行为)、app_ids(APP行为定向-按APP) 、app_category(APP行为定向-按分类)
  2. 11月17日我们会新增一些计划创编接口的错误校验,为了避免影响你的正常使用请提前检查您的代码中是否涉及相关参数。

新增校验及处理方式:


序号

涉及API

大类

类别

类别

新增校验

错误场景

处理方式

1

ad/create
ad/update

权限

权限

权限

不能通过非投放管家方式修改投放管家平台或者投放管家API创建的计划

通过非投放管家方式修改投放管家平台或者投放管家API创建的计划,报错:该广告组已被智能托管,无法修改

通过投放管家方式修改

2

广告计划


投放目标

转化(整体转化跟踪)

未激活的转化id不能使用

convert_id对应的转化未激活,报错:转化不可用

激活对应转化id

3

转化(整体转化跟踪)

预定义的转化目标必须为当前计划可用

convert_id对应的预定义转化当前计划无该转化目标,报错:转化目标不可用

用接口查询:https://ad.oceanengine.com/openapi/doc/index.html?id=1696710727725056

4

下载链接

url类型参数校验url的合法性

参数中包含参数中非合法的url,报错:'Not a valid URL.'

请传入正确可用的url

5

转化目标

external_actions和convert_id不能同时存在

同时传入external_actions和convert_id字段,报错:“转化与转化目标只能传一个”

根据需要使用的转化目标,确定传“external_actions”和“convert_id”中的一个

6

用户定向

安卓版本

ios应用不能定向安卓版本

ios应用推广传入安卓版本android_osv,报错: iOS应用只能选择iOS版本

应用推广时,设置应用版本号时应该与系统版本相对应。安卓应用不可传IOS版本,IOS应用不可传安卓版本

7

智能放量

auto_extend_targets不再支持 ad_tag, interest_tag

如果auto_extend_targets字段传入ad_tag, interest_tag两个值,报错:“智能放量校验-校验不通过-智能放量选项不合法”


auto_extend_targets目前仅支持 "custom_audience", "age", "gender", "region", "interest_action"


8


行为兴趣


旧版行为兴趣定向已下线,请使用新版行为兴趣定向


传入已下线字段“ad_tag”,“interest_tags”,报错:“旧版行为兴趣定向已下线,请使用新版行为兴趣定向”


旧版行为兴趣定向已下线,请使用新版行为兴趣定向


9


旧版app行为定向已下线


传入已下线字段“app_behavior_target”,“app_category”,“app_ids”,报错:“【app行为定向】功能目前已经下线,请返回上一步去除app行为定向的勾选,才能提交成功。”


旧版app行为定向已下线


10


预算与出价


深度转化
与深度转化出价


如无深度转化目标不能填写deep_bid_type": "PACING"


如无深度转化目标填写deep_bid_type": "PACING",报错:目标转化价格不能小于0.1


出价方式为OCPM/OCPC时,cpa_bid需要传入合法的目标转化出价


11


深度出价价格需在0.1~10000(闭区间)


deep_cpabid值小于0.1,大于10000,报错:“深度出价价格不在允许范围内”


调整deep_cpabid值为0.1~10000(闭区间)


12


深度转化出价(deep_cpabid)不能低于目标转化出价(cpa_bid)


deep_cpabid传值小于cpa_bid,报错:“深度转化出价不能低于目标转化出价”


调整cpa_bid<=deep_cpabid


13


deep_bid_type值需要和深度转化目标相匹配


deep_bid_type和传入的convert_id对应的深度转化目标不匹配,报错为对应的业务报错,“请选择对应深度转化方式,当前可用的深度转化方式为xxxxx”


deep_bid_type值需要和深度转化目标相匹配


14


计划无可用的深度转化方式


如果根据传入的转化参数和出价参数,不能获取到可用的深度转化方式,则报错:“深度转化方式不可用”


deep_bid_type需要在有可用深度转化方式时传入

2020年11月12日

尊敬的开发者您好,

为给各位开发者,广告主提供更优质的服务,巨量引擎Marketing API将于北京时间2020年11月12日对系统进行维护。请关注更新内容及注意对您现有使用的影响


【涉及接口】

  • 创建橙子建站站点接口:open_api/2/tools/site/create/
  • 修改橙子建站站点接口 :open_api/2/tools/site/update/

【更新内容】

  1. 建站功能需要对输入的IOS应用下载的链接进行限制,仅可输入:apps.apple.com、itunes.apple.com 域名开头的链接。

例如:https://itunes.apple.com/cn/app/idxxxxxxx?mt=8(输入字段信息不符合要求会提示报错并要求输入AppleStore链接)


2020年11月05日

尊敬的开发者您好,

本期我们会新增:广告创意支持直播创意,广告计划关联抖音号支持用户手动上传(旧版为默认第一个关联抖音号)

广告投放-广告创意模块

【能力更新】新增支持“直播创意”

广告创意选择“直播创意”需满足的条件:【广告计划模块-创建广告计划】 “推广目的”为 抖音号推广/商品推广 且“投放内容”为 直播

广告投放-广告计划模块

【能力更新】支持手动上传绑定关联的抖音号

【广告计划模块-创建广告计划】aweme_account绑定抖音号,可从【获取绑定抖音号】接口获取,默认取绑定的第一个抖音号


2020年10月20日

尊敬的开发者您好,

本期我们会新增广告创意支持推广卡片,同时DMP人群包增加发布时间相关信息

广告投放——广告创意模块

【能力更新】新增支持“推广卡片”

更新说明:广告创意支持“推广卡片” 创建推广卡片需满足的条件:1.广告组推广目的不在:头条文章;抖音号推广-投放内容为抖音主页/直播间;商品推广-投放内容为直播间;商品目录推广 2.投放范围不是穿山甲 3.广告组类型为信息流广告 4.投放位置包含抖音信息流广告

满足上述4个条件才可上传推广卡片,否则会报错

涉及接口:广告投放——广告创意模块——创建广告创意 /创意详细信息 /修改创意信息

DMP人群管理

【能力更新】新增支持“DMP人群包数据源详细信息返回发布时间相关字段”

更新说明:增加三个相关字段,lastest_published_time:数据源最近一次发布完成时间; lastest_published_changelog_id:数据源最近一次发布完成对应的操作日志id,未完成显示“-1”;published_time:当次操作发布完成时间用以反映人群包的推送完成时间信息

涉及接口:DMP人群管理——数据源详细信息


2020年10月12日

尊敬的开发者您好,

在11月17日我们会新增一些计划创编接口的错误校验,具体如下,历史逻辑会忽略这些校验依然正常创建,当严格的校验生效后会报错返回,为了避免影响你的正常使用请提前check你的代码中是否涉及相关参数,并且当你遇到以下问题时可以参考处理方式进行处理:


新增校验

错误场景

处理方式

只有当传入的convert_id包含对应的深度转化时,创建计划才可以设置deep_bid_type

deep_bid_type 深度优化设置了,但convert_id 不包含深度转化,会报错:深度出价优化方式与深度转化目标不匹配


传deep_bid_type必须与convert_id所包含的深度转化匹配,具体可通过
https://ad.oceanengine.com/openapi/doc/index.html?id=1696710551161856检查


"deep_bid_type": "DEEP_BID_PACING"需要用户开放动态出价


"deep_bid_type"传入"DEEP_BID_PACING",但其实不需要深度转化,报错:当前用户尚未开放动态出价


不需要深度转化,deep_bid_type不要传值


"deep_bid_type": "DEEP_BID_MIN"时, "deep_cpabid"不能传0


参数有 "deep_bid_type": "DEEP_BID_MIN", "deep_cpabid": "0.00",报错:无深度转化目标


在有深度转化目标的同时,deep_cpabid不能传0


参数有"roi_goal",则必须包含对应的深度转化目标


参数有"roi_goal",但没有深度转化目标,报错:ROI系数出价请输入合法的深度转化目标


参数有"roi_goal",则必须啊包含对应的深度转化目标


deep_bid_type": "ROI_COEFFICIENT",时不允许传入smart_bid_type


参数有"smart_bid_type": "SMART_BID_CONSERVATIVE",deep_bid_type": "ROI_COEFFICIENT",报错:ROI系数出价不支持自动出价


不要同时传deep_bid_type: "ROI_COEFFICIENT"和smart_bid_type


未激活的转化id不能使用


convert_id对应的转化未激活,报错:转化不可用


激活对应转化id


预定义的转化目标必须为当前计划可用


convert_id对应的预定义转化当前计划无该转化目标,报错:转化目标不可用


用接口查询:
https://ad.oceanengine.com/openapi/doc/index.html?id=1696710727725056


url类型参数校验url的合法性


参数中包含参数中非合法的url,报错:'Not a valid URL.'


请传入正确可用的url


如无深度转化目标不能填写deep_bid_type": "PACING"


如无深度转化目标填写deep_bid_type": "PACING",报错:目标转化价格不能小于0.1


如无深度转化目标deep_bid_type不传值


不能通过非投放管家方式修改投放管家平台或者投放管家API创建的计划


通过非投放管家方式修改投放管家平台或者投放管家API创建的计划,报错:该广告组已被智能托管,无法修改


通过投放管家方式修改


ios应用不能定向安卓版本


ios应用推广传入安卓版本android_osv,报错: iOS应用只能选择iOS版本


应用推广时,设置应用版本号时应该与系统版本相对应。安卓应用不可传IOS版本,IOS应用不可传安卓版本


2020年9月24日

尊敬的开发者您好,

本期搜索广告创意部分对齐平台功能,具体更新如下:

广告创编

【能力更新】搜索广告创意能力更新


2020年9月18日

尊敬的开发者您好,

本期对定向中的superior_popularity_type字段(原精选流量包 )进行了更新 ,具体更新如下:

定向

【字段更新】superior_popularity_type

  • 更新说明:superior_popularity_type原描述为精选流量包,更新后描述为媒体定向,应用软件精选流量包枚举值下线,历史创建的枚举值为应用软件精选流量包的媒体定向在 投放时不生效
  • 涉及接口:创建广告计划修改广告计划获取广告计划


2020年9月16日

尊敬的开发者您好,

本期上线屏蔽抖音用户、否定词管理(新版)、游戏礼包码、行为兴趣报表、抖音达人报表等能力,投放管家-投放结束时间有所调整,具体更新如下:

评论管理

【新增能力】屏蔽抖音用户


搜索广告

【能力更新】否定词管理(新版)


广告创编

【新增能力】游戏礼包码

  • 能力说明:应用推广类型的广告计划可以添加游戏礼包附加创意,游戏礼包可以吸引用户下载游戏--游戏礼包码在游戏的推广阶段发放给玩家,玩家在下载登录游戏之后兑换获得相应的奖励,目前只适用于应用推广类型的计划,游戏礼包码是白名单功能,如需申请请联系相应的销售和运营同学


数据报表

1.【新增能力】行为兴趣报表

  • 能力说明:如果您在计划的受众定向中设置了行为/兴趣定向,那么您可以通过该能力获取行为/兴趣指标所对应的数据
  • 涉及接口:行为兴趣报表


2.【新增能力】抖音达人报表

  • 能力说明:如果你在计划的受众定向中设置了抖音达人,那么您可以通过该能力获取抖音达人指标所对应的数据
  • 涉及接口:抖音达人报表


投放管家

【重要通知】投放管家-投放结束时间更新


转化目标管理

【重要通知】转化来源下线AD_CONVERT_SOURCE_TYPE_API

  • 通知说明:转化来源(convert_source_type)枚举值AD_CONVERT_SOURCE_TYPE_API将在9.23下线,届时将无法继续使用,如果有使用,请尽快调整
  • 涉及接口:转化目标管理-创建转化id


2020年9月10日

尊敬的开发者您好,

本期上线游戏营销场景(预约、大推&常规投放)、定向-已安装用户、查询应用信息、查询游戏信息等能力,具体更新如下:

定向

【字段更新】定向-已安装用户


应用管理

1.【新增能力】查询应用信息

  • 能力说明:查询广告主在应用管理上传的应用详细信息
  • 涉及接口:查询应用信息


2.【新增能力】查询游戏信息

  • 能力说明:查询广告主在应用管理上传的游戏预约信息
  • 涉及接口:查询游戏信息


数据报表

【接口更新】多合一报表搜索广告相关更新

  • 更新说明:报表素材类型过滤新增搜索橱窗、搜索词报表新增触发方式分组聚合和过滤条件
  • 涉及接口:多合一数据数据报表接口


建站管理

【新增能力】获取橙子建站落地页表单信息


广告创编

【新增能力】游戏营销场景能力

  • 能力说明:基于“游戏生命周期”维度,支持游戏客户分营销场景(目前支持新游预约、游戏大推和常规投放三种场景)进行投放广告;目前游戏营销场景能力是白名单功能,如需申请请联系相应的销售和运营同学
  • 涉及接口:营销场景广告投放-游戏营销场景广告投放-创建广告组/创建广告计划、广告投放-广告组-获取广告组、广告投放-广告计划模块-获取广告计划/ 修改广告计划


2020年8月31日

【重要通知】服务升级影响部分接口使用

尊敬的开发者您好,

巨量引擎开放平台将于2020年9月3日凌晨01:00 - 03:00期间进行服务升级,期间创编接口暂不可用,数据报表相关接口返回数据为空或缺失。请规避此时段内的广告创建及查询,以免影响您的投放。

具体涉及接口如下:

【广告投放相关接口】:获取广告组/获取广告计划/获取广告创意

【数据报表相关所有接口】:广告主数据/广告组数据/广告计划数据/广告创意数据/多合一数据报表接口/分级模糊数据/视频素材报表/代理商数据(待废弃)/受众分析数据

【账号服务相关接口】:查询账号日流水

【建站管理相关接口】:创建橙子建站站点

【工具相关接口】:转化id列表


2020年8月28日

【重要通知】巨量引擎安卓应用下载类广告的发布规范

尊敬的开发者您好,

根据工业和信息化部《关于开展纵深推进APP侵害用户权益专项整治行动的通知》的要求,相关企业应进一步强化个人信息保护,加强各平台应用类软件的隐私权限信息公示及对平台分发的应用软件审核管理工作。现需平台安卓应用下载类广告主配合完成以下工作:巨量引擎安卓应用下载类广告的发布规范

请您务必阅读以上文档,并及时同步给贵司业务方,防止因不符工信部《通知》内要求而对您的广告投放造成不必要的负面影响。

根据《通知》内容,MAPI侧即将于下周三【9月2日】上线相应的校验逻辑,预计将造成以下影响:

一、橙子建站创建:

1. 创建橙子建站接口:

- XrPicture、XrPictureGroup、XrSimpleText、XrRichText、XrForm 组件均不允许填“有执行下载apk的链接”和“quickapp链接”。

- XrButton中LinkEvent中-安卓链接不允许填“执行下载apk的链接”,iOS字段只允许填iOS链接。 不允许的连接填入后,会出现报错。

- 如:XrPicture传入的link对象中的url是一个apk下载链接,会报错。

2. 更新橙子建站接口:如果更新提交的站点信息里包含“创建所述不允许的情况”,会报错。

3. 获取橙子建站列表、详情与更新建站状态接口不会影响,不做校验报错。

二、第三方落地页创编获取等不影响 。

三、端上显示:

1. 存量橙子建站落地页处理:

1) 火山lite端:所有建站落地页中非下载组件若可被判断是跳转下载链接,则点击无响应;

2) 其他端不影响;

2. 第三方落地页也不得在非按钮区域支持下载。


尊敬的开发者您好,

本期新增搜索子链数据报表、广告组预算下限调整至300元、广告组unique_fk字段、飞鱼线索source字段0枚举值下线,具体更新如下:

数据报表

【能力更新】搜索子链报表

  • 用途:用于获取搜索广告子链素材报表
  • 接口位置:数据报表-多合一数据报表接口
  • 接口地址:多合一数据报表接口


广告组

1.【字段变更】budget(广告组预算)

  • 变更说明:为了便捷更多中小广告主使用,广告组预算下限由1000元调整至300元
  • 字段位置:广告投放-广告组-创建广告组/修改广告组
  • 字段地址:创建广告组修改广告组


2.【字段下线】unique_fk


飞鱼线索管理

【字段值下线】source(广告来源)

  • 下线内容:source为0的线索回传,飞鱼平台不再披露显示,允许值0将于2020年9月24日下线
  • 字段位置:飞鱼线索管理-回传有效线索
  • 字段地址:回传有效线索


2020年8月21日

尊敬的开发者您好,

我们将在8.25对广告组预算下限进行调整,具体更新如下:

广告组

【重要通知】广告组预算下限调整至300元

  • 为了便捷更多中小广告主使用,我们会在8.25(下周二)将广告组的预算下限调整至300元
  • 涉及接口:创建广告组修改广告组


2020年8月14日

尊敬的开发者您好,

本期上线新版搜索广告关键词管理相关接口,原搜索广告关键词管理相关接口即将下线(预计下线时间10月13日),获取绑定的抖音号新增抖音id等字段,监测链接上线https强校验,具体更新如下:

搜索广告

【能力更新】搜索广告关键词管理(获取、创建、更新、删除)

  • 变化:新接口(获取、更新、删除)通过关键词id进行操作,支持计划绑定关键词时输入关键词的出价、出价类型、匹配类型。
  • 位置:搜索广告投放-关键词管理(新版)
  • 地址:关键词管理(新版)


查询工具

【涉及接口】获取绑定的抖音号

  • 新增字段:抖音id(aweme_id)、抖音昵称(aweme_name)、状态(status)、抖音头像(aweme_avatar)、共享的广告主列表(shared_advertisers)、绑定起始日期(start_date)
  • 接口位置:工具-查询工具-获取绑定的抖音号
  • 接口地址:获取绑定的抖音号


广告创意/转化目标管理

【重要通知】监测链接上线https强校验

为了保障用户的数据安全,“监测链接”将在8月20日(下周四)上线监测链接https的强校验功能,监测链接都必须使用https。

上线后,Marketing API将无法填充非https的监测链接,从而无法创建带有监测链接的创意以及转化跟踪,8月20日之前创建的监测链接不受影响。

注意:2020年8月20日后,提供的所有监测链接都必须是https的形式,否则将无法填充入后台并保存。


2020年8月10日

尊敬的开发者,Marketing API将会下线部分接口以及接口的相关字段,请求仔细检查代码并做调整以免影响后续接口调用,具体可查看如下两大点:

9月10日下线内容

广告计划

1.创建计划接口请求参数中:下线(老)人群包定向字段(retargeting_type,retargeting_tags);

2.更新计划接口请求参数中:下线(老)人群包定向字段(retargeting_type,retargeting_tags)、转化目标字段(convert_id)、深度优化字段(deep_bid_type)、DPA广告类型(dpa_adtype)(创建后不可修改,与平台保持一致);

3.获取计划接口返回参数中:下线(老)人群包定向字段(retargeting_type,retargeting_tags)、学习期字段(learning_phase,目前此字段返回值不准确,为了不影响列表接口性能,为此提供了新的学习期查询接口

4.更新计划预算接口请求参数中:下线(老)计划id与(老)预算字段:ad_id、budget, 修改预算统一使用:"data":[{"ad_id":xxxx,"budget":XXXX}] 的形式更新预算,非data形式不再支持,具体可查看文档;

5.更新计划出价接口请求参数中:下线(老)计划id与(老)出价字段:ad_ids、bid, 修改出价统一使用:"data":[{"ad_id":xxxx,"bid":XXXX}] 的形式更新出价,非data形式不再支持,具体可查看文档;


评论管理

1.查询评论接口返回参数中:下线item_id,group_id ,reply_info字段;

2.评论操作接口返回参数中:下线item_id, group_id, user_id, reply_to_user_id字段;

3.评论回复获取接口返回参数中:下线item_id,group_id字段;


10月13日下线内容

搜索广告

搜索广告-关键词管理(获取、创建、更新、增加、删除)5个老接口全部废弃,统一走新关键词管理接口(接口待上线,预计8月12日);


数据报表

数据报表-广告主数据、广告组数据、广告计划数据、广告创意数据、多合一报表数据接口返回参数中下线广告下载广告数据字段 next_day_open、next_day_open_cost、next_day_open_rate;


转化目标管理

转化目标管理:废弃(老)获取可用计划转化接口, 统一走:新版的查询可用计划接口获取可用转化;


一键起量管理

一键起量管理-启动一键起量获取起量预估值 接口请求参数:下线预估值字段modify_value;


2020年8月7日

尊敬的开发者您好,

本期新增单商品广告(SDPA)能力、获取DPA商品库商品列表接口、获取 DPA 商品库视频模板接口、视频互动流失数据秒级报表能力、试玩素材报表能力 ,具体更新如下:

广告组/广告计划/广告创意

【新增能力】单商品广告(SDPA)

  • 用途:结合商品的特征,自动批量生成广告创意,一个计划对应一个商品,帮助广告主打造爆款商品。
  • 新增字段:广告组商品类型(delivery_related_num) ,产品目录id(product_platform_id)、商品id(product_id),是否使用商品库视频模板(dpa_template)、商品库视频生成类型(dpa_video_template_type)、自定义商品库视频模板id(dpa_video_task_ids


DPA商品广告

1.【新增接口】获取DPA商品库商品列表

  • 用途:根据商品库id查询商品库中的商品列表
  • 接口位置:DPA商品广告-获取DPA商品库商品列表
  • 接口地址:获取DPA商品库商品列表


2.【新增接口】获取 DPA 商品库视频模板

  • 用途:根据商品库ids和商品库商品ids查询可用的商品库视频模板
  • 字段位置:DPA商品广告-获取 DPA 商品库视频模板
  • 字段地址:获取 DPA 商品库视频模板


数据报表

1.【新增接口】视频互动流失数据

  • 用途:在广告投放平台报表-广告产品-视频分析中获取视频素材秒级别的互动流失数据
  • 接口位置:数据报表-视频互动流失数据
  • 接口地址:视频互动流失数据


2.【新增能力】试玩素材报表能力

  • 用途:在广告投放平台报表-广告产品-分素材素材-试玩素材中获取试玩素材报表数据
  • 能力位置:数据报表-多合一数据报表接口
  • 能力地址:多合一数据报表接口


2020年8月3日

尊敬的开发者您好,

本期飞鱼回传有效线索、投放管家相关字段发生变更,具体更新如下:

飞鱼线索管理

【字段描述变更】广告来源、线索状态

  • 变更情况:广告来源由crm为0,允许值:0修改为新版深度转化 source为1 允许值:1;线索状态允许值由无效线索、潜在客户、高价值客户、已成单修改为回访-信息确认、回访-加为好友、回访-高潜成交
  • 字段位置:飞鱼线索管理-回传有效线索
  • 字段地址:回传有效线索


投放管家

1.【字段描述变更】视频播放链接相关字段

  • 变更情况:视频播放链接相关字段补充说明穿山甲穿山甲不支持视频类监测
  • 字段位置:投放管家-创建项目-设置项目创意信息
  • 字段地址:设置项目创意信息


2.【字段描述变更】出价

  • 变更情况:出价字段去掉游戏场景才支持(现在所有场景均支持)
  • 字段位置:投放管家-计划分析报表-更新计划目标成本
  • 字段地址:更新计划目标成本


3.【枚举值变更】投放管家项目场景

  • 变更情况:投放管家项目场景枚举值删除GAME_UNION(游戏穿山甲场景)、IF_SERVER_UNION(网服穿山甲场景)
  • 字段位置:附录-枚举值
  • 字段地址:枚举值


4.【字段变更】ad_bid、group_bid

  • 变更情况:ad_bid修改为必填字段,group_bid字段待废弃,废弃时间(2020.09.03)
  • 字段位置:投放管家-项目修改-更新计划状态
  • 字段地址:更新计划状态


2020年7月28日

尊敬的开发者您好,

本期新增查询计划可用的的转化id,原查询计划可用的转化id接口将废弃(2020.08.28),具体更新如下:


转化目标管理

【新增接口】【新】查询计划可用的转化id


2020年7月22日

尊敬的开发者您好,

商业开放平台将于北京时间2020年7月23日凌晨02:00-02:05进行服务迁移。届时广告组/计划/创意相关接口的增删改查功能将无法使用。本次维护不影响在投计划的正常投放,请您提前妥善安排相关工作, 避免上述时间进行接口调用和操作。


2020年7月21日

尊敬的开发者您好,

本期新增DPA报表支持小时纬度查询,具体更新如下:

异步任务管理

【新增能力】DPA报表支持小时纬度查询

  • 用途:在创建DPA类型的异步报表任务时,能够按照小时纬度获取数据
  • 接口位置:工具-异步任务管理-创建异步任务
  • 接口地址:创建异步任务


2020年7月16日

尊敬的开发者您好,

本期新增子链管理,创意相关接口新增子链id列表字段,具体更新如下:

子链管理

【新增能力】子链管理模块

  • 用途:子链主要帮助广告主投放搜索广告
  • 包含接口:获取子链列表、创建子链、编辑子链、删除子链
  • 接口位置:工具-子链管理模块
  • 接口地址:子链管理模块


广告创意

【新增字段】子链id列表


2020年7月15日

尊敬的开发者您好,

为了与平台的报表功能保持一致,本期对多合一数据报表接口进行了字段补齐,并对部分接口的字段名称做了改动,具体更新如下:

数据报表

1、【修改字段】应用下载广告数分类的付费次数、付费成本、付费率、卡券页领取修改为首次付费次数、首次付费成本、首次付费率、建站卡劵领取

2、【新增字段】 应用下载广告数据、落地页及门店数据、视频数据、附加创意、互动数据等分类下新增字段

详情见数据报表-多合一数据报表接口文档

接口位置:数据报表-多合一数据报表接口

接口地址: https://ad.oceanengine.com/openapi/doc/index.html?id=1696710554400780


2020年7月14日

尊敬的开发者您好,

【重要通知】关于敏感物料授权

目前我们获取素材URL、线索、评论这类相对敏感的物料接口存在主体校验,如果开发者主体和操作的广告主主体不一致,接口会报错提示。对此API升级了"敏感物料授权",在授权时开发者可以主动向广告主(管家/代理商)申请敏感物料的权限,具体说明如下:

1. 在授权URL中拼接物料授权开关可选参数material_auth,0或者不传都表示不做物料授权,1时表示做物料授权,material_auth将会被记录在token中。

2. 敏感物料授权范围为评论管理——二级权限点(67),飞鱼线索管理——二级权限点(69),图片和视频管理——三级权限(501)。

3. 每次授权会将material_auth更新成最新状态,如果最新授权不勾选物料授权则新的token无法操作敏感物料。

此外,以下情况开发者也可以获得敏感物料操作权限:将投放账号主体加入Appid的多主体白名单内。


2020年7月7日

尊敬的开发者您好,

本期对创建转化ID,查询转化详细信息进行字段补齐,新增深度优化方式枚举值具体更新如下:

转化目标管理

1.【新增字段】转化统计方式

2.【新增枚举】深度优化方式新增每次付费出价枚举


2020年7月3日

尊敬的开发者您好,

本期新增青鸟线索通卡券和智能电话组件,RTA策略、查询应用预约记录接口、原生化广告、关键词排名字段,具体更新如下:

青鸟线索通

【新增能力】青鸟线索通卡券、智能电话组件


RTA策略

【新增能力】RTA策略

  • 用途:基于本地投放的程序化升级,根据广告主不同的数据和技术能力,支持其逐步深入参与投放决策,最终共同优化提升广告投放效率/效果;
  • 包含接口:包含绑定RTA策略、解绑RTA策略、获取RTA策略数据、获取可用的RTA策略
  • 接口位置:工具-RTA策略管理;
  • 接口地址: https://ad.oceanengine.com/openapi/doc/index.html?id=1696710747268096


应用管理

【新增能力】查询应用预约记录


广告创意

【新增能力】原生化广告


数据报表

【新增字段】搜索接口支持关键词排名字段


2020年7月1日

尊敬的开发者您好,

为给各位开发者、广告主提供更优质的服务,巨量引擎Marketing API将于北京时间2020年7月2日凌晨01:00-05:00进行系统维护。将造成以下影响:

1-更新期间,所有接口拉取的数据展示会存在延迟;

2-账户和计划新建、账户充值等接口调用可能失败;

3-更新期间内,所有接口的下载服务将不可用。

本次维护不影响在投计划的正常投放,请您提前妥善安排相关工作, 避免上述时间进行接口调用和操作。


2020年6月23日

尊敬的开发者您好,

【重要通知】关于账户管家下线并升级为客户中心账户

管家将于6月30日正式升级为客户中心,历史账号管家数据将迁移至新版平台,届时会下线旧版账户管家平台,为此您需要关注以下几点,为了便于您理解以下将客户中心账户描述为新版管家账户:

1、获取管家列表接口没有变化(/majordomo/advertiser/select/),仅做接口名称变更,查询客户中心下的广告主列表依然使用此接口。

2、此次升级将同步支持一户多开(一个邮箱/手机号开通多个广告账户),并且在新的账号体系下如果advertiser_id没有绑定任何管家账户,6月30日后将自动为此advertiser_id关联上一个新的系统自建的新版管家账户(及客户中心账户),授权时则会变成授权新版管家账户,为此您需要兼容好管家账号的授权场景,如果返回管家账号需要基于管家ID再去查询管家下的广告主列表,如果您原来已兼容了管家场景将无影响;

3、以上变更对于6月30日前已授权的token不受影响,而6月30日后新的授权将走新的客户中心模式(原来授权广告主可能会变成授权客户中心账户,您只需要通过/majordomo/advertiser/select/接口即可查询得到客户中心账户下的广告主列表)。

关于快速上手客户中心和各模块的功能介绍,您可以参考帮助中心 https://e.oceanengine.com/account/page/help;如您遇到问题,可提交工单咨询;


2020年6月21日

尊敬的开发者您好,

为了您更好地使用巨量引擎Marketing API进行开发,我们计划将于6月22日凌晨02:00-02:10;6月23日凌晨02:00-04:00分别进行两次服务升级。

1. 【6月22日】凌晨02:00-02:10时段升级:届时将停止进行有关广告创编的接口调用。

2. 【6月23日】凌晨02:00-04:00时段升级:届时将停止进行计费相关接口(代理商转账,代理商退款,更新账户日预算,更新计划预算,更新计划出价)的接口调用。

请您提前做好应对该次升级的准备,并提前规避上述时段进行操作。此外,GET请求类接口不受本次升级影响,请各位开发者知悉。因服务升级给您带来不便,敬请谅解。感谢您对巨量引擎Marketing API的支持。


2020年6月15日

尊敬的开发者您好,

本期新增青鸟线索通卡券和智能电话组件,查询抖音号id对应的达人信息接口,具体更新如下:

1.【新增能力】青鸟线索通卡券、智能电话组件

2.【新增接口】查询抖音号id对应的达人信息


2020年6月10日

尊敬的开发者您好,

为了提升跨账户管理效率,AD平台为账户操作人提供了一户多开功能,实现一个邮箱 /手机号开通多个广告账户,Marketing API支持用户使用一户多开授权。Marketing API授权是在user纬度,当使用一户多开授权时,实际是授权这个user下管理的所有广告主,后一次授权会覆盖前一次授权结果:

比如user管理了A、B、C账户,第一次授权时,只选择了A,那此次授权的操作范围只能操作A;第二次授权时,只选择了B、C,那第二次授权的范围只能操作B、C,前一次A的授权状态会被覆盖。


本期新增搜索广告增加关键词、删除关键词接口,批量删除视频素材接口,试玩素材推送接口,投放管家支持通投字段,报表接口支持搜索广告枚举值,具体更新如下:

1.【新增接口】搜索广告增加关键词、删除关键词接口

2.【新增接口】批量删除视频素材接口

3.【新增接口】试玩素材推送接口

4.【新增字段】投放管家支持通投字段

5.【新增枚举】搜索广告枚举


2020年6月2日

尊敬的开发者您好,

本期对素材库接口进行字段补齐,具体更新如下:

1.【新增字段】文件名称

2.【新增字段】获取图片/视频素材库字段补齐


2020年6月1日

尊敬的开发者您好,

本期新增第三方落地页管理能力,同时将在6月28日对安卓id&udid&openudid宏参数升级,具体更新如下:

1.【新增能力模块】第三方落地页管理

2.【参数升级】安卓id&udid&openudid宏参数升级

  • 背景:为了涉及数据使用规范性。
  • 升级点:效果广告-应用下载产品-监测宏参数「ANDROIDID1」、「UDID」、「OpenUDID」,自2020年6月28日暂停此字段数据发送,统一优化升级为ANDROIDID字段,同时监测链接会上线校验功能。


2020年5月27日

尊敬的开发者您好,

本期新增视频素材报表接口,视频监测链接补充,转化类型新增店铺停留枚举,具体更新如下:

1.【新增接口】视频素材报表

2.【新增字段】视频监测链接补充

3.【新增枚举】转化类型新增店铺停留枚举


2020年5月22日

尊敬的开发者您好,

本期新增过滤时间范围字段,新增深度优化方式枚举值,另外我们将于6月30日对获取广告创意相关数据增加限制,同时在创编流程对素材所属权做主体校验,具体更新如下:

1.【新增字段】过滤时间范围

2.【新增枚举】深度优化方式

3.【接口限制】获取广告创意数据限制

4.【接口改动】创编流程素材、视频封面素材进行主体校验


2020年5月14日

尊敬的开发者您好,

本期新增投放管家获取项目列表、批量查询计划信息两个接口,同时为方便开发者调用接口,新增可视化调试工具,具体更新如下:

1.【新增接口】获取项目列表

2.【新增接口】批量查询计划信息

3.【新增工具】可视化调试工具


2020年5月12日

尊敬的开发者您好,

本期新增点击监测链接上报方式细分,人群包投放状态细分,具体更新如下:

1.【添加基线】点击监测链接上报方式

2.【添加分组】人群包投放状态


考虑到万花筒创意能力的广泛需求度及您的申请成本,商业开放平台为非服务市场类型的所有APPid批量增加了万花筒接口的一级权限。

您不需要额外在工单向管理员提交关于万花筒接口的权限申请,只需更新授权URL,并对投放帐号/代理商帐号重新授权,即可正常使用万花筒接口能力。


为了保障用户的数据安全,“监测链接” https校验功能已于2020年5月12日完成升级,新建及修改转化目标监测链接增加https校正功能,非https开始链接将无法使用,在投广告使用的非https开头的监测链接暂时不干预,辛苦知悉。


旧转化目标监测链接及“监测链接”校正计划于6月底启动重置上线,涉及模块如下:

  • 新建监测链接需要是https开头
  • 关联转化目标(不分新新旧转化目标)都需要是https开头

建议广告主在此期间尽快启动并完成切换,以防影响后续使用。


2020年5月9日

尊敬的开发者您好,

我们将于5月21日开始,对多合一数据报表接口中素材尺寸的数据,增加时间跨度限制为1个月。

另外因查询广告计划学习期状态独立成单独的接口,可以获取广告计划的学习期状态转换(细分位置:广告投放-广告计划模块-获取广告计划)可以在6月8日下线。

【接口】查询广告计划学习期状态:

请各位开发者尽快修改,以免对您使用造成不便。


2020年5月8日

尊敬的开发者您好,

本期新增一键起量青鸟前端通两大模块,具体更新如下:

1.【添加模块】一键起量

  • 一键起量给广告主提供一个花费可控的激进提价工具,并且通过短时详细数据显示,为广告主提供更多数据价值。
  • 包含接口:启动一键起量,获取起量预测值,获取当前起量状态,获取一键起量的后验数据4个接口
  • 接口位置:工具-一键起量
  • 接口地址: https://ad.oceanengine.com/openapi/doc/index.html?id=1696710736526348

2.【添加模块】青鸟前端通表单组件


2020年5月6日

尊敬的开发者您好,

我们将于本月12日开始,对获取建站列表接口的页面大小更改进行限制,每次最大支持获取500条记录,不再支持获取1000条记录。

请各位开发者尽快修改,以免对您使用造成不便。


2020年4月28日

尊敬的开发者您好,

为了提供更好的素材库接口服务,我们即将本月28日22:00〜22:30时间段对素材库进行升级,届时素材库相关接口会出现部分超时现象,请您合理安排使用素材相关连接的时间,避免报错。

另外为了保障用户的数据安全,“监测链接”将在4月29日上线监测链接https的强校验功能,监测链接都必须使用https。

上线后,Marketing API将无法填充非https开始的检测链接。从而无法创建带有监测链接计划以及转化跟踪。建议开发者在此期间快速启动并完成切换,以防影响后续投放。

注意:2020年4月29日日后,提供的所有监测链接都必须是https的形式,否则将无法填充入后台并保存。


本期新增查询广告计划学习期状态接口,屏蔽词管理接口,另对素材库接口,转换免联调接口优化,同时下线获取广告计划的学习期状态分割,具体更新如下:

1.【添加接口】查询广告计划学习期状态:

2.【添加接口】获取屏蔽词,获取屏蔽词列表,更新屏蔽词,删除屏蔽词

3.【接口优化】素材库优化:

  • 更新内容:获取图片素材库,获取视频素材库优化1)图片素材库增加入参:过滤条件(material_ids和签名)和出参(material_id)2)视频素材库增加入参:过滤条件(material_ids和签名)3)获取图片信息补充出参:material_id4)上传图片接口补充入参:文件_名称和出参:material_id5)上传视频接口添加入参:文件_名称和出参:material_id
  • 接口位置:素材管理-获取图片素材库/获取视频素材库
  • 接口地址: https://ad.oceanengine.com/openapi/doc/index.html?id=1696710599092236

4.【接口优化】转化免联调:

5.【字段下线】获取广告计划的学习期状态

  • 因获取广告计划的学习期状态独立成单独的接口,导致获取广告计划的学习期状态中断下线
  • 细分位置:广告投放-广告计划模块-获取广告计划


2020年4月23日

尊敬的开发者您好,

为丰富的创意接口能力,我们于4月23日上线万花筒创意中心的视频,图片,音频处理能力,帮助您更好的发挥创意,具体更新如下:

1.增加【视频功能】模块,增加视频摘要,视频分解,视频智能裁剪,Topview方式的视频裁剪,视频尺寸缩放5个接口,另为方便各位开发者清晰了解万花筒视频功能模块,微电影接口划入视频能力模块,具体请查看【视频能力】模块

2.增加【图片能力】模块,增加图片超分接口,具体请查看【图片能力】模块

3.增加【音频能力】模块,增加根据音乐风格获取音乐列表,具体请查看【图片能力】模块

联系详情见开发者文档: https://ad.oceanengine.com/openapi/doc/index.html?id=1696710609213455


2020年4月21日

获取万花筒任务信息接口(/万花筒/工作/结果/获取/)增加advertiser_id的必填传参要求,如果您有使用到该接口,请及时添加上advertiser_id的传参,否则将影响调用;


2020年4月3日

尊敬的开发者您好,

我们每月4月30日为获取广告创意相关数据增加限制,届时【按照创意类型过滤拆分将由选填替换必填】,请您尽快进行迁移,具体如下:

  • 涉及接口:广告创意数据接口,多合一数据报表接口
  • 接口地址:open_api / 2 /报告/广告素材/获取/,open_api / 2 /报告/集成/获取/
  • 限制详情:请求参数中creative_material_mode按照创意类型过滤分段由选填变成必填


请您尽快完成相应迁移。

2020年4月1日

行业升级通知:

尊敬的开发者你好,为了更好地契合您的推广目标,巨量引擎广告投放平台从2020年4月1日起,针对广告主行业,创意分类的行业进行了行业升级,增减和变更了部分行业ID,4月1日-5月1日期间对变更的行业会进行兼容不会对你的调用产生影响,通过ools /工业/获得/(获取行业列表)接口你将能得到最新的行业列表,和获取行业列表接口传参没有任何变化,可参考以下场景判断你是否需要做开发兼容:


在为代理商账号创建广告主,或者创建创意选择创意分类时:

1,如果您是实时获取工具/行业/ get /接口选择最新行业的话,那么将有很好的扩展性,新建是用的是最新行业将不会受到影响;

2,如果您离线存了行业ID,请确保更新为最新的行业,在4月1日-5月1日期间如果使用到已终止行业会持续兼容,但5月2日后将不再支持无效行业;


建议在涉及行业选择时都采用实时调用牛逼的方式 /行业/获得/(获取行业列表) 的方式,具有更强的扩展性,对于后续的行业调整也能同步实施,避免使用离线存储行业列表的方式,如有问题可提交工单 与我们联系。


2020年3月27日

尊敬的开发者您好,我们于3月27日上线支持投放管家,抖音粉丝定向获取类目及推荐达人,具体更新如下:

1.增加【投放管家】模块,包含创建项目,项目修改,项目查询,计划分析报表四大部分,一共包含14个接口,具体查看【发布管家】模块

2.【工具-查询工具】添加支持音迷定向获取类目及推荐达人

  • 新增查询抖音类目列表,查询抖音类目下的推荐达人两个接口
  • 接口地址:tools / aweme_multi_level_category / get /,工具/ aweme_category_top_author / get /

联系详情见开发者文档: https://ad.oceanengine.com/openapi/doc/index.html?id=1696710656912399


2020年3月4日

重要下线通知:现在行为兴趣定向站内已经全量上线,计划相关接口将逐渐下线旧版行为定向(app_behavior_target,app_category,app_ids)和兴趣定向(ad_tag,interest_tags),api,次会进行进行而改为,限制限制于3月18日生效,请尽快进行迁移,具体调整如下:


注:穿山甲计划将继续使用旧版行为定向和兴趣定向,且穿山甲计划不支持新版行为兴趣

广告投放范围选择“ DEFAULT”,将不支持使用旧版的APP行为定向和兴趣定向转化,以及包含旧版转化定向包:

  • 涉及接口:创建广告计划,修改广告计划
  • 旧版版本:兴趣分类ad_tag,兴趣关键字interest_tags,APP行为定向app_behavior_target,行为定向分类app_category,APP集合app_ids
  • 新版版本:行为兴趣选择interest_action_mode,行为场景action_scene,行为天数action_days,行为类目action_categories,行为关键字action_words,兴趣分类interest_categories,兴趣关键字interest_words
  • 具体变动:

定向选择相关-投放范围选择替代“ DEFAULT”,将不再支持使用以上五个旧版版本

定向包相关-发射范围选择替代“ DEFAULT”,包含五个旧版本更改的定向包也不再支持使用(穿山甲可正常使用)


2020年2月24日

新增支持搜索广告的否定词管理功能,可通过API进行否定词的补充,更新和查询,具体更新如下:

1.增加【搜索广告-否定词管理】模块,包含以下三个接口:

  • 新增批量补充否定词接口,批量更新否定词接口,查询否定词接口
  • 接口地址:工具/专用字/添加/,工具/专用字/更新/,工具/专用字/选择/


2020年2月21日

新增支持获取素材报表和抖音粉丝定向,具体更新如下:

1.【数据报表-多合一数据报表】接口添加支持素材报表:

  • 接口地址:报告/集成/获取/
  • groupby分组条件分割新增支持素材纬度的聚合
  • 过滤过滤添加添加支持按素材id过滤

2.新增支持抖音粉丝定向

  • 【广告计划-创建/修改广告计划】接口,添加额外的抖音用户行为,抖音号,抖音分类
  • 【定向包管理-创建定向包】接口,添加额外的抖音用户行为,抖音号,抖音分类

3.【工具-查询工具】模块添加以下两个接口:

  • 【查询抖音帐号和类目信息】接口,接口地址:tools / aweme_info_search /
  • 【查询抖音相似账号】接口,接口地址:tools / aweme_similar_author_search /


2020年2月20日

建站管理模块更新:

1.【建站管理-落地页管理-创建站点】【建站管理-落地页管理-修改站点】接口更新:

  • 接口地址:工具/网站/创建/,工具/网站/更新/
  • 新增支持富文本组件,组图组件,表单组件,按钮组件新增支持智能电话;

2.【建站管理-落地页管理】模块添加接口:

  • 新增查询表单详情接口,查询现有表单接口,查询现有电话接口
  • 接口地址:工具/线索/表格/详细信息/,工具/线索/表格/获取/,工具/线索/智能电话/获取/

3.新增【建站管理-落地页组管理】模块:

  • 新增创建落地页组,获取落地页组,更新落地页组站点状态,更新落地页组信息
  • 接口地址:tools / landing_group / create /,tools / landing_group / get /,tools / landing_group / site_opt_status / update /,tools / landing_group / update /


2020年2月10日

数据上报管理-移动应用API上报数据-监控链接发送服务恢复支持geoo宏指令。


2020年1月17日

1.应用api检测链接下一个起点从12月23日开始不再支持uuid宏参数替换替换。从1月16日开始将不再支持该局部替换。补充部分文档内部嵌套会存在空值的下发说明。

2.临时不支持geoo分割宏参数替换,文档内部删除该分段信息。

3.搜索广告相关细分功能增加,具体更新如下:

-广告/创建,广告/更新,广告/获取接口添加intelligent_flow_switch智选流量细分

-创意类型image_mode添加TOUTIAO_SEARCH_AD_IMAGE搜索大图,SEARCH_AD_SMALL_IMAGE搜索小图类型

-投放位置inventory_type添加INVENTORY_AWEME_SEARCH搜索广告抖音位,INVENTORY_SEARCH搜索广告今日头条位,投放时必须必须都传值

4.信息流广告投放添加行动号召,门店活动相关功能,具体更新如下:

-广告素材/获取,创意/创建,创意/更新_v2接口添加action_text行动号召回

-查询工具添加工具/ action_text / get行动号召内容获取接口

-广告/创建,广告/获取添加storepro_pack_id活动id细分

-查询工具添加工具/广告商_商店/搜索包/查询门店活动接口

5.获取定点包接口,再添加delivery_range范围内的过滤条件,添加精选流量包,定向流量包,排除流量包返回参数


2020年1月14日

1.16号本周四将上线搜索广告投放相关功能,广告位inventory_type添加“ INVENTORY_SEARCH”今日头条,“ INVENTORY_AWEME_SEARCH”抖音广告位,历史对接搜索广告的开发者,若未传出inventory_type会报错误无法转移,请尽快调整,inventory_type需传[“ INVENTORY_SEARCH”,“ INVENTORY_AWEME_SEARCH”]


2020年1月13日

1.支持游戏试玩素材上传功能,具体更新如下:

-游戏试玩素材的上传需要经历上传,校验,保存三个步骤

-新增/工具/可播放/上传/试玩素材上传接口

-新增/工具/可播放/验证/试玩素材校正结果接口

-新增/工具/可播放/保存/试玩素材保存接口

2.扩展人群包接口增加扩展范围量,添加垂直范围,具体更新如下:

-/ dmp / custom_audience / lookalike /接口请求参数lookalike_num扩展数量修改范围大小,添加is_contain_seed是否保留人群包种子和app_platform扩展流量位置

3.新增获取建议的功能,具体更新如下:

-/ tools / bid / suggest /接口请求参数添加bid_mode更改方式转换,返回参数添加建议日预算,预期成本范围等变量


2020年1月2日

1. 1.3日将上线新版授权体系,具体更新如下:

-支持多帐户角色授权:若登录帐户为代理商帐户,会根据当前登录的代理商角色,返回有权限的代理商帐户,选择需要授权的代理商帐户即可完成授权。 A,A具有一代账户a,b,c和二代账户1、2、3的权限,列表会返回a,b,c,1、2、3三个代理商账户,用户可多选账户进行收入,如选择a,c,1,完成授权即拥有a,c,1的代理商功能和管理a,c,1绑定的广告主功能


-一个令牌可用于多帐户管理,新版授权体系下,一次性授权的多帐户共用一个令牌

-统一帐户下增加的授权帐户等于在重新授权历史已授权帐户,若当前登录帐户已有帐户授权给appid,再次登录增加新帐户授权时,该帐户下历史已授权的帐户会被重新授权,生成新代币

-添加oauth2 / advertiser / get /接口,用于查询令牌可管理的广告主或代理商id,历史授权帐户无法使用该接口查询

-已授权应用管理页面可查看账户下给appid授权的全部账户,支持一键解除授权


2.管家账户,直客广告主授权流程无变化

巨量引擎广告投放平台-“转化追踪”于1月7日20:00-1月8日12:00进行系统维护,期间无法操作api修改下载链接,监测链接等功能。请广告主提前安排好账户广告计划。如果出现功能不可操作提示,请耐心等待,1月8日12:00后可恢复正常操作。


2019年12月19日

1.多合一数据报表报告/集成/获取/接口功能优化,具体更新如下:

-请求参数变更:分组条件group_by细分组合规则变更,按转化成本过滤细分conversion_cost更名为convert_cost,旧名称恢复2020年1月19日下线,详情请参见开发文档

-请求参数添加:过滤条件filtering细分下,另外按广告组id过滤细分campaign_id,按creative_id过滤替换creative_id等六个二级细分,详情请参见开发文档


2.增加支持获取分级模糊数据功能,更新如下:

-数据报表添加报告/错误/获取/获取分级模糊数据接口,接口详情参见开发文档


2019年12月12日

数据上报管理-移动应用SDK上报数据方案说明完成整体更新:

1.安卓SDK3.3.12版本与iOS SDK3.2.9版本完成CDN上传,对接说明下载地址完成更新

2.安卓版SDK使用说明,针对厂商安卓Q版做整体更新,接口与分段完成调整调整,详情见使用说明

3.iOS版SDK使用说明,初始化及play_session调整,需在初始化是手动配置打开心跳事件play_session上报,用于游戏时长统计,详情参见使用说明

4.SDK 数据上报测试&实际应用,对接流程根据新版转化工具箱做对应更新调整


2019年12月4日

1. 新增投放资质接口查询替代老接口,对部分资质信息进行字段更新,相关更新如下:

- /advertiser/qualification/select/获取投放资质接口即将废弃(12.12号),新增/advertiser/qualification/select_v2/接口,请开发者尽快迁移

-/advertiser/qualification/create/新增投放资质接口新增ad_qualification_type资质图片类型字段

-工具/file/image/advertiser/上传广告主图片接口对upload_to调用上传资质字段进行了修改


2. 多合一数据接口功能优化,具体更新如下:

- report/integrated/get/请求参数新增fields指定返回指标字段

- 返回参数中stat_time更名为stat_datetime、conversion_cost更名为convert_cost、conversion_rate更名为convert_rate,旧名称下线时间12.20日


3. async_task/create/创建异步任务接口请求参数新增fields指定返回指标字段


2019年12月2日

数据报表新增接口:新版代理商报表。

新版代理商报表接口更新内容如下,旧版代理商数据报表需要废弃,废弃时间为2019年12月23日。


1. 代理商接口地址变更

- 新版代理商接口的请求地址由【https://ad.oceanengine.com/open_api/2/report/agent/get/】变更为 【https://ad.oceanengine.com/open_api/2/report/agent/get_v2/】

2. 代理商请求参数变更

- 代理商ID由advertiser_id字段变更为agent_id字段

- start_date字段和end_date字段两个字段由【必填】变为【可选】,当查询今天的实时数据时,这两个字段都不能填。

- 取消原有的分组条件group_by字段和时间粒度time_granularity字段

- 新增filtering字段来进行条件筛选,并在filtering字段下增加 广告主id字段advertiser_ids、广告主公司名称字段company_name等9个二级字段用于进一步条件筛选。

3. 代理商应答参数变更

- 原有字段即将全部废弃,变更为代理商id字段agent_id、代理商名称字段agent_name、账户id字段advertiser_id等54个新的字段,具体请查看新版代理商接口的应答参数表。

4. 附录枚举值新增

- 新增附录枚举值【账户类型】、【账户状态】。


2019年11月27日

1. 工具上线异步全量任务功能,发布离线任务来处理批量历史数据请求,数据请求方式和返回参数同实时接口保持一致,相关更新如下:

- 新增async_task/create/创建异步任务、async_task/get/查询异步任务状态、async_task/download/下载异步任务三个接口

- 附录枚举值新增枚举值【异步任务状态】、【异步任务分组条件】

2. 由于巨量引擎域名由ad.toutiao变更为ad.oceanengine,商业开放平台所有接口的请求地址域名将做同步变更,如计划获取接口请求地址将由【 https://ad.toutiao.com/open_api/2/ad/get/】变更为【https://ad.oceanengine.com/open_api/2/ad/get/】,其他接口同理,当前新域名接口已正式使用,请您尽快迁移新域名,您可将所有接口请求域名的ad.toutiao做批量替换,我们将于11.30号下线ad.toutiao域名。

新域名地址:https://ad.oceanengine.com/,旧域名: https://ad.toutiao.com/将废弃不再使用,请各位开发者尽快将接口请求地址更换为新域名地址。


2019年11月20日

1. 应用推广支持应用商店直投,相关更新如下:

- /ad/create/、/ad/update/请求参数新增download_mode下载模式字段

- /ad/get/返回参数新增download_mode下载模式字段

2. 工具-查询工具新增行为兴趣关键词id转词接口、新增行为兴趣关键词推荐词接口

- 查询工具新增/tools/interest_action/id2word/关键词id转词接口

- 查询工具新增/tools/interest_action/keyword/suggest/查询行为兴趣关键词推荐词查询接口

3. ad/get接口新增返回参数learning_phase,用来标示计划学习期详细状态


2019年11月17日

1. 账号管理上线广告主账号头像管理相关接口,详情如下:

- 广告主信息与资质管理新增advertiser/avatar/submit/头像上传、更新接口

- 广告主信息与资质管理新增advertiser/avatar/get/获取广告主头像接口

- 广告主需要在及时上传头像,才能进行创意的修改及创建。如果账户头像为空,将无法新建、修改创意。(该逻辑将在12月3号生效)


2.巨量引擎所有接口请求地址域名将由ad.toutiao变更为ad.oceanengine

由于巨量引擎域名由ad.toutiao变更为ad.oceanengine,商业开放平台所有接口的请求地址域名将做同步变更,如计划获取接口请求地址将由【 https://ad.toutiao.com/open_api/2/ad/get/】变更为【https://ad.oceanengine.com/open_api/2/ad/get/】,其他接口同理,当前新域名接口已正式使用,请您尽快迁移新域名,您可将所有接口请求域名的ad.toutiao做批量替换,我们将于11.30号下线ad.toutiao域名。

新域名地址:https://ad.oceanengine.com/,旧域名: https://ad.toutiao.com/将废弃不再使用,请各位开发者尽快将接口请求地址更换为新域名地址。


2019年10月31日

1. 平台上线新版频控限制,详情请参阅文档: https://openapi.bytedance.net/openapi/doc/index.html?id=412

- 新版频控分为四个等级,包括了qps、分钟限制、天限制三种限制

- 针对不同的接口频控限制不同

2. 支持roi出价系数修改

- ad/update/接口新增roi_goal字段

3. inventory_type投放位置新增穿山甲-精选休闲游戏广告位

-creative/create_v2/、creative/update_v2/、creative/get/、报表相关接口支持UNION_BOUTIQUE_GAME穿山甲-精选游戏广告位


2019年10月25日

1. 行为兴趣定向新增兴趣、行为关键词查询接口,具体更新如下:

- 查询工具新增/tools/interest_action/action/keyword/行为关键词、/tools/interest_action/interest/keyword/兴趣关键词查询接口

2. 创意相关接口新增程序化创意包id

- 查询工具新增/tools/procedural_package/get/程序化创意包id查询接口,具体更新如下:

- /creative/create_v2/、/creative/update_v2/、/creative/read_v2/接口新增procedural_package_id程序化创意包id字段

3. 创意相关接口新增图片生成视频功能,具体更新如下:

-/creative/create_v2/、/creative/update_v2/、/creative/read_v2/接口新增is_presented_video启用图片生成视频字段

4. /tools/ad_convert/create/转化id推送接口新增返回参数转化id

5. advertiser/qualification/delete/删除广告主资质接口已下线


2019年10月18日

1. 评论管理相关接口进行优化,具体更新如下:

- tools/comment/get/评论获取接口返回参数新增评论回复量、评论发布者是否黑名单等字段

- reply_infos二级评论字段将于10.28号下线,由新接口tools/comment_reply/get/替代

- 新增tools/comment_reply/get/评论回复获取接口

2. 建站相关接口进行优化,具体更新如下:

- tools/site/create/创建站点
a. 视频组件: local_source中的poster封面图片支持传图片url/图片id. 获取详情的时候,此字段返回的都是图片对应的链接
b. 图片组件: 增加image_url字段; image_url字段与ic_id字段须传其一
- tools/site/read返回字段由原来的驼峰式,改成a_b式
- tools/site/get/获取建站列表, total_number字段类型改成int, status调整显示为英文枚举值,siteType改成英文枚举


2019年10月17日

1. 新增定向包相关接口、新增手机价格、行为兴趣等定向

-工具新增/audience_package/get/获取定向包、audience_package/create/创建定向包、/audience_package/update/更新定向包、audience_package/delete/删除定向包接口

- 工具新增/audience_package/ad/bind/计划绑定定向包批量接口、audience_package/ad/unbind/定向包解绑计划批量接口

- 工具-查询接口新增/tools/interest_action/action/category/行为兴趣定向类目查询接口、/tools/interest_action/interest/category/行为兴趣定向兴趣类目查询接口

- /ad/create/、/ad/update/、/ad/get/接口新增定向包id字段、手机价格定向、行为兴趣定向、地域定向地图模式、抖音推广相关定向等

- 附录枚举值新增定向包推广类型、行为场景、荣耀手机品牌定向


2019年9月26日

1. 新增多合一数据报表接口(目前仅支持搜索广告关键词、搜索词数据)

-新增report/integrated/get/接口,可以查询关键词、搜索词报表数据,支持多种维度聚合,并返回展示、点击、转化等数据

-附录新增【多合一报表分组条件】

2. ad/create接口支持CPA出价方式

-出价字段新增CPA类型 pricing="PRICING_CPA"
-CPA广告计划限制
a. 仅销售线索类型campaign支持CPA出价,landing_type="LINK"
b. convert_id字段必传
c. bid必传


2019年9月22日

1. 视频信息返回素材id和视频来源

-file/video/get/接口新增返回参数material_id(素材id)和source(视频来源)字段

-/file/video/ad/get/接口新增返回参数material_id(素材id)

-枚举值新增素材来源


2019年9月11日

1. 创建组、计划接口支持状态修改

- campaign/create/、/ad/create/接口新增operation字段,支持设置开启、关闭状态

2. 深度转化目标注册行为下线

- 深度转化目标枚举值AD_CONVERT_TYPE_ACTIVE_REGISTER下线,不再支持激活且注册行为


2019年9月6日

1. 计划相关接口支持ROI出价系数

- ad/create、ad/get新增roi_goal ROI出价系数字段,deep_bid_type为'ROI_COEFFICIENT'时可传

- deep_bid_type深度优化方式新增枚举值'ROI_COEFFICIENT'-ROI系数,'ROI_PACING'-自动优化

2. 新增计划、创意审核建议获取接口

- 优化了审核建议内容返回,原字段audit_reject_reason将废弃

- 新增ad/reject_reason/获取计划审核建议、creative/reject_reason/获取创意审核建议接口,支持批量查询,只有审核拒绝的内容才会返回审核建议(拒审理由)


2019年8月30日

1. 新增橙子建站相关接口,提供通过接口数据生成落地页的能力,落地页仅支持流式布局,支持图片、文本、按钮、视频等普通组件,支持根据数据落地页新建、修改 、查看详情、预览、发布,支持落地页列表查询,具体更新如下:

- 新增tools/site/create/创建站点、/tools/site/update/修改站点、/tools/site/update_status/更新站点状态、/tools/site/preview/获取站点预览地址、/tools/site/read/查询站点详情接口

- 枚举值新增【站点操作状态】、【站点状态】、【站点组件浮动方式】

2. DMP规则人群包新增精准定向规则

- dmp/custom_audience/rule/接口请求参数新增profiles字段-精准定向规则、is_publish_auto是否自动发布字段

- 规则类型为 ENGAGEMENT(精准广告) 时,新增广告行为、次数、次数类型等字段

- 枚举值【DMP 规则类型】新增ENGAGEMENT(精准广告)


2019年8月21日

1. 素材库相关接口进行优化

- 改善了图片、视频素材通过API上传无法同步到素材库的问题,符合素材库规格标准的素材通过API上传可直接同步到AD投放平台素材库

2. 下线通知

- agent/advertiser/create/接口中的行业1.0字段(industry)将在8月31号下线


2019年8月12日

1. 穿山甲流量包新增创建、修改、删除接口,新增rit数据查询接口
- 新增tools/union/flow_package/create/、tools/union/flow_package/update/、tools/union/flow_package/delete/接口,可进行创建、修改、删除穿山甲流量包
- 新增tools/union/flow_package/report/接口,可以查询穿山甲各广告位消耗、次留等数据
2. 新增日志查询接口,默认查询历史7天数据,最长跨度半年
- 新增tools/log_search/接口,可根据组、计划、创意id查询详细操作日志


2019年8月2日

1. 定向功能新增智能放量、穿山甲设备定向相关字段
- ad/create、ad/update、ad/get接口field(查询字段集合)请求参数新增device_type(设备类型)、auto_extend_enabled(是否启用智能放量)、auto_extend_targets(可开放定向类型)字段
- 枚举值新增auto_extend_targets(可开放定向类型)枚举值,详情参阅【附录-可开放定向】
2. dpa商品定向新增定向维度,投放类型支持商品库视频模板
- ad/create、ad/update、ad/get接口field(查询字段集合)请求参数新增dpa_lbs(LBS定向)、dpa_city(商品城市市级)、dpa_province(商品城市省级)、dpa_recommend_type(dpa商品重定向推荐类型)字段
- creative/create_v2/接口程序化创意image_list和视频创意新增dpa_template(商品库模板视频)字段


3. 广告主、组、计划、创意数据报表相关接口增加参数返回、丰富了分组聚合维度和查询维度
- report/advertiser/get/、report/campaign/get/、report/ad/get/、report/creative/get/接口请求参数增加group_by聚合维度,filtering(过滤条件)新增pricing(出价类型)、image_modes(素材类型)等多种过滤条件。
- report/advertiser/get/、report/campaign/get/、report/ad/get/、report/creative/get/接口返回参数新增next_day_open(次留数)、gender(性别)等多种数据维度指标
- 枚举值新增group_by(分组条件)多种类型,详情参阅【附录-分组条件】


2019年7月18日

文档请求示例增加java、php代码示例


新增极速下载列表查询接口,具体更新如下:

1. 工具-查询工具新增极速下载列表获取接口,可获取头条提供的CDN服务


新增飞鱼线索管理接口,具体更新如下:

1. 工具新增获取线索列表接口

2. 工具新增回传有效线索接口


自定义人群包新功能上线通知(25号全量,API编辑时如果有旧的逻辑,会有系统报错):

人群包定向排除功能调整:
定向:定向功能中(包括定向与同时定向排除中的定向池),同一个来源的第三方人群包可以和一二方包同时选择
排除:排除功能中(包括排除与同时定向排除中的排除池),任何时候都不支持选择第三方人群包
已建的定向包在180天内无消耗或者未使用的人群和人群标签将不可用,系统会自动清理这些标签


2019年7月10日

增加广告评论管理功能,具体更新如下:

1. 工具新增评论查询接口,可以查询广告评论内容

2. 工具新增评论操作接口,可以快速回复、管理相关广告评论


2019年7月1日

代理商相关接口升级优化,具体更新如下:

1. 创建广告主新增广告主类型:头条广告主、鲁班广告主

2. 获取二代列表接口请求参数增加一代id

3. 新增代理商信息查询接口


2019年6月20日

创意相关接口新增游戏试玩素材添加,相关更新如下:

1. 创建/修改/获取广告创意支持添加游戏试玩链接

2.工具新增获取游戏试玩素材详情接口


推广目的新增抖音号推广类型,相关更新如下:

1.创建广告组landing_type新增允许值AWEME

2.计划相关接口新增抖音号推广相关字段

3.创意相关接口新增抖音号推广相关字段

4.工具新增绑定抖音号查询接口


新增广告预览相关接口,相关更新如下:

1.工具新增广告预览接口,可获取到对应的计划/创意预览二维码链接


2019年6月12日

转化相关服务升级,兼容新版投放平台转化服务,增加转化名称25字限制、增加下载链接https请求限制(7.2号API侧启用)

推广目的类型支持电商店铺推广,相关更新如下:

1. 创建广告组landing_type新增允许值SHOP

2. 计划相关接口新增电商店铺转化目标类型

3. 创意相关接口新增电商店铺类型请求参数

4.枚举值新增【附加创意-电商卡片】、【电商卡片类型】、【电商卡片按钮文案类型】、【电商卡片出现时间类型】、【转化类型-调起店铺】

查询工具新增鲁班商品信息查询接口,具体更新如下:

1. 新增鲁班商品详情查询工具

2.枚举值新增【商品支付方式】、【商品业务类型】、【商品审核状态】、【商品上下架状态】


2019年5月31日

新增快速入门之广告投放示例demo,跟踪应用直达功能开放权限,面对所有广告主开放。具体更新如下:

1. 工具辅助--快速入门增加创建、修改计划、创意示例代码

2. 跟踪应用直达功能开放权限,面对所有广告主,鼓励ocpm计费方式的使用,有利于提高调起类广告的转化率,相关文档请查阅【数据上报管理-移动应用API上报数据-跟踪应用直达/下载】


2019年5月29日

推广目的类型支持门店推广,相关更新内容如下:

1. 工具新增查询广告主门店接口【/tools/advertiser_store/search/

2. 创建广告组landing_type新增允许值STORE

3. 创建广告计划请求参数新增门店ids字段和门店类型字段

4. 广告详细信息返回参数新增门店ids



2019年5月20日

新增动态商品广告相关接口,如果你要投放产品目录广告(简称DPA)首先需要有改投放的权限,可联系对接运营同学了解,创建DPA广告组、计划、创意与其他类型的广告有着部分区别。

新增内容:

1.ad/create新增DPA相关字段

2.ad/update/新增DPA相关字段

3.ad/get/新增DPA相关字段

4.creative/create_v2/新增DPA相关字段

5.creative/update_v2新增DPA相关字段

6.creative/read_v2/新增DPA相关字段

7.新增获取DPA商品库信息接口

8.新增获取DPA分类接口

9.新增获取DPA可用行为接口

10.新增获取DPA模板接口

11.新增获取DPA词包接口


2019年5月8日

1.创意视频增加同步功能

【creative/create_v2/】、【/creative/update_v2/】新增视频封面和标题同步到图片创意接口


2.上传视频接口返回视频信息

【file/video/ad/】返回参数新增width、height、url、文件大小、时长字段


3.人群包详细信息返回参数新增推送状态push_status、创建时间create_time、更新时间modify_time、几方包

【dmp/custom_audience/read/】返回参数新增推送状态push_status、创建时间create_time、更新时间modify_time、几方包


4.广告主公开信息返回参数新增注册时间

【/advertiser/info/】 返回参数新增注册时间


5.过滤已转化用户枚举值更改

【hide_if_converted】增加枚举值:公司账户


6.Ios和Android支持到最新版本

版本号已支持到最近,相关枚举值请查看附录


7.计划相关接口支持自动出价

ad/create、ad/get接口新增smart_bid_type和adjust_cpa自动,支持计划自动出价。


2019年4月17日

1.新增获取账户日预算接口

新增advertiser/budget/get/ 接口,支持获取广告主的账户日预算设置。


2.新增计划诊断获取接口

新增tools/diagnosis/ad/get/tools/diagnosis/ad/curve/ 接口,支持获取计划诊断的详情以及预估变化趋势。


3.工具辅助版块新增快速入门工具

新增快速入门工具,目前支持数据报告,你可以在可视化界面完成广告各版块设置后一键生成样本代码,例如要查询一个时间段应用下载类型所有包含已删除计划的分日数据,只需要在页面做简单选择就可以生成后端的示例传参代码,帮助你更快的了解传参方式。


2019年3月31日

1.查询受众预估和查询建议出价接口更新至最新定向条件

tools/estimate_audience/ tools/bid/suggest/ 更新至最新定向条件,新增字段如下:定向人群包、排查人群包、安卓版本、文章分类、地域类型新增商圈、兴趣分类、兴趣关键词、精选流量包、定向流量包、排查流量包字段、DPA定向人群包、DPA排查人群包。


2.查询应用信息接口支持按APPID查应用

tools/app_search/ 接口 新增search_by查询条件,支持按应用名称或应用ID搜索。


3.campaign、ad相关接口新增unique_fk支持第三方唯一键设置,幂等校验

campaign/create、campaign/get、ad/create、ad/get接口新增unique_fk第三方唯一键,传该值时保证接口重试的幂等性,带有相同unique_fk的请求服务端会视为同一个广告处理。仅在创建接口传入且无法修改,如果创建时传入了已存在的唯一键值,那么会返回该唯一键值所对应的广告组ID/计划。

该值可用于内部系统会生成的唯一ID与头条ID做关联的场景,避免超时重试实际上一次创建请求又成功导致的重复创建问题,通过unique_fk可与内部系统ID实现关联并避免重复创建,可结合实际场景选择使用,unique_fk要求不重复。


4.人群包运算接口上线支持人群包合并

dmp/custom_audience/calc/接口 上线,当前仅支持人群包的合并。


5.创意相关接口广告位支持场景广告位

creative/create_v2、creative/update_v2、creative/read_v2新增scene_inventory,支持按场景设置广告位,使用场景广告位时默认忽略inventory_type字段,与scene_inventory不能同时传。


2019年3月14日

1.新增新版资质查询和提交接口

由于全平台开户资质的改版升级,原有服务将在30号停止,新版资质获取和提交接口将支持后续的资质查询和创建/更新,请您及时转移:

  • 新增advertiser/qualification/get/接口,支持获取广告主开户资质,请注意新创建的资质只可用新接口获取得到,历史资质将在18号完成同步,同步后也可使用新接口获得
  • 新增advertiser/qualification/submit/接口,支持提交资质,为全量接口同时支持创建和更新,如果还无资质则是创建,如果已有资质则是更新


2.工具上线开源库功能

工具新增开源库,开源计划旨在为你提供常见的API应用功能的解决方案,如批量投放功能,利用通用的开源代码,你只需要结合内部的特殊应用需求做定制化处理,可以帮助你更快捷的实现后端功能逻辑,当前支持批量投放助手的Python开源代码,可点此查看


3.创意相关接口新增衍生计划

  • creative/create_v2, creative/read_v2, creative/update_v2接口新增generate_derived_ad衍生计划字段,默认为不启用


4.计划相关接口新增商圈

  • ad/create、ad/get、ad/update三个接口地域类型新增商圈类型(BUSINESS_DISTRICT),并且地域列表支持商圈ID(business_ids)填写
  • 新增tools/region/get/接口,支持查询商圈ID列表


5.计划相关接口支持使用穿山甲自定义流量包

  • ad/create、ad/get、ad/update三个接口支持使用穿山甲自定义流量包,新增flow_package(定向流量包ID数组)和exclude_flow_package(排查流量包ID数组)字段
  • 新增tools/union/flow_package/get/接口,支持查询已创建的穿山甲自定义流量包列表


2019年3月1日

1.新增更新账户日预算接口

2.计划相关接口新增深度优化方式字段

3.计划相关接口穿山甲广告新增精选流量包、穿山甲视频创意类型字段

  • ad/get/ad/create/ ad/update/ 接口新增 union_video_type(穿山甲视频创意类型)、superior_popularity_type(精选流量包)字段


2019年1月21日

1.应用下载类型计划新增下载方式字段

投放平台针对应用下载类型的计划做了调整,新增应用下载方式字段,API支持如下:

  • ad/getad/create接口新增download_type(应用下载方式)字段,当推广目的是应用下载即landing_type=APP时要求传此字段,默认为按下载链接方式。可选值:DOWNLOAD_URL(下载链接,默认),EXTERNAL_URL(落地页链接)
  • 兼容方案:API将继续兼容老的创建方式持续到2月20日,期间API针对推广目的是落地页类型的计划依然可以选择应用下载类型转化,但是希望您尽快转移至新的字段,在应用下载推广目的的计划中通过使用download_type字段来满足创建落地页投应用下载需求。


2.广告主行业和创意分类的行业升级,新增查询行业列表接口

投放平台针对广告主行业和创意分类的行业做了升级,为此API分别新增了两个字段来帮助你过渡成新行业,并且新增了tools/industry/get/(获取行业列表)接口,老行业将进行兼容一段时间持续到2月20日

  • agent/advertiser/create/ 接口新增second_industry_id字段(替换原有的industry),需要填写二级行业ID,可从tools/industry/get/ 接口获取
  • advertiser/info/ 接口新增first_industry_name(一级行业名称)和second_industry_name(二级行业名称)的返回,替换原有的industry字段
  • creative/create_v2/ creative/read_v2/ creative/update_v2/ 接口新增third_industry_id字段(替换原有的ad_category),此处创意分类填写的是三级行业ID,可从tools/industry/get/ 接口获取
  • 新增 tools/industry/get/获取行业列表)接口,通过接口可以获取到一级行业、二级行业、三级行业列表,其中代理商创建广告主时使用的是二级行业,在创建创意填写创意分类时使用的是三级行业,请注意区分


3.广告位中的 信息流和详情页合并为头条系

当前API与投放平台进行了统一,广告位中的信息流(INVENTORY_FEED)与详情页(INVENTORY_TEXT_LINK)已合并为头条系(依然使用INVENTORY_FEED字段,名称更改为头条系),详细内容如下:

  • creative/create_v2/creative/update_v2/ 接口的inventory_type字段不管是传INVENTORY_FEED或者INVENTORY_TEXT_LINK任意一个字段都按INVENTORY_FEED头条系进行上传,建议您只传INVENTORY_FEED字段,2月20日后将逐渐下线INVENTORY_TEXT_LINK字段
  • creative/read_v2/ 接口的inventory_type字段针对历史创意如果有投放信息流或者详情页任意一个都只返回INVENTORY_FEED头条系 字段


2019年1月16日

1.新增沙箱环境

为了便于您更安全地进行API调试,我们为您提供了沙箱环境,该环境下所有接口的请求主域为"https://test-ad.toutiao.com/open_api/"(正式环境为https://ad.toutiao.com/open_api/)。沙箱环境下的所有信息与正式环境是完全隔绝的,您可以放心地进行各种API调用,而不会对您的真实线上帐号产生影响,并且沙箱环境的广告也不会被曝光、点击或产生费用。

当前沙箱环境只支持账号服务、广告投放、数据报表这三个类型接口的测试联调(请注意其中文档中标记为已废弃的接口以及获取管家列表majordomo/advertiser/select/接口不支持沙箱联调),其他接口的沙箱支持我们在紧锣密鼓的开发中,敬请期待!


2.代理商转账/退款接口新增金额类型,支持选择是转现金还是赠款

  • agent/advertiser/recharge/agent/advertiser/refund/接口新增transfer_type转账类型字段,支持选择是现金转账还是赠款转账,退款同理。枚举值:CASH(现金),GRANT(赠款)
  • 提醒:代理商如果使用了转账退款接口,请尽快调整上传最新的transfer_type字段,历史转账会按一定的规则和比例进行转账,新功能上线后需要您实际选择是希望转现金还是赠款,在1月31日之前如果不传transfer_type我们将按历史逻辑处理,在31日后如果不传transfer_type将默认优先转现金,请您尽快调整。

3.report接口增加名称加上一级ID和名称返回

  • report/campaign/get/增加广告组名称(campaign_name)返回
  • report/ad/get/增加计划名称(ad_name)、所属广告组ID(campaign_id)、广告组名称(campaign_name)返回
  • report/creative/get/增加所属计划ID(ad_id)、计划名称(ad_name)、广告组ID(campaign_id)、广告组名称(campaign_name)返回

4.creative/get接口优化支持更多过滤条件

  • creative/get/完善过滤条件,增加广告组推广目的、出价方式、创意状态、创意素材类型过滤

5.列表和报表接口状态默认值统一,新增所有不包含已删除状态枚举

  • campaign/get/report/campaign/get/:广告组状态过滤不传默认返回【所有不包含已删除】广告组,广告组状态过滤新增CAMPAIGN_STATUS_ALL(所有包含已删除)、CAMPAIGN_STATUS_NOT_DELETE(所有不含已删除)两个选项,详见附录-广告组状态
  • ad/get/report/ad/get/:广告计划状态过滤不传默认返回【所有不包含已删除】计划,计划状态过滤新增AD_STATUS_ALL(所有包含已删除)、AD_STATUS_NOT_DELETE(所有不含已删除)两个选项,详见附录-广告计划状态
  • creative/get/report/creative/get/:广告创意状态过滤不传默认返回【所有不包含已删除】广告创意,广告创意状态过滤新增CREATIVE_STATUS_ALL(所有包含已删除)、CREATIVE_STATUS_NOT_DELETE(所有不含已删除),详见附录-广告创意状态

6.列表和报表接口过滤条件支持name名称搜索


2018年12月27日

1.接口权限细分

本次对权限进行了重新定义和细分,由原来的四大权限(账号服务、广告投放、DMP人群包管理、数据报表)进行权限细分,并且新增【工具】权限点,对于历史APPID的权限会做如下处理:

  • 历史APPID如果拥有【广告投放】权限会自动增加【工具】的权限,已授权账号的token也会拥有工具接口的访问权限。
  • 但是新授权需要确保授权URL带上了工具权限才能实际使用,授权URL传参方式做了更改,授权范围scope新增了工具类型,如果scope传空意味着授权所有拥有的权限,如果你是操作自己的广告主建议使用传空的方式更为简便快捷。
  • 请注意授权URL中的scope的传参做了更改,如1表示账号服务权限,与原来的定义方式有所区别,详细请参考OAuth2.0授权文档


2.新增获取站点列表接口

  • 新增tools/site/get/接口,支持获取广告主账号下的站点列表,建站地址可由如下格式拼装得到:https://www.chengzijianzhan.com/tetris/page/XXXXXXXXXXXXX/(其中XX是建站ID,拼装后就可获得投放的URL/预览URL)。

3.转化相关接口应用下载API和应用下载SDK类型转化增加深度转化目标字段

  • 创建转化接口(tools/ad_convert/create/ )和查询转化详细接口(tools/ad_convert/read/ )中的应用下载API和应用下载SDK类型转化新增深度转化目标(deep_external_action)字段,支持注册、付费、次留的深度转化目标。

4.report相关接口增加点赞数、分享数等互动数据


2018年12月5日

1.人群包列表接口(dmp/custom_audience/select/ )和人群包详细信息接口(dmp/custom_audience/read/ )新增如下优化:

  • 上传类型人群包增加data_source_id返回(不是所有人群包都有data_source_id,只有上传人群包有)
  • 增加人群包来源返回,如拓展人群包,上传人群包
  • 人群包select列表接口返回人群包总数


2018年11月22日

1.新增获取图片素材库和视频素材库接口

新增file/image/get/接口 file/video/get/接口 分别可获取广告主下的素材库中的图片和素材库中的视频,为保证接口使用的安全性避免调取他人的素材信息,该接口只可用于查询自己广告主下的视频信息,即需查询的广告主账号的主体需与APPID对应开发者的主体保持一致,才可获取到素材库的信息。


2.新版创意列表接口上线

新增 creative/get/接口 ,可用于替代creative/select接口,新版接口增加了创意的视频ID、创意拒绝理由的返回,除此之外新版接口支持多维度的fields过滤,能给你带来更好的使用体验。


2018年10月31日

1.新增查询广告主/代理商流水明细接口

新增advertiser/fund/transaction/get/ 接口,通过此接口你可以查询广告主/代理商下的流水明细。


2.【预通知】老版接口停用通知

为了提升接口的易用性和调用体验,我们在过去的一段时间新增了多个升级版接口,可替代原有的老接口,新版接口较老接口有更强大的功能以及更好的调用体验,当前老接口已不再维护更新,我们逐渐废弃,预计在2018年12月31日关停一批老版接口,其中包括:

老版将废弃接口(停用时间:12月31日)

新版可替代接口

优化内容

campaign/select/campaign/read/

campaign/get/

可使用一个get接口替代select和read接口,减少接口冗余,支持filtering多维度过滤,统一分页规范

ad/select/ad/read/

ad/get

可使用一个get接口替代select和read接口,减少接口冗余,支持filtering多维度过滤,统一分页规范

creative/create/

creative/create_v2/

减少接口冗余,支持视频广告创建,支持程序化创意,支持使用动态词包

creative/read/

creative/read_v2/

减少接口冗余,支持视频广告获取,支持程序化创意,支持使用动态词包

creative/update/

creative/update_v2/

减少接口冗余,支持视频广告更新,支持程序化创意,支持使用动态词包

report/advertiser/

report/advertiser/get/

增加数据维度,统一分页规范,优化字段定义,增加视频播放等多个数据维度,支持排序

report/campaign/

report/campaign/get/

支持filtering多维度过滤,统一分页规范,优化字段定义,增加视频播放等多个数据维度,支持排序

report/ad/

report/ad/get/

支持filtering多维度过滤,统一分页规范,优化字段定义,增加视频播放等多个数据维度,支持排序

report/creative/

report/creative/get/

支持filtering多维度过滤,统一分页规范,优化字段定义,增加视频播放等多个数据维度,支持排序

dmp/custom_audience/push/

dmp/custom_audience/publish/dmp/custom_audience/push_v2/

接口解耦,使用publish可以将人群包实现发布,有一个人群包24小时只可发布一次的限制,push_v2接口可以将人群包推送分享给其他同主体的账号,将不再有24小时的限制。


2018年10月29日

1.广告主日流水接口增加返货支出(return_goods_cost)字段返回,可 点此查看

2.计划相关接口(ad/get、ad/create、ad/update)功能新增:

  • 兴趣分类定向ad_tag增加系统推荐选项,如果传空数组 [] 表示不限,如果只传[0]表示系统推荐,如果按兴趣类型传表示自定义;
  • 过滤已转化字段hide_if_converted增加按APP转化过滤,新增APP枚举值,可在附录-枚举值中搜索过滤已转化用户类型查看;
  • 增加过滤已安装字段hide_if_exists,当推广目标为安卓应用下载时可填,0表示不过滤,1表示过滤,默认为不过滤;

3.创意相关接口(creative/create_v2、creative/read_v2、creative/update_v2)增加优选广告位选择

  • 增加smart_inventory字段,0表示不使用优选,1表示使用,默认为不选择,如果使用优选广告位的时将忽略inventory_type字段;

4.新增获取智能封面接口

智能封面功能是通过提取视频关键帧筛选出推荐封面,帮助你发现视频内优质封面素材,通过tools/video_cover/suggest/接口 你可以获取一个视频的推荐封面,推荐封面数量在6-12个图片范围内,由实际的视频内容和时长决定。


5.APPID管理升级

为了提升APPID管理的安全性,我们新增的应用总开关和secret重置的功能,当应用出现secret泄漏或异常调用时,你可以第一时间做相应的操作,请注意:

  • 应用关闭后将立即停止此应用相关的所有调用;
  • secret重置不会影响历史ccess_token和refresh_token的有效性,但是在重置后老的secret将立即过期,再次调用oauth2/access_token/及oauth2/refresh_token/接口时,将要求使用最新的secret进行校验;

请谨慎操作应用的关闭和secret的重置操作。


2018年10月23日

1.支持穿山甲和资讯联盟广告位

ad/createad/get接口增加投放范围delivery_range字段:

  • 投放范围默认为DEFAULT,这时候在创意编辑添加广告位时需要像原来一样上传广告位如头条、抖音等,其中广告位中我们新增了资讯联盟广告位,可在枚举中搜索INVENTORY_UNION_SLOT
  • 投放范围选择穿山甲UNION时只能投放穿山甲流量,在创意编辑时不需要再上传广告位字段,并且计划创建后投放范围无法更改。


2.token刷新机制优化

为解决token刷新后新token由于某些原因可能存储失败,导致无法使用问题,我们对token刷新机制做了优化,刷新后历史token将保留10分钟的有效时间,具体场景逻辑如下:

  • 场景一:token被刷新只要token刷新成功获得了新的access_token和refresh_token,老的access_token和refresh_token将继续保留10分钟的有效期,10分钟后会自动过期;如果10分钟内对老的token再次刷新,不再刷新老token的时间,即老token刷新后的10分钟有效期从第一次刷新时间开始。
  • 场景二:重新授权获得新的auth_code同以往,只要重新授权了,那历史auth_code和token将立即失效;
  • 场景三:广告主取消授权同以往,APPID下与此广告主相关的auth_code和token立即过期;


3.人群包push接口拆分为dmp/custom_audience/publish/和dmp/custom_audience/push_v2/两个接口

原有的dmp/custom_audience/push/接口存在将两个操作(发布和推送)耦合在一起的问题,以此导致如果想做人群包推送给其他账户只能24小时推送一次,为此我们新增了两个publish和push_v2接口用来替代原有的老版push接口,使用publish可以将人群包进行发布会有一个人群包24小时只可发布一次的限制,push_v2接口可以将人群包推送分享给其他同主体的账号,将不再有24小时的限制。

发布接口简单的说是一个让人群包正式生效的操作,将人群信息发布到正式的投放系统,发布后人群包的内容才会在投放中正式生效,存在以下三种场景将用到publish接口:

  • 在创建数据源,人群包ID首次生成后,必须先使用publish接口将人群包发布,才可使用;
  • 如果更新了数据源,需要使用publish接口才能把数据源的最新的内容发布(更新)到人群包中,发布后数据源的最新内容将在人群包中生效,否则更新内容将无法生效;
  • 如果是拓展人群包或者运算人群包,人群包ID生成后同样也需要调用publish接口才可将人群包生效;

详细请参考: 发布人群包接口 推送人群包接口


2018年9月27日

图片转视频接口上线:

通过图片转视频接口可以帮助你使用图片+视频模板快速构建一个创意视频,我们为您提供了丰富的模板类型,任你选择,支持竖版和横版视频,详细请参考图片转视频工具部分的文档介绍。


2018年9月21日

1.新版报告接口支持排序功能,增加过滤尺寸


2.ad/get接口支持获取DPA计划信息

  • 广告/获取接口支持获取完整的DPA计划信息,另外还要包括dpa_categories,dpa_products,dpa_ad_type等,详细请参考获取广告计划接口。


3.添加广告主/ public_info接口,为通用权限接口

  • advertiser / public_info接口可查询已授权账号的通用账号信息,包括账号名称,公司名称,为通用权限接口。


4.更新计划预算(ad / update / budget /)和更新计划预算(ad / update / budget /)接口升级,支持同时修改多个计划

  • 广告/更新/预算/接口新增数据字段,支持多个计划分别修改成多个预算,原来仅支持单个计划修改成一个预算,请注意新旧参数只能二选一,勿混传;
  • 广告/更新/修订/接口添加 数据片段,支持多个计划分别修改成多个变量,原来仅支持多个计划修改成一个替换,请注意新旧参数只能二选一,勿混传;


5.广告主余额接口(广告客户/资金/获取)增加返货余额


6.增加文档搜索功能

可以通过平台右上角的搜索功能对关键字就行搜索,例如搜索返回码,行信息等,帮助您快速定位查找的文档。


7.【预通知】老版接口终止通知

为了提升接口的易用性和调用体验,我们在过去的重置又添加了多个升级版接口,可替代互连的老接口,新版接口较老的接口有更强大的功能以及更好的调用体验,当前老接口已不再维护更新,我们逐渐废弃,预计在2018年12月1日关停资金老版接口,其中包括:

老版将废弃接口(终止时间:12月1日)

新版可替代接口

优化内容

活动/选择/活动/阅读/

广告活动/获取/

可使用一个get接口替代select和read接口,减少接口冗余,支持过滤多维过滤,统一分页规范

广告/选择/广告/阅读/

广告/获取

可使用一个get接口替代select和read接口,减少接口冗余,支持过滤多维过滤,统一分页规范

广告/创造/

广告素材/ create_v2 /

减少接口冗余,支持视频广告创作,支持程序化创意,支持使用动态词包

广告/阅读/

广告/ read_v2 /

减少接口冗余,支持视频广告获取,支持程序化创意,支持使用动态词包

广告/更新/

广告素材/ update_v2 /

减少接口冗余,支持视频广告更新,支持程序化创意,支持使用动态词包

报告/广告商/

报告/广告商/获取/

增加数据维度,统一分页规范,优化细分定义,增加视频播放等多个数据维度,支持排序

报告/广告活动/

报告/广告系列/获取/

支持过滤多维度过滤,统一分页规范,优化定义,增加视频播放等多个数据维度,支持排序

报告/广告/

报告/广告/获取/

支持过滤多维度过滤,统一分页规范,优化定义,增加视频播放等多个数据维度,支持排序

报告/创意/

报告/创意/获取/

支持过滤多维度过滤,统一分页规范,优化定义,增加视频播放等多个数据维度,支持排序