Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AdvancedCreative ¶ added in v1.4.8
type AdvancedCreative struct { UnitID int64 `json:"unit_id"` // 广告组ID PackageName string `json:"package_name"` // 程序化创意包名称,1-100字符 HorizontalPhotoIDs []string `json:"horizontal_photo_ids"` // 横版视频ID列表,横版视频和竖版视频加起来只能1-5个 VerticalPhotoIDs []string `json:"vertical_photo_ids"` // 竖版视频ID列表 CoverImageTokens []string `json:"cover_image_tokens"` // 封面image_token,只能是1-4个 CoverImageURLs []string `json:"cover_image_urls"` // 封面链接地址 StickerStyles []int `json:"sticker_styles"` // 封面贴纸 CoverSlogans []string `json:"cover_slogans"` // 封面广告语 ActionBar string `json:"action_bar"` // 行动号召按钮 Captions []string `json:"captions"` // 作品广告语,只能是1-3个 ClickURL string `json:"click_url"` // 第三方点击检测链接 ActionBarClickURL string `json:"actionbar_click_url"` // 第三方ActionBar点击监控链接 PutStatus int `json:"put_status"` // 程序化创意操作状态,1:投放,2:暂停,3:删除 ViewStatus int `json:"view_status"` //程序化创意状态 ViewStatusReason string `json:"view_status_reason"` // 程序化创意状态描述 CreateTime string `json:"create_time"` // 创建时间,格式样例:"2019-06-11 15:17:25" UpdateTime string `json:"update_time"` // 更新时间,格式样例:"2019-06-11 15:17:25" Creatives []Creatives `json:"creatives"` // 创建后生成的程序化创意 ID PicIDs []string `json:"pic_ids"` // 图片库图片ID AppGradeType int `json:"app_grade_type"` // 审核分级类型,0:默认;1:审核降级(当创意发生降级时,会限制部分流量无法投放) PicList []string `json:"pic_list"` // 联盟图片(横版/竖版),联盟图片imageToken PicURLList []string `json:"pic_url_list"` // 联盟图片url(横版/竖版),联盟图片url PhotoList []Photo `json:"photo_list"` // 素材列表 AdPhotoPlayedT3SURL string `json:"ad_photo_played_t3s_url"` // 第三方有效播放监测链接 CreativeCategory int `json:"creative_category"` // 创意分类 CreativeTag []string `json:"creative_tag"` // 创意标签 NewExposeTag []ExposeTag `json:"new_expose_tag"` // 广告标签 2 期 }
type AdvancedCreativeListRequest ¶ added in v1.4.8
type AdvancedCreativeListRequest struct { AdvertiserID int64 `json:"advertiser_id"` // 必填,广告主 ID,在获取 access_token 的时候返回 UnitIDs []int64 `json:"unit_ids,omitempty"` // 选填,广告组 ID 集,不超过一百个 PackageName string `json:"package_name,omitempty"` // 选填,程序化创意包名称,非空,0 到 100 字符 Status int `json:"status,omitempty"` // 选填,程序化创意状态,-2:所有(包含已删除)、40:只包含已删除,不传:所有(不包含已删除) StartDate string `json:"start_date,omitempty"` // 选填,起始日期,格式如 yyyy-MM-dd EndDate string `json:"end_date,omitempty"` // 选填,结束时期,格式如 yyyy-MM-dd // 1. 如传入此字段时不传"start_date",与"end_date"字段,则不根据时间筛选。 // 2. 传入"start_date",与"end_date"字段,且此字段为 1 时,按照创建时间进行筛选。 // 3. 传入"start_date",与"end_date"字段,此字段不传,或传值为 0 时,则按照更新时间进行筛选 TimeFilterType int `json:"time_filter_type,omitempty"` // 选填,按创建时间或者更新时间进行筛选, Page int `json:"page,omitempty"` // 选填,页数,默认为 1 PageSize int `json:"page_size,omitempty"` // 选填,每页行数,默认为 20 PutStatusList []int `json:"put_status_list,omitempty"` // 选填,创意投放状态,1:投放;2:暂停;3:删除。备注:传了该参数会覆盖status参数筛选,因为二者是相同筛选项 }
func (AdvancedCreativeListRequest) Encode ¶ added in v1.4.8
func (r AdvancedCreativeListRequest) Encode() []byte
Encode implement PostRequest interface
func (AdvancedCreativeListRequest) Url ¶ added in v1.4.8
func (r AdvancedCreativeListRequest) Url() string
Url implement PostRequest interface
type CreateRequest ¶
type CreateRequest struct { //advertiser_id long 必填 广告主 ID 在获取 access_token 的时候返回 AdvertiserID uint64 `json:"advertiser_id,omitempty"` //unit_id long 必填 广告组 ID UnitID uint64 `json:"unit_id,omitempty"` //creative_name string 必填 创意名称 长度为 1-100 字符,同一个广告组下名称不能重复 CreativeName string `json:"creative_name,omitempty"` //photo_id string 选填 视频 ID PhotoID string `json:"photo_id,omitempty"` //image_token string 选填 封面图片 token 通过上传图片接口获得,不传值则直接使用视频的首帧作为封面图片,自定义封面的图片宽高要与视频宽高一致 ImageToken string `json:"image_token,omitempty"` //dpa_template_id long 选填 DPA模板ID creative_material_type = 14 时,必填。通过DPA 模板信息接口取 DPATemplateID uint64 `json:"dpa_template_id,omitempty"` //creative_material_type int 必填 素材类型 1:竖版视频;2:横版视频;4:便利贴单图图片创意;5: 竖版图片(优选/联盟);6:横版图片(优选/联盟/信息流/快看点);9:小图(优选/信息流/快看点);10:组图(优选/信息流/快看点) ;11:开屏视频;12:开屏图片;14:DPA模板(联盟)。搜索广告当前仅支持1、2 CreativeMaterialType int `json:"creative_material_type,omitempty"` //image_tokens string[] 选填 便利贴单图图片创意 token 便利贴/图片/小图图片创意必填,目前只支持一张图片;组图图片创意需要上传 3 张图片,详细要求见附录 ImageTokens []string `json:"image_tokens,omitempty"` //action_bar_text string 必填 行动号召按钮文案 根据计划类型进行设置,详情见附录 ActionBarText string `json:"action_bar_text,omitempty"` //description string 必填 广告语 长度为 1-30 字符,不支持换行。 如果要使用动态词包,格式如"[地区]的[男性女性]都喜欢", 联盟广告和程序化创意不支持动态词包, 词包名可以通过下方动态词包接口获取 Description string `json:"description,omitempty"` //new_expose_tag struct[] 选填 广告标签 2 期 按照相关格式传递两个推荐理由 举例{“text”:"工厂直发"},{"text":"限时专享"} NewExposeTag []NewExposeTag `json:"new_expose_tag,omitempty"` //click_track_url string 选填 第三方点击检测链接 仅当广告组 scene_id 为 1、2、6、7、10 时,可选填; 广告组优化目标为激活时,该字段必填(下载类广告投放的应用集成快手 Android SDK 时除外) 使用 Marketing API 创建时,监测链接使用以该文档为准 ClickTrackURL string `json:"click_track_url,omitempty"` //impression_url string 选填 第三方开始播放监测链接 广告组优化目标为激活时,该字段必填(下载类广告投放的应用集成快手 Android SDK 时除外) 使用 Marketing API 创建时,监测链接使用以该文档为准 ImpressionURL string `json:"impression_url,omitempty"` //ad_photo_played_t3s_url string 选填 第三方有效播放监测链接 AdPhotoPlayedT3SURL string `json:"ad_photo_played_t3s_url,omitempty"` //actionbar_click_url string 选填 第三方点击按钮监测链接 1.校验 click_url 必填的广告场景 优选(1)/信息流(2、7)/上下滑(6) 2.优化目标为激活功能必填点击监测链接,但如果安卓应用接入了快手监测 sdk 就不需要填写监测链接了 3.联盟场景检查 click_url 不能为空 4.若广告联盟的转化目标为激活,click_url、actionbar_click_url 和监测 SDK 至少三选一 ActionbarClickURL string `json:"actionbar_click_url,omitempty"` //creative_category int 金融,教育,游戏,小说,电商 如上行业必填 创意分类 由创意分类查询接口 获得;必须是叶子结点;与创意标签同时传或同时不传 可通过工具-功能名单-获取创意分类标签白名单客户接口获取是否必填。注:不可传入负值 CreativeCategory int `json:"creative_category,omitempty"` //creative_tag string[] 选创意分类 必填 创意标签 与创意分类参数,要么都传,要么都不传;且单个创意的创意标签最多 10 个;单个创意标签不能为空且不能超过 10 字符, CreativeTag []string `json:"creative_tag,omitempty"` //live_creative_type int 选填 直播类型(粉丝直播推广计划type=16时必填) 3 - 直投直播;4 - 视频引流直播 LiveCreativeType int `json:"live_creative_type,omitempty"` //live_track_url string 选填 点击监测链接 计划 campaignType=16 粉丝直播推广时可填写 LiveTrackURL string `json:"live_track_url,omitempty"` //dpa_style_types int[] 选填 动态商品卡样式 14001-区域服务卡 DpaStyleTypes []int `json:"dpa_style_types,omitempty"` //outer_loop_native int 选填 是否开启原生 0关闭,1开启,不填默认为0仅在计划 campaignType=2提升应用安装、5收集销售线索、7提升应用活跃、19推广快手小程序时,可开启原生投放。 OuterLoopNative int `json:"outer_loop_native,omitempty"` //kol_user_type int 选填 原生达人用户类型 2服务号原生,3聚星达人原生,当outer_loop_native为1时此项必填 KolUserType int `json:"kol_user_type,omitempty"` //high_light_flash int 选填 高光创意状态 0:关闭 1:开启 HighLightFlash int `json:"high_light_flash,omitempty"` //splash_photo_ids sting[] 选填 开屏视频 id creative_material_type 为 11 时必填,使用上传视频接口时返回的 photo_id;即素材类型是开屏视频时,必须传入全尺寸的 4 条视频,具体参考素材层级接口 SplashPhotoIDs []string `json:"splash_photo_ids,omitempty"` //splash_image_tokens sting[] 选填 开屏图片 token creative_material_type 为 12 时必填,使用上传图片接口时返回的 image_token,素材类型是开屏图片时,必须传入全尺寸的 6 张图片,具体参考素材层级接口 SplashImageTokens []string `json:"splash_image_tokens,omitempty"` }
CreateRequest 创建创意API Request
func (CreateRequest) Encode ¶
func (r CreateRequest) Encode() []byte
Encode implement PostRequest interface
type CreateResponse ¶
type CreateResponse struct { // CreativeID 创意ID CreativeID uint64 `json:"creative_id,omitempty"` }
CreateResponse 创建创意 API Response
type Creative ¶ added in v1.4.8
type Creative struct { CampaignID uint64 `json:"campaign_id"` // 广告计划 ID UnitID uint64 `json:"unit_id"` // 广告组 ID CreativeID uint64 `json:"creative_id"` // 广告创意 ID CreativeName string `json:"creative_name"` // 广告创意名称 CreativeMaterialType int `json:"creative_material_type"` // 素材类型 0:历史创意未作区分 1:竖版视频 2:横版视频 3:后贴片单图图片创意(历史类型,已下线)4:便利贴单图图片创意 11:开屏视频 12:开屏图片 CreativeCategory int `json:"creative_category"` // 创意分类 CreativeTag []string `json:"creative_tag"` // 创意标签 PhotoID string `json:"photo_id"` // 视频作品 ID PhotoMD5 string `json:"photo_md5"` // 视频作品的md5 MaterialURL []string `json:"material_url"` // 单图创意 url ImageTokens []string `json:"image_tokens"` // 单图创意 image_token Status int `json:"status"` // 广告创意状态(优先先看这个状态,计算结果) -1:不限,1:计划已暂停,3:计划超预算,6:余额不足,11:组审核中,12:组审核未通过,14:已结束,15:组已暂停,17:组超预算,19:未达投放时间,40:已删除,41:审核中,42:审核未通过,46:已暂停,52:投放中,53:作品异常,54:视频审核通过可投放滑滑场景,55:部分素材审核失败 PutStatus int `json:"put_status"` // 投放状态(操作结果) 1:投放中;2:暂停 3:删除 ReviewDetail string `json:"review_detail"` // 审核拒绝理由 RejectVideoSnapshot []string `json:"reject_video_snapshot"` // 审核拒绝图片 list 里面可以包含多个数据 CoverURL string `json:"cover_url"` // 封面 URL ImageToken string `json:"image_token"` // 视频封面 token 若创意使用系统自动生成的首帧图片作为封面,该 token 无法复用 CoverWidth int64 `json:"cover_width"` // 封面图宽度 CoverHeight int64 `json:"cover_height"` // 封面图高度 OverlayBgURL string `json:"overlay_bg_url"` // 动态词包原始封面图片 URL OverlayBgImageToken string `json:"overlay_bg_image_token"` // 动态词包原始封面图片 token StickerTitle string `json:"sticker_title"` // 封面广告语标题 OverlayType string `json:"overlay_type"` // 贴纸样式类型 DisplayInfo DisplayInfo `json:"display_info"` //广告展示信息 ShortSlogan string `json:"short_slogan"` // 便利贴创意短广告语 ExposeTag string `json:"expose_tag"` // 广告标签 NewExposeTag []NewExposeTag `json:"new_expose_tag"` //广告标签 2 期 ClickTrackUrl string `json:"click_track_url"` // 点击监测链接 若出现与后台显示不一致,以文档为准即可 ImpressionUrl string `json:"impression_url"` // 第三方开始播放监测链接 若出现与后台显示不一致,以文档为准即可 ActionbarClickUrl string `json:"actionbar_click_url"` // 第三方点击按钮监测链接 AdPhotoPlayedT3sUrl string `json:"ad_photo_played_t3s_url"` // 第三方有效播放监测链接 仅历史个别账户使用 CreateTime string `json:"create_time"` // 创建时间 格式样例:"2019-06-11 15:17:25" UpdateTime string `json:"update_time"` // 最后修改时间 格式样例:"2019-06-11 15:17:25" PicId string `json:"pic_id"` // 图片库图片 AppGradeType int `json:"app_grade_type"` // 审核分级类型 0:默认;1:审核降级(当创意发生降级时,会限制部分流量无法投放) SplashPhotos []SplashPhoto `json:"splash_photos"` // 开屏视频信息 creative_material_type 为 11 时 LiveCreativeType int `json:"live_creative_type"` // 粉丝直播推广创意类型 3:直投直播;4:作品引流 SplashPictures []SplashPicture `json:"splash_pictures"` // 开屏图片 creative_material_type 为 12 时 LiveTrackUrl string `json:"live_track_url"` // 点击监测链接 计划 campaignType=16 粉丝直播推广时填写 AdType int `json:"ad_type"` // 广告计划类型 0:信息流,1:搜索 OuterLoopNative int `json:"outer_loop_native"` // 是否开启原生 0关闭,1开启,不填默认为0 KolUserType int `json:"kol_user_type"` // 原生达人用户类型 2服务号原生,3聚星达人原生, 不开启原生时此项为0 KolUserId int64 `json:"kol_user_id"` // 原生投放目标达人ID Recommendation string `json:"recommendation"` // plc自定义文案 DpaStyleTypes []int `json:"dpa_style_types"` // 动态商品卡样式 14001-区域服务卡 HighLightFlash int `json:"high_light_flash"` // 高光创意状态 0:关闭 1:开启 }
type DisplayInfo ¶ added in v1.4.8
type ListAdvancedCreativeResponse ¶ added in v1.4.8
type ListAdvancedCreativeResponse struct { // TotalCount 数据总数 TotalCount int `json:"total_count,omitempty"` // Details 返回值详情 Details []AdvancedCreative `json:"details,omitempty"` }
type ListRequest ¶ added in v1.4.8
type ListRequest struct { AdvertiserID uint64 `json:"advertiser_id"` // 广告主 ID,在获取 access_token 的时候返回 CampaignID uint64 `json:"campaign_id,omitempty"` // 广告计划 ID,过滤筛选条件,若不传或传空则视为无限制条件 UnitID uint64 `json:"unit_id,omitempty"` // 广告组 ID,过滤筛选条件,若不传或传空则视为无限制条件 CreativeID uint64 `json:"creative_id,omitempty"` // 广告创意 ID,过滤筛选条件,若不传或传空则视为无限制条件 CreativeName string `json:"creative_name,omitempty"` // 广告创意名称,过滤筛选条件,支持模糊搜索和精确查询 CreativeIDs []uint64 `json:"creative_ids,omitempty"` // 广告创意 ID 集,不超过 100 个 Status int `json:"status,omitempty"` // 广告创意状态,过滤筛选条件,-2:不限,40:只包含已删除,不传:所有不包含已删除,其他值无效 StartDate string `json:"start_date,omitempty"` // 开始时间,过滤筛选条件,格式为"yyyy-MM-dd",参数值对应 update_time 信息 EndDate string `json:"end_date,omitempty"` // 结束时间,过滤筛选条件,格式为"yyyy-MM-dd",参数值对应 update_time 信息 TimeFilterType int `json:"time_filter_type,omitempty"` // 按创建时间或者更新时间进行筛选,1.如传入此字段时不传"start_date",与"end_date"字段,则不根据时间筛选。2.传入"start_date",与"end_date"字段,且此字段为 1 时,按照创建时间进行筛选。3.传入"start_date",与"end_date"字段,此字段不传,或传值为 0 时,则按照更新时间进行筛选 Page int `json:"page,omitempty"` // 请求的页码数,默认为 1 PageSize int `json:"page_size,omitempty"` // 请求的每页行数,默认为 20 PutStatusList []int `json:"put_status_list,omitempty"` // 创意投放状态,1:投放;2:暂停;3:删除。备注:传了该参数会覆盖 status 参数筛选,因为二者是相同筛选项 }
func (ListRequest) Encode ¶ added in v1.4.8
func (r ListRequest) Encode() []byte
Encode implement PostRequest interface
func (ListRequest) Url ¶ added in v1.4.8
func (r ListRequest) Url() string
Url implement PostRequest interface
type ListResponse ¶ added in v1.4.8
type NewExposeTag ¶
NewExposeTag 广告标签
type SplashPhoto ¶ added in v1.4.8
Click to show internal directories.
Click to hide internal directories.