广告主相关API(已废弃)

DSP通过该系列API进行广告主的相关操作,包括创建、修改、补充投放资质、查询。
PDB/PD:广告主由腾讯内部系统下单时指定,无需新建与修改。因此DSP只需关注查询接口,无需关注其他接口。
RTB:DSP上传素材,必须先提交广告主到AdX。因此DSP需关注所有接口:新建、修改、补充投放资质、查询(资质文件大小不超过4MB)。

1. 创建

接口:advertiser/add
请求字段:

名称 类型 描述
data 数组类型 最多10个

data内容详细:

名称 类型 必填 描述
name string Y 广告主名称,DSP需保证该名称在DSP侧的唯一性
homeurl string Y 广告主主页网址
qq int N 广告主QQ号
vocation string N 广告主行业编码,详见广告主行业编码表
qualidata 数组类型 N 基本资质内容

qualidata内容详细:

名称 类型 必填 描述
name string Y 资质名称
fileurl string Y 资质文件

接口返回:

名称 类型 描述
ret_code int 返回码
ret_msg 数组类型 返回内容
error_code int 错误补充码

ret_msg内容详细:

名称 类型 描述
id int 广告主id
name string 广告主名称
err_code int 成功不返回,失败返回具体错误码
err_msg string/数组 成功不返回,失败返回具体错误描述

请求示例:

返回示例:

2. 修改

接口:advertiser/update
请求字段:

名称 类型 描述
data 数组类型 最多10个

data内容详细:

名称 类型 必填 描述
id int Y 广告主id,调用广告主新建接口生成的唯一id
name string Y 广告主名称,DSP需保证该名称在DSP侧的唯一性
homeurl string Y 广告主主页网址
qq int N 广告主QQ号
vocation string N 广告主行业编码,详见广告主行业编码表
qualidata 数组类型 N 基本资质内容

qualidata内容详细:

名称 类型 必填 描述
name string Y 资质名称
fileurl string Y 资质文件

接口返回:

名称 类型 描述
ret_code int 返回码
ret_msg 数组类型 返回内容
error_code int 错误补充码

ret_msg内容详细:

名称 类型 描述
id int 广告主id
name string 广告主名称
err_code int 成功不返回,失败返回具体错误码
err_msg string/数组 成功不返回,失败返回具体错误描述

请求示例:

返回示例:

注:
(1)广告主id与名称不允许修改,其他都可以修改
(2)已通过审核的广告主信息不允许修改,修改前先通过查询接口同步状态
(3)修改时参数id与name二选一,都传的话优先使用id

3. 补充投放资质

接口:advertiser/extraquali
请求字段:

名称 类型 描述
data 数组类型 最多10个

data内容详细:

名称 类型 必填 描述
id int Y 广告主id,调用广告主新建接口生成的唯一id
name string Y 广告主名称,dsp需保证该名称在dsp测的唯一性
qualidata 数组类型 N 补充资质内容

qualidata内容详细:

名称 类型 必填 描述
name string Y 补充资质名称
fileurl string Y 补充资质文件

接口返回:

名称 类型 描述
ret_code int 返回码
ret_msg 数组类型 返回内容
error_code int 错误补充码

ret_msg内容详细:

名称 类型 描述
id int 广告主id
name string 广告主名称
err_code int 成功不返回,失败返回具体错误码
err_msg string/数组 成功不返回,失败返回具体错误描述

请求示例:

返回示例:

注:广告主审核通过后也可以上传补充投放资质

err_msg补充说明:

如果是客户信息出错,err_code的同级 err_msg会返回string,
如果是客户的资质文件出错, err_code会返回一个array list

4. 查询

接口:advertiser/list
请求字段:

名称 类型 描述
page int 可以为空,默认值为1
size int 可以为空,默认值为10,最大为20
data 数组类型 可以为空,不为空则data优先,忽略page与size参数,最多20个

data内容详细:

名称 类型 必填 描述
id int Y 广告主id,调用广告主新建接口生成的唯一id
name string Y 广告主名称,DSP需保证该名称在DSP侧的唯一性

接口返回:

名称 类型 描述
ret_code int 返回码
ret_msg 数组类型 返回内容
error_code int 错误补充码

ret_msg内容详细:

名称 类型 描述
id int 广告主id
name string 广告主名称
homeurl string 广告主网址主页
vocation string 广告主行业编码,详见广告主行业编码表
status int 审核状态 (1-审核通过,3-审核不通过,8-待审核)
vinfo string 审核意见
qualidata 数组类型 基本资质(仅针对RTB有效)
exqualidata 数组类型 补充投放资质(仅针对RTB有效)

qualidata内容详细:

名称 类型 描述
name string 补充资质名称
fileurl string 补充资质文件

exqualidata内容详细:

名称 类型 描述
name string 补充资质名称
fileurl string 补充资质文件
status int 补充资质审核状态 (1-审核通过,3-审核不通过,2-待审核)
vinfo string 补充资质审核意见

请求示例:

返回示例: