Google Play Developer Reporting API . vitals . errors . reports

Instance Methods

close()

Close httplib2 connections.

search(parent, filter=None, interval_endTime_day=None, interval_endTime_hours=None, interval_endTime_minutes=None, interval_endTime_month=None, interval_endTime_nanos=None, interval_endTime_seconds=None, interval_endTime_timeZone_id=None, interval_endTime_timeZone_version=None, interval_endTime_utcOffset=None, interval_endTime_year=None, interval_startTime_day=None, interval_startTime_hours=None, interval_startTime_minutes=None, interval_startTime_month=None, interval_startTime_nanos=None, interval_startTime_seconds=None, interval_startTime_timeZone_id=None, interval_startTime_timeZone_version=None, interval_startTime_utcOffset=None, interval_startTime_year=None, pageSize=None, pageToken=None, x__xgafv=None)

Searches all error reports received for an app.

search_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
search(parent, filter=None, interval_endTime_day=None, interval_endTime_hours=None, interval_endTime_minutes=None, interval_endTime_month=None, interval_endTime_nanos=None, interval_endTime_seconds=None, interval_endTime_timeZone_id=None, interval_endTime_timeZone_version=None, interval_endTime_utcOffset=None, interval_endTime_year=None, interval_startTime_day=None, interval_startTime_hours=None, interval_startTime_minutes=None, interval_startTime_month=None, interval_startTime_nanos=None, interval_startTime_seconds=None, interval_startTime_timeZone_id=None, interval_startTime_timeZone_version=None, interval_startTime_utcOffset=None, interval_startTime_year=None, pageSize=None, pageToken=None, x__xgafv=None)
Searches all error reports received for an app.

Args:
  parent: string, Required. Parent resource of the reports, indicating the application for which they were received. Format: apps/{app} (required)
  filter: string, A selection predicate to retrieve only a subset of the reports. For filtering basics, please check [AIP-160](https://google.aip.dev/160). ** Supported field names:** * `apiLevel`: Matches error reports that occurred in the requested Android versions (specified as the numeric API level) only. Example: `apiLevel = 28 OR apiLevel = 29`. * `versionCode`: Matches error reports that occurred in the requested app version codes only. Example: `versionCode = 123 OR versionCode = 456`. * `deviceModel`: Matches error issues that occurred in the requested devices. Example: `deviceModel = "google/walleye" OR deviceModel = "google/marlin"`. * `deviceBrand`: Matches error issues that occurred in the requested device brands. Example: `deviceBrand = "Google". * `deviceType`: Matches error reports that occurred in the requested device types. Example: `deviceType = "PHONE"`. * `errorIssueType`: Matches error reports of the requested types only. Valid candidates: `CRASH`, `ANR`. Example: `errorIssueType = CRASH OR errorIssueType = ANR`. * `errorIssueId`: Matches error reports belonging to the requested error issue ids only. Example: `errorIssueId = 1234 OR errorIssueId = 4567`. * `errorReportId`: Matches error reports with the requested error report id. Example: `errorReportId = 1234 OR errorReportId = 4567`. * `appProcessState`: Matches error reports on the process state of an app, indicating whether an app runs in the foreground (user-visible) or background. Valid candidates: `FOREGROUND`, `BACKGROUND`. Example: `appProcessState = FOREGROUND`. * `isUserPerceived`: Matches error reports that are user-perceived. It is not accompanied by any operators. Example: `isUserPerceived`. ** Supported operators:** * Comparison operators: The only supported comparison operator is equality. The filtered field must appear on the left hand side of the comparison. * Logical Operators: Logical operators `AND` and `OR` can be used to build complex filters following a conjunctive normal form (CNF), i.e., conjunctions of disjunctions. The `OR` operator takes precedence over `AND` so the use of parenthesis is not necessary when building CNF. The `OR` operator is only supported to build disjunctions that apply to the same field, e.g., `versionCode = 123 OR versionCode = ANR`. The filter expression `versionCode = 123 OR errorIssueType = ANR` is not valid. ** Examples ** Some valid filtering expressions: * `versionCode = 123 AND errorIssueType = ANR` * `versionCode = 123 AND errorIssueType = OR errorIssueType = CRASH` * `versionCode = 123 AND (errorIssueType = OR errorIssueType = CRASH)`
  interval_endTime_day: integer, Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
  interval_endTime_hours: integer, Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
  interval_endTime_minutes: integer, Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
  interval_endTime_month: integer, Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
  interval_endTime_nanos: integer, Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
  interval_endTime_seconds: integer, Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
  interval_endTime_timeZone_id: string, IANA Time Zone Database time zone, e.g. "America/New_York".
  interval_endTime_timeZone_version: string, Optional. IANA Time Zone Database version number, e.g. "2019a".
  interval_endTime_utcOffset: string, UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
  interval_endTime_year: integer, Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
  interval_startTime_day: integer, Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
  interval_startTime_hours: integer, Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
  interval_startTime_minutes: integer, Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
  interval_startTime_month: integer, Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
  interval_startTime_nanos: integer, Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
  interval_startTime_seconds: integer, Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
  interval_startTime_timeZone_id: string, IANA Time Zone Database time zone, e.g. "America/New_York".
  interval_startTime_timeZone_version: string, Optional. IANA Time Zone Database version number, e.g. "2019a".
  interval_startTime_utcOffset: string, UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
  interval_startTime_year: integer, Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
  pageSize: integer, The maximum number of reports to return. The service may return fewer than this value. If unspecified, at most 50 reports will be returned. The maximum value is 100; values above 100 will be coerced to 100.
  pageToken: string, A page token, received from a previous `SearchErrorReports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchErrorReports` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response with a paginated list of error reports matching the search query.
  "errorReports": [ # Error reports that were found.
    { # An error report received for an app. There reports are produced by the Android platform code when a (potentially fatal) error condition is detected. Identical reports from many users will be deduplicated and coalesced into a single ErrorReport. **Required permissions**: to access this resource, the calling user needs the _View app information (read-only)_ permission for the app.
      "appVersion": { # Representations of an app version. # The app version on which an event in this error report occurred on.
        "versionCode": "A String", # Numeric version code of the app version (set by the app's developer).
      },
      "deviceModel": { # Summary of a device # A device model on which an event in this error report occurred on.
        "deviceId": { # Identifier of a device. # Identifier of the device.
          "buildBrand": "A String", # Value of Build.BRAND.
          "buildDevice": "A String", # Value of Build.DEVICE.
        },
        "deviceUri": "A String", # Link to the device in Play Device Catalog.
        "marketingName": "A String", # Display name of the device.
      },
      "eventTime": "A String", # Start of the hour during which the latest event in this error report occurred.
      "issue": "A String", # The issue this report was associated with. **Please note:** this resource is currently in Alpha. There could be changes to the issue grouping that would result in similar but more recent error reports being assigned to a different issue.
      "name": "A String", # The resource name of the report. Format: apps/{app}/{report}
      "osVersion": { # Representation of an OS version. # The OS version on which an event in this error report occurred on.
        "apiLevel": "A String", # Numeric version code of the OS - API level
      },
      "reportText": "A String", # Textual representation of the error report. These textual reports are produced by the platform. The reports are then sanitized and filtered to remove any potentially sensitive information. Although their format is fairly stable, they are not entirely meant for machine consumption and we cannot guarantee that there won't be subtle changes to the formatting that may break systems trying to parse information out of the reports.
      "type": "A String", # Type of the error for which this report was generated.
      "vcsInformation": "A String", # Version control system information from BUNDLE-METADATA/version-control-info.textproto or META-INF/version-control-info.textproto of the app bundle or APK, respectively.
    },
  ],
  "nextPageToken": "A String", # Page token to fetch the next page of reports.
}
search_next()
Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.