新义素材前审API

标签：publisher-review-api

v1.0 2020.10.16

文档更新记录

版本	作者	时间	备注
v1.0	孙槐	2020.10.16	创建
v1.1	孙槐	2022.09.14	优化数据结构&命名风格, 补充示例

使用说明

该接口用于向媒体提供广告主和素材的审核信息, 广告主的审核信息为可选, 素材的审核信息为必选, 媒体可以视情况来实现

请求说明

请求的method: HTTP POST
请求的Content-Type: application/json
请求体格式: json
请求接口地址：须由合作方提供
请求中的dspID和key: 须由合作方提供

请求验证方式

采用Bearer Token的方式验证, 请求时会在header中设置以下信息用于验证

Authorization: Bearer <token>

token的生成方式

$dspID = '123456';
$key = 'key';
$timestamp = time();
$sign = getSign($dspID, $key, $timestamp);
$token = getToken($dspID, $sign, $timestamp);
echo $token;

function getSign($dspID = 0, $key = '', $timestamp = 0)
{
    return sha1($dspID . $key . $timestamp);
}

function getToken($dspID = 0, $sign = '', $timestamp = 0)
{
    return base64_encode(join(',', [
        $dspID,
        $timestamp,
        $sign,
    ]));
}

广告主相关接口

广告主提交/更新接口

Request 参数说明

字段名称	类型	必须	描述
name	string	是	名称
advertiser_id	string	是	DSP的广告主ID
website	string	是	官网地址
industry	string	否	行业名称
qualifications	qualification[]	否	资质信息, 若无需资质审核, 可不实现该部分

qualification 资质信息说明

字段名称	类型	必须	描述
name	string	是	资质名称
img_url	string	是	资质图片地址

请求示例

{
  "name": "BA2E21E8C87C936B20B58C1A918F5E7D",
  "advertiser_id": "BA2E21E8C87C936B20B58C1A918F5E7D",
  "website": "https://adtalos.com",
  "industry": "电商",
  "qualifications": [
    {
      "name": "营业执照",
      "img_url": "https://xxxx.com/xxx.jpeg"
    }
  ]
}

Response 字段信息

http status code	描述
200	成功
500	服务暂时不可用

响应body

字段名称	类型	必须	描述
data	object	否	数据对象

data 说明

字段名称	类型	必须	描述
status	string	是	状态 APPROVED=>提交通过 REJECTED=>提交拒绝
advertiser_id	string	是	广告主ID
message	string	否	提交成功或失败原因说明

响应示例

{
  "data": {
    "status": "APPROVED",
    "advertiser_id": "BA2E21E8C87C936B20B58C1A918F5E7D",
    "message": "成功"
  }
}

广告主获取状态接口

广告主获取状态接口 Request 参数说明

字段名称	类型	必须	描述
advertiser_id	string	是	广告主ID

请求示例

{
  "advertiser_id": "BA2E21E8C87C936B20B58C1A918F5E7D"
}

广告主获取状态接口 Response 字段信息

http status code	描述
200	成功
500	服务暂时不可用

字段名称	类型	必须	描述
data	object	是	数据对象

data 说明

字段名称	类型	必须	描述
status	string	是	状态 PENDING=>处理中 APPROVED=>已通过 REJECTED=>拒绝
message	string	否	通过或拒绝原因说明

响应示例

{
  "data": {
    "status": "APPROVED",
    "message": "成功"
  }
}

素材相关接口

素材提交/更新接口

素材提交/更新接口 Request 参数说明

字段名称	类型	必须	描述
creatives	creative[]	是	creative 素材对象

creative 对象说明

字段名称	类型	必须	描述
advertiser_id	string	否	广告主ID
creative_id	string	是	素材ID
target_url	string	是	点击跳转地址
deeplink	string	否	deeplink
type	string	是	素材形式
width	int	否	宽
height	int	否	高
images	string[]	否	图片列表
videos	string[]	否	视频列表
title	string	否	标题
desc	string	否	描述

type素材形式说明

值	描述
BANNER	横幅
INTERSTITIAL	插屏
SPLASH	开屏
NATIVE	原生
VIDEO	视频

请求示例

{
  "creatives": [
    {
      "creative_id": "BA2E21E8C87C936B20B58C1A918F5E7D",
      "target_url": "https://xxx.com/test.html?xxx=aaa",
      "deeplink": "example://v1/search?upgrade=1",
      "type": "BANNER",
      "images": [
        "https://xxx.com/xxx.jpeg"
      ]
    }
  ]
}

素材提交/更新接口 Response 字段信息

http status code	描述
200	成功
500	服务暂时不可用

字段名称	类型	必须	描述
data	object[]	是	数据对象

data object说明

字段名称	类型	必须	描述
creative_id	string	是	素材ID
status	string	是	状态 APPROVED=>提交通过 REJECTED=>失败
message	string	否	提交通过或失败原因说明

响应示例

{
  "data": [
    {
      "creative_id": "BA2E21E8C87C936B20B58C1A918F5E7D",
      "status": "APPROVED",
      "message": "成功"
    }
  ]
}

素材获取状态接口

素材获取状态接口 Request 参数说明

字段名称	类型	必须	描述
creative_ids	string[]	是	素材ID列表,最多20个

请求示例

{
  "creative_ids": [
    "635D35AE7CBAD90A98DE74AA52D94344",
    "8C0792597C0F7C573FC74430ECAD6A61"
  ]
}

素材获取状态接口 Response 字段信息

http status code	描述
200	正常
500	服务暂时不可用

字段名称	类型	必须	描述
data	object[]	是	数据对象数组

data object说明

字段名称	类型	必须	描述
creative_id	string	是	素材ID
status	string	是	状态 PENDING=>处理中 APPROVED=>已通过 REJECTED=>拒绝
message	string	否	通过或拒绝原因说明

响应示例

{
  "message": "成功",
  "data": [
    {
      "creative_id": "635D35AE7CBAD90A98DE74AA52D94344",
      "status": "APPROVED",
      "message": "成功"
    },
    {
      "creative_id": "8C0792597C0F7C573FC74430ECAD6A61",
      "status": "REJECTED",
      "message": "素材尺寸有误"
    }
  ]
}