获取广告组信息
开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
GET
https://ad.e.kuaishou.com/rest/openapi/v1/ad_unit/list
返回参数
| 字段 | 类型 | 说明 | 备注 |
|---|---|---|---|
| code | int | 返回码 | |
| message | string | 返回信息 | |
| data | struct | JSON 返回值 | |
| details | struct | 返回值详情 | |
| campaign_id | long | 广告计划 ID | |
| unit_id | long | 广告组 ID | |
| unit_name | string | 广告组名称 | |
| status | int | 广告组状态（优先看看这个状态，计算结果） | -1：不限，1：计划已暂停，3：计划超预算，6：余额不足，，11：审核中，12：审核未通过，14：已结束，15：已暂停，17：组超预算，19：未达投放时间，20：有效，22：不在投放时段 |
| put_status | int | 投放状态（操作结果） | 1：投放中；2：暂停 3：删除 |
| create_channel | int | 创建渠道 | 0：投放后台创建；1：Marketing API 创建 |
| review_detail | string | 审核拒绝理由 | |
| study_status | int | 学习期 | 1:学习中,2:学习成功,3:学习失败 |
| compensate_status | int | 赔付状态 | 0=不需要赔付(不需要展示赔付标志)，1=成本保障生效中，2=成本保证确认中，3=已赔付完成，4=已失效 |
| bid_type | int | 出价类型 | 1：CPM，2：CPC，6：OCPC(使用 OCPC 代表 OCPX)，10：OCPM，20：eCPC |
| bid | long | 出价 | 单位：厘 |
| cpa_bid | long | OCPC 出价 | 单位：厘 |
| smart_bid | int | 优先低成本是否自动出价 | 0：手动出价，1：自动出价 |
| ocpx_action_type | int | 优化目标 | 0：未知，2：点击转化链接，10：曝光，11：点击，31：下载完成，53：提交线索，109：电话卡激活，137：量房，180：激活，190: 付费，191：首日 ROI，348：有效线索，383: 授信，384: 完件 715：微信复制;739:7 日付费次数;774:7 日ROI;810:激活付费 |
| deep_conversion_type | int | 深度转化目标 | 3:付费，7:次日留存，10:完件, 11:授信；13:添加购物车；14:提交订单；15:购买；44：有效线索；92：付费 roi；181：激活后24H次日留存；0：无； |
| deep_conversion_bid | long | 深度转化目标出价 | 白名单功能，单位：厘 |
| day_budget | long | 单日预算 | 单位：厘 |
| day_budget_schedule | long[] | 分日预算 | 单位：厘，单日预算和分日预算同时存在时，以分日预算为准，优先级高于day_budget |
| roi_ratio | double | 付费 ROI 系数 | 优化目标为「首日 ROI」时必填：ROI 系数取值范围 ( 0,100 ] 最多支持到三位小数（如：0.066） |
| speed | int | 投放方式 | 0：未知，1：正常投放，2：平滑投放，3：优先低成本。 |
| begin_time | string | 投放开始时间 | 格式：yyyy-MM-dd |
| end_time | string | 投放结束时间 | 格式：yyyy-MM-dd,排期不限为 null |
| schedule | struct | 投放时段 | 不投放的时段为 null，详请见下方，历史字段，即将废弃 |
| schedule_time | string | 投放时段 | 24*7 的字符串，0 为不投放，1 为投放，例如：0010000000001....0000 |
| scene_id | int[] | 广告位 | 1：优选广告位；2：按场景选择广告位-信息流广告（旧广告位，包含上下滑大屏广告）6：上下滑大屏广告；7：信息流广告（不包含上下滑大屏广告）24：激励视频；11：快看点场景 |
| show_mode | int | 创意展现方式 | 0：未知，1：轮播，2：优选 |
| unit_type | int | 创意制作方式 | 4: 自定义; 7：程序化创意 2.0 |
| convert_id | int | 转化目标 | |
| use_app_market | int | 优先从系统应用商店下载 | 0：未设置 1：优先从系统应用商店下载使用 |
| app_store | string[] | 应用商店列表 | |
| url_type | int | url 类型 | 当计划类型为 3 时（获取电商下单）时有返回。1：淘宝商品短链 2：淘宝商品 itemID |
| web_uri_type | int | url 类型 | 当计划类型为 5（收集销售线索）&使用建站时有返回：需使用魔力建站 不传默认 1，2：落地页 |
| url | string | 落地页链接 | 计划类型是 2（提升应用安装）：返回应用下载地址；计划类型是 3（获取电商下单）：根据 url_type 返回相应信息；计划类型是 4 （推广品牌活动）：返回落地页 url 计划类型是 5（收集销售线索）：返回落地页 url 计划类型是 5（收集销售线索）：建站 idl |
| schema_uri | string | 调起链接 | 提升应用活跃营销目标的调起链接 |
| app_id | long | 应用 ID | |
| app_icon_url | string | APP 图标存储地址 | |
| diverse_data | struct | 应用信息 | 详情见下方 |
| total_count | int | 数据总数 | |
| target | struct | 定向数据 | 详情见下方 |
| site_type | int | 预约广告 | 1:IOS 预约 缺省为不传或传 0 |
| auto_target | boolean | 智能定向 | 若开启智能定向，定向部分仅保留地域+年龄+性别+排除人群+系统纬度的定向，其他定向纬度暂不支持（报错处理）true 表示开启，false 表示未开启 |
| smart_cover | boolean | 程序化创意 2.0 智能抽帧 | 是否开启智能抽帧 |
| asset_mining | boolean | 程序化创意 2.0 素材挖掘 | 是否开启历史素材挖掘 |
| auto_create_photo | boolean | 是否开启自动生成视频 | |
| update_time | string | 最后修改时间 | 格式样例："2019-06-11 15:17:25" |
| consult_id | long | 是否使用了咨询组件 | 0=未使用，1=使用；注，咨询组件仅在收集销售线索计划(campaign_type=5)下可用，且使用了咨询组件后，可用的行动号召按钮限于接口返回内容 |
| adv_card_option | int | 高级创意开关 | 0：关闭 1:开启 |
| adv_card_list | struct[] | 高级创意列表 | |
| adv_card_id | long | 卡片 id | |
| card_type | int | 卡片类型 | 100:图片卡片 101:多利益卡-图文 102：多利益卡-多标签 103：电商促销样式 |
| url | string | 图片 url | |
| title | string | 标题 | |
| sub_title | string | 副标题 | |
| price | int | 原价格(单位：分) | |
| sale_price | int | 售卖价(单位：分) | |
| backflow_forecast | json | "backflow_cv_lower": 2,"backflow_cv_upper": 5,"backflow_timestamp": 1614134110150,"backflow_payment":100,"backflow_roi":0.33} | backflow_cv_lower：回流预估值的下限；backflow_cv_upper：回流预估值的上限；backflow_timestamp：本次回流预估数据的时间戳，13 位毫秒时间戳;backflow_payment：回流预估总金额;backflow_roi：回流首日预估 ROI |
| playable_orientation | int | 试玩素材的横竖适配 | 默认值为-1；0:横竖均可；1:竖屏；2:横屏 |
| playable_url | string | 试玩的 url | |
| playable_file_name | string | 试玩广告的文件名 | |
| playable_switch | int | 试玩广告的开关 | 默认值为 0；1:关闭；2:开启 |
| playable_id | Long | 试玩 ID | 可选字段，开启试玩时存在，否则不存在。当用户上传试玩素材成功时返回，用于之后对于广告组中试玩创意的编辑操作。 |
| play_button | String | 试玩按钮文字内容 | 开启试玩时存在，否则不存在，示例按钮内容如下：1：立即试玩；2：试玩一下；3：立即体验；4：免装试玩；5：免装体验。启用试玩时：默认“立即试玩”，未启用试玩时：内容为空。 |
| splash_ad_switch | boolean | 是否投放开屏广告位 | true:投放，false：不投放 |
| dpa_unit_sub_type | int | 商品广告类型：2-SDPA，3-动态商品卡 | |
| library_id | int | 商品库ID | |
| outer_id | String | 商品第三方ID | |
| dpa_outer_ids | String | DPA商品ID集合 | |
| dpa_category_ids | String | DPA商品类目集合 | |
| product_name | String | 商品名称 | |
| product_price | Double | 商品价格 | 单位：元 |
| product_image | String | 商品主图 | |
| intention_target | boolean | 行为意向-系统优选 | 行为意向是否开启系统优选，智能定向和行为意向系统优选不能同时开启 |
| page_group_detail | str | 程序化落地页信息 | 广告组ID绑定的程序化落地页组信息 |
| app_download_type | int | 应用下载方式 | 0：直接下载1：落地页下载（仅在提升应用安装计划下生效） |
| jingle_bell_id | long | 小铃铛组件id | |
| live_user_id | long | 主播id | |
| ad_type | int | 广告计划类型 | 0:信息流，1:搜索 |
| extend_search | boolean | 智能扩词开启状态 | false：关闭，true：开启 |
| unit_source | int | 广告组来源 | 0:常规（非托管）、1:托管 |
| negative_word | AdMarketNegativeWordParam | 搜索广告否词 | 搜索广告新增 |
| quick_search | int | 是否开启快投 | 0:关闭、1:开启 |
| target_explore | int | 是否开启搜索人群探索 | 0:关闭、1:开启 |
| schema_id | String | 微信小程序外部调起链接 | 目前只有收集营销线索计划下的联盟广告位该字段才有效 |
| package_id | long | 应用包ID | 新版应用中心，应用包ID |
| schedule | |||
|---|---|---|---|
| 字段 | 类型 | 说明 | 备注 |
| mon | int[] | 周一时间段 | 时间段范围0, 23 |
| tues | int[] | 周二时间段 | 时间段范围0, 23 |
| wed | int[] | 周三时间段 | 时间段范围0, 23 |
| thur | int[] | 周四时间段 | 时间段范围0, 23 |
| fri | int[] | 周五时间段 | 时间段范围0, 23 |
| sat | int[] | 周六时间段 | 时间段范围0, 23 |
| sun | int[] | 周日时间段 | 时间段范围0, 23 |
| diverse_data | |||
|---|---|---|---|
| 字段 | 类型 | 说明 | 备注 |
| app_name | string | 应用名称 | |
| app_package_name | string | 应用包名 | |
| device_os_type | int | 应用操作系统类型 | 0：未知，1：ANDROID，2：IO |
| target | ||||
|---|---|---|---|---|
| 字段 | 类型 | 说明 | 备注 | |
| region | long[] | 地域 | ||
| district_ids | long[] | 商圈定向 | ||
| age | struct | 自定义年龄段 | 具体见下方表格 | |
| ages_range | int[] | 固定年龄段 | 【18：表示 18-23 岁】【24：表示 24-30 岁】【31：表示 31-40 岁】【41：表示 41-49 岁】【50：表示 50-100 岁】 | |
| gender | int | 性别 | 1：女性, 2：男性，0 表示不限 | |
| platform_os | int | 操作系统 | 1：Android，2：iOS，0 表示不限 | |
| android_osv | int | Android 版本 | 3：不限，4：4.x+，5：5.x+，6：6.x+，7：7.x+，8：8.x+，9：9.x+，10：10.x+,11:11.x+;12:12.x+,13:13.x+,14:14.x+ | |
| ios_osv | int | iOS 版本 | 6：不限，7：7.x+，8：8.x+，9：9.x+，10：10.x+； | |
| network | int | 网络环境 | 1：Wi-Fi，2：移动网络，0：表示不限 | |
| device_brand | int[] | 设备品牌 | 1：OPPO，2：VIVO，3：华为，4：小米，5：荣耀，6：三星，7：金立，8：魅族，9：乐视，10：其他，11：苹果 | |
| device_brand_ids | long[] | 设备品牌ID列表 | 传值为[]表示不限；当 platform为iOS定向时，没有设备品牌定向；1：苹果（platform字段为空时可选）；2：VIVO；3：OPPO；4：华为；5：小米；6：荣耀；7：三星；8：魅族；9：金立；10：HTC；11：联想；12：酷派；13：酷比；14：中兴；15：乐视；16：LG；17：中国移动；18：360；19：百度；20：努比亚；21：一加；22：海信；23：朵唯；24：美图；25：锤子；26：谷歌；27：小辣椒；28：诺基亚；29：康佳 | |
| device_price | int[] | 设备价格 | 1：1500 元以下（11:1000元以下，12:1001 | |
| fans_star | long[] | 网红粉丝 | ||
| interest_video | long[] | 兴趣视频用户 | ||
| app_interest | long[] | APP 行为-按分类 | ||
| app_ids | long[] | APP 行为-按 APP 名称 | ||
| app_names | str[] | app 名称 | 和 app_ids 对应，是 app_id 对应的名称 | |
| filter_converted_level | int | 过滤已转化 人群纬度 | 0(默认)：不限 1：广告组 2：广告计划 3：本账户 4：公司主体 5：APP | |
| population | long[] | 人群包定向 | ||
| exclude_population | long[] | 人群包排除 | ||
| media | long[] | 选填 | 媒体定向包 | |
| exclude_media | long[] | 选填 | 媒体定向排除包 | media 和 exclude_media 只可选其一 |
| media_source_type | int | 选填 | 媒体包来源 | 默认为 0，0-不限，未指定，1-行业优质流量包，2-广告主自定义 |
| intelli_extend | struct | 智能扩量 | 具体见下方表格 | |
| behavior_interest | struct | 行为兴趣定向，详情见下方 | 具体见下方表格 | |
| seed_population | long[] | 种子人群包 | 当账户开通种子人群包功能后方可使用此功能 | |
| celebrity | struct | |||
| ip_type | int | 地域IP类型 | 白名单可用，0-默认IP、1-广协IP |
| celebrity | ||||
|---|---|---|---|---|
| 字段 | 类型 | 是否必填 | 说明 | 备注 |
| behaviors | int[] | 该字段为平台对应快手网红功能中的行为类型，可多选，但不可不选，不选会导致快手网红定向失效，定义如下 0:关注、1:视频互动、2:直播互动 | ||
| fans_stars | fans_star[] | 该字段包括平台对应快手网红功能中的网红分类和快手网红两项，数据保证录入顺序，可从【快手网红-网红分类】和【快手网红-搜索快手网红】接口获取对应数据 |
| fans_star | ||||
|---|---|---|---|---|
| 字段 | 类型 | 是否必填 | 说明 | 备注 |
| id | string | 如使用该功能则必填此项，该字段有两种含义 1、当是网红分类，即type=1时，该字段传入对应网红分类对应的父ID与当前ID的拼接字符串，如传入"33-177"表示一级网红分类"游戏"下的二级网红分类"沙盒游戏"，如选中的是一级网红分类，则直接传入当前ID如"33" 2、当是快手网红，即type=2时，该字段传入对应快手网红的author_id，如传入"1151465119"表示快手网红小脑斧来自N次元 | ||
| type | int | 如使用该功能则必填此项，该字段为平台对应快手网红功能中的网红分类和快手网红两项，可从【快手网红-网红分类】和【快手网红-搜索快手网红】接口获取对应数据 1:网红分类、2:快手网红 | ||
| name | string | 如使用该功能则必填此项，该字段有两种含义 1、当是网红分类，即type=1时，该字段传入对应网红分类对应的父name与当前name的拼接字符串，如传入"游戏-沙盒游戏"表示一级网红分类"游戏"下的二级网红分类"沙盒游戏"，如选中的是一级网红分类，则直接传入当前ID如"游戏"，保证传入的值与传入id对应网红标签name（拼接）一致 2、当是快手网红，即type=2时，该字段传入对应快手网红的kwai_id，如传入"小脑斧来自N次元"表示快手网红小脑斧来自N次元，保证传入的值与传入id对应的快手网红的kwai_id保持一致 | ||
| category | int[] | 当是快手网红，即type=2时，该字段传值有效，对应当前快手网红的分类，格式为first_label_id,second_label_id，如果second_label_id不存在，则只传入first_label_id，如传入32, 241表示当前快手网红属于影视-影视分类二级网红分类 |
| age | |||
|---|---|---|---|
| 字段 | 类型 | 说明 | 备注 |
| min | int | 年龄最小限制 | 18 |
| max | int | 年龄最大限制 | 55 |
| intelli_extend | |||
|---|---|---|---|
| 字段 | 类型 | 说明 | 备注 |
| is_open | int | 开启智能扩量 | 0：关闭智能扩量，1：打开智能扩量 |
| no_age_break | int | 不可突破年龄 | 0：可突破/无需控制，1：不可突破 |
| no_gender_break | int | 不可突破性别 | 0：可突破/无需控制，1：不可突破 |
| no_area_break | int | 不可突破地域 | 0：可突破/无需控制，1：不可突破 |
| gift_data | |||
|---|---|---|---|
| 字段 | 类型 | 说明 | 备注 |
| target_action_type | int | 发送时机 | android:30： 开始下载后 31：下载完成后 32：安装完成后 ios：2：检测到用户行为 |
| code | string | 礼包码 | 最多 20 字符，只能字母+数字 |
| behavior | |||
|---|---|---|---|
| 字段 | 类型 | 说明 | 备注 |
| keyword | struct[] | 行为定向关键词，详情见下方 | |
| label | string[] | 行为定向，类目词 | |
| time_type | int | 在多少天内发生行为的用户 | 0:7 天 1：15 天 2：30 天 3：90 天 4：180 天 |
| strength_type | int | 行为强度 | 0：不限 1：高强度 |
| scene_type | int[] | 行为场景 | 1：社区 2：APP 4：推广 |
| keyword | |||
|---|---|---|---|
| 字段 | 类型 | 说明 | 备注 |
| id | long | 关键词 id | |
| name | string | 关键词名称 |
| interest | |||
|---|---|---|---|
| 字段 | 类型 | 说明 | 备注 |
| label | string[] | 兴趣定向类目词 |
| page_group_detail | 类型 | 说明 | 备注 |
|---|---|---|---|
| group_id | long | 程序化落地页组ID | |
| group_name | string | 程序化落地页组名称 | |
| page_review_detail | struct[] | 程序化落地页组下的页面信息 |
| page_review_detail | 类型 | 说明 | 备注 |
|---|---|---|---|
| page_id | long | 落地页ID | |
| review_status | string | 落地页审核状态 | 1-审核中 2-审核通过 3-审核拒绝 |
| review_detail | string | 落地页的审核拒绝理由 | |
| url | string | 落地页URL信息 |
| negative_word | |||
|---|---|---|---|
| 字段 | 类型 | 说明 | 备注 |
| exact_words | string[] | 精确否定词 | 搜索广告新增 |
| phrase_words | string[] | 短语否定词 | 搜索广告新增 |
| AdMarketCustomMiniAppData | |||
|---|---|---|---|
| 字段 | 类型 | 说明 | 备注 |
| mini_app_id_platform | string | 小程序APPID | |
| bootstrap_page | string | 小程序启动页面 | |
| bootstrap_params | string | 小程序启动参数 |
请求参数
Body 参数application/json
返回响应
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://ad.e.kuaishou.com/rest/openapi/v1/ad_unit/list' \
--header 'Content-Type: application/json' \
--data '{
"advertiser_id": 20000146,
"page":1,
"page_size":1
}'响应示例响应示例
{}
修改于 2023-10-23 08:25:53