-
Notifications
You must be signed in to change notification settings - Fork 0
/
adwords_user_list.go
287 lines (255 loc) · 9.27 KB
/
adwords_user_list.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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
package gads
import (
"encoding/xml"
"fmt"
)
type AdwordsUserListService struct {
Auth
}
func NewAdwordsUserListService(auth *Auth) *AdwordsUserListService {
return &AdwordsUserListService{Auth: *auth}
}
type UserListLogicalRule struct {
Operator string `xml:"operator"` // "ALL", "ANY", "NONE", "UNKNOWN"
RuleOperands []UserList `xml:"ruleOperands"`
}
type UserListConversionType struct {
Id *int64
Name string
Category *string `xml:"category"` // "BOOMERANG_EVENT", "OTHER"
}
// Rule structs
type DateRuleItem struct {
Key string `xml:"key>name"`
Op string `xml:"op"` // "UNKNOWN", "EQUALS", "NOT_EQUAL", "BEFORE", "AFTER"
Value string `xml:"string"`
}
type NumberRuleItem struct {
Key string `xml:"key>name"`
Op string `xml:"op"` // "UNKNOWN", "GREATER_THAN", "GREATER_THAN_OR_EQUAL", "EQUALS", "NOT_EQUAL", "LESS_THAN", "LESS_THAN_OR_EQUAL"
Value int64 `xml:"value"`
}
type StringRuleItem struct {
Key string `xml:"key>name"`
Op string `xml:"op"` // "UNKNOWN", "CONTAINS", "EQUALS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUAL", "NOT_CONTAIN", "NOT_START_WITH", "NOT_END_WITH"
Value string `xml:"string"`
}
type RuleItemGroup struct {
Items []interface{} `xml:"items"`
}
type Rule struct {
Groups []RuleItemGroup `xml:"groups"`
}
/*type UserListOperations struct {
}*/
type UserListOperations map[string][]MutateMembersOperand
type UserList struct {
Id int64 `xml:"id"`
Readonly *bool `xml:"isReadOnly"`
Name string `xml:"name"`
Description string `xml:"description"`
Status string `xml:"status"` // membership status "OPEN", "CLOSED"
IntegrationCode string `xml:"integrationCode"`
AccessReason string `xml:"accessReason"` // account access resson "OWNER", "SHARED", "LICENSED", "SUBSCRIBED"
AccountUserListStatus string `xml:"accountUserListStatus"` // if share is still active "ACTIVE", "INACTIVE"
MembershipLifeSpan int64 `xml:"membershipLifeSpan"` // number of days cookie stays on list
Size *int64 `xml:"size,omitempty"`
SizeRange *string `xml:"sizeRange,omitempty"` // size range "LESS_THEN_FIVE_HUNDRED","LESS_THAN_ONE_THOUSAND", "ONE_THOUSAND_TO_TEN_THOUSAND","TEN_THOUSAND_TO_FIFTY_THOUSAND","FIFTY_THOUSAND_TO_ONE_HUNDRED_THOUSAND","ONE_HUNDRED_THOUSAND_TO_THREE_HUNDRED_THOUSAND","THREE_HUNDRED_THOUSAND_TO_FIVE_HUNDRED_THOUSAND","FIVE_HUNDRED_THOUSAND_TO_ONE_MILLION","ONE_MILLION_TO_TWO_MILLION","TWO_MILLION_TO_THREE_MILLION","THREE_MILLION_TO_FIVE_MILLION","FIVE_MILLION_TO_TEN_MILLION","TEN_MILLION_TO_TWENTY_MILLION","TWENTY_MILLION_TO_THIRTY_MILLION","THIRTY_MILLION_TO_FIFTY_MILLION","OVER_FIFTY_MILLION"
SizeForSearch *int64 `xml:"sizeForSearch,omitempty"` // estimated number of google.com users in this group
SizeRangeForSearch *string `xml:"sizeRangeForSearch,omitempty"` // same values as size range but for search
ListType *string `xml:"sizeType,omitempty"` // one of "UNKNOWN", "REMARKETING", "LOGICAL", "EXTERNAL_REMARKETING", "RULE_BASED", "SIMILAR"
// LogicalUserList
LogicalRules *[]UserListLogicalRule `xml:"rules,omitempty"`
// BasicUserList
ConversionTypes *[]UserListConversionType `xml:"conversionTypes"`
// RuleUserList
Rule *Rule `xml:"rule,omitempty"`
StartDate *string `xml:"startDate,omitempty"`
EndDate *string `xml:"endDate,omitempty"`
// SimilarUserList
SeedUserListId *int64 `xml:"seedUserListId,omitempty"`
SeedUserListName *string `xml:"seedUserListName,omitempty"`
SeedUserListDescription *string `xml:"seedUserListDescription,omitempty"`
SeedUserListStatus *string `xml:"seedUserListStatus,omitempty"`
SeedListSize *int64 `xml:"seedListSize,omitempty"`
}
// DoubleClick platform user list mapped to AdWords
//func NewExternalRemarketingUserList() (adwordsUserList UserList) {
//}
//
func NewLogicalUserList(name, description, status, integrationCode string, membershipLifeSpan int64, logicalRules []UserListLogicalRule) (adwordsUserList UserList) {
return UserList{
Name: name,
Description: description,
Status: status,
IntegrationCode: integrationCode,
MembershipLifeSpan: membershipLifeSpan,
LogicalRules: &logicalRules,
}
}
func NewBasicUserList(name, description, status, integrationCode string, membershipLifeSpan int64, conversionTypes []UserListConversionType) (adwordsUserList UserList) {
return UserList{
Name: name,
Description: description,
Status: status,
IntegrationCode: integrationCode,
MembershipLifeSpan: membershipLifeSpan,
ConversionTypes: &conversionTypes,
}
}
func NewDateSpecificRuleUserList(name, description, status, integrationCode string, membershipLifeSpan int64, rule Rule, startDate, endDate string) (adwordsUserList UserList) {
return UserList{
Name: name,
Description: description,
Status: status,
IntegrationCode: integrationCode,
MembershipLifeSpan: membershipLifeSpan,
Rule: &rule,
StartDate: &startDate,
EndDate: &endDate,
}
}
func NewExpressionRuleUserList(name, description, status, integrationCode string, membershipLifeSpan int64, rule Rule) (adwordsUserList UserList) {
return UserList{
Name: name,
Description: description,
Status: status,
IntegrationCode: integrationCode,
MembershipLifeSpan: membershipLifeSpan,
Rule: &rule,
}
}
func NewSimilarUserList(name, description, status, integrationCode string, membershipLifeSpan int64) (adwordsUserList UserList) {
return UserList{
Name: name,
Description: description,
Status: status,
IntegrationCode: integrationCode,
MembershipLifeSpan: membershipLifeSpan,
}
}
// Get returns an array of adwords user lists and the total number of adwords user lists matching
// the selector.
//
// Example
//
// ads, totalCount, err := adwordsUserListService.Get(
// gads.Selector{
// Fields: []string{
// "Id",
// "Name",
// "Status",
// "Labels",
// },
// Predicates: []gads.Predicate{
// {"Id", "EQUALS", []string{adGroupId}},
// },
// },
// )
//
// Selectable fields are
// "Id", "IsReadOnly", "Name", "Description", "Status", "IntegrationCode", "AccessReason",
// "AccountUserListStatus", "MembershipLifeSpan", "Size", "SizeRange", "SizeForSearch",
// "SizeRangeForSearch", "ListType"
//
// BasicUserList
// "ConversionType"
//
// LogicalUserList
// "Rules"
//
// SimilarUserList
// "SeedUserListId", "SeedUserListName", "SeedUserListDescription", "SeedUserListStatus",
// "SeedListSize"
//
// filterable fields are
// "Id", "Name", "Status", "IntegrationCode", "AccessReason", "AccountUserListStatus",
// "MembershipLifeSpan", "Size", "SizeForSearch", "ListType"
//
// SimilarUserList
// "SeedUserListId", "SeedListSize"
//
// Relevant documentation
//
// https://developers.google.com/adwords/api/docs/reference/v201409/AdwordsUserListService#get
//
func (s AdwordsUserListService) Get(selector Selector) (userLists []UserList, err error) {
selector.XMLName = xml.Name{"", "serviceSelector"}
respBody, err := s.Auth.request(
adwordsUserListServiceUrl,
"get",
struct {
XMLName xml.Name
Sel Selector
}{
XMLName: xml.Name{
Space: baseUrl,
Local: "get",
},
Sel: selector,
},
)
if err != nil {
return userLists, err
}
getResp := struct {
Size int64 `xml:"rval>totalNumEntries"`
UserLists []UserList `xml:"rval>entries"`
}{}
fmt.Printf("%s\n", respBody)
err = xml.Unmarshal([]byte(respBody), &getResp)
if err != nil {
return userLists, err
}
return getResp.UserLists, err
}
// Mutate is not yet implemented
//
// Relevant documentation
//
// https://developers.google.com/adwords/api/docs/reference/v201409/AdwordsUserListService#mutate
//
type MutateMembersOperand struct {
UserListId string `xml:"userListId"`
DataType string `xml:"dataType"`
RemoveAll bool `xml:"removeAll"`
Members []string `xml:"members"`
}
func (s *AdwordsUserListService) Mutate(adwordsUserListOperations UserListOperations) (adwordsUserLists []UserList, err error) {
type MutateMembersOperation struct {
Action string `xml:"https://adwords.google.com/api/adwords/cm/v201609 operator"`
MutateMembersOperand MutateMembersOperand `xml:"operand"`
}
operations := []MutateMembersOperation{}
for action, campaigns := range adwordsUserListOperations {
for _, campaign := range campaigns {
operations = append(operations,
MutateMembersOperation{
Action: action,
MutateMembersOperand: campaign,
},
)
}
}
mutation := struct {
XMLName xml.Name
Ops []MutateMembersOperation `xml:"operations"`
}{
XMLName: xml.Name{
Space: "https://adwords.google.com/api/adwords/rm/v201609",
Local: "mutateMembers",
},
Ops: operations}
respBody, err := s.Auth.request(adwordsUserListServiceUrl, "mutateMembers", mutation)
if err != nil {
return adwordsUserLists, err
}
mutateResp := struct {
MutateMembersOperands []UserList `xml:"rval>value"`
}{}
err = xml.Unmarshal([]byte(respBody), &mutateResp)
if err != nil {
return adwordsUserLists, err
}
return mutateResp.MutateMembersOperands, err
}