ad

package
v1.15.8 Latest Latest
Warning

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

 Go to latest Published: Jul 3, 2023 License: Apache-2.0 Imports: 10 Imported by: 1

Documentation

Overview

Package ad 广告计划

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types 

type Ad struct {
	// AdID 计划ID
	AdID uint64 `json:"ad_id,omitempty"`
	// CampaignID 广告组ID（若为托管计划，则返回null）
	CampaignID uint64 `json:"campaign_id,omitempty"`
	// MarketingGoal 营销目标
	MarketingGoal enum.MarketingGoal `json:"marketing_goal,omitempty"`
	// CampaignScene 营销场景
	CampaignScene qianchuan.CampaignScene `json:"campaign_scene,omitempty"`
	// MarketingScene 广告类型，FEED 通投广告，SEARCH 搜索广告
	MarketingScene qianchuan.MarketingScene `json:"marketing_scene,omitempty"`
	// PromotionWay 推广方式
	PromotionWay enum.PromotionWay `json:"promotion_way,omitempty"`
	// Name 计划名称
	Name string `json:"name,omitempty"`
	// Status 计划投放状态
	Status qianchuan.AdStatus `json:"status,omitempty"`
	// OptStatus 计划操作状态
	OptStatus qianchuan.AdOptStatus `json:"opt_status,omitempty"`
	// AdCreateTime 计划创建时间
	AdCreateTime string `json:"ad_create_time,omitempty"`
	// AdModifyTime 计划修改时间
	AdModityTime string `json:"ad_modity_time,omitempty"`
	// AwemeInfo 计划中关联的抖音号信息
	AwemeInfo []aweme.Aweme `json:"aweme_info,omitempty"`
	// ProductInfo 商品列表
	ProductInfo []product.Product `json:"product_info,omitempty"`
	// RoomInfo 直播间列表
	RoomInfo []live.Room `json:"room_info,omitempty"`
	// DeliverySetting 投放设置
	DeliverySetting *DeliverySetting `json:"delivery_setting,omitempty"`
	// Audience 定向设置
	Audience *Audience `json:"audience,omitempty"`
	// CreativeMaterialMode 创意呈现方式
	CreativeMaterialMode enum.CreativeMaterialMode `json:"creative_material_mode,omitempty"`
	// FirstIndustryID 创意一级行业ID
	FirstIndustryID uint64 `json:"first_industry_id,omitempty"`
	// SecondIndustryID 创意二级行业ID
	SecondIndustryID uint64 `json:"second_industry_id,omitempty"`
	// ThirdIndustryID 创意三级行业ID
	ThirdIndustryID uint64 `json:"third_industry_id,omitempty"`
	// AdKeywords 创意标签
	AdKeywords []string `json:"ad_keywords,omitempty"`
	// CreativeList 创意信息（若为托管计划，则返回空数组）
	CreativeList []creative.Creative `json:"creative_list,omitempty"`
	// ProgrammaticCreativeMediaList 程序化创意素材信息
	ProgrammaticCreativeMediaList []creative.ProgrammaticCreativeMedia `json:"programmatic_creative_media_list,omitempty"`
	// ProgrammaticCreativeTitleList 程序化创意标题信息
	ProgrammaticCreativeTitleList []creative.TitleMaterial `json:"programmatic_creative_title_list,omitempty"`
	// ProgrammaticCreativeCard 程序化创意推广卡片信息
	ProgrammaticCreativeCard []creative.ProgrammaticCreativeCard `json:"programmatic_creative_card,omitempty"`
	// CreativeAutoGenerate 是否开启「生成更多创意」
	CreativeAutoGenerate int `json:"creative_auto_generate,omitempty"`
	// IsHomepageHide 抖音主页是否隐藏视频
	IsHomepageHide int `json:"is_homepage_hide,omitempty"`
	// IsIntelligent 是否启用智选流量，0 关闭、1 开启
	IsIntelligent int `json:"is_intelligent,omitempty"`
	// DynamicCreative 是否启用动态创意，0 关闭、1 开启
	DynamicCreative int `json:"dynamic_creative,omitempty"`
	// Keywords 搜索关键词列表
	Keywords []Keyword `json:"keyword,omitempty"`
	// PrivateWords 搜索否定词
	PrivateWords *PrivateWords `json:"private_words,omitempty"`
	// LabAdType 推广方式，NOT_LAB_AD：非托管计划，LAB_AD：托管计划
	LabAdType enum.AdLabType `json:"lab_ad_type,omitempty"`
}

Ad 计划详情

type Audience 

type Audience struct {
	// AudienceMode 人群定向模式，当promotion_way为 SIMPLE时返回，枚举值：AUTO智能推荐、CUSTOM自定义
	AudienceMode enum.AudienceMode `json:"audience_mode,omitempty"`
	// District 地域定向类型，配合city字段使用，允许值：CITY：省市，COUNTY：区县，NONE：不限；默认值：NONE
	District enum.District `json:"district,omitempty"`
	// City 具体定向的城市列表，当 district 为COUNTY，city 为必填，枚举值详见【附件-city.json】；省市传法：city: [12]，district: CITY；区县的传法：city: [130102]，district: COUNTY
	City []uint64 `json:"city,omitempty"`
	// LocationType 地域定向的用户状态类型，当 district 为COUNTY，CITY为必填，允许值：CURRENT：正在该地区的用户，HOME：居住在该地区的用户，TRAVEL；到该地区旅行的用户，ALL：该地区内的所有用户
	LocationType enum.LocationType `json:"location_type,omitempty"`
	// ExcludeLimitRegion 排除限运地区，允许值：
	// 0：否，默认值
	// 1：是
	// 注意：
	// 1、仅同时满足以下条件时，设置为“1”才有效：- 地域定向类型为“不限”/地域定向的用户状态类型为“正在该地区的用户”
	// 2、当“可放开定向列表”为REGION且排除限运地区时，依旧会探索限运地区的目标人群
	ExcludeLimitRegion int `json:"exclude_limit_region,omitempty"`
	// Gender 允许值: GENDER_FEMALE：女性，GENDER_MALE：男性，NONE： 不限
	Gender enum.AudienceGender `json:"gender,omitempty"`
	// Age 年龄，详见【附录-受众年龄区间】；允许值：AGE_BETWEEN_18_23, AGE_BETWEEN_24_30, AGE_BETWEEN_31_40, AGE_BETWEEN_41_49, AGE_ABOVE_50
	Age enum.AudienceAge `json:"age,omitempty"`
	// AwemeFanBehaviors 抖音达人互动用户行为类型
	AwemeFanBehaviors []string `json:"aweme_fan_behaviors,omitempty"`
	// AwemeFanBehaviorDays 抖音达人互动用户行为天数
	AwemeFanBehaviorDays string `json:"aweme_fan_behavior_days,omitempty"`
	// AwemeFanCategories 抖音达人分类ID列表
	AwemeFanCategories []uint64 `json:"aweme_fan_categories,omitempty"`
	// AwemeFanAccounts 抖音达人ID列表
	AwemeFanAccounts []uint64 `json:"aweme_fan_accounts,omitempty"`
	// AutoExtendEnabled 是否启用智能放量
	AutoExtendEnabled *int `json:"auto_extend_enabled,omitempty"`
	// AutoExtendTargets 可放开定向列表
	AutoExtendTargets []qianchuan.AutoExtendTarget `json:"auto_extend_targets,omitempty"`
	// Platform 投放平台列表
	Platform []enum.AudiencePlatform `json:"platform,omitempty"`
	// SmartInterestAction 行为兴趣意向定向模式
	SmartInterestAction string `json:"smart_interest_action,omitempty"`
	// ActionScene 行为场景
	ActionScene []enum.ActionScene `json:"action_scene,omitempty"`
	// ActionDays 用户发生行为天数
	ActionDays int `json:"action_days,omitempty"`
	// ActionCategories 行为类目词
	ActionCategories []uint64 `json:"action_categories,omitempty"`
	// ActionWords 行为关键词
	ActionWords []uint64 `json:"action_words,omitempty"`
	// InterestCategories 兴趣类目词
	InterestCategories []uint64 `json:"interest_categories,omitempty"`
	// InterestWords 兴趣关键词
	InterestWords []uint64 `json:"interest_words,omitempty"`
	// Ac 网络类型
	Ac []string `json:"ac,omitempty"`
	// RetargetingTagsInclude 定向人群包id列表
	RetargetingTagsInclude []uint64 `json:"retargeting_tags_include,omitempty"`
	// RetargetingTagsExclude 排除人群包id列表
	RetargetingTagsExclude []uint64 `json:"retargeting_tags_exclude,omitempty"`
	// LivePlatformTags 直播带货平台精选人群包
	LivePlatformTags []enum.LivePlatformTag `json:"live_platform_tags,omitempty"`
}

Audience 定向设置

type CreateRequest 

type CreateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// MarketingGoal 营销目标
	MarketingGoal enum.MarketingGoal `json:"marketing_goal,omitempty"`
	// CampaignScene 营销场景 ，允许值：
	// DAILY_SALE日常销售
	CampaignScene qianchuan.CampaignScene `json:"campaign_scene,omitempty"`
	// MarketingScene 广告类型，允许值：
	// FEED 通投广告
	MarketingScene qianchuan.MarketingScene `json:"marketing_scene,omitempty"`
	// PromotionWary 推广方式
	PromotionWay enum.PromotionWay `json:"promotion_way,omitempty"`
	// Name 计划名称，长度为1-100个字符，其中1个汉字算2位字符。名称不可重复，否则会报错
	Name string `json:"name,omitempty"`
	// LabAdType 推广方式，允许值：
	// LAB_AD 托管
	LabAdType enum.AdLabType `json:"lad_ad_type,omitempty"`
	// CampaignID 千川广告组id
	CampaignID uint64 `json:"campaign_id,omitempty"`
	// AwemeID 抖音id，即商品广告背后关联的抖音号，可通过【查询可推广抖音号列表】接口获取名下可推广抖音号
	AwemeID uint64 `json:"aweme_id,omitempty"`
	// ProductIDs 商品id列表，即准备推广的商品列表，可通过【查询店铺商品列表】接口获取名下可推广商品; 目前仅支持推一个商品，但需以数组入参
	ProductIDs []uint64 `json:"product_ids,omitempty"`
	// DeliverySetting 投放设置
	DeliverySetting DeliverySetting `json:"delivery_setting,omitempty"`
	// Audience 人群定向
	Audience *Audience `json:"audience,omitempty"`
	// CreativeMaterialMode 创意呈现方式，和抖音号关系类型相关
	CreativeMaterialMode enum.CreativeMaterialMode `json:"creative_material_mode,omitempty"`
	// FirstIndustryID 创意一级行业ID
	FirstIndustryID uint64 `json:"first_industry_id,omitempty"`
	// SecondIndustryID 创意二级行业ID
	SecondIndustryID uint64 `json:"second_industry_id,omitempty"`
	// ThirdIndustryID 创意三级行业ID
	ThirdIndustryID uint64 `json:"third_industry_id,omitempty"`
	// AdKeywords 创意标签。最多20个标签，且每个标签长度要求为1~20个字符，汉字算2个字符
	AdKeywords []string `json:"ad_keywords,omitempty"`
	// CreativeList 自定义素材信息
	CreativeList []creative.Creative `json:"creative_list,omitempty"`
	// CreativeAutoGenerate是否开启「生成更多创意」，允许值：0 关闭（默认值）、1 开启
	CreativeAutoGenerate int `json:"creative_auto_generate,omitempty"`
	// IsHomepageHide 抖音主页是否隐藏视频，和抖音号关系类型相关，返回值参考【附录-抖音号授权类型】;bind_type为OFFICIAL或SELF时，允许值：1 隐藏、0 不隐藏（默认值）;bind_type不为OFFICIAL或SELF时，需传入唯一允许值0 不隐藏
	IsHomePageHide int `json:"is_homepage_hide,omitempty"`
	// ProgrammaticCreativeMadiaList 程序化创意素材信息，最多支持 9 个创意。当 creative_material_mode 不为 PROGRAMMATIC_CREATIVE 时，该字段不填数据；当 creative_material_mode 为 PROGRAMMATIC_CREATIVE 时，该字段必填;请至少添加一个视频类型素材
	ProgrammaticCreativeMadiaList []creative.ProgrammaticCreativeMedia `json:"programmatic_creative_media_list,omitempty"`
	// ProgrammaticCreativeTitleList 程序化创意标题信息，最多支持 10 个标题。当 creative_material_mode 不为 PROGRAMMATIC_CREATIVE 时，该字段不填数据；当 creative_material_mode 为 PROGRAMMATIC_CREATIVE 时，该字段必填; 请至少添加一个标题
	ProgrammaticCreativeTitleList []creative.TitleMaterial `json:"programmatic_creative_title_list,omitempty"`
	// ProgrammaticCreativeCard 程序化创意推广卡片信息。当 creative_material_mode 不为 PROGRAMMATIC_CREATIVE 时，该字段不填数据；当 creative_material_mode 为 PROGRAMMATIC_CREATIVE 时，该字段必填
	ProgrammaticCreativeCard *creative.ProgrammaticCreativeCard `json:"programmatic_creative_card,omitempty"`
}

CreateRequest 创建计划（含创意生成规则）

func (CreateRequest) Encode 

func (r CreateRequest) Encode() []byte

Encode implement PostRequest interface

type CreateResponse 

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

CreateResponse 创建计划（含创意生成规则）

type CreateResult added in v1.15.0 

type CreateResult struct {
	// AdID 创建的计划id
	AdID uint64 `json:"ad_id,omitempty"`
	// NoticeInfos 提示信息
	NoticeInfos []NoticeInfo `json:"notice_info,omitempty"`
}

type DeliverySetting 

type DeliverySetting struct {
	// SmartBidType 投放场景（出价方式）
	SmartBidType enum.SmartBidType `json:"smart_bid_type,omitempty"`
	// FlowControlMode 投放速度
	FlowControlMode enum.FlowControlMode `json:"flow_control_mode,omitempty"`
	// ExternalAction 转化目标
	ExternalAction qianchuan.ExternalAction `json:"external_action,omitempty"`
	// DeepExternalAction 深度转化目标
	DeepExternalAction qianchuan.ExternalAction `json:"deep_external_action,omitempty"`
	// DeepBidType 深度出价方式，允许值：MIN
	DeepBidType qianchuan.DeepBidType `json:"deep_bid_type,omitempty"`
	// RoiGoal 支付ROI目标，最多支持两位小数，0.01～100
	// 当external_action=AD_CONVERT_TYPE_SHOPPING且deep_external_action=AD_CONVERT_TYPE_LIVE_PAY_ROI且deep_bid_type=MIN时，必填
	// 注意：
	// 1、按展示付费(oCPM)，根据【保障规则】提供保障福利，请谨慎修改支付ROI目标和定向，以免失去保障资格。
	RoiGoal float64 `json:"roi_goal,omitempty"`
	// Budget 预算
	Budget float64 `json:"budget,omitempty"`
	// BudgetMode 预算类型
	BudgetMode enum.BudgetMode `json:"budget_mode,omitempty"`
	// CpaBid 转化出价
	CpaBid float64 `json:"cpa_bid,omitempty"`
	// VideoScheduleType 短视频投放日期选择方式
	VideoScheduleType enum.VideoScheduleType `json:"video_schedule_type,omitempty"`
	// LiveScheduleType 直播间投放时段选择方式
	LiveScheduleType enum.LiveScheduleType `json:"live_schedule_type,omitempty"`
	// StartTime 投放开始时间
	StartTime string `json:"start_time,omitempty"`
	// EndTime 投放结束时间
	EndTime string `json:"end_time,omitempty"`
	// ScheduleTime 投放时段，当 video_schedule_type 和 live_schedule_type为SCHEDULE_START_END和SCHEDULE_FROM_NOW时有值，格式是48*7位字符串，且都是0或1。也就是以半个小时为最小粒度，周一至周日每天分为48个区段，0为不投放，1为投放，不传、全传0、全传1均代表全时段投放。
	ScheduleTime string `json:"schedule_time,omitempty"`
	// ScheduleFixedRange 固定投放时长，当 live_schedule_type 为时有值；单位为秒，最小值为1800（0.5小时），最大值为48*1800（24小时）SCHEDULE_TIME_FIXEDRANGE
	ScheduleFixedRange int64 `json:"schedule_fixed_range,omitempty"`
}

DeliverySetting 投放设置

type DetailGetRequest 

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 

func (r DetailGetRequest) Encode() string

Encode implement GetRequest interface

type DetailGetResponse 

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

DetailGetResponse 获取计划详情（含创意信息） API Response

type GetFiltering 

type GetFiltering struct {
	// IDs 按计划ID过滤，list长度限制 1-100
	IDs []uint64 `json:"ids,omitempty"`
	// AdName 按计划名称过滤，长度为1-30个字符
	AdName string `json:"ad_name,omitempty"`
	// Status 按计划状态过滤，不传入即默认返回“所有不包含已删除”，其他规则详见【附录-广告计划查询状态】
	Status qianchuan.AdStatusForSearch `json:"status,omitempty"`
	// CampaignScene 按营销场景过滤，允许值：DAILY_SALE日常销售（默认）
	CampaignScene qianchuan.CampaignScene `json:"campaign_scene,omitempty"`
	// MarketingScene 按广告类型过滤，允许值：ALL 全部，FEED 通投广告，SEARCH 搜索广告，默认为FEED
	MarketingScene qianchuan.MarketingScene `json:"marketing_scene,omitempty"`
	// PromotionWay 按推广方式过滤，允许值：STANDARD专业推广、SIMPLE极速推广
	PromotionWay enum.PromotionWay `json:"promotion_way,omitempty"`
	// MarketingGoal 广告组营销目标，允许值：VIDEO_PROM_GOODS：短视频带货、LIVE_PROM_GOODS：直播带货
	MarketingGoal enum.MarketingGoal `json:"marketing_goal,omitempty"`
	// CampaignID 按广告组ID过滤
	CampaignID uint64 `json:"campaign_id,omitempty"`
	// AdCreateStartDate 计划创建开始时间，格式："yyyy-mm-dd"
	AdCreateStartDate string `json:"ad_create_start_date,omitempty"`
	// AdCreateEndDate 计划创建结束时间，与ad_create_start_date搭配使用，格式："yyyy-mm-dd"，时间跨度不能超过180天
	AdCreateEndDate string `json:"ad_create_end_date,omitempty"`
	// AdModifyTime 计划修改时间，精确到小时，格式："yyyy-mm-dd HH"
	AdModifyTime string `json:"ad_modify_time,omitempty"`
	// AwemeID 根据抖音号过滤
	AwemeID uint64 `json:"aweme_id,omitempty"`
	// AutoManageFilter 按是否为托管计划过滤，允许值：ALL ：不限，AUTO_MANAGE ：托管计划，NORMAL ：非托管计划，默认为ALL
	AutoManageFilter string `json:"auto_manage_filter,omitempty"`
}

GetFiltering 过滤条件

type GetRequest 

type GetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// RequestAwemeInfo 是否包含抖音号信息，允许值：0：不包含；1：包含；默认不返回
	RequestAwemeInfo int `json:"request_aweme_info,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"`
	// FailList 获取失败的计划id列表
	FailList []uint64 `json:"fail_list,omitempty"`
	// List 计划列表
	List []Ad `json:"list,omitempty"`
}

GetResponseData json返回值

type Keyword added in v1.15.0 

type Keyword struct {
	// ID 关键词id
	ID uint64 `json:"id,omitempty"`
	// WordID 词id，不同计划下如果关键词字面相同，词id会相同
	WordID uint64 `json:"word_id,omitempty"`
	// Word 关键词字面
	Word string `json:"word,omitempty"`
	// Status 关键词状态
	// CONFIRM 审核通过且可代入
	// REJECT 审核拒绝
	// AUDIT 新建审核中
	// DELETE 已删除
	// PAUSED 词暂停
	Status qianchuan.KeywordStatus `json:"status,omitempty"`
	// MatchType 匹配类型，PHRASE 短语匹配、EXTENSIVE 广泛匹配、PRECISION 精准匹配
	MatchType enum.KeywordMatchType `json:"match_type,omitempty"`
}

Keyword 搜索关键词

type NoticeInfo added in v1.15.0 

type NoticeInfo struct {
	// Code 提示错误码
	Code int `json:"code,omitempty"`
	// Message 提示错误信息
	Message string `json:"message,omitempty"`
	// SearchKeywordError 搜索关键词错误列表，仅marketing_scene=SEARCH 情况下会返回该信息
	SearchKeywordError []SearchKeywordError `json:"search_keyword_error,omitempty"`
}

NoticeInfo 提示信息

type PrivateWords added in v1.15.0 

type PrivateWords struct {
	// PhraseWords 短语否定词列表
	PhraseWords []string `json:"phrase_words,omitempty"`
	// PreciseWords 精确否定词列表
	PreciseWords []string `json:"precise_words,omitempty"`
}

PrivateWords 搜索否定词

type RejectReasonList 

type RejectReasonList struct {
	// AdID 广告计划id
	AdID uint64 `json:"ad_id,omitempty"`
	// AuditRecords 审核详细内容
	AuditRecords []creative.AuditRecord `json:"audit_records,omitempty"`
}

RejectReasonList 审核详细信息

type RejectReasonRequest 

type RejectReasonRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdIDs 查询审核意见的的计划id
	AdIDs []uint64 `json:"ad_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 SearchKeywordError added in v1.15.0 

type SearchKeywordError struct {
	// SearchKeyword 错误的搜索关键词
	SearchKeyword string `json:"search_keyword,omitempty"`
	// ErrorMessage 错误的原因
	ErrorMessage string `json:"error_message,omitempty"`
}

SearchKeywordError 搜索关键词错误

type UpdateBidRequest 

type UpdateBidRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Data 更新计划出价的列表，最多支持10个
	Data []UpdateBidRequestData `json:"data,omitempty"`
}

UpdateBidRequest 更新计划出价 API Request

func (UpdateBidRequest) Encode 

func (r UpdateBidRequest) Encode() []byte

Encode implement PostRequest interface

type UpdateBidRequestData 

type UpdateBidRequestData struct {
	// AdID 广告计划id
	AdID uint64 `json:"ad_id,omitempty"`
	// Bid 计划更新之后的出价，最多只有两位小数
	Bid float64 `json:"bid,omitempty"`
}

UpdateBidRequestData 更新预算的计划id和出价

type UpdateBudgetRequest 

type UpdateBudgetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Data 更新预算的计划id和预算价格列表，最多支持10个
	Data []UpdateBudgetRequestData `json:"data,omitempty"`
}

UpdateBudgetRequest 更新计划预算 API Request

func (UpdateBudgetRequest) Encode 

func (r UpdateBudgetRequest) Encode() []byte

Encode implement PostRequest interface

type UpdateBudgetRequestData 

type UpdateBudgetRequestData struct {
	// AdID 广告计划id
	AdID uint64 `json:"ad_id,omitempty"`
	// Budget 更新后的预算，最多只有两位小数
	Budget float64 `json:"budget,omitempty"`
}

UpdateBudgetRequestData 更新预算的计划id和预算价格

type UpdateError 

type UpdateError struct {
	// ObjectID 错误对象id
	ObjectID uint64 `json:"object_id,omitempty"`
	// ObjectType 错误对象类型，返回值：AD 计划，CREATIVE 创意
	ObjectType string `json:"object_type,omitempty"`
	// OptType 操作类型，返回值：UPDATE 更新，ADD 新建
	OptType string `json:"opt_type,omitempty"`
	// AdID 更新失败的计划id
	AdID uint64 `json:"ad_id,omitempty"`
	// ErrorCode 错误码
	ErrorCode int `json:"error_code,omitempty"`
	// ErrorMessage 错误信息
	ErrorMessage string `json:"error_message,omitempty"`
}

UpdateError 更新失败错误

type UpdateRequest 

type UpdateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdID 待修改的广告计划id
	AdID uint64 `json:"ad_id,omitempty"`
	// Name 计划名称，长度为1-100个字符，其中1个汉字算2位字符。需要注意：计划名称不修改的话，可不填。填入的话，需与原计划名不同，否则报错
	Name string `json:"name,omitempty"`
	// DeliverySetting 投放设置
	DeliverySetting *DeliverySetting `json:"delivery_setting,omitempty"`
	// Audience 人群定向
	Audience *Audience `json:"audience,omitempty"`
	// CreativeMaterialMode 创意呈现方式，和抖音号关系类型相关
	CreativeMaterialMode enum.CreativeMaterialMode `json:"creative_material_mode,omitempty"`
	// FirstIndustryID 创意一级行业ID
	FirstIndustryID uint64 `json:"first_industry_id,omitempty"`
	// SecondIndustryID 创意二级行业ID
	SecondIndustryID uint64 `json:"second_industry_id,omitempty"`
	// ThirdIndustryID 创意三级行业ID
	ThirdIndustryID uint64 `json:"third_industry_id,omitempty"`
	// AdKeywords 创意标签。最多20个标签，且每个标签长度要求为1~20个字符，汉字算2个字符
	AdKeywords []string `json:"ad_keywords,omitempty"`
	// CreativeList 自定义素材信息
	CreativeList []creative.Creative `json:"creative_list,omitempty"`
	// CreativeAutoGenerate是否开启「生成更多创意」，允许值：0 关闭（默认值）、1 开启
	CreativeAutoGenerate *int `json:"creative_auto_generate,omitempty"`
	// IsHomepageHide 抖音主页是否隐藏视频，和抖音号关系类型相关，返回值参考【附录-抖音号授权类型】;bind_type为OFFICIAL或SELF时，允许值：1 隐藏、0 不隐藏（默认值）;bind_type不为OFFICIAL或SELF时，需传入唯一允许值0 不隐藏
	IsHomePageHide *int `json:"is_homepage_hide,omitempty"`
	// ProgrammaticCreativeMadiaList 程序化创意素材信息，最多支持 9 个创意。当 creative_material_mode 不为 PROGRAMMATIC_CREATIVE 时，该字段不填数据；当 creative_material_mode 为 PROGRAMMATIC_CREATIVE 时，该字段必填;请至少添加一个视频类型素材
	ProgrammaticCreativeMadiaList []creative.ProgrammaticCreativeMedia `json:"programmatic_creative_media_list,omitempty"`
	// ProgrammaticCreativeTitleList 程序化创意标题信息，最多支持 10 个标题。当 creative_material_mode 不为 PROGRAMMATIC_CREATIVE 时，该字段不填数据；当 creative_material_mode 为 PROGRAMMATIC_CREATIVE 时，该字段必填; 请至少添加一个标题
	ProgrammaticCreativeTitleList []creative.TitleMaterial `json:"programmatic_creative_title_list,omitempty"`
	// ProgrammaticCreativeCard 程序化创意推广卡片信息。当 creative_material_mode 不为 PROGRAMMATIC_CREATIVE 时，该字段不填数据；当 creative_material_mode 为 PROGRAMMATIC_CREATIVE 时，该字段必填
	ProgrammaticCreativeCard *creative.ProgrammaticCreativeCard `json:"programmatic_creative_card,omitempty"`
}

UpdateRequest 更新计划（含创意生成规则）

func (UpdateRequest) Encode 

func (r UpdateRequest) Encode() []byte

Encode implement PostRequest interface

type UpdateResponse 

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

UpdateResponse 计划更新 API Response

type UpdateResponseData 

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

UpdateResponseData json返回值

type UpdateStatusRequest 

type UpdateStatusRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdIDs 需要更新的广告计划id，最多支持10个
	AdIDs []uint64 `json:"ad_ids,omitempty"`
	// OptStatus 批量更新的广告计划状态
	OptStatus qianchuan.AdOptStatus `json:"opt_status,omitempty"`
}

UpdateStatusRequest 更新计划状态 API Request

func (UpdateStatusRequest) Encode 

func (r UpdateStatusRequest) Encode() []byte

Encode implement PostRequest interface

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.