获取创意API

获取创意API

更新时间:2018-05-02 15:08:03

获取创意API主要实现对DSP公司录入的创意进行投放,通过这一组API可以实现对创意的获取。

此接口不需要进行签名约定,具体域名请联系阿里云营销引擎技术支持获取。

请求方式

GET

请求结构

http://xxxxxx.aliyun.com/get_creative?<para>=<value>[&<para>=<value>]

参数列表

参数名 类型 必填 含义
did int Y dsp id,在营销引擎控制台可以找到该ID
pid int 推广位的id,可以通过调用“推广位列表”的API获取pid。对于未在营销引擎系统内存储的推广位,此字段未非必填。
as string 所需创意的大小,格式为:宽*高 。如已在营销引擎系统内录入相应推广位信息,此字段为非必填。
at int 推广位的类型,1为PC媒体推广位,2为移动APP推广位,3为移动WAP推广位。如已在营销引擎系统内录入相应推广位信息,此字段为非必填。
vt int 推广位的展现形式,如已在营销引擎系统内录入相应推广位信息,此字段为非必填。具体取值详见推广位展现类型。
c int 推广位所属的行业类目,如已在营销引擎系统内录入相应推广位信息,此字段为非必填。具体取值详见推广位类目词典
mid int 推广位所处媒体的id,如已在营销引擎系统内录入相应推广位信息,此字段为非必填。可以通过调用“媒体列表”的API获取mid。
tpt int 推广位所属的平台。当推广位不是营销引擎系统内录入的二方推广位时,为必要参数;否则,不是必要参数;取值包括:1-tanx;2-二方媒体;3-百度BES;4-腾讯ADX;5-Google DoubleClick;6-网易YEX;7-灵集;8-硬核联盟;9-INMOBI;10-smaato;11-其他;对于非adx的推广位,建议使用11-其他;
tpp string 平台的推广资源位id,即广告位id;当推广位不是营销引擎系统内录入的二方推广位时,为必要参数;否则,不是必要参数;
n int N 需要获取的创意个数,默认值=1
s int N 需要获取的创意偏移,如匹配了10个创意,s=5时,从第六个创意开始返回。默认值=0
v int N API版本号,目前支持v=1,默认值v=1。
cb string N jsonp callback
nf int N 是否返回open_id(p4pid)、匹配创意个数和最终返回创意个数这三个属性的值。默认值为0,即不返回。
mo string N 用户浏览推广素材时,使用的移动操作系统,取值字典包括:iphone;ipad;android
ua string N 用户的浏览器信息
u string N 推广位所在页面的URL
p4pid string N 唯一PV的标识id
mac string N 设备的mac地址
IMEI string N 设备的IMEI(原值,未加密),安卓设备推荐使用此信息
IDFA string N 设备的IDFA(原值,未加密),适用于IOS设备
keyenc string N imei/idfa加密类型,取值词典包括:md5; ori(表示未加密的原值);默认值:ori;
f string N 结果需要返回的字段,具体取值详见结果字段字典。如果传入的字段名称不在上述词典表中,则不会返回对应的值。
ct int N 创意类型,默认为4(图片),具体取值-1:图文;2-微信;3-文字;4-图片;5-动画或视频;
i string N 请求来源ip,点分十进制(如127.0.0.1);
rs int N 是否真实曝光(适用于取回多个创意后做bucket test的场景);取值范围:1(是真实曝光),0(非真实曝光);默认值:1
ran int N 是否根据创意静态分进行概率性的展现,默认值:0;当ran=1时,目前只支持n=1,s=0
kw string N 关键词,逗号分隔。
apids string N 推广计划id,多值使用逗号分隔。传入此参数后,只会吐出属于输入推广计划的创意。

请求样例

1. 推广位已录入营销引擎系统

https://xxxxxx.aliyuncs.com/get_creative?did=1&pid=17&n=2&s=0&u=https%253A%252F%252Fxxxxxx.aliyuncs.com%252FaliyunCookie.html%253Fas%253D250*250%2526at%253D1%2526c%253D43016%2526cnz%253DFcLoEBb%25252Be0gCActKeCrO5fAd%2526did%253D1%2526mid%253D8%2526pid%253D17%2526title%253Dasdf%2526vt%253D1%2526id%253D1-17%2526dim%25255B%25255D%253D250%2526dim%25255B%25255D%253D250%2526wrapperId%253Ddfb-wrapper-1-17&ua=firefox&v=1&cb=__jsonp__0

2. 推广位未录入营销引擎系统

https://xxxxxx.aliyuncs.com/get_creative?did=1&n=1&s=0&as=250*250&vt=1&mid=8&c=43016&tpp=aliyun_pid1&tpt=11&at=1&u=https%253A%252F%252Fxxxxxx.aliyuncs.com%252FaliyunCookie.html%253Fas%253D250*250%2526at%253D1%2526c%253D43016%2526cnz%253DFcLoEBb%25252Be0gCActKeCrO5fAd%2526did%253D1%2526mid%253D8%2526pid%253D17%2526title%253Dasdf%2526vt%253D1%2526id%253D1-17%2526dim%25255B%25255D%253D250%2526dim%25255B%25255D%253D250%2526wrapperId%253Ddfb-wrapper-1-17&ua=firefox&v=1&cb=__jsonp__0

返回字段

字段名 说明
status 本次操作的结果状态码
message 本次操作结果状态的描述
total_num 本次操作匹配的全部创意的个数,当请求参数nf等于1时返回;
return_num 本次操作最终返回的创意的个数,当请求参数nf等于1时返回;
open_id PV的唯一标识id,当请求参数nf等于1时返回;
results 本次请求返回的创意数组,其中每一个对象都是一个匹配的创意;当status不等于200时,results为空。
cb 和请求参数中cb的取值一致

返回样例

JSON返回结果示例如下:

示例
$cb{ “status”:”200”, “message”:”OK”, “total_num”:”1”, “return_num”:”1”, “open_id”:”bfe15c15-13ca-4935-a390-439e4c1ab107-46eative”, “results”: [ { “img_path”:”http://img\_path“, “dest_url”:”http://dest\_url“, “fields”:$field_value, … }, … ] }

results字段

字段名 含义
creative_id 创意id
creative_name 创意名
img_size 创意尺寸,格式为宽*高。
category 创意类目,详见5.2.6-创意类目词典;
user_define 用户自定义字段
download_url 下载型创意的下载url,非下载型的创意此字段值为空
monitor_url 创意的展现监控url
click_monitor_url 创意的点击监控url
hunt 是否为抄底创意,true:是抄底创意;false:非抄底创意
creative_type 创意类型,1:图文;2:微信公众号;3:文字链;4:图片; 5:视频
img_path 创意图片路径。创意类型为图文或图片时,该字段值有实际意义。
dest_url 创意目标地址。创意类型为图文或文字链或图片时,该字段值有实际意义。
creative_desc 创意描述。创意类型为图文或文字链时,该字段值有实际意义。
title 创意标题。创意类型为图文或文字链时,该字段值有实际意义。
wechat_url 公众号地址。创意类型为微信公众号时,该字段值有实际意义。
animation_url 视频地址。创意类型为视频时,该字段值有实际意义。