跳到主要内容

广告主相关 API(已废弃)

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

1. 创建​

接口:advertiser/add
请求字段:

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

data 内容详细:

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

qualidata 内容详细:

名称类型必填描述
namestringY资质名称
fileurlstringY资质文件

接口返回:

名称类型描述
ret_codeint返回码
ret_msg数组类型返回内容
error_codeint错误补充码

ret_msg 内容详细:

名称类型描述
idint广告主ID
namestring广告主名称
err_codeint成功不返回,失败返回具体错误码
err_msgstring/数组成功不返回,失败返回具体错误描述

请求示例:

创建接口请求示例

返回示例:

创建接口返回示例

2. 修改​

接口:advertiser/update
请求字段:

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

data 内容详细:

名称类型必填描述
idintY广告主ID,调用广告主新建接口生成的唯一ID
namestringY广告主名称,DSP 需保证该名称在 DSP 侧的唯一性
homeurlstringY广告主主页网址
qqintN广告主 QQ 号
vocationstringN广告主行业编码,详见广告主行业编码表
qualidata数组类型N基本资质内容

qualidata 内容详细:

名称类型必填描述
namestringY资质名称
fileurlstringY资质文件

接口返回:

名称类型描述
ret_codeint返回码
ret_msg数组类型返回内容
error_codeint错误补充码

ret_msg 内容详细:

名称类型描述
idint广告主ID
namestring广告主名称
err_codeint成功不返回,失败返回具体错误码
err_msgstring/数组成功不返回,失败返回具体错误描述

请求示例:

修改接口请求示例

返回示例:

修改接口返回示例

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

3. 补充投放资质​

接口:advertiser/extraquali
请求字段:

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

data 内容详细:

名称类型必填描述
idintY广告主ID,调用广告主新建接口生成的唯一ID
namestringY广告主名称,DSP 需保证该名称在 DSP 侧的唯一性
qualidata数组类型N补充资质内容

qualidata 内容详细:

名称类型必填描述
namestringY补充资质名称
fileurlstringY补充资质文件

接口返回:

名称类型描述
ret_codeint返回码
ret_msg数组类型返回内容
error_codeint错误补充码

ret_msg 内容详细:

名称类型描述
idint广告主ID
namestring广告主名称
err_codeint成功不返回,失败返回具体错误码
err_msgstring/数组成功不返回,失败返回具体错误描述

请求示例:

补充投放资质请求示例

返回示例:

补充投放资质返回示例

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

err_msg 补充说明:

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

4. 查询​

接口:advertiser/list
请求字段:

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

data 内容详细:

名称类型必填描述
idintY广告主ID,调用广告主新建接口生成的唯一ID
namestringY广告主名称,DSP 需保证该名称在 DSP 侧的唯一性

接口返回:

名称类型描述
ret_codeint返回码
ret_msg数组类型返回内容
error_codeint错误补充码

ret_msg 内容详细:

名称类型描述
idint广告主ID
namestring广告主名称
homeurlstring广告主网址主页
vocationstring广告主行业编码,详见广告主行业编码表
statusint审核状态 (1-审核通过,3-审核不通过,8-待审核)
vinfostring审核意见
qualidata数组类型基本资质(仅针对 RTB 有效)
exqualidata数组类型补充投放资质(仅针对 RTB 有效)

qualidata 内容详细:

名称类型描述
namestring补充资质名称
fileurlstring补充资质文件

exqualidata 内容详细:

名称类型描述
namestring补充资质名称
fileurlstring补充资质文件
statusint补充资质审核状态 (1-审核通过,3-审核不通过,2-待审核)
vinfostring补充资质审核意见

请求示例:

查询接口请求示例

返回示例:

查询接口返回示例