1. 广告组
磁力引擎
  • M-API 注册认证问题Q&A
  • M-API咨询类问题Q&A
  • 快速入门
    • 如何开通快手mapi
  • Oauth2.0授权
    • 授权流程
    • scope 权限说明
    • token管理
      • token有效期&续期
      • 获取 token
      • 刷新 token
  • 账户服务
    • 广告主
      • 获取广告账户信息
      • 获取广告账户余额信息
      • 获取广告账户流水信息
    • 账户罗盘
      • 获取罗盘绑定广告主列
      • 磁力罗盘对外 quota 腾挪接口
    • 代理商
      • 上传资质文件
      • 获取账号信息和开户资质
      • 创建或更新账户信息和开户资质
      • 创建或更新投放资质
      • 可复制账户列表
      • 复制账户
  • 广告投放
    • 账户层级
      • 账户日预算查询
      • 修改账户预算
      • 账户操作记录信息查询
    • 创编2.0(已下线)
      • 广告计划
        • 创建广告计划
        • 修改广告计划
        • 获取广告计划信息
        • 修改广告计划预算
      • 广告组
        • 创建广告组
        • 创建联盟定投广告组
        • 创建搜索广告组
        • 创建搜索快投广告组
        • 修改广告组
        • 修改联盟定投广告组
        • 修改搜索广告组
        • 修改搜索快投广告组
        • 定向人群预估查询
        • 获取广告组信息
      • 广告创意
        • 创建创意
        • 创建程序化 2.0 创意
        • 批量创建&修改创意
        • 修改创意
        • 修改程序化 2.0 创意
        • 获取广告创意信息
        • 获取程序化创意 2.0 信息
    • 创编3.0(已下线)
      • 广告创建接口
      • 广告创建接口(广告组和广告创意)
      • 广告计划更新接口
      • 广告组更新接口
      • 广告创意更新接口(程序化创意和自定义创意)
      • 广告详情接口
      • 广告计划详情接口
      • 广告组详情接口
      • 广告创意详情接口
    • 智能化创编
      • 广告计划
        • 创建广告计划
        • 修改广告计划
        • 获取广告计划信息
        • 修改广告计划状态
      • 广告组
        • 创建广告组
          POST
        • 修改广告组
          POST
        • 查询广告组
          GET
        • 修改广告组预算
          POST
        • 修改广告组状态
          POST
        • 修改广告组出价
          POST
      • 广告创意
        • 创建自定义创意
        • 创建程序化创意
        • 修改自定义创意
        • 修改程序化创意
        • 批量修改自定义创意
        • 查询自定义创意
        • 查询程序化创意
        • 修改创意状态
        • 创意体验
        • 创意标签填写建议
        • 获取程序化创意 2.0 审核信息
      • 批量获取监测链接接口
        POST
      • 监测链接批量更新接口
        POST
    • 高级创意
      • 获取高级创意列表
      • 创建高级创意接口
      • 删除高级创意接口
    • 搜索广告投放工具
      • 关键词管理
        • 获取关键词列表
        • 创建关键词
        • 修改关键词匹配方式
        • 修改关键词投放状态
        • 批量导出关键词
        • 获取关键词导出文件
      • 否定词管理
        • 获取否定词列表
        • 更新否定词
  • 数据报表
    • 异步任务数据报表
      • 创建历史数据查询任务
      • 获取任务状态
      • 数据下载
    • 直播报表
      • 报表新增直播数据
      • 直播间组件报表
      • 直播间报表
    • 获取原生效果数据整体概览接口(数据概览、分日转化数据分布、转化漏斗)
    • 原生效果数据报表明细接口
    • 查询原生快手号列表(for原生报表)
    • 代理商数据(t-1 数据需要第二天 9 点以后获取)
    • 广告主数据(实时)
    • 广告计划数据(实时)
    • 广告组数据
    • 广告创意数据-自定义
    • 程序化创意 2.0 数据
    • 素材报表
    • 人群分析报表
    • 小店通转化数据报表
    • 程序化落地页报表
    • 获取商品库报表
    • 关键词报表
    • 搜索词报表
    • 探索工具关键报表数据
  • 素材管理
    • 图片素材
      • 上传图片 v1 接口【逐步废弃,请使用V2接口】
      • 上传图片 v2 接口
      • 查询图片信息 get 接口
      • 查询图片接口 list 接口
      • 图片库推送
      • 获取可选的封面贴纸样式
    • 视频素材
      • 上传视频接口 v1【逐步废弃,请使用V2接口】
      • 上传视频接口 v2
      • 获取视频信息 get 接口(可通过 photo_ids 查询所有视频)
      • 获取视频信息 list 接口推荐使用,仅能查询平台&MAPI 上传,可查 uid 下所有非素造视频)
      • 批量删除视频
      • 上传图文视频
    • 视频库
      • 视频库-推送视频
      • 视频库-推送视频(新版)
      • 视频库-批量更新视频功能
      • 视频库-删除视频标签
      • 视频关联创意数查询
    • 文件上传
      • 图文音频文件MAPI上传
  • 素造平台
    • 获取素造视频接口
  • 建站管理
    • 魔力建站落地页信息查询接口
    • 魔力建站落地页批量创建接口
    • 魔力建站落地页更新CID信息
    • 魔力建站营销组件-表单查询接口
    • 魔力建站预约下载信息查询接口
    • 魔力建站落地页组信息查询接口
    • 魔力建站落地页组创建接口
    • 魔力建站落地页组更新接口
    • 魔力建站落地页组删除接口
    • 魔力建站落地页投放开关接口
  • 线索管理-老铁线索通
    • 线索通-批量创建微信小游戏
    • 线索通-获取微信小游戏列表
    • 线索 crm 信息查询接口
    • 线索 crm 意向度/进度/通话状态更新接口
    • 发起外呼接口
    • 获取通话记录
    • 线索crm赔付线索回传接口
  • DMP人群管理
    • 文件上传接口(新)
    • 人群包创建接口(新)
    • 人群包更新接口(新)
    • 人群列表查询接口
    • 人群包删除接口
    • 人群包跨账户推送
    • 人群包上线接口
    • 系统推荐定向/排除人群包
  • 联合建模
    • 样本文件上传
    • 通过上传方式新建样本
  • 工具
    • 短句
      • 通过快手号id查询授权短剧接口
      • 通过短剧id查询剧集列表
      • 获取授权的短剧作者列表
    • 查询工具
      • 创意相关
        • 获取创意推荐理由
      • 获取可选的深度优化目标
      • 获取可选的浅度优化目标
      • 获取可选的定向标签
      • 获取可选的应用定向
      • 获取可选的推荐封面
      • 获取可选的动态词包
      • 获取行动号召按钮
      • 获取可选的封面贴纸样式
      • 获取可用的转化目标
      • 获取可选白名单接口
      • 获取地域定向
      • 获取商圈地域定向
      • 获取可用咨询组件列表
      • MAPI Quota 白盒化
      • 获取创意分类查询接口
      • 快手网红-网红分类
      • 种子人群包列表
      • 快手网红-搜索快手网红
    • 功能名单
      • 获取创意分类标签白名单客户
      • 获取联盟投放白名单
    • 评论管理
      • 评论列表数据查询
      • 回复评论
      • 评论树查询
      • 屏蔽评论
      • 增加屏蔽评论信息
      • 删除屏蔽评论信息
      • 获取屏蔽评论信息列表
      • 评论管理-评论置顶
      • 评论管理-取消评论置顶
    • 应用列表
      • 获取应用列表
      • 应用权限信息列表接口
    • 行为兴趣标签-创意层级
      • 获取行为与兴趣"类目"
      • 获取行为兴趣"关键词"
    • 定向模板(新)
      • 创建定向模板
      • 更新定向模板
      • 查询定向模板
      • 删除定向模板
      • 定向模板同步
      • 模板同步失败查询
      • 查询模板关联的广告列表接口
      • 查询待升级模板列表
      • 模板升级
    • 小说库
      • 获取小说列表
      • 获取小说详情
      • 获取小说各分类枚举
      • 创建小说
      • 小说批量更新
      • 小说批量删除
      • 批量下载小说图片接口
      • 小说报表
      • 小说批量分享
    • 联盟自定义媒体包
      • 联盟定向媒体包创建
      • 联盟定向媒体包修改
      • 联盟定向媒体包删除
      • 获取联盟定向媒体包列表
      • 联盟定向媒体包广告位报表
    • 游戏试玩
      • 上传试玩素材
      • 直存试玩
      • 获取试玩按钮列表
      • 获取试玩列表
      • 试玩推送
      • 查看共享账户
    • 商品库
      • 商品库各行业商品数据校验规则
      • 查询 DPA 模板信息
      • 获取商品库列表
      • 获取商品库类目树
      • 创建商品
      • 更新商品
      • 获取商品列表
      • 获取商品列表(部分信息)
      • 获取商品列表(游标)
      • 获取SDPA创意视频模板
      • 批量模板合成SDPA创意视频
    • 出价建议
      • 批量获取广告组出价建议
      • 获取广告组曝光、转化预估
      • 获取广告组投放预估曲线
    • 直播推广
      • 获取主播列表
      • 获取直播间小铃铛列表
    • 探索工具
      • 一键复苏开启
      • 一键复苏关闭
      • 加速探索-开启接口
      • 加速探索关闭
      • 辅助探索开启
      • 探索工具状态查询
      • 探索工具报表
      • 探索工具使用记录
      • 探索工具关键报表数据
    • 智能托管
      • 枚举说明
      • 智能托管创建及更新接口
      • 智能托管状态更新
      • 智能托管删除接口
      • 获取智能托管详情接口
      • 获取智能托管物料接口
      • 智能托管报表接口
      • 分小说展开效果数据接口
    • 投前预估
      • 创建投前预估任务
      • 投前预估详情
      • 投前预估列表
      • 投前预估任务管理
    • 原生广告投放工具
      • 隐藏视频同步至个人主页
      • 获取快手号授权列表
      • 快手号授权接口
      • 获取达人原生视频列表接口
      • 共享授权接口
      • 共享授权结果
      • 共享授权-获取已共享授权授权记录
      • 获取原生快手号列表接口
      • 本地视频上传接口
  • 频控和创建限制
    • 频控和创建限制
    • 接口调用分级使用
  • 磁力聚星
    • 投后数据
      • 星视频--查询订单的投后数据
      • 星任务(视频)-查询任务的投后数据
      • 星任务(视频)-查询订单的投后数据
  • 转化归因
    • 转化归因信息合辑
      • 转化归因信息合辑
  • 应用管理
    • 接入前言
    • 文件上传【必选】
      • 【应用中心】上传 APK 文件
      • 【应用中心】上传图片
    • 应用创编【必选】
      • 【应用中心】创建 Android 应用
      • 【应用中心】创建 iOS 应用
      • 【应用中心】编辑 Android 应用
      • 【应用中心】更新 iOS 应用
    • 应用查询For单元投放【必选】
      • 获取新版应用发布列表【单元创编】
      • 获取新版分包发布列表【单元创编】
    • 应用查询For应用中心【可选】
      • 【应用中心】获取应用列表
      • 【应用中心】获取应用详情
    • 应用共享【可选】
      • 【应用中心】添加应用共享
      • 【应用中心】取消应用共享
      • 【应用中心】获取应用已共享账号列表
      • 【应用中心】获取应用已共享主体列表
      • 【应用中心】获取单个主体下共享账号列表
      • 【应用中心】获取可共享的主体列表
      • 【应用中心】获取可共享的账号列表
    • 应用操作【可选】
      • 【应用中心】iOS 应用上报更新
      • 【应用中心】发布应用
      • 【应用中心】应用上架
      • 【应用中心】应用下架
      • 【应用中心】应用商店上下架
    • 应用分包【可选】
      • 【应用中心】新建应用分包
      • 【应用中心】更新/恢复/删除应用分包
      • 【应用中心】修改应用分包备注
      • 【应用中心】获取分包管理/回收站列表
      • 【应用中心】分包失败,重新构建
    • 其他接口【可选】
      • 【应用中心】获取应用尚未发布的最新的应用包信息
      • 【应用中心】获取应用版本记录
      • 获取新版应用发布详情
      • 人群包数据
  • 附录
    • 3.0创编接口改动
    • 报错 code 枚举值
  1. 广告组

创建广告组

开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
POST
https://ad.e.kuaishou.com/rest/openapi/gw/dsp/unit/create

请求参数#

字段类型是否必填说明备注
advertiser_idlong必填广告主 ID在获取 access_token 的时候返回
campaign_idlong必填广告计划 ID
unit_namestring必填广告组名称长度为 1-100 个字符,同一个计划下的广告组名称不能重复
put_statusint选填广告组的投放状态1:广告组投放中;2:广告组暂停投放;当不传或为 null 时,会默认填充 1
bid_typeint必填优化目标出价类型2:CPC(计划类型为粉丝直播推广、DPA不支持,计划出价为MCB不支持;广告组选择开屏不支持;搜索广告需要添加白名单才可支持);10:OCPM ;12:MCB最大转化(当计划bid_type=1时,组层级bid_type必须传12)
bidlong选填出价bid_type 为 CPC 时该字段必填,单位:厘,不得低于 0.2 元,不得高于 100 元,不得高于组预算
cpa_bidlong选填出价bid_type 是 OCPM 时该字段必填,单位:厘,ocpx_action_type 为 2 时,不得低于 0.1 元,不得高于 10 元;ocpx_action_type 为 180 时,不得低于 1 元,不得高于 3000 元,ocpx_action_type 为 53 时,不得低于 5 元,不得高于 3000 元;不得高于组预算
ocpx_action_typeint选填优化目标bid_type 是 OCPM 时该字段必填,需通过接口「rest/openapi/gw/dsp/v1/ocpx/ocpxTypes」获取可以选择的优化目标;;2:行为数(actionBar 点击);180:激活数;53:表单数;109:电话卡激活;137:量房;190: 付费;191:首日 ROI;324:唤起应用(campaign_type=7+主站+加白);348:有效线索;383: 授信;384: 完件 394:订单提交;(计划类型获取电商下单,非金牛);396:注册(联盟暂不支持);715:微信复制优化目标;(campaign_type=5&bid_type=10);716:多转化事件(campaign_type=5&bid_type=10&使用魔力建站&线索转化类组件>=2 种);717:广告观看次数(campaign_type=2&bid_type=10&app与转化追踪工具联调过或者该广告主的在相应事件的回传数>=1);731:广告观看 5 次;732:广告观看 10 次;733:广告观看 20 次;773:关键行为;774:7 日 ROI;72:小店通商品和主页推广,转化目标“涨粉”;739:7 日付费次数;392:小店通商品推广,优化目标“转化数”,转化目标“商品访问”;395:小店通商品和主页推广,转化目标“订单支付”,62:直播观看数,(小店直播推广&商品推广支持,计划 type=14、13);192:直播推广 ROI;(小店直播推广&商品推广支持,计划 type=14、13);634:预约表单;635:预约点击跳转。需通过接口「获取可选的深度转化类型」,接口 is_order_paied 字段返回值为 1 才可以使用; 810:激活付费;346:自然日次日留存
deep_conversion_typeint选填深度转化目标通过接口「/rest/openapi/gw/dsp/v1/ocpx/deepTypes」获取可以选择深度转化目标;3:付费,7:次日留存,10:完件, 11:授信;13:添加购物车;14:提交订单;15:购买;44:有效线索;92:付费 roi;181:激活后24H次日留存。
enhance_conversion_typeint选填增强目标8:7日留存
roi_ratiodouble选填付费 ROI 系数优化目标为「首日 ROI、7日ROI出价」时必填:ROI 系数取值范围 ( 0,100 ] 最多支持到三位小数(如:0.066)
deep_conversion_bidlong选填深度转化目标出价单位:厘,仅当 deep_conversion_type 可用且账户满足白名单时选填,出价需大于 cpa_bid,小于 min{组预算,3000 元},不得高于组预算,不支持从 0 改为其他值,也不支持从其他值改为 0
scene_idint[]必填资源位置1:优选广告位(当账户在联盟优选白名单中且 campaign_type=2/3/5/7 时为主站&联盟优选广告位 );5:联盟广告;(对应DSP后台unit层级选择联盟广告位);6:上下滑大屏广告(计划 campaignType=16 粉丝直播推广时,仅支持填写 6);10:联盟场景;当账户在联盟优选白名单中且 campaign_type = 2/3/5/7,可传 10;当账户不在联盟优选白名单中或 campaign_type 不等于 2/3/5/7 时,不可传 10;(对应DSP后台创意层级选择联盟广告位);24:激励视频(需要加白后可选);27:开屏广告位(白名单功能);39:搜索广告
unit_typeint必填创意制作方式3:DPA 自定义创意(仅在计划类型为商品库推广下使用) 4: 常规自定义创意; 7:程序化创意 2.0
begin_timestring必填投放开始时间格式为 yyyy-MM-dd,需大于等于当前时间
end_timestring选填投放结束时间格式为 yyyy-MM-dd,不传值表示从今天开始长期投放,传值表示设置开始时间和结束时间,且投放结束时间需大于等于投放开始时间,开屏如果选择按开始时间和结束时间投放,时间(end_time - begin_time)必须超过三天
schedule_timestring选填投放时间段格式为 24*7 位字符串,且都为 0 和 1,以一个小时为最小粒度,从周一零点开始至周日 24 点结束;0 为不投放,1 为投放,不传/全传 1/全传 0 视为全时段投放
day_budgetlong选填单日预算单位:厘,指定 0 表示预算不限,默认为 0;每天不小于 100 元,不超过 100000000 元,仅支持输入数字;修改预算不得低于该广告组当日花费的 120%,与 day_budget_schedule 不能同时传,均不能低于组出价
day_budget_schedulelong[]必填分日预算单位:厘,指定 0 表示预算不限,默认为 0;每天不小于 100 元,不超过 100000000 元,仅支持输入数字;修改预算不得低于该计划当日花费的 120%,与 day_budget 不能同时传,均不能低于该计划下任一广告组出价,优先级高于day_budget
convert_idint选填转化目标 ID可通接口【/rest/openapi/v1/tool/convert/list】获得,不同计划类型需要对应各自的转化目标类型:提升应用安装(campaign_type=2) - 安卓:convert_type:3、7 / IOS:convert_type:7;推广品牌活动(campaign_type=4) / 收集销售线索(campaign_type=5):convert_type:1、2 收集销售线索营销目标下,建站落地页程序化落地页不支持convertId,自有落地页仅支持convert_type=1的场景
url_typeint选填url 类型当计划类型为获取电商下单(campaign.type=3)时必填,其它场景下无效;3 - 手淘落地页(深度唤醒手机淘宝,scene_id为5时联盟场景不可用)
web_uri_typeint选填url 类型当计划类型为收集销售线索、提升应用活跃(campaign.type = 5/7 )且使用建站落地页时必填;1:广告主自有链接,默认填充值; 2:建站落地页,此时siteId_id 需要填充;3:程序化落地页,此时group_id需要填充(仅收集营销线索下可用) ;4:微信小程序调起链接(仅收集营销线索下且scene_id包含5可用);
urlstring选填投放链接长度不超过 1000 字符;计划类型是获取电商下单(campaign.type=3),url_type = 3 时表示手淘落地页;计划类型是 4(推广品牌活动):落地页 URL;web_uri_type = 1 时表示客户自有链接必填;web_uri_type = 4 时表示小程序的落地页;「房地产」「家装建材」「招商加盟」三个二级行业【收集销售线索】目标下隐藏客户自有链接填写入口。
site_idlong选填建站ID/下载中间页ID当 web_uri_type = 2 时表示建站 ID,必须为数字,通过「/rest/openapi/v2/lp/page/list」 获取。计划类型是2(提升应用安装)且关联应用为安卓时,表示安卓下载中间页ID,通过「/rest/openapi/v2/lp/page/list」 获取 "view_comps = 7" 的建站ID。
group_idlong选填程序化落地页IDweb_uri_type = 3 时表示程序化落地页ID,必须为数字,通过「/rest/openapi/gw/magicsite/v1/group/list」获取;
schema_uristring必填调起链接提升应用活跃营销目标的调起链接;应用推广下在已经安装 app 的用户手机上可以拉起 app(需要运营加白),开屏广告如果营销目标是应用活跃,调起链接必须在品牌开屏白名单中;当 web_uri_type = 4 时,该字段必填,表示带归因参数的小程序启动页面链接,当campaign.type=5时,白名单用户可填。campaign.type=9 时,若该字段非空,使用该链接唤起应用,否者使用商品上的链接直达商品
schema_idString选填微信小程序ID收集营销线索下,web_uri_type = 4时生效,表示微信小程序ID
app_idlong必填应用 ID当计划类型为 提升应用活跃/提升应用安装/商品库推广(campaign.type = 2/7/9) 时必填,可通过应用列表接口「/rest/openapi/v2/file/ad/app/list」获取应用 ID;当计划类型为粉丝直播推广(campaign.type = 16),且组件类型为小铃铛关联了应用时必填;
app_download_typeint选填应用下载方式0 - 直接下载;1 - 落地页下载;仅在提升应用活跃(默认是直接下载)、提升应用安装(默认是落地页下载)下白名单生效。
download_page_urlstring选填自定义落地页URL选择落地页下载方式时的自定义落地页URL,仅在提升应用活跃和提升应用安装下生效,site_id 优先级高于此字段,白名单功能
use_app_marketint选填优先从系统应用商店下载0:不从应用商店下载;1:优先从应用商店下载。【填充为1的前提:提升应用活跃、提升应用安装计划类型且选择的应用为安卓。收集营销线索计划类型且选择的建站落地页关联了安卓APP】
app_storestring[]选填应用商店列表huawei:华为; oppo:OPPO;vivo:VIVO;xiaomi:小米;meizu:魅族;smartisan:锤子 。【仅当use_app_market=1时生效】
show_modeint选填创意展现方式1 - 轮播;2 - 优选(默认)
site_typeint加白预约广告1 - IOS预约;2 - ANDROID 预约;【仅在计划类型为收集营销线索,web_uri_type = 2 时生效】
smart_coverbooleanunit_type=7 选填程序化创意 2.0 智能抽帧是否开启智能抽帧
asset_miningbooleanunit_type=7 选填程序化创意 2.0 素材挖掘是否开启历史素材挖掘
consult_idlong选填:从工具-获取可选咨询组件咨询组件 id1、仅可被用于线索类计划下的 unit;2、仅当落地页使用了建站落地页或者建站程序化落地页时可使用;3、注意本字段不可被更新;4、本属性不可与附加表单组件(component_id)同时使用;通过「/rest/openapi/v2/lp/consult/list」接口获取
adv_card_optionint选填高级创意开关0:关闭 1:开启
adv_card_listlong[]选填绑定卡片 idcard_type=100 为 1 个;card_type=101 为 3 个;card_type=102 为 3 个;card_type=103 为 1 个;通过接口「/rest/openapi/v1/asset/adv_card/list」获取
playable_idLong选填试玩 ID可选字段,开启试玩时存在,否则不存在。当用户上传试玩素材成功时返回,用于之后对于广告组中试玩创意的编辑操作。通过接口「 /rest/openapi/gw/dsp/v1/playable/list 」 获取
play_buttonString选填试玩按钮文字内容开启试玩时存在,否则不存在,示例按钮内容如下:1:立即试玩;2:试玩一下;3:立即体验;4:免装试玩;5:免装体验。启用试玩时:默认“立即试玩”,未启用试玩时:内容为空。通过接口「/rest/openapi/gw/dsp/v1/playable/play_buttons」获取
dpa_unit_paramstruct选填DPA 相关商品信息当计划类型为商品库推广时必填。
jingle_bell_idlong选填小铃铛组件id计划 campaignType=16 粉丝直播推广时必填写
live_user_idlong选填主播id计划 campaignType=16 粉丝直播推广时必填写, 计划 campaignType=30 短剧推广时,必填,值为短剧作者ID
conversion_typeint选填转化途径计划 campaignType=16 粉丝直播推广时必填写 6
extend_searchboolean选填智能扩词开启状态false:关闭,true:开启,不填默认为false
custom_mini_app_datastruct选填推广小程序营销目标小程序信息计划 campaignType=19 推广快手小程序时必填,具体见下方表格。 具体见下方表格
targetstruct必填定向数据具体见下方表格
template_idlong选填定向模板 id此字段关联到定向信息后,target 字段失效。会将关联的定向信息填充到广告组中。
outer_loop_nativeint选填是否开启原生0关闭,1开启,不填默认为0仅在计划 campaignType=2提升应用安装、5收集销售线索、7提升应用活跃、19推广快手小程序、30快手号-短剧推广时,可开启原生投放。
quick_searchint选填搜索快投开关0:不开启(默认填充);1:开启搜索快投;
target_exploreint选填搜索人群探索0:不开启;1:开启;开启后系统将基于用户搜索行为探索定向人群以外的更多优质人群,仅在 quick_search = 1时生效;
negative_word_paramstruct选填搜索广告否词设置否词必填
package_idlong必填新版应用中心,应用包ID使用新版应用中心投放,该字段必填;老版本应用非必填 获取母包接口文档 获取分包接口文档
series_idlong选填短剧id当计划 campaignType=30 短剧推广时,必填
episode_idlong选填短剧下剧集id当计划 campaignType=30 短剧推广时,必填
series_card_typeint选填是否使用短剧卡片0关闭,1开启,默认关闭,仅在计划 campaignType=30快手号-短剧推广时支持开启使用短剧卡片
series_card_infostruct选填短剧卡片信息开启短剧卡片时,必填,具体见下方表格

target#

字段类型是否必填说明备注
regionlong[]选填地域传值为[]表示不限;传递上一级 ID 时,childrenID 可以不传;不允许同时传 parentID 和 childrenID;地域信息可通过地域接口获取;仅计划的 campaign_type 为 5 时,支持设置三级地域(例:山西-大同-左云,左云是三级地域)
district_idslong[]选填商圈定向与 region 字段不能同时传、白名单控制,最多选 100 个。可以通过/rest/openapi/v1/region/district/list 接口获取商圈信息。该定向仅支持快手站内广告位,不支持联盟广告位。
user_typeint选填用户类型0:实时;1:常驻;2:不限
agestruct选填自定义年龄段不传值表示不限,传值具体见下方表格;与 ages_range 不能同时传
ages_rangeint[]选填固定年龄段与 age 不能同时传;【18:表示 18-23 岁】;【24:表示 24-30 岁】;【31:表示 31-40 岁】;【41:表示 41-49 岁】;【50:表示 50-100 岁】
genderint选填性别1:女性, 2:男性,0 表示不限
platform_osint选填操作系统1:Android,2:iOS,0 表示不限;当计划类型为 2(提升应用安装)时该字段可忽略
android_osvint选填Android 版本3:不限,4:4.x+,5:5.x+,6:6.x+,7:7.x+,8:8.x+,9:9.x+,10:10.x+;当计划类型为 2(提升应用安装),7(提升应用活跃)时,仅当 app_id 表示的是 Android 应用可使用此字段传递版本
ios_osvint选填iOS 版本6:不限,7:7.x+,8:8.x+,9:9.x+,10:10.x+;11:11.x+;12:12.x+;13:13.x+;14:14.x+;15:15.x+;16:16.x+;当计划类型为 2(提升应用安装),7(提升应用活跃)时,仅当 app_id 表示的是 IOS 应用可使用此字段传递版本
networkint选填网络环境1:Wi-Fi,2:移动网络,0:表示不限
device_brand_idslong[]选填设备品牌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_priceint[]选填设备价格1:1500元以下(近期下线),新增 11:1000元以下,12:10011500,请直接使用新枚举值; 2:15012000,3:20012500,4:25013000,5:30013500,6:35014000,7:40014500(近期下线),新增:13:40015000; 8:45015000(近期下线),新增:13:40015000; 9:50015500(近期下线),新增:14:50016000; 10:5500元以上(近期下线),新增:15:6000元以上;传值为[]表示不限;
app_interest_idslong[]选填APP 行为-按分类id 不能重复且必须准确,具体 id 可通过下方标签接口获取;仅包含安卓数据,若操作系统定向 IOS 则无效;不能同时选择 app_ids(新标签体系字段,替换 app_interest,与 app_interest 同时传递,app_interest 字段失效)。该定向仅支持快手站内广告位,不支持联盟广告位。
app_idslong[]选填APP 行为-按 APP 名称id 不能重复且必须准确,具体 id 可通过下方应用接口获取,建议不超过 10 个,否则可能出现报错;仅包含安卓数据,若操作系统定向 IOS 则无效;不能同时选择 app_interest。该定向仅支持快手站内广告位,不支持联盟广告位。
filter_converted_levelint选填过滤已转化人群纬度搜索广告、联盟广告、小店通不支持。优化目标不支持【封面曝光数】和【封面点击数】非应用下载类推广不支持过滤【APP】纬度。0(默认):不限;1:广告组 2:广告计划;3:本账户;4:公司主体;5:APP;6:运营自定义产品名
populationlong[]选填人群包定向/rest/openapi/v1/dmp/population/list 获取人群包 id。population 不能重复,与 exclude_population 不能有交集,不能传付费人群包,付费人群包标识字段:population_type=7
exclude_populationlong[]选填人群包排除/rest/openapi/v1/dmp/population/list 获取人群包 id。exclude_population 不能重复,不能传付费人群包,付费人群包标识字段:population_type=7
paid_audiencelong[]选填付费人群包 id/rest/openapi/v1/dmp/population/list 获取人群包 id。1、不能重复,只能传付费人群包,且 third_platform_code 要一样,2、如果传了【population 或 exclude_population】,报错;修改时要也要保证【population 或 exclude_population】不能同时传。3、创建时若已经有了【population 或 exclude_population】修改时只传 paid_audience 也会报错,这时需要把 population 或 exclude_population】设为[]才行,反之也一样。总之,【population 或 exclude_population】与【paid_audience】不能同时存在。该定向仅支持快手站内广告位,不支持联盟广告位。
seed_populationlong[]选填种子人群包当账户开通种子人群包功能后方可使用此功能。该定向仅支持快手站内广告位,不支持联盟广告位。
intelli_extend_optionint选填智能定向开关0:智能定向关闭;1:智能定向开启【计划层级开启智能调控时,只能传1】;当计划层级开启了自动调控功能,不传默认智能定向开启状态,其他清空默认智能定向关闭。
behavior_typeint条件必填行为兴趣类型0:不限;1:自定义行为意向;2:行为意向系统优选,联盟广告位不支持。当target定向字段不为null时,此字段必填,无默认值。
behavior_intereststruct选填行为兴趣定向behavior.keyword 、behavior.label、interest.lable 其中一个必传,具体传值下方表格;仅在 behavior_type = 1 时生效。联盟广告位不支持interest。
disable_installed_app_switchint选填过滤已安装人群维度0:过滤(默认),1:不限
filter_time_rangeint选填用户的转化时间范围0:30天;1:60天;2:90天。该定向仅支持快手站内广告位,不支持联盟广告位。
celebritystruct选填快手网红behaviors、fans_star两个字段必填充。该定向仅支持快手站内广告位,不支持联盟广告位。
medialong[]选填媒体定向包若选择使用定向行业优质流量包(media_source_type = 1),此处单选:1 - 超休闲游戏;2 - 重度游戏;4 - 直营电商;5 - 平台电商;若选择使用广告主自定义媒体包(media_source_type = 2),此处多选,填写媒体包 id【仅联盟广告位生效】
exclude_medialong[]选填媒体定向排除包media 和 exclude_media 只可选其一,若选择使用排除行业优质流量包(media_source_type = 1),此处单选:1 - 超休闲游戏;2 - 重度游戏;4 - 直营电商;5 - 平台电商;若选择使用广告主自定义媒体包(media_source_type = 2),此处多选,填写媒体包 id;【仅联盟广告位生效】
media_source_typeint选填媒体包来源默认为 0,0-不限,未指定,1-行业优质流量包,2-广告主自定义
ip_typeint选填地域IP类型白名单可用,0-默认IP、1-广协IP
auto_populationint选填智能人群包白名单可用,0-默认、1-智能人群包勾选。加白账户在计划层级开启智能操盘时必须为1

celebrity#

字段类型是否必填说明备注
behaviorsint[]必填行为类型该字段为平台对应快手网红功能中的行为类型,可多选,但不可不选,不选会导致快手网红定向失效,定义如下 0:关注、1:视频互动、2:直播互动
fans_starsfans_star[]必填网红内容该字段包括平台对应快手网红功能中的网红分类和快手网红两项,数据保证录入顺序,可从【快手网红-网红分类】和【快手网红-搜索快手网红】接口获取对应数据

fans_star#

字段类型是否必填说明备注
idstring如使用该功能则必填此项,该字段有两种含义 1、当是网红分类,即type=1时,该字段传入对应网红分类对应的父ID与当前ID的拼接字符串,如传入"33-177"表示一级网红分类"游戏"下的二级网红分类"沙盒游戏",如选中的是一级网红分类,则直接传入当前ID如"33" 2、当是快手网红,即type=2时,该字段传入对应快手网红的author_id,如传入"1151465119"表示快手网红小脑斧来自N次元
typeint如使用该功能则必填此项,该字段为平台对应快手网红功能中的网红分类和快手网红两项,可从【快手网红-网红分类】和【快手网红-搜索快手网红】接口获取对应数据 1:网红分类、2:快手网红
namestring如使用该功能则必填此项,该字段有两种含义 1、当是网红分类,即type=1时,该字段传入对应网红分类对应的父name与当前name的拼接字符串,如传入"游戏-沙盒游戏"表示一级网红分类"游戏"下的二级网红分类"沙盒游戏",如选中的是一级网红分类,则直接传入当前ID如"游戏",保证传入的值与传入id对应网红标签name(拼接)一致 2、当是快手网红,即type=2时,该字段传入对应快手网红的kwai_id,如传入"小脑斧来自N次元"表示快手网红小脑斧来自N次元,保证传入的值与传入id对应的快手网红的kwai_id保持一致
categoryint[]当是快手网红,即type=2时,该字段传值有效,对应当前快手网红的分类,格式为first_label_id,second_label_id,如果second_label_id不存在,则只传入first_label_id,如传入32, 241表示当前快手网红属于影视-影视分类二级网红分类

age#

字段类型是否必填说明备注
minint必填年龄最小限制年龄区间最小为 18 岁
maxint必填年龄最大限制年龄区间最大为 55 岁,且年龄最大限制须大于等于年龄最小限制

behavior_interest#

字段类型是否必填说明备注
behaviorstruct必填行为定向behavior 与 interest 同时不传,则清空行为兴趣定向
intereststruct选填兴趣定向behavior 与 interest 同时不传,则清空行为兴趣定向

behavior#

字段类型是否必填说明备注
keywordstruct[]选填行为定向关键词根据/rest/openapi/v1/tool/keyword/query 接口获取
labelstring[]选填行为定向 类目词根据/rest/openapi/v1/tool/label/behavior_interest 接口获取。将行为类目 id 从最高层类目 id 开始,以“-”连接起来,假如有一个类目 id 为 80202,父类目 id 为 802,最高层类目 id 为 8,则此时应该写"8-802-80202";如果想全选最高层类目"8"底下的所有子类目,填"8"
time_typeint必填在多少天内发生行为的用户0:7 天;1:15 天;2:30 天;3:90 天;4:180 天
strength_typeint必填行为强度0:不限;1:高强度
scene_typeint[]必填行为场景1:社区;2:APP;3:电商;4:推广

keyword#

字段类型是否必填说明备注
idlong必填关键词 idid 与 name 需互相匹配
namestring必填关键词名称id 与 name 需互相匹配

interest#

字段类型是否必填说明备注
labelstring[]选填兴趣定向类目词根据/rest/openapi/v1/tool/label/behavior_interest 接口获取。将兴趣类目 id 从最高层类目 id 开始,以“-”连接起来,假如有一个类目 id 为 80202,父类目 id 为 802,最高层类目 id 为 8,则此时应该写"8-802-80202";如果想全选最高层类目"8"底下的所有子类目,填"8"
strength_typeint必填兴趣标签强度0:不限 1:高强度

dpa_unit_param#

字段类型是否必填说明备注
dpa_unit_sub_typeint选填商品广告类型商品广告必填:1-DPA,2-SDPA,3-动态商品卡(2/3在提升应用安装、提升应用活跃、收集营销线索、小程序推广营销目标下可用)
library_idlong选填商品库ID商品广告必填
product_idstring选填快手商品IDSDPA必填
outer_idstring选填外部商品IDSDPA必填
click_urlstring选填点击跳转监测链接DPA可用(scene_id = 5 须在 creative 填写)
actionbar_click_urlstring选填Actionbar点击跳转监测链接DPA可用(scene_id = 5 须在 creative 填写)
impression_urlstring选填曝光监测链接,DPA可用(scene_id = 5不支持)DPA可用
dpa_outer_idsString[]选填DPA 商品ID集合DPA可用(仅scene_id = 5支持),与dpa_category_ids 二选一, 两者并存优先dpa_outer_ids
dpa_category_idsString[]选填DPA商品类目集合DPA可用。类目 ID 通过商品库类目信息接口获取。类目之间用 - 分隔,如:"一级类目ID-二级类目ID-三级类目ID" 或 "一级类目ID"。与 dpa_outer_ids 二选一,两者皆空则全类目投放

custom_mini_app_data#

字段类型是否必填说明备注
mini_app_id_platformstring选填小程序APPID计划 campaignType=19 推广快手小程序时必填,不能超过30个字符。 注:当账户加了小游戏推广白名单时,不需要填写。
bootstrap_pagestring选填小程序启动页面跳转小程序时将直接进入该页面,计划 campaignType=19 小程序推广时必填。例:page/app/index。注:当账户加了小游戏推广白名单时,必填。
bootstrap_paramsstring选填小程序启动参数启动参数可以追踪页面来源,计划 campaignType=19 小程序推广时选填。例:name=lilei&age=18。注:当账户加了小游戏推广白名单时,不需要填写。

negative_word_param#

字段类型说明备注
exact_wordsstring[]精确否定词搜索广告新增
phrase_wordsstring[]短语否定词搜索广告新增

series_card_info#

字段类型是否必填说明备注
pic_idlong选填短剧卡片封面图片比例3:4,仅支持PNG/JPEG/JPG,图片不能大于2M
labelstring[]必填短剧卡片标签『专属推荐』、『口碑好剧』、『本月精品』、『本月热播』、『爽文改编』五选二
descriptionstring必填短剧卡片简介不超过100个字,若选择开启短剧卡片,该字段必填

请求参数

Body 参数application/json

示例

返回响应

🟢200成功
application/json
Bodyapplication/json

请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location 'https://ad.e.kuaishou.com/rest/openapi/gw/dsp/unit/create' \
--header 'Content-Type: application/json' \
--data '{
        "advertiser_id": 20000152,
        "campaign_id": 2342062,
        "unit_name":"market api 创建计划",
        "bid_type":6,
        "cpa_bid": 20000,
        "ocpx_action_type": 2,
        "scene_id": [3],
        "unit_type": 4,
        "begin_time":"2019-05-01",
        "end_time":"2019-05-13",
        "url":"https://www.kuaishou.com",
        "show_mode":1,
        "target": {
        	"region":[56576],
        	"age": {
            	"min": 5,
            	"max": 55
        	},
        	"gender": 0
        }
}'
响应示例响应示例
{
    "code": 0,
    "message": "string",
    "data": {
        "unit_id": 0
    }
}
修改于 2023-10-24 03:17:58
上一页
修改广告计划状态
下一页
修改广告组
Built with