1 | <?php
|
---|
2 | /*
|
---|
3 | * Copyright 2014 Google Inc.
|
---|
4 | *
|
---|
5 | * Licensed under the Apache License, Version 2.0 (the "License"); you may not
|
---|
6 | * use this file except in compliance with the License. You may obtain a copy of
|
---|
7 | * the License at
|
---|
8 | *
|
---|
9 | * http://www.apache.org/licenses/LICENSE-2.0
|
---|
10 | *
|
---|
11 | * Unless required by applicable law or agreed to in writing, software
|
---|
12 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
---|
13 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
---|
14 | * License for the specific language governing permissions and limitations under
|
---|
15 | * the License.
|
---|
16 | */
|
---|
17 |
|
---|
18 | namespace Google\Service\Playdeveloperreporting\Resource;
|
---|
19 |
|
---|
20 | use Google\Service\Playdeveloperreporting\GooglePlayDeveloperReportingV1beta1SearchErrorIssuesResponse;
|
---|
21 |
|
---|
22 | /**
|
---|
23 | * The "issues" collection of methods.
|
---|
24 | * Typical usage is:
|
---|
25 | * <code>
|
---|
26 | * $playdeveloperreportingService = new Google\Service\Playdeveloperreporting(...);
|
---|
27 | * $issues = $playdeveloperreportingService->vitals_errors_issues;
|
---|
28 | * </code>
|
---|
29 | */
|
---|
30 | class VitalsErrorsIssues extends \Google\Service\Resource
|
---|
31 | {
|
---|
32 | /**
|
---|
33 | * Searches all error issues in which reports have been grouped. (issues.search)
|
---|
34 | *
|
---|
35 | * @param string $parent Required. Parent resource of the error issues,
|
---|
36 | * indicating the application for which they were received. Format: apps/{app}
|
---|
37 | * @param array $optParams Optional parameters.
|
---|
38 | *
|
---|
39 | * @opt_param string filter A selection predicate to retrieve only a subset of
|
---|
40 | * the issues. Counts in the returned error issues will only reflect occurrences
|
---|
41 | * that matched the filter. For filtering basics, please check
|
---|
42 | * [AIP-160](https://google.aip.dev/160). ** Supported field names:** *
|
---|
43 | * `apiLevel`: Matches error issues that occurred in the requested Android
|
---|
44 | * versions (specified as the numeric API level) only. Example: `apiLevel = 28
|
---|
45 | * OR apiLevel = 29`. * `versionCode`: Matches error issues that occurred in the
|
---|
46 | * requested app version codes only. Example: `versionCode = 123 OR versionCode
|
---|
47 | * = 456`. * `deviceModel`: Matches error issues that occurred in the requested
|
---|
48 | * devices. Example: `deviceModel = "google/walleye" OR deviceModel =
|
---|
49 | * "google/marlin"`. * `deviceBrand`: Matches error issues that occurred in the
|
---|
50 | * requested device brands. Example: `deviceBrand = "Google". * `deviceType`:
|
---|
51 | * Matches error issues that occurred in the requested device types. Example:
|
---|
52 | * `deviceType = "PHONE"`. * `errorIssueType`: Matches error issues of the
|
---|
53 | * requested types only. Valid candidates: `CRASH`, `ANR`. Example:
|
---|
54 | * `errorIssueType = CRASH OR errorIssueType = ANR`. * `appProcessState`:
|
---|
55 | * Matches error issues on the process state of an app, indicating whether an
|
---|
56 | * app runs in the foreground (user-visible) or background. Valid candidates:
|
---|
57 | * `FOREGROUND`, `BACKGROUND`. Example: `appProcessState = FOREGROUND`. *
|
---|
58 | * `isUserPerceived`: Matches error issues that are user-perceived. It is not
|
---|
59 | * accompanied by any operators. Example: `isUserPerceived`. ** Supported
|
---|
60 | * operators:** * Comparison operators: The only supported comparison operator
|
---|
61 | * is equality. The filtered field must appear on the left hand side of the
|
---|
62 | * comparison. * Logical Operators: Logical operators `AND` and `OR` can be used
|
---|
63 | * to build complex filters following a conjunctive normal form (CNF), i.e.,
|
---|
64 | * conjunctions of disjunctions. The `OR` operator takes precedence over `AND`
|
---|
65 | * so the use of parenthesis is not necessary when building CNF. The `OR`
|
---|
66 | * operator is only supported to build disjunctions that apply to the same
|
---|
67 | * field, e.g., `versionCode = 123 OR errorIssueType = ANR` is not a valid
|
---|
68 | * filter. ** Examples ** Some valid filtering expressions: * `versionCode = 123
|
---|
69 | * AND errorIssueType = ANR` * `versionCode = 123 AND errorIssueType = OR
|
---|
70 | * errorIssueType = CRASH` * `versionCode = 123 AND (errorIssueType = OR
|
---|
71 | * errorIssueType = CRASH)`
|
---|
72 | * @opt_param int interval.endTime.day Optional. Day of month. Must be from 1 to
|
---|
73 | * 31 and valid for the year and month, or 0 if specifying a datetime without a
|
---|
74 | * day.
|
---|
75 | * @opt_param int interval.endTime.hours Optional. Hours of day in 24 hour
|
---|
76 | * format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose
|
---|
77 | * to allow the value "24:00:00" for scenarios like business closing time.
|
---|
78 | * @opt_param int interval.endTime.minutes Optional. Minutes of hour of day.
|
---|
79 | * Must be from 0 to 59, defaults to 0.
|
---|
80 | * @opt_param int interval.endTime.month Optional. Month of year. Must be from 1
|
---|
81 | * to 12, or 0 if specifying a datetime without a month.
|
---|
82 | * @opt_param int interval.endTime.nanos Optional. Fractions of seconds in
|
---|
83 | * nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
|
---|
84 | * @opt_param int interval.endTime.seconds Optional. Seconds of minutes of the
|
---|
85 | * time. Must normally be from 0 to 59, defaults to 0. An API may allow the
|
---|
86 | * value 60 if it allows leap-seconds.
|
---|
87 | * @opt_param string interval.endTime.timeZone.id IANA Time Zone Database time
|
---|
88 | * zone. For example "America/New_York".
|
---|
89 | * @opt_param string interval.endTime.timeZone.version Optional. IANA Time Zone
|
---|
90 | * Database version number. For example "2019a".
|
---|
91 | * @opt_param string interval.endTime.utcOffset UTC offset. Must be whole
|
---|
92 | * seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00
|
---|
93 | * would be represented as { seconds: -14400 }.
|
---|
94 | * @opt_param int interval.endTime.year Optional. Year of date. Must be from 1
|
---|
95 | * to 9999, or 0 if specifying a datetime without a year.
|
---|
96 | * @opt_param int interval.startTime.day Optional. Day of month. Must be from 1
|
---|
97 | * to 31 and valid for the year and month, or 0 if specifying a datetime without
|
---|
98 | * a day.
|
---|
99 | * @opt_param int interval.startTime.hours Optional. Hours of day in 24 hour
|
---|
100 | * format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose
|
---|
101 | * to allow the value "24:00:00" for scenarios like business closing time.
|
---|
102 | * @opt_param int interval.startTime.minutes Optional. Minutes of hour of day.
|
---|
103 | * Must be from 0 to 59, defaults to 0.
|
---|
104 | * @opt_param int interval.startTime.month Optional. Month of year. Must be from
|
---|
105 | * 1 to 12, or 0 if specifying a datetime without a month.
|
---|
106 | * @opt_param int interval.startTime.nanos Optional. Fractions of seconds in
|
---|
107 | * nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
|
---|
108 | * @opt_param int interval.startTime.seconds Optional. Seconds of minutes of the
|
---|
109 | * time. Must normally be from 0 to 59, defaults to 0. An API may allow the
|
---|
110 | * value 60 if it allows leap-seconds.
|
---|
111 | * @opt_param string interval.startTime.timeZone.id IANA Time Zone Database time
|
---|
112 | * zone. For example "America/New_York".
|
---|
113 | * @opt_param string interval.startTime.timeZone.version Optional. IANA Time
|
---|
114 | * Zone Database version number. For example "2019a".
|
---|
115 | * @opt_param string interval.startTime.utcOffset UTC offset. Must be whole
|
---|
116 | * seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00
|
---|
117 | * would be represented as { seconds: -14400 }.
|
---|
118 | * @opt_param int interval.startTime.year Optional. Year of date. Must be from 1
|
---|
119 | * to 9999, or 0 if specifying a datetime without a year.
|
---|
120 | * @opt_param string orderBy Specifies a field that will be used to order the
|
---|
121 | * results. ** Supported dimensions:** * `errorReportCount`: Orders issues by
|
---|
122 | * number of error reports. * `distinctUsers`: Orders issues by number of unique
|
---|
123 | * affected users. ** Supported operations:** * `asc` for ascending order. *
|
---|
124 | * `desc` for descending order. Format: A field and an operation, e.g.,
|
---|
125 | * `errorReportCount desc` *Note:* currently only one field is supported at a
|
---|
126 | * time.
|
---|
127 | * @opt_param int pageSize The maximum number of error issues to return. The
|
---|
128 | * service may return fewer than this value. If unspecified, at most 50 error
|
---|
129 | * issues will be returned. The maximum value is 1000; values above 1000 will be
|
---|
130 | * coerced to 1000.
|
---|
131 | * @opt_param string pageToken A page token, received from a previous call.
|
---|
132 | * Provide this to retrieve the subsequent page. When paginating, all other
|
---|
133 | * parameters provided to the request must match the call that provided the page
|
---|
134 | * token.
|
---|
135 | * @opt_param int sampleErrorReportLimit Optional. Number of sample error
|
---|
136 | * reports to return per ErrorIssue. If unspecified, 0 will be used. *Note:*
|
---|
137 | * currently only 0 and 1 are supported.
|
---|
138 | * @return GooglePlayDeveloperReportingV1beta1SearchErrorIssuesResponse
|
---|
139 | * @throws \Google\Service\Exception
|
---|
140 | */
|
---|
141 | public function search($parent, $optParams = [])
|
---|
142 | {
|
---|
143 | $params = ['parent' => $parent];
|
---|
144 | $params = array_merge($params, $optParams);
|
---|
145 | return $this->call('search', [$params], GooglePlayDeveloperReportingV1beta1SearchErrorIssuesResponse::class);
|
---|
146 | }
|
---|
147 | }
|
---|
148 |
|
---|
149 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
150 | class_alias(VitalsErrorsIssues::class, 'Google_Service_Playdeveloperreporting_Resource_VitalsErrorsIssues');
|
---|