creative

package
v0.0.0-...-4c075ac Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 19, 2024 License: MIT, Apache-2.0 Imports: 3 Imported by: 0

Documentation

Overview

Package creative广告创意相关API models

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActionBarTextListRequest 

type ActionBarTextListRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CampaignType 计划类型; 必填 2 - 提升应用安装;3 - 获取电商下单;4 - 推广品牌活动;5 - 收集销售线索;13 - 小店商品推广；14：直播推广
	CampaignType int `json:"campaign_type,omitempty"`
	// ConsultType 是否使用了咨询组件；0=未使用，1=使用；注，咨询组件仅在收集销售线索计划(campaign_type=5)下可用，且使用了咨询组件后，可用的行动号召按钮限于接口返回内容
	ConsultType int `json:"consult_type,omitempty"`
}

ActionBarTextListRequest 获取行动号召按钮

func (ActionBarTextListRequest) Encode 

func (r ActionBarTextListRequest) Encode() string

Encode implement GetRequest interface

func (ActionBarTextListRequest) Url 

func (r ActionBarTextListRequest) Url() string

Url implement GetRequest interface

type ActionBarTextListResponse 

type ActionBarTextListResponse struct {
	// ActionBarText 行动号召按钮文案
	ActionBarText []string `json:"action_bar_text,omitempty"`
}

ActionBarTextListResponse 获取行动号召按钮 API Response

type AdvancedProgramCreateRequest 

type AdvancedProgramCreateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// UnitID 广告组ID
	UnitID uint64 `json:"unit_id,omitempty"`
	// PackageName 程序化创意包名称，1-100 字符，
	PackageName string `json:"package_name,omitempty"`
	// HorizontalPhotoIDs 横版视频 id list; 横版视频和竖版视频加起来只能 1-5 个
	HorizontalPhotoIDs []string `json:"horizontal_photo_ids,omitempty"`
	// VerticalPhotoIDs 竖版视频 id list
	VerticalPhotoIDs []string `json:"vertical_photo_ids,omitempty"`
	// CoverImageTokens 封面 image_token;只能是 1-4 个
	CoverImageTokens []string `json:"cover_image_tokens,omitempty"`
	// SiteID 建站 id
	SiteID uint64 `json:"site_id,omitempty"`
	// StickerStyles 封面贴纸
	StickerStyles []int `json:"sticker_styles,omitempty"`
	// CoverSlogans 封面广告语
	CoverSlogans []string `json:"cover_slogans,omitempty"`
	// ActionBar 行动号召按钮
	ActionBar string `json:"action_bar,omitempty"`
	// Captions 作品广告语; 只能是 1-3 个
	Captions []string `json:"captions,omitempty"`
	// ClickUrl 第三方点击检测链接
	ClickUrl string `json:"click_url,omitempty"`
	// ActionbarClickUrl 第三方ActionBar点击监控链接
	ActionbarClickUrl string `json:"actionbar_click_url,omitempty"`
	// CreativeCategory 创意分类; 由创意分类查询接口获得； 必须是叶子结点；与创意标签同时传或同时不传
	CreativeCategory int `json:"creative_category,omitempty"`
	// CreativeTag 创意标签; 与创意分类参数，要么都传，要么都不传；且单个创意的创意标签最多20个；单个创意标签不能为空且不能超过10字符
	CreativeTag []string `json:"creative_tag,omitempty"`
	// PhotoList 素材列表; 新创建程序化创意请使用此参数，最多支持10组素材(传递后将忽略horizontal_photo_ids,vertical_photo_ids,cover_image_tokens，7.15日后老字段下线)
	PhotoList []Photo `json:"photo_list,omitempty"`
}

AdvancedProgramCreateRequest 创建程序化2.0创意

func (AdvancedProgramCreateRequest) Encode 

func (r AdvancedProgramCreateRequest) Encode() []byte

Encode implement PostRequest interface

func (AdvancedProgramCreateRequest) Url 

func (r AdvancedProgramCreateRequest) Url() string

Url implement PostRequest interface

type AdvancedProgramCreateResponse 

type AdvancedProgramCreateResponse struct {
	// UnitID 广告组id
	UnitID uint64 `json:"unit_id,omitempty"`
}

AdvancedProgramCreateResponse 创建程序化2.0创意 API Response

type AdvancedProgramCreative 

type AdvancedProgramCreative struct {
	// UnitID 广告组ID
	Unit uint64 `json:"unit_id,omitempty"`
	// PackageName 程序化创意包名称，1-100 字符，
	PackageName string `json:"package_name,omitempty"`
	// HorizontalPhotoIDs 横版视频 id list; 横版视频和竖版视频加起来只能 1-5 个
	HorizontalPhotoIDs []string `json:"horizontal_photo_ids,omitempty"`
	// VerticalPhotoIDs 竖版视频 id list
	VerticalPhotoIDs []string `json:"vertical_photo_ids,omitempty"`
	// CoverImageTokens 封面 image_token;只能是 1-4 个
	CoverImageTokens []string `json:"cover_image_tokens,omitempty"`
	// CoverImageUrls 封面链接地址
	CoverImageUrls []string `json:"cover_image_urls,omitempty"`
	// SiteID 建站 id
	SiteID uint64 `json:"site_id,omitempty"`
	// StickerStyles 封面贴纸
	StickerStyles []int `json:"sticker_styles,omitempty"`
	// CoverSlogans 封面广告语
	CoverSlogans []string `json:"cover_slogans,omitempty"`
	// ActionBar 行动号召按钮
	ActionBar string `json:"action_bar,omitempty"`
	// Captions 作品广告语; 只能是 1-3 个
	Captions []string `json:"captions,omitempty"`
	// ClickUrl 第三方点击检测链接
	ClickUrl string `json:"click_url,omitempty"`
	// ActionbarClickUrl 第三方ActionBar点击监控链接
	ActionbarClickUrl string `json:"actionbar_click_url,omitempty"`
	// PutStatus 程序化创意操作状态，1：投放，2：暂停，3：删除
	PutStatus int `json:"put_status,omitempty"`
	// ViewStatus 程序化创意状态; -1：不限，1：计划已暂停，3：计划超预算，6：余额不足，11：组审核中，12：组审核未通过，14：已结束，15：组已暂停，17：组超预算，19：未达投放时间，40：创意已删除，41：审核中，42：审核未通过，46：已暂停，52：投放中，53：作品异常，55：部分素材审核通过
	ViewStatus int `json:"view_status,omitempty"`
	// ViewStatusReason 程序化创意状态描述
	ViewStatusReason string `json:"view_status_reason,omitempty"`
	// CreateTime 创建时间
	CreateTime string `json:"create_time,omitempty"`
	// UpdateTime 最后修改时间
	UpdateTime string `json:"update_time,omitempty"`
}

AdvancedProgramCreative 获取程序化创意2.0信息

type AdvancedProgramListRequest 

type AdvancedProgramListRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// UnitIDs 广告组ID;不超过一百个，当unit_ids参数不为空时，返回值total_count为0
	UnitIDs []uint64 `json:"unit_ids,omitempty"`
	// PackageName 程序化创意包名称; 非空，0到100字符
	PackageName string `json:"package_name,omitempty"`
	// Status 程序化创意状态; -2：所有（包含已删除）、40：只包含已删除 不传：所有（不包含已删除）
	Status int `json:"status,omitempty"`
	// StartDate 开始时间;与end_date同时传或同时不传；过滤筛选条件，格式为"yyyy-MM-dd"，参数值对应update_time信息
	StartDate string `json:"start_date,omitempty"`
	// EndDate 结束时间; 与start_date同时传或同时不传；过滤筛选条件，格式为"yyyy-MM-dd"，参数值对应update_time信息
	EndDate string `json:"end_date,omitempty"`
	// TimeFilterType 按创建时间，还是更新时间进行筛选; 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 请求的页码数 默认为1
	Page int `json:"page,omitempty"`
	// PageSize 请求的每页行数; 默认为20
	PageSize int `json:"page_size,omitempty"`
}

AdvancedProgramListRequest 获取程序化创意2.0信息 API Request

func (AdvancedProgramListRequest) Encode 

func (r AdvancedProgramListRequest) Encode() []byte

Encode implement PostRequest interface

func (AdvancedProgramListRequest) Url 

func (r AdvancedProgramListRequest) Url() string

Url implement PostRequest interface

type AdvancedProgramListResponse 

type AdvancedProgramListResponse struct {
	// TotalCount 数据总数
	TotalCount int `json:"total_count,omitempty"`
	// Details 返回值详情
	Details []AdvancedProgramCreative `json:"details,omitempty"`
}

AdvancedProgramListResponse 获取程序化创意2.0信息 API Response

type AdvancedProgramReviewDetail 

type AdvancedProgramReviewDetail struct {
	// UnitID 当前的程序化创意的广告组id
	UnitID uint64 `json:"unit_id,omitempty"`
	// Slogans 审核不通过的封面广告语
	Slogans []string `json:"slogans,omitempty"`
	// CombineDetailViews 审核不通过和正在审核的创意组合
	CombineDetailViews []CombineDetailView `json:"combine_detail_views,omitempty"`
}

AdvancedProgramReviewDetail 获取程序化创意2.0审核信息

type AdvancedProgramReviewDetailRequest 

type AdvancedProgramReviewDetailRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// UnitIDs 广告组ID;数量小于等于20个
	UnitIDs []uint64 `json:"unit_ids,omitempty"`
}

AdvancedProgramReviewDetailRequest 获取程序化创意2.0审核信息

func (AdvancedProgramReviewDetailRequest) Encode 

func (r AdvancedProgramReviewDetailRequest) Encode() string

Encode implement GetRequest interface

func (AdvancedProgramReviewDetailRequest) Url 

func (r AdvancedProgramReviewDetailRequest) Url() string

Url implement GetRequest interface

type AdvancedProgramUpdateRequest 

type AdvancedProgramUpdateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// UnitID 广告组ID
	UnitID uint64 `json:"unit_id,omitempty"`
	// PackageName 程序化创意包名称，1-100 字符，
	PackageName string `json:"package_name,omitempty"`
	// HorizontalPhotoIDs 横版视频 id list; 横版视频和竖版视频加起来只能 1-5 个
	HorizontalPhotoIDs []string `json:"horizontal_photo_ids,omitempty"`
	// VerticalPhotoIDs 竖版视频 id list
	VerticalPhotoIDs []string `json:"vertical_photo_ids,omitempty"`
	// CoverImageTokens 封面 image_token;只能是 1-4 个
	CoverImageTokens []string `json:"cover_image_tokens,omitempty"`
	// SiteID 建站 id
	SiteID uint64 `json:"site_id,omitempty"`
	// StickerStyles 封面贴纸
	StickerStyles []int `json:"sticker_styles,omitempty"`
	// CoverSlogans 封面广告语
	CoverSlogans []string `json:"cover_slogans,omitempty"`
	// ActionBar 行动号召按钮
	ActionBar string `json:"action_bar,omitempty"`
	// Captions 作品广告语; 只能是 1-3 个
	Captions []string `json:"captions,omitempty"`
	// ClickUrl 第三方点击检测链接
	ClickUrl string `json:"click_url,omitempty"`
	// ActionbarClickUrl 第三方ActionBar点击监控链接
	ActionbarClickUrl string `json:"actionbar_click_url,omitempty"`
	// CreativeCategory 创意分类; 由创意分类查询接口获得； 必须是叶子结点；与创意标签同时传或同时不传
	CreativeCategory int `json:"creative_category,omitempty"`
	// PhotoList 素材列表; 新创建程序化创意请使用此参数，最多支持10组素材(传递后将忽略horizontal_photo_ids,vertical_photo_ids,cover_image_tokens，7.15日后老字段下线)
	PhotoList []Photo `json:"photo_list,omitempty"`
}

AdvancedProgramUpdateRequest 修改程序化2.0创意

func (AdvancedProgramUpdateRequest) Encode 

func (r AdvancedProgramUpdateRequest) Encode() []byte

Encode implement PostRequest interface

func (AdvancedProgramUpdateRequest) Url 

func (r AdvancedProgramUpdateRequest) Url() string

Url implement PostRequest interface

type BatchUpdateRequest 

type BatchUpdateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// UnitID 广告组ID; 一个unit最多创建15个创意
	UnitID uint64 `json:"unit_id,omitempty"`
	// ClickTrackUrl 第三方点击检测链接; 仅当广告组scene_id为1、2、6、7时，可选填； 广告组优化目标为激活时，该字段必填（下载类广告投放的应用集成快手Android SDK时除外） 使用Marketing API创建时，监测链接使用以该文档为准
	ClickTrackUrl string `json:"click_track_url,omitempty"`
	// ImpressionUrl 第三方开始播放监测链接; 仅当广告组scene_id为3时，可选填； 广告组优化目标为激活时，该字段必填（下载类广告投放的应用集成快手Android SDK时除外） 使用Marketing API创建时，监测链接使用以该文档为准
	ImpressionUrl string `json:"impression_url,omitempty"`
	// AdPhotoPlayedT3sUrl 第三方有效播放监测链接; 仅历史个别账户使用且当广告组scene_id为3时可选，与impression_url不可同时使用
	AdPhotoPlayedT3sUrl string `json:"ad_photo_played_t3s_url,omitempty"`
	// ActionbarClickUrl 第三方点击按钮监测链接; 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"`
	// CreativeCategory 创意分类; 由创意分类查询接口 获得；必须是叶子结点；与创意标签同时传或同时不传
	CreativeCategory int `json:"creative_category,omitempty"`
	// CreativeTag 创意标签; 与创意分类参数，要么都传，要么都不传；且单个创意的创意标签最多20个；单个创意标签不能为空且不能超过10字符
	CreativeTag []string `json:"creative_tag,omitempty"`
	// Creatives 批量参数
	Creatives []Creative `json:"creatives,omitempty"`
}

BatchUpdateRequest 批量创建&修改创意 API Request 注：该接口可实现创意的批量创建&更新，上传creative_id为更新，不上传creative_id则为创建。

func (BatchUpdateRequest) Encode 

func (r BatchUpdateRequest) Encode() []byte

Encode implement PostRequest interface

func (BatchUpdateRequest) Url 

func (r BatchUpdateRequest) Url() string

Url implement PostRequest interface

type BatchUpdateResponse 

type BatchUpdateResponse struct {
	UpdateCreativeIDs []uint64 `json:"update_creative_ids,omitempty"`
	AddCreativeIDs    []uint64 `json:"add_creative_ids,omitempty"`
}

BatchUpdateResponse 批量创建&修改创意 API Response

type CombineDetailView 

type CombineDetailView struct {
	// ID 创意id
	ID uint64 `json:"id,omitempty"`
	// PhotoID 视频id; 已加密
	PhotoID uint64 `json:"photo_id,omitempty"`
	// CoverUrl 封面url
	CoverUrl string `json:"cover_url,omitempty"`
	// Caption 作品广告语
	Caption string `json:"caption,omitempty"`
	// ReviewStatus 审核状态;1：审核中2：审核通过3：不通过
	ReviewStatus int `json:"review_status,omitempty"`
	// ReviewDetail 审核信息;里面是一个String类型数据，是审核信息
	ReviewDetail []string `json:"review_detail,omitempty"`
	// PutStatus 程序化创意审核状态; 程序化创意操作状态，1：投放，2：暂停，3：删除
	PutStatus int `json:"put_status,omitempty"`
}

CombineDetailView 审核不通过和正在审核的创意组合

type CreateAdvancedRequest 

type CreateAdvancedRequest struct {
	// AdvertiserId 广告主ID
	AdvertiserId uint64 `json:"advertiser_id,omitempty"`
	// UnitID 广告组ID
	Unit uint64 `json:"unit_id,omitempty"`
	//PackageName 程序化创意名称
	PackageName string `json:"package_name"`
	// SiteID 安卓下载中间页ID
	SiteID uint64 `json:"site_id,omitempty"`
	// StickerStyles 封面贴纸
	StickerStyles []int `json:"sticker_styles,omitempty"`
	// CoverSlogans 封面广告语
	CoverSlogans []string `json:"cover_slogans,omitempty"`
	// ActionBar 行动号召按钮
	ActionBar string `json:"action_bar"`
	// Captions 作品广告语
	Captions []string `json:"captions"`
	// ClickUrl 点击监测链接; 若出现与后台显示不一致，以文档为准即可
	ClickUrl string `json:"click_url,omitempty"`
	// ActionbarClickUrl 第三方 ActionBar 点击监控链接
	ActionbarClickUrl string `json:"actionbar_click_url,omitempty"`
	// CreativeCategory 创意分类
	CreativeCategory int `json:"creative_category,omitempty"`
	// CreativeTag 创意标签
	CreativeTag []string `json:"creative_tag,omitempty"`
	// PhotoList 素材列表
	PhotoList []PhotoItem `json:"photo_list,omitempty"`
	// PicList 联盟图片（横版/竖版）
	PicList []string `json:"pic_list,omitempty"`
}

CreateAdvancedRequest 创建程序化2.0创意 API Request

func (CreateAdvancedRequest) Encode 

func (r CreateAdvancedRequest) Encode() []byte

Encode implement PostRequest interface

func (CreateAdvancedRequest) Url 

func (r CreateAdvancedRequest) Url() string

Url implement PostRequest interface

type CreateAdvancedResponse 

type CreateAdvancedResponse struct {
	// UnitId 创意ID
	UnitId uint64 `json:"unit_id,omitempty"`
}

CreateResponse 创建创意 API Response

type CreateRequest 

type CreateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// UnitID 广告组ID
	UnitID uint64 `json:"unit_id,omitempty"`
	// CreativeName 创意名称; 长度为1-100字符，同一个广告组下名称不能重复
	CreativeName string `json:"creative_name,omitempty"`
	// PutStatus 广告组的投放状态; 不填时，创建的广告组为投放状态；填2时，创建的广告组为暂停状态，其他值非法
	PutStatus int `json:"put_status,omitempty"`
	// PhotoID 视频ID
	PhotoID string `json:"photo_id,omitempty"`
	// ImageToken 封面图片token; 通过上传图片接口获得，不传值则直接使用视频的首帧作为封面图片，自定义封面的图片宽高要与视频宽高一致
	ImageToken string `json:"image_token,omitempty"`
	// CreativeMaterialType 素材类型; 1：竖版视频 2：横版视频 4：便利贴单图图片创意 5： 竖版图片（优选/联盟）6：横版图片(优选/联盟/信息流/快看点) 9：小图(优选/信息流/快看点) 10：组图(优选/信息流/快看点)
	CreativeMaterialType int `json:"creative_material_type,omitempty"`
	// ImageTokens 便利贴单图图片创意token; 便利贴/图片/小图图片创意必填，目前只支持一张图片；组图图片创意需要上传3张图片，详细要求见附录
	ImageTokens []string `json:"image_tokens,omitempty"`
	// ActionBarText 行动号召按钮文案; 根据计划类型进行设置，详情见附录
	ActionBarText string `json:"action_bar_text,omitempty"`
	// Description 广告语; 长度为1-30字符，不支持换行。 如果要使用动态词包，格式如"[地区]的[男性女性]都喜欢"， 联盟广告和程序化创意不支持动态词包， 词包名可以通过下方动态词包接口获取
	Description string `json:"description,omitempty"`
	// ShortSlogan 便利贴创意短广告语; 长度为1-8字符，便利贴创意必填参数
	ShortSlogan string `json:"short_slogan,omitempty"`
	// StickerTitle 封面广告语标题; 不超过14字符， 如果要使用动态词包，格式如"[地区]的[男性女性]都喜欢"， 后贴片广告不支持动态词包， 词包名可以通过下方动态词包接口获取， sticker_title和overlay_type需同时为空值或同时非空
	StickerTitle string `json:"sticker_title,omitempty"`
	// OverlayType 贴纸样式类型; 贴纸样式可以通过查询下方贴纸掩饰接口获取， sticker_title和overlay_type需同时为空值或同时非空
	OverlayType string `json:"overlay_type,omitempty"`
	// ExposeTag 广告标签; 从 /expose_tags/list 接口获取，从下方9获取 更新的时候如果要将广告标签设置为 「暂不选择」，传空字符串即可，只支持计划类型为 2
	ExposeTag string `json:"expose_tag,omitempty"`
	// NewExposeTag 广告标签2期; 与老的expose_tag兼容, 逐渐将老的expose_tag替换掉。可以按照相关格式传递两个推荐理由 举例{“text”:""},{"text":""}
	NewExposeTag []string `json:"new_expose_tag,omitempty"`
	// SiteID 安卓下载中间页ID; 可从下方「获取已发布的下载页」接口获取（老建站6.30下线） 或通过「rest/openapi/v2/lp/page/list」获取新建站落地页（魔力建站"view_comps":7） 1.仅支持下载类广告 2.广告组选择的应用类型要为安卓 3.下载页对应的app_id要与广告组选择的app_id一致
	SiteID uint64 `json:"site_id,omitempty"`
	// ClickTrackUrl 第三方点击检测链接; 仅当广告组scene_id为1、2、6、7、10时，可选填； 广告组优化目标为激活时，该字段必填（下载类广告投放的应用集成快手Android SDK时除外） 使用Marketing API创建时，监测链接使用以该文档为准
	ClickTrackUrl string `json:"click_track_url,omitempty"`
	// ImpressionUrl 第三方开始播放监测链接; 仅当广告组scene_id为3时，可选填； 广告组优化目标为激活时，该字段必填（下载类广告投放的应用集成快手Android SDK时除外） 使用Marketing API创建时，监测链接使用以该文档为准
	ImpressionUrl string `json:"impression_url,omitempty"`
	// AdPhotoPlayedT3sUrl 第三方有效播放监测链接; 仅历史个别账户使用且当广告组scene_id为3时可选，与impression_url不可同时使用
	AdPhotoPlayedT3sUrl string `json:"ad_photo_played_t3s_url,omitempty"`
	// ActionbarClickUrl 第三方点击按钮监测链接; 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"`
	// CreativeCategory 创意分类; 由创意分类查询接口 获得；必须是叶子结点；与创意标签同时传或同时不传 必填账户可通过接口3.17——接口获取是否必填
	CreativeCategory int `json:"creative_category,omitempty"`
	// CreativeTag 创意标签; 与创意分类参数，要么都传，要么都不传；且单个创意的创意标签最多10个；单个创意标签不能为空且不能超过10字符
	CreativeTag []string `json:"creative_tag,omitempty"`
	// LiveCreativeType 直播类型（小店直播推广类型，计划type=14）; 1 - 直投直播；2 - 视频引流直播
	LiveCreativeType int `json:"live_creative_type,omitempty"`
}

CreateRequest 创建创意API Request

func (CreateRequest) Encode 

func (r CreateRequest) Encode() []byte

Encode implement PostRequest interface

func (CreateRequest) Url 

func (r CreateRequest) Url() string

Url implement PostRequest interface

type CreateResponse 

type CreateResponse struct {
	// CreativeID 创意ID
	CreativeID uint64 `json:"creative_id,omitempty"`
}

CreateResponse 创建创意 API Response

type Creative 

type Creative struct {
	// CampaignID 广告计划ID
	CampaignID uint64 `json:"campaign_id,omitempty"`
	// UnitID 广告组ID
	Unit uint64 `json:"unit_id,omitempty"`
	// CreativeID 广告创意ID
	CreativeID uint64 `json:"creative_id,omitempty"`
	// CreativeName 广告创意名称
	CreativeName string `json:"creative_name,omitempty"`
	// CreativeMaterialType 素材类型; 0：历史创意未作区分 1：竖版视频2：横版视频3：后贴片单图图片创意（历史类型，已下线）4：便利贴单图图片创意
	CreativeMaterialType int `json:"creative_material_type,omitempty"`
	// PhotoID 视频作品ID
	PhotoID string `json:"photo_id,omitempty"`
	// MaterialUrl 单图创意url
	MaterialUrl []string `json:"material_url,omitempty"`
	// ImageTokens 单图创意image_token
	ImageTokens []string `json:"image_tokens,omitempty"`
	// Status 广告创意状态（优先先看这个状态,计算结果）;-1：不限，1：计划已暂停，3：计划超预算，6：余额不足，11：组审核中，12：组审核未通过，14：已结束，15：组已暂停，17：组超预算，19：未达投放时间，40：已删除，41：审核中，42：审核未通过，46：已暂停，52：投放中，53：作品异常，54：视频审核通过可投放滑滑场景，55：部分素材审核失败
	Status int `json:"status,omitempty"`
	// PutStatus 投放状态（操作结果）;1：投放中；2：暂停 3：删除
	PutStatus int `json:"put_status,omitempty"`
	// CreateChannel 创建渠道; 0：投放后台创建；1：Marketing API创建
	CreateChannel int `json:"create_channel,omitempty"`
	// ReviewDetail 审核拒绝理由;
	ReviewDetail string `json:"review_detail,omitempty"`
	// RejectVideoSnapshot 审核拒绝图片
	RejectVideoSnapshot []string `json:"reject_video_snapshot,omitempty"`
	// CoverUrl 封面URL
	CoverUrl string `json:"cover_url,omitempty"`
	// ImageToken 视频封面token; 若创意使用系统自动生成的首帧图片作为封面，该token无法复用
	ImageToken string `json:"image_token,omitempty"`
	// FirstFrameType 视频封面来源; 1：首帧，0：非首帧
	FirstFrameType int `json:"first_frame_type,omitempty"`
	// CoverWidth 封面图宽度
	CoverWidth int64 `json:"cover_width,omitempty"`
	// CoverHeight 封面图高度
	CoverHeight int64 `json:"cover_height,omitempty"`
	// OverlayBgUrl 动态词包原始封面图片URL
	OverlayBgUrl string `json:"overlay_bg_url,omitempty"`
	// OverlayBgImageToken 动态词包原始封面图片token
	OverlayBgImageToken string `json:"overlay_bg_image_token,omitempty"`
	// StickerTitle 封面广告语标题
	StickerTitle string `json:"sticker_title,omitempty"`
	// OverlayType 贴纸样式类型
	OverlayType string `json:"overlay_type,omitempty"`
	// DisplayInfo 广告展示信息
	DisplayInfo *DisplayInfo `json:"display_info,omitempty"`
	// ShortSlogan 便利贴创意短广告语
	ShortSlogan string `json:"short_slogan,omitempty"`
	// ExposeTag 广告标签
	ExposeTag string `json:"expose_tag,omitempty"`
	// NewExposeTag 广告标签2期
	NewExposeTag []NewExposeTag `json:"new_expose_tag,omitempty"`
	// SiteID 安卓下载中间页ID
	SiteID int64 `json:"site_id,omitempty"`
	// ClickTrackUrl 点击监测链接; 若出现与后台显示不一致，以文档为准即可
	ClickTrackUrl string `json:"click_track_url,omitempty"`
	// ImpressionUrl 第三方开始播放监测链接; 若出现与后台显示不一致，以文档为准即可
	ImpressionUrl string `json:"impression_url,omitempty"`
	// AdPhotoPlayedT3sUrl 第三方有效播放监测链接; 仅历史个别账户使用
	AdPhotoPlayedT3sUrl string `json:"ad_photo_played_t3s_url,omitempty"`
	// ProgrammedCreativeMaterial 程序化创意物料
	ProgrammedCreativeMaterial *ProgrammedCreativeMaterial `json:"programmed_creative_material,omitempty"`
	// CreativeStatusType 否为僵尸创意; 1：僵尸 0：非僵尸
	CreativeStatusType int `json:"creative_status_type,omitempty"`
	// CreateTime 创建时间
	CreateTime string `json:"create_time,omitempty"`
	// UpdateTime 最后修改时间
	UpdateTime string `json:"update_time,omitempty"`

	ActionbarClickUrl string   `json:"actionbar_click_url,omitempty"`
	CreativeCategory  int      `json:"creative_category,omitempty"`
	CreativeTag       []string `json:"creative_tag,omitempty"`
	MerchantLibraryId int      `json:"merchant_library_id,omitempty"`
	MerchantProductId string   `json:"merchant_product_id,omitempty"`
	//SplashPictures             []interface{} `json:"splash_pictures"`
	//SplashPhotos               []interface{} `json:"splash_photos"`
	AdType int `json:"ad_type,omitempty"`
}

Creative 广告创意

type CreativeTagAdviseRequest 

type CreativeTagAdviseRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
}

CreativeTagAdviseRequest 创意标签填写建议 API Request

func (CreativeTagAdviseRequest) Encode 

func (r CreativeTagAdviseRequest) Encode() string

Encode implement GetRequest interface

func (CreativeTagAdviseRequest) Url 

func (r CreativeTagAdviseRequest) Url() string

Url implement GetRequest interface

type CreativeTagAdviseResponse 

type CreativeTagAdviseResponse struct {
	// Industry 一级行业
	Industry string `json:"industry,omitempty"`
	// SecondIndustry 二级行业
	SecondIndustry string `json:"secondIndustry,omitempty"`
	// Tags 推荐标签
	Tags []string `json:"tags,omitempty"`
}

CreativeTagAdviseResponse 创意标签填写建议 API Response

type DisplayInfo 

type DisplayInfo struct {
	// Description 广告语
	Description string `json:"description,omitempty"`
	// ActionBarText 行动号召按钮文案
	ActionBarText string `json:"action_bar_text,omitempty"`
}

DisplayInfo 广告展示信息

type ListRequest 

type ListRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CampaignID 广告计划ID; 过滤筛选条件，若不传或传空则视为无限制条件
	CampaignID uint64 `json:"campaign_id,omitempty"`
	// UnitID 广告组ID; 过滤筛选条件，若不传或传空则视为无限制条件
	UnitID uint64 `json:"unit_id,omitempty"`
	// CreativeID 广告创意ID; 过滤筛选条件，若不传或传空则视为无限制条件
	CreativeID string `json:"creative_id,omitempty"`
	// CreativeName 广告创意名称
	CreativeName string `json:"creative_name,omitempty"`
	// CreativeIDs 广告创意ID集
	CreativeIDs []uint64 `json:"creative_ids,omitempty"`
	// Status 广告创意状态; 过滤筛选条件；-1：不限，1：计划已暂停，3：计划超预算，6：余额不足，11：组审核中，12：组审核未通过，14：已结束，15：组已暂停，17：组超预算，19：未达投放时间，22：不在投放时段。41：审核中，42：审核未通过，46：已暂停，52：投放中，53：作品异常 -2：所有包含已删除 40：只包含已删除不传：所有不包含已删除 其他值无效
	Status int `json:"status,omitempty"`
	// StartDate 开始时间;与end_date同时传或同时不传；过滤筛选条件，格式为"yyyy-MM-dd"，参数值对应update_time信息
	StartDate string `json:"start_date,omitempty"`
	// EndDate 结束时间; 与start_date同时传或同时不传；过滤筛选条件，格式为"yyyy-MM-dd"，参数值对应update_time信息
	EndDate string `json:"end_date,omitempty"`
	// TimeFilterType 按创建时间，还是更新时间进行筛选; 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 请求的页码数 默认为1
	Page int `json:"page,omitempty"`
	// PageSize 请求的每页行数; 默认为20
	PageSize int `json:"page_size,omitempty"`
	// ActionbarClickUrl 第三方点击按钮监测链接
	ActionbarClickUrl string `json:"actionbar_click_url,omitempty"`
	// ReviewStatusList 单元审核状态筛选	1：待审核；2：审核通过；3：审核失败；7：待送审
	ReviewStatusList []int `json:"review_status_list,omitempty"`
	// PutStatusList 单元投放状态筛选	1：投放；2：暂停；3：删除
	PutStatusList []int `json:"put_status_list,omitempty"`
}

ListRequest 获取广告创意信息 API Request

func (ListRequest) Encode 

func (r ListRequest) Encode() []byte

Encode implement PostRequest interface

func (ListRequest) Url 

func (r ListRequest) Url() string

Url implement PostRequest interface

type ListResponse 

type ListResponse struct {
	// TotalCount 数据总数
	TotalCount int `json:"total_count,omitempty"`
	// Details 返回值详情
	Details []Creative `json:"details,omitempty"`
}

ListResponse 获取广告创意信息 API Response

type Material 

type Material struct {
	// PhotoID 视频ID
	PhotoID string `json:"photo_id,omitempty"`
	// ImageTokens 封面图片token
	ImageTokens []string `json:"image_tokens,omitempty"`
	// CreativeMaterialType 素材类型
	CreativeMaterialType int `json:"creative_material_type,omitempty"`
	// StickerTitles 封面广告语
	StickerTitles []string `json:"sticker_titles,omitempty"`
}

Material 物料信息

type NewExposeTag 

type NewExposeTag struct {
	Text string `json:"text"`
	Url  string `json:"url"`
}

type Photo 

type Photo struct {
	// PhotoID 视频ID
	PhotoID uint64 `json:"photo_id,omitempty"`
	// CoverImageToken 封面图片token;通过上传图片接口获得，不传值则直接使用视频的首帧作为封面图片，自定义封面的图片宽高要与视频宽高一致，使用智能抽帧时不需要传递。
	CoverImageToken string `json:"cover_image_token,omitempty"`
	// CreativeMaterialType 素材类型; 1：竖版视频 2：横版视频
	CreativeMaterialType int `json:"creative_material_type,omitempty"`
}

Photo 新创建程序化创意请使用素材列表

type PhotoItem 

type PhotoItem struct {
	// CreativeMaterialType 素材类型; 0：历史创意未作区分 1：竖版视频2：横版视频3：后贴片单图图片创意（历史类型，已下线）4：便利贴单图图片创意
	CreativeMaterialType int `json:"creative_material_type,omitempty"`
	// PhotoID 视频作品ID
	PhotoID string `json:"photo_id,omitempty"`
	// CoverImageTokens 封面图片cover_image_token
	CoverImageTokens string `json:"cover_image_tokens,omitempty"`
}

type PreviewRequest 

type PreviewRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// UserIDs 快手id; 一次不超过十个
	UserIDs []string `json:"user_ids,omitempty"`
	// CreativeID 创意id; unit_type为4时，必填
	CreativeID uint64 `json:"creative_id,omitempty"`
	// UnitID 组id; unit_type为7时，必填
	UnitID uint64 `json:"unit_id,omitempty"`
	// UnitType 组类型; 4：自定义创意 7：程序化创意2.0
	UnitType int `json:"unit_type,omitempty"`
	// Phones 用户要推送创意到哪个手机号; 原本是传userId，由于允许邮箱开户后，不一定每个userId都有手机号，所以改成传手机号
	Phones []string `json:"phones,omitempty"`
}

PreviewRequest 创意体验 API Request

func (PreviewRequest) Encode 

func (r PreviewRequest) Encode() []byte

Encode implement PostRequest interface

func (PreviewRequest) Url 

func (r PreviewRequest) Url() string

Url implement PostRequest interface

type ProgrammedCreativeMaterial 

type ProgrammedCreativeMaterial struct {
	// Materials 物料信息
	Materials []Material `json:"materials,omitempty"`
	// StickerStyleIDs 封面贴纸类型ID
	StickerStyleIDs []int `json:"sticker_style_ids,omitempty"`
	// DescriptionTItles 广告语
	DescriptionTItles []string `json:"description_titles,omitempty"`
	// StickerTitles 封面广告语
	StickerTitles []string `json:"sticker_titles,omitempty"`
}

ProgrammedCreativeMaterial 程序化创意物料

type UpdateRequest 

type UpdateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CreativeID 广告创意ID
	CreativeID uint64 `json:"creative_id,omitempty"`
	// CreativeName 创意名称; 长度为1-100字符，同一个广告组下名称不能重复
	CreativeName string `json:"creative_name,omitempty"`
	// PhotoID 视频ID
	PhotoID string `json:"photo_id,omitempty"`
	// ImageToken 封面图片token; 通过上传图片接口获得，不传值则直接使用视频的首帧作为封面图片，自定义封面的图片宽高要与视频宽高一致
	ImageToken *string `json:"image_token,omitempty"`
	// ImageTokens 便利贴单图图片创意token; 便利贴/图片/小图图片创意必填，目前只支持一张图片；组图图片创意需要上传3张图片，详细要求见附录
	ImageTokens []string `json:"image_tokens,omitempty"`
	// ActionBarText 行动号召按钮文案; 根据计划类型进行设置，详情见附录
	ActionBarText string `json:"action_bar_text,omitempty"`
	// Description 广告语; 长度为1-30字符，不支持换行。 如果要使用动态词包，格式如"[地区]的[男性女性]都喜欢"， 联盟广告和程序化创意不支持动态词包， 词包名可以通过下方动态词包接口获取
	Description string `json:"description,omitempty"`
	// ShortSlogan 便利贴创意短广告语; 长度为1-8字符，便利贴创意必填参数
	ShortSlogan string `json:"short_slogan,omitempty"`
	// StickerTitle 封面广告语标题; 不超过14字符， 如果要使用动态词包，格式如"[地区]的[男性女性]都喜欢"， 后贴片广告不支持动态词包， 词包名可以通过下方动态词包接口获取， sticker_title和overlay_type需同时为空值或同时非空
	StickerTitle string `json:"sticker_title,omitempty"`
	// OverlayType 贴纸样式类型; 贴纸样式可以通过查询下方贴纸掩饰接口获取， sticker_title和overlay_type需同时为空值或同时非空
	OverlayType string `json:"overlay_type,omitempty"`
	// ExposeTag 广告标签; 从 /expose_tags/list 接口获取，从下方9获取 更新的时候如果要将广告标签设置为 「暂不选择」，传空字符串即可，只支持计划类型为 2
	ExposeTag string `json:"expose_tag,omitempty"`
	// NewExposeTag 广告标签2期; 与老的expose_tag兼容, 逐渐将老的expose_tag替换掉。可以按照相关格式传递两个推荐理由 举例{“text”:""},{"text":""}
	NewExposeTag []string `json:"new_expose_tag,omitempty"`
	// SiteID 安卓下载中间页ID; 可从下方「获取已发布的下载页」接口获取（老建站6.30下线） 或通过「rest/openapi/v2/lp/page/list」获取新建站落地页（魔力建站"view_comps":7） 1.仅支持下载类广告 2.广告组选择的应用类型要为安卓 3.下载页对应的app_id要与广告组选择的app_id一致
	SiteID uint64 `json:"site_id,omitempty"`
	// ClickTrackUrl 第三方点击检测链接; 仅当广告组scene_id为1、2、6、7、10时，可选填； 广告组优化目标为激活时，该字段必填（下载类广告投放的应用集成快手Android SDK时除外） 使用Marketing API创建时，监测链接使用以该文档为准
	ClickTrackUrl *string `json:"click_track_url,omitempty"`
	// ImpressionUrl 第三方开始播放监测链接; 仅当广告组scene_id为3时，可选填； 广告组优化目标为激活时，该字段必填（下载类广告投放的应用集成快手Android SDK时除外） 使用Marketing API创建时，监测链接使用以该文档为准
	ImpressionUrl *string `json:"impression_url,omitempty"`
	// AdPhotoPlayedT3sUrl 第三方有效播放监测链接; 仅历史个别账户使用且当广告组scene_id为3时可选，与impression_url不可同时使用
	AdPhotoPlayedT3sUrl *string `json:"ad_photo_played_t3s_url,omitempty"`
	// CreativeCategory 创意分类; 由创意分类查询接口 获得；必须是叶子结点；与创意标签同时传或同时不传 必填账户可通过接口3.17——接口获取是否必填
	CreativeCategory int `json:"creative_category,omitempty"`
	// CreativeTag 创意标签; 与创意分类参数，要么都传，要么都不传；且单个创意的创意标签最多10个；单个创意标签不能为空且不能超过10字符
	CreativeTag []string `json:"creative_tag,omitempty"`
}

UpdateRequest 修改创意API Request

func (UpdateRequest) Encode 

func (r UpdateRequest) Encode() []byte

Encode implement PostRequest interface

func (UpdateRequest) Url 

func (r UpdateRequest) Url() string

Url implement PostRequest interface

type UpdateResponse 

type UpdateResponse struct {
	// CreativeID 创意ID
	CreativeID uint64 `json:"creative_id,omitempty"`
}

UpdateResponse 修改创意 API Response

type UpdateStatusRequest 

type UpdateStatusRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID int64 `json:"advertiser_id,omitempty"`
	// CreativeID 广告创意ID
	CreativeID uint64 `json:"creative_id,omitempty"`
	// CreativeIDs 与原有的creative_id字段可以同时填，也可以只填一个; 1.传入的创意id不得重复，且至少有一个;传入的创意id总数最多20个。2.put_status为3时，会删除所有创意
	CreativeIDs []uint64 `json:"creative_ids,omitempty"`
	// PutStatus 操作码; 1-投放、2-暂停、3-删除，传其他数字非法
	PutStatus int `json:"put_status,omitempty"`
}

UpdateStatusRequest 修改创意状态

func (UpdateStatusRequest) Encode 

func (r UpdateStatusRequest) Encode() []byte

Encode implement PostRequest interface

func (UpdateStatusRequest) Url 

func (r UpdateStatusRequest) Url() string

Url implement PostRequest interface

type UpdateStatusResponse 

type UpdateStatusResponse struct {
	// CreativeIDs 所有修改状态成功的创意id; 假如接口的入参 creative_id传了值且修改状态成功，则此创意id也会包含在返回值creative_ids里面
	CreativeIDs []uint64 `json:"creative_ids,omitempty"`
}

UpdateStatusResponse 修改创意状态

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.