新建广告创意
新建广告创意
请求地址
https://openapi.aiclk.com/openapi/v1/creative/create
所属权限
ads_write
请求方式
POST
请求参数
URL中携带参数:
| 字段名 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| account_id | int | 是 | 广告主ID(广告投放平台的userID) |
Post body(json)
公共参数
| 字段名 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| campaign_id | int | 是 | 计划ID |
| adgroup_id | int | 是 | 单元ID |
| creative_name | string | 是 | 创意名称 |
| configure_status | string | 否 | 状态,默认开启。 允许值:开启- ENABLE, 暂停-PAUSED |
第三方监测参数
| 字段名 | 类型 | 是否必须 | 描述 | 说明 |
|---|---|---|---|---|
| click_feedback_url | string | 否 | 点击监控链接 | 可填写自定义链接,转化追踪方式为API(APP内转化)时必填,也可通过API查询接口查询可用的API ID(APP内转化类型)对应的监控链接 多个监控链接之间用英文空格分隔,最多支持填写50个 |
| api_id | int | 否 | api监控链接的ID | 转化追踪方式选择API(APP内转化)或API(落地页转化)时可填 |
应用推广
| 字段名 | 类型 | 是否必须 | 描述 | 备注 |
|---|---|---|---|---|
| type | string | 是 | 创意样式 | 枚举值 支持以下类型: 小图、大图、组图、视频广告(横版)、视频广告(竖版)、激励视频(横版)、激励视频(竖版)、文字链、互动广告、开屏广告、横幅广告、应用商城 |
| sub_cate | string | 是 | 推广分类 | 枚举值 注意:激励视频、应用商城样式仅能选择 ANDROID_APP |
| pkg_name | string | 否 | 安装包名 | 推广分类选择ANDROID_APP时必传安卓包名校验规则:必须是字母,字母规则(eg:com.duowan.mobile) |
| conversion_type | string | 是 | 追踪转化方式 | 枚举值 默认值:无 允许值:无,API(APP内转化) 应用商城样式须开通白名单才可选 |
| download_url | string | 是 | APP下载链接 | 可填写自定义链接。 也可通过APP查询接口查询可用APP ID对应的下载链接。 |
| is_market_link | string | 否 | 跳转厂商应用商店 | 开启后,用户点击广告将跳转手机厂商应用商店进行下载。枚举值 |
| target_url_h5 | string | 否 | 落地页链接 | 应用推广场景选填。 拉活且投放系统为 Android或不限时,download_url、target_url_h5、deep_link三者至少填写一个。注意可填写自定义链接,也可通过建站查询查询可用建站ID对应的落地页链接(注意:创意仅能使用本账户的建站) |
| target_type | string | 否 | 建站类型 | 与clk_site_id成对出现,使用建站时必填。允许值:鲸鱼建站-WHALE、赤兔建站-CHITU |
| clk_site_id | int | 否 | 建站ID | 与target_type成对出现,使用建站时必填。通过建站查询接口查询可用建站ID(注意:创意仅能使用本账户的建站) |
| deep_link | string | 否 | deeplink链接 | 1、不能以http或https开头 2、不能出现中文 |
| universal_link | string | 否 | universal_link链接 | 当 sub_cate 为 IOS_APP 时可用 |
| app_logo | string | 否 | APP的logo链接 | 除应用商城外必填logo数量:1张,比例:1:1,大小 < 200k,支持格式:gif、jpg、png |
| app_name | string | 否 | APP名称 | 除应用商城外必填,1-20个字数 |
| play_duration | string | 否 | 试玩时长 | 样式为应用商城,转化追踪方式为无时,必填;枚举值 |
| title | string | 否 | 标题 | 标题,样式为小图,大图,组图,视频广告(横版),视频广告(竖版),文字链,互动广告时,必填文字链的标题长度要求最多10字; 互动广告的标题长度要求最多23字; 其余样式的标题长度要求8-23字 |
| second_title | string | 否 | 副标题 | 副标题,样式为激励视频(横版),激励视频(竖版)时,必填;长度要求最多11字 |
| description | string | 否 | 创意描述(激励视频) | 样式为激励视频(横版),激励视频(竖版)时,必填。长度要求8-23字 |
| play_action | string | 否 | 动作类型(应用商城) | 样式为“应用商城”,转化追踪方式为“无”时,必填。枚举值 |
| conversion_target | string | 否 | 转化目标 | 样式为 应用商城且转化追踪方式为API(APP内转化)时,必填;枚举值 自定义后端转化文案长度要求最多10字 |
| back_end_conversion | string | 否 | 后端转化文案 | 满足以下条件是,该参数必填: 1.样式为 应用商城;2.账户在 应用商城API回传白名单中;3.转化追踪方式选择 API(APP内转化);4.转化目标选择 后端转化 |
| app_introduction | string | 否 | 应用简介 | 样式为应用商城时,必填;长度要求8-15字 |
| app_desc | string | 否 | app内容描述 | 样式为应用商城时,必填;长度要求10-100字 |
| text_link_description | string | 否 | 内容描述 | 样式为文字链时,必填;长度要求最多16字 |
| text_link_btn | string | 否 | 文字链按钮 | 样式为文字链时,必填长度要求最多4字 |
| btn_text | string | 否 | 互动广告按钮文案 | 样式为互动广告时,可填;长度要求最多5字 |
| image | []int | 是 | 图片信息 | 格式见字段示例 |
| video_id | int | 否 | 视频ID | 样式为视频广告和激励视频时必填,视频ID可以通过素材列表接口获取 |
| motivate_style | string | 否 | 激励样式 | 满足以下条件后,可以填写: 1.开通了激励样式白名单; 2.计划营销目标为拉活; 3.单元付费方式为 CPC,oCPX;4.投放媒体为 趣头条;5.样式为 小图,大图,组图,视频广告(横版),视频广告(竖版)时;枚举值 默认值:无 |
| motivate_video_autoplay | string | 否 | 激励视频plus开关 | 激励视频播完自动跳转落地页开关。 默认值:关闭。允许值:开启-ENABLE, 关闭-DISABLE |
线索收集
| 字段名 | 类型 | 是否必须 | 描述 | 备注 |
|---|---|---|---|---|
| type | string | 是 | 创意样式 | 枚举值 支持以下类型: 小图、大图、组图、视频广告(横版)、视频广告(竖版)、激励视频(横版)、激励视频(竖版)、文字链、互动广告、开屏广告、横幅广告 |
| sub_cate | string | 是 | 推广分类 | 枚举值 注意:推广分类,允许值: ANDROID_APP、IOS_APP、OTHER,激励视频样式不能选择IOS_APP |
| pkg_name | string | 否 | 安装包名 | 推广分类选择ANDROID_APP时必须传;安卓包名校验规则:必须是字母,字母规则(eg:com.duowan.mobile) |
| conversion_type | string | 是 | 转化追踪方式 | 枚举值 默认值:无; 允许值:无,JS布码,API(APP内转化),API(落地页转化) |
| target_url | string | 是 | 落地页链接 | 1.可填写自定义链接 2.也可通过建站查询查询可用建站ID对应的落地页链接(注意:创意仅能使用本账户的建站)。 3.转化追踪方式为 JS布码时,必须使用JS布码查询接口查询可用JS布码ID对应的落地页链接;4.转化追踪方式为 API(落地页转化)时,必须使用API查询查询可用的API ID(落地页转化类型)对应的落地页链接 |
| target_type | string | 否 | 建站类型 | 使用建站时必填。 允许值:鲸鱼建站-WHALE、赤兔建站-CHITU |
| clk_site_id | int | 否 | 建站ID | 使用建站时必填。 通过建站查询接口查询可用建站ID(注意:创意仅能使用本账户的建站) |
| js_conversion_id | int | 否 | Js布码链接ID | 转化追踪方式选择JS布码时,可传值且必填 |
| deep_link | string | 否 | deeplink链接 | 1、不能以http或https开头 2、不能出现中文 |
| app_logo | string | 否 | APP的logo链接 | 推广分类选择ANDROID_APP和IOS_APP时必传;logo数量:1张,比例:1:1,大小 < 200k,支持格式:gif、jpg、png |
| app_name | string | 否 | APP名称 | 推广分类选择ANDROID_APP和IOS_APP时必传;1-10个字数 |
| title | string | 否 | 标题 | 样式为小图,大图,组图,视频广告(横版),视频广告(竖版),文字链,互动广告`时,必填;标题要求: 1.文字链的标题长度要求最多10字; 2.互动广告的标题长度要求最多23字; 3.其余样式的标题长度要求8-23字; |
| second_title | string | 否 | 副标题 | 样式为视频广告(横版),视频广告(竖版)时,必填;长度要求最多11字 |
| video_title | string | 否 | 激励视频的标题 | 样式为激励视频(横版),激励视频(竖版)时,必填;长度要求最多10字 |
| description | string | 否 | 创意描述(激励视频) | 样式为激励视频(横版),激励视频(竖版)时,必填。长度要求8-23字 |
| text_link_description | string | 否 | 内容描述 | 样式为文字链时,必填;长度要求最多16字 |
| text_link_btn | string | 否 | 按钮文案 | 样式为文字链时,必填长度要求最多4字 |
| btn_text | string | 否 | 领取按钮文案 | 样式为互动广告时,可填;长度要求最多5字 |
| image | []int | 是 | 图片信息 | 格式见字段示例 |
| video_id | int | 否 | 视频ID | 样式为视频广告和激励视频时必填,视频ID可以通过素材列表接口获取 |
| motivate_style | string | 否 | 激励样式 | 满足以下条件后,可以填写: 1.开通了激励样式白名单; 2.计划营销目标为拉活; 3.单元付费方式为 CPC,oCPX;4.投放媒体为 趣头条;5.样式为 小图,大图,组图,视频广告(横版),视频广告(竖版)时;枚举值 默认值:无 |
| motivate_video_autoplay | string | 否 | 激励视频plus开关 | 激励视频播完自动跳转落地页开关。 默认值:关闭。允许值:开启-ENABLE, 关闭-DISABLE |
快应用
| 字段名 | 类型 | 是否必须 | 描述 | 备注 |
|---|---|---|---|---|
| type | string | 是 | 创意样式 | 枚举值 支持以下类型: 小图、大图、组图、视频广告(横版)、视频广告(竖版)、激励视频(横版)、激励视频(竖版)、文字链、互动广告、开屏广告、横幅广告 |
| sub_cate | string | 是 | 推广分类 | 枚举值 注意:推广分类,允许值: QUICK_APPS |
| pkg_name | string | 否 | 快应用包名 | 快应用包名校验规则:必须是字母,字母规则(eg:com.duowan.mobile) |
| conversion_type | string | 是 | 转化追踪方式 | 枚举值 默认值:无; 允许值:无,API(APP内转化),API(落地页转化) 注意:快应用不支持 JS布码 |
| target_url | string | 否 | 落地页链接 | 1.可填写自定义链接 2.也可通过建站查询查询可用建站ID对应的落地页链接(注意:创意仅能使用本账户的建站)。 3.转化追踪方式为 API(落地页转化)时,必填,且必须使用API查询查询可用的API ID(落地页转化类型)对应的落地页链接 |
| target_type | string | 否 | 建站类型 | 与clk_site_id成对出现,使用建站时必填。允许值:鲸鱼建站-WHALE、赤兔建站-CHITU |
| clk_site_id | int | 否 | 建站ID | 与target_type成对出现,使用建站时必填。通过建站查询接口查询可用建站ID(注意:创意仅能使用本账户的建站) |
| deep_link | string | 否 | deeplink链接 | 1、不能以http或https开头 2、不能出现中文 3、除 API(落地页转化)外,其他转化追踪方式必填 |
| app_logo | string | 否 | 快应用的logo链接 | logo数量:1张,比例:1:1,大小 < 200k,支持格式:gif、jpg、png |
| app_name | string | 否 | 快应用名称 | 1-10个字数 |
| title | string | 否 | 标题 | 样式为小图,大图,组图,视频广告(横版),视频广告(竖版),文字链,互动广告`时,必填;标题要求: 1.文字链的标题长度要求最多10字; 2.互动广告的标题长度要求最多23字; 3.其余样式的标题长度要求8-23字; |
| second_title | string | 否 | 副标题 | 样式为视频广告(横版),视频广告(竖版)时,必填;长度要求最多11字 |
| video_title | string | 否 | 激励视频的标题 | 样式为激励视频(横版),激励视频(竖版)时,必填;长度要求最多10字 |
| description | string | 否 | 创意描述(激励视频) | 样式为激励视频(横版),激励视频(竖版)时,必填。长度要求8-23字 |
| text_link_description | string | 否 | 内容描述 | 样式为文字链时,必填;长度要求最多16字 |
| text_link_btn | string | 否 | 按钮文案 | 样式为文字链时,必填长度要求最多4字 |
| btn_text | string | 否 | 领取按钮文案 | 样式为互动广告时,可填;长度要求最多5字 |
| image | []int | 是 | 图片信息 | 格式见字段示例 |
| video_id | int | 否 | 视频ID | 样式为视频广告和激励视频时必填,视频ID可以通过素材列表接口获取 |
| motivate_style | string | 否 | 激励样式 | 满足以下条件后,可以填写: 1.开通了激励样式白名单; 2.计划营销目标为拉活; 3.单元付费方式为 CPC,oCPX;4.投放媒体为 趣头条;5.样式为 小图,大图,组图,视频广告(横版),视频广告(竖版)时;枚举值 默认值:无 |
| motivate_video_autoplay | string | 否 | 激励视频plus开关 | 激励视频播完自动跳转落地页开关。 默认值:关闭。允许值:开启-ENABLE, 关闭-DISABLE |
微信小程序
| 字段名 | 类型 | 是否必须 | 描述 | 备注 |
|---|---|---|---|---|
| type | string | 是 | 创意样式 | 枚举值 支持以下类型: 小图、大图、组图、视频广告(横版)、视频广告(竖版)、激励视频(横版)、激励视频(竖版)、文字链、互动广告、开屏广告、横幅广告 |
| sub_cate | string | 是 | 推广分类 | 枚举值 注意:推广分类,允许值: MINI_PROGRAM |
| pkg_name | string | 是 | 小程序名称 | 小程序名称 |
| conversion_type | string | 是 | 转化追踪方式 | 枚举值 默认值:无; 允许值:无,API(APP内转化),API(落地页转化) |
| mini_url_type | int | 否 | 小程序跳转链路类型 | 允许值:1-系统生成链路,2-自定义跳转链接 |
| mini_program | object | 否 | 微信小程序相关信息 | 1.与deep_link互斥2.格式:{"original_id":"XXXX","path":"XXXX"}3.mini_url_type=1时,需传original_id;path为唤醒页面 |
| target_type | string | 否 | 建站类型 | 与clk_site_id成对出现,使用建站时必填。允许值:鲸鱼建站-WHALE、赤兔建站-CHITU |
| clk_site_id | int | 否 | 建站ID | 与target_type成对出现,使用建站时必填。通过建站查询接口查询可用建站ID(注意:创意仅能使用本账户的建站) |
| target_url | string | 否 | 落地页链接 | 1.可填写自定义链接 2.也可通过建站查询查询可用建站ID对应的落地页链接(注意:创意仅能使用本账户的建站)。 3.转化追踪方式为 API(落地页转化)时必填,并须使用API查询查询可用的API ID(落地页转化类型)对应的落地页链接;其他转化追踪方式选填 |
| deep_link | string | 否 | deeplink链接 | 1、不能以http或https开头 2、不能出现中文 3. mini_url_type=2且转化追踪方式不为API(落地页转化)时必填 |
| app_logo | string | 是 | 小程序的logo链接 | logo数量:1张,比例:1:1,大小 < 200k,支持格式:gif、jpg、png |
| app_name | string | 是 | 小程序名称 | 1-10个字数 |
| title | string | 否 | 标题 | 样式为小图,大图,组图,视频广告(横版),视频广告(竖版),文字链,互动广告`时,必填;标题要求: 1.文字链的标题长度要求最多10字; 2.互动广告的标题长度要求最多23字; 3.其余样式的标题长度要求8-23字; |
| second_title | string | 否 | 副标题 | 样式为视频广告(横版),视频广告(竖版)时,必填;长度要求最多11字 |
| video_title | string | 否 | 激励视频的标题 | 样式为激励视频(横版),激励视频(竖版)时,必填;长度要求最多10字 |
| description | string | 否 | 创意描述(激励视频) | 样式为激励视频(横版),激励视频(竖版)时,必填。长度要求8-23字 |
| text_link_description | string | 否 | 内容描述 | 样式为文字链时,必填;长度要求最多16字 |
| text_link_btn | string | 否 | 按钮文案 | 样式为文字链时,必填长度要求最多4字 |
| btn_text | string | 否 | 领取按钮文案 | 样式为互动广告时,可填;长度要求最多5字 |
| image | []int | 是 | 图片信息 | 格式见字段示例 |
| video_id | int | 否 | 视频ID | 样式为视频广告和激励视频时必填,视频ID可以通过素材列表接口获取 |
| motivate_style | string | 否 | 激励样式 | 满足以下条件后,可以填写: 1.开通了激励样式白名单; 2.计划营销目标为拉活; 3.单元付费方式为 CPC,oCPX;4.投放媒体为 趣头条;5.样式为 小图,大图,组图,视频广告(横版),视频广告(竖版)时;枚举值 默认值:无 |
| motivate_video_autoplay | string | 否 | 激励视频plus开关 | 激励视频播完自动跳转落地页开关。 默认值:关闭。允许值:开启-ENABLE, 关闭-DISABLE |
Body示例
{
"adgroup_id": 2944162,
"api_id": 0,
"app_logo": "http://oss.cdn.aiclk.com/live/customer/1000002/79b06524698a749b2d057ce4d9d930c0_1000002_100_100.jpg",
"app_name": "APP",
"btn_text": "文案",
"campaign_id": 2404617,
"click_feedback_url": "http://www.click.com",
"configure_status": "PAUSED",
"conversion_type": "API_DOWNLOAD",
"creative_name": "测试创意",
"deep_link": "deeplink",
"image": [
2021442
],
"js_conversion_id": 0,
"motivate_style": "NONE",
"pkg_name": "com.zs",
"sub_cate": "ANDROID_APP",
"target_url": "http://www.baidu.apk",
"title": "测试title",
"type": "ENGAGEMENT",
"mini_program": {"original_id": "1234", "path": "adv"},
}
请求示例
curl -X POST \
'https://openapi.aiclk.com/openapi/v1/creative/create?account_id=1000009' \
-H 'Content-Type: application/json' \
-H 'OGW_ACCESS_TOKEN: your_access_token' \
-d '{"adgroup_id":2944162,"api_id":0,"app_logo":"http://oss.cdn.aiclk.com/live/customer/1000002/79b06524698a749b2d057ce4d9d930c0_1000002_100_100.jpg","app_name":"APP","btn_text":"文案","campaign_id":2404617,"click_feedback_url":"http://www.click.com","configure_status":"PAUSED","conversion_type":"API_DOWNLOAD","creative_name":"测试创意","deep_link":"deeplink","image":[2021442],"js_conversion_id":0,"motivate_style":"NONE","pkg_name":"com.zs","sub_cate":"ANDROID_APP","target_url":"http://www.baidu.apk","title":"测试title","type":"ENGAGEMENT"}'
返回字段释义
| 字段名 | 类型 | 描述 |
|---|---|---|
| code | int | 返回码 |
| message | string | 返回信息 |
| data | object | 返回值 |
| - creative_id | int | 创意ID |
返回示例
{
"code": 200,
"message": "success",
"data": {
"creative_id": 3994457
}
}