unit

package
v1.7.6 Latest Latest
Warning

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

 Go to latest Published: Apr 29, 2024 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package unit 广告组相关API models

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AdMarketNegativeWordParam added in v1.4.5 

type AdMarketNegativeWordParam struct {
	// ExactWords 精确否定词，搜索广告新增
	ExactWords []string `json:"exact_words,omitempty"`
	// PhraseWords 短语否定词，搜索广告新增
	PhraseWords []string `json:"phrase_words,omitempty"`
}

AdMarketNegativeWordParam 搜索广告否词，搜索广告新增

type AdvCard 

type AdvCard struct {
	// ID 卡片id
	ID uint64 `json:"adv_card_id,omitempty"`
	// CardType 卡片类型; 100:图片卡片 101:多利益卡-图文 102：多利益卡-多标签 103：电商促销样式
	CardType int `json:"card_type,omitempty"`
	// Url 图片url
	Url string `json:"url,omitempty"`
	// Title 标题
	Title string `json:"title,omitempty"`
	// SubTitle 副标题
	SubTitle string `json:"sub_title,omitempty"`
	// Price 原价格(单位：分)
	Price int64 `json:"price,omitempty"`
	// SalePrice 售卖价(单位：分)
	SalePrice int64 `json:"sale_price,omitempty"`
}

AdvCard 高级创意

type BackflowForecast 

type BackflowForecast struct {
	// CvLower 回流预估值的下限
	CvLower int64 `json:"backflow_cv_lower,omitempty"`
	// CvUpper 回流预估值的上限
	CvUpper int64 `json:"backflow_cv_upper,omitempty"`
	// Timestamp 本次回流预估数据的时间戳，13位毫秒时间戳
	Timestamp int64 `json:"backflow_timestamp,omitempty"`
}

type CreateRequest added in v1.0.5 

type CreateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID int64 `json:"advertiser_id,omitempty"`
	// CampaignID 广告计划ID
	CampaignID uint64 `json:"campaign_id,omitempty"`
	// UnitName 广告组名称; 长度为1-100个字符，同一个计划下的广告组名称不能重复
	UnitName string `json:"unit_name,omitempty"`
	// PutStatus 广告组的投放状态; 不填时，创建的广告组为投放状态；填2时，创建的广告组为暂停状态，其他值非法
	PutStatus int `json:"put_status,omitempty"`
	// TemplateID 定向模板id
	TemplateID uint64 `json:"template_id,omitempty"`
	// BidType 优化目标出价类型; 1: CPM 2: CPC 10:OCPM 4: CPA只有计划类型为3，url_type=4才支持，而且ocpx_action_type只能为表单提交53)
	BidType int `json:"bid_type,omitempty"`
	// UseAppMarket 优先从系统应用商店下载; 下载模式：允许值：0，1；1：优先从系统应用商店下载使用，默认0。仅提升应用安装计划类型且选择的app为安卓才支持。
	UseAppMarket int `json:"use_app_market,omitempty"`
	// AppStore 应用商店列表; 华为：huawei, OPPO：oppo VIVO：vivo 小米：xiaomi；魅族：meizu；锤子：smartisan 只支持计划类型为 2 且应用是 Android 类型的推广
	AppStore []string `json:"app_store,omitempty"`
	// Bid 出价; bid_type为CPC/eCPC/CPM时该字段必填，单位：厘，不得低于0.2元，不得高于100元，不得高于组预算
	Bid int64 `json:"bid,omitempty"`
	// CpaBid 出价; bid_type是OCPM时该字段必填，单位：厘，ocpx_action_type为2时，不得低于1元，不得高于3000元；ocpx_action_type为180时，不得低于1元，不得高于3000元，ocpx_action_type为53时，不得低于5元，不得高于3000元；不得高于组预算
	CpaBid int64 `json:"cpa_bid,omitempty"`
	// SmartBid 优先低成本出价(设置条件); 当 speed 等于 3 时可用 ；0：手动出价，1：自动出价；1、当 smart_bid 为 1 时，cpa_bid 或 deep_conversion_bid 都不能设置值；2、快享和联盟不支持优先低成本，直接报错；3、优先低成本的 bid_type 只支持OCPM；4、优先低成本 必须设置统一预算或分日预算
	SmartBid int `json:"smart_bid,omitempty"`
	// OcpxActionType 优化目标;
	// bid_type是OCPM时该字段必填；2：行为数（actionBar点击）；180：激活数；53：表单数；190: 付费；191：首日ROI；324：唤起应用（campaign_type=7+主站+加白）；348：有效线索；383: 授信；384: 完件394：订单提交；（计划类型获取电商下单，非金牛）；396：注册（联盟暂不支持）；715：微信复制优化目标；（campaign_type=5&bid_type=10）；716：多转化事件(campaign_type=5&bid_type=10&使用魔力建站&线索转化类组件>=2种)；717：广告观看次数(campaign_type=2&bid_type=10&appi与转化追踪工具联调过或者该广告主的在相应事件的回传数>=1）需通过接口「rest/openapi/v1/ad_unit/ocpc/conversion_infos」获取是否可以选择「激活」、「表单转化」、「付费」、「授信」、「完件」的优化目标;731：广告观看5次；732：广告观看10次；733：广告观看20次；773：关键行为；774：7日ROI；72：小店通商品和主页推广，转化目标“涨粉”；392：小店通商品推广，优化目标“转化数”，转化目标“商品访问”；395：小店通商品和主页推广，转化目标“订单支付”，62：直播观看数,（小店直播推广&商品推广支持，计划type=14、13）;192：直播推广ROI；小店直播推广&商品推广支持，计划type=14、13）;403：近似购买（小店直播推广&商品推广支持，计划type=14、13）。需通过接口「获取可选的深度转化类型」，接口is_order_paied字段返回值为1才可以使用;
	OcpxActionType int `json:"ocpx_action_type,omitempty"`
	// DeepConversionType 深度转化目标;
	// 3:付费，7:次日留存，10:完件, 11:授信；13:添加购物车；14:提交订单；15:购买；44：有效线索；92：付费roi。可通过下方深度转化信息查询接口获取当前账户可选的深度转化目标
	DeepConversionType int `json:"deep_conversion_type,omitempty"`
	// RoiRatio 付费ROI系数; 优化目标为「首日ROI」时必填：ROI系数取值范围 ( 0,100 ] 最多支持到三位小数（如：0.066）
	RoiRatio float64 `json:"roi_ratio,omitempty"`
	// DeepConversionBid 深度转化目标出价; 单位：厘，仅当deep_conversion_type可用且账户满足白名单时选填，出价需大于cpa_bid，小于min{组预算，3000元}，不得高于组预算，不支持从0改为其他值，也不支持从其他值改为0
	DeepConversionBid int64 `json:"deep_conversion_bid,omitempty"`
	// SceneID 资源位置; 1：优选广告位（当账户在联盟优选白名单中且campaign_type=2/3/5/7时为主站&联盟优选广告位 ）；3：视频播放页广告-便利贴广告（不支持深度转化目标的优化）；5：联盟广告；6：上下滑大屏广告；7：信息流广告；10：联盟场景 3、6、7、10可多选;当账户在联盟优选白名单中且campaign_type = 2/3/5/7，可传10；;当账户不在联盟优选白名单中或campaign_type不等于2/3/5/7时，不可传10；
	SceneID []int `json:"scene_id,omitempty"`
	// UnitType 创意制作方式; 4: 自定义；5：程序化创意 7：程序化创意2.0
	UnitType int `json:"unit_type,omitempty"`
	// BeginTime 投放开始时间; 格式为yyyy-MM-dd，需大于等于当前时间
	BeginTime string `json:"begin_time,omitempty"`
	// EndTime 投放结束时间; 格式为yyyy-MM-dd，不传值表示从今天开始长期投放，传值表示设置开始时间和结束时间，且投放结束时间需大于等于投放开始时间
	EndTime string `json:"end_time,omitempty"`
	// ScheduleTime 投放时间段; 格式为24*7位字符串，且都为0和1，以一个小时为最小粒度，从周一零点开始至周日24点结束；0为不投放，1为投放，不传/全传1/全传0视为全时段投放
	ScheduleTime string `json:"schedule_time,omitempty"`
	// DayBudget 单日预算; 单位：厘，指定0表示预算不限，默认为0；每天不小于100元，不超过100000000元，仅支持输入数字；修改预算不得低于该广告组当日花费的120%，与day_budget_schedule不能同时传，均不能低于组出价
	DayBudget int64 `json:"day_budget,omitempty"`
	// DayBudgetSchedule 分日预算; 单位：厘，指定0表示预算不限，默认为0；每天不小于500元，不超过100000000元，仅支持输入数字；修改预算不得低于该计划当日花费的120%，与day_budget不能同时传，均不能低于该计划下任一广告组出价
	DayBudgetSchedule []int64 `json:"day_budget_schedule,omitempty"`
	// ConvertID 转化目标ID; 可通过下方【转化目标查询接口】获得，不同计划类型需要对应各自的转化目标类型：提升应用安装(campaign_type=2) - 安卓：convert_type:3、7 / IOS：convert_type:7；推广品牌活动(campaign_type=4) / 收集销售线索(campaign_type=5)：convert_type:1、2
	ConvertID int `json:"convert_id,omitempty"`
	// UrlType url类型; 当计划类型为：3（获取电商下单）时必填：1 - 淘宝商品短链；2 - 淘宝商品itemID；4 - 金牛电商
	UrlType int `json:"url_type,omitempty"`
	// WebUrlType url类型; 当计划类型为5（收集销售线索）&使用建站时必填：需使用魔力建站；不传默认1，2：落地页
	WebUrlType int `json:"web_url_type,omitempty"`
	// URL 投放链接; 当计划类型是3/4/5时必填；长度不超过1000字符；计划类型是3（获取电商下单）：金牛商品ID（必须为数字）；计划类型是4（推广品牌活动）：落地页URL；计划类型是5（收集销售线索）：落地页URL；计划类型是5（收集销售线索）：建站ID，通过/rest/openapi/v2/lp/page/list获取。「房地产」「家装建材」「招商加盟」三个二级行业【收集销售线索】目标下隐藏客户自有链接填写入口。
	URL string `json:"url,omitempty"`
	// SchemaUri 调起链接; 提升应用活跃营销目标的调起链接；应用推广下在已经安装app的用户手机上可以拉起app（需要运营加白）
	SchemaUri string `json:"schema_uri,omitempty"`
	// AppID 应用ID; 当计划类型为2时必填，可通过应用列表接口获取应用ID；为9时且detail_unit_type为0、2时必填
	AppID uint64 `json:"app_id,omitempty"`
	// ShowMode 创意展现方式; 1 - 轮播；2 - 优选
	ShowMode int `json:"show_mode,omitempty"`
	// Speed 投放方式; 1 - 加速投放；2 - 平滑投放；3-优先低成本（投放时间范围只可为全天；预算不可为不限或空）
	Speed int `json:"speed,omitempty"`
	// SiteType 预约广告; 1:IOS预约缺省为不传或传0
	SiteType int `json:"site_type,omitempty"`
	// GiftData 游戏礼包码; "gift_data": {}，仅支持计划类型为 2
	GiftData *GiftData `json:"gift_data,omitempty"`
	// VideoLandingPage 是否使用落地页前置功能; true: 使用 false：不使用，不填使用系统默认值（只支持双feed流，推广品牌活动-落地页url填写、获取电商下单-淘客短链url填写、获取电商下单-金牛活动页、获取销售线、获取销售线索）
	VideoLandingPage bool `json:"video_landing_page,omitempty"`
	// AutoTarget 智能定向; 若开启智能定向，定向部分仅保留地域+年龄+性别+排除人群+系统纬度的定向，其他定向纬度暂不支持（报错处理）true表示开启，false表示未开启
	AutoTarget bool `json:"auto_target,omitempty"`
	// AutoCreatePhoto 是否开启自动生成视频; 加白使用
	AutoCreatePhoto bool `json:"auto_create_photo,omitempty"`
	// ItemID 电商关联Id (小店通); 1. merchantItemType为0时填写小店商品id 2. merchantItemType为2时不用填写，系统补充
	ItemID uint64 `json:"item_id,omitempty"`
	// MerchantItemPutType 电商广告投放类型（小店通）; 0: 商品 2: 个人主页
	MerchantItemPutType int `json:"merchant_item_put_type,omitempty"`
	// FictionID 小说ID; 仅支持“提升应用安装”、“收集销售线索”以及“提高应用活跃”三种计划类型，且一旦绑定，不可修改。此参数仅是绑定小说，并非自动关联小说生成的落地页，如需推广小说生成的落地页，请使用小说ID获取其生成的建站落地页后将落地页ID一并传入即可（落地页ID传参与之前建站落地页ID字段一致）
	FictionID uint64 `json:"fiction_id,omitempty"`
	// SmartCover 程序化创意2.0智能抽帧; 是否开启智能抽帧; unit_type=7选填
	SmartCover bool `json:"smart_cover,omitempty"`
	// AssetMining 程序化创意2.0素材挖掘; 是否开启历史素材挖掘
	AssetMining bool `json:"asset_mining,omitempty"`
	// ConsultID 咨询组件id; 1、仅可被用于线索类计划下的unit；2、仅当落地页使用了建站落地页时可使用；3、注意本字段不可被更新；4、本属性不可与附加表单组件(component_id)同时使用
	ConsultID uint64 `json:"consult_id,omitempty"`
	// AdvCardOption 高级创意开关; 0：关闭 1:开启
	AdvCardOption int `json:"adv_card_option,omitempty"`
	// AdvCardList 绑定卡片id; card_type=100为1个；card_type=101为3个；card_type=102为3个；card_type=103为1个
	AdvCardList []uint64 `json:"adv_card_list,omitempty"`
	// CardType 卡片类型; 100:图片卡片 101:多利益卡-图文 102：多利益卡-多标签 103：电商促销样式 104：快捷评论卡
	CardType int `json:"card_type,omitempty"`
	// MerchandiseID 商品ID，且一旦绑定，不可修改; 此参数用于绑定商品（绑定商品类型受merchandise_type字段控制），与 fiction_id 字段互斥。merchandise_type=2，merchandise_id 为课程ID，仅支持“收集销售线索”计划类型，且一旦绑定不可修改
	MerchandiseID uint64 `json:"merchandise_id,omitempty"`
	// MerchandiseType 选填; 与 merchandise_id 共同使用，merchandise_type=2，merchandise_id 为课程ID，仅支持“收集销售线索”计划类型，且一旦绑定不可修改
	MerchandiseType int `json:"merchandise_type,omitempty"`
	// IntentionTarget 行为意向-系统优选; 行为意向是否开启系统优选，智能定向和行为意向系统优选不能同时开启
	IntentionTarget bool `json:"intention_target,omitempty"`
	// DpaUnitParam DPA相关商品信息; 当子计划类型为sdpa时必填
	DpaUnitParam *DpaUnitParam `json:"dpa_unit_param,omitempty"`
	// BehaviorInterest 行为兴趣定向; behavior.keyword 、behavior.label、interest.lable 其中一个必传，具体传值下方表格
	BehaviorInterest *target.BehaviorInterest `json:"behavior_interest,omitempty"`
	// Target 定向数据 必填
	Target *target.Target `json:"target"`
}

CreateRequest 创建广告组APIRequest

func (CreateRequest) Encode added in v1.0.5 

func (r CreateRequest) Encode() []byte

Encode implement PostRequest interface

func (CreateRequest) Url added in v1.0.5 

func (r CreateRequest) Url() string

Url implement PostRequest interface

type CreateResponse added in v1.0.5 

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

CreateResponse 创建广告组 API Response

type CreateUnionRequest added in v1.0.6 

type CreateUnionRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CampaignID 广告计划ID
	CampaignID uint64 `json:"campaign_id,omitempty"`
	// UnitName 广告组名称; 长度为1-100个字符，同一个计划下的广告组名称不能重复
	UnitName string `json:"unit_name,omitempty"`
	// BidType 优化目标出价类型; 1: CPM 2: CPC 10:OCPM 4: CPA只有计划类型为3，url_type=4才支持，而且ocpx_action_type只能为表单提交53)
	BidType int `json:"bid_type,omitempty"`
	// Bid 出价; bid_type为CPC/eCPC/CPM时该字段必填，单位：厘，不得低于0.2元，不得高于100元，不得高于组预算
	Bid int64 `json:"bid,omitempty"`
	// CpaBid 出价; bid_type是OCPM时该字段必填，单位：厘，ocpx_action_type为2时，不得低于1元，不得高于3000元；ocpx_action_type为180时，不得低于1元，不得高于3000元，ocpx_action_type为53时，不得低于5元，不得高于3000元；不得高于组预算
	CpaBid int64 `json:"cpa_bid,omitempty"`
	// OcpxActionType 优化目标;
	// bid_type是OCPM时该字段必填；2：行为数（actionBar点击）；180：激活数；53：表单数；190: 付费；191：首日ROI；324：唤起应用（campaign_type=7+主站+加白）；348：有效线索；383: 授信；384: 完件394：订单提交；（计划类型获取电商下单，非金牛）；396：注册（联盟暂不支持）；715：微信复制优化目标；（campaign_type=5&bid_type=10）；716：多转化事件(campaign_type=5&bid_type=10&使用魔力建站&线索转化类组件>=2种)；717：广告观看次数(campaign_type=2&bid_type=10&appi与转化追踪工具联调过或者该广告主的在相应事件的回传数>=1）需通过接口「rest/openapi/v1/ad_unit/ocpc/conversion_infos」获取是否可以选择「激活」、「表单转化」、「付费」、「授信」、「完件」的优化目标;731：广告观看5次；732：广告观看10次；733：广告观看20次；773：关键行为；774：7日ROI；72：小店通商品和主页推广，转化目标“涨粉”；392：小店通商品推广，优化目标“转化数”，转化目标“商品访问”；395：小店通商品和主页推广，转化目标“订单支付”，62：直播观看数,（小店直播推广&商品推广支持，计划type=14、13）;192：直播推广ROI；小店直播推广&商品推广支持，计划type=14、13）;403：近似购买（小店直播推广&商品推广支持，计划type=14、13）。需通过接口「获取可选的深度转化类型」，接口is_order_paied字段返回值为1才可以使用;
	OcpxActionType int `json:"ocpx_action_type,omitempty"`
	// DeepConversionType 深度转化目标;
	// 3:付费，7:次日留存，10:完件, 11:授信；13:添加购物车；14:提交订单；15:购买；44：有效线索；92：付费roi。可通过下方深度转化信息查询接口获取当前账户可选的深度转化目标
	DeepConversionType int `json:"deep_conversion_type,omitempty"`
	// DeepConversionBid 深度转化目标出价; 单位：厘，仅当deep_conversion_type可用且账户满足白名单时选填，出价需大于cpa_bid，小于min{组预算，3000元}，不得高于组预算，不支持从0改为其他值，也不支持从其他值改为0
	DeepConversionBid int64 `json:"deep_conversion_bid,omitempty"`
	// SceneID 资源位置; 5：联盟广告；10：联盟优选 3、6、7、10可多选；当账户在联盟优选白名单中且campaign_type = 2/3/5/7，可传10；；当账户不在联盟优选白名单中或campaign_type不等于2/3/5/7时，不可传10；
	SceneID []int `json:"scene_id,omitempty"`
	// UnitType 创意制作方式; 4: 自定义；5：程序化创意 7：程序化创意2.0
	UnitType int `json:"unit_type,omitempty"`
	// BeginTime 投放开始时间; 格式为yyyy-MM-dd，需大于等于当前时间
	BeginTime string `json:"begin_time,omitempty"`
	// EndTime 投放结束时间; 格式为yyyy-MM-dd，不传值表示从今天开始长期投放，传值表示设置开始时间和结束时间，且投放结束时间需大于等于投放开始时间
	EndTime string `json:"end_time,omitempty"`
	// ScheduleTime 投放时间段; 格式为24*7位字符串，且都为0和1，以一个小时为最小粒度，从周一零点开始至周日24点结束；0为不投放，1为投放，不传/全传1/全传0视为全时段投放
	ScheduleTime string `json:"schedule_time,omitempty"`
	// DayBudget 单日预算; 单位：厘，指定0表示预算不限，默认为0；每天不小于100元，不超过100000000元，仅支持输入数字；修改预算不得低于该广告组当日花费的120%，与day_budget_schedule不能同时传，均不能低于组出价
	DayBudget int64 `json:"day_budget,omitempty"`
	// DayBudgetSchedule 分日预算; 单位：厘，指定0表示预算不限，默认为0；每天不小于500元，不超过100000000元，仅支持输入数字；修改预算不得低于该计划当日花费的120%，与day_budget不能同时传，均不能低于该计划下任一广告组出价
	DayBudgetSchedule []int64 `json:"day_budget_schedule,omitempty"`
	// ConvertID 转化目标ID; 计划类型为2时不支持；计划类型为5时仅支持【JS代码】的转化目标
	ConvertID int `json:"convert_id,omitempty"`
	// URL 投放链接; 当计划类型是3/4/5时必填；长度不超过1000字符；计划类型是3（获取电商下单）：金牛商品ID（必须为数字）；计划类型是4（推广品牌活动）：落地页URL；计划类型是5（收集销售线索）：落地页URL；计划类型是5（收集销售线索）：建站ID，通过/rest/openapi/v2/lp/page/list获取。「房地产」「家装建材」「招商加盟」三个二级行业【收集销售线索】目标下隐藏客户自有链接填写入口。
	URL string `json:"url,omitempty"`
	// AppID 应用ID; 当计划类型为2时必填，可通过应用列表接口获取应用ID；为9时且detail_unit_type为0、2时必填
	AppID uint64 `json:"app_id,omitempty"`
	// ShowMode 创意展现方式; 1 - 轮播；2 - 优选
	ShowMode int `json:"show_mode,omitempty"`
	// Speed 投放方式; 1 - 加速投放；2 - 平滑投放；3-优先低成本（投放时间范围只可为全天；预算不可为不限或空）
	Speed int `json:"speed,omitempty"`
	// PlayableOrientation 试玩素材的横竖适配; 默认值为-1；0:横竖均可；1:竖屏；2:横屏
	PlayableOrientation int `json:"playable_orientation,omitempty"`
	// PlayableUrl 试玩的url
	PlayableUrl string `json:"playable_url,omitempty"`
	// PlayableSwitch 试玩广告的开关; 默认值为0；1:关闭；2:开启
	PlayableSwitch int `json:"playalbe_switch_omitempty"`
	// Target 定向数据
	Target *target.Target `json:"target,omitempty"`
}

CreateUnionRequest 创建联盟定投广告组APIRequest

func (CreateUnionRequest) Encode added in v1.0.6 

func (r CreateUnionRequest) Encode() []byte

Encode implement PostRequest interface

func (CreateUnionRequest) Url added in v1.0.6 

func (r CreateUnionRequest) Url() string

Url implement PostRequest interface

type CreateUnionResponse added in v1.0.6 

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

CreateUnionResponse 创建联盟定投广告组API Response

type DeepConversionType added in v1.0.6 

type DeepConversionType struct {
	// Desc 深度转化类型描述
	Desc string `json:"desc,omitempty"`
	// DeepConversionType 深度转化类型
	DeepConversionType int `json:"deep_conversion_type,omitempty"`
}

DeepConversionType 深度转化类型

type DiverseData 

type DiverseData struct {
	// AppName 应用名称
	AppName string `json:"app_name,omitempty"`
	// AppPackageName 应用包名
	AppPackageName string `json:"app_package_name,omitempty"`
	// DeviceOsType 应用操作系统类型; 0：未知，1：ANDROID，2：IO
	DeviceOsType int `json:"device_os_type,omitempty"`
}

DiverseData 应用信息

type DpaUnitParam added in v1.0.5 

type DpaUnitParam struct {
	// LibraryID 商品库ID; 当子计划类型为sdpa时必填
	LibraryID uint64 `json:"library_id,omitempty"`
	// OuterID 外部商品ID
	OuterID string `json:"outer_id,omitempty"`
	// DetailUnitType 商品链接类型; 0：app下载，1：H5跳转，2：Deeplink唤起，当计划类型为sdpa时必填
	DetailUnitType int `json:"detail_unit_type"`
	// ProductID 快手商品ID; 当计划子类型为sdpa时必填
	ProductID string `json:"product_id,omitempty"`
	// ClickUrl 点击跳转监控链接
	ClickUrl string `json:"click_url,omitempty"`
	// ActionbarClickUrl actionbar点击跳转监控链接
	ActionbarClickUrl string `json:"actionbar_click_url,omitempty"`
	// ImpressionUrl 曝光监控链接;
	ImpressionUrl string `json:"impression_url,omitempty"`
}

DpaUnitParam DPA相关商品信息

type GiftData 

type GiftData struct {
	// TargetActionType 发送时机; android:30： 开始下载后 31：下载完成后 32：安装完成后 ios：2：检测到用户行为
	TargetActionType int `json:"target_action_type,omitempty"`
	// Code 礼包码; 最多20字符，只能字母+数字
	Code string `json:"code,omitempty"`
}

GiftData 游戏礼包码

type ListRequest 

type ListRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CampaignID 广告计划ID; 过滤筛选条件，若不传或传空则视为无限制条件
	CampaignID uint64 `json:"campaign_id,omitempty"`
	// CampaignType 广告计划类型;过滤筛选条件；2 - 提升应用安装;3 - 获取电商下单;4 - 推广品牌活动;5 - 收集销售线索;
	CampaignType int `json:"campaign_type,omitempty"`
	// UnitID 广告组ID; 过滤筛选条件，若不传或传空则视为无限制条件
	UnitID uint64 `json:"unit_id,omitempty"`
	// UnitName 广告组名称
	UnitName string `json:"unit_name,omitempty"`
	// UnitIDs 广告组ID集
	UnitIDs []uint64 `json:"unit_ids,omitempty"`
	// Status 广告组状态;过滤筛选条件；-1：不限，1：计划已暂停，3：计划超预算，6：余额不足，11：审核中，12：审核未通过，14：已结束，15：已暂停，17：组超预算，19：未达投放时间，20：有效-2，22：不在投放时段。所有包含已删除10：只包含已删除不传：所有不包含已删除 其他值无效
	Status int `json:"status,omitempty"`
	// AppName 应用名称; 过滤筛选条件，支持模糊搜索
	AppName string `json:"app_name,omitempty"`
	// StartDate 开始时间;与end_date同时传或同时不传；过滤筛选条件，格式为"yyyy-MM-dd"，参数值对应update_time信息
	StartDate string `json:"start_date,omitempty"`
	// EndDate 结束时间; 与start_date同时传或同时不传；过滤筛选条件，格式为"yyyy-MM-dd"，参数值对应update_time信息
	EndDate string `json:"end_date,omitempty"`
	// TimeFilterType 按创建时间，还是更新时间进行筛选; 1.如传入此字段时不传"start_date"，与"end_date"字段，则不根据时间筛选。2.传入"start_date"，与"end_date"字段，且此字段为1时，按照创建时间进行筛选。3.传入"start_date"，与"end_date"字段，此字段不传，或传值为0时，则按照更新时间进行筛选
	TimeFilterType int `json:"time_filter_type,omitempty"`
	// Page 请求的页码数 默认为1
	Page int `json:"page,omitempty"`
	// PageSize 请求的每页行数; 默认为20
	PageSize int `json:"page_size,omitempty"`
	// ReviewStatusList 单元审核状态筛选	1：待审核；2：审核通过；3：审核失败；7：待送审
	ReviewStatusList []int `json:"review_status_list,omitempty"`
	// PutStatusList 单元投放状态筛选	1：投放；2：暂停；3：删除
	PutStatusList []int `json:"put_status_list,omitempty"`
}

ListRequest 获取广告组信息 API Request

func (ListRequest) Encode 

func (r ListRequest) Encode() []byte

Encode implement PostRequest interface

func (ListRequest) Url 

func (r ListRequest) Url() string

Url implement PostRequest interface

type ListResponse 

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

ListResponse 获取广告组信息 API Response

type OcpcConversionInfosRequest added in v1.0.6 

type OcpcConversionInfosRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CampaignType 计划类型
	CampaignType int `json:"campaign_type,omitempty"`
	// AppID 应用id campaign_type=2/7该参数必填
	AppID uint64 `json:"app_id,omitempty"`
}

OcpcConversionInfosRequest 获取可选的深度转化目标 API Request

func (OcpcConversionInfosRequest) Encode added in v1.0.6 

func (r OcpcConversionInfosRequest) Encode() string

Encode implement GetRequest interface

func (OcpcConversionInfosRequest) Url added in v1.0.6 

func (r OcpcConversionInfosRequest) Url() string

Url implement GetRequest interface

type OcpcConversionInfosResponse added in v1.0.6 

type OcpcConversionInfosResponse struct {
	// IsActivate 是否有激活出价权限
	IsActivate int `json:"is_activate,omitempty"`
	// IsFormSubmit 是否有表单出价权限
	IsFormSubmit int `json:"is_form_submit,omitempty"`
	// IsCreditGrant 是否有授信出价权限
	IsCreditGrant int `json:"is_credit_grant,omitempty"`
	// IsPurchase 是否有付费出价权限
	IsPurchase int `json:"is_purchase,omitempty"`
	// IsWanJian 是否有完件出价权限
	IsWanJian int `json:"is_wan_jian,omitempty"`
	// IsValidClue 是否可以使用有效线索
	IsValidClue int `json:"is_valid_clue,omitempty"`
	// IsFirstdayRoi 是否可以使用首日ROI
	IsFirstdayRoi int `json:"is_firstday_roi,omitempty"`
	// IsRegister 是否可以使用注册优化目标
	IsRegister int `json:"is_register,omitempty"`
	// IsOrderSubmit 是否可以使用订单提交优化目标
	IsOrderSubmit int `json:"is_order_submit,omitempty"`
	// IsAddWechat 是否可用微信复制
	IsAddWechat int `json:"is_add_wechat,omitempty"`
	// IsAppInvoked 是否可以使用唤起应用优化目标
	IsAppInvoked int `json:"is_app_invoked,omitempty"`
	// IsMultiConversion 是否可用多转化事件
	IsMultiConversion int `json:"is_multi_conversion,omitempty"`
	// IsAdWatchTimes 是否可用广告观看次数
	IsAdWatchTimes int `json:"is_ad_watch_times,omitempty"`
	// IsOrderPaid 是否可以使用订单支付转化目标
	IsOrderPaid int `json:"is_order_paid,omitempty"`
	// IsSevenDayRoi 是否可以使用7日ROI目标
	IsSevenDayRoi int `json:"is_seven_day_roi,omitempty"`
	// IsKeyAction 是否可以使用关键行为目标
	IsKeyAction int `json:"is_key_action,omitempty"`
	// DeepConversionTypes 深度转化类型
	DeepConversionTypes []DeepConversionType `json:"deep_conversion_types,omitempty"`
}

OcpcConversionInfosResponse 获取可选的深度转化目标 API Response

type PageGroupDetail added in v1.2.1 

type PageGroupDetail struct {
	// GroupID 程序化落地页组ID
	GroupID string `json:"group_id,omitempty"`
	// GroupName 程序化落地页组名称
	GroupName string `json:"group_name,omitempty"`
	// PagePreviewDetail 程序化落地页组下的页面信息
	PagePreviewDetail []PagePreviewDetail `json:"page_preview_detail,omitempty"`
}

PageGroupDetail 程序化落地页信息

type PagePreviewDetail added in v1.2.1 

type PagePreviewDetail struct {
	// PageID 落地页ID
	PageID string `json:"page_id,omitempty"`
	// ReviewStatus 落地页审核状态	1-审核中 2-审核通过 3-审核拒绝
	ReviewStatus int `json:"review_status,omitempty"`
	// ReviewDetail 落地页的审核拒绝理由
	ReviewDetail string `json:"review_detail,omitempty"`
	// URL 落地页URL信息
	URL string `json:"url,omitempty"`
}

PagePreviewDetail 程序化落地页组下的页面信息

type Schedule 

type Schedule struct {
	// Mon 周一时间段; 时间段范围0, 23
	Mon []int `json:"mon,omitempty"`
	// Tues 周二时间段; 时间段范围0, 23
	Tues []int `json:"tues,omitempty"`
	// Wed 周三时间段; 时间段范围0, 23
	Wed []int `json:"wed,omitempty"`
	// Thur 周四时间段; 时间段范围0, 23
	Thur []int `json:"thur,omitempty"`
	// Fri 周五时间段; 时间段范围0, 23
	Fir []int `json:"fir,omitempty"`
	// Sat 周六时间段; 时间段范围0, 23
	Sat []int `json:"sat,omitempty"`
	// Sun 周日时间段; 时间段范围0, 23
	Sun []int `json:"sun,omitempty"`
}

Schedule 投放时段 不投放的时段为null，详请见下方，历史字段，即将废弃

type Unit 

type Unit struct {
	// CampaignID 广告计划ID
	CampaignID uint64 `json:"campaign_id,omitempty"`
	// UnitID 广告组ID
	UnitID uint64 `json:"unit_id,omitempty"`
	// UnitName 广告组名称
	UnitName string `json:"unit_name,omitempty"`
	// Status 广告组状态（优先看看这个状态，计算结果）; -1：不限，1：计划已暂停，3：计划超预算，6：余额不足，，11：审核中，12：审核未通过，14：已结束，15：已暂停，17：组超预算，19：未达投放时间，20：有效
	Status int `json:"status,omitempty"`
	// PutStatus 投放状态（操作结果）;1：投放中；2：暂停 3：删除
	PutStatus int `json:"put_status,omitempty"`
	// CreateChannel 创建渠道; 0：投放后台创建；1：Marketing API创建
	CreateChannel int `json:"create_channel,omitempty"`
	// ReviewDetail 审核拒绝理由;
	ReviewDetail string `json:"review_detail,omitempty"`
	// StudyStatus 学习期;1:学习中,2:学习成功,3:学习失败
	StudyStatus int `json:"study_status,omitempty"`
	// CompensateStatus 赔付状态; 0=不需要赔付(不需要展示赔付标志)，1=成本保障生效中，2=成本保证确认中，3=已赔付完成，4=已失效
	CompensateStatus int `json:"compensate_status,omitempty"`
	// BidType 出价类型; 1：CPM，2：CPC，6：OCPC(使用OCPC代表OCPX)，10：OCPM，20：eCPC
	BidType int `json:"bid_type,omitempty"`
	// Bid 出价; 单位：厘
	Bid int64 `json:"bid,omitempty"`
	// CpaBid OCPC出价; 单位：厘
	CpaBid int64 `json:"cpa_bid,omitempty"`
	// SmartBid 优先低成本是否自动出价; 0：手动出价，1：自动出价
	SmartBid int `json:"smart_bid,omitempty"`
	// OcpxActionType 优化目标; 0：未知，2：点击转化链接，10：曝光，11：点击，31：下载完成，53：提交线索，180：激活，190: 付费，191：首日ROI，348：有效线索，383: 授信，384: 完件 715：微信复制
	OcpxActionType int `json:"ocpx_action_type"`
	// DeepConversionType 深度转化目标; 3: 付费，7: 次日留存，10: 完件, 11: 授信 ，0：无
	DeepConversionType int `json:"deep_conversion_type,omitempty"`
	// DeepConversionBid 深度转化目标出价; 白名单功能，单位：厘
	DeepConversionBid int64 `json:"deep_conversion_bid,omitempty"`
	// DayBudget 单日预算; 单位：厘
	DayBudget int64 `json:"day_budget,omitempty"`
	// DayBudgetSchedule 分日预算; 单位：厘，单日预算和分日预算同时存在时，以分日预算为准
	DayBudgetSchedule []int64 `json:"day_budget_schedule,omitempty"`
	// RoiRatio 付费ROI系数; 优化目标为「首日ROI」时必填：ROI系数取值范围 ( 0,100 ] 最多支持到三位小数（如：0.066）
	RoiRatio float64 `json:"roi_ratio,omitempty"`
	// Speed 投放方式; 0：未知，1：正常投放，2：平滑投放，3：优先低成本。
	Speed int `json:"speed,omitempty"`
	// BeginTime 投放开始时间; 格式：yyyy-MM-dd
	BeginTime string `json:"begin_time,omitempty"`
	// EndTime 投放结束时间; 格式：yyyy-MM-dd,排期不限为null
	EndTime string `json:"end_time,omitempty"`
	// Schedule 投放时段
	Schedule *Schedule `json:"schedule,omitempty"` // 不投放的时段为null，详请见下方，历史字段，即将废弃
	// ScheduleTime 投放时段; 24*7的字符串，0为不投放，1为投放，例如：0010000000001....0000
	ScheduleTime string `json:"schedule_time,omitempty"`
	// SceneID 广告位; 1：优选广告位；2：按场景选择广告位-信息流广告（旧广告位，包含上下滑大屏广告）；3：视频播放页广告-便利贴广告；6：上下滑大屏广告；7：信息流广告（不包含上下滑大屏广告）10：激励视频；11：快看点场景
	SceneID []int `json:"scene_id,omitempty"`
	// ShowMode 创意展现方式; 0：未知，1：轮播，2：优选
	ShowMode int `json:"show_mode,omitempty"`
	// UnitType 创意制作方式; 4: 自定义；5：程序化创意 7：程序化创意2.0
	UnitType int `json:"unit_type,omitempty"`
	// ConvertID 转化目标
	ConvertID int `json:"convert_id,omitempty"`
	// UseAppMarket 优先从系统应用商店下载; 0：未设置 1：优先从系统应用商店下载使用
	UseAppMarket int `json:"use_app_market,omitempty"`
	// AppStore 应用商店列表
	AppStore []string `json:"app_store,omitempty"`
	// UrlType url类型; 当计划类型为3时（获取电商下单）时有返回。1：淘宝商品短链 2：淘宝商品itemID
	UrlType int `json:"url_type,omitempty"`
	// WebUriType url类型; 当计划类型为5（收集销售线索）&使用建站时有返回：需使用魔力建站 不传默认1，2：落地页
	WebUriType int `json:"web_uri_type,omitempty"`
	// Url 落地页链接; 计划类型是 2（提升应用安装）：返回应用下载地址；计划类型是 3（获取电商下单）：根据url_type返回相应信息；计划类型是 4（推广品牌活动）：返回落地页url计划类型是 5（收集销售线索）：返回落地页url计划类型是5（收集销售线索）：建站idl
	Url string `json:"url,omitempty"`
	// SchemaUri 调起链接; 提升应用活跃营销目标的调起链接
	SchemaUri string `json:"schema_uri,omitempty"`
	// AppID 应用ID
	AppID uint64 `json:"app_id,omitempty"`
	// AppIconUrl APP图标存储地址
	AppIconUrl string `json:"app_icon_url,omitempty"`
	// DiverseData 应用信息
	DiverseData *DiverseData `json:"diverse_data,omitempty"`
	// Target 定向数据
	Target *target.Target `json:"target,omitempty"`
	// SiteType 预约广告; 1:IOS预约 缺省为不传或传0
	SiteType int `json:"site_type,omitempty"`
	// GiftData 游戏礼包码; 联盟广告暂不支持
	GiftData *GiftData `json:"gift_data,omitempty"`
	// VideoLandingPage 是否使用落地页前置功能; true: 使用 false：不使用
	VideoLandingPage bool `json:"video_landing_page,omitempty"`
	// AutoTarget 智能定向; 若开启智能定向，定向部分仅保留地域+年龄+性别+排除人群+系统纬度的定向，其他定向纬度暂不支持（报错处理）true表示开启，false表示未开启
	AutoTarget bool `json:"auto_target,omitempty"`
	// SmartCover 程序化创意2.0智能抽帧; 是否开启智能抽帧
	SmartCover bool `json:"smart_cover,omitempty"`
	// AssetMining 程序化创意2.0素材挖掘; 是否开启历史素材挖掘
	AssetMining bool `json:"asset_mining,omitempty"`
	// AutoCreatePhoto 是否开启自动生成视频
	AutoCreatePhoto bool `json:"auto_create_photo,omitempty"`
	// UpdateTime 最后修改时间
	UpdateTime string `json:"update_time,omitempty"`
	// ItemID 电商关联Id (小店通); 1. merchantItemType为0时表示小店商品id; 2. merchantItemType为2时表示快手id
	ItemID uint64 `json:"item_id,omitempty"`
	// FictionID 小说ID; 仅支持“提升应用安装”、“收集销售线索”以及“提高应用活跃”三种计划类型，且一旦绑定，不可修改。此参数仅是绑定小说，并非自动关联小说生成的落地页，如需推广小说生成的落地页，请使用小说ID获取其生成的建站落地页后将落地页ID一并传入即可（落地页ID传参与之前建站落地页ID字段一致）
	FictionID uint64 `json:"fiction_id,omitempty"`
	// MerchantItemPutType 电商广告投放类型（小店通）; 0: 商品; 2: 个人主页
	MerchantItemPutType int `json:"merchant_item_put_type,omitempty"`
	// ConsultID 是否使用了咨询组件; 0=未使用，1=使用；注，咨询组件仅在收集销售线索计划(campaign_type=5)下可用，且使用了咨询组件后，可用的行动号召按钮限于接口返回内容
	ConsultID int `json:"consult_id,omitempty"`
	// AdvCardOption 高级创意开关; 0：关闭 1:开启
	AdvCardOption int `json:"adv_card_option,omitempty"`
	// AdvCardList 高级创意列表
	AdvCardList []AdvCard `json:"adv_card_list,omitempty"`
	// BackflowForecast backflow_cv_lower：回流预估值的下限；backflow_cv_upper：回流预估值的上限；backflow_timestamp：本次回流预估数据的时间戳，13位毫秒时间戳
	BackflowForecast *BackflowForecast `json:"backflow_forecast,omitempty"`
	// MerchandiseID 商品ID，且一旦绑定，不可修改; 此参数用于绑定商品（绑定商品类型受merchandise_type字段控制），与 fiction_id 字段互斥。merchandise_type=2，merchandise_id 为课程ID，仅支持“收集销售线索”计划类型，且一旦绑定不可修改
	MerchandiseID uint64 `json:"merchandise_id,omitempty"`
	// MerchandiseType 课程类型; 与 merchandise_id 共同使用，merchandise_type=2，merchandise_id 为课程ID，仅支持“收集销售线索”计划类型，且一旦绑定不可修改
	MerchandiseType int `json:"merchandise_type,omitempty"`
	// PlayableOrientation 试玩素材的横竖适配; 默认值为-1；0:横竖均可；1:竖屏；2:横屏
	PlayableOrientation int `json:"playable_orientation,omitempty"`
	// PlayableUrl 试玩的url
	PlayableUrl string `json:"playable_url,omitempty"`
	// PlayableFileName 试玩广告的文件名
	PlayableFileName string `json:"playable_file_name,omitempty"`
	// PlayableSwitch 试玩广告的开关; 默认值为0；1:关闭；2:开启
	PlayableSwitch int `json:"playable_switch,omitempty"`
	// PlayableID 试玩 ID; 可选字段，开启试玩时存在，否则不存在。当用户上传试玩素材成功时返回，用于之后对于广告组中试玩创意的编辑操作。
	PlayableID uint64 `json:"playable_id,omitempty"`
	// PlayButton 试玩按钮文字内容; 开启试玩时存在，否则不存在，示例按钮内容如下：1：立即试玩；2：试玩一下；3：立即体验；4：免装试玩；5：免装体验。启用试玩时：默认“立即试玩”，未启用试玩时：内容为空。
	PlayButton string `json:"play_button,omitempty"`
	// LibraryID 商品库ID; sdpa类型广告组才会存在
	LibraryID uint64 `json:"library_id,omitempty"`
	// OuterID 商品ID; sdpa类型广告组才会存在
	OuterID string `json:"outer_id,omitempty"`
	// ProductID 商品ID; sdpa类型广告组才会存在
	ProductID model.Uint64 `json:"product_id,omitempty"`
	// ProductName 商品名称; sdpa类型广告组才会存在
	ProductName string `json:"product_name,omitempty"`
	// ProductPrice 商品价格; 单位：元，sdpa类型广告组才会存在
	ProductPrice float64 `json:"product_price,omitempty"`
	// ProductImage 商品主图; sdpa类型广告组才会存在
	ProductImage string `json:"product_image,omitempty"`
	// IntentionTarget 行为意向-系统优选; 行为意向是否开启系统优选，智能定向和行为意向系统优选不能同时开启
	IntentionTarget bool `json:"intention_target,omitempty"`
	// SplashAdSwitch 是否投放开屏广告位; true:投放，false：不投放
	SplashAdSwitch bool `json:"splash_ad_switch,omitempty"`
	// PageGroupDetail 程序化落地页信息; 广告组ID绑定的程序化落地页组信息
	PageGroupDetail PageGroupDetail `json:"page_group_detail,omitempty"`
	// JingleBellID 小铃铛组件id
	JingleBellID uint64 `json:"jingle_bell_id,omitempty"`
	// LiveUserID 主播id
	LiveUserID uint64 `json:"live_user_id,omitempty"`
	// AdType 广告计划类型 0:信息流，1:搜索
	AdType int `json:"ad_type,omitempty"`
	// ExtendSearch 智能扩词开启状态; false：关闭，true：开启
	ExtendSearch bool `json:"extend_search"`
	// UnitSource 广告组来源; 0:常规（非托管）、1:托管
	UnitSource int `json:"unit_source,omitempty"`
	// NegativeWord 搜索广告否词，搜索广告新增
	NegativeWord AdMarketNegativeWordParam `json:"negative_word,omitempty"`
	// QuickSearch 是否开启快投; 0:关闭、1:开启
	QuickSearch int `json:"quick_search,omitempty"`
	// TargetExplore 是否开启搜索人群探索; 0:关闭、1:开启
	TargetExplore int `json:"target_explore,omitempty"`
	// SchemaId 微信小程序外部调起链接; 目前只有收集营销线索计划下的联盟广告位该字段才有效
	SchemaId string `json:"schema_id,omitempty"`
	// CreateTime 创建时间
	CreateTime  string `json:"create_time,omitempty"`
	TemplateID  int    `json:"template_id,omitempty"`
	ComponentID int    `json:"component_id,omitempty"`
	UseSka      bool   `json:"use_ska,omitempty"`
}

Unit 广告组

type UpdateBidRequest added in v1.0.5 

type UpdateBidRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// UnitID 广告组ID
	UnitID uint64 `json:"unit_id,omitempty"`
	// Bid 出价; 广告组bid_type为CPC和eCPC时：不得低于0.2元，不得高于100元，单位：厘；广告组bid_type为OCPC时：行为出价不得低于1元；激活出价不得低于5元（白名单用户不得低于2元），单位：厘
	Bid int64 `json:"bid,omitempty"`
}

UpdateBidRequest 修改广告组出价 API Request

func (UpdateBidRequest) Encode added in v1.0.5 

func (r UpdateBidRequest) Encode() []byte

Encode implement PostRequest interface

func (UpdateBidRequest) Url added in v1.0.5 

func (r UpdateBidRequest) Url() string

Url implement PostRequest interface

type UpdateDayBudgetRequest added in v1.0.5 

type UpdateDayBudgetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// UnitID 广告组ID
	UnitID uint64 `json:"unit_id,omitempty"`
	// DayBudget 单日预算金额; 广告组单日预算金额，单位：厘，指定0表示预算不限，默认为0；不小于100元，不超过100000000元，仅支持输入数字；修改预算不得低于该广告组当日花费的120%
	DayBudget int64 `json:"day_budget,omitempty"`
	// DayBudgetSchedule 分日预算; 单位：厘，指定0表示预算不限，默认为0；每天不小于500元，不超过100000000元，仅支持输入数字；修改预算不得低于该计划当日花费的120%，与day_budget不能同时传，均不能低于该计划下任一广告组出价
	DayBudgetSchedule []int64 `json:"day_budget_schedule,omitempty"`
}

UpdateDayBudgetRequest 修改广告组预算

func (UpdateDayBudgetRequest) Encode added in v1.0.5 

func (r UpdateDayBudgetRequest) Encode() []byte

Encode implement PostRequest interface

func (UpdateDayBudgetRequest) Url added in v1.0.5 

func (r UpdateDayBudgetRequest) Url() string

Url implement PostRequest interface

type UpdateRequest added in v1.0.5 

type UpdateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// UnitID 广告组 ID
	UnitID uint64 `json:"unit_id,omitempty"`
	// CampaignID 广告计划ID
	CampaignID uint64 `json:"campaign_id,omitempty"`
	// UnitName 广告组名称; 长度为1-100个字符，同一个计划下的广告组名称不能重复
	UnitName string `json:"unit_name,omitempty"`
	// PutStatus 广告组的投放状态; 不填时，创建的广告组为投放状态；填2时，创建的广告组为暂停状态，其他值非法
	PutStatus int `json:"put_status,omitempty"`
	// TemplateID 定向模板id
	TemplateID uint64 `json:"template_id,omitempty"`
	// BidType 优化目标出价类型; 1: CPM 2: CPC 10:OCPM 4: CPA只有计划类型为3，url_type=4才支持，而且ocpx_action_type只能为表单提交53)
	BidType int `json:"bid_type"`
	// UseAppMarket 优先从系统应用商店下载; 下载模式：允许值：0，1；1：优先从系统应用商店下载使用，默认0。仅提升应用安装计划类型且选择的app为安卓才支持。
	UseAppMarket int `json:"use_app_market,omitempty"`
	// AppStore 应用商店列表; 华为：huawei, OPPO：oppo VIVO：vivo 小米：xiaomi；魅族：meizu；锤子：smartisan 只支持计划类型为 2 且应用是 Android 类型的推广
	AppStore []string `json:"app_store,omitempty"`
	// Bid 出价; bid_type为CPC/eCPC/CPM时该字段必填，单位：厘，不得低于0.2元，不得高于100元，不得高于组预算
	Bid int64 `json:"bid,omitempty"`
	// CpaBid 出价; bid_type是OCPM时该字段必填，单位：厘，ocpx_action_type为2时，不得低于1元，不得高于3000元；ocpx_action_type为180时，不得低于1元，不得高于3000元，ocpx_action_type为53时，不得低于5元，不得高于3000元；不得高于组预算
	CpaBid int64 `json:"cpa_bid,omitempty"`
	// SmartBid 优先低成本出价(设置条件); 当 speed 等于 3 时可用 ；0：手动出价，1：自动出价；1、当 smart_bid 为 1 时，cpa_bid 或 deep_conversion_bid 都不能设置值；2、快享和联盟不支持优先低成本，直接报错；3、优先低成本的 bid_type 只支持OCPM；4、优先低成本 必须设置统一预算或分日预算
	SmartBid int `json:"smart_bid,omitempty"`
	// OcpxActionType 优化目标;
	// bid_type是OCPM时该字段必填；2：行为数（actionBar点击）；180：激活数；53：表单数；190: 付费；191：首日ROI；324：唤起应用（campaign_type=7+主站+加白）；348：有效线索；383: 授信；384: 完件394：订单提交；（计划类型获取电商下单，非金牛）；396：注册（联盟暂不支持）；715：微信复制优化目标；（campaign_type=5&bid_type=10）；716：多转化事件(campaign_type=5&bid_type=10&使用魔力建站&线索转化类组件>=2种)；717：广告观看次数(campaign_type=2&bid_type=10&appi与转化追踪工具联调过或者该广告主的在相应事件的回传数>=1）需通过接口「rest/openapi/v1/ad_unit/ocpc/conversion_infos」获取是否可以选择「激活」、「表单转化」、「付费」、「授信」、「完件」的优化目标;731：广告观看5次；732：广告观看10次；733：广告观看20次；773：关键行为；774：7日ROI；72：小店通商品和主页推广，转化目标“涨粉”；392：小店通商品推广，优化目标“转化数”，转化目标“商品访问”；395：小店通商品和主页推广，转化目标“订单支付”，62：直播观看数,（小店直播推广&商品推广支持，计划type=14、13）;192：直播推广ROI；小店直播推广&商品推广支持，计划type=14、13）;403：近似购买（小店直播推广&商品推广支持，计划type=14、13）。需通过接口「获取可选的深度转化类型」，接口is_order_paied字段返回值为1才可以使用;
	OcpxActionType int `json:"ocpx_action_type,omitempty"`
	// DeepConversionType 深度转化目标;
	// 3:付费，7:次日留存，10:完件, 11:授信；13:添加购物车；14:提交订单；15:购买；44：有效线索；92：付费roi。可通过下方深度转化信息查询接口获取当前账户可选的深度转化目标
	DeepConversionType int `json:"deep_conversion_type,omitempty"`
	// RoiRatio 付费ROI系数; 优化目标为「首日ROI」时必填：ROI系数取值范围 ( 0,100 ] 最多支持到三位小数（如：0.066）
	RoiRatio float64 `json:"roi_ratio,omitempty"`
	// DeepConversionBid 深度转化目标出价; 单位：厘，仅当deep_conversion_type可用且账户满足白名单时选填，出价需大于cpa_bid，小于min{组预算，3000元}，不得高于组预算，不支持从0改为其他值，也不支持从其他值改为0
	DeepConversionBid int64 `json:"deep_conversion_bid,omitempty"`
	// SceneID 资源位置; 1：优选广告位（当账户在联盟优选白名单中且campaign_type=2/3/5/7时为主站&联盟优选广告位 ）；3：视频播放页广告-便利贴广告（不支持深度转化目标的优化）；5：联盟广告；6：上下滑大屏广告；7：信息流广告；10：联盟场景 3、6、7、10可多选;当账户在联盟优选白名单中且campaign_type = 2/3/5/7，可传10；;当账户不在联盟优选白名单中或campaign_type不等于2/3/5/7时，不可传10；
	SceneID []int `json:"scene_id,omitempty"`
	// UnitType 创意制作方式; 4: 自定义；5：程序化创意 7：程序化创意2.0
	UnitType int `json:"unit_type,omitempty"`
	// BeginTime 投放开始时间; 格式为yyyy-MM-dd，需大于等于当前时间
	BeginTime string `json:"begin_time,omitempty"`
	// EndTime 投放结束时间; 格式为yyyy-MM-dd，不传值表示从今天开始长期投放，传值表示设置开始时间和结束时间，且投放结束时间需大于等于投放开始时间
	EndTime string `json:"end_time,omitempty"`
	// ScheduleTime 投放时间段; 格式为24*7位字符串，且都为0和1，以一个小时为最小粒度，从周一零点开始至周日24点结束；0为不投放，1为投放，不传/全传1/全传0视为全时段投放
	ScheduleTime string `json:"schedule_time,omitempty"`
	// DayBudget 单日预算; 单位：厘，指定0表示预算不限，默认为0；每天不小于100元，不超过100000000元，仅支持输入数字；修改预算不得低于该广告组当日花费的120%，与day_budget_schedule不能同时传，均不能低于组出价
	DayBudget int64 `json:"day_budget,omitempty"`
	// DayBudgetSchedule 分日预算; 单位：厘，指定0表示预算不限，默认为0；每天不小于500元，不超过100000000元，仅支持输入数字；修改预算不得低于该计划当日花费的120%，与day_budget不能同时传，均不能低于该计划下任一广告组出价
	DayBudgetSchedule []int64 `json:"day_budget_schedule,omitempty"`
	// ConvertID 转化目标ID; 可通过下方【转化目标查询接口】获得，不同计划类型需要对应各自的转化目标类型：提升应用安装(campaign_type=2) - 安卓：convert_type:3、7 / IOS：convert_type:7；推广品牌活动(campaign_type=4) / 收集销售线索(campaign_type=5)：convert_type:1、2
	ConvertID int `json:"convert_id,omitempty"`
	// UrlType url类型; 当计划类型为：3（获取电商下单）时必填：1 - 淘宝商品短链；2 - 淘宝商品itemID；4 - 金牛电商
	UrlType int `json:"url_type,omitempty"`
	// WebUrlType url类型; 当计划类型为5（收集销售线索）&使用建站时必填：需使用魔力建站；不传默认1，2：落地页
	WebUrlType int `json:"web_url_type,omitempty"`
	// URL 投放链接; 当计划类型是3/4/5时必填；长度不超过1000字符；计划类型是3（获取电商下单）：金牛商品ID（必须为数字）；计划类型是4（推广品牌活动）：落地页URL；计划类型是5（收集销售线索）：落地页URL；计划类型是5（收集销售线索）：建站ID，通过/rest/openapi/v2/lp/page/list获取。「房地产」「家装建材」「招商加盟」三个二级行业【收集销售线索】目标下隐藏客户自有链接填写入口。
	URL string `json:"url,omitempty"`
	// SchemaUri 调起链接; 提升应用活跃营销目标的调起链接；应用推广下在已经安装app的用户手机上可以拉起app（需要运营加白）
	SchemaUri *string `json:"schema_uri,omitempty"`
	// AppID 应用ID; 当计划类型为2时必填，可通过应用列表接口获取应用ID；为9时且detail_unit_type为0、2时必填
	AppID uint64 `json:"app_id,omitempty"`
	// ShowMode 创意展现方式; 1 - 轮播；2 - 优选
	ShowMode int `json:"show_mode,omitempty"`
	// Speed 投放方式; 1 - 加速投放；2 - 平滑投放；3-优先低成本（投放时间范围只可为全天；预算不可为不限或空）
	Speed int `json:"speed,omitempty"`
	// SiteType 预约广告; 1:IOS预约缺省为不传或传0
	SiteType int `json:"site_type,omitempty"`
	// GiftData 游戏礼包码; "gift_data": {}，仅支持计划类型为 2
	GiftData *GiftData `json:"gift_data,omitempty"`
	// VideoLandingPage 是否使用落地页前置功能; true: 使用 false：不使用，不填使用系统默认值（只支持双feed流，推广品牌活动-落地页url填写、获取电商下单-淘客短链url填写、获取电商下单-金牛活动页、获取销售线、获取销售线索）
	VideoLandingPage *bool `json:"video_landing_page,omitempty"`
	// AutoTarget 智能定向; 若开启智能定向，定向部分仅保留地域+年龄+性别+排除人群+系统纬度的定向，其他定向纬度暂不支持（报错处理）true表示开启，false表示未开启
	AutoTarget *bool `json:"auto_target,omitempty"`
	// AutoCreatePhoto 是否开启自动生成视频; 加白使用
	AutoCreatePhoto *bool `json:"auto_create_photo,omitempty"`
	// ItemID 电商关联Id (小店通); 1. merchantItemType为0时填写小店商品id 2. merchantItemType为2时不用填写，系统补充
	ItemID uint64 `json:"item_id,omitempty"`
	// MerchantItemPutType 电商广告投放类型（小店通）; 0: 商品 2: 个人主页
	MerchantItemPutType *int `json:"merchant_item_put_type,omitempty"`
	// FictionID 小说ID; 仅支持“提升应用安装”、“收集销售线索”以及“提高应用活跃”三种计划类型，且一旦绑定，不可修改。此参数仅是绑定小说，并非自动关联小说生成的落地页，如需推广小说生成的落地页，请使用小说ID获取其生成的建站落地页后将落地页ID一并传入即可（落地页ID传参与之前建站落地页ID字段一致）
	FictionID uint64 `json:"fiction_id,omitempty"`
	// SmartCover 程序化创意2.0智能抽帧; 是否开启智能抽帧; unit_type=7选填
	SmartCover *bool `json:"smart_cover,omitempty"`
	// AssetMining 程序化创意2.0素材挖掘; 是否开启历史素材挖掘
	AssetMining *bool `json:"asset_mining,omitempty"`
	// ConsultID 咨询组件id; 1、仅可被用于线索类计划下的unit；2、仅当落地页使用了建站落地页时可使用；3、注意本字段不可被更新；4、本属性不可与附加表单组件(component_id)同时使用
	ConsultID uint64 `json:"consult_id,omitempty"`
	// AdvCardOption 高级创意开关; 0：关闭 1:开启
	AdvCardOption *int `json:"adv_card_option,omitempty"`
	// AdvCardList 绑定卡片id; card_type=100为1个；card_type=101为3个；card_type=102为3个；card_type=103为1个
	AdvCardList []uint64 `json:"adv_card_list,omitempty"`
	// CardType 卡片类型; 100:图片卡片 101:多利益卡-图文 102：多利益卡-多标签 103：电商促销样式 104：快捷评论卡
	CardType int `json:"card_type,omitempty"`
	// MerchandiseID 商品ID，且一旦绑定，不可修改; 此参数用于绑定商品（绑定商品类型受merchandise_type字段控制），与 fiction_id 字段互斥。merchandise_type=2，merchandise_id 为课程ID，仅支持“收集销售线索”计划类型，且一旦绑定不可修改
	MerchandiseID uint64 `json:"merchandise_id,omitempty"`
	// MerchandiseType 选填; 与 merchandise_id 共同使用，merchandise_type=2，merchandise_id 为课程ID，仅支持“收集销售线索”计划类型，且一旦绑定不可修改
	MerchandiseType int `json:"merchandise_type,omitempty"`
	// IntentionTarget 行为意向-系统优选; 行为意向是否开启系统优选，智能定向和行为意向系统优选不能同时开启
	IntentionTarget *bool `json:"intention_target,omitempty"`
	// Target 定向数据
	Target *target.Target `json:"target,omitempty"`
}

UpdateRequest 修改广告组APIRequest

func (UpdateRequest) Encode added in v1.0.5 

func (r UpdateRequest) Encode() []byte

Encode implement PostRequest interface

func (UpdateRequest) Url added in v1.0.5 

func (r UpdateRequest) Url() string

Url implement PostRequest interface

type UpdateResponse added in v1.0.5 

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

UpdateResponse 修改广告组 API Response

type UpdateStatusRequest added in v1.0.5 

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

UpdateStatusRequest 修改广告组状态 API Request

func (UpdateStatusRequest) Encode added in v1.0.5 

func (r UpdateStatusRequest) Encode() []byte

Encode implement PostRequest interface

func (UpdateStatusRequest) Url added in v1.0.5 

func (r UpdateStatusRequest) Url() string

Url implement PostRequest interface

type UpdateStatusResponse added in v1.0.5 

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

UpdateStatusResponse 修改广告组状态 API Response

type UpdateUnionRequest added in v1.0.6 

type UpdateUnionRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// UnitID 广告组ID
	UnionID uint64 `json:"union_id,omitempty"`
	// UnitName 广告组名称; 长度为1-100个字符，同一个计划下的广告组名称不能重复
	UnitName string `json:"unit_name,omitempty"`
	// BidType 优化目标出价类型; 1: CPM 2: CPC 10:OCPM 4: CPA只有计划类型为3，url_type=4才支持，而且ocpx_action_type只能为表单提交53)
	BidType int `json:"bid_type,omitempty"`
	// Bid 出价; bid_type为CPC/eCPC/CPM时该字段必填，单位：厘，不得低于0.2元，不得高于100元，不得高于组预算
	Bid int64 `json:"bid,omitempty"`
	// CpaBid 出价; bid_type是OCPM时该字段必填，单位：厘，ocpx_action_type为2时，不得低于1元，不得高于3000元；ocpx_action_type为180时，不得低于1元，不得高于3000元，ocpx_action_type为53时，不得低于5元，不得高于3000元；不得高于组预算
	CpaBid int64 `json:"cpa_bid,omitempty"`
	// DeepConversionBid 深度转化目标出价; 单位：厘，仅当deep_conversion_type可用且账户满足白名单时选填，出价需大于cpa_bid，小于min{组预算，3000元}，不得高于组预算，不支持从0改为其他值，也不支持从其他值改为0
	DeepConversionBid int64 `json:"deep_conversion_bid,omitempty"`
	// BeginTime 投放开始时间; 格式为yyyy-MM-dd，需大于等于当前时间
	BeginTime string `json:"begin_time,omitempty"`
	// EndTime 投放结束时间; 格式为yyyy-MM-dd，不传值表示从今天开始长期投放，传值表示设置开始时间和结束时间，且投放结束时间需大于等于投放开始时间
	EndTime string `json:"end_time,omitempty"`
	// ScheduleTime 投放时间段; 格式为24*7位字符串，且都为0和1，以一个小时为最小粒度，从周一零点开始至周日24点结束；0为不投放，1为投放，不传/全传1/全传0视为全时段投放
	ScheduleTime string `json:"schedule_time,omitempty"`
	// DayBudget 单日预算; 单位：厘，指定0表示预算不限，默认为0；每天不小于100元，不超过100000000元，仅支持输入数字；修改预算不得低于该广告组当日花费的120%，与day_budget_schedule不能同时传，均不能低于组出价
	DayBudget int64 `json:"day_budget,omitempty"`
	// URL 投放链接; 当计划类型是3/4/5时必填；长度不超过1000字符；计划类型是3（获取电商下单）：金牛商品ID（必须为数字）；计划类型是4（推广品牌活动）：落地页URL；计划类型是5（收集销售线索）：落地页URL；计划类型是5（收集销售线索）：建站ID，通过/rest/openapi/v2/lp/page/list获取。「房地产」「家装建材」「招商加盟」三个二级行业【收集销售线索】目标下隐藏客户自有链接填写入口。
	URL string `json:"url,omitempty"`
	// AppID 应用ID; 当计划类型为2时必填，可通过应用列表接口获取应用ID；为9时且detail_unit_type为0、2时必填
	AppID uint64 `json:"app_id,omitempty"`
	// ShowMode 创意展现方式; 1 - 轮播；2 - 优选
	ShowMode int `json:"show_mode,omitempty"`
	// Speed 投放方式; 1 - 加速投放；2 - 平滑投放；3-优先低成本（投放时间范围只可为全天；预算不可为不限或空）
	Speed int `json:"speed,omitempty"`
	// PlayableOrientation 试玩素材的横竖适配; 默认值为-1；0:横竖均可；1:竖屏；2:横屏
	PlayableOrientation int `json:"playable_orientation,omitempty"`
	// PlayableUrl 试玩的url
	PlayableUrl string `json:"playable_url,omitempty"`
	// PlayableSwitch 试玩广告的开关; 默认值为0；1:关闭；2:开启
	PlayableSwitch int `json:"playalbe_switch_omitempty"`
	// Target 定向数据
	Target *target.Target `json:"target,omitempty"`
}

UpdateUnionRequest 修改联盟定投广告组APIRequest

func (UpdateUnionRequest) Encode added in v1.0.6 

func (r UpdateUnionRequest) Encode() []byte

Encode implement PostRequest interface

func (UpdateUnionRequest) Url added in v1.0.6 

func (r UpdateUnionRequest) Url() string

Url implement PostRequest interface

type UpdateUnionResponse added in v1.0.6 

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

UpdateUnionResponse 修改联盟定投广告组API Response

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.