-
Notifications
You must be signed in to change notification settings - Fork 14.2k
/
campaign_manager.py
351 lines (322 loc) · 12.7 KB
/
campaign_manager.py
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
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
"""
This module contains Google Campaign Manager hook.
"""
from typing import Any, Dict, List, Optional
from googleapiclient import http
from googleapiclient.discovery import Resource, build
from airflow.exceptions import AirflowException
from airflow.providers.google.common.hooks.base_google import GoogleBaseHook
class GoogleCampaignManagerHook(GoogleBaseHook):
"""
Hook for Google Campaign Manager.
"""
_conn = None # type: Optional[Resource]
def __init__(
self,
api_version: str = "v3.3",
gcp_conn_id: str = "google_cloud_default",
delegate_to: Optional[str] = None,
) -> None:
super().__init__(gcp_conn_id, delegate_to)
self.api_version = api_version
def get_conn(self) -> Resource:
"""
Retrieves connection to Campaign Manager.
"""
if not self._conn:
http_authorized = self._authorize()
self._conn = build(
"dfareporting",
self.api_version,
http=http_authorized,
cache_discovery=False,
)
return self._conn
def delete_report(self, profile_id: str, report_id: str) -> Any:
"""
Deletes a report by its ID.
:param profile_id: The DFA user profile ID.
:type profile_id: str
:param report_id: The ID of the report.
:type report_id: str
"""
response = (
self.get_conn() # pylint: disable=no-member
.reports()
.delete(profileId=profile_id, reportId=report_id)
.execute(num_retries=self.num_retries)
)
return response
def insert_report(self, profile_id: str, report: Dict[str, Any]) -> Any:
"""
Creates a report.
:param profile_id: The DFA user profile ID.
:type profile_id: str
:param report: The report resource to be inserted.
:type report: Dict[str, Any]
"""
response = (
self.get_conn() # pylint: disable=no-member
.reports()
.insert(profileId=profile_id, body=report)
.execute(num_retries=self.num_retries)
)
return response
def list_reports(
self,
profile_id: str,
max_results: Optional[int] = None,
scope: Optional[str] = None,
sort_field: Optional[str] = None,
sort_order: Optional[str] = None,
) -> List[Dict]:
"""
Retrieves list of reports.
:param profile_id: The DFA user profile ID.
:type profile_id: str
:param max_results: Maximum number of results to return.
:type max_results: Optional[int]
:param scope: The scope that defines which results are returned.
:type scope: Optional[str]
:param sort_field: The field by which to sort the list.
:type sort_field: Optional[str]
:param sort_order: Order of sorted results.
:type sort_order: Optional[str]
"""
reports = [] # type: List[Dict]
conn = self.get_conn()
request = conn.reports().list( # pylint: disable=no-member
profileId=profile_id,
maxResults=max_results,
scope=scope,
sortField=sort_field,
sortOrder=sort_order,
)
while request is not None:
response = request.execute(num_retries=self.num_retries)
reports.extend(response.get("items", []))
request = conn.reports().list_next( # pylint: disable=no-member
previous_request=request, previous_response=response
)
return reports
def patch_report(self, profile_id: str, report_id: str, update_mask: Dict) -> Any:
"""
Updates a report. This method supports patch semantics.
:param profile_id: The DFA user profile ID.
:type profile_id: str
:param report_id: The ID of the report.
:type report_id: str
:param update_mask: The relevant portions of a report resource,
according to the rules of patch semantics.
:type update_mask: Dict
"""
response = (
self.get_conn() # pylint: disable=no-member
.reports()
.patch(profileId=profile_id, reportId=report_id, body=update_mask)
.execute(num_retries=self.num_retries)
)
return response
def run_report(
self, profile_id: str, report_id: str, synchronous: Optional[bool] = None
) -> Any:
"""
Runs a report.
:param profile_id: The DFA profile ID.
:type profile_id: str
:param report_id: The ID of the report.
:type report_id: str
:param synchronous: If set and true, tries to run the report synchronously.
:type synchronous: Optional[bool]
"""
response = (
self.get_conn() # pylint: disable=no-member
.reports()
.run(profileId=profile_id, reportId=report_id, synchronous=synchronous)
.execute(num_retries=self.num_retries)
)
return response
def update_report(self, profile_id: str, report_id: str) -> Any:
"""
Updates a report.
:param profile_id: The DFA user profile ID.
:type profile_id: str
:param report_id: The ID of the report.
:type report_id: str
"""
response = (
self.get_conn() # pylint: disable=no-member
.reports()
.update(profileId=profile_id, reportId=report_id)
.execute(num_retries=self.num_retries)
)
return response
def get_report(self, file_id: str, profile_id: str, report_id: str) -> Any:
"""
Retrieves a report file.
:param profile_id: The DFA user profile ID.
:type profile_id: str
:param report_id: The ID of the report.
:type report_id: str
:param file_id: The ID of the report file.
:type file_id: str
"""
response = (
self.get_conn() # pylint: disable=no-member
.reports()
.files()
.get(fileId=file_id, profileId=profile_id, reportId=report_id)
.execute(num_retries=self.num_retries)
)
return response
def get_report_file(
self, file_id: str, profile_id: str, report_id: str
) -> http.HttpRequest:
"""
Retrieves a media part of report file.
:param profile_id: The DFA user profile ID.
:type profile_id: str
:param report_id: The ID of the report.
:type report_id: str
:param file_id: The ID of the report file.
:type file_id: str
:return: googleapiclient.http.HttpRequest
"""
request = (
self.get_conn() # pylint: disable=no-member
.reports()
.files()
.get_media(fileId=file_id, profileId=profile_id, reportId=report_id)
)
return request
@staticmethod
def _conversions_batch_request(
conversions: List[Dict[str, Any]],
encryption_entity_type: str,
encryption_entity_id: int,
encryption_source: str,
kind: str,
) -> Dict[str, Any]:
return {
"kind": kind,
"conversions": conversions,
"encryptionInfo": {
"kind": "dfareporting#encryptionInfo",
"encryptionEntityType": encryption_entity_type,
"encryptionEntityId": encryption_entity_id,
"encryptionSource": encryption_source,
},
}
def conversions_batch_insert(
self,
profile_id: str,
conversions: List[Dict[str, Any]],
encryption_entity_type: str,
encryption_entity_id: int,
encryption_source: str,
max_failed_inserts: int = 0,
) -> Any:
"""
Inserts conversions.
:param profile_id: User profile ID associated with this request.
:type profile_id: str
:param conversions: Conversations to insert, should by type of Conversation:
https://developers.google.com/doubleclick-advertisers/v3.3/conversions#resource
:type conversions: List[Dict[str, Any]]
:param encryption_entity_type: The encryption entity type. This should match the encryption
configuration for ad serving or Data Transfer.
:type encryption_entity_type: str
:param encryption_entity_id: The encryption entity ID. This should match the encryption
configuration for ad serving or Data Transfer.
:type encryption_entity_id: int
:param encryption_source: Describes whether the encrypted cookie was received from ad serving
(the %m macro) or from Data Transfer.
:type encryption_source: str
:param max_failed_inserts: The maximum number of conversions that failed to be inserted
:type max_failed_inserts: int
"""
response = (
self.get_conn() # pylint: disable=no-member
.conversions()
.batchinsert(
profileId=profile_id,
body=self._conversions_batch_request(
conversions=conversions,
encryption_entity_type=encryption_entity_type,
encryption_entity_id=encryption_entity_id,
encryption_source=encryption_source,
kind="dfareporting#conversionsBatchInsertRequest",
),
)
.execute(num_retries=self.num_retries)
)
if response.get('hasFailures', False):
errored_conversions = [stat['errors'] for stat in response['status'] if 'errors' in stat]
if len(errored_conversions) > max_failed_inserts:
raise AirflowException(errored_conversions)
return response
def conversions_batch_update(
self,
profile_id: str,
conversions: List[Dict[str, Any]],
encryption_entity_type: str,
encryption_entity_id: int,
encryption_source: str,
max_failed_updates: int = 0,
) -> Any:
"""
Updates existing conversions.
:param profile_id: User profile ID associated with this request.
:type profile_id: str
:param conversions: Conversations to update, should by type of Conversation:
https://developers.google.com/doubleclick-advertisers/v3.3/conversions#resource
:type conversions: List[Dict[str, Any]]
:param encryption_entity_type: The encryption entity type. This should match the encryption
configuration for ad serving or Data Transfer.
:type encryption_entity_type: str
:param encryption_entity_id: The encryption entity ID. This should match the encryption
configuration for ad serving or Data Transfer.
:type encryption_entity_id: int
:param encryption_source: Describes whether the encrypted cookie was received from ad serving
(the %m macro) or from Data Transfer.
:type encryption_source: str
:param max_failed_updates: The maximum number of conversions that failed to be updateed
:type max_failed_updates: int
"""
response = (
self.get_conn() # pylint: disable=no-member
.conversions()
.batchupdate(
profileId=profile_id,
body=self._conversions_batch_request(
conversions=conversions,
encryption_entity_type=encryption_entity_type,
encryption_entity_id=encryption_entity_id,
encryption_source=encryption_source,
kind="dfareporting#conversionsBatchUpdateRequest",
),
)
.execute(num_retries=self.num_retries)
)
if response.get('hasFailures', False):
errored_conversions = [stat['errors'] for stat in response['status'] if 'errors' in stat]
if len(errored_conversions) > max_failed_updates:
raise AirflowException(errored_conversions)
return response