Documentation
¶
Overview ¶
Package adraise 一键起量相关API
Index ¶
- type EstimateRequest
- type EstimateResponse
- type Report
- type ReportRequest
- type ReportResponse
- type ReportResponseData
- type Result
- type ResultRequest
- type ResultResponse
- type SetRequest
- type SetResponse
- type StatusRequest
- type StatusResponse
- type Version
- type VersionRequest
- type VersionResponse
- type VersionResponseData
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type EstimateRequest ¶
type EstimateRequest struct {
// AdvertiserID 广告主ID
AdvertiserID uint64 `json:"advertiser_id,omitempty"`
// AdID 广告计划id
AdID uint64 `json:"ad_id,omitempty"`
// ModifyValue 预估值,启动一键起量时必填,单位千分之一分,取值大于等于0且小于等于计划预算
ModifyValue int64 `json:"modify_value,omitempty"`
}
EstimateRequest 获取起量预估值 API Request
func (EstimateRequest) Encode ¶
func (r EstimateRequest) Encode() string
Encode implement GetRequest interface
type EstimateResponse ¶
type EstimateResponse struct {
model.BaseResponse
// Data json 返回值
Data struct {
// EstimateNum 预估展示量
EstimateNum int64 `json:"estimate_num,omitempty"`
} `json:"data,omitempty"`
}
EstimateResponse 获取起量预估值 API Response
type Report ¶
type Report struct {
// StatDatetime 起量时间,当为时返回,格式:time_dimensionHOURLY2021-03-31 16:00 - 17:00
StatDatetime string `json:"stat_datetime,omitempty"`
// Cost 一键起量阶段产生消耗
Cost int64 `json:"cost,omitempty"`
// Show 一键起量阶段产生展示
Show int64 `json:"show,omitempty"`
// Click 一键起量阶段产生点击数
Click int64 `json:"click,omitempty"`
// Convert 一键起量阶段产生转换数
Convert int64 `json:"convert,omitempty"`
// Ctr CTR 一键起量期间点击率
Ctr float64 `json:"ctr,omitempty"`
// Cvr CVR 一键起量期间转化率
Cvr float64 `json:"cvr,omitempty"`
}
Report 起量报告
type ReportRequest ¶
type ReportRequest struct {
// AdvertiserID 广告主ID
AdvertiserID uint64 `json:"advertiser_id,omitempty"`
// AdID 广告计划id
AdID uint64 `json:"ad_id,omitempty"`
// AdRaiseVersion 起量版本号,通过【获取起量版本信息】接口获取
AdRaiseVersion string `json:"ad_raise_version,omitempty"`
// StartTime 当前起量版本起量开始时间,格式:2021-03-31 16:00:00,通过【获取起量版本信息】接口获取
StartTime string `json:"start_time,omitempty"`
// EndTime 当前起量版本起量结束时间,格式:2021-03-31 17:00:00,结束时间必须大于开始时间,通过【获取起量版本信息】接口获取
EndTime string `json:"end_time,omitempty"`
// TimeDimension 报告时间维度; 允许值:SUM 获取总计报告,HOURLY 获取分时报告;默认值:SUM
TimeDimension string `json:"time_dimension,omitempty"`
// OrderField 排序指标,当 time_dimension 为HOURLY时可用,允许值:show、convert、 stat_time_hour 、;默认值:stat_time_hour 按照小时时间排序
OrderField string `json:"order_field,omitempty"`
// OrderType 排序类型,当time_dimension为HOURLY时可用,允许值:ASC 顺序、DESC:倒序; 默认值:ASC
OrderType enum.OrderType `json:"order_type,omitempty"`
// Page 页码,默认值:1
Page int `json:"page,omitempty"`
// PageSize 页面大小,允许值:1-100,默认值:10
PageSize int `json:"page_size,omitempty"`
}
ReportRequest 获取一键起量报告 API Request
func (ReportRequest) Encode ¶
func (r ReportRequest) Encode() string
Encode implement GetRequest interface
type ReportResponse ¶
type ReportResponse struct {
model.BaseResponse
// Data json 返回值
Data *ReportResponseData `json:"data,omitempty"`
}
ReportResponse A获取一键起量报告PI Response
type ReportResponseData ¶
type ReportResponseData struct {
// AdRaiseVersion 起量版本号
AdRaiseVersion string `json:"ad_raise_version,omitempty"`
// AdRaiseReport 起量报告
AdRaiseReport []Report `json:"ad_raise_report,omitempty"`
// PageInfo 页面信息
PageInfo *model.PageInfo `json:"page_info,omitempty"`
}
ReportResponseData json 返回值
type Result ¶
type Result struct {
// StartTime 一键起量开始时间
StartTime string `json:"start_time,omitempty"`
// EndTime 一键起量结束时间
EndTime string `json:"end_time,omitempty"`
// Cost 一键起量阶段产生消耗
Cost int64 `json:"cost,omitempty"`
// Show 一键起量阶段产生展示
Show int64 `json:"show,omitempty"`
// Click 一键起量阶段产生点击数
Click int64 `json:"click,omitempty"`
// Convert 一键起量阶段产生转换数
Convert int64 `json:"convert,omitempty"`
// Ctr CTR 一键起量期间点击率
Ctr float64 `json:"ctr,omitempty"`
// Cvr CVR 一键起量期间转化率
Cvr float64 `json:"cvr,omitempty"`
}
Result 一键起量的后验数据
type ResultRequest ¶
type ResultRequest struct {
// AdvertiserID 广告主ID
AdvertiserID uint64 `json:"advertiser_id,omitempty"`
// AdID 广告计划id
AdID uint64 `json:"ad_id,omitempty"`
// OptType 操作类型
OptType enum.AdRaiseOptType `json:"opt_type,omitempty"`
}
ResultRequest 获取一键起量的后验数据 API Request
func (ResultRequest) Encode ¶
func (r ResultRequest) Encode() string
Encode implement GetRequest interface
type ResultResponse ¶
type ResultResponse struct {
model.BaseResponse
// Data json 返回值
Data *Result `json:"data,omitempty"`
}
ResultResponse 获取一键起量的后验数据 API Response
type SetRequest ¶
type SetRequest struct {
// AdvertiserID 广告主ID
AdvertiserID uint64 `json:"advertiser_id,omitempty"`
// AdID 广告计划id
AdID uint64 `json:"ad_id,omitempty"`
// OptType 操作类型
OptType enum.AdRaiseOptType `json:"opt_type,omitempty"`
// ModifyValue 预估值,启动一键起量时必填,单位千分之一分,取值大于等于0且小于等于计划预算
ModifyValue int64 `json:"modify_value,omitempty"`
}
SetRequest 设置一键起量 API Request
func (SetRequest) Encode ¶
func (r SetRequest) Encode() []byte
Encode implement PostRequest interface
type SetResponse ¶
type SetResponse struct {
model.BaseResponse
// Data json 返回值
Data struct {
// Status 一键起量状态
Status enum.AdRaiseStatus `json:"status,omitempty"`
} `json:"data,omitempty"`
}
SetResponse 设置一键起量 API Response
type StatusRequest ¶
type StatusRequest struct {
// AdvertiserID 广告主ID
AdvertiserID uint64 `json:"advertiser_id,omitempty"`
// AdIDs 广告计划id 列表,最多1000个
AdIDs []uint64 `json:"ad_ids,omitempty"`
}
StatusRequest 获取当前起量状态 API Request
func (StatusRequest) Encode ¶
func (r StatusRequest) Encode() string
Encode implement GetRequest interface
type StatusResponse ¶
type StatusResponse struct {
model.BaseResponse
// Data json 返回值
Data struct {
// Status 一键起量状态
Status string `json:"status,omitempty"`
} `json:"data,omitempty"`
}
StatusResponse 获取当前起量状态 API Response
type Version ¶
type Version struct {
// Num 起量版本号
Num uint64 `json:"version,omitempty"`
// StartTime 当前版本起量开始时间,格式:2021-03-31 16:00:00
StartTime string `json:"start_time,omitempty"`
// EndTime 当前起量版本结束时间,格式:2021-03-31 17:00:00
EndTime string `json:"end_time,omitempty"`
}
Version 起量版本
type VersionRequest ¶
type VersionRequest struct {
// AdvertiserID 广告主ID
AdvertiserID uint64 `json:"advertiser_id,omitempty"`
// AdID 广告计划ID
AdID uint64 `json:"ad_id,omitempty"`
// Page 页码,默认值:1
Page int `json:"page,omitempty"`
// PageSize 页面大小,允许值:1-100,默认值:10
PageSize int `json:"page_size,omitempty"`
}
VersionRequest 获取起量版本信息 API Request
func (VersionRequest) Encode ¶
func (r VersionRequest) Encode() string
Encode implement GetRequest interface
type VersionResponse ¶
type VersionResponse struct {
model.BaseResponse
// Data json 返回值
Data *VersionResponseData `json:"data,omitempty"`
}
VersionResponse 获取起量版本信息 API Response
type VersionResponseData ¶
type VersionResponseData struct {
// List 起量版本列表
List []Version `json:"ad_raise_version_list,omitempty"`
// PageInfo 页面信息
PageInfo *model.PageInfo `json:"page_info,omitempty"`
}
VersionResponseData json 返回值