Skip to content

Modules

BaseReportingService

Source code in google_play_developer_api/report/base_report.py 
  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
class BaseReportingService:
    def __init__(self, credentials_path: str):
        credentials = service_account.Credentials.from_service_account_file(
            credentials_path, scopes=["https://www.googleapis.com/auth/playdeveloperreporting"]
        )
        self._reporting_service = build(serviceName="playdeveloperreporting",
                                        version="v1beta1",
                                        credentials=credentials,
                                        cache_discovery=False)

        self._metric_sets = {
            'anomalies': self._reporting_service.anomalies(),
            'anrRateMetricSet': self._reporting_service.vitals().anrrate(),
            'crashRateMetricSet': self._reporting_service.vitals().crashrate(),
            'errorCountMetricSet': self._reporting_service.vitals().errors().counts(),
            'errorIssues': self._reporting_service.vitals().errors().issues(),
            'errorReports': self._reporting_service.vitals().errors().reports(),
            'excessiveWakeupRateMetricSet': self._reporting_service.vitals().excessivewakeuprate(),
            'slowRenderingRateMetricSet': self._reporting_service.vitals().slowrenderingrate(),
            'slowStartRateMetricSet': self._reporting_service.vitals().slowstartrate(),
            'stuckBackgroundWakelockRateMetricSet': self._reporting_service.vitals().stuckbackgroundwakelockrate(),
        }

    def _query(
        self,
        app_package_name: str = "",
        timeline_spec: dict = {},
        dimensions: list[str] = [],
        metrics: list[str] = [],
        metric_set: str = "",
        page_size: int = 50000,
        retry_count: int = 3,
        sleep_time: int = 15,
    ) -> list[dict]:
        """
        Query report data from Google Play Developer API

        Note: Read this doc
        https://developers.google.com/play/developer/reporting/reference/rest

        Args:
            app_package_name: App package name
            timeline_spec: Timeline spec (see docs above)
            dimensions: Dimensions (see docs above)
            metrics: Metrics (see docs above)
            metric_set: One of ['anrRateMetricSet', 'crashRateMetricSet', 'errorCountMetricSet', 'excessiveWakeupRateMetricSet', 'slowRenderingRateMetricSet', 'slowStartRateMetricSet', 'stuckBackgroundWakelockRateMetricSet']
            page_size: Page size

        Returns:
            List of dicts with report data
        """
        # GET DATA
        page_token = ""
        rows = []
        while True:
            body = {
                "dimensions": dimensions,
                "metrics": metrics,
                "timelineSpec": timeline_spec,
                "pageSize": page_size,
                "pageToken": page_token
            }

            for i in range(retry_count):
                try:
                    report = self._metric_sets[metric_set].query(name=f"apps/{app_package_name}/{metric_set}",
                                                                 body=body).execute()
                    break
                except HttpError as e:
                    if e.resp.status == 403:
                        logging.warning(f'Permission denied for {app_package_name}')
                    elif e.resp.status == 400:
                        logging.warning(f'Bad request for {app_package_name}, {e.reason}')
                        raise e
                    return []

                except TimeoutError as e:
                    raise e
                except Exception as e:
                    if i == retry_count - 1:
                        raise e
                    else:
                        time.sleep(sleep_time)
                        logging.warning(f"Retry {i + 1}/{retry_count}...")
                        continue

            rows.extend(report.get("rows", []))
            page_token = report.get("nextPageToken", "")
            if not page_token:
                break

        # PARSE DATA
        result_list = []
        for row in rows:
            year = row["startTime"].get("year")
            month = row["startTime"].get("month")
            day = row["startTime"].get("day")

            # Add hour if aggregationPeriod is HOURLY
            if timeline_spec["aggregationPeriod"] == "HOURLY":
                hour = row["startTime"].get("hours", "00")
                hour = f" {hour}:00"
            else:
                hour = ""

            result = {
                "eventDate": f"{year}-{month}-{day}{hour}",
                "timeZone": row["startTime"]["timeZone"]["id"],
                "appPackageName": app_package_name,
            }

            # dimensions
            _dimensions = row.get("dimensions", [])
            for dimension in _dimensions:
                if "stringValue" in dimension:
                    result[f'{dimension["dimension"]}'] = dimension["stringValue"]
                elif "int64Value" in dimension:
                    result[f'{dimension["dimension"]}'] = dimension["int64Value"]
                else:
                    result[f'{dimension["dimension"]}'] = ""
            # metrics
            _metrics = row.get("metrics", [])
            for metric in _metrics:
                result[f'{metric["metric"]}'] = metric["decimalValue"]["value"] if "decimalValue" in metric else ""

            result_list.append(result)

        return result_list

    def get_freshnesses(self,
                        app_package_name: str = None,
                        metric_set: str = None,
                        retry_count: int = 3,
                        sleep_time: int = 5):
        """
        Get freshnesses of a report

        Args:
            app_package_name: App package name
            metric_set: One of ['anrRateMetricSet', 'crashRateMetricSet', 'errorCountMetricSet', 'excessiveWakeupRateMetricSet', 'slowRenderingRateMetricSet', 'slowStartRateMetricSet', 'stuckBackgroundWakelockRateMetricSet']
            retry_count: number of retries
            sleep_time: time to sleep between retries (seconds)

        Returns:
            Dict with freshnesses
        """
        import time

        metric_set = self._metric_set if not metric_set else metric_set  # Default of each child class
        for i in range(retry_count):
            try:
                data = self._metric_sets[metric_set].get(name=f"apps/{app_package_name}/{metric_set}").execute()
                break
            except Exception as e:
                if i == retry_count - 1:
                    raise e
                else:
                    time.sleep(sleep_time)
                    continue

        freshnesses = data.get('freshnessInfo', {}).get('freshnesses', [])
        result = {
            'HOURLY': {},
            'DAILY': {},
        }

        for freshness in freshnesses:
            latest_end_time = freshness.get('latestEndTime', {})
            time_zone = latest_end_time.get('timeZone', {})
            year = latest_end_time.get('year')
            month = latest_end_time.get('month')
            day = latest_end_time.get('day')
            hour = latest_end_time.get('hours', 0)

            result[freshness['aggregationPeriod']] = {
                'event_date': f"{year}-{month}-{day} {hour}:00",
                'time_zone': time_zone,
            }

        return result

    def get_hourly(
        self,
        app_package_name: str = "",
        start_time: str = "YYYY-MM-DD HH:MM",
        end_time: str = "YYYY-MM-DD HH:MM",
        dimensions: list[str] = [],
        metrics: list[str] = [],
        metric_set: str = None,
        **kwargs,
    ) -> list[dict]:
        """
        Get hourly report data from Google Play Developer API

        Args:
            app_package_name: App package name
            start_time: Start time (format: YYYY-MM-DD HH:MM)
            end_time: End time (format: YYYY-MM-DD HH:MM)
            dimensions: Dimensions
            metrics: Metrics
            metric_set: One of ['anrRateMetricSet', 'crashRateMetricSet', 'errorCountMetricSet', 'excessiveWakeupRateMetricSet', 'slowRenderingRateMetricSet', 'slowStartRateMetricSet', 'stuckBackgroundWakelockRateMetricSet']

        Returns:
            List of dicts with report data
        """
        dimensions = self._default_dimensions if dimensions is None else dimensions
        metrics = self._default_metrics if metrics is None else metrics
        metric_set = self._metric_set if metric_set is None else metric_set  # Default of each child class

        start_time = datetime.datetime.strptime(start_time, "%Y-%m-%d %H:%M")
        end_time = datetime.datetime.strptime(end_time, "%Y-%m-%d %H:%M")

        timeline_spec = {
            "aggregationPeriod": "HOURLY",
            "startTime": {
                "year": start_time.year,
                "month": start_time.month,
                "day": start_time.day,
                "hours": start_time.hour,
            },
            "endTime": {
                "year": end_time.year,
                "month": end_time.month,
                "day": end_time.day,
                "hours": end_time.hour,
            },
        }

        return self._query(
            app_package_name=app_package_name,
            timeline_spec=timeline_spec,
            dimensions=dimensions,
            metrics=metrics,
            metric_set=metric_set,
            **kwargs,
        )

    def get_daily(
        self,
        app_package_name: str = "",
        start_time: str = "YYYY-MM-DD",
        end_time: str = "YYYY-MM-DD",
        dimensions: list[str] = None,
        metrics: list[str] = None,
        metric_set: str = None,
        **kwargs,
    ) -> list[dict]:
        """
        Get daily report data from Google Play Developer API

        Args:
            app_package_name: App package name
            start_time: Start time (format: YYYY-MM-DD)
            end_time: End time (format: YYYY-MM-DD)
            dimensions: Dimensions
            metrics: Metrics
            metric_set: One of ['anrRateMetricSet', 'crashRateMetricSet', 'errorCountMetricSet', 'excessiveWakeupRateMetricSet', 'slowRenderingRateMetricSet', 'slowStartRateMetricSet', 'stuckBackgroundWakelockRateMetricSet']

        Returns:
            List of dicts with report data
        """
        dimensions = self._default_dimensions if dimensions is None else dimensions
        metrics = self._default_metrics if metrics is None else metrics
        metric_set = self._metric_set if metric_set is None else metric_set  # Default of each child class

        start_time = datetime.datetime.strptime(start_time, "%Y-%m-%d")
        end_time = datetime.datetime.strptime(end_time, "%Y-%m-%d")

        timeline_spec = {
            "aggregationPeriod": "DAILY",
            "startTime": {
                "year": start_time.year,
                "month": start_time.month,
                "day": start_time.day,
                "timeZone": {"id": "America/Los_Angeles"},
            },
            "endTime": {
                "year": end_time.year,
                "month": end_time.month,
                "day": end_time.day,
                "timeZone": {"id": "America/Los_Angeles"},
            },
        }

        return self._query(
            app_package_name=app_package_name,
            timeline_spec=timeline_spec,
            dimensions=dimensions,
            metrics=metrics,
            metric_set=metric_set,
            **kwargs,
        )

get_daily(app_package_name='', start_time='YYYY-MM-DD', end_time='YYYY-MM-DD', dimensions=None, metrics=None, metric_set=None, **kwargs)

Get daily report data from Google Play Developer API

Parameters:

Name Type Description Default
app_package_name str

App package name

 ''
start_time str

Start time (format: YYYY-MM-DD)

 'YYYY-MM-DD'
end_time str

End time (format: YYYY-MM-DD)

 'YYYY-MM-DD'
dimensions list[str]

Dimensions

 None
metrics list[str]

Metrics

 None
metric_set str

One of ['anrRateMetricSet', 'crashRateMetricSet', 'errorCountMetricSet', 'excessiveWakeupRateMetricSet', 'slowRenderingRateMetricSet', 'slowStartRateMetricSet', 'stuckBackgroundWakelockRateMetricSet']

 None

Returns:

Type Description
list[dict]

List of dicts with report data
Source code in google_play_developer_api/report/base_report.py 
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
def get_daily(
    self,
    app_package_name: str = "",
    start_time: str = "YYYY-MM-DD",
    end_time: str = "YYYY-MM-DD",
    dimensions: list[str] = None,
    metrics: list[str] = None,
    metric_set: str = None,
    **kwargs,
) -> list[dict]:
    """
    Get daily report data from Google Play Developer API

    Args:
        app_package_name: App package name
        start_time: Start time (format: YYYY-MM-DD)
        end_time: End time (format: YYYY-MM-DD)
        dimensions: Dimensions
        metrics: Metrics
        metric_set: One of ['anrRateMetricSet', 'crashRateMetricSet', 'errorCountMetricSet', 'excessiveWakeupRateMetricSet', 'slowRenderingRateMetricSet', 'slowStartRateMetricSet', 'stuckBackgroundWakelockRateMetricSet']

    Returns:
        List of dicts with report data
    """
    dimensions = self._default_dimensions if dimensions is None else dimensions
    metrics = self._default_metrics if metrics is None else metrics
    metric_set = self._metric_set if metric_set is None else metric_set  # Default of each child class

    start_time = datetime.datetime.strptime(start_time, "%Y-%m-%d")
    end_time = datetime.datetime.strptime(end_time, "%Y-%m-%d")

    timeline_spec = {
        "aggregationPeriod": "DAILY",
        "startTime": {
            "year": start_time.year,
            "month": start_time.month,
            "day": start_time.day,
            "timeZone": {"id": "America/Los_Angeles"},
        },
        "endTime": {
            "year": end_time.year,
            "month": end_time.month,
            "day": end_time.day,
            "timeZone": {"id": "America/Los_Angeles"},
        },
    }

    return self._query(
        app_package_name=app_package_name,
        timeline_spec=timeline_spec,
        dimensions=dimensions,
        metrics=metrics,
        metric_set=metric_set,
        **kwargs,
    )

get_freshnesses(app_package_name=None, metric_set=None, retry_count=3, sleep_time=5)

Get freshnesses of a report

Parameters:

Name Type Description Default
app_package_name str

App package name

 None
metric_set str

One of ['anrRateMetricSet', 'crashRateMetricSet', 'errorCountMetricSet', 'excessiveWakeupRateMetricSet', 'slowRenderingRateMetricSet', 'slowStartRateMetricSet', 'stuckBackgroundWakelockRateMetricSet']

 None
retry_count int

number of retries

 3
sleep_time int

time to sleep between retries (seconds)

 5

Returns:

Type Description

Dict with freshnesses
Source code in google_play_developer_api/report/base_report.py 
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
def get_freshnesses(self,
                    app_package_name: str = None,
                    metric_set: str = None,
                    retry_count: int = 3,
                    sleep_time: int = 5):
    """
    Get freshnesses of a report

    Args:
        app_package_name: App package name
        metric_set: One of ['anrRateMetricSet', 'crashRateMetricSet', 'errorCountMetricSet', 'excessiveWakeupRateMetricSet', 'slowRenderingRateMetricSet', 'slowStartRateMetricSet', 'stuckBackgroundWakelockRateMetricSet']
        retry_count: number of retries
        sleep_time: time to sleep between retries (seconds)

    Returns:
        Dict with freshnesses
    """
    import time

    metric_set = self._metric_set if not metric_set else metric_set  # Default of each child class
    for i in range(retry_count):
        try:
            data = self._metric_sets[metric_set].get(name=f"apps/{app_package_name}/{metric_set}").execute()
            break
        except Exception as e:
            if i == retry_count - 1:
                raise e
            else:
                time.sleep(sleep_time)
                continue

    freshnesses = data.get('freshnessInfo', {}).get('freshnesses', [])
    result = {
        'HOURLY': {},
        'DAILY': {},
    }

    for freshness in freshnesses:
        latest_end_time = freshness.get('latestEndTime', {})
        time_zone = latest_end_time.get('timeZone', {})
        year = latest_end_time.get('year')
        month = latest_end_time.get('month')
        day = latest_end_time.get('day')
        hour = latest_end_time.get('hours', 0)

        result[freshness['aggregationPeriod']] = {
            'event_date': f"{year}-{month}-{day} {hour}:00",
            'time_zone': time_zone,
        }

    return result

get_hourly(app_package_name='', start_time='YYYY-MM-DD HH:MM', end_time='YYYY-MM-DD HH:MM', dimensions=[], metrics=[], metric_set=None, **kwargs)

Get hourly report data from Google Play Developer API

Parameters:

Name Type Description Default
app_package_name str

App package name

 ''
start_time str

Start time (format: YYYY-MM-DD HH:MM)

 'YYYY-MM-DD HH:MM'
end_time str

End time (format: YYYY-MM-DD HH:MM)

 'YYYY-MM-DD HH:MM'
dimensions list[str]

Dimensions

 []
metrics list[str]

Metrics

 []
metric_set str

One of ['anrRateMetricSet', 'crashRateMetricSet', 'errorCountMetricSet', 'excessiveWakeupRateMetricSet', 'slowRenderingRateMetricSet', 'slowStartRateMetricSet', 'stuckBackgroundWakelockRateMetricSet']

 None

Returns:

Type Description
list[dict]

List of dicts with report data
Source code in google_play_developer_api/report/base_report.py 
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
def get_hourly(
    self,
    app_package_name: str = "",
    start_time: str = "YYYY-MM-DD HH:MM",
    end_time: str = "YYYY-MM-DD HH:MM",
    dimensions: list[str] = [],
    metrics: list[str] = [],
    metric_set: str = None,
    **kwargs,
) -> list[dict]:
    """
    Get hourly report data from Google Play Developer API

    Args:
        app_package_name: App package name
        start_time: Start time (format: YYYY-MM-DD HH:MM)
        end_time: End time (format: YYYY-MM-DD HH:MM)
        dimensions: Dimensions
        metrics: Metrics
        metric_set: One of ['anrRateMetricSet', 'crashRateMetricSet', 'errorCountMetricSet', 'excessiveWakeupRateMetricSet', 'slowRenderingRateMetricSet', 'slowStartRateMetricSet', 'stuckBackgroundWakelockRateMetricSet']

    Returns:
        List of dicts with report data
    """
    dimensions = self._default_dimensions if dimensions is None else dimensions
    metrics = self._default_metrics if metrics is None else metrics
    metric_set = self._metric_set if metric_set is None else metric_set  # Default of each child class

    start_time = datetime.datetime.strptime(start_time, "%Y-%m-%d %H:%M")
    end_time = datetime.datetime.strptime(end_time, "%Y-%m-%d %H:%M")

    timeline_spec = {
        "aggregationPeriod": "HOURLY",
        "startTime": {
            "year": start_time.year,
            "month": start_time.month,
            "day": start_time.day,
            "hours": start_time.hour,
        },
        "endTime": {
            "year": end_time.year,
            "month": end_time.month,
            "day": end_time.day,
            "hours": end_time.hour,
        },
    }

    return self._query(
        app_package_name=app_package_name,
        timeline_spec=timeline_spec,
        dimensions=dimensions,
        metrics=metrics,
        metric_set=metric_set,
        **kwargs,
    )