广告创意列表
获取广告创意列表信息。
请求地址
https://openapi.aiclk.com/openapi/v1/creative/get
所属权限
ads_read
请求方式
GET
请求参数
| 字段名 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| account_id | int | 是 | 广告主ID(广告投放平台的userID) |
| query | string | 是 | 请求参数结构,json格式,具体字段如下 |
query参数
| 字段名 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| campaign_id | int | 否 | 广告计划ID |
| creative_id | array | 否 | 创意ID,示例:[77777,88888] |
| fields | array | 是 | 需要的返回字段,允许值:"account_id","campaign_id","adgroup_id","creative_id","creative_name","sub_cate","pkg_name","app_name","app_logo","api_id","js_conversion_id","conversion_type","type","optimization_goal","configure_status","effective_status","unable_reason","title","second_title","description","app_introduction","target_url","target_url_h5","download_url","image","app","video_id","audit_reason","clk_site_id","click_feedback_url","text_link_btn","deep_link","universal_link","text_link_description","game_url","video_title","motivate_style","play_action","play_duration","conversion_target","back_end_conversion","game_material_id","created_at","motivate_video_autoplay","original_id","path","resource_name" |
| created_at | object | 否 | 创建时间过滤,查询结果包含start和end |
| - start | string | 否 | 开始时间,例如:2020-03-10 |
| - end | string | 否 | 结束时间,例如:2020-03-12 |
| updated_at | object | 否 | 修改时间过滤,start和end字段至少传一个 |
| - start | string | 否 | 开始时间,例如:2020-03-10 |
| - end | string | 否 | 结束时间,例如:2020-03-12 |
| configure_status | []string | 否 | 创意状态,开启-ENABLE,暂停-PAUSED,删除-DELETED,连带删除-RELATE_DELETED |
| page | int | 否 | 页数,默认为1 |
| page_size | int | 否 | 页面大小,默认为10,不大于100 |
query示例
{
"page": 1,
"page_size": 10,
"campaign_id": 66666,
"creative_id": [
77777,
88888
],
"created_at":{
"start":"2020-03-10",
"end":"2020-01-10"
},
"fields": [
"campaign_id",
"adgroup_id",
"creative_id"
],
}
请求示例
curl -X GET \
'https://openapi.aiclk.com/openapi/v1/creative/get?account_id=1625380&query={"campaign_id":1111111,"creative_id":[22222,333333],"page":3,"page_size":10,"fields":["campaign_id","creative_id","creative_name","optimization_goal","type","image","app","video_id","configure_status","title","second_title","video_title","description","target_url"]}' \
-H 'Host: openapi.aiclk.com' \
-H 'OGW_ACCESS_TOKEN: your_access_token'
返回字段释义
| 字段名 | 类型 | 描述 |
|---|---|---|
| code | int | 返回码 |
| message | string | 返回信息 |
| data | json | 返回值,json格式,包含如下字段 |
| - list | json | 返回值,创意信息列表 |
| -- account_id | int | 广告主UID |
| -- campaign_id | int | 广告计划ID |
| -- adgroup_id | int | 广告单元ID |
| -- creative_id | int | 广告创意ID |
| -- creative_name | string | 广告创意名称 |
| -- created_at | string | 创建时间 |
| -- sub_cate | string | 推广分类 |
| -- pkg_name | string | 安装包名 |
| -- app_name | string | APP名称 |
| -- app_logo | string | APP的logo链接 |
| -- api_id | int | API监控链接的ID |
| -- js_conversion_id | int | JS布码链接ID |
| -- conversion_type | string | 追踪转化方式 |
| -- type | string | 广告创意类型,枚举值 |
| -- optimization_goal | string | 投放目标,枚举值 |
| -- configure_status | string | 创意状态,枚举值 |
| -- effective_status | string | 操作状态,开启-ENABLE,暂停-PAUSED |
| -- unable_reason | []string | 无法投放原因 |
| -- title | string | 创意标题 |
| -- second_title | string | 副标题 |
| -- video_title | string | 激励视频标题 |
| -- description | string | 创意描述(激励视频) |
| -- app_introduction | string | 应用简介(应用商城) |
| -- app_desc | string | 应用描述(应用商城) |
| -- target_url | string | 落地页链接(落地页推广) |
| -- target_url_h5 | string | 落地页链接(应用推广) |
| -- target_type | string | 建站类型 枚举值:鲸鱼建站-WHALE、赤兔建站-CHITU |
| -- clk_site_id | int | 建站ID 通过建站查询列表接口获取对应信息 |
| -- download_url | string | 下载地址 |
| -- deep_link | string | 创意的deeplink链接 |
| -- image | object | 参考 图片字段说明 |
| -- app | int | 应用素材ID,可通过<广告素材列表>接口获取对应信息 |
| -- video_id | int | 视频素材ID,可通过<广告素材列表>接口获取对应信息 |
| -- game_material_id | int | 游戏素材ID,可通过<广告素材列表>接口获取对应信息 |
| -- btn_text | string | 互动广告按钮文案 |
| -- audit_reason | string | 审核拒绝原因 |
| -- clk_site_id | int | 建站ID |
| -- click_feedback_url | string | 点击监控链接 |
| -- text_link_btn | string | 文字链按钮的文案 |
| -- text_link_description | string | 文字链的内容描述 |
| -- game_url | string | 游戏链接,投放目标为应用推广,创意样式为试玩广告时可见 |
| -- motivate_style | string | 激励样式,枚举值 |
| -- play_action | string | 动作类型(应用商城),枚举值 |
| -- play_duration | string | 试玩时长(应用商城),枚举值 |
| -- conversion_target | string | 转化目标(应用商城),枚举值 |
| -- back_end_conversion | string | 后端转化文案(应用商城) |
| -- original_id | string | 原始id(微信小程序) |
| -- path | string | 唤醒页面(微信小程序) |
| -- resource_name | string | 素材名称 |
| -- page_info | json | 分页信息 |
| -- page | int | 页数 |
| -- page_size | int | 页面大小 |
| -- total_number | int | 总数 |
返回示例
{
"code": 200,
"message": "success",
"data": {
"list": [
{
"account_id": 1000002,
"adgroup_id": 1000009,
"api_id": 0,
"app": 0,
"app_logo": "",
"app_name": "",
"audit_reason": "",
"back_end_conversion": "",
"campaign_id": 1000004,
"category_id": 134101100,
"click_feedback_url": "",
"clk_site_id": 0,
"configure_status": "DELETED",
"conversion_target": "",
"conversion_type": 0,
"creative_id": 1000010,
"creative_name": "新的广告创意",
"deep_link": "",
"description": "",
"download_url": "",
"engagement_video_type1": 0,
"feed_title": "",
"game_material_id": 0,
"image": {
"image": 1000004
},
"is_api_callback": 0,
"js_conversion_id": 0,
"motivate_style_description": "",
"optimization_goal": "LANDING_PAGE_URL",
"play_action": "",
"play_duration": "事实上长长的图大的",
"second_title": "",
"style_id": 0,
"sub_cate": "0",
"sub_cate_value": "",
"target_url": "点点滴滴",
"target_url_h5": "",
"title": "事实上长长的图大的",
"type": "BIG_IMAGE",
"unable_reason": [],
"video_id": 0,
"video_style": "DEFAULT"
}
],
"page_info":{
"page": 1,
"page_size": 10,
"total_number": 2
}
}
}