-
Notifications
You must be signed in to change notification settings - Fork 42
/
get_request.go
130 lines (125 loc) · 6.07 KB
/
get_request.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
package report
import (
"encoding/json"
"strconv"
"time"
"github.com/bububa/oceanengine/marketing-api/enum"
"github.com/bububa/oceanengine/marketing-api/util"
)
// GetRequest 获取数据报表API Request
type GetRequest struct {
// AgentID 代理商id。
AgentID uint64 `json:"agent_id,omitempty"`
// AdvertiserID 广告主ID
AdvertiserID uint64 `json:"advertiser_id,omitempty"`
// StartDate 起始日期,格式YYYY-MM-DD,只支持查询2016-10-26及以后的日期
StartDate time.Time `json:"start_date,omitempty"`
// EndDate 结束日期,格式YYYY-MM-DD,只支持查询2016-10-26及以后的日期，时间跨度不能超过30天
EndDate time.Time `json:"end_date,omitempty"`
// Fields 指定需要的指标名称
Fields []string `json:"fields,omitempty"`
// GroupBy 分组条件默认为 STAT_GROUP_BY_FIELD_STAT_TIME
GroupBy []enum.StatGroupBy `json:"group_by,omitempty"`
// TimeGranularity 时间粒度, 默认值: STAT_TIME_GRANULARITY_DAILY
TimeGranularity enum.StatTimeGranularity `json:"time_granularity,omitempty"`
// OrderField 排序字段，所有的统计指标均可参与排序
OrderField string `json:"order_field,omitempty"`
// OrderType 排序方式；默认值: DESC；允许值: ASC, DESC
OrderType enum.OrderType `json:"order_type,omitempty"`
// Page 页码；默认值: 1
Page int `json:"page,omitempty"`
// PageSize 页面大小，即每页展示的数据量；默认值: 20；取值范围: 1-1000
PageSize int `json:"page_size,omitempty"`
// Filtering 过滤字段，json格式，支持字段如下
Filtering *StatFiltering `json:"filtering,omitempty"`
}
// StatFiltering 数据报表过滤条件
type StatFiltering struct {
// AdvertiserIDs 广告主 id 列表，若选填该字段，则最少应上传1个广告主id，最多支持同时查询100个广告主。
AdvertiserIDs []uint64 `json:"advertiser_ids,omitempty"`
// Active 用户活跃状态。可选枚举值: ACTIVE表示活跃用户,SILENT表示沉默用户,ALL表示所有用户。不填写该字段则默认值为ALL。
Active string `json:"active,omitempty"`
// FirstIndustry 一级行业名称
FirstIndustry string `json:"first_industry,omitempty"`
// SecondIndustry 二级行业名称
SecondIndustry string `json:"secondy_industry,omitempty"`
// AccountSource 账户类型。可选枚举值: LUBAN_ACCOUNT,NORMAL_ADVERTISER
AccountSource enum.AccountSource `json:"account_source,omitempty"`
// AccountStatus 账户状态
AccountStatus enum.AccountStatus `json:"account_status,omitempty"`
// StartAuditPassTime 过审时间范围的开始时间。闭区间。格式：YYYY-MM-DD。表示过滤出账户资质审核通过时间在给定的过审时间范围内的广告主数据。
StartAuditPassTime string `json:"start_audit_pass_time,omitempty"`
// EndAuditPassTime 过审时间范围的结束时间。闭区间。格式：YYYY-MM-DD。表示过滤出账户资质审核通过时间在给定的过审时间范围内的广告主数据。
EndAuditPassTime string `json:"end_audit_pass_time,omitempty"`
// CampaignIDs 广告组id列表：按照campaign_id过滤，最多支持100个
CampaignIDs []uint64 `json:"campaign_ids,omitempty"`
// CampaignName 广告组名称：按照campaign_name过滤，字符串长度限制1-30
CampaignName string `json:"campaign_name,omitempty"`
// AdIDs 广告计划id列表：按照 ad_id 过滤，最多支持100个
AdIDs []uint64 `json:"ad_ids,omitempty"`
// AdName 广告计划名称：按照ad_name过滤，字符串长度限制1-30
AdName string `json:"ad_name,omitempty"`
// CreativeIDs 广告创意id列表：按照 creative_id 过滤，最多支持100个
CreativeIDs []uint64 `json:"creative_ids,omitempty"`
// InventoryTypes 广告位置列表：按照广告位置过滤
InventoryTypes []enum.StatInventoryType `json:"inventory_types,omitempty"`
// Pricings 出价方式列表：按照出价方式过滤
Pricings []enum.PricingType `json:"pricings,omitempty"`
// ImageModes 素材类型列表：按照类型过滤
ImageModes []enum.ImageMode `json:"image_modes,omitempty"`
// CreativeMaterialModes 创意类型列表：按照创意类型过滤，STATIC_ASSEMBLE 表示程序化创意，INTERVENE表示自定义创意
CreativeMaterialModes []enum.CreativeMaterialMode `json:"creative_material_modes,omitempty"`
// LandingTypes 推广目的列表：按照广告组推广目的过滤, 允许值: "LINK","APP","DPA","GOODS","STORE","SHOP","AWEME"
LandingTypes []enum.LandingType `json:"landing_types,omitempty"`
// Status 广告创意状态：按照广告创意状态过滤，默认为返回“所有不包含已删除”，如果要返回所有包含已删除有对应枚举表示
Status enum.CreativeStatus `json:"status,omitempty"`
// DeliveryMode 投放模式筛选。
// 允许值:
// STANDARD:标准投放。
// ADLAB_FREE:管家&省心投放
DeliveryMode []string `json:"delivery_mode,omitempty"`
// PlatformVersion 获取的数据平台版本
PlatformVersion enum.PlatformVersion `json:"platform_version,omitempty"`
}
// Encode implement GetRequest interface
func (r GetRequest) Encode() string {
values := util.GetUrlValues()
values.Set("start_date", r.StartDate.Format("2006-01-02"))
values.Set("end_date", r.EndDate.Format("2006-01-02"))
if r.AgentID > 0 {
values.Set("agent_id", strconv.FormatUint(r.AgentID, 10))
}
if r.AdvertiserID > 0 {
values.Set("advertiser_id", strconv.FormatUint(r.AdvertiserID, 10))
}
if len(r.Fields) > 0 {
fields, _ := json.Marshal(r.Fields)
values.Set("fields", string(fields))
}
if r.GroupBy != nil {
groupBy, _ := json.Marshal(r.GroupBy)
values.Set("group_by", string(groupBy))
}
if r.TimeGranularity != "" {
values.Set("time_granularity", string(r.TimeGranularity))
}
if r.OrderField != "" {
values.Set("order_field", r.OrderField)
}
if r.OrderType != "" {
values.Set("order_type", string(r.OrderType))
}
if r.Page > 0 {
values.Set("page", strconv.Itoa(r.Page))
}
if r.PageSize > 0 {
values.Set("page_size", strconv.Itoa(r.PageSize))
}
if r.Filtering != nil {
filtering, _ := json.Marshal(r.Filtering)
values.Set("filtering", string(filtering))
}
ret := values.Encode()
util.PutUrlValues(values)
return ret
}