creative

Documentation

Overview

Package creative 广告创意

Index

• type AuditRecord
• type CarouselMaterial
• type Creative
• type DynamicWord
• type GetFiltering
• type GetRequest
  • func (r GetRequest) Encode() string
• type GetResponse
• type GetResponseData
• type ImageMaterial
• type ProgrammaticCreativeCard
• type ProgrammaticCreativeMedia
• type PromotionCardMaterial
• type RejectReasonList
• type RejectReasonRequest
  • func (r RejectReasonRequest) Encode() string
• type RejectReasonResponse
• type TitleMaterial
• type UpdateError
• type UpdateResponse
• type UpdateResponseData
• type UpdateStatusRequest
  • func (r UpdateStatusRequest) Encode() []byte
• type VideoMaterial

Types

type AuditRecord

type AuditRecord struct {
	// Desc 审核内容，即审核的内容类型，如 视频，图片，标题 等
	Desc string `json:"desc,omitempty"`
	// Content 拒绝内容（文字类型）
	Content string `json:"content,omitempty"`
	// ImageID 拒绝内容id（图片类型）
	ImageID uint64 `json:"image_id,omitempty"`
	// VideoID 拒绝内容id（视频类型）
	VideoID uint64 `json:"video_id,omitempty"`
	// AuditPlatform 审核来源类型，返回值：AD 广告审核、CONTENT 内容审核
	AuditPlatform string `json:"audit_platform,omitempty"`
	// RejectReason 拒绝原因，可能会有多条
	RejectReason []string `json:"reject_reason,omitempty"`
	// Suggestion 审核建议，可能会有多条
	Suggestion []string `json:"suggestion,omitempty"`
}

AuditRecord 审核详细内容

type CarouselMaterial

type CarouselMaterial struct {
	// ID 素材唯一标识
	ID uint64 `json:"id,omitempty"`
	// AwemeCarouselID 抖音图文id
	AwemeCarouselID uint64 `json:"aweme_carousel_id,omitempty"`
	// CarouselID 图文ID
	CarouselID uint64 `json:"carousel_id,omitempty"`
	// IsAutoGenerated 是否为派生创意标识，1：是，0：不是
	IsAutoGenerated int `json:"is_auto_generated,omitempty"`
	// Images 图片信息
	Images []struct {
		// URL 图片url
		URL string `json:"url,omitempty"`
	} `json:"iamges,omitempty"`
	// Audio 音频信息
	Audio []struct {
		// URL 音频url
		URL string `json:"url,omitempty"`
		// Description 图文描述信息
		Description string `json:"description,omitempty"`
	}
}

CarouselMaterial 图文信息

type Creative

type Creative struct {
	// AdID 计划ID
	AdID uint64 `json:"ad_id,omitempty"`
	// CreativeID 创意ID
	CreativeID uint64 `json:"creative_id,omitempty"`
	// CreativeMaterialMode 创意呈现方式，CUSTOM_CREATIVE: 自定义创意，PROGRAMMATIC_CREATIVE: 程序化创意
	CreativeMaterialMode enum.CreativeMaterialMode `json:"creative_material_mode,omitempty"`
	// Status 创意状态
	Status qianchuan.CreativeStatus `json:"status,omitempty"`
	// OptStatus 创意操作状态
	OptStatus qianchuan.CreativeOptStatus `json:"opt_status,omitempty"`
	// CreativeCreateTime 创意创建时间
	CreativeCreateTime string `json:"creative_create_time,omitempty"`
	// CreativeModifyTime 创意修改时间
	CreativeModifyTime string `json:"creative_modify_time,omitempty"`
	// ImageMode 素材类型，支持视频和图片
	ImageMode enum.MaterialMode `json:"image_mode,omitempty"`
	// VideoMaterial 视频素材
	VideoMaterial *VideoMaterial `json:"video_material,omitempty"`
	// ImageMaterial 图片素材
	ImageMaterial *ImageMaterial `json:"image_material,omitempty"`
	// TitleMaterial 标题素材
	TitleMaterial *TitleMaterial `json:"title_material,omitempty"`
	// CarouselMaterial 图文信息，对应image_mode=CAROUSEL
	CarouselMaterial *CarouselMaterial `json:"carousel_material,omitempty"`
	// LabAdType 托管计划类型，NOT_LAB_AD：非托管计划，LAB_AD：托管计划
	LabAdType enum.AdLabType `json:"ad_lab_type,omitempty"`
	// VideoMaterialList 视频素材列表
	VideoMaterialList []VideoMaterial `json:"video_material_list,omitempty"`
	// ImageMaterialList 图片素材列表
	ImageMaterialList []ImageMaterial `json:"image_material_list,omitempty"`
	// TitleMaterialList 标题素材列表
	TitleMaterialList []TitleMaterial `json:"title_material_list,omitempty"`
	// PromotionCardMaterial 推广卡片信息
	PromotionCardMaterial *PromotionCardMaterial `json:"promotion_card_material,omitempty"`
}

Creative 创意

type DynamicWord

type DynamicWord struct {
	// WordID 动态词包ID
	WordID uint64 `json:"word_id,omitempty"`
	// DictName 创意词包名称
	DictName string `json:"dict_name,omitempty"`
	// DefaultWord 创意词包默认词
	DefaultWord string `json:"default_word,omitempty"`
}

DynamicWord 动态词包对象

type GetFiltering

type GetFiltering struct {
	// AdIDs 按计划ID过滤，list长度限制 1-100
	AdIDs []uint64 `json:"ad_ids,omitempty"`
	// CreativeID 按创意ID过滤
	CreativeID uint64 `json:"creative_id,omitempty"`
	// CreativeMaterialMode 按创意呈现方式过滤，允许值：CUSTOM_CREATIVE 自定义创意、PROGRAMMATIC_CREATIVE 程序化创意
	CreativeMaterialMode enum.CreativeMaterialMode `json:"creative_material_mode,omitempty"`
	// AdName 按计划名称过滤，长度为1-30个字符
	AdName string `json:"ad_name,omitempty"`
	// Status 按创意状态过滤，不传入即默认返回“所有不包含已删除”，其他规则详见【附录-创意查询状态】
	Status qianchuan.CreativeStatusForSearch `json:"status,omitempty"`
	// MarketingGoal 广告组营销目标，允许值：VIDEO_PROM_GOODS：短视频带货、LIVE_PROM_GOODS：直播带货
	MarketingGoal enum.MarketingGoal `json:"marketing_goal,omitempty"`
	// CampaignID 按广告组ID过滤
	CampaignID uint64 `json:"campaign_id,omitempty"`
	// CreativeCreateStartDate 创意创建开始时间，格式："yyyy-mm-dd"
	CreativeCreateStartDate string `json:"creative_create_start_date,omitempty"`
	// CreativeCreateEndDate 创意创建结束时间，与ad_create_start_date搭配使用，格式："yyyy-mm-dd"，时间跨度不能超过180天
	CreativeCreateEndDate string `json:"creative_create_end_date,omitempty"`
	// CreativeModifyTime 创意修改时间，精确到小时，格式："yyyy-mm-dd HH"
	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"`
	// Page 当前页码: 1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小 默认值: 10， 取值范围：1-1000
	PageSize int `json:"page_size,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 {
	// PageInfo 分页信息
	PageInfo model.PageInfo `json:"page_info,omitempty"`
	// List 计划列表
	List []Creative `json:"list,omitempty"`
}

GetResponseData json返回值

type ImageMaterial

type ImageMaterial struct {
	// ID 素材唯一标识
	ID uint64 `json:"id,omitempty"`
	// ImageIDs 图片ID列表
	ImageIDs []string `json:"image_ids,omitempty"`
	// ImageID 图片ID
	ImageID string `json:"image_id,omitempty"`
	// ImageMode 素材类型，见附录-枚举值
	ImageMode enum.MaterialMode `json:"image_mode,omitempty"`
	// IsAutoGenerate 是否为派生创意标识，1：是，0：不是
	IsAutoGenerate int `json:"is_auto_generate,omitempty"`
	// URL 图片预览url
	URL string `json:"url,omitempty"`
}

ImageMaterial 图片素材

type ProgrammaticCreativeCard

type ProgrammaticCreativeCard struct {
	// PromotionCardID 推广卡片ID
	PromotionCardID uint64 `json:"promotion_card_id,omitempty"`
	// ComponentID 组件ID
	ComponentID uint64 `json:"component_id,omitempty"`
	// Title 推广卡片标题
	Title string `json:"promotion_card_title,omitempty"`
	// SellingPoints 推广卡片卖点列表
	SellingPoints []string `json:"promotion_card_selling_points,omitempty"`
	// ImageID 推广卡片配图ID
	ImageID string `json:"promotion_card_image_id,omitempty"`
	// ActionButton 推广卡片行动号召按钮文案
	ActionButton string `json:"promotion_card_action_button,omitempty"`
	// ButtonSmartOptimization 智能优选行动号召按钮文案开关
	ButtonSmartOptimization int `json:"promotion_card_button_smart_optimization,omitempty"`
}

ProgrammaticCreativeCard 程序化创意推广卡片信息

type ProgrammaticCreativeMedia

type ProgrammaticCreativeMedia struct {
	// ImageMode 创意素材类型
	ImageMode enum.MaterialMode `json:"image_mode,omitempty"`
	// VideoID 视频ID
	VideoID string `json:"video_id,omitempty"`
	// VideoCoverID 视频封面ID
	VideoCoverID string `json:"video_cover_id,omitempty"`
	// AwemeItemID 抖音视频ID
	AwemeItemID string `json:"aweme_item_id,omitempty"`
	// AwemeCarouselID 抖音主页图文id
	AwemeCarouselID uint64 `json:"aweme_carousel_id,omitempty"`
	// CarouselID 素材库图文id
	CarouselID uint64 `json:"carousel_id,omitempty"`
	// ImageIDs 图片ID列表
	ImageIDs []string `json:"image_ids,omitempty"`
	// IsAutoGenerate 是否为派生创意标识，1：是，0：不是
	IsAutoGenerate int `json:"is_auto_generate,omitempty"`
	// URL 视频地址，仅限同主体进行素材预览查看，若非同主体会返回“素材所属主体与开发者主体不一致无法获取URL”，链接1小时过期
	URL string `json:"url,omitempty"`
	// VideoPosterURL 视频首帧截图，仅限同主体进行素材预览查看，若非同主体会返回“素材所属主体与开发者主体不一致无法获取URL”，链接1小时过期
	VideoPosterURL string `json:"video_poster_url,omitempty"`
	// IamgeURL 图片地址
	ImageURL string `json:"iamge_url,omitempty"`
	// CarouselImages 图片信息
	CarouselImages []struct {
		// URL 图片预览url
		URL string `json:"url,omitempty"`
	} `json:"carousel_iamges,omitempty"`
	// CarouselAudio 音频信息
	CarouselAudio []struct {
		// URL 音频url
		URL string `json:"url,omitempty"`
	} `json:"carousel_audio,omitempty"`
	// CarouselDescription 图文描述
	CarouselDescription string `json:"carousel_description,omitempty"`
}

ProgrammaticCreativeMedia 程序化创意素材信息

type PromotionCardMaterial

type PromotionCardMaterial struct {
	// ID 素材唯一标识
	ID uint64 `json:"id,omitempty"`
	// ComponentID 组件唯一标识
	ComponentID uint64 `json:"component_id,omitempty"`
	// Title 推广卡片标题
	Title string `json:"title,omitempty"`
	// SellingPoints 推广卡片卖点列表
	SellingPoints []string `json:"selling_points,omitempty"`
	// ImageID 推广卡片配图ID
	ImageID string `json:"image_id,omitempty"`
	// ActionButton 推广卡片行动号召按钮文案
	ActionButton string `json:"action_button,omitempty"`
	// ButtonSmartOptimization 智能优选行动号召按钮文案开关
	ButtonSmartOptimization *int `json:"button_smart_optimization,omitempty"`
}

PromotionCardMaterial 推广卡片信息

type RejectReasonList

type RejectReasonList struct {
	// 广告创意id
	CreativeID uint64 `json:"creative_id,omitempty"`
	// AuditRecords 审核详细内容
	AuditRecords []AuditRecord `json:"audit_records,omitempty"`
}

RejectReasonList 审核详细信息

type RejectReasonRequest

type RejectReasonRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CreativeIDs 查询审核意见的的创意id
	CreativeIDs []uint64 `json:"creative_ids,omitempty"`
}

RejectReasonRequest 获取创意审核建议 API Request

func (RejectReasonRequest) Encode

func (r RejectReasonRequest) Encode() string

Encode implement GetRequest interface

type RejectReasonResponse

type RejectReasonResponse struct {
	model.BaseResponse
	// Data json返回值
	Data struct {
		List []RejectReasonList `json:"list,omitempty"`
	} `json:"data,omitempty"`
}

RejectReasonResponse 获取创意审核建议 API Response

type TitleMaterial

type TitleMaterial struct {
	// ID 素材唯一标识
	ID uint64 `json:"id,omitempty"`
	// Title 创意标题
	Title string `json:"title,omitempty"`
	// TitleType 素材类型，可选值
	// CUSTOM自定义标题
	// COMMODITY_CARD商品卡标题
	// 注意：商品卡标题限制条件如下：
	// 广告主类型为商家
	// 抖音号选择的是「官方」或「自运营」
	TitleType qianchuan.TitleType `json:"title_type,omitempty"`
	// AwemeCarouselID 抖音主页图文id
	AwemeCarouselID uint64 `json:"aweme_carousel_id,omitempty"`
	// DynamicWords 动态词包对象列表
	DynamicWords []DynamicWord `json:"dynamic_words,omitempty"`
}

TitleMaterial 标题素材

type UpdateError

type UpdateError struct {
	// CreativeID 更新失败的创意id
	CreativeID uint64 `json:"creative_id,omitempty"`
	// ErrorMessage 错误信息
	ErrorMessage string `json:"error_message,omitempty"`
}

UpdateError 更新失败错误

type UpdateResponse

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

UpdateResponse 计划更新 API Response

type UpdateResponseData

type UpdateResponseData struct {
	// CreativeIDs 更新成功的创意id
	CreativeIDs []uint64 `json:"creative_ids,omitempty"`
	// Errors 更新失败的广告计划列表
	Errors []UpdateError `json:"errors,omitempty"`
}

UpdateResponseData json返回值

type UpdateStatusRequest

type UpdateStatusRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CreativeIDs 需要更新的广告创意id，一次最多更新10个创意
	CreativeIDs []uint64 `json:"creative_ids,omitempty"`
	// OptStatus 批量更新的广告计划状态
	OptStatus qianchuan.CreativeOptStatus `json:"opt_status,omitempty"`
}

UpdateStatusRequest 更新创意状态 API Request

func (UpdateStatusRequest) Encode

func (r UpdateStatusRequest) Encode() []byte

Encode implement PostRequest interface

type VideoMaterial

type VideoMaterial struct {
	// ID 素材唯一标识
	ID uint64 `json:"id,omitempty"`
	// VideoID 视频ID
	VideoID string `json:"video_id,omitempty"`
	// VideoCoverID 视频封面ID
	VideoCoverID string `json:"video_cover_id,omitempty"`
	// AwemeItemID 抖音视频ID
	AwemeItemID uint64 `json:"aweme_item_id,omitempty"`
	// ImageMode 素材类型，见附录-枚举值
	ImageMode enum.MaterialMode `json:"image_mode,omitempty"`
	// IsAutoGenerate 是否为派生创意标识，1：是，0：不是
	IsAutoGenerate int `json:"is_auto_generate,omitempty"`
	// URL 视频地址，仅限同主体进行素材预览查看，若非同主体会返回“素材所属主体与开发者主体不一致无法获取URL”，链接1小时过期
	URL string `json:"url,omitempty"`
	// PosterURL 视频首帧截图，仅限同主体进行素材预览查看，若非同主体会返回“素材所属主体与开发者主体不一致无法获取URL”，链接1小时过期
	PosterURL string `json:"poster_url,omitempty"`
}

VideoMaterial 视频素材