creative

package
v1.14.0 Latest Latest
Warning

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

 Go to latest Published: May 31, 2023 License: Apache-2.0 Imports: 6 Imported by: 1

Documentation

Overview

Package creative 广告创意模块API models

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AbstractMaterial added in v1.5.0 

type AbstractMaterial struct {
	// TextAbstractInfo 文本摘要信息; 注意：与标签摘要struct_abstract_info选其一
	TextAbstractInfo *TextAbstractInfo `json:"text_abstract_info,omitempty"`
	// StructAbstractInfo 标签摘要信息列表;注意：与文本摘要text_abstract_info选其一
	StructAbstractInfo *StructAbstractInfo `json:"struct_abstract_info,omitempty"`
}

AbstractMaterial 摘要素材

type AdData added in v1.5.0 

type AdData struct {
	// ThridIndustryID 三级行业ID
	ThirdIndustryID uint64 `json:"thrid_industry_id,omitempty"`
	// ParamsType 链接类型
	ParamsType string `json:"params_type,omitempty"`
	// DpaExternalUrlField 落地页链接字段选择
	DpaExternalUrlField *string `json:"dpa_external_url_field,omitempty"`
	// AdKeywords 创意标签。最多20个标签，且每个标签长度不超过10个字符
	AdKeywords []string `json:"ad_keywords,omitempty"`
	// Source 广告来源，4-20个字符，当推广目的为非应用下载或者应用下载且download_type为"EXTERNAL_URL时"时必填
	Source string `json:"source,omitempty"`
	// EnableSmartSource 是否开启来源智能生成，允许值：ON 开启，OFF 关闭
	EnableSmartSource string `json:"enable_smart_source,omitempty"`
	// IesCoreUserID 品牌主页-推广抖音号，当传入此字段时表示开启抖音主页。广告视频将同步到您的主页下，在客户端点击广告头像将进入您的主页。创建后不可修改。
	IesCoreUserID string `json:"ies_core_user_id,omitempty"`
	// IsPresentedVideo 自动生成视频素材，利用已上传的图片与视频生成更多优质的短视频素材：1（启用），0（不启用）默认值: 0
	IsPresentedVideo *int `json:"is_presented_video,omitempty"`
	// PlayableURL 搭配试玩素材URL，可通过【获取试玩素材列表】进行获取。
	PlayableURL string `json:"playable_url,omitempty"`
	// IsFeedAndFavSee 主页作品列表隐藏广告内容，默认值：0; 允选值：0（不隐藏），1（隐藏）
	IsFeedAndFavSee *int `json:"is_feed_and_fav_see,omitempty"`
	// CreativeAutoGenerateSwitch 是否开启自动派生创意，大通投时可填，默认值: 1允许值: 0(不启用), 1(启用)
	CreativeAutoGenerateSwitch *int `json:"creative_auto_generate_switch,omitempty"`
	// AppName 应用名，当广告计划的download_type为"DOWNLOAD_URL"时必填。1到40个字符，中文占2个字符
	AppName string `json:"app_name,omitempty"`
	// WebURL Android应用下载详情页（用户点击广告中“立即下载”按钮以外的区域时所到达的页面），当广告计划app_type为"APP_ANDROID"或快应用推广目的时, 必填; 可从此接口获取：【获取橙子建站站点列表】
	WebURL string `json:"web_url,omitempty"`
	// ExternalURL 落地页链接（支持橙子建站落地页）
	ExternalURL string `json:"external_url,omitempty"`
	// ExternalUrlParams 落地页检测参数
	ExternalUrlParams *string `json:"external_url_params,omitempty"`
	// IsCommentDisable 是否关闭评论，0为开启，1为关闭，默认值：0; 允许值: 0, 1
	IsCommentDisable *int `json:"is_comment_disable,omitempty"`
	// AdDownloadStatus 允许客户端下载视频功能，0为开启，即允许客户端下载视频；1为关闭，即不允许客户端下载视频。默认不传值，表示允许客户端下载视频。关闭客户端下载视频功能仅对本地上传的视频有效。
	AdDownloadStatus *int `json:"ad_download_status,omitempty"`
	// PriorityTrail 是否优先调起试玩。当推广目的为应用推广且使用搭配试玩素材时可以开启该功能。允许值：ON开启，OFF关闭
	PriorityTrail string `json:"priority_trail,omitempty"`
	// Supplements 云游戏
	Supplements []SupplementInfo `json:"supplements,omitempty"`
	// DynamicCreativeSwitch 启用动态创意类型,详见【附录-动态创意类型】
	// 允许值:DYNAMIC_CREATIVE_TITLE, DYNAMIC_CREATIVE_ABSTRACT，DYNAMIC_CREATIVE_SUBLINK，DYNAMIC_CREATIVE_ON，默认DYNAMIC_CREATIVE_ON当传入不为空时，等同于传入DYNAMIC_CREATIVE_ON启用动态创意，当传入[]时，关闭动态创意
	// 不传时，不改变已有的值
	// 注意：该字段为【增量更新】
	DynamicCreativeSwitch []enum.DynamicCreativeType `json:"dynamic_creative_switch,omitempty"`
	// OpenURL 直达链接，只在电商店铺推广推广目的下有效
	OpenURL string `json:"open_url,omitempty"`
	// MiniProgramInfo 字节小程序信息
	MiniProgramInfo *MiniProgramInfo `json:"mini_program_info,omitempty"`
	// AnchorRelatedType 原生锚点启用类型，允许值：不启用OFF，自动生成AUTO，手动选择SELECT
	// 默认值为OFF
	// 自动生成AUTO仅应用推广目的下时支持
	AnchorRelatedType string `json:"anchor_related_type,omitempty"`
	// AnchorType 锚点类型，允许值：
	// - 应用下载-游戏：APP_GAME
	// - 应用下载-网服：APP_INTERNET_SERVICE
	// - 应用下载-电商：APP_SHOP
	// - 高级在线预约：ONLINE_SUBSCRIBE
	// 当 anchor_related_type = SELECT时必填
	AnchorType enum.AnchorType `json:"anchor_type,omitempty"`
	// AnchorID 原生锚点id，当 anchor_related_type = SELECT时必填，可从【获取账户下原生锚点】接口中获取
	AnchorID string `json:"anchor_id,omitempty"`
}

AdData 广告计划数据

type CommerceCard 

type CommerceCard struct {
	// Title 产品卖点
	Title string `json:"title,omitempty"`
	// Source 产品名称
	Source string `json:"source,omitempty"`
	// ImageID 直播卡片图片信息。传入commerce_cards时必填。可通过调用【获取图片素材】获得。该图片信息作展示使用，可以自行选择您素材库中需要展示的图片进行上传。建议最佳：宽高比1:1, 224px*224px,小于300KB
	ImageID string `json:"image_id,omitempty"`
	// ImageInfo 素材信息
	ImageInfo *struct {
		// Width 宽度
		Width int `json:"width,omitempty"`
		// Height 高度
		Height int `json:"height,omitempty"`
		// WebUri 直播卡片图片信息
		WebUri string `json:"web_uri,omitempty"`
	} `json:"image_info,omitempty"`
}

CommerceCard 产品（商业卡）信息

type ComponentMaterial added in v1.5.0 

type ComponentMaterial struct {
	// ComponentID 组件id，通过【查询组件列表】接口获取
	ComponentID model.Uint64 `json:"component_id,omitempty"`
	// ComponentType 组件类型
	ComponentType enum.ComponentType `json:"component_type,omitempty"`
	// MaterialID
	MaterialID model.Uint64 `json:"material_id,omitempty"`
}

ComponentMaterial 组件信息

type CreateRequest added in v1.5.0 

type CreateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdID 广告计划ID，计划ID要属于广告主ID，且非删除计划，否则会报错
	AdID uint64 `json:"ad_id,omitempty"`
	// InventoryType 广告投放位置（首选媒体）
	InventoryType enum.StatInventoryType `json:"inventory_type,omitempty"`
	// SmartInventory 优选广告位，0表示不使用优选，1表示使用，使用优选广告位的时候默认忽略inventory_type字段;默认值: 0; 允许值: 0、1
	SmartInventory int `json:"smart_inventory,omitempty"`
	// CreativeMaterialMode 创意方式，当值为"STATIC_ASSEMBLE"表示程序化创意，其他情况不传字段
	CreativeMaterialMode enum.CreativeMaterialMode `json:"creative_material_mode,omitempty"`
	// ProceduralPackageID 程序化创意包ID，可通过【查询程序化创意包】接口进行查询，程序化创意包与自定义素材（title_list和image_list）不能同时使用，否则会报错;仅支持程序化创意，头条文章、DPA推广类型暂不支持
	ProceduralPackageID uint64 `json:"procedural_package_id,omitempty"`
	// IsPresentedVideo 自动生成视频素材，利用已上传的图片与视频生成更多优质的短视频素材：1（启用），0（不启用）默认值: 0
	IsPresentedVideo int `json:"is_presented_video,omitempty"`
	// ImageList 素材信息，creative_material_mode为"STATIC_ASSEMBLE"时必填，字段说明见下表。最多包含12张图和10个视频。
	ImageList []ImageInfo `json:"image_list,omitempty"`
	// TitleList 标题信息，creative_material_mode为"STATIC_ASSEMBLE"时必填，字段说明见下表。最多包含10个标题。
	TitleList []TitleMaterial `json:"title_list,omitempty"`
	// ComponentInfo 组件信息
	ComponentInfo []ComponentMaterial `json:"component_info,omitempty"`
	// Creatives 自定义素材信息, 最多支持10个创意。首选投放位置和创意类型决定素材规格。当为程序化创意时，该字段不填数据，值为[]
	Creatives []Creative `json:"creatives,omitempty"`
	// Source 广告来源，4-20个字符，当推广目的为非应用下载或者应用下载且download_type为"EXTERNAL_URL时"时必填
	Source string `json:"source,omitempty"`
	// IesCoreUserID 品牌主页-推广抖音号，当传入此字段时表示开启抖音主页。广告视频将同步到您的主页下，在客户端点击广告头像将进入您的主页。创建后不可修改。
	IesCoreUserID string `json:"ies_core_user_id,omitempty"`
	// IsFeedAndFavSee 主页作品列表隐藏广告内容，默认值：0; 允选值：0（不隐藏），1（隐藏）
	IsFeedAndFavSee *int `json:"is_feed_and_fav_see,omitempty"`
	// CreativeAutoGenerateSwitch 是否开启自动派生创意，大通投时可填，默认值: 1允许值: 0(不启用), 1(启用)
	CreativeAutoGenerateSwitch *int `json:"creative_auto_generate_switch,omitempty"`
	// AppName 应用名，当广告计划的download_type为"DOWNLOAD_URL"时必填。1到40个字符，中文占2个字符
	AppName string `json:"app_name,omitempty"`
	// SubTitle APP 副标题。仅推广目标为APP，4到24个字符，填写Android下载链接时可设置
	SubTitle string `json:"sub_title,omitempty"`
	// WebURL Android应用下载详情页（用户点击广告中“立即下载”按钮以外的区域时所到达的页面），当广告计划app_type为"APP_ANDROID"或快应用推广目的时, 必填; 可从此接口获取：【获取橙子建站站点列表】
	WebURL string `json:"web_url,omitempty"`
	// ActionText 行动号召（仅应用下载推广类型有效）;备注：应用下载的行动号召字段使用action_text，门店与销售线索行动号召使用button_text;请求值可从接口【行动号召字段内容获取】进行获取，如果不传参默认为立即下载
	ActionText string `json:"action_text,omitempty"`
	// PlayableURL 搭配试玩素材URL，可通过【获取试玩素材列表】进行获取。
	PlayableURL string `json:"playable_url,omitempty"`
	// IsCommentDisabled 是否关闭评论，0为开启，1为关闭，默认值：0; 允许值: 0, 1
	IsCommentDisabled *int `json:"is_comment_disabled,omitempty"`
	// PromotionCard 商品推广卡片，如不传，则创意中没有推广卡片
	PromotionCard []PromotionCard `json:"promotion_card,omitempty"`
	// AdDownloadStatus 允许客户端下载视频功能，0为开启，即允许客户端下载视频；1为关闭，即不允许客户端下载视频。默认不传值，表示允许客户端下载视频。关闭客户端下载视频功能仅对本地上传的视频有效。
	AdDownloadStatus *int `json:"ad_download_status,omitempty"`
	// AdvancedCreativeType 附加创意类型。直播创意枚举：ATTACHED_CREATIVE_LIVE_CARD（直播卡片）
	AdvancedCreativeType enum.AdvancedCreativeType `json:"advanced_creative_type,omitempty"`
	// AdvancedCreativeTitle 副标题，最多24个字符
	AdvancedCreativeTitle string `json:"advanced_creative_title,omitempty"`
	// PhoneNumber 电话号码。当附加创意类型为"ATTACHED_CREATIVE_PHONE"时必填
	PhoneNumber string `json:"phone_number,omitempty"`
	// ButtonText 按钮文本，即行动号召，当附加创意类型非"ATTACHED_CREATIVE_NONE"时填写，请求值可从接口【行动号召字段内容获取】进行获取
	ButtonText string `json:"button_text,omitempty"`
	// FormURL 表单提交链接。当附加创意类型为"ATTACHED_CREATIVE_FORM"时 必填，必须为今日头条建站地址：【查询已有表单列表】
	FormURL string `json:"form_url,omitempty"`
	// CommerceCards 产品（商业卡）信息;目前为白名单功能，如需使用请联系平台运营
	CommerceCards []CommerceCard `json:"commerce_cards,omitempty"`
	// TrackURL 展示（监测链接）
	TrackURL string `json:"track_url,omitempty"`
	// ActionTrackURL 点击（监测链接）（当推广目的为应用下载且创建计划传递了convert_id，系统会自动获取转化中的点击监测链接，且不可修改）
	ActionTrackURL string `json:"action_track_url,omitempty"`
	// VideoPlayEffectiveTrackURL 视频有效播放（监测链接），投放范围为穿山甲时暂不支持设置此链接
	VideoPlayEffectiveTrackURL string `json:"video_play_effective_track_url,omitempty"`
	// VideoPlayDoneTrackURL 视频播完（监测链接），投放范围为穿山甲时暂不支持设置此链接
	VideoPlayDoneTrackURL string `json:"video_play_done_track_url,omitempty"`
	// VideoPlayTrackURL 视频播放（监测链接），投放范围为穿山甲时暂不支持设置此链接
	VideoPlayTrackURL string `json:"video_play_track_url,omitempty"`
	// TrackURLSendType 数据发送方式，不可修改,默认值: SERVER_SEND; 允许值: SERVER_SEND(服务器端上传), CLIENT_SEND(客户端上传);客户端上传是指由客户端直接上报给监测平台的服务器, 只有白名单用户才可使用CLIENT_SEND(客户端上传), 如果需要开通请找对接的销售、运营
	TrackURLSendType string `json:"track_url_send_type,omitempty"`
}

CreateRequest 创建广告创意 API Request

func (CreateRequest) Encode added in v1.5.0 

func (r CreateRequest) Encode() []byte

Encode implement PostRequest interface

type CreateResponse added in v1.5.0 

type CreateResponse struct {
	model.BaseResponse
	// Data json返回值
	Data *CreateResponseData `json:"data,omitempty"`
}

CreateResponse 创建广告创意 API Response

type CreateResponseData added in v1.5.0 

type CreateResponseData struct {
	CreateRequest
	// ProceduralPackageVersion 程序化创意包版本
	ProceduralPackageVersion string `json:"procedural_package_version,omitempty"`
	// GenerateDerivedAd 是否开启衍生计划，1为开启，0为不开启; 默认值: 0
	GenerateDerivedAd int `json:"generate_derived_ad,omitempty"`
	// CloseVideoDetail 是否关闭视频详情页落地页(勾选该选项后,视频详情页中不默认弹出落地页,仅对视频广告生效); 允许值: 0, 1
	CloseVideoDetail int `json:"close_video_detail,omitempty"`
	// CreativeDisplayMode 创意展现方式
	CreativeDisplayMode enum.CreativeDisplayMode `json:"creative_display_mode,omitempty"`
}

CreateResponseData json返回值

type Creative 

type Creative struct {
	// CreativeID 创意ID
	CreativeID uint64 `json:"creative_id,omitempty"`
	// AdID 广告计划ID
	AdID uint64 `json:"ad_id,omitempty"`
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Title 创意素材标题
	Title string `json:"title,omitempty"`
	// BidwordList 关键词列表
	BidwordList []WordListItem `json:"bidword_list,omitempty"`
	// CreativeWordIDs 动态词包列表
	CreativeWordIDs []uint64 `json:"creative_word_ids,omitempty"`
	// TextAbstractInfo 文本摘要
	TextAbstractInfo *TextAbstractInfo `json:"text_abstract_info,omitempty"`
	// StructAbstractInfo 标签摘要列表
	StructAbstractInfo []StructAbstractInfo `json:"struct_abstract_info,omitempty"`
	// Status 创意素材状态
	Status enum.CreativeStatus `json:"status,omitempty"`
	// OptStatus 创意素材操作状态
	OptStatus enum.CreativeOptStatus `json:"opt_status,omitempty"`
	// ImageMode 创意素材类型
	ImageMode enum.ImageMode `json:"image_mode,omitempty"`
	// ImageIDs 图片素材，图片ID列表
	ImageIDs []string `json:"image_ids,omitempty"`
	// ImageID 视频素材，封面图片ID
	ImageID string `json:"image_id,omitempty"`
	// VideoID 视频素材，视频ID
	VideoID string `json:"video_id,omitempty"`
	// PlayableInfo 基础试玩素材信息，使用基础试玩素材时返回
	PlayableInfo *PlayableInfo `json:"playable_info,omitempty"`
	// DerivePosterCID 是否将视频的封面和标题同步到图片创意，1为开启，0为不开启。视频素材时返
	DerivePosterCID *int `json:"derive_poster_cid,omitempty"`
	// ThirdPartyID 第三方ID
	ThirdPartyID string `json:"third_party_id,omitempty"`
	// DpaDictIDs DPA词包ID列表，针对DPA广告
	DpaDictIDs []uint64 `json:"dpa_dict_ids,omitempty"`
	// TemplateID DPA模板ID，针对DPA广告
	TemplateID uint64 `json:"template_id,omitempty"`
	// TemplateDataList 模版自定义参数
	TemplateDataList []TemplateData `json:"template_data_list,omitempty"`
	// TemplateImageID DPA创意实际显示的图片ID，针对DPA广告
	TemplateImageID string `json:"template_image_id,omitempty"`
	// DpaTemplate 是否使用商品库视频模板，针对DPA广告
	DpaTemplate uint64 `json:"dpa_template,omitempty"`
	// DpaVideoTempateType 商品库视频模板生成类型，针对DPA广告
	DpaVideoTemplateType enum.DpaVideoTemplateType `json:"dpa_video_template_type,omitempty"`
	// DpaVideoTaskIDs 自定义商品库视频模板ID，针对DPA广告
	DpaVideoTaskIDs []string `json:"dpa_video_task_ids,omitempty"`
	// ComponentInfo 创意组件信息
	ComponentInfo []ComponentMaterial `json:"component_info,omitempty"`
	// Materials 素材信息列表，标题，图片，视频均是不同素材，注意部分老数据可能此结构为空
	Materials []Material `json:"materials,omitempty"`
	// CreativeCreateTime 广告创意创建时间，格式yyyy-MM-dd HH:mm:ss
	CreativeCreateTime string `json:"creative_create_time,omitempty"`
	// CreativeModifyTime 广告创意更新时间，格式yyyy-MM-dd HH:mm:ss
	CreativeModifyTime string `json:"creative_modify_time,omitempty"`
}

Creative 创意

type CreativeDetail 

type CreativeDetail struct {
	// AdID 广告计划ID
	AdID uint64 `json:"ad_id,omitempty"`
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// ModifyTime 时间戳，用于判断创意版本
	ModifyTime string `json:"modify_time,omitempty"`
	// InventoryType 创意首选投放位置,详见【附录-首选投放位置】，请注意广告位中的信息流（INVENTORY_FEED）与详情页（INVENTORY_TEXT_LINK）已合并为头条系（依然使用INVENTORY_FEED字段，名称更改为头条系）
	InventoryType []enum.StatInventoryType `json:"inventory_type,omitempty"`
	// ExternalUrl 落地页链接，新版营销链路下创意支持
	ExternalUrl string `json:"external_url,omitempty"`
	// AdDownloadStatus 允许客户端下载视频功能，0为开启，即允许客户端下载视频；1为关闭，即不允许客户端下载视频，该字段为空与0效果一致，即表示允许客户端下载视频。关闭客户端下载视频功能仅对本地上传的视频有效
	AdDownloadStatus *int `json:"ad_download_status,omitempty"`
	// SmartInventory 是否使用优选广告位，0表示不使用优选，1表示使用，2表示标记该创意隶属的计划投放范围是通投智选
	SmartInventory int `json:"smart_inventory,omitempty"`
	// ComponentInfo 创意组件信息
	ComponentInfo []ComponentMaterial `json:"component_info,omitempty"`
	// SceneInventory 首选场景广告位，详见【附录-首选场景广告位】，使用首选场景广告位时默认忽略inventory_type字段，与scene_inventory不能同时传 允许值: "VIDEO_SCENE", "FEED_SCENE", "TAIL_SCENE"
	SceneInventory string `json:"scene_inventory,omitempty"`
	// CreativeMaterialMode 创意类型，该字段为STATIC_ASSEMBLE表示程序化创意，其他情况无该字段
	CreativeMaterialMode enum.CreativeMaterialMode `json:"creative_material_mode,omitempty"`
	// ProceduralPackageID 程序化创意包ID
	ProceduralPackageID uint64 `json:"procedural_package_id,omitempty"`
	// ProceduralPackageVersion 程序化创意包版本
	ProceduralPackageVersion uint64 `json:"procedural_package_version,omitempty"`
	// IsPresentedVideo 启用图片生成视频，允许值：0（不启用），1（启用）
	IsPresentedVideo *int `json:"is_presented_video,omitempty"`
	// GenerateDerivedAd 是否开启衍生计划，1为开启，0为不开启
	GeneratedDerivedAd string `json:"generated_derived_ad,omitempty"`
	// ImageList 素材信息，程序化创意素材列表。最多包含12张图和6个视频。
	ImageList []ImageInfo `json:"image_list,omitempty"`
	// TitleList 标题信息，程序化创意标题列表。最多包含10个标题
	TitleList []TitleMaterial `json:"title_list,omitempty"`
	// AbstractList 搜索广告字段
	AbstractList []AbstractMaterial `json:"abstract_list,omitempty"`
	// Creatives 素材信息, 首选投放位置和创意类型决定素材规格。程序化创意只有在审核通过后才有值
	Creatives []Creative `json:"creatives,omitempty"`
	// Source 广告来源
	Source string `json:"source,omitempty"`
	// IesCoreUserID 广告主绑定的抖音ID
	IesCoreUserID string `json:"ies_core_user_id,omitempty"`
	// IsFeedAndFavSee 是否隐藏抖音主页，0：不隐藏，1：隐藏
	IsFeedAndFavSee *int `json:"is_feed_and_fav_see,omitempty"`
	// CreativeAutoGenerateSwitch 是否开启自动生成素材，delivery_range为UNIVERSAL：通投智选时返回，0：不启用,1：启用
	CreativeAutoGenerateSwitch *int `json:"creative_auto_generate_switch,omitempty"`
	// AppName 应用名
	AppName string `json:"app_name,omitempty"`
	// SubTitle APP 副标题。
	SubTitle string `json:"sub_title,omitempty"`
	// WebUrl Android应用下载详情页
	WebUrl string `json:"web_url,omitempty"`
	// OpenUrl 直达链接，只在电商店铺推广推广目的下有效
	OpenUrl string `json:"open_url,omitempty"`
	// ActionText 行动号召
	ActionText string `json:"action_text,omitempty"`
	// PlayableUrl 试玩素材URL
	PlayableUrl string `json:"playable_url,omitempty"`
	// IsCommentDisable 是否关闭评论
	IsCommentDisable *int `json:"is_comment_disable,omitempty"`
	// CloseVideoDetail 是否关闭视频详情页落地页(勾选该选项后,视频详情页中不默认弹出落地页,仅对视频广告生效)
	CloseVideoDetail *int `json:"close_video_detail,omitempty"`
	// CreativeDisplayMode 创意展现方式
	CreativeDisplayMode enum.CreativeDisplayMode `json:"creative_display_mode,omitempty"`
	// AdvancedCreativeType 附加创意类型
	AdvancedCreativeType enum.AdvancedCreativeType `json:"advanced_creative_type,omitempty"`
	// AdvancedCreativeTitle 附加创意副标题
	AdvancedCreativeTitle string `json:"advanced_creative_title,omitempty"`
	// PhoneNumber 电话号码(当附加创意类型为ATTACHED_CREATIVE_PHONE时返回)
	PhoneNumber string `json:"phone_number,omitempty"`
	// ButtonText 按钮文本(当附加创意类型不为ATTACHED_CREATIVE_NONE时返回)
	ButtonText string `json:"button_text,omitempty"`
	// FormUrl 表单提交链接(当附加创意类型为ATTACHED_CREATIVE_FORM时返回)
	FormUrl string `json:"form_url,omitempty"`
	// CommmerceCards 产品（商业卡）信息。如果没有启用，那么不返回相关字段。
	CommerceCards []CommerceCard `json:"commerce_cards,omitempty"`
	// ThirdIndustryID 三级行业ID
	ThirdIndustryID uint64 `json:"third_industry_id,omitempty"`
	// AdKeywords 创意标签
	AdKeywords []string `json:"ad_keywords,omitempty"`
	// TrackUrl 展示（监测链接）
	TrackUrl string `json:"track_url,omitempty"`
	// ActionTrackUrl 点击（监测链接）（当推广目的为应用下载且创建计划传递了convert_id，系统会自动获取转化中的点击监测链接，且不可修改）
	ActionTrackUrl string `json:"action_track_url,omitempty"`
	// VideoPlayEffectTrackUrl 视频有效播放（监测链接）
	VideoPlayEffectTrackUrl string `json:"video_play_effect_track_url,omitempty"`
	// VideoPlayDoneTrackUrl 视频播完（监测链接）
	VideoPlayDoneTrackUrl string `json:"video_play_done_track_url,omitempty"`
	// VideoPlayTrackUrl 视频播放（监测链接）
	VideoPlayTrackUrl string `json:"video_play_track_url,omitempty"`
	// TrackUrlSendType 数据发送方式; 允许值: SERVER_SEND(服务器端上传), CLIENT_SEND(客户端上传)
	TrackUrlSendType string `json:"track_url_send_type,omitempty"`
	// PromotionCard 商品推广卡片
	PromotionCard *PromotionCard `json:"promotion_card,omitempty"`
	// CollocationType 云游戏类型，允许值"CLOUD_GAME"云游戏
	CollocationType string `json:"collocation_type,omitempty"`
	// Supplements 云游戏素材
	Supplements []Supplement `json:"supplements,omitempty"`
	// IsSmartTitle
	IsSmartTitle *int `json:"is_smart_title,omitempty"`
	// AdCategory
	AdCategory uint64 `json:"ad_category,omitempty"`
	// PriorityTrial 是否优先调起试玩。当推广目的为应用推广且使用搭配试玩素材是可以开启该功能。允许值：ON开启，OFF关闭，默认关闭
	PriorityTrial string `json:"priority_trial,omitempty"`
	// DynamicCreativeSwitch 启用动态创意类型,详见【附录-动态创意类型】
	// 允许值:DYNAMIC_CREATIVE_TITLE, DYNAMIC_CREATIVE_ABSTRACT，DYNAMIC_CREATIVE_SUBLINK，DYNAMIC_CREATIVE_ON，默认DYNAMIC_CREATIVE_ON当传入不为空时，等同于传入DYNAMIC_CREATIVE_ON启用动态创意，当传入[]时，关闭动态创意
	// 不传时，不改变已有的值
	// 注意：该字段为【增量更新】
	DynamicCreativeSwitch []enum.DynamicCreativeType `json:"dynamic_creative_switch,omitempty"`
	// MiniProgramInfo 字节小程序信息
	MiniProgramInfo *MiniProgramInfo `json:"mini_program_info,omitempty"`
}

CreativeDetail 创意详情

type CreativeDetailV2 added in v1.8.17 

type CreativeDetailV2 struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdID 广告计划ID，计划ID要属于广告主ID，且非删除计划，否则会报错
	AdID uint64 `json:"ad_id,omitempty"`
	// CreativeList 自定义素材信息
	CreativeList []CreativeInfo `json:"creative_list,omitempty"`
	// Creative 程序化素材信息，投放位置和创意类型决定素材规格。
	Creative *CreativeInfo `json:"creative,omitempty"`
	// AdData 广告计划数据
	AdData *AdData `json:"ad_data,omitempty"`
}

CreativeDetailV2 创意详情 (新)

type CreativeInfo added in v1.5.0 

type CreativeInfo struct {
	// ImageMode 素材类型
	ImageMode enum.ImageMode `json:"image_mode,omitempty"`
	// CreativeID 创意id，填写id为修改创意，不填为新增创意，需要注意该接口为全量接口，不填写id的已有创意会被覆盖
	CreativeID uint64 `json:"creative_id,omitempty"`
	// TitleMaterial 标题素材
	TitleMaterial *TitleMaterial `json:"title_material,omitempty"`
	// TitleMaterials 创意标题素材，最多支持10个标题，不使用程序化创意包时必填
	TitleMaterials []TitleMaterial `json:"title_materials,omitempty"`
	// ImageMaterials 创意图片素材，组图、橱窗类型传3张，其他图片类型传1张，使用DPA模板时template_image只能传入1个，image_mode为图片素材时使用
	ImageMaterials []ImageMaterial `json:"image_materials,omitempty"`
	// VideoMaterials 视频素材信息，image_mode为视频素材时使用
	VideoMaterials []VideoMaterial `json:"video_materials,omitempty"`
	// VideoMaterial 视频素材信息，image_mode为视频素材时使用
	VideoMaterial *VideoMaterial `json:"video_material,omitempty"`
	// SubTitleMaterial 副标题素材
	SubTitleMaterial *TitleMaterial `json:"sub_title_material,omitempty"`
	// PlayableMaterial 基础试玩素材，image_mode为基础试玩素材时使用，不支持和image_materials同时传入
	PlayableMaterial *PlayableMaterial `json:"playable_material,omitempty"`
	// InteractiveMaterial 直出互动素材信息
	InteractiveMaterial *InteractiveMaterial `json:"interactive_material,omitempty"`
	// CompnentMaterials 组件信息，数组传入最大长度2，每种类型（基础/附加组件）最多支持1个; 附加组件：选择磁贴、投票磁贴、图片磁贴、电商磁贴、优惠券磁贴、游戏礼包码; 基础组件：推广卡片
	ComponentMaterials []ComponentMaterial `json:"component_materials,omitempty"`
	// AbstractMaterials 摘要素材，使用标签摘要时必须要传入3个;使用搜索广告时必传
	AbstractMaterials []AbstractMaterial `json:"abstract_materials,omitempty"`
	// DecorationMaterial 家装卡券素材
	DecorationMaterial *DecorationMaterial `json:"decoration_material,omitempty"`
	// DerivePosterCid 是否将视频的封面和标题同步到图片创意。视频素材可填写。在创建完视频创意后，在计划下同步新建图片创意，允许值：0（不开启），1（开启）
	DerivePosterCid *int `json:"derive_poster_cid,omitempty"`
	// ThirdPartyID 创意自定义参数，例如开发者可设定此参数为创意打标签，用于区分使用的素材
	ThirdPartyID string `json:"third_party_id,omitempty"`
}

CreativeInfo 创意信息

type CustomCreativeCreateRequest added in v1.5.0 

type CustomCreativeCreateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdID 广告计划ID，计划ID要属于广告主ID，且非删除计划，否则会报错
	AdID uint64 `json:"ad_id,omitempty"`
	// CreativeList 自定义素材信息, 最多支持10个创意。投放位置和创意类型决定素材规格。
	CreativeList []CreativeInfo `json:"creative_list,omitempty"`
	// AdData 广告计划数据
	AdData *AdData `json:"ad_data,omitempty"`
}

CustomCreativeCreateRequest 创建自定义创意（营销链路） API Request

func (CustomCreativeCreateRequest) Encode added in v1.5.0 

func (r CustomCreativeCreateRequest) Encode() []byte

Encode implement PostRequest interface

type CustomCreativeCreateResponse added in v1.5.0 

type CustomCreativeCreateResponse struct {
	model.BaseResponse
	// Data json返回值
	Data *CustomCreativeCreateResponseData `json:"data,omitempty"`
}

CustomCreativeCreateResponse 创建自定义创意 API Response

type CustomCreativeCreateResponseData added in v1.5.0 

type CustomCreativeCreateResponseData struct {
	// CreativeIDs 创意ID列表，若部分失败，则对应项为null
	CreativeIDs []uint64 `json:"creative_ids,omitempty"`
	// Errors 每个创意对应的错误信息，若部分成功，则对应项为null
	Errors []Error `json:"errors,omitempty"`
}

CustomCreativeCreateResponseData json返回值

type CustomCreativeUpdateRequest added in v1.5.0 

type CustomCreativeUpdateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdID 广告计划ID，计划ID要属于广告主ID，且非删除计划，否则会报错
	AdID uint64 `json:"ad_id,omitempty"`
	// CreativeList 自定义素材信息, 最多支持10个创意。投放位置和创意类型决定素材规格。
	CreativeList []CreativeInfo `json:"creative_list,omitempty"`
	// AdData 广告计划数据
	AdData *AdData `json:"ad_data,omitempty"`
}

CustomCreativeUpdateRequest 修改自定义创意 API Request

func (CustomCreativeUpdateRequest) Encode added in v1.5.0 

func (r CustomCreativeUpdateRequest) Encode() []byte

Encode implement PostRequest interface

type DecorationMaterial added in v1.9.6 

type DecorationMaterial struct {
	// ActivityID 活动ID
	ActivityID string `json:"activity_id,omitempty"`
	// ImageMode 素材类型
	ImageMode enum.ImageMode `json:"image_mode,omitempty"`
}

DecorationMaterial 家装卡券素材

type DetailGetRequest added in v1.8.17 

type DetailGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdID 计划ID
	AdID uint64 `json:"ad_id,omitempty"`
}

DetailGetRequest 创意详细信息(新)API Request

func (DetailGetRequest) Encode added in v1.8.17 

func (r DetailGetRequest) Encode() string

Encode implement GetRequest interface

type DetailGetResponse added in v1.8.17 

type DetailGetResponse struct {
	model.BaseResponse
	// Data json返回值
	Data *CreativeDetailV2 `json:"data,omitempty"`
}

DetailGetResponse 创意详细信息(新)API Response

type Error added in v1.5.0 

type Error struct {
	// Code 返回码
	Code int `json:"code,omitempty"`
	// Message 返回信息
	Message string `json:"message,omitempty"`
}

Error 错误信息

type GameInfo added in v1.5.0 

type GameInfo struct {
	// ID 云游戏id，对应【获取云游戏试玩素材列表】中的game_id字段
	ID string `json:"id,omitempty"`
	// Orientation 云游戏素材方向，允许值: VERTICAL竖屏，HORIZONTAL横屏
	Orientation string `json:"orientation,omitempty"`
}

GameInfo 云游戏信息

type GetFiltering 

type GetFiltering struct {
	// CampaignID 按照campaign_id过滤
	CampaignID uint64 `json:"campaign_id,omitempty"`
	// AdID 按照ad_id过滤
	AdID uint64 `json:"ad_id,omitempty"`
	// CreativeIDs 按照creative_id过滤，最多传100个。创意ID需属于当前广告主，否则会报错
	CreativeIDs []uint64 `json:"creative_ids,omitempty"`
	// LandingType 按照广告组推广目的过滤
	LandingType enum.LandingType `json:"landing_type,omitempty"`
	// Pricing 按照广告计划出价方式过滤
	Pricing enum.PricingType `json:"pricing,omitempty"`
	// Status 按照创意状态过滤，默认为返回“所有不包含已删除”，如果要返回所有包含已删除有对应枚举表示
	Status enum.CreativeStatus `json:"status,omitempty"`
	// ImageMode 按照创意素材类型过滤
	ImageMode enum.ImageMode `json:"image_mode,omitempty"`
	// CreativeCreateTime 广告创意创建时间，格式yyyy-MM-dd，表示过滤出当天创建的广告创意
	CreativeCreateTime string `json:"creative_create_time,omitempty"`
	// CreativeModifyTime 广告创意更新时间，格式yyyy-MM-dd，表示过滤出当天更新的广告创意
	CreativeModifyTime string `json:"creative_modify_time,omitempty"`
}

GetFiltering 过滤条件

type GetRequest 

type GetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Filtering 过滤条件
	Filtering *GetFiltering `json:"filtering,omitempty"`
	// Fields 查询字段集合, 如果指定, 则返回结果数组中, 每个元素是包含所查询字段的字典，默认全部指定
	// 允许值: "creative_id", "ad_id", "advertiser_id", "status","opt_status", "image_mode", "title", "creative_word_ids","third_party_id", "image_ids", "image_id", "video_id","materials"
	Fields []string `json:"fields,omitempty"`
	// Page 页数默认值: 1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小默认值: 10，大小上限1000
	PageSize int `json:"page_size,omitempty"`
	// Cursor 页码游标值，第一次拉取，传入0
	// 同时传入时，cursor优先级大于page
	// 注：page+page_size与cursor+count为两种分页方式
	// cursor+count适用于获取数据记录数≥10000的场景
	Cursor int `json:"cursor,omitempt"`
	// Count 页面数据量
	// 注：page+page_size与cursor+count为两种分页方式
	// cursor+count适用于获取数据记录数≥10000的场景
	Count int `json:"count,omitempty"`
}

GetRequest 获取创意列表 API Request

func (GetRequest) Encode 

func (r GetRequest) Encode() string

Encode implement GetRequest interface

type GetResponse 

type GetResponse struct {
	model.BaseResponse
	// Data json返回值
	Data *GetResponseData `json:"data,omitempty"`
}

GetResponse 获取创意列表 API Response

type GetResponseData 

type GetResponseData struct {
	// List Creative数组
	List []Creative `json:"list,omitempty"`
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
}

GetResponseData json返回值

type ImageInfo added in v1.5.0 

type ImageInfo struct {
	// ImageMode 素材类型，必填，注意：程序化创意不支持组图 CREATIVE_IMAGE_MODE_GROUP，其他类型图片都支持，如横版/竖版大图、小图。详见【附录-素材类型】
	ImageMode enum.ImageMode `json:"image_mode,omitempty"`
	// ImageID 图片ID，image_mode为图片素材时填写 可通过【获取图片素材】接口获得
	ImageID string `json:"image_id,omitempty"`
	// VideoID 视频ID，视频素材时填写。可通过【获取视频素材】接口获得
	VideoID string `json:"video_id,omitempty"`
	// ImageIDs 图片ID列表，非视频素材时填写。图片ID和视频ID可通过【获取图片素材】接口获得。组图类型传3张图，其他图片类型传1张，否则会报错。图片大小不能超过1.5M
	ImageIDs []string `json:"image_ids,omitempty"`
	// TemplateIDs 模版ID列表
	TemplateIDs []uint64 `json:"template_ids,omitempty"`
	// TemplateID DPA模板ID，针对DPA广告，且对应的素材类型是大图、小图、组图。可通过【获取DPA模板】接口查询模版ID
	TemplateID uint64 `json:"template_id,omitempty"`
	// TemplateDataList 模版自定义参数
	TemplateDataList []TemplateData `json:"template_data_list,omitempty"`
	// Name 图片描述，搜索创意素材类型为橱窗素材时可传入，长度限制4-6字，两个英文字符占1位。
	Name string `json:"name,omitempty"`
}

ImageInfo 图片素材信息

type ImageInfoWrapper added in v1.9.10 

type ImageInfoWrapper struct {
	Object *ImageInfo
	List   []ImageInfo
}

ImageInfoWrapper image_info wrapper image_info 可能为slice也可能为object

func (*ImageInfoWrapper) IsObject added in v1.9.10 

func (i *ImageInfoWrapper) IsObject() bool

func (*ImageInfoWrapper) MarshalJSON added in v1.9.10 

func (i *ImageInfoWrapper) MarshalJSON() ([]byte, error)

MmarshalJSON implement json Marshal interface

func (*ImageInfoWrapper) UnmarshalJSON added in v1.9.10 

func (i *ImageInfoWrapper) UnmarshalJSON(b []byte) (err error)

UnmarshalJSON implement json Unmarshal interface

type ImageMaterial added in v1.5.0 

type ImageMaterial struct {
	// ImageMode 素材类型，必填，注意：程序化创意不支持组图 CREATIVE_IMAGE_MODE_GROUP，其他类型图片都支持，如横版/竖版大图、小图。详见【附录-素材类型】
	ImageMode enum.ImageMode `json:"image_mode,omitempty"`
	// ImageInfo 图片素材信息
	ImageInfo *ImageInfoWrapper `json:"image_info,omitempty"`
	// TemplateImage 图片模版信息，创建DPA创意时可传入,选择模板后image_info传入内容无效
	TemplateImage *TemplateImage `json:"template_image,omitempty"`
}

ImageMaterial 创意图片素材

type InteractiveMaterial added in v1.9.6 

type InteractiveMaterial struct {
	// PlayableID 直出互动素材id
	PlayableID uint64 `json:"playable_id,omitempty"`
}

InteractiveMaterial 直出互动素材信息

type Material 

type Material struct {
	// ID 创意ID
	ID model.Uint64 `json:"id,omitempty"`
	// AdID 广告计划ID
	AdID model.Uint64 `json:"ad_id,omitempty"`
	// AdvertiserID 广告主ID
	AdvertiserID model.Uint64 `json:"advertiser_id,omitempty"`
	// Title 创意素材标题
	Title string `json:"title,omitempty"`
	// Status 创意状态
	Status enum.CreativeStatus `json:"status,omitempty"`
	// OptStatus 创意操作状态
	OptStatus enum.CreativeOptStatus `json:"op_status,omitempty"`
	// ImageMode 创意类型
	ImageMode enum.ImageMode `json:"image_mode,omitempty"`
	// ImageInfo 图片素材信息
	ImageInfo []struct {
		// Url 图片链接
		Url string `json:"url,omitempty"`
		// Width 图片宽度
		Width int `json:"width,omitempty"`
		// Height 图片高度
		Height int `json:"height,omitempty"`
	} `json:"image_info,omitempty"`
	// ImageID 视频素材封面
	ImageID string `json:"image_id,omitempty"`
	// VideoID 视频ID
	VideoID string `json:"video_id,omitempty"`
}

Material 素材信息

type MaterialReadRequest 

type MaterialReadRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CreativeIDs 创意ID集合，支持最大长度为100。创意ID需属于当前广告主，否则会报错
	CreativeIDs []uint64 `json:"creative_ids,omitempty"`
	// Fields 查询字段集合, 默认查询所有字段。详见下方response字段定义; 允许值: "id", "ad_id", "advertiser_id", "title", "image_info","image_mode", "opt_status"
	Fields []string `json:"fields,omitempty"`
}

MaterialReadRequest 创意素材信息

func (MaterialReadRequest) Encode 

func (r MaterialReadRequest) Encode() string

Encode implement GetRequest interface

type MaterialReadResponse 

type MaterialReadResponse struct {
	model.BaseResponse
	// Data json返回值
	Data []Material `json:"data,omitempty"`
}

MaterialReadResponse 创意素材信息 API Response

type MaterialReject added in v1.6.9 

type MaterialReject struct {
	// MaterialType 素材类型。1-图片，2-标题，3-视频，4-副标题，5-头图，6-摘要
	MaterialType int `json:"material_type,omitempty"`
	// Title 标题
	Title string `json:"title,omitempty"`
	// ImageID 图片ID
	ImageID []string `json:"image_id,omitempty"`
	// VideoID 视频ID
	VideoID string `json:"video_id,omitempty"`
	// RejectReason 审核建议
	RejectReason string `json:"reject_reason,omitempty"`
}

MaterialReject 自定义创意类型的素材审核建议

type MiniProgramInfo added in v1.7.5 

type MiniProgramInfo struct {
	// AppID 小程序/小游戏id
	AppID string `json:"app_id,omitempty"`
	// StartPath 启动路径，小程序类型必传，小游戏类型不传值
	StartPath string `json:"start_path,omitempty"`
	// Params 页面监测参数
	Params string `json:"params,omitempty"`
	// Type 小程序类型，当使用 mini_program_info 时，该字段必填
	// 允许值：BYTE_GAME 小游戏、BYTE_APP 小程序
	Type enum.MiniProgramType `json:"type,omitempty"`
	// URL 字节小程序调起链接
	URL string `json:"url,omitempty"`
}

MiniProgramInfo 字节小程序信息

type PlayableInfo 

type PlayableInfo struct {
	// PlayableURL 试玩素材URL，可通过【获取试玩素材列表】进行获取。 只有穿山甲激励视频可以使用试玩素材，同时素材需要审核通过
	PlayableURL string `json:"playable_url,omitempty"`
	// PlayableUrlBasic 基础试玩素材url
	PlayableUrlBasic string `json:"playable_url_basic,omitempty"`
	// PlayableOrientation 基础试玩素材方向
	PlayableOrientation enum.PlayableOrientation `json:"playable_orientation,omitempty"`
	// PreviewUrl 基础试玩素材预览图
	PreviewUrl string `json:"preview_url,omitempty"`
}

PlayableInfo 试玩信息

type PlayableMaterial added in v1.5.0 

type PlayableMaterial struct {
	// PlayableInfo 试玩信息
	PlayableInfo PlayableInfo `json:"playable_info,omitempty"`
}

PlayableMaterial 基础试玩素材

type ProceduralCreativeCreateRequest added in v1.6.9 

type ProceduralCreativeCreateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdID 广告计划ID，计划ID要属于广告主ID，且非删除计划，否则会报错
	AdID uint64 `json:"ad_id,omitempty"`
	// Creative 程序化素材信息，投放位置和创意类型决定素材规格。
	Creative *CreativeInfo `json:"creative,omitempty"`
	// AdData 广告计划数据
	AdData *AdData `json:"ad_data,omitempty"`
}

ProceduralCreativeCreateRequest 创建程序化创意（营销链路） API Request

func (ProceduralCreativeCreateRequest) Encode added in v1.6.9 

func (r ProceduralCreativeCreateRequest) Encode() []byte

Encode implement PostRequest interface

type ProceduralCreativeUpdateRequest added in v1.6.9 

type ProceduralCreativeUpdateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdID 广告计划ID，计划ID要属于广告主ID，且非删除计划，否则会报错
	AdID uint64 `json:"ad_id,omitempty"`
	// Creative 程序化素材信息，投放位置和创意类型决定素材规格。
	Creative *CreativeInfo `json:"creative,omitempty"`
	// AdData 广告计划数据
	AdData *AdData `json:"ad_data,omitempty"`
}

ProceduralCreativeUpdateRequest 修改程序化创意（营销链路） API Request

func (ProceduralCreativeUpdateRequest) Encode added in v1.6.9 

func (r ProceduralCreativeUpdateRequest) Encode() []byte

Encode implement PostRequest interface

type PromotionCard 

type PromotionCard struct {
	// EnableStorePack 是否使用门店包，true为使用，false为不使用，推广目的非门店推广时会忽略该字段。若选择使用，则卡片标题为最近门店名称
	EnableStorePack bool `json:"enable_store_pack,omitempty"`
	// ProductSellingPoints 商品卖点，对应广告投放平台的推荐卖点
	ProductSellingPoints []string `json:"product_selling_points,omitempty"`
	// ProductDescription 商品描述
	ProductDescription string `json:"product_description,omitempty"`
	// CallToAction 行动号召
	CallToAction string `json:"call_to_action,omitempty"`
	// EnablePersonalAction 是否使用智能优选，true为使用，false为不使用
	EnablePersonalAction bool `json:"enable_personal_action,omitempty"`
	// ProductImageID 商品图片ID，对应广告投放平台的推广卡片主图
	ProductImageID string `json:"product_image_id,omitempty"`
}

PromotionCard 商品推广卡片

type ReadRequest 

type ReadRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdID 计划ID
	AdID uint64 `json:"ad_id,omitempty"`
}

ReadRequest 创意详细信息API Request

func (ReadRequest) Encode 

func (r ReadRequest) Encode() string

Encode implement GetRequest interface

type ReadResponse 

type ReadResponse struct {
	model.BaseResponse
	// Data json返回值
	Data *CreativeDetail `json:"data,omitempty"`
}

ReadResponse 创意详细信息API Response

type RejectData added in v1.6.9 

type RejectData struct {
	// RejectItem 审核项
	RejectItem string `json:"reject_item,omitempty"`
	// RejectReasion 审核建议，审核中/审核通过创意也存在返回审核建议的情况
	RejectReason string `json:"reject_reason,omitempty"`
}

RejectData 审核建议

type RejectReason added in v1.6.9 

type RejectReason struct {
	// CreativeID 创意ID
	CreativeID uint64 `json:"creative_id,omitempty"`
	// RejectData 审核建议
	RejectData []RejectData `json:"reject_data,omitempty"`
	// MaterialReject 自定义创意类型的素材审核建议
	MaterialReject []MaterialReject `json:"material_reject,omitempty"`
}

RejectReason 审核建议

type RejectReasonRequest added in v1.6.9 

type RejectReasonRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CreativeIDs 广告创意ID，长度限制：1～10。创意ID需要属于当前广告主，否则会报错。只有审核不通过的创意才有审核建议，审核通过的创意没有审核建议。（所有的程序化创意都是审核通过的）
	CreativeIDs []uint64 `json:"creative_ids,omitempty"`
}

RejectReasonRequest 获取创意审核建议 API Request

func (RejectReasonRequest) Encode added in v1.6.9 

func (r RejectReasonRequest) Encode() string

Encode implement GetRequest interface

type RejectReasonResponse added in v1.6.9 

type RejectReasonResponse struct {
	model.BaseResponse
	// Data json 返回值
	Data struct {
		// List 审核建议数据
		List []RejectReason `json:"list,omitempty"`
	} `json:"data,omitempty"`
}

RejectReasonResponse 获取创意审核建议 API Response

type StrategyListData added in v1.12.8 

type StrategyListData struct {
	// StrategyModels 策略列表
	StrategyModels []promotion.StrategyData `json:"strategy_models,omitempty"`
	// PageInfo 翻页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
}

type StrategyListRequest added in v1.12.8 

type StrategyListRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// StrategyTypes 策略类型(支持多选)
	StrategyTypes []enum.StrategyType `json:"strategy_type,omitempty"`
	// Page 页码，从1开始, 默认1
	Page int `json:"page,omitempty"`
	// PageSize 分页大小, 取值[1-100], 默认10
	PageSize int `json:"page_size,omitempty"`
}

StrategyListRequest 获取模板（白盒策略）列表 API Request

func (StrategyListRequest) Encode added in v1.12.8 

func (r StrategyListRequest) Encode() string

Encode implement GetRequest interface

type StrategyListResponse added in v1.12.8 

type StrategyListResponse struct {
	model.BaseResponse
	Data *StrategyListData `json:"data,omitempty"`
}

StrategyListResponse 获取模板（白盒策略）列表 API Response

type StructAbstractInfo added in v1.5.0 

type StructAbstractInfo struct {
	// AbstractLabel 摘要标签,单个标签限2-4字，标签需文本不同。使用标签摘要(struct_abstract_info)时必填
	AbstractLabel string `json:"abstract_label,omitempty"`
	// AbstractText 摘要内容,内容限2-10字。使用标签摘要(struct_abstract_info)时必填
	AbstractText string `json:"abstract_text,omitempty"`
}

StructAbstractInfo 标签摘要信息

type Supplement 

type Supplement struct {
	// GameID 云游戏id
	GameID string `json:"game_id,omitempty"`
	// Orientation 云游戏横竖屏，"VERTICAL"竖屏, "HORIZONTAL"横屏
	Orientation string `json:"orientation,omitempty"`
}

Supplement 云游戏素材

type SupplementInfo added in v1.5.0 

type SupplementInfo struct {
	// SupplementType 云游戏类型，允许值: CLOUD_GAME
	SupplementType string `json:"supplement_type,omitempty"`
	// Game 云游戏信息, 最多只允许填入一个
	Games []GameInfo `json:"games,omitempty"`
}

SupplementInfo 云游戏列表

type TemplateData added in v1.5.0 

type TemplateData struct {
	// BackgroundImageID 自定义背景图片ID，图片尺寸必须与模版背景图尺寸一致。图片ID可通过【获取图片素材】接口获得
	BackgroundImageID string `json:"background_image_id,omitempty"`
}

TemplateData 模版自定义参数

type TemplateImage added in v1.5.0 

type TemplateImage struct {
	// TemplateID 图片素材类型-DPA模板ID，针对DPA广告，且对应的素材类型是大图、小图、组图。可通过【获取DPA模板】接口查询模版ID
	TemplateID uint64 `json:"template_id,omitempty"`
	// TemplateDataList 模版自定义参数
	TemplateDataList []TemplateData `json:"template_data_list,omitempty"`
}

TemplateImage 图片模版信息

type TextAbstractInfo added in v1.5.0 

type TextAbstractInfo struct {
	// AbstractText 文本摘要内容,长度限制为25-45个字, 两个英文字符占1位。使用文本摘要(text_abstract_info)时必填; 如果要使用动态词包，格式如下：“XXX{词包名}XXX{词包名}XXX”，请注意当您使用动态词包需在下方 word_list 字段中按顺序传入词包ID，并且在一个文本摘要内容中最多使用两个动态词包。如果要使用搜索关键词，格式如下：“XXX{#关键词#}XXX”，请注意当您使用关键词需在下方 bidword_list 字段中传入关键词，并且在一个文本摘要内容中最多使用一个关键词
	AbstractText string `json:"abstract_text,omitempty"`
	// BidwordList 搜索关键词列表
	BidwordList []WordListItem `json:"bidword_list,omitempty"`
	// WordList 动态词包ID，可使用 【查询动态词包接口】 获得，结合文本摘要内容中的词包格式您需要填写相同个数与顺序的词包ID，如果实际ID顺序与文本摘要内容中词包名顺序不一致我们将以词包ID顺序为准。
	WordList []WordListItem `json:"word_list,omitempty"`
	// CreativeWordIDs 动态词包ID
	CreativeWordIDs []WordListItem `json:"creative_word_ids,omitempty"`
}

TextAbstractInfo 文本摘要信息

type TitleMaterial added in v1.5.0 

type TitleMaterial struct {
	// Title 创意标题，如果要使用动态词包，格式：“XXX{词包名}XXX{词包名}XXX”。请注意当您使用动态词包时，需在word_list字段中按顺序传入词包ID，并且在一个标题中最多使用两个动态词包。长度为5-30个字, 两个英文字符占1位。
	Title string `json:"title,omitempty"`
	// SubTitle APP 副标题素材。仅推广目标为APP，4到24个字符，填写Android下载链接时可设置,每个创意下只需传入一个副标题
	SubTitle string `json:"sub_title,omitempty"`
	// WordList 动态词包ID，可使用 【查询动态词包接口】 获得，结合标题中的词包格式您需要填写相同个数与顺序的词包ID，如果实际ID顺序与标题中词包名顺序不一致我们将以词包ID顺序为准。
	WordList []WordListItem `json:"word_list,omitempty"`
	// DpaWordList 创建DPA创意时可以选择传入DPA词包ID列表，动态词包与DPA词包总数最多为2。可通过【获取DPA词包】接口获取，结合标题中的词包格式您需要填写相同个数与顺序的词包ID，如果实际ID顺序与标题中词包名顺序不一致我们将以词包ID顺序为准
	DpaWordList []WordListItem `json:"dpa_word_list,omitempty"`
	// BidwordList 搜索关键词列表，创建搜索广告创意时选择传入，对应title格式如下：“XXX{#关键词#}XXX”
	BidwordList []WordListItem `json:"bidword_list,omitempty"`
	// CreativeWordIDs 动态词包ID，最多支持两个词包。可使用【查询动态创意词包】获得，结合标题中的词包格式您需要填写相同个数与顺序的词包ID，如果实际ID顺序与标题中词包名顺序不一致我们将以词包ID顺序为准
	CreativeWordIDs []uint64 `json:"creative_word_ids,omitempty"`
	// DpaDictIDs DPA词包ID列表，动态词包与DPA词包总数最多为2。可通过【获取DPA词包】接口获取，结合标题中的词包格式您需要填写相同个数与顺序的词包ID，如果实际ID顺序与标题中词包名顺序不一致我们将以词包ID顺序为准
	DpaDictIDs []uint64 `json:"dpa_dict_ids,omitempty"`
}

TitleMaterial 标题素材

type UpdateError added in v1.5.0 

type UpdateError struct {
	// CreativeID 更新失败的创意ID
	CreativeID uint64 `json:"creative_id,omitempty"`
	// ErrorMessage 更新失败的原因
	ErrorMessage string `json:"error_message,omitempty"`
}

UpdateError 更新失败信息

type UpdateRequest added in v1.6.1 

type UpdateRequest struct {
	CreativeDetail
}

UpdateRequest 修改创意信息 API Request

func (UpdateRequest) Encode added in v1.6.1 

func (r UpdateRequest) Encode() []byte

Encode implement PostRequest interface

type UpdateResponse added in v1.5.0 

type UpdateResponse struct {
	model.BaseResponse
	// Data json 返回值
	Data *UpdateResponseData `json:"data,omitempty"`
}

UpdateResponse 更新创意 API Response

type UpdateResponseData added in v1.5.0 

type UpdateResponseData struct {
	// Success 更新状态成功的创意ID列表
	Success []uint64 `json:"success,omitempty"`
	// Errors 更新失败的创意列表
	Errors []UpdateError `json:"errors,omitempty"`
}

UpdateResponseData json 返回值

type UpdateStatusRequest added in v1.5.0 

type UpdateStatusRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CreativeIDs 创意ID列表，长度限制1～100
	CreativeIDs []uint64 `json:"creative_ids,omitempty"`
	// OptStatus 操作, "enable"表示启用, "delete"表示删除, "disable"表示暂停；允许值: "enable", "delete", "disable",; 对于删除的广告组不可进行任何操作，否则会报错哈
	OptStatus string `json:"opt_status,omitempty"`
}

UpdateStatusRequest 更新创意状态 API Request

func (UpdateStatusRequest) Encode added in v1.5.0 

func (r UpdateStatusRequest) Encode() []byte

Encode implement PostRequest interface

type VideoInfo added in v1.5.0 

type VideoInfo struct {
	// VideoID 视频ID，image_mode为视频素材时填写 可通过【获取视频素材】接口获得
	VideoID string `json:"video_id,omitempty"`
}

VideoInfo 视频素材信息

type VideoMaterial added in v1.5.0 

type VideoMaterial struct {
	// ImageMode 素材类型，必填，注意：程序化创意不支持组图 CREATIVE_IMAGE_MODE_GROUP，其他类型图片都支持，如横版/竖版大图、小图。详见【附录-素材类型】
	ImageMode enum.ImageMode `json:"image_mode,omitempty"`
	// ImageInfo 视频封面图片，传1张
	ImageInfo *ImageInfo `json:"image_info,omitempty"`
	// VideoInfo 视频素材信息
	VideoInfo *VideoInfo `json:"video_info,omitempty"`
	// AwemeItemID 抖音短视频ID
	AwemeItemID uint64 `json:"aweme_item_id,omitempty"`
	// DpaVideoTemplateType 商品库视频生成类型，创建DPA创意时可传入，传入后该素材下image_info与video_info不生效
	DpaVideoTemplateType enum.DpaVideoTemplateType `json:"dpa_video_template_type,omitempty"`
	// DpaVideoTaskIDs 自定义商品库视频模板ID，创建DPA创意时可传入，传入后该素材下image_info与video_info不生效，长度限制1，从【获取 DPA 商品库视频模板】接口中获取
	DpaVideoTaskIDs []string `json:"dpa_video_task_ids,omitempty"`
}

VideoMaterial 视频素材信息

type WordListItem added in v1.5.0 

type WordListItem struct {
	WordID      uint64 `json:"word_id,omitempty"`
	DefaultWord string `json:"default_word,omitempty"`
}

WordListItem 动态词包

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.