Skip to main content

创意同步

创意送审​

简介​

2345-ADX需要对DSP将要投放的素材进行审核，如果审核不通过，将不会允许在2345-ADX上进行交易。DSP通过该接口向2345-ADX提交需要审核的素材信息。

送审接口会根据2345-ADX的要求，对素材的标题、尺⼨、大小、类型进⾏初步机器校验和人工审核，并返回素材的失败原因。

注意：若广告主未审核通过，则无法上传广告创意。

请求方法​

POST

请求路径​

/external/v1/material/create

请求header​

参考信息同步API

请求body​

字段类型是否必填备注
creative_listCreativeMaterial[]是送审素材列表,最多只能30条，参见CreativeMaterial

CreativeMaterial对象​

字段类型是否必填备注
creative_idstring是素材创意ID，自己的所有创意ID不能重复(包括与之前送审的)
advertiser_idstring是广告主ID
advertiser_namestring是广告主名称
vocationint是广告主行业
urlstring是素材落地页
template_idint是模板id
materialMaterial是素材，参见Material对象
app_infoAppInfo否app
statusint否审核状态，创意送审/修改接口不传此字段。当接口为创意查询时，字段必返回:0-待审核 1-审核通过 2-审核拒绝
check_infostring否审核拒绝原因，创意送审/修改接口不传此字段。当接口为创意查询时，字段必返回

Material 对象​

字段名称类型是否必填备注
titlestring推荐广告标题
descriptionstring推荐广告描述
btnstring否广告按钮文字
brandstring推荐品牌描述
imagesImage[]推荐广告图片素材，图文或纯图时必填，详见Image对象
videoVideo推荐广告视频素材，视频广告必填，详见Video对象
iconImage推荐广告 icon 图片，详见Image对象

Image 对象​

字段名称类型是否必填备注
urlstring是图片地址
widthint否图片宽度，单位：像素
heightint否图片高度，单位：像素

Video 对象​

字段名称类型是否必填备注
urlstring是视频地址
durationint否视频时长，单位：秒
sizeint否视频大小，单位：KB
coverImage否视频封面图片或视频后贴片图片，详见Image对象
protocolint否视频协议类型

AppInfo 对象​

字段类型是否必填描述
product_typeint是1-普通链接 2-android应用下载 3-ios应用下载
android_urlstring否安卓下载地址，下载类时android_url或 ios_url⾄少填⼀个，其它情况直接过滤为空
ios_urlstring否IOS下载地址，下载类选填
deeplinkstring否应用直达URL，SDK客户端会对deeplink地址进行有效性校验，无效的话会自动转成非唤起的广告形式，打开落地页
package_namestring推荐下载应用包名 下载和唤醒类广告必填
actionurlstring否电话号码或获取号码的URL
app_namestring否应用名称，下载和唤醒类广告必填
app_sizeint否应用大小，单位 KB，下载类需要
app_logostring否应用logo，下载和唤醒类广告必填
introstring否应用介绍
versionstring否应用版本号，下载类广告必填
developerstring否应用开发者，下载类广告必填
privacystring否应用隐私协议，下载类广告必填
privacy_urlstring否应用隐私协议链接，下载类广告必填
注：下载类广告 privacy、privacy_url 任填一个即可。
permissionsPermission[]否应用隐私权限列表，下载类广告必填。详见permission对象
wx_miniprogramWxMiniProgram[]否调起微信小程序

Permission 对象​

字段名称类型是否必填备注
titlestring是隐私权限标题
descstring是隐私权限详细描述

WxMiniProgram 对象​

字段名称类型是否必填备注
wx_usernamestring是所需跳转的小程序原始 ID（以"gh_"开头）
wx_pathstring否推荐，所需跳转的小程序内页面路径及参数，不填默认拉起小程序主页。
wx_minitypeint是所需跳转的小程序类型，0=正式版、1=开发版、2=体验版

响应返回​

响应参数​

注：响应参数指的是data下的返回

字段类型是否必须备注
nameint必须错误字段名称，请求错误时会返回
msgstring必须错误字段信息
result_listReulst[]非必须每条

Result 对象​

字段类型必填备注
creative_idstring必须素材创意ID
codeint必须错误码，0表示成功
msgstring必须错误信息

请求示例​

{
  "creative_list": [
    {
      "creative_id": "9cc6d4523be14cbab34a1f617c7f2ddd",
      "advertiser_id": "1101",
      "advertiser_name": "天目",
      "vocation": 1101,
      "template_id": 3,
      "url": "https://h5.m.taobao.com/taolive/video.html?userId=2214642867585&livesource=taolivejulang.item.haiguan.dx&sLaunch=0&sKeep=1&sModuleName=taolive&spm=2014.ugdhh&slk_actid=100000000207&dhh_route=4&bc_fl_src=growth_dhh_2200803434232_100-1784456-21253700-194562979-bfaaa36cfa7b67d80f306c82738f2950-53001-0&spm=2014.ugdhh.2200803434232.100-1784456-21253700&bootImage=0&force_no_smb=true&wh_biz=tm&dpa_Inid=2125370060002&dpa_material_id=714796326152&dpa_source_code=10477&itemIds=714796326152",
      "material": {
        "brand": "淘宝",
        "description": "正在直播",
        "icon": {
          "url": "https://qh-material.taobao.com/dsp/img/ebb5e39e1a0a76b24d1e3f9e3eab6ba3.jpg?x-oss-process=image/resize,w_1080,h_1960,limit_0,m_fill&"
        },
        "images": [
          {
            "url": "https://qh-material.taobao.com/dsp/img/ebb5e39e1a0a76b24d1e3f9e3eab6ba3.jpg?x-oss-process=image/resize,w_1080,h_1960,limit_0,m_fill&"
          }
        ],
        "title": "正在直播2"
      },
      "app_info": {
      }
    }
  ]
}

返回示例​

{
  "code": 0,
  "msg": "OK",
  "data": {
    "result_list": [
      {
        "creative_id": "9cc6d4523be14cbab34a1f617c7f2ddd",
        "code": 0,
        "msg": "ok"
      }
    ]
  }
}

创意修改​

简介​

DSP通过该API申请修改创意相关的字段。

提示

创意修改与创意送审请求参数基本一致，除了请求路径不一样

请求方法​

POST

请求路径​

/external/v1/material/update

请求header​

参考信息同步API

请求body​

字段类型是否必填备注
creative_listCreativeMaterial[]是送审素材列表,最多只能30条。字段与送审一致，参见CreativeMaterial

响应参数​

注：响应参数指的是data下的返回

字段类型是否必须备注
nameint必须错误字段名称，请求错误时会返回
msgstring必须错误字段信息
result_listReulst[]非必须每条

Result 对象​

字段类型必填备注
creative_idstring必须素材创意ID
codeint必须错误码，0表示成功
msgstring必须错误信息

请求示例​

参考素材送审-请求示例

返回示例​

参考素材送审-返回示例

创意查询​

简介​

DSP通过该API获取ADX对请求中指定创意的相关信息

请求方法​

POST

请求路径​

/external/v1/materials

请求header​

参考信息同步API

请求body​

字段类型是否必填备注
creative_idsstring[]是广告创意id列表(DSP需保证该id在DSP侧的唯一性) 最多30个

响应参数​

字段类型是否必填备注
creative_listCreativeMaterial[]是送审的素材列表，参见CreativeMaterial

请求示例​

{
  "creative_list": [
    "9cc6d4523be14cbab34a1f617c7f2ddd"
  ]
}

返回示例​

{
  "creative_list": [
    {
      "creative_id": "9cc6d4523be14cbab34a1f617c7f2ddd",
      "advertiser_id": "1101",
      "advertiser_name": "天目",
      "vocation": 1101,
      "template_id": 3,
      "url": "https://h5.m.taobao.com/taolive/video.html?userId=2214642867585&livesource=taolivejulang.item.haiguan.dx&sLaunch=0&sKeep=1&sModuleName=taolive&spm=2014.ugdhh&slk_actid=100000000207&dhh_route=4&bc_fl_src=growth_dhh_2200803434232_100-1784456-21253700-194562979-bfaaa36cfa7b67d80f306c82738f2950-53001-0&spm=2014.ugdhh.2200803434232.100-1784456-21253700&bootImage=0&force_no_smb=true&wh_biz=tm&dpa_Inid=2125370060002&dpa_material_id=714796326152&dpa_source_code=10477&itemIds=714796326152",
      "material": {
        "brand": "淘宝",
        "description": "正在直播",
        "icon": {
          "url": "https://qh-material.taobao.com/dsp/img/ebb5e39e1a0a76b24d1e3f9e3eab6ba3.jpg?x-oss-process=image/resize,w_1080,h_1960,limit_0,m_fill&"
        },
        "images": [
          {
            "url": "https://qh-material.taobao.com/dsp/img/ebb5e39e1a0a76b24d1e3f9e3eab6ba3.jpg?x-oss-process=image/resize,w_1080,h_1960,limit_0,m_fill&"
          }
        ],
        "title": "正在直播2"
      },
      "app_info": {
      },
      "status": 0,
      "check_info": ""
    }
  ]
}