unipromotion

Documentation

Overview

Package unipromotion 全域推广

Index

• type Ad
• type AdInfo
• type ListRequest
  • func (r ListRequest) Encode() string
• type ListResponse
• type ListResult

Types

type Ad

type Ad struct {
	// AdInfo 广告信息
	AdInfo *AdInfo `json:"ad_info,omitempty"`
	// RoomInfo 主播信息
	RoomInfo []live.Room `json:"room_info,omitempty"`
	// StatsInfo 消耗指标
	StatsInfo *report.UniPromotionStats `json:"stats_info,omitempty"`
}

Ad 全域推广

type AdInfo

type AdInfo struct {
	// ID 推广id
	ID uint64 `json:"id,omitempty"`
	// StartTime 当前周期开始时间，用来返回周期内数据
	StartTime string `json:"start_time,omitempty"`
	// EndTime 当前周期结束时间
	EndTime string `json:"end_time,omitempty"`
	// ModifyTime 修改时间
	ModifyTime string `json:"modify_time,omitempty"`
	// CreateTime 创建时间
	CreateTime string `json:"create_time,omitempty"`
	// MarketingGoal  营销目标
	MarketingGoal enum.MarketingGoal `json:"marketing_goal,omitempty"`
	// Roi2Goal 支付ROI目标，最多支持两位小数
	Roi2Goal float64 `json:"roi2_goal,omitempty"`
	// BudgetMode  预算类型
	BudgetMode enum.BudgetMode `json:"budget_mode,omitempty"`
	// Budget 预算
	Budget float64 `json:"budget,omitempty"`
	// Status 投放状态
	Status qianchuan.AdStatus `json:"status,omitempty"`
	// OptStatus 操作状态，详见【附录-枚举值】
	OptStatus qianchuan.AdOptStatus `json:"opt_status,omitempty"`
	// DeliverySecond 投放时长
	DeliverySecond int64 `json:"delivery_second,omitempty"`
}

AdInfo 广告信息

type ListRequest

type ListRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// StartTime 开始时间，格式 2021-04-05 00:00:00
	StartTime string `json:"start_time,omitempty"`
	// EndTime 结束时间，格式 2021-04-06 00:00:00
	EndTime string `json:"end_time,omitempty"`
	// MarketingGoal 按营销目标过滤，允许值
	// LIVE_PROM_GOODS：直播带货
	MarketingGoal enum.MarketingGoal `json:"marketing_goal,omitempty"`
	// Fields 需要查询的消耗指标，见返回参数
	Fields []string `json:"fields,omitempty"`
	// OrderType 排序方式，允许值：
	// ASC 升序（默认）
	// DESC 降序
	OrderType enum.OrderType `json:"order_type,omitempty"`
	// OrderField  排序字段，默认create_time，同时支持根据消耗指标排序
	// create_time
	// stat_cost
	// total_cost_per_pay_order_for_roi2
	// total_pay_order_count_for_roi2
	// total_pay_order_gmv_for_roi2
	// total_prepay_and_pay_order_roi2
	// total_prepay_order_count_for_roi2
	OrderField string `json:"order_field,omitempty"`
	// Page 页码，默认值：1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小，允许值：10, 20, 50, 100, 200，默认值：10
	PageSize int `json:"page_size,omitempty"`
}

ListRequest 获取全域推广列表 API Request

func (ListRequest) Encode

func (r ListRequest) Encode() string

Encode implement GetRequest interface

type ListResponse

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

ListResponse 获取全域推广列表 API Response

type ListResult

type ListResult struct {
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
	// AdList 全域推广列表
	AdList []Ad `json:"ad_list,omitempty"`
}