-
Notifications
You must be signed in to change notification settings - Fork 0
/
google_utils.py
729 lines (604 loc) · 33 KB
/
google_utils.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
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
'''
NOTICE: THIS FILE (and google client library dependency) IS TEMPORARY AND WILL BE MOVED TO **DCICUTILS** AFTER MORE COMPLETE
'''
import inspect
from datetime import (
date,
timedelta
)
from types import FunctionType
from calendar import monthrange
from collections import OrderedDict
from dcicutils.env_utils import FF_PROD_BUCKET_ENV
from googleapiclient.discovery import build
from google.oauth2.service_account import Credentials
from dcicutils import (
ff_utils,
s3_utils
)
DEFAULT_GOOGLE_API_CONFIG = {
"scopes" : [ # Descriptions from: https://developers.google.com/identity/protocols/googlescopes
'https://www.googleapis.com/auth/analytics.readonly', # View your Google Analytics data
'https://www.googleapis.com/auth/drive', # View and manage the files in your Google Drive
'https://www.googleapis.com/auth/drive.file', # View and manage Google Drive files and folders that you have opened or created with this app
'https://www.googleapis.com/auth/spreadsheets' # View and manage your spreadsheets in Google Drive
],
"analytics_view_id" : '132680007',
"analytics_page_size" : 10000
}
class _NestedGoogleServiceAPI:
'''Used as common base class for nested classes of GoogleAPISyncer.'''
def __init__(self, syncer_instance):
self.owner = syncer_instance
if not self.owner.credentials:
raise Exception("No Google API credentials set.")
def report(*args, disabled=False):
'''Decorator for AnalyticsAPI'''
def decorate_func(func):
if disabled:
return func
setattr(func, 'is_report_provider', True)
return func
if len(args) == 1 and isinstance(args[0], FunctionType):
return decorate_func(args[0])
else:
return decorate_func
class GoogleAPISyncer:
'''
Handles authentication and common requests against Google APIs using `fourfront-ec2-account` (a service_account).
If no access keys are provided, initiates a connection to production.
Interfaces with Google services using Google API version 4 ('v4').
For testing against localhost, please provide a `ff_access_keys` dictionary with server=localhost:8000 and key & secret from there as well.
Arguments:
ff_access_keys - Optional. A dictionary with a 'key', 'secret', and 'server', identifying admin account access keys and FF server to POST to.
google_api_key - Optional. Override default API key for accessing Google.
s3UtilsInstance - Optional. Provide an S3Utils class instance connected to a bucket with a proper Google API key (if none supplied otherwise).
If not supplied, a new S3 connection will be created to the Fourfront production bucket.
extra_config - Additional Google API config, e.g. OAuth2 scopes and Analytics View ID. Shouldn't need to set this.
'''
DEFAULT_CONFIG = DEFAULT_GOOGLE_API_CONFIG
@staticmethod
def validate_api_key_format(json_api_key):
try:
assert json_api_key is not None
assert isinstance(json_api_key, dict)
assert json_api_key['type'] == 'service_account'
assert json_api_key["project_id"] == "fourdn-fourfront"
for dict_key in ['private_key_id', 'private_key', 'client_email', 'client_id', 'auth_uri', 'client_x509_cert_url']:
assert json_api_key[dict_key]
except:
return False
return True
def __init__(
self,
ff_access_keys = None,
google_api_key = None,
s3UtilsInstance = None,
extra_config = DEFAULT_GOOGLE_API_CONFIG
):
'''Authenticate with Google APIs and initialize sub-class instances.'''
if s3UtilsInstance is None:
self._s3Utils = s3_utils.s3Utils(env='data') # Google API Keys are stored on production bucket only ATM.
else:
self._s3Utils = s3UtilsInstance
if google_api_key is None:
self._api_key = self._s3Utils.get_google_key()
if not self._api_key:
raise Exception("Failed to get Google API key from S3.")
else:
self._api_key = google_api_key
if not GoogleAPISyncer.validate_api_key_format(self._api_key):
raise Exception("Google API Key is in invalid format.")
self.extra_config = extra_config
self.credentials = Credentials.from_service_account_info(
self._api_key,
scopes=self.extra_config.get('scopes', DEFAULT_GOOGLE_API_CONFIG['scopes'])
)
# These are required only for POSTing/GETing data for TrackingInfo items.
if ff_access_keys is None:
ff_access_keys = self._s3Utils.get_access_keys()
self.server = ff_access_keys['server']
self.access_key = {
"key" : ff_access_keys['key'],
"secret": ff_access_keys['secret']
}
# Init sub-class objects
self.analytics = GoogleAPISyncer.AnalyticsAPI(self)
self.sheets = GoogleAPISyncer.SheetsAPI(self)
self.docs = GoogleAPISyncer.DocsAPI(self)
class AnalyticsAPI(_NestedGoogleServiceAPI):
'''
Interface for accessing Google Analytics data using our Google API Syncer credentials.
Relevant Documentation:
https://developers.google.com/analytics/devguides/reporting/core/v4/rest/v4/reports/batchGet
'''
@staticmethod
def transform_report_result(raw_result, save_raw_values=False, date_increment="daily"):
'''
Transform raw responses (multi-dimensional array) from Google Analytics to a more usable
list-of-dictionaries structure.
Arguments:
raw_result - A dictionary containing at minimum `reports` (as delivered from) and `report_key_frames`
Returns:
A dictionary with `start_date`, `end_date`, `date_requested`, and parsed reports as `reports`.
'''
def format_metric_value(row, metric_dict, metric_index):
'''Parses value from row into a numerical format, if necessary.'''
value = row['metrics'][0]["values"][metric_index]
type = metric_dict['type']
if type == 'INTEGER':
value = int(value)
elif type in ('FLOAT', 'CURRENCY', 'TIME'):
value = float(value)
elif type == 'PERCENT':
value = float(value) / 100
return value
def report_to_json_items(report):
# [(0, "ga:productName"), (1, "ga:productSku"), ...]
dimension_keys = list(enumerate(report['columnHeader'].get('dimensions', [])))
# [(0, { "name": "ga:productDetailViews", "type": "INTEGER" }), (1, { "name": "ga:productListClicks", "type": "INTEGER" }), ...]
metric_key_definitions = list(enumerate(report['columnHeader'].get('metricHeader', []).get('metricHeaderEntries', [])))
return_items = []
for row_index, row in enumerate(report.get('data', {}).get('rows', [])):
list_item = { dk : row['dimensions'][dk_index] for (dk_index, dk) in dimension_keys }
list_item = dict(list_item, **{
mk_dict['name'] : format_metric_value(row, mk_dict, mk_index)
for (mk_index, mk_dict) in metric_key_definitions
})
return_items.append(list_item)
return return_items
def parse_google_api_date(date_requested):
'''
Returns ISO-formatted date of a date string sent to Google Analytics.
Translates 'yesterday', 'XdaysAgo', from `date.today()` appropriately.
TODO: Return Python3 date when date.fromisoformat() is available (Python v3.7+)
TODO: Handle 'today' and maybe other date string options.
'''
if date_requested == 'yesterday':
return (date.today() - timedelta(days=1)).isoformat()
if 'daysAgo' in date_requested:
days_ago = int(date_requested.replace('daysAgo', ''))
return (date.today() - timedelta(days=days_ago)).isoformat()
return date_requested # Assume already in ISO format.
parsed_reports = OrderedDict()
for idx, report_key_name in enumerate(raw_result['report_key_names']):
if save_raw_values:
parsed_reports[report_key_name] = {
"request" : raw_result['requests'][idx],
"raw_report" : raw_result['reports'][idx],
"results" : report_to_json_items(raw_result['reports'][idx])
}
else:
parsed_reports[report_key_name] = report_to_json_items(raw_result['reports'][idx])
for_date = None
# `start_date` and `end_date` must be same for all requests (defined in Google API docs) in a batchRequest, so we're ok getting from just first 1
if len(raw_result['requests']) > 0:
common_start_date = raw_result['requests'][0]['dateRanges'][0].get('startDate', '7daysAgo') # Google API default
common_end_date = raw_result['requests'][0]['dateRanges'][0].get('endDate', 'yesterday') # Google API default
if common_start_date:
common_start_date = parse_google_api_date(common_start_date)
if common_end_date:
common_end_date = parse_google_api_date(common_end_date)
# They should be the same
if date_increment == 'daily' and common_end_date != common_start_date:
raise Exception('Expected 1 day interval(s) for analytics, but startDate and endDate are different.')
if date_increment == 'monthly' and common_end_date[0:7] != common_start_date[0:7]:
raise Exception('Expected monthly interval(s) for analytics, but startDate and endDate "YYYY-MD" are different.')
for_date = common_start_date
return {
"reports" : parsed_reports,
"for_date" : for_date,
"date_increment" : date_increment
}
def __init__(self, syncer_instance):
_NestedGoogleServiceAPI.__init__(self, syncer_instance)
self.view_id = self.owner.extra_config.get('analytics_view_id', DEFAULT_GOOGLE_API_CONFIG['analytics_view_id'])
self._api = build('analyticsreporting', 'v4', credentials=self.owner.credentials, cache_discovery=False)
def get_report_provider_method_names(self):
'''
Collects name of every single method defined on this classes which is
marked with `@report` decorator (non-disabled) and returns in form of list.
'''
report_requests = []
for method_name in GoogleAPISyncer.AnalyticsAPI.__dict__.keys():
method_instance = getattr(self, method_name)
if method_instance and getattr(method_instance, 'is_report_provider', False):
report_requests.append(method_name)
return report_requests
def query_reports(self, report_requests=None, **kwargs):
'''
Run a query to Google Analytics API
Accepts either a list of reportRequests (according to Google Analytics API Docs) and returns their results,
or a list of strings which reference AnalyticsAPI methods (aside from this one).
See: https://developers.google.com/analytics/devguides/reporting/core/v4/rest/v4/reports/batchGet#ReportRequest
Arguments:
report_requests - A list of reportRequests.
Returns:
Parsed and transformed analytics data. See: GoogleAPISyncer.AnalyticsAPI.transform_report_result()
'''
if report_requests is None:
report_requests = self.get_report_provider_method_names()
report_key_names = None
all_reports_requested_as_strings = True
for r in report_requests:
if not isinstance(r, str):
all_reports_requested_as_strings = False
break
if all_reports_requested_as_strings:
report_key_names = report_requests
else:
# THIS DEPENDS ON CPYTHON TO WORK. PyPy or Jython = no go.
caller_method = None
try:
curframe = inspect.currentframe()
caller_frame = inspect.getouterframes(curframe, 2)
caller_method = caller_frame[1][3]
except:
pass
if isinstance(caller_method, str) and hasattr(self, caller_method):
report_key_names = [caller_method]
if report_key_names is None:
raise Exception("Cant determine report key names.")
def process_report_request_type(report_request, **kwargs):
if isinstance(report_request, str): # Convert string to dict by executing AnalyticsAPI[report_request](**kwargs)
report_request = getattr(self, report_request)(execute=False, **{ k:v for k,v in kwargs.items() if k in ('start_date', 'end_date') })
return dict(report_request, # Add required common key/vals, see https://developers.google.com/analytics/devguides/reporting/core/v4/basics.
viewId=self.view_id,
pageSize=report_request.get('pageSize', self.owner.extra_config.get('analytics_page_size', DEFAULT_GOOGLE_API_CONFIG['analytics_page_size']))
)
formatted_report_requests = [ process_report_request_type(r, **kwargs) for r in report_requests ]
# Google only permits 5 requests max within a batchRequest, so we need to chunk it up if over this -
report_request_count = len(formatted_report_requests)
if report_request_count > 5:
raw_result = { "reports" : [] }
for chunk_num in range(report_request_count // 5 + 1):
chunk_num_start = chunk_num * 5
chunk_num_end = min([chunk_num_start + 5, report_request_count])
for chunk_raw_res in self._api.reports().batchGet(body={ "reportRequests" : formatted_report_requests[chunk_num_start:chunk_num_end] }).execute().get('reports', []):
raw_result['reports'].append(chunk_raw_res)
else:
raw_result = self._api.reports().batchGet(body={ "reportRequests" : formatted_report_requests }).execute()
# We get back as raw_result:
# { "reports" : [{ "columnHeader" : { "dimensions" : [Xh, Yh, Zh], "metricHeaderEntries" : [{ "name" : 1h, "type" : "INTEGER" }, ...] }, "data" : { "rows": [{ "dimensions" : [X,Y,Z], "metrics" : [1,2,3,4] }] } }, { .. }, ....] }
raw_result['requests'] = formatted_report_requests
raw_result['report_key_names'] = report_key_names
# This transforms raw_result["reports"] into more usable data structure for ES and aggregation
# e.g. list of JSON items instead of multi-dimensional table representation
return self.transform_report_result(raw_result, date_increment=kwargs.get('increment')) # same as GoogleAPISyncer.AnalyticsAPI.transform_report_result(raw_result)
def get_latest_tracking_item_date(self, increment="daily"):
'''
Queries '/search/?type=TrackingItem&sort=-google_analytics.for_date&&google_analytics.date_increment=...'
to get date of last TrackingItem for increment in database.
TODO: Accept yearly once we want to collect & viz it.
'''
if increment not in ('daily', 'monthly'):
raise IndexError("increment parameter must be one of 'daily', 'monthly'")
search_results = ff_utils.search_metadata(
'/search/?type=TrackingItem&tracking_type=google_analytics&sort=-google_analytics.for_date&limit=1&google_analytics.date_increment=' + increment,
key=dict(self.owner.access_key, server=self.owner.server)
)
if len(search_results) == 0:
return None
iso_date = search_results[0]['google_analytics']['for_date']
# TODO: Use date.fromisoformat() once we're on Python 3.7
year, month, day = iso_date.split('-', 2) # In python, months are indexed from 1 <= month <= 12, not 0 <= month <= 11 like in JS.
return date(int(year), int(month), int(day))
def fill_with_tracking_items(self, increment):
'''
This method is meant to be run periodically to fetch/sync Google Analytics data into Fourfront database.
Adds 1 TrackingItem for each day to represent analytics data for said day.
Fill up from latest already-existing TrackingItem until day before current day (to get full day of data).
TODO:
`date.fromisoformat(...)` is not supported until Python 3.7 though (without extra libraries).
See: https://docs.python.org/3/library/datetime.html#datetime.date.fromisoformat
Args:
increment - One of 'daily', 'monthly', or 'yearly'. Required.
'''
last_tracking_item_date = self.get_latest_tracking_item_date(increment=increment)
today = date.today()
if last_tracking_item_date is None:
if increment == 'daily':
# Fill up with last 60 days of Google Analytics data, if no other TrackingItem(s) yet exist.
last_tracking_item_date = today - timedelta(days=61)
date_to_fill_from = last_tracking_item_date + timedelta(days=1)
elif increment == 'monthly':
# Fill up with last 6 months Google Analytics data, if no other TrackingItem(s) yet exist.
month_to_fill_from = today.month - 6
year_to_fill_from = today.year
while month_to_fill_from < 1:
month_to_fill_from = 12 + month_to_fill_from
year_to_fill_from += -1
date_to_fill_from = date(year_to_fill_from, month_to_fill_from, 1)
else:
if increment == 'daily':
# Day from which we begin to fill
date_to_fill_from = last_tracking_item_date + timedelta(days=1)
elif increment == 'monthly':
month_to_fill_from = last_tracking_item_date.month + 1
year_to_fill_from = last_tracking_item_date.year
if month_to_fill_from > 12:
month_to_fill_from = 1
year_to_fill_from += 1
date_to_fill_from = date(year_to_fill_from, month_to_fill_from, 1)
counter = 0
created_list = []
if increment == 'daily':
end_date = today - timedelta(days=1)
if date_to_fill_from > end_date:
return { 'created' : created_list, 'count' : counter }
while date_to_fill_from <= end_date:
for_date_str = date_to_fill_from.isoformat()
response = self.create_tracking_item(
do_post_request = True,
start_date = for_date_str,
end_date = for_date_str,
increment = increment
)
counter += 1
created_list.append(response['uuid'])
print('Created ' + str(counter) + ' TrackingItems so far.')
date_to_fill_from += timedelta(days=1)
elif increment == 'monthly':
end_year = today.year
end_month = today.month - 1
fill_year = date_to_fill_from.year
fill_month = date_to_fill_from.month
if end_month == 0:
end_year -= 1
end_month += 12
if fill_year > end_year and fill_month > end_month:
return { 'created' : created_list, 'count' : counter }
while fill_year <= end_year and fill_month <= end_month:
for_date_start_str = date(fill_year, fill_month, 1).isoformat()
for_date_end_str = date(fill_year, fill_month, monthrange(fill_year, fill_month)[1]).isoformat() # Last day of fill month
response = self.create_tracking_item(
do_post_request = True,
start_date = for_date_start_str,
end_date = for_date_end_str,
increment = increment
)
counter += 1
created_list.append(response['uuid'])
print('Created ' + str(counter) + ' TrackingItems so far.')
fill_month += 1
if fill_month > 12:
fill_month -= 12
fill_year += 1
return { 'created' : created_list, 'count' : counter }
def create_tracking_item(self, report_data=None, do_post_request=False, **kwargs):
'''
Wraps `report_data` in a TrackingItem Item.
If `do_post_request` is True, will also POST the Item into fourfront database, according to the access_keys
that the class was instantiated with.
If `report_data` is not supplied or set to None, will run query_reports() to get all reports defined as are defined in instance methods.
'''
if report_data is None:
report_data = self.query_reports(**kwargs)
# First make sure _all_ reporting methods defined on this class are included. Otherwise we might have tracking items in DB with missing data.
for method_name in self.get_report_provider_method_names():
if report_data['reports'].get(method_name) is None:
raise Exception("Not all potentially available data is included in report_data. Exiting.")
if not isinstance(report_data['reports'][method_name], list):
raise Exception("Can only make tracking_item for report_data which does not contain extra raw report and request data, per the schema.")
tracking_item = {
"status" : "released",
"tracking_type" : "google_analytics",
"google_analytics" : report_data
}
if do_post_request:
response = ff_utils.post_metadata(tracking_item, 'tracking-items', key=dict(self.owner.access_key, server=self.owner.server))
return response['@graph'][0]
else:
return tracking_item
@report
def sessions_by_country(self, start_date='yesterday', end_date='yesterday', execute=True):
report_request_json = {
'dateRanges' : [{ 'startDate' : start_date, 'endDate' : end_date }],
'metrics': [
{ 'expression': 'ga:sessions', 'formattingType' : 'INTEGER' },
{ 'expression': 'ga:users', 'formattingType' : 'INTEGER' },
{ 'expression': 'ga:pageviews', 'formattingType' : 'INTEGER' },
{ 'expression': 'ga:sessionsPerUser' },
{ 'expression': 'ga:avgSessionDuration' },
{ 'expression': 'ga:bounceRate' }
],
'dimensions': [
{ 'name': 'ga:country' }
]
}
if execute:
return self.query_reports([report_request_json])
return report_request_json
@report
def views_by_file(self, start_date='yesterday', end_date='yesterday', execute=True):
report_request_json = {
'dateRanges' : [{ 'startDate' : start_date, 'endDate' : end_date }],
'metrics': [
{ 'expression': 'ga:productDetailViews', 'formattingType' : 'INTEGER' },
{ 'expression': 'ga:productListClicks', 'formattingType' : 'INTEGER' },
{ 'expression': 'ga:productListViews', 'formattingType' : 'INTEGER' }
],
'dimensions': [
{ 'name': 'ga:productName' },
{ 'name': 'ga:productSku' },
{ 'name': 'ga:productCategoryLevel2' },
{ 'name': 'ga:productBrand' }
],
"orderBys" : [{ 'fieldName' : 'ga:productDetailViews', 'sortOrder' : 'descending' }],
'dimensionFilterClauses' : [
{
"filters" : [
{ "dimensionName" : "ga:productCategoryLevel1", "expressions" : ["File"], "operator" : "EXACT" }
]
}
],
'pageSize' : 100
}
if execute:
return self.query_reports([report_request_json])
return report_request_json
@report
def views_by_experiment_set(self, start_date='yesterday', end_date='yesterday', execute=True):
report_request_json = {
'dateRanges' : [{ 'startDate' : start_date, 'endDate' : end_date }],
'metrics': [
{ 'expression': 'ga:productDetailViews', 'formattingType' : 'INTEGER' },
{ 'expression': 'ga:productListClicks', 'formattingType' : 'INTEGER' },
{ 'expression': 'ga:productListViews', 'formattingType' : 'INTEGER' }
],
'dimensions': [
{ 'name': 'ga:productName' },
{ 'name': 'ga:productSku' },
{ 'name': 'ga:productCategoryLevel2' },
{ 'name': 'ga:productBrand' }
],
"orderBys" : [{ 'fieldName' : 'ga:productDetailViews', 'sortOrder' : 'descending' }],
'dimensionFilterClauses' : [
{
"filters" : [
{ "dimensionName" : "ga:productCategoryLevel1", "expressions" : ["ExperimentSet"], "operator" : "EXACT" }
]
}
],
'pageSize' : 100
}
if execute:
return self.query_reports([report_request_json])
return report_request_json
@report(disabled=True)
def views_by_other_item(self, start_date='yesterday', end_date='yesterday', execute=True):
report_request_json = {
'dateRanges' : [{ 'startDate' : start_date, 'endDate' : end_date }],
'dimensions': [
{ 'name': 'ga:productName' },
{ 'name': 'ga:productSku' },
{ 'name': 'ga:productCategoryHierarchy' },
{ 'name': 'ga:productBrand' }
],
'metrics': [
{ 'expression': 'ga:productDetailViews', 'formattingType' : 'INTEGER' },
{ 'expression': 'ga:productListClicks', 'formattingType' : 'INTEGER' },
{ 'expression': 'ga:productListViews', 'formattingType' : 'INTEGER' }
],
"orderBys" : [{ 'fieldName' : 'ga:productDetailViews', 'sortOrder' : 'descending' }],
'dimensionFilterClauses' : [
{
"filters" : [
{
"not" : True,
"dimensionName" : "ga:productCategoryLevel1",
"expressions" : ["ExperimentSet"],
"operator" : "PARTIAL"
},
{
"not" : True,
"dimensionName" : "ga:productCategoryLevel1",
"expressions" : ["File"],
"operator" : "EXACT"
}
]
}
],
'pageSize' : 20
}
if execute:
return self.query_reports([report_request_json])
return report_request_json
@report(disabled=True)
def search_search_queries(self, start_date='yesterday', end_date='yesterday', execute=True):
report_request_json = {
'dateRanges' : [{ 'startDate' : start_date, 'endDate' : end_date }],
'dimensions': [
{ 'name': 'ga:searchKeyword' }
],
'metrics': [
{ 'expression': 'ga:users', 'formattingType' : 'INTEGER' },
{ 'expression': 'ga:sessions', 'formattingType' : 'INTEGER' },
{ 'expression': 'ga:pageviews', 'formattingType' : 'INTEGER' }
],
"orderBys" : [{ 'fieldName' : 'ga:pageviews', 'sortOrder' : 'descending' }],
'dimensionFilterClauses' : [
{
"filters" : [
{
"dimensionName" : "ga:searchDestinationPage",
"expressions" : ["/search/"],
"operator" : "PARTIAL"
}
]
}
]
}
if execute:
return self.query_reports([report_request_json])
return report_request_json
@report(disabled=True)
def browse_search_queries(self, start_date='yesterday', end_date='yesterday', execute=True):
report_request_json = {
'dateRanges' : [{ 'startDate' : start_date, 'endDate' : end_date }],
'dimensions': [
{ 'name': 'ga:searchKeyword' }
],
'metrics': [
{ 'expression': 'ga:users', 'formattingType' : 'INTEGER' },
{ 'expression': 'ga:sessions', 'formattingType' : 'INTEGER' },
{ 'expression': 'ga:pageviews', 'formattingType' : 'INTEGER' }
],
"orderBys" : [{ 'fieldName' : 'ga:pageviews', 'sortOrder' : 'descending' }],
'dimensionFilterClauses' : [
{
"filters" : [
{
"dimensionName" : "ga:searchDestinationPage",
"expressions" : ["/browse/"],
"operator" : "PARTIAL"
}
]
}
]
}
if execute:
return self.query_reports([report_request_json])
return report_request_json
@report
def fields_faceted(self, start_date='yesterday', end_date='yesterday', execute=True):
report_request_json = {
'dateRanges' : [{ 'startDate' : start_date, 'endDate' : end_date }],
'dimensions': [
#{ 'name': 'ga:eventLabel' }, # Too many distinct terms if we make it this granular.
{ 'name': 'ga:dimension3' }, # Field Name
#{ 'name': 'ga:dimension4' } # Term Name # # Too many distinct terms if we make it this granular.
],
'metrics': [
{ 'expression': 'ga:totalEvents', 'formattingType' : 'INTEGER' },
{ 'expression': 'ga:sessions', 'formattingType' : 'INTEGER' },
{ 'expression': 'ga:users', 'formattingType' : 'INTEGER' }
],
"orderBys" : [{ 'fieldName' : 'ga:totalEvents', 'sortOrder' : 'descending' }],
'dimensionFilterClauses' : [
{
"filters" : [
{
"dimensionName" : "ga:eventAction",
"expressions" : ["Set Filter"],
"operator" : "EXACT"
}
]
}
]
}
if execute:
return self.query_reports([report_request_json])
return report_request_json
class SheetsAPI(_NestedGoogleServiceAPI):
'''
Use this sub-class to help query, read, edit, and analyze spreadsheet data, which will be returned in form of multi-dimensional JSON array.
TODO: Implement
'''
pass
class DocsAPI(_NestedGoogleServiceAPI):
'''
Use this sub-class to help query, read, and edit Google Doc data.
TODO: Implement
'''
pass