ad

package
v1.26.3 Latest Latest
Warning

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

 Go to latest Published: Aug 5, 2024 License: Apache-2.0 Imports: 12 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"`
	// ShopInfo 店铺信息
	ShopInfo *shop.Shop `json:"shop_info,omitempty"`
	// BrandInfo 品牌信息
	BrandInfo *brand.Brand `json:"brand_info,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 AdMaterialInfo added in v1.25.7 

type AdMaterialInfo struct {
	// MaterialDeliveryType 素材投放状态
	MaterialDeliveryType string `json:"material_delivery_type,omitempty"`
	// AuditStatus 审核状态 可选值:
	// PASS 审核通过
	// REJECT 审核拒绝
	// IN_PROGRESS 审核中
	AuditStatus string `json:"audit_status,omitempty"`
	// CreativeIDs 关联的创意id
	CreativeIDs []uint64 `json:"creative_ids,omitempty"`
	// IsDel 是否删除
	IsDel bool `json:"is_del,omitempty"`
	// IsAutoGenerate 是否派生
	IsAutoGenerate bool `json:"is_auto_generate,omitempty"`
}

AdMaterialInfo 素材信息

type Audience 

type Audience struct {
	// AudienceMode 人群定向模式，当promotion_way为 SIMPLE时返回，枚举值：AUTO智能推荐、CUSTOM自定义
	AudienceMode enum.AudienceMode `json:"audience_mode,omitempty"`
	// OrientationID 定向包ID，定向包ID由【工具-人群管理-获取定向包】获取
	// 1、如果同时传定向包ID和自定义用户定向参数时，仅定向包中的定向生效
	// 2、仅通投且专业推广支持，极速推广不支持
	OrientationID uint64 `json:"orientation_id,omitempty"`
	// DistrictType 定向or排除地域，允许值：
	// true：排除地域
	// false：定向地域，默认
	// 仅直播带货+通投广告+极速推广+托管计划，支持
	DistrictType *bool `json:"district_type,omitempty"`
	// District 地域定向类型，配合city字段使用，允许值：CITY：省市，COUNTY：区县，NONE：不限；默认值：NONE
	District enum.District `json:"district,omitempty"`
	// EletricFenceRegion 电子围栏定向
	// 1：支持电子围栏定向
	// 2：支持电子围栏定向
	ElectricFenceRegion int `json:"electric_fence_region,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"`
	// 	NewCUstomer 新客定向，
	// NO_BUY 店铺未购，
	// NONE 不限
	// NO_BUY_BRAND：品牌未购
	// NO_BUY_DOUYIN 抖音号未购// NewCustomer
	NewCustomer string `json:"new_customer,omitempty"`
}

Audience 定向设置

type ChannelProduct added in v1.19.9 

type ChannelProduct struct {
	// ProductID 商品id，需要与product_ids保持一致
	ProductID uint64 `json:"product_id,omitempty"`
	// ChannelID 渠道ID
	ChannelID uint64 `json:"channel_id,omitempty"`
	// ChannelType 渠道类型
	// 达人自播 STAR_SELL
	// 商家自卖 SHOP_SELL
	ChannelType qianchuan.ProductChannelType `json:"channel_type,omitempty"`
}

ChannelProduct 渠道品信息

type CompensateStatus added in v1.20.5 

type CompensateStatus struct {
	// AdID 计划id
	AdID uint64 `json:"ad_id,omitempty"`
	// Status 当前请求是否成功, 枚举值:
	// SUCCESS: 查询成功
	// FAILED: 查询失败，请重试
	Status qianchuan.CompensateRequestStatus `json:"status,omitempty"`
	// CompensateStatus 计划成本保障状态，允许值
	// IN_EFFECT: 成本保障生效中
	// INVALID: 成本保障已失效
	// CONFIRMING: 成本保障确认中
	// PAID: 成本保障已到账
	// ENDED: 成本保障已结束
	// DEFAULT：无成本保障状态
	CompensateStatus qianchuan.CompensateStatus `json:"compensate_status,omitempty"`
	// Reason 成本保障失效/结束原因
	Reason string `json:"reason,omitempty"`
	// URL 赔付规则链接
	URL string `json:"url,omitempty"`
}

CompensateStatus 计划成本保障状态

type CompensateStatusGetRequest added in v1.20.5 

type CompensateStatusGetRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdIDs 计划id列表，每次最多传入50个
	AdIDs []uint64 `json:"ad_ids,omitempty"`
}

CompensateStatusGetRequest 获取计划成本保障状态 API Request

func (CompensateStatusGetRequest) Encode added in v1.20.5 

func (r CompensateStatusGetRequest) Encode() string

Encode implement GetRequest interface

type CompensateStatusGetResponse added in v1.20.5 

type CompensateStatusGetResponse struct {
	model.BaseResponse
	Data struct {
		List []CompensateStatus `json:"list,omitempty"`
	} `json:"data,omitempty"`
}

CompensateStatusGetResponse 获取计划成本保障状态 API Response

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"`
	// ChannelProductInfos 渠道品信息
	// 注意：如果当前商品在该抖音号下存在渠道品，需要入參channel_product_info
	// 渠道品相关介绍见《【抖店】销售渠道品功能操作手册》
	ChannelProductInfos []ChannelProduct `json:"channel_product_infos,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 DeliveryInfo added in v1.17.2 

type DeliveryInfo struct {
	// TotalNum 总在投计划数
	TotalNum int `json:"total_num,omitempty"`
	// AdlabNum 托管计划的在投计划数
	AdlabNum int `json:"adlab_num,omitempty"`
	// NoAdlabNum 非托管计划的在投计划数
	NoAdlabNum int `json:"no_adlab_num,omitempty"`
}

DeliveryInfo 当前在投计划数信息

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"`
	// ReviveBudget 复活预算
	ReviveBudget float64 `json:"revive_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"`
	// EnableAutoPause 是否启用超成本自动暂停，允许值：
	// 0 关闭 1 开启
	EnableAutoPause int `json:"enable_auto_pause,omitempty"`
	// AutoManageStrategyCmd 托管策略，允许值：
	// 0 优先跑量 1 优先成本
	AutoManageStrategyCmd int `json:"auto_manage_strategy_cmd,omitempty"`
	// EnableFlowMaterial 是否优质素材自动同步投放
	// 0 关闭 1 开启
	EnableFlowMaterial int `json:"enable_flow_material,omitempty"`
	// ProductNewOpen 是否开启新品加速，默认关闭。
	// 开启：true
	// 关闭：false（默认）
	// 注意：需要调用【商家获取可投商品列表】/【达人获取可投商品列表】获取当前商品是否支持开启新品加速。在开启商品加速后，roi_goal会受到限制。
	ProductNewOpen bool `json:"product_new_open,omitempty"`
	// QcpxMode 是否开启智能优惠券，允许值
	// QCPX_MODE_ON 启用
	// QCPX_MODE_OFF 不启用
	QcpxMode qianchuan.QcpxMode `json:"qcpx_mode,omitempty"`
	// AllowQcpx 是否支持智能优惠券
	// true 支持
	// false 不支持
	AllowQcpx bool `json:"allow_qcpx,omitempty"`
}

DeliverySetting 投放设置

type DetailGetRequest 

type DetailGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdID 计划ID
	AdID uint64 `json:"ad_id,omitempty"`
	// RequestMaterialURL 是否需要返回素材url，只有当version=v2时有效
	RequestMaterialURL string `json:"request_material_url,omitempty"`
	// Version 版本，可选值：v2，当传入v2值，支持获取素材预览url，同时不会返回程序化创意叉乘后的创意信息，返回内容与pc一致
	Version string `json:"version,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 EstimateEffectRequest added in v1.16.0 

type EstimateEffectRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AwemeID 抖音id，即商品广告背后关联的抖音号，可通过【查询可推广抖音号列表】接口获取名下可推广抖音号
	AwemeID uint64 `json:"aweme_id,omitempty"`
	// ExternalAction  转化目标
	// 1、直播间成交 AD_CONVERT_TYPE_LIVE_SUCCESSORDER_PAY
	// 2、支付ROI：external_action=AD_CONVERT_TYPE_LIVE_SUCCESSORDER_PAY且deep_external_action=AD_CONVERT_TYPE_LIVE_PAY_ROI且deep_bid_type=MIN
	ExternalAction qianchuan.ExternalAction `json:"external_action,omitempty"`
	// DeepExternalAction 深度转化目标，对应千川后台「期待同时优化」
	// 允许值：
	// 1、AD_CONVERT_TYPE_LIVE_PAY_ROI ROI相关
	DeepExternalAction qianchuan.ExternalAction `json:"deep_external_action,omitempty"`
	// DeepBidType 深度出价方式，允许值：MIN等同于PC端，转化目标设置为“支付ROI”
	// 1.仅deep_external_action=AD_CONVERT_TYPE_LIVE_PAY_ROI 时，必填
	//  可选值:
	// MIN
	DeepBidType qianchuan.DeepBidType `json:"deep_bid_type,omitempty"`
	// BidgetMode 预算类型，允许值：
	// BUDGET_MODE_DAY
	// BUDGET_MODE_TOTAL
	BudgetMode enum.BudgetMode `json:"budget_mode,omitempty"`
	// Budget 预算，最多支持两位小数。预算范围是300 - 9999999.99
	Budget float64 `json:"budget,omitempty"`
	// LiveScheduleType 直播间投放时段选择方式，允许值：
	// 1、SCHEDULE_FROM_NOW 从今天起长期投放、
	// 2、SCHEDULE_START_END 设置开始和结束日期、
	// 3、SCHEDULE_TIME_FIXEDRANGE 固定时长
	LiveScheduleType enum.LiveScheduleType `json:"live_schedule_type,omitempty"`
	// StartTime 投放起始时间，形式如：2017-01-01，广告投放起始时间不允许修改。
	// live_schedule_type为SCHEDULE_START_END 设置开始和结束日期时需传入。
	// 当live_schedule_type为SCHEDULE_FROM_NOW 、SCHEDULE_TIME_FIXEDRANGE 时不能传入
	StartTime string `json:"start_time,omitempty"`
	// EndTime 投放结束时间，形式如：2017-01-01,结束时间不能比起始时间早。
	// 当live_schedule_type为SCHEDULE_START_END 设置开始和结束日期时需传入。
	// 当live_schedule_type为SCHEDULE_FROM_NOW 、SCHEDULE_TIME_FIXEDRANGE 时不能传入
	EndTime string `json:"end_time,omitempty"`
	// ScheduleTime 投放时段当且 live_schedule_type 为SCHEDULE_START_END和SCHEDULE_FROM_NOW时允许传入，默认全时段投放，格式是48*7位字符串，且都是0或1。也就是以半个小时为最小粒度，周一至周日每天分为48个区段，0为不投放，1为投放，不传、全传0、全传1均代表全时段投放。
	// 例如：填写"000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000"，则投放时段为周一到周日的11:30~13:30
	ScheduleTime string `json:"schedule_time,omitempty"`
	// ScheduleFixedRange 固定投放时长
	// 当 live_schedule_type 为 SCHEDULE_TIME_FIXEDRANGE 固定时长时必填；
	// 当live_schedule_type 为SCHEDULE_FROM_NOW 从今天起长期投放、SCHEDULE_START_END 设置开始和结束日期时不能传入。
	// 单位为秒，最小值为1800（0.5小时），最大值为48*1800（24小时），值必须为1800倍数，不然会报错
	ScheduleFixedRange int64 `json:"schedule_fixed_range,omitempty"`
}

EstimateEffectRequest 获取预估效果接口 API Request

func (EstimateEffectRequest) Encode added in v1.16.0 

func (r EstimateEffectRequest) Encode() string

Encode implement GetRequest interface

type EstimateEffectResponse added in v1.16.0 

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

EstimateEffectResponse 获取预估效果接口 API Response

type EstimateEffectResult added in v1.16.0 

type EstimateEffectResult struct {
	// EstimateEffectLow 预估结果下限，单位千分之一分
	// 当优化目标为「直播间成交」时，预估转化成本；
	// 当优化目标为「支付ROI」时，预估支付ROI
	EstimateEffectLow float64 `json:"estimate_effect_low,omitempty"`
	// EstimateEffectHigh 预估结果上限，单位千分之一分
	EstimateEffectHigh float64 `json:"estimate_effect_high,omitempty"`
}

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 ImageMaterial added in v1.25.7 

type ImageMaterial struct {
	// Title 标题
	Title string `json:"title,omitempty"`
	// MusicURL 图文音乐播放链接
	MusicURL string `json:"music_url,omitempty"`
	// Description 图文描述
	Description string `json:"description,omitempty"`
	// ImageMode 素材样式
	ImageMode enum.MaterialMode `json:"image_mode,omitempty"`
	// Source 来源
	Source enum.MaterialSource `json:"source,omitempty"`
	// Images 图片
	Images []MaterialImage `json:"images,omitempty"`
	// MaterialID 素材id
	MaterialID uint64 `json:"material_id,omitempty"`
}

ImageMaterial 图片素材

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"`
	// AdID 计划ID
	AdID uint64 `json:"ad_id,omitempty"`
	// Status 关键词状态
	// CONFIRM 审核通过且可代入
	// REJECT 审核拒绝
	// AUDIT 新建审核中
	// DELETE 已删除
	// PAUSED 词暂停
	Status qianchuan.KeywordStatus `json:"status,omitempty"`
	// MatchType 匹配类型，PHRASE 短语匹配、EXTENSIVE 广泛匹配、PRECISION 精准匹配
	MatchType enum.KeywordMatchType `json:"match_type,omitempty"`
	// WordPackageID 词包ID
	WordPackageID uint64 `json:"word_package_id,omitempty"`
	// WordPackageName 词包名称
	WordPackageName string `json:"word_package_name,omitempty"`
}

Keyword 搜索关键词

type KeywordCheckData added in v1.16.0 

type KeywordCheckData struct {
	// FailList 违规关键词列表
	FailList []KeywordCheckResult `json:"fail_list,omitempty"`
	// SuccessList 可用关键词列表
	SuccessList []KeywordCheckResult `json:"success_list,omitempty"`
}

type KeywordCheckRequest added in v1.16.0 

type KeywordCheckRequest struct {
	// AdvertiserID 千川广告账户id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Keywords 关键词列表，一次最多上传200个词
	Keywords []string `json:"keywords,omitempty"`
}

KeywordCheckRequest 关键词合规校验 API Request

func (KeywordCheckRequest) Encode added in v1.16.0 

func (r KeywordCheckRequest) Encode() []byte

Encode implement PostRequest interface

type KeywordCheckResponse added in v1.16.0 

type KeywordCheckResponse struct {
	model.BaseResponse
	// Data 校验结果
	Data *KeywordCheckData `json:"data,omitempty"`
}

KeywordCheckResponse 关键词合规校验 API Response

type KeywordCheckResult added in v1.16.0 

type KeywordCheckResult struct {
	// Keyword 关键词
	Keyword string `json:"keyword,omitempty"`
	// FailReason 违规原因
	FailReason string `json:"fail_reason,omitempty"`
}

type KeywordInfo added in v1.19.9 

type KeywordInfo struct {
	// KeywordID 关键词id
	KeywordID uint64 `json:"keyword_id,omitempty"`
	// KeywordName 关键词名称
	KeywordName string `json:"keyword_name,omitempty"`
	// KeywordMatchType 关键词匹配方式，可选值:
	// EXTENSIVE
	// PHRASE
	// PRECISION
	KeywordMatchType enum.KeywordMatchType `json:"keyword_match_type,omitempty"`
	// WordPackageName 词包名称
	WordPackageName string `json:"word_package_name,omitempty"`
	// SearchSum 月搜索量
	SearchSum int64 `json:"search_sum,omitempty"`
	// Degree 竞争程度，枚举值：
	// 1、2、3、4、5（对应pc页面上点亮的格数）
	Degree int `json:"degree,omitempty"`
}

KeywordInfo 关键词列表信息

type KeywordPackageGetRequest added in v1.19.9 

type KeywordPackageGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AwemeID 抖音id，与计划创建时设置的抖音ID一致
	// 注：PC侧创建「直播带货」搜索广告时，默认根据aweme_id获取推荐关键
	AwemeID uint64 `json:"aweme_id,omitempty"`
	// ProductID 商品ID，此参数用于获取与商品更为相关的关键词推荐
	// 注：PC侧创建「短视频带货」搜索广告时，默认根据product_id获取推荐关键
	ProductID uint64 `json:"product_id,omitempty"`
}

KeywordPackageGetRequest 获取词包推荐关键词 API Request

func (KeywordPackageGetRequest) Encode added in v1.19.9 

func (r KeywordPackageGetRequest) Encode() string

Encode implement GetRequest interface

type KeywordPackageGetResponse added in v1.19.9 

type KeywordPackageGetResponse struct {
	model.BaseResponse
	Data struct {
		// WordPackageInfos 词包列表信息
		WordPackageInfos []WordPackage `json:"word_package_infos"`
	} `json:"data,omitempty"`
}

KeywordPackageGetResponse 获取词包推荐关键词 API Respons

type KeywordsGetFilter added in v1.16.0 

type KeywordsGetFilter struct {
	// AdID 待获取搜索关键词的计划ID
	AdID uint64 `json:"ad_id,omitempty"`
}

type KeywordsGetRequest added in v1.16.0 

type KeywordsGetRequest struct {
	// AdvertiserID 千川广告账户id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Filtering 过滤条件
	Filtering *KeywordsGetFilter `json:"filtering,omitempty"`
	// Page 页码，从 1 开始，默认1
	Page int `json:"page,omitempty"`
	// PageSize 每页数目，上限500，默认100
	PageSize int `json:"page_size,omitempty"`
}

KeywordsGetRequest 获取计划的搜索关键词 API Request

func (KeywordsGetRequest) Encode added in v1.16.0 

func (r KeywordsGetRequest) Encode() string

Encode implement GetRequest interface

type KeywordsGetResponse added in v1.16.0 

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

KeywordsGetResponse 获取计划的搜索关键词 API Response

type KeywordsGetResult added in v1.16.0 

type KeywordsGetResult struct {
	// List 关键词列表
	List     []Keyword       `json:"list,omitempty"`
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
}

type KeywordsUpdateRequest added in v1.16.0 

type KeywordsUpdateRequest struct {
	// AdvertiserID 千川广告账户id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdID 计划ID
	AdID uint64 `json:"ad_id,omitempty"`
	// Keywords 更新关键词
	Keywords []UpdateKeyword `json:"keywords,omitempty"`
}

KeywordsUpdateRequest 更新关键词 API Request

func (KeywordsUpdateRequest) Encode added in v1.16.0 

func (r KeywordsUpdateRequest) Encode() []byte

Encode implement PostRequest interface

type LearningStatus added in v1.20.5 

type LearningStatus struct {
	// AdID 计划id
	AdID uint64 `json:"ad_id,omitempty"`
	// Status 学习期状态，允许值：
	// LEARNING（学习期）
	// LEARNED（学习期结束）
	// LEARN_FAILED（学习期失败)
	// DEFAULT：无学习期状态
	// 具体可以参考此文档的说明：关于学习期
	Status qianchuan.LearningStatus `json:"status,omitempty"`
}

LearingStatus 计划学习期状态

type LearningStatusGetRequest added in v1.20.5 

type LearningStatusGetRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdIDs 计划id列表，每次最多传入50个
	AdIDs []uint64 `json:"ad_ids,omitempty"`
}

LearningStatusGetRequest 获取计划学习期状态 API Request

func (LearningStatusGetRequest) Encode added in v1.20.5 

func (r LearningStatusGetRequest) Encode() string

Encode implement GetRequest interface

type LearningStatusGetResponse added in v1.20.5 

type LearningStatusGetResponse struct {
	model.BaseResponse
	Data struct {
		// List 计划列表
		List []LearningStatus `json:"list,omitempty"`
	} `json:"data,omitempty"`
}

LearningStatusGetResponse 获取计划学习期状态 API Response

type LqAdGetFilter added in v1.16.0 

type LqAdGetFilter struct {
	// MarketingScene 按广告类型过滤，允许值：
	// ALL 全部
	// FEED 通投广告，默认为FEED
	// SEARCH 搜索广告
	// SHOPPING_MALL商城广告
	MarketingScene qianchuan.MarketingScene `json:"marketing_scene,omitempty"`
}

type LqAdGetRequest added in v1.16.0 

type LqAdGetRequest struct {
	// AdvertiserID 千川广告主账户ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Filtering 过滤条件
	Filtering *LqAdGetFilter `json:"filtering,omitempty"`
}

LqAdGetRequest 获取低效计划列表 API Request

func (LqAdGetRequest) Encode added in v1.16.0 

func (r LqAdGetRequest) Encode() string

Encode implement GetRequest interface

type LqAdGetResponse added in v1.16.0 

type LqAdGetResponse struct {
	model.BaseResponse
	Data struct {
		// AdIDs 低效计划ID列表
		AdIDs []uint64 `json:"ad_ids,omitempty"`
	} `json:"data,omitempty"`
}

LqAdGetResponse 获取低效计划列表 API Response

type MaterialDeleteRequest added in v1.25.7 

type MaterialDeleteRequest struct {
	// MaterialIDs 待删除素材ID
	// 注意：最大支持100个素材
	MaterialIDs []uint64 `json:"material_ids,omitempty"`
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdID 计划ID
	AdID uint64 `json:"ad_id,omitempty"`
}

MaterialDeleteRequest 删除广告计划下素材 API Request

func (MaterialDeleteRequest) Encode added in v1.25.7 

func (r MaterialDeleteRequest) Encode() []byte

Encode implement PostRequest interface

type MaterialGetFiltering added in v1.25.7 

type MaterialGetFiltering struct {
	// MaterialType 素材类型 可选值:
	// IMAGE 图片，图文
	// TITLE 标题
	// LIVE_ROOM 直播间画面
	// VIDEO 视频
	MaterialType MaterialType `json:"material_type,omitempty"`
	// ImageMode 素材样式，仅material_type=VIDEO/IMAGE时支持
	// 当material_type=VIDEO时，支持如下
	// 横版视频 VIDEO_LARGE
	// 竖版视频  VIDEO_VERTICAL
	// 当material_type=IMAGE时，支持如下
	// 横版小图 SMALL
	// 横版大图 LARGE
	// 竖版图片LARGE_VERTICAL
	// 图文CAROUSEL
	ImageMode enum.MaterialMode `json:"image_mode,omitempty"`
	// HavingCost 消耗情况，仅material_type=VIDEO/IMAGE时支持
	// 全部 ALL
	// 有消耗 YES
	// 默认查询全部
	HavingCost string `json:"having_cost,omitempty"`
	// SearchKeyword 搜索关键词
	// 支持查询直播间/视频/标题/图片名称、直播间/视频/图片id
	SearchKeyword string `json:"search_keyword,omitempty"`
	// StartTime 数据开始时间
	// 注意：仅having_cost入参时，该筛选项生效
	StartTime string `json:"start_time,omitempty"`
	// EndTime 数据结束时间
	// 注意：仅having_cost入参时，该筛选项生效
	EndTime string `json:"end_time,omitempty"`
	// VideoSource 视频来源，仅material_type=VIDEO时支持
	// AWEME 抖音主页视频
	// E_COMMERCE 本地上传
	// LIVE_HIGHLIGHT 直播剪辑素材
	// BP 巨量纵横共享素材
	// VIDEO_CAPTURE 易拍APP共享素材
	// ARTHUR 亚瑟共享素材
	// STAR 星图&即合共享素材
	// TADA tada共享素材
	// CREATIVE_CENTER 巨量创意PC共享素材
	// JIANYING 剪映共享素材
	// JI_CHUANG 即创共享素材
	VideoSource []enum.MaterialSource `json:"material_source,omitempty"`
	// AnalysisType 素材建议，仅material_type=VIDEO时支持
	//  CARRY_MATERIAL 搬运风险素材
	// LOW_EFFICIENCY_MATERIAL 低效素材
	// FIRST_PUBLISH_MATERIAL 首发素材
	// SIMILAR_RISK_MATERIAL 同质化素材
	// HIGH_QUALITY_MATERIAL 优质素材
	// POOR_QUALITY_MATERIAL 低质素材
	AnalysisType []enum.MaterialProperty `json:"analysis_type,omitempty"`
}

MaterialGetFiltering 过滤条件

type MaterialGetRequest added in v1.25.7 

type MaterialGetRequest struct {
	// Filtering 过滤条件
	Filtering *MaterialGetFiltering `json:"filtering,omitempty"`
	// OrderType 排序方式 可选值:
	// ASC 升序
	// DESC 降序 默认
	OrderType enum.OrderType `json:"order_type,omitempty"`
	// OrderField 排序字段，支持根据消耗等数据指标排序
	OrderField string `json:"order_field,omitempty"`
	// AdvertiserID 千川广告账户ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdID 计划ID
	AdID uint64 `json:"ad_id,omitempty"`
	// Page 页码，默认值：1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小，允许值：10, 20, 50, 100，默认值：10
	PageSize int `json:"page_size,omitempty"`
}

MaterialGetRequest 获取计划下素材列表 API Request

func (MaterialGetRequest) Encode added in v1.25.7 

func (r MaterialGetRequest) Encode() string

Encode implements GetRequest interface

type MaterialGetResponse added in v1.25.7 

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

MaterialGetResponse 获取计划下素材列表 API Response

type MaterialGetResult added in v1.25.7 

type MaterialGetResult struct {
	// PageInfo 分页结果
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
	// AdMaterialInfos 返回的素材信息列表
	AdMaterialInfos []AdMaterialInfo `json:"ad_material_infos,omitempty"`
}

type MaterialImage added in v1.25.7 

type MaterialImage struct {
	// WebURL 图片url
	WebURL string `json:"web_url,omitempty"`
	// ImageURL 图片url
	ImageURL string `json:"image_url,omitempty"`
	// ID 图片id
	ID string `json:"id,omitempty"`
	// Height 图片高度
	Height int `json:"height,omitempty"`
	// Width 图片宽度
	Width int `json:"width,omitempty"`
}

MaterialImage 图片信息

type MaterialInfo added in v1.25.7 

type MaterialInfo struct {
	// VideoMaterial 视频素材
	VideoMaterial *VideoMaterial `json:"video_material,omitempty"`
	// ImageMaterial 图片素材
	ImageMaterial *ImageMaterial `json:"image_material,omitempty"`
	// TitleMaterial 标题素材
	TitleMaterial *TitleMaterial `json:"title_material,omitempty"`
	// RoomMaterial 直播间画面用户信息
	RoomMaterial *RoomMaterial `json:"room_material,omitempty"`
	// MaterialType 素材类型
	MaterialType MaterialType `json:"material_type,omitempty"`
}

MaterialInfo 素材信息

type MaterialType added in v1.25.7 

type MaterialType string

MaterialType 素材类型 

const (
	// MaterialType_IMAGE 图片，图文
	MaterialType_IMAGE MaterialType = "IMAGE"
	// MaterialType_TITLE 标题
	MaterialType_TITLE MaterialType = "TITLE"
	// MaterialType_LIVE_ROOM 直播间画面
	MaterialType_LIVE_ROOM MaterialType = "LIVE_ROOM"
	// MaterialType_VIDEO 视频
	MaterialType_VIDEO MaterialType = "VIDEO"
)

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 PrivatewordsGetFilter added in v1.16.0 

type PrivatewordsGetFilter struct {
	// AdID 待获取否定词的计划ID
	AdID uint64 `json:"ad_id,omitempty"`
}

type PrivatewordsGetRequest added in v1.16.0 

type PrivatewordsGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Filtering 筛选条件
	Filtering *PrivatewordsGetFilter `json:"filtering,omitempty"`
}

PrivatewordsGetRequest 获取否定词列表 API Request

func (PrivatewordsGetRequest) Encode added in v1.16.0 

func (r PrivatewordsGetRequest) Encode() string

Encode implement GetRequest interface

type PrivatewordsGetResponse added in v1.16.0 

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

PrivatewordsGetResponse 获取否定词列表 API Response

type PrivatewordsUpdateRequest added in v1.16.0 

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

PrivatewordsUpdateRequest 全量更新否定词 API Request

func (PrivatewordsUpdateRequest) Encode added in v1.16.0 

func (r PrivatewordsUpdateRequest) Encode() []byte

Encode implement PostRequest interface

type PrivatewordsUpdateResponse added in v1.16.0 

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

PrivatewordsUpdateResponse 全量更新否定词 API Response

type PrivatewordsUpdateResult added in v1.16.0 

type PrivatewordsUpdateResult struct {
	// Status 修改状态 可选值:
	// UNKNOWN: 未知结果
	// SUCCESS: 成功
	// FAIL: 失败
	Status string `json:"status,omitempty"`
	// Reason 原因
	Reason string `json:"reason,omitempty"`
}

type Quota added in v1.17.2 

type Quota struct {
	// QuotaGear 当前所在配额档位：1,2,3,4,5,6,7,8,9
	QuotaGear int `json:"quota_gear,omitempty"`
	// MonthCost 当前最高月消耗
	MonthCost float64 `json:"month_cost,omitempty"`
	// QuotaInfo 在投计划数配额信息
	QuotaInfo *QuotaInfo `json:"quota_info,omitempty"`
	// DeliveryInfo 当前在投计划数信息
	DeliveryInfo *DeliveryInfo `json:"delivery_info,omitempty"`
	// StageInfo 当前所在投放阶段信息
	StageInfo *StageInfo `json:"stage_info,omitempty"`
}

Quota 广告在投计划配额信息

type QuotaGetRequest added in v1.17.2 

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

QuotaGetRequest 获取在投计划配额信息 API Request

func (QuotaGetRequest) Encode added in v1.17.2 

func (r QuotaGetRequest) Encode() string

Encode implement GetRequest interface

type QuotaGetResponse added in v1.17.2 

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

QuotaGetResponse 获取在投计划配额信息 API Response

type QuotaGetResult added in v1.17.2 

type QuotaGetResult struct {
	// QuotaFeed 通投广告在投计划配额信息
	QuotaFeed *Quota `json:"quota_feed,omitempty"`
	// QuotaSearch 搜索广告在投计划配额信息
	QuotaSearch *Quota `json:"quota_search,omitempty"`
}

type QuotaInfo added in v1.17.2 

type QuotaInfo struct {
	// TotalNum 总在投计划配额
	TotalNum int `json:"total_num,omitempty"`
}

QuotaInfo 在投计划数配额信息

type RecommendKeyword added in v1.16.0 

type RecommendKeyword struct {
	// Keyword 关键词
	Keyword string `json:"keyword,omitempty"`
	// SuggestReason 推荐理由类型，枚举值:
	// CLICK: 高点买词
	// DARKHORSE: 黑马词
	// LOW_COST: 低成本词
	// POTENTIAL: 蓝海词
	// PREFERENCE: 同行买词
	SuggestReason qianchuan.KeywordSuggestReason `json:"suggest_reason,omitempty"`
	// SearchSum 月搜索量
	SearchSum int64 `json:"search_sum,omitempty"`
	// Degree 竞争程度，枚举值：
	// 1、2、3、4、5（对应pc页面上点亮的格数）
	Degree int `json:"degree,omitempty"`
	// CacheID 本次查询的唯一标识ID，有效期12h。
	// 可用于后续请求，用以保证查询到数据的完整性。
	CacheID string `json:"cache_id,omitempty"`
}

RecommendKeyword 推荐关键词

type RecommendKeywordsFilter added in v1.16.0 

type RecommendKeywordsFilter struct {
	// SearchWord 词根
	SearchWord string `json:"search_word,omitempty"`
	// ProductID 商品ID，此参数用于获取与商品更为相关的关键词推荐
	// 注：PC侧创建「短视频带货」搜索广告时，默认根据product_id获取推荐关键
	ProductID uint64 `json:"product_id,omitempty"`
	// AwemeID 抖音id，与计划创建时设置的抖音ID一致
	// 注：PC侧创建「直播带货」搜索广告时，默认根据aweme_id获取推荐关键
	AwemeID uint64 `json:"aweme_id,omitempty"`
	// SuggestReason 推荐理由类型：允许值:
	// CLICK: 高点击词
	// DARKHORSE: 黑马词
	// LOW_COST: 低成本词
	// POTENTIAL: 蓝海词
	// PREFERENCE: 同行买词
	SuggestReason qianchuan.KeywordSuggestReason `json:"suggest_reason,omitempty"`
}

type RecommendKeywordsGetRequest added in v1.16.0 

type RecommendKeywordsGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Filtering 过滤条件
	// 1. “search_word”、“product_id”、“aweme_id”，必须传入一个；
	// 2. 优先按“search_word”过滤，其次按“product_id”过滤，最后按“aweme_id”过滤
	Filtering *RecommendKeywordsFilter `json:"filtering,omitempty"`
	// OrderField 排序字段：允许值:
	// COMPETITION: 竞争程度
	// DEFAULT: 推荐度（默认）
	// PV: 月搜索量
	// RELEVANCE: 相关性
	OrderField qianchuan.RecommendKeywordOrderField `json:"order_field,omitempty"`
	// OrderType 排序方式，允许值：
	// ASC: 升序
	// DESC: 降序
	OrderType enum.OrderType `json:"order_type,omitempty"`
	// CacheID 选填入参。
	// 请求唯一标识，能保证同样的过滤条件返回的数据是一致的。
	// 使用过期后的cache_id请求该接口，不会报错，会当作全新的查询操作来处理。
	// 注意：每次全新的查询，返回的数据可能会不一样
	CacheID string `json:"cache_id,omitempty"`
	// Page 页码，默认值：1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小，允许值：500, 1000，默认值：500
	PageSize int `json:"page_size,omitempty"`
}

RecommendKeywordsGetRequest 获取系统推荐的搜索关键词 API Request

func (RecommendKeywordsGetRequest) Encode added in v1.16.0 

func (r RecommendKeywordsGetRequest) Encode() string

Encode implement GetRequest interface

type RecommendKeywordsGetResponse added in v1.16.0 

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

RecommendKeywordsGetResponse 获取系统推荐的搜索关键词 API Response

type RecommendKeywordsGetResult added in v1.16.0 

type RecommendKeywordsGetResult struct {
	// List 关键词列表
	List []RecommendKeyword `json:"list,omitempty"`
	// PageInfo
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
}

type RegionUpdateRequest added in v1.18.5 

type RegionUpdateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdIDs 需要更新的广告计划id，一次只允许传入10个
	AdIDs []uint64 `json:"ad_ids,omitempty"`
	// District 地域类型，允许值：
	// CITY 省市
	// COUNTY 区县
	// 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"`
	// ExcludeLimitedRegion  排除限运地区，允许值：
	// 0：否，默认值
	// 1：是
	// 注意：
	// 1、当地域定向类型为“不限”/地域定向的用户状态类型为“正在该地区的用户”才支持
	ExcludeLimitedRegion int `json:"exclude_limited_region,omitempty"`
}

RegionUpdateRequest 更新计划地域定向 API Request

func (RegionUpdateRequest) Encode added in v1.18.5 

func (r RegionUpdateRequest) Encode() []byte

Encode implement PostRequest interface

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 RoiGoalUpdate added in v1.16.0 

type RoiGoalUpdate struct {
	// AdID 需要更新ROI目标的计划id
	AdID uint64 `json:"ad_id,omitempty"`
	// RoiGoal 计划更新之后的支付ROI目标，最多支持两位小数，0.01～100
	// 注意：
	// 按展示付费(oCPM)，根据【保障规则】提供保障福利，请谨慎修改支付ROI目标和定向，以免失去保障资格。
	RoiGoal float64 `json:"roi_goal,omitempty"`
}

RoiGoalUpdate 更新计划出价的列表，当前最多支持1个

type RoiGoalUpdateRequest added in v1.16.0 

type RoiGoalUpdateRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// RoiGoalUpdates 更新计划出价的列表，当前最多支持1个
	RoiGoalUpdates []RoiGoalUpdate `json:"roi_goal_updates,omitempty"`
}

RoiGoalUpdateRequest 更新计划的支付ROI目标 API Request

func (RoiGoalUpdateRequest) Encode added in v1.16.0 

func (r RoiGoalUpdateRequest) Encode() []byte

Encode implement PostRequest interface

type RoiGoalUpdateResponse added in v1.16.0 

type RoiGoalUpdateResponse struct {
	model.BaseResponse
	Data struct {
		Results []RoiGoalUpdateResult `json:"results,omitempty"`
	} `json:"data,omitempty"`
}

RoiGoalUpdateResponse 更新计划的支付ROI目标 API Response

type RoiGoalUpdateResult added in v1.16.0 

type RoiGoalUpdateResult struct {
	// Flag 更新ROI目标结果，枚举值:
	// 1 成功
	// 0 失败
	Flat int `json:"flat,omitempty"`
	// AdID 计划id
	AdID uint64 `json:"ad_id,omitempty"`
	// ErrorMessage 更新ROI目标失败的原因
	// 仅当"flag"为0 时有效
	ErrorMessage string `json:"error_message,omitempty"`
}

type RoomMaterial added in v1.25.7 

type RoomMaterial struct {
	// Name 直播间名称
	Name string `json:"name,omitempty"`
	// AwemeAvatar 头像
	AwemeAvatar string `json:"aweme_avatar,omitempty"`
	// ID 直播间id
	ID uint64 `json:"id,omitempty"`
}

RoomMaterial 直播间画面用户信息

type ScheduleDateUpdateRequest added in v1.18.5 

type ScheduleDateUpdateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdIDs 需要更新的广告计划id，一次只允许传入10个
	AdIDs []uint64 `json:"ad_ids,omitempty"`
	// ScheduleType  投放日期选择方式，允许值：
	// SCHEDULE_FROM_NOW 长期投放
	// SCHEDULE_START_END 具体日期投放
	ScheduleType enum.ScheduleType `json:"schedule_type,omitempty"`
	// EndTime 投放结束时间，形式如：2017-01-01,结束时间不能早于当天。
	// 注意：当video_schedule_type=SCHEDULE_START_END 必填。
	EndTime string `json:"end_time,omitempty"`
}

ScheduleDateUpdateRequest 更新计划投放时间 API Request

func (ScheduleDateUpdateRequest) Encode added in v1.18.5 

func (r ScheduleDateUpdateRequest) Encode() []byte

Encode implement PostRequest interface

type ScheduleFixedRangeUpdateRequest added in v1.18.5 

type ScheduleFixedRangeUpdateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdIDs 需要更新的广告计划id，一次只允许传入10个
	AdIDs []uint64 `json:"ad_ids,omitempty"`
	// ScheduleFixedRange 固定投放时长
	// 单位为秒，最小值为1800（0.5小时），最大值为48*1800（24小时），值必须为1800倍数，不然会报错
	ScheduleFixedRange int64 `json:"schedule_fixed_range,omitempty"`
}

ScheduleFixedRangeUpdateRequest 更新计划投放时长 API Request

func (ScheduleFixedRangeUpdateRequest) Encode added in v1.18.5 

func (r ScheduleFixedRangeUpdateRequest) Encode() []byte

Encode implement PostRequest interface

type ScheduleTimeUpdateRequest added in v1.18.5 

type ScheduleTimeUpdateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdIDs 需要更新的广告计划id，一次只允许传入10个
	AdIDs []uint64 `json:"ad_ids,omitempty"`
	// ScheduleTime 投放时段
	// 默认全时段投放（不限），格式是48*7位字符串，且都是0或1。也就是以半个小时为最小粒度，周一至周日每天分为48个区段，0为不投放，1为投放，不传、全传0、全传1均代表全时段投放。
	// 例如：填写"000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000"，则投放时段为周一到周日的11:30~13:30
	ScheduleTime string `json:"schedule_time,omitempty"`
}

ScheduleTimeUpdateRequest 更新计划投放时段 API Request

func (ScheduleTimeUpdateRequest) Encode added in v1.18.5 

func (r ScheduleTimeUpdateRequest) Encode() []byte

Encode implement PostRequest interface

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 StageInfo added in v1.17.2 

type StageInfo struct {
	// IsPrimary 是否在投放初期
	// 0：否
	// 1：是
	IsPrimary int `json:"is_primary,omitempty"`
	// StartDay 投放初期起始日期
	StartDay string `json:"start_day,omitempty"`
	// EndDay 投放初期截止日期
	EndDay string `json:"end_day,omitempty"`
}

StageInfo 当前所在投放阶段信息

type SuggestBidRequest added in v1.16.0 

type SuggestBidRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AwemeID 抖音id ，即待推广直播开播的抖音号，可通过【查询可推广抖音号列表】接口获取名下可推广抖音号
	AwemeID uint64 `json:"aweme_id,omitempty"`
	// MarketingGoal 营销目标，可选值:
	// LIVE_PROM_GOODS 推直播间
	// VIDEO_PROM_GOODS 推商品
	MarketingGoal enum.MarketingGoal `json:"marketing_goal,omitempty"`
	// ProductID 商品ID
	ProductID uint64 `json:"product_id,omitempty"`
	// ExternalAction 短视频带货目的允许值：
	// AD_CONVERT_TYPE_SHOPPING 商品购买
	// AD_CONVERT_TYPE_QC_FOLLOW_ACTION 粉丝提升
	// AD_CONVERT_TYPE_QC_MUST_BUY 点赞评论
	// AD_CONVERT_TYPE_LIVE_SUCCESSORDER_PAY_7DAYS7日总成交
	// 注意：搜索广告短视频带货只支持AD_CONVERT_TYPE_SHOPPING
	//
	// 直播带货目的允许值：
	// AD_CONVERT_TYPE_LIVE_ENTER_ACTION 进入直播间
	// AD_CONVERT_TYPE_LIVE_CLICK_PRODUCT_ACTION 直播间商品点击
	// AD_CONVERT_TYPE_LIVE_SUCCESSORDER_ACTION 直播间下单
	// AD_CONVERT_TYPE_NEW_FOLLOW_ACTION 直播间粉丝提升
	// AD_CONVERT_TYPE_LIVE_COMMENT_ACTION 直播间评论
	// AD_CONVERT_TYPE_LIVE_SUCCESSORDER_PAY直播间成交
	// AD_CONVERT_TYPE_LIVE_SUCCESSORDER_PAY_7DAYS7日总成交
	ExternalAction qianchuan.ExternalAction `json:"external_action,omitempty"`
	// CampaignScene 营销场景，可选值
	// DAILY_SALE 日常销售
	// NEW_CUSTOMER_TRANSFORMATION 新客转化
	CampaignScene qianchuan.CampaignScene `json:"campaign_scene,omitempty"`
}

SuggestBidRequest 获取非ROI目标建议出价 API Request

func (SuggestBidRequest) Encode added in v1.16.0 

func (r SuggestBidRequest) Encode() string

Encode implement GetRequest interface

type SuggestBidResponse added in v1.16.0 

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

SuggestBidResponse 获取非ROI目标建议出价 API Response

type SuggestBidResult added in v1.16.0 

type SuggestBidResult struct {
	// SuggestBidLow 建议出价下限，单位千分之一分
	SuggestBidLow float64 `json:"suggest_bid_low,omitempty"`
	// SuggestBidHigh 建议出价上限，单位千分之一分
	SuggestBidHigh float64 `json:"suggest_bid_high,omitempty"`
}

type SuggestBudgetRequest added in v1.16.0 

type SuggestBudgetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AwemeID 抖音id ，即待推广直播开播的抖音号，可通过【查询可推广抖音号列表】接口获取名下可推广抖音号
	AwemeID uint64 `json:"aweme_id,omitempty"`
	// LiveScheduleType  直播间投放时段选择方式，允许值：
	// 1、SCHEDULE_FROM_NOW 从今天起长期投放
	// 2、SCHEDULE_START_END 设置开始和结束日期
	// 3、SCHEDULE_TIME_FIXEDRANGE 固定时长
	LiveScheduleType enum.LiveScheduleType `json:"live_schedules_type,omitempty"`
	// StartTime 投放起始时间，形式如：2017-01-01，广告投放起始时间不允许修改。live_schedule_type为SCHEDULE_START_END 设置开始和结束日期时需传入。
	// 当live_schedule_type为SCHEDULE_FROM_NOW 、SCHEDULE_TIME_FIXEDRANGE 时不能传入
	StartTime string `json:"start_time,omitempty"`
	// EndTime 投放结束时间，形式如：2017-01-01,结束时间不能比起始时间早。
	// 当live_schedule_type为SCHEDULE_START_END 设置开始和结束日期时需传入。
	// 当live_schedule_type为SCHEDULE_FROM_NOW 、SCHEDULE_TIME_FIXEDRANGE 时不能传入
	EndTime string `json:"end_time,omitempty"`
	// ScheduleTime 投放时段当且 live_schedule_type 为SCHEDULE_START_END和SCHEDULE_FROM_NOW时允许传入，默认全时段投放，格式是48*7位字符串，且都是0或1。也就是以半个小时为最小粒度，周一至周日每天分为48个区段，0为不投放，1为投放，不传、全传0、全传1均代表全时段投放。
	// 例如：填写"000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000"，则投放时段为周一到周日的11:30~13:30
	ScheduleTime string `json:"schedule_time,omitempty"`
	// ScheduleFixedRange 固定投放时长
	// 当 live_schedule_type 为 SCHEDULE_TIME_FIXEDRANGE 固定时长时必填；
	// 当live_schedule_type 为SCHEDULE_FROM_NOW 从今天起长期投放、SCHEDULE_START_END 设置开始和结束日期时不能传入。
	// 单位为秒，最小值为1800（0.5小时），最大值为48*1800（24小时），值必须为1800倍数，不然会报错
	ScheduleFixedRange int64 `json:"schedule_fixed_range,omitempty"`
}

SuggestBudgetRequest 获取建议预算接口 API Request

func (SuggestBudgetRequest) Encode added in v1.16.0 

func (r SuggestBudgetRequest) Encode() string

Encode implement GetRequest interface

type SuggestBudgetResponse added in v1.16.0 

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

SuggestBudgetResponse 获取建议预算接口 API Response

type SuggestBudgetResult added in v1.16.0 

type SuggestBudgetResult struct {
	// SuggestBudgetLow 建议预算下限，单位千分之一分
	SuggestBudgetLow float64 `json:"suggest_budget_low,omitempty"`
	// SuggestBudgetHigh 建议预算上限，单位千分之一分
	SuggestBudgetHigh float64 `json:"suggest_budget_high,omitempty"`
}

type SuggestRoiGoalRequest added in v1.16.0 

type SuggestRoiGoalRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AwemeID 抖音id ，即待推广直播开播的抖音号，可通过【查询可推广抖音号列表】接口获取名下可推广抖音号
	AwemeID uint64 `json:"aweme_id,omitempty"`
	// MarketingGoal 营销目标，可选值:
	// LIVE_PROM_GOODS 推直播间
	// VIDEO_PROM_GOODS 推商品
	MarketingGoal enum.MarketingGoal `json:"marketing_goal,omitempty"`
	// MarketingScene 广告类型， 可选值:
	// FEED 通投
	// SEARCH 搜索
	// SHOPPING_MALL商城广告
	MarketingScene qianchuan.MarketingScene `json:"marketing_scene,omitempty"`
	// ProductID 商品ID
	ProductID uint64 `json:"product_id,omitempty"`
	// ProductNewOpen 是否开启新品加速
	// 开启：true
	// 关闭：false
	ProductNewOpen bool `json:"product_new_open,omitempty"`
	// ExternalAction 短视频带货目的允许值：
	// AD_CONVERT_TYPE_SHOPPING 商品购买
	// AD_CONVERT_TYPE_QC_FOLLOW_ACTION 粉丝提升
	// AD_CONVERT_TYPE_QC_MUST_BUY 点赞评论
	// AD_CONVERT_TYPE_LIVE_SUCCESSORDER_PAY_7DAYS7日总成交
	// 注意：搜索广告短视频带货只支持AD_CONVERT_TYPE_SHOPPING
	//
	// 直播带货目的允许值：
	// AD_CONVERT_TYPE_LIVE_ENTER_ACTION 进入直播间
	// AD_CONVERT_TYPE_LIVE_CLICK_PRODUCT_ACTION 直播间商品点击
	// AD_CONVERT_TYPE_LIVE_SUCCESSORDER_ACTION 直播间下单
	// AD_CONVERT_TYPE_NEW_FOLLOW_ACTION 直播间粉丝提升
	// AD_CONVERT_TYPE_LIVE_COMMENT_ACTION 直播间评论
	// AD_CONVERT_TYPE_LIVE_SUCCESSORDER_PAY直播间成交
	// AD_CONVERT_TYPE_LIVE_SUCCESSORDER_PAY_7DAYS7日总成交
	ExternalAction qianchuan.ExternalAction `json:"external_action,omitempty"`
	// CampaignScene 营销场景，可选值
	// DAILY_SALE 日常销售
	// NEW_CUSTOMER_TRANSFORMATION 新客转化
	CampaignScene qianchuan.CampaignScene `json:"campaign_scene,omitempty"`
}

SuggestRoiGoalRequest 获取支付ROI目标建议 API Request

func (SuggestRoiGoalRequest) Encode added in v1.16.0 

func (r SuggestRoiGoalRequest) Encode() string

Encode implement GetRequest interface

type SuggestRoiGoalResponse added in v1.16.0 

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

SuggestRoiGoalResponse 获取支付ROI目标建议 API Response

type SuggestRoiResult added in v1.16.0 

type SuggestRoiResult struct {
	// EcpRoiGoal 支付ROI目标建议值的上限，单位：元，精确到两位小数
	EcpRoiGoal float64 `json:"ecp_roi_goal,omitempty"`
	// RoiLowerBound roi下限，在开启新品加速后，需校验上下线
	RoiLowerBound float64 `json:"roi_lower_bound,omitempty"`
	// RoiUpperBound roi上限，在开启新品加速后，需校验上下线
	RoiUpperBound float64 `json:"roi_upper_bound,omitempty"`
}

type TitleMaterial added in v1.25.7 

type TitleMaterial struct {
	// Title 标题
	Title string `json:"title,omitempty"`
	// MaterialID 素材id
	MaterialID uint64 `json:"material_id,omitempty"`
}

TitleMaterial 标题素材

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 UpdateKeyword added in v1.16.0 

type UpdateKeyword struct {
	// ID 关键词ID
	ID uint64 `json:"id,omitempty"`
	// StatusType 关键词操作状态 可选值:
	// DELETE: 删除
	// ENABLE: 启动
	// PAUSED: 暂停
	StatusType qianchuan.KeywordStatus `json:"status_type,omitempty"`
	// MatchType 关键词匹配类型 可选值:
	// EXTENSIVE: 广泛匹配
	// PHRASE: 短语匹配
	// PRECISION: 精准匹配
	MatchType enum.KeywordMatchType `json:"match_type,omitempty"`
}

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

type VideoMaterial added in v1.25.7 

type VideoMaterial struct {
	// CoverImage 视频封面图片
	CoverImage *MaterialImage `json:"cover_image,omitempty"`
	// VideoID 视频 id
	VideoID string `json:"video_id,omitempty"`
	// Title 视频标题
	Title string `json:"title,omitempty"`
	// Source 视频来源
	Source enum.MaterialSource `json:"source,omitempty"`
	// ImageMode 素材样式
	ImageMode enum.MaterialMode `json:"image_mode,omitempty"`
	// MaterialID 素材id
	MaterialID uint64 `json:"material_id,omitempty"`
	// VideoDuration 视频时长
	VideoDuration float64 `json:"video_duration,omitempty"`
}

VideoMaterial 视频素材

type WordPackage added in v1.19.9 

type WordPackage struct {
	// ID 词包id
	ID uint64 `json:"id,omitempty"`
	// Name 词包名称
	Name string `json:"name,omitempty"`
	// SearchSum 月搜索量
	SearchSum int64 `json:"search_sum,omitempty"`
	// Degree 竞争程度，枚举值：
	// 1、2、3、4、5（对应pc页面上点亮的格数）
	Degree int `json:"degree,omitempty"`
	// KeywordInfos 关键词列表信息
	KeywordInfos []KeywordInfo `json:"keyword_infos,omitempty"`
}

WordPackage 词包列表信息

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.