快手广告组详情接口（上）

当前位置：首页 > 疑难解答

疑难解答

快手广告组详情接口（上）

发布时间：2024-01-04浏览次数：130

快手广告组详情接口

请求方式：POST

数据格式：JSON

快手广告组详情接口

请求参数

字段	类型	示例值	是否必填	说明	备注
unit_id	Long	182729271	必填	快手广告组ID

返回参数

字段	类型	示例	说明	备注
code	Integer	1	1为成功，非1为失败
message	String		错误详细信息
data	Struct		快手广告组详情

data

字段	类型	示例值	说明	备注
campaign_id	Long	123121231	快手广告计划ID
unit_id	Long	123131726	快手广告组ID
name	String	快手广告组测试	快手广告组名称	长度为 1-100 个字符，同计划下单元名称不能重复
bid_type	Integer	1	出价类型	10：OCPM； 12：转化
cpa_bid	Long	1000	出价，单位厘	单位：厘。bid_type 是 OCPM且ocpx_action_type非roi类目标时该字段必填。ocpx_action_type 为 2 时，不得低于 1 元，不得高于 3000 元；ocpx_action_type 为 180 时，不得低于 1 元，不得高于 3000 元，ocpx_action_type 为 53 时，不得低于 5 元，不得高于 3000 元；不得高于组预算
ocpx_action_type	Integer	2	浅层优化目标	由接口/rest/openapi/gw/dsp/v1/ocpx/ocpxTypes拉取得到。当bid_type是OCPM/转化时该字段必填。
deep_conversion_type	Long	2	深度优化目标	由接口/rest/openapi/gw/dsp/v1/ocpx/deepTypes拉取得到。当ocpx_action_type所代表的优化目标支持深度优化目标时可用。
deep_conversion_bid	Long	0	深度目标的出价	当deep_conversion_type非0且不是roi类目标时，本出价代表deep_conversion_type目标的出价。单位：厘。本出价必须高于cpa_bid的出价值，且不能超过10000元。当deep_conversion_type非0且非roi类目标时，本出价亦可设置为0，此时代表尝试优化而非保证优化，请谨慎选择。
day_budget	Long	0	统一预算	0表示不限，优先级低于 budget_schedule
budget_schedule	Long[]	0	分日预算	优先级高于day_budget
begin_time	Long	0	快手广告投放开始时间	格式：13位毫秒时间戳
end_time	Long	0	快手广告投放结束时间	格式：13位毫秒时间戳。不传值表示从今天开始长期投放，传值表示设置开始时间和结束时间，且快手广告投放结束时间需大于等于快手广告投放开始时间，开屏如果选择按开始时间和结束时间投放，时间(end_time - begin_time)超过三天。
schedule	String	[[],[],[],[],[],[],[]]	快手广告投放排期	请注意这是一个二维数组的string串格式。子列表为小时粒度的Integer类型；默认存在7个子列表，分别表示周一到周天。如果串非[]则要求内部子列表长度为7个。例：[[0,2],[],[5, 9],[],[],[],[]]表示只在周一的0点和2点，周三的5点和9点进行投放。注意如果传参为[],[],[],[],[],[],[]会被当成[]处理
roi_ratio	Double	2	ROI系数	优化目标（ocpx_action_type）或深度目标（deep_conversion_type）为「首日 ROI、7日ROI出价」时必填：ROI 系数取值范围 ( 0,100 ] 支持到三位小数（如：0.066）。
web_uri	String	https://www.uri.com	不同计划类型下有不同语义，参加说明	campaign.type=2时为应用下载链接，此时不用传入，会根据app_id默认填充；campaign.type=5时代表落地页链接，此时是否需要传入要根据落地页类型webUriType区分，当webUriType=1时需要填入合法值（以https开头并且非下载地址等，详见快手对线索类落地页的限制说明），当webUriType=2时不需要填入，此时要求site_id字段是有效值，将使用site_id所对应的页面链接填充本属性；当webUriType=3时不需要填入，此时要求group_id字段是有效值，且本属性不会被填充；当campaign.type=7时，本属性语义是H5兜底链接，此时要根据webUriType来决定是否填入，本计划类型下的webUriType仅支持1（快手广告主自有）、2（建站页面），不支持3（程序化落地页）本属性会替换旧接口的uri、url，并在create、update接口保持一致。
web_uri_type	Integer	2	落地页类型	0：默认值，用于不可使用落地页等计划类型下的设置值； 1：快手广告主自有； 2：自建站； 3：程序化落地页。当前在campaign.type=5、7时可以使用。
schema_uri	String	string	应用直达链接	当campaign.type=2时，应用直达白名单用户可填；当campaign.type=7时，默认必填，如果在非必填白名单中，可不填本字段。
app_id	Long	0	应用ID	campaign.type in (2, 7)时传
site_id	String	123122312	当campaign.type=2时代表应用下载详情页，此时downloadPageType=1时可用；当campaign.type in (5, 7)时代表使用了建站落地页，此时联动 webUriType，注意此时与groupId是互斥的，不可同时为非0。	注意此字段为String类型，存在是为一个数字，不存在为空字符串
convert_id	Long	12312312	转化追踪工具ID	请注意与追踪工具类型匹配。当campaign.type=2时，选择安卓应用，则可使用的类型为api、sdk和快归因，选择ios应用，则可使用api和快归因；当campaign.type=5时，如果使用了非自有落地页（web_uri_type!=1），则不允许使用追踪工具，如果是自有落地页（web_uri_type=1）则可用追踪工具类型为JS和XPATH。
group_id	String	232132317	程序化落地页	使用条件：campaign.type = 5 and web_uri_type = 3；互斥条件：此字段与site_id字段分别代表程序化落地页和建站落地页，同一个快手广告组中能存在一个；字段格式：此字段为String类型的数字。
use_app_market	Boolean	true	是否使用应用商店	campaign.type=2、5时可用，当取值为true时，要求app_store数组长度非空且元素均可识别
app_store	String[]	["huawei"]	应用商店列表	use_app_market为true时此字段生效，可选值如下：["huawei","oppo","vivo","xiaomi","meizu","smartisan"
target_info	Struct	{}	定向信息，详见对应结构
template_id	Long	121827281	定向模板ID
target_type	Integer	2	定向类型	0：不限； 1：智能定向，此时auto_target = true； 2：历史营销人群
scene_ids	Integer[]	1, 2	快手广告投放资源位	1：优选场景； 5：联盟明投； 6：上下滑大屏广告； 7：快手信息流广告； 10：快手联盟优选； 11：快看点； 24：激励视频； 27：开屏视频； 39：快手搜索广告
playable_id	Long	12311	试玩快手广告ID	可选字段，开启试玩时存在，否则不存在，请注意试玩和高级卡功能冲突，不可同时使用。试玩功能支持的计划类型为campaign.type=2、5。当用户上传试玩素材成功时返回，用于之后对于快手广告组中试玩创意的编辑操作。请注意，试玩快手广告的类型与快手广告投放版位scene_ids有关，如果快手广告投放联盟流量，则试玩包类型支持"不限"和"联盟"，如果投放快手系流量，则试玩包类型支持"不限"和"站内"，详见试玩资源包列表的接口说明。
play_button	String	string	试玩快手广告的按钮文案	开启试玩时存在，否则不存在，示例按钮内容如下： 1：立即试玩； 2：试玩一下； 3：立即体验； 4：免装试玩； 5：免装体验。启用试玩时：默认“立即试玩”，未启用试玩时：内容为空。
taobao_url_type	Integer	2	电商广告类型	当计划类型为：3（获取电商下单）时必填： 1 - 淘宝商品短链； 3 - 唤起手机淘宝。
dpa_sub_type	Integer	1	关联商品库类型	当campaign.type=2、5、7时可用。请注意绑定商品库与试玩库功能冲突，不可同时选择。其中枚举为2：SDPA单商品；3：DPA商品卡（动态商品卡）
dpa_library_id	Long	123111	关联商品库ID
dpa_outer_id	String	1281718	关联商品ID	当dpa_sub_type = 2时必填。此字段为快手侧商品ID，字段类型为字符串类型的数字
unit_click_url	String	https://www.click.url	视频点击监测链接	当campaign.type = 9时，此字段可填
unit_actionbar_click_url	String	https://www.click.url	actionBar点击监测链接	当campaign.type = 9时，此字段可填
unit_impression_url	String	https://www.impression.url	曝光监测链接	当campaign.type = 9时，此字段可填
conversion_type	Integer	2	客户端转化形态	当campaign.type = 16粉丝直播时可用； 6：快手广告直播推广（粉丝直播时固定为此值）
consult_id	String	123122	咨询组件ID	仅在 web_uri_type in (2, 3)可用；字段类型为String类型的数字
dsp_version	Long	0	对应创编接口的版本	注：新老板接口创建的物料不能混用； 0：老版本接口； 3：新版本接口
download_page_type	Long	0	应用中间页的类型	仅在campaign.type=2即提升应用安装下，且应用信息为安卓可用； 0=不使用； 1=建站落地页，此时关联siteId； 2=建站的半屏落地页，此时关联siteId。
download_page_url	String	string	应用中间页链接	本属性不需要填充，当download_page_type!=0时，会根据site_id字段所对应的落地页链接填充
live_user_id	Long	12313	直播用户ID	campaign.type = 16粉丝直播推广时使用
jingle_bell_id	String	string	小铃铛组件ID	campaign.type = 16粉丝直播推广时使用
account_id	Long	1231312	快手广告账户ID信息
put_status	Long	0	快手广告投放状态	0：默认值； 1：快手广告投放； 2：暂停； 3：删除
unit_type	Long	0	快手广告组类型	4：自定义创意的快手广告组； 5：程序化创意的快手广告组； 6：京快相关的快手广告组
create_time	Long	0	创建时间，毫秒时间戳
update_time	Long	0	更新时间，毫秒时间戳
campaign_type	Long	0	快手广告组对应计划类型
convert_name	String	string	转化追踪工具名称	convert_id对应的名称
consult_name	String	string	咨询组件名称	consult_id对应的名称
ocpx_action_type_name	String	string	浅层优化目标名称	ocpx_action_type对应的名称
deep_conversion_type_name	String	string	深度优化目标名称	deep_conversion_type对应的名称
unit_source_type	Long	0	快手广告组创建来源	1：普通广告组； 2：智能创编广告组； 4：波义尔； 5：速推版； 6：托管rage模式
dpa_library_info	Struct	{}	商品库信息（SDPA、DPA相关）
dpa_product_info	Struct	{}	商品信息（SDPA、DPA相关）
jingle_bell_status	Long	0	小铃铛组件状态	jingle_bell_id对应组件的状态
auto_target	boolean	ture	是否是智能定向	target_type = 1时，此字段为 true
schema_id	String	""	微信小程序外部调起链接	目前只有收集快手广告营销线索计划下的联盟广告位该字段有效
package_id	Long	0	应用包ID	新版本应用中心必传