|
| 1 | +package report |
| 2 | + |
| 3 | +import ( |
| 4 | + "strconv" |
| 5 | + |
| 6 | + "github.com/bububa/oceanengine/marketing-api/enum" |
| 7 | + "github.com/bububa/oceanengine/marketing-api/enum/local" |
| 8 | + "github.com/bububa/oceanengine/marketing-api/model" |
| 9 | + "github.com/bububa/oceanengine/marketing-api/util" |
| 10 | +) |
| 11 | + |
| 12 | +// AccountGetRequest 查询账户数据 API Request |
| 13 | +type AccountGetRequest struct { |
| 14 | + // LocalAccountID 本地推投放账户ID |
| 15 | + LocalAccountID uint64 `json:"local_account_id,omitempty"` |
| 16 | + // TimeGranularity 时间粒度,如果不传,返回查询日期内的聚合数据,允许值: |
| 17 | + // TIME_GRANULARITY_DAILY(按天维度),会返回账户每天的数据 |
| 18 | + // TIME_GRANULARITY_HOURLY(按小时维度),会返回账户每小时的数 |
| 19 | + // TIME_GRANULARITY_TOTAL(汇总),会返回账户汇总的数据 |
| 20 | + TimeGranularity enum.TimeGranularity `json:"time_granularity,omitempty"` |
| 21 | + // StartDate 投放开始时间,格式 2021-04-05,开始时间不得早于今日-365天 |
| 22 | + StartDate string `json:"start_date,omitempty"` |
| 23 | + // EndDate 投放结束时间,格式 2021-04-05 |
| 24 | + // 若不传time_granularity,则时间跨度不能超过365天; |
| 25 | + // 若传time_granularity为TIME_GRANULARITY_DAILY时,则时间跨度不能超过365天; |
| 26 | + // 若传time_granularity为TIME_GRANULARITY_TOTAL时,则时间跨度不能超过365天; |
| 27 | + // 若传time_granularity为TIME_GRANULARITY_HOURLY时,则时间跨度不能超过7天 |
| 28 | + EndDate string `json:"end_date,omitempty"` |
| 29 | + // Metrics 指标集,允许值可参考应答返回数据指标 |
| 30 | + Metrics []string `json:"metrics,omitempty"` |
| 31 | + // OrderType 排序方式,允许值: |
| 32 | + // ASC:升序 |
| 33 | + // DESC:降序(默认) |
| 34 | + OrderType enum.OrderType `json:"order_type,omitempty"` |
| 35 | + // OrderField 排序字段,允许值参考数据指标,默认根据时间排序 |
| 36 | + // 注意:如果根据指标排序,order_field必须在metrics范围内 |
| 37 | + OrderField string `json:"order_field,omitempty"` |
| 38 | + // Filtering 过滤条件 |
| 39 | + Filtering *AccountGetFilter `json:"filtering,omitempty"` |
| 40 | + // Page 页码,默认值:1 |
| 41 | + Page int `json:"page,omitempty"` |
| 42 | + // PageSize 页面大小,允许值:10(默认值)、20、50、100 |
| 43 | + PageSize int `json:"page_size,omitempty"` |
| 44 | +} |
| 45 | + |
| 46 | +type AccountGetFilter struct { |
| 47 | + // MarketingGoal 营销场景,允许值: |
| 48 | + // LIVE 直播 |
| 49 | + // VIDEO_IMAGE 短视频/图文 |
| 50 | + MarketingGoal local.MarketingGoal `json:"marketing_goal,omitempty"` |
| 51 | + // LocalDeliveryScene 营销目的,不传,默认查询全部,可选值: |
| 52 | + // CLUE 获取线索 |
| 53 | + // CONTENT_HEATING 线上互动 |
| 54 | + // POI_CUSTOMER 线下到店 |
| 55 | + // PURCHASE 团购成交 |
| 56 | + LocalDeliveryScene local.LocalDeliveryScene `json:"local_delivery_scene,omitempty"` |
| 57 | + // CampaignType 单元类型,不传,默认查询全部,可选值: |
| 58 | + // GENERAL 通投 |
| 59 | + // SEARCHING 搜索 |
| 60 | + CampaignType local.AdType `json:"campaign_type,omitempty"` |
| 61 | + // ExternalAction 优化目标,不传,默认查询全部,可选值: |
| 62 | + // CLUE_ACQUISITION 获取线索 |
| 63 | + // FOLLOW_ACTION 粉丝增长 |
| 64 | + // CLUE_CONFIRM确认意向 |
| 65 | + // LIVE_ENGAGEMENT 直播加热 |
| 66 | + // LIVE_ENTER_ACTION 直播间观看 |
| 67 | + // LIVE_OTO_CLICK 直播间团购点击 |
| 68 | + // LIVE_OTO_GROUP_BUYING 直播间团购购买 |
| 69 | + // LIVE_STAY_TIME 直播间停留 |
| 70 | + // NATIVE_ACTION 用户互动 |
| 71 | + // OTO_PAY 团购成交 |
| 72 | + // POI_RECOMMEND 门店浏览 |
| 73 | + // PRIVATE_MESSAGE 私信消息 |
| 74 | + // SHOW 展示量 |
| 75 | + ExternalAction local.ExternalAction `json:"external_action,omitempty"` |
| 76 | + // DeliveryMode 投放模式,不传,默认查询全部,可选值: |
| 77 | + // CDP_AUTO_MODE 自动投放 |
| 78 | + // MANUAL_MODE 手动投放 |
| 79 | + DeliveryMode local.DeliveryMode `json:"devlivery_mode,omitempty"` |
| 80 | +} |
| 81 | + |
| 82 | +// Encode implements GetRequest interface |
| 83 | +func (r AccountGetRequest) Encode() string { |
| 84 | + values := util.GetUrlValues() |
| 85 | + values.Set("local_account_id", strconv.FormatUint(r.LocalAccountID, 10)) |
| 86 | + if r.TimeGranularity != "" { |
| 87 | + values.Set("time_granularity", string(r.TimeGranularity)) |
| 88 | + } |
| 89 | + values.Set("start_date", r.StartDate) |
| 90 | + values.Set("end_date", r.EndDate) |
| 91 | + if r.OrderType != "" { |
| 92 | + values.Set("order_type", string(r.OrderType)) |
| 93 | + } |
| 94 | + if r.OrderField != "" { |
| 95 | + values.Set("order_field", r.OrderField) |
| 96 | + } |
| 97 | + values.Set("metrics", string(util.JSONMarshal(r.Metrics))) |
| 98 | + if r.Filtering != nil { |
| 99 | + values.Set("filtering", string(util.JSONMarshal(r.Filtering))) |
| 100 | + } |
| 101 | + if r.Page > 0 { |
| 102 | + values.Set("page", strconv.Itoa(r.Page)) |
| 103 | + } |
| 104 | + if r.PageSize > 0 { |
| 105 | + values.Set("page_size", strconv.Itoa(r.PageSize)) |
| 106 | + } |
| 107 | + ret := values.Encode() |
| 108 | + util.PutUrlValues(values) |
| 109 | + return ret |
| 110 | +} |
| 111 | + |
| 112 | +// AccountGetResponse 查询账户数据 API Response |
| 113 | +type AccountGetResponse struct { |
| 114 | + model.BaseResponse |
| 115 | + Data *AccountGetResult `json:"data,omitempty"` |
| 116 | +} |
| 117 | + |
| 118 | +type AccountGetResult struct { |
| 119 | + // PageInfo 分页信息 |
| 120 | + PageInfo *model.PageInfo `json:"page_info,omitempty"` |
| 121 | + // DataList |
| 122 | + DataList []Report `json:"project_list,omitempty"` |
| 123 | +} |
0 commit comments