Documentation
¶
Overview ¶
Package rta RTA策略管理
Index ¶
- type GetInfoData
- type GetInfoRequest
- type GetInfoResponse
- type GetRequest
- type GetResponse
- type InterfaceInfo
- type Report
- type RtaExpGetRequest
- type RtaExpGetResponse
- type RtaExpLocalDailyGetFilter
- type RtaExpLocalDailyGetRequest
- type RtaExpLocalDailyGetResponse
- type RtaExpLocalHourlyGetRequest
- type RtaExpLocalHourlyGetResponse
- type RtaInfo
- type Scope
- type ScopeGetRequest
- type ScopeGetResponse
- type SetScopeRequest
- type StatusUpdateRequest
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GetInfoData ¶
type GetInfoData struct {
// InterfaceInfo RTA配置数据
InterfaceInfo *InterfaceInfo `json:"interface_info,omitempty"`
// RtaInfo RTA策略信息
RtaInfo *RtaInfo `json:"rta_info,omitempty"`
}
type GetInfoRequest ¶
type GetInfoRequest struct {
// AdvertiserID 广告主ID
AdvertiserID uint64 `json:"advertiser_id,omitempty"`
// CampaignID 广告组id,若传入,则拉取的是组维度的RTA策略
CampaignID uint64 `json:"campaign_id,omitempty"`
}
GetInfoRequest 获取RTA策略数据 API Request
func (GetInfoRequest) Encode ¶
func (r GetInfoRequest) Encode() string
Encode implement GetRequest interface
type GetInfoResponse ¶
type GetInfoResponse struct {
model.BaseResponse
Data *GetInfoData `json:"data,omitempty"`
}
GetInfoResponse 获取RTA策略数据 API Response
type GetRequest ¶
type GetRequest struct {
// AdvertiserID 广告主ID
AdvertiserID uint64 `json:"advertiser_id,omitempty"`
}
GetRequest 获取可用的RTA策略 API Request
func (GetRequest) Encode ¶
func (r GetRequest) Encode() string
Encode implement GetRequest interface
type GetResponse ¶
type GetResponse struct {
model.BaseResponse
Data struct {
// List 可用的RTA策略列表
List []RtaInfo `json:"list,omitempty"`
} `json:"data,omitempty"`
}
GetResponse 获取可用的RTA策略 API Response
type InterfaceInfo ¶
type InterfaceInfo struct {
// Status 接口地址状态
// 1:生效 0:失效
Status int `json:"status,omitempty"`
// DeliveryRange 适用流量范围:
// LOCAL_ONLY: 站内
// UNION_ONLY: 穿山甲
// UNIVERSAL_DELIVERY: 全部
DeliveryRange string `json:"delivery_range,omitempty"`
// LocalQPS 站内QPS
LocalQPS int64 `json:"local_qps,omitempty"`
// UnionQPS 穿山甲QPS
UnionQPS int64 `json:"union_qps,omitempty"`
// URL 接口地址
URL string `json:"url,omitempty"`
}
InterfaceInfo RTA配置数据
type Report ¶
type Report struct {
// Date 数据统计日期,格式YYYYMMDDHH
Date string `json:"date,omitempty"`
// VID 联合实验组唯一标识
VID int `json:"vid,omitempty"`
// CusVID 客户自行开分桶实验的唯一标识
CusVID int `json:"cus_vid,omitempty"`
// Strategy 联合实验策略,请求入参
Strategy model.Int `json:"strategy,omitempty"`
// Click 展现数据-点击数。当头条用户点击广告素材时,触发点击事件,该事件被认为是一次有效的广告点击
Click int64 `json:"click,omitempty"`
// Show 展现数据-展示数。广告展示给用户的次数。计算方式:经平台判定有效且被计费的展示次数
Show int64 `json:"show,omitempty"`
// Convert 转化数据-转化数。将转化数记录在转化事件发生的时间上。建议广告主考核成本时参考“转化数据(计费时间)”例如您的广告在早上8点进行了展示和点击,用户晚上19点发生了激活行为,我们会把激活数披露在晚上19点
Convert int64 `json:"convert,omitempty"`
// Cost 展现数据-总花费。表示广告在投放期内的预估花费金额
Cost float64 `json:"cost,omitempty"`
// BidCoef 返回RTA出价系数的区间值
BidCoef string `json:"bid_coef,omitempty"`
// WinRatio 竞胜率。竞胜率=竞胜数/参竞数,代表广告主参竞请求的胜出比例,范围 0~1
WinRatio float64 `json:"win_ratio,omitempty"`
}
type RtaExpGetRequest ¶
type RtaExpGetRequest struct {
// AdvertiserID 广告主ID
AdvertiserID uint64 `json:"advertiser_id"`
// RtaID RTA ID
RtaID int `json:"rta_id"`
// StartDate 开始日期,格式YYYYMMDD,示例:20220828;注:历史数据最早可回溯到8月1号0点;最大查询跨度为10天;只支持查询当日前90天内的数据
StartDate string `json:"start_date"`
// EndDate 结束日期,格式YYYYMMDD,示例:20220902;注:历史数据最早可回溯到8月1号0点;最大查询跨度为10天;只支持查询当日前90天内的数据
EndDate string `json:"end_date"`
// Strategy 联合实验策略。共10个实验分桶标记,每个分桶代表一种策略。允许值:0 代表基线策略 ,传入1、2、3、4、5、6、7、8、9
Strategy int `json:"strategy,omitempty"`
}
RtaExpGetRequest 获取穿山甲渠道RTA联合实验数据 API Request
func (RtaExpGetRequest) Encode ¶
func (r RtaExpGetRequest) Encode() string
Encode implement GetRequest interface
type RtaExpGetResponse ¶
type RtaExpGetResponse struct {
model.BaseResponse
// Data json返回值
Data struct {
Data []Report `json:"data_array,omitempty"`
} `json:"data,omitempty"`
}
RtaExpGetResponse 获取穿山甲渠道RTA联合实验数据 API Response
type RtaExpLocalDailyGetFilter ¶
type RtaExpLocalDailyGetFilter struct {
// BidCoef 出价系数取数区间。枚举值:COEF_0(表示系数为0)、COEF_BETWEEN_0_0.1(表示系数区间为(0,0.1))、COEF_BETWEEN_0.1_0.2(表示系数区间为[0.1,0.2))、COEF_BETWEEN_0.2_0.3(表示系数区间为[0.2,0.3))、COEF_BETWEEN_0.3_0.4(表示系数区间为[0.3,0.4))、COEF_BETWEEN_0.4_0.5(表示系数区间为[0.4,0.5))、COEF_BETWEEN_0.5_0.6(表示系数区间为[0.5,0.6))、COEF_BETWEEN_0.6_0.7(表示系数区间为[0.6,0.7))、COEF_BETWEEN_0.7_0.8(表示系数区间为[0.7,0.8))、COEF_BETWEEN_0.8_0.9(表示系数区间为[0.8,0.9))、COEF_BETWEEN_0.9_1.0(表示系数区间为[0.9,1.0))、COEF_BETWEEN_1.0_1.1(表示系数区间为[1.0,1.1))、COEF_BETWEEN_1.1_1.2(表示系数区间为[1.1,1.2))、COEF_BETWEEN_1.2_1.3(表示系数区间为[1.2,1.3))、COEF_BETWEEN_1.3_1.4(表示系数区间为[1.3,1.4))、COEF_BETWEEN_1.4_1.5(表示系数区间为[1.4,1.5))、COEF_BETWEEN_1.5_1.6(表示系数区间为[1.5,1.6))、COEF_BETWEEN_1.6_1.7(表示系数区间为[1.6,1.7))、COEF_BETWEEN_1.7_1.8(表示系数区间为[1.7,1.8))、COEF_BETWEEN_1.8_1.9(表示系数区间为[1.8,1.9))、COEF_BETWEEN_1.9_2.0(表示系数区间为[1.9,2.0))、COEF_BETWEEN_2.0_2.1(表示系数区间为[2.0,2.1))、COEF_BETWEEN_2.1_2.2(表示系数区间为[2.1,2.2))、COEF_BETWEEN_2.2_2.3(表示系数区间为[2.2,2.3))、COEF_BETWEEN_2.3_2.4(表示系数区间为[2.3,2.4))、COEF_BETWEEN_2.4_2.5(表示系数区间为[2.4,2.5))、COEF_BETWEEN_2.5_2.6(表示系数区间为[2.5,2.6))、COEF_BETWEEN_2.6_2.7(表示系数区间为[2.6,2.7))、COEF_BETWEEN_2.7_2.8(表示系数区间为[2.7,2.8))、COEF_BETWEEN_2.8_2.9(表示系数区间为[2.8,2.9))、COEF_BETWEEN_2.9_3.0(表示系数区间为[2.9,3.0))、COEF_BETWEEN_3.0_3.5(表示系数区间为[3.0,3.5))、COEF_BETWEEN_3.5_4.0(表示系数区间为[3.5,4.0))、COEF_BETWEEN_4.0_4.5(表示系数区间为[4.0,4.5))、COEF_BETWEEN_4.5_5.0(表示系数区间为[4.5,5.0))、COEF_ABOVE_5.0(表示系数大于等于5)
BidCoef []string `json:"bid_coef"`
}
type RtaExpLocalDailyGetRequest ¶
type RtaExpLocalDailyGetRequest struct {
// AdvertiserID 广告主ID
AdvertiserID uint64 `json:"advertiser_id"`
// RtaID RTA ID
RtaID uint64 `json:"rta_id"`
// StartDate 开始日期,格式YYYYMMDD,示例:20220828;注:历史数据最早可回溯到8月1号0点;最大查询跨度为10天;只支持查询当日前90天内的数据
StartDate string `json:"start_date"`
// EndDate 结束日期,格式YYYYMMDD,示例:20220902;注:历史数据最早可回溯到8月1号0点;最大查询跨度为10天;只支持查询当日前90天内的数据
EndDate string `json:"end_date"`
// VID 联合实验组唯一标识,共10个实验分桶标记。若使用该数据报表,务必在入参中携带cus_vid或者vid二者之一,若为空则报错。
// 注:联系对接销售/运营咨询获取vid
VID int `json:"vid,omitempty"`
// CusVID 客户自行开分桶实验的唯一标识,一共10个枚举值(1~10)。若使用该数据报表,务必在入参中携带cus_vid或者vid二者之一,若为空则报错。
// 注:cus_vid和vid不能同时使用,同时入参;如有特殊需求,联系对接销售/运营咨询。
CusVID int `json:"cus_vid,omitempty"`
// FIltering 过滤条件
Filtering *RtaExpLocalDailyGetFilter `json:"filtering,omitempty"`
}
RtaExpLocalDailyGetRequest 获取站内媒体RTA联合实验数据 API Request
func (RtaExpLocalDailyGetRequest) Encode ¶
func (r RtaExpLocalDailyGetRequest) Encode() string
type RtaExpLocalDailyGetResponse ¶
type RtaExpLocalDailyGetResponse struct {
model.BaseResponse
// Data json返回值
Data struct {
Data []Report `json:"data,omitempty"`
} `json:"data,omitempty"`
}
RtaExpLocalDailyGetResponse 获取站内媒体RTA联合实验数据 API Response
type RtaExpLocalHourlyGetRequest ¶
type RtaExpLocalHourlyGetRequest struct {
// AdvertiserID 广告主ID
AdvertiserID uint64 `json:"advertiser_id"`
// RtaID RTA ID
RtaID uint64 `json:"rta_id"`
// StarteDate 开始时间,格式YYYYMMDDHH,示例:2022090208;注:HH取值范围为00-23;历史数据最早可回溯到8月1号0点;最大查询跨度为10天;只支持查询当日前90天内且查询当时5个小时以前的数据;若start_date=2022090208,end_date=2022090209,则获取2022年9月2日8时、9时整两小时的数据
StartDate string `json:"start_date"`
// EndDate 结束时间,格式YYYYMMDDHH,示例:2022090209;注:HH取值范围为00-23;历史数据最早可回溯到8月1号0点;最大查询跨度为10天;只支持查询当日前90天内且查询当时5个小时以前的数据;若start_date=2022090208,end_date=2022090209,则获取2022年9月2日8时、9时整两小时的数据
EndDate string `json:"end_date"`
// VID 联合实验组唯一标识,共10个实验分桶标记。若使用该数据报表,务必在入参中携带cus_vid或者vid二者之一,若为空则报错。
// 注:联系对接销售/运营咨询获取vid
VID int `json:"vid,omitempty"`
// CusVID 客户自行开分桶实验的唯一标识,一共10个枚举值(1~10)。若使用该数据报表,务必在入参中携带cus_vid或者vid二者之一,若为空则报错。
// 注:cus_vid和vid不能同时使用,同时入参;如有特殊需求,联系对接销售/运营咨询。
CusVID int `json:"cus_vid,omitempty"`
}
RtaExpLocalHourlyGetRequest 获取站内媒体RTA联合实验数据(分时t+5)API Request
func (RtaExpLocalHourlyGetRequest) Encode ¶
func (r RtaExpLocalHourlyGetRequest) Encode() string
type RtaExpLocalHourlyGetResponse ¶
type RtaExpLocalHourlyGetResponse struct {
model.BaseResponse
// Data json返回值
Data struct {
Data []Report `json:"data,omitempty"`
} `json:"data,omitempty"`
}
RtaExpLocalHourlyGetResponse 获取站内媒体RTA联合实验数据(分时t+5) API Response
type RtaInfo ¶
type RtaInfo struct {
// RtaID RTA策略ID
RtaID uint64 `json:"rta_id,omitempty"`
// Remark 备注,即RTA策略描述
Remark string `json:"remark,omitempty"`
}
RtaInfo RTA策略信息
type Scope ¶
type Scope struct {
// ProjectID 项目id
ProjectID uint64 `json:"project_id,omitempty"`
// ProjectName 项目名称
ProjectName string `json:"project_name,omitempty"`
// CampaignID 广告组id
CampaignID uint64 `json:"campaign_id,omitempty"`
// CampaignName 广告组名称
CampaignName string `json:"campaign_name,omitempty"`
}
Scope 指定rta策略下所绑定的信息
type ScopeGetRequest ¶
type ScopeGetRequest struct {
// AdvertiserID 广告主ID
AdvertiserID uint64 `json:"advertiser_id,omitempty"`
// RtaID RTA策略ID
RtaID uint64 `json:"rta_id,omitempty"`
}
ScopeGetRequest 获取RTA策略绑定信息列表 API Request
func (ScopeGetRequest) Encode ¶
func (r ScopeGetRequest) Encode() string
Encode implement GetRequest interface
type ScopeGetResponse ¶
type ScopeGetResponse struct {
model.BaseResponse
Data struct {
// List 指定rta策略下所绑定的信息列表
List []Scope `json:"list,omitempty"`
}
}
ScopeGetResponse 获取RTA策略绑定信息列表 API Response
type SetScopeRequest ¶
type SetScopeRequest struct {
// AdvertiserID 广告账户id
AdvertiserID uint64 `json:"advertiser_id,omitempty"`
// RtaID 预期设置的rta策略id
RtaID uint64 `json:"rta_id,omitempty"`
// TargetType 生效维度
// 默认值:ADV广告账户
// 允许值:ADV广告账户,CAMPAIGN广告组,PROJECT项目(体验版)
TargetType enum.RtaTargetType `json:"target_type,omitempty"`
// TargetIDs 生效列表,当target_type = CAMPAIGN 或 PROJECT 有效
// 当target_type = CAMPAIGN,传入广告组id
// 当target_type = PROJECT,传入项目id
TargetIDs []uint64 `json:"target_ids,omitempty"`
}
SetScopeRequest 设置账户下RTA策略生效范围 API Request
func (SetScopeRequest) Encode ¶
func (r SetScopeRequest) Encode() []byte
Encode implement PostRequest interface
type StatusUpdateRequest ¶
type StatusUpdateRequest struct {
// AdvertiserID 广告账户id
AdvertiserID uint64 `json:"advertiser_id,omitempty"`
// RtaIDs 预期设置的rta策略id
RtaIDs []uint64 `json:"rta_ids,omitempty"`
// Status 目标状态,允许值:启用 ENABLE、停用 DISABLE
Status enum.RtaStatus `json:"status,omitempty"`
}
StatusUpdateRequest 批量启停账户下RTA策略 API Request
func (StatusUpdateRequest) Encode ¶
func (r StatusUpdateRequest) Encode() []byte
Encode implement PostRequest interface