Google Play Developer Reporting API (playdeveloperreporting:v1beta1)

2023-03-24

8 new methods

Additions

    Methods
  • playdeveloperreporting.vitals.errors.issues.search

      Description : Searches all error issues in which reports have been grouped.

      Parameters :

        interval.startTime.day

          Description : 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.

          Type : integer

          Location : query

          Format : int32

        interval.startTime.month

          Type : integer

          Location : query

          Description : Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.

          Format : int32

        interval.endTime.timeZone.version

          Location : query

          Description : Optional. IANA Time Zone Database version number, e.g. "2019a".

          Type : string

        interval.endTime.minutes

          Type : integer

          Description : Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.

          Location : query

          Format : int32

        interval.endTime.hours

          Type : integer

          Format : int32

          Location : query

          Description : 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.day

          Location : query

          Format : int32

          Description : 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.

          Type : integer

        filter

          Description : A selection predicate to retrieve only a subset of the issues. Counts in the returned error issues will only reflect occurrences that matched the filter. For filtering basics, please check [AIP-160](https://google.aip.dev/160). ** Supported field names:** * `apiLevel`: Matches error issues that occurred in the requested Android versions (specified as the numeric API level) only. Example: `apiLevel = 28 OR apiLevel = 29`. * `versionCode`: Matches error issues 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 = "walleye" OR deviceModel = "marlin"`. * `deviceType`: Matches error issues that occurred in the requested device types. Example: `deviceType = "PHONE"`. * `errorIssueType`: Matches error issues of the requested types only. Valid candidates: `CRASH`, `ANR`. Example: `errorIssueType = CRASH OR errorIssueType = ANR`. * `appProcessState`: Matches error issues 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 issues 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 errorIssueType = ANR` is not a valid filter. ** Examples ** Some valid filtering expressions: * `versionCode = 123 AND errorIssueType = ANR` * `versionCode = 123 AND errorIssueType = OR errorIssueType = CRASH` * `versionCode = 123 AND (errorIssueType = OR errorIssueType = CRASH)`

          Location : query

          Type : string

        pageToken

          Location : query

          Type : string

          Description : A page token, received from a previous call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to the request must match the call that provided the page token.

        interval.startTime.seconds

          Type : integer

          Description : 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.

          Format : int32

          Location : query

        interval.startTime.minutes

          Location : query

          Description : Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.

          Format : int32

          Type : integer

        interval.endTime.utcOffset

          Type : string

          Description : 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 }.

          Location : query

          Format : google-duration

        interval.startTime.timeZone.id

          Location : query

          Description : IANA Time Zone Database time zone, e.g. "America/New_York".

          Type : string

        interval.startTime.hours

          Type : integer

          Format : int32

          Description : 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.

          Location : query

        interval.endTime.seconds

          Format : int32

          Location : query

          Type : integer

          Description : 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.utcOffset

          Location : query

          Format : google-duration

          Type : string

          Description : 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.nanos

          Description : Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.

          Format : int32

          Location : query

          Type : integer

        interval.startTime.timeZone.version

          Type : string

          Location : query

          Description : Optional. IANA Time Zone Database version number, e.g. "2019a".

        parent

          Description : Required. Parent resource of the error issues, indicating the application for which they were received. Format: apps/{app}

          Pattern : ^apps/[^/]+$

          Type : string

          Location : path

          Required : Yes

        interval.endTime.month

          Type : integer

          Description : Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.

          Location : query

          Format : int32

        interval.endTime.timeZone.id

          Type : string

          Description : IANA Time Zone Database time zone, e.g. "America/New_York".

          Location : query

        interval.startTime.year

          Description : Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.

          Location : query

          Format : int32

          Type : integer

        interval.endTime.year

          Type : integer

          Description : Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.

          Location : query

          Format : int32

        interval.startTime.nanos

          Location : query

          Type : integer

          Description : Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.

          Format : int32

        pageSize

          Description : The maximum number of error issues to return. The service may return fewer than this value. If unspecified, at most 50 error issues will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

          Location : query

          Type : integer

          Format : int32

      Parameter Order : parent

      HTTP Method : GET

      Path : v1beta1/{+parent}/errorIssues:search

      Scopes : https://www.googleapis.com/auth/playdeveloperreporting

      Flat Path : v1beta1/apps/{appsId}/errorIssues:search

  • playdeveloperreporting.vitals.errors.reports.search

      Flat Path : v1beta1/apps/{appsId}/errorReports:search

      Scopes : https://www.googleapis.com/auth/playdeveloperreporting

      HTTP Method : GET

      Parameters :

        interval.endTime.minutes

          Description : Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.

          Type : integer

          Location : query

          Format : int32

        pageToken

          Description : 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.

          Location : query

          Type : string

        interval.endTime.nanos

          Description : Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.

          Format : int32

          Type : integer

          Location : query

        interval.startTime.minutes

          Format : int32

          Location : query

          Description : Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.

          Type : integer

        interval.endTime.timeZone.version

          Type : string

          Location : query

          Description : Optional. IANA Time Zone Database version number, e.g. "2019a".

        interval.startTime.month

          Location : query

          Type : integer

          Format : int32

          Description : Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.

        interval.endTime.utcOffset

          Type : string

          Format : google-duration

          Description : 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 }.

          Location : query

        interval.endTime.day

          Format : int32

          Type : integer

          Description : 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.

          Location : query

        interval.startTime.nanos

          Format : int32

          Location : query

          Type : integer

          Description : Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.

        interval.startTime.timeZone.version

          Type : string

          Location : query

          Description : Optional. IANA Time Zone Database version number, e.g. "2019a".

        parent

          Required : Yes

          Location : path

          Type : string

          Description : Required. Parent resource of the reports, indicating the application for which they were received. Format: apps/{app}

          Pattern : ^apps/[^/]+$

        interval.startTime.seconds

          Description : 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.

          Format : int32

          Type : integer

          Location : query

        interval.endTime.month

          Type : integer

          Description : Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.

          Location : query

          Format : int32

        interval.endTime.seconds

          Description : 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.

          Format : int32

          Type : integer

          Location : query

        pageSize

          Location : query

          Description : 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 1000; values above 1000 will be coerced to 1000.

          Type : integer

          Format : int32

        interval.startTime.year

          Format : int32

          Location : query

          Type : integer

          Description : Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.

        interval.startTime.timeZone.id

          Description : IANA Time Zone Database time zone, e.g. "America/New_York".

          Location : query

          Type : string

        interval.startTime.hours

          Description : 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.

          Format : int32

          Type : integer

          Location : query

        interval.endTime.timeZone.id

          Type : string

          Location : query

          Description : IANA Time Zone Database time zone, e.g. "America/New_York".

        filter

          Description : 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 reports that occurred in the requested devices. Example: `deviceModel = "walleye" OR deviceModel = "marlin"`. * `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: `JAVA_CRASH`, `NATIVE_CRASH`, `ANR`. Example: `errorIssueType = JAVA_CRASH OR errorIssueType = NATIVE_CRASH`. * `errorIssueId`: Matches error reports belonging to the requested error issue ids only. Example: `errorIssueId = 1234 OR errorIssueId = 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)`

          Location : query

          Type : string

        interval.startTime.utcOffset

          Type : string

          Location : query

          Description : 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 }.

          Format : google-duration

        interval.endTime.hours

          Format : int32

          Location : query

          Description : 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.

          Type : integer

        interval.endTime.year

          Format : int32

          Location : query

          Description : Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.

          Type : integer

        interval.startTime.day

          Format : int32

          Type : integer

          Location : query

          Description : 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.

      Path : v1beta1/{+parent}/errorReports:search

      Parameter Order : parent

      Description : Searches all error reports received for an app.

  • playdeveloperreporting.vitals.errors.counts.query

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/playdeveloperreporting

      Flat Path : v1beta1/apps/{appsId}/errorCountMetricSet:query

      HTTP Method : POST

      Description : Queries the metrics in the metrics set.

      Parameters :

        name

          Location : path

          Type : string

          Required : Yes

          Description : Required. The resource name. Format: apps/{app}/errorCountMetricSet

          Pattern : ^apps/[^/]+/errorCountMetricSet$

      Path : v1beta1/{+name}:query

  • playdeveloperreporting.vitals.errors.counts.get

      Path : v1beta1/{+name}

      Description : Describes the properties of the metrics set.

      HTTP Method : GET

      Flat Path : v1beta1/apps/{appsId}/errorCountMetricSet

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/playdeveloperreporting

      Parameters :

        name

          Location : path

          Description : Required. Name of the errors metric set. Format: apps/{app}/errorCountMetricSet

          Type : string

          Required : Yes

          Pattern : ^apps/[^/]+/errorCountMetricSet$

  • playdeveloperreporting.vitals.slowstartrate.get

      Parameters :

        name

          Required : Yes

          Pattern : ^apps/[^/]+/slowStartRateMetricSet$

          Location : path

          Description : Required. The resource name. Format: apps/{app}/slowStartRateMetricSet

          Type : string

      Path : v1beta1/{+name}

      Scopes : https://www.googleapis.com/auth/playdeveloperreporting

      Parameter Order : name

      Flat Path : v1beta1/apps/{appsId}/slowStartRateMetricSet

      HTTP Method : GET

      Description : Describes the properties of the metric set.

  • playdeveloperreporting.vitals.slowstartrate.query

      Flat Path : v1beta1/apps/{appsId}/slowStartRateMetricSet:query

      Path : v1beta1/{+name}:query

      Description : Queries the metrics in the metric set.

      Parameters :

        name

          Description : Required. The resource name. Format: apps/{app}/slowStartRateMetricSet

          Required : Yes

          Type : string

          Pattern : ^apps/[^/]+/slowStartRateMetricSet$

          Location : path

      Scopes : https://www.googleapis.com/auth/playdeveloperreporting

      HTTP Method : POST

      Parameter Order : name

  • playdeveloperreporting.vitals.slowrenderingrate.get

      Scopes : https://www.googleapis.com/auth/playdeveloperreporting

      HTTP Method : GET

      Flat Path : v1beta1/apps/{appsId}/slowRenderingRateMetricSet

      Description : Describes the properties of the metric set.

      Path : v1beta1/{+name}

      Parameters :

        name

          Type : string

          Description : Required. The resource name. Format: apps/{app}/slowRenderingRateMetricSet

          Required : Yes

          Pattern : ^apps/[^/]+/slowRenderingRateMetricSet$

          Location : path

      Parameter Order : name

  • playdeveloperreporting.vitals.slowrenderingrate.query

      Parameters :

        name

          Location : path

          Pattern : ^apps/[^/]+/slowRenderingRateMetricSet$

          Required : Yes

          Description : Required. The resource name. Format: apps/{app}/slowRenderingRateMetricSet

          Type : string

      Path : v1beta1/{+name}:query

      Description : Queries the metrics in the metric set.

      Flat Path : v1beta1/apps/{appsId}/slowRenderingRateMetricSet:query

      Scopes : https://www.googleapis.com/auth/playdeveloperreporting

      Parameter Order : name

      HTTP Method : POST