blob: ff06fb9c53874eccdbf910f934f22696c71441fa [file] [log] [blame]
Bu Sun Kim673ec5c2020-11-16 11:05:03 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="analyticsdata_v1alpha.html">Google Analytics Data API</a> . <a href="analyticsdata_v1alpha.properties.html">properties</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
81 <code><a href="#getMetadata">getMetadata(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Returns metadata for dimensions and metrics available in reporting methods. Used to explore the dimensions and metrics. In this method, a Google Analytics GA4 Property Identifier is specified in the request, and the metadata response includes Custom dimensions and metrics as well as Universal metadata. For example if a custom metric with parameter name `levels_unlocked` is registered to a property, the Metadata response will contain `customEvent:levels_unlocked`. Universal metadata are dimensions and metrics applicable to any property such as `country` and `totalUsers`.</p>
83<p class="toc_element">
84 <code><a href="#runRealtimeReport">runRealtimeReport(property, body=None, x__xgafv=None)</a></code></p>
85<p class="firstline">The Google Analytics Realtime API returns a customized report of realtime event data for your property. These reports show events and usage from the last 30 minutes.</p>
86<h3>Method Details</h3>
87<div class="method">
88 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90</div>
91
92<div class="method">
93 <code class="details" id="getMetadata">getMetadata(name, x__xgafv=None)</code>
94 <pre>Returns metadata for dimensions and metrics available in reporting methods. Used to explore the dimensions and metrics. In this method, a Google Analytics GA4 Property Identifier is specified in the request, and the metadata response includes Custom dimensions and metrics as well as Universal metadata. For example if a custom metric with parameter name `levels_unlocked` is registered to a property, the Metadata response will contain `customEvent:levels_unlocked`. Universal metadata are dimensions and metrics applicable to any property such as `country` and `totalUsers`.
95
96Args:
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -080097 name: string, Required. The resource name of the metadata to retrieve. This name field is specified in the URL path and not URL parameters. Property is a numeric Google Analytics GA4 Property identifier. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Example: properties/1234/metadata Set the Property ID to 0 for dimensions and metrics common to all properties. In this special mode, this method will not return custom dimensions and metrics. (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070098 x__xgafv: string, V1 error format.
99 Allowed values
100 1 - v1 error format
101 2 - v2 error format
102
103Returns:
104 An object of the form:
105
106 { # The dimensions and metrics currently accepted in reporting methods.
107 &quot;dimensions&quot;: [ # The dimension descriptions.
108 { # Explains a dimension.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800109 &quot;description&quot;: &quot;A String&quot;, # Description of how this dimension is used and calculated.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800110 &quot;uiName&quot;: &quot;A String&quot;, # This dimension&#x27;s name within the Google Analytics user interface. For example, `Event name`.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700111 &quot;deprecatedApiNames&quot;: [ # Still usable but deprecated names for this dimension. If populated, this dimension is available by either `apiName` or one of `deprecatedApiNames` for a period of time. After the deprecation period, the dimension will be available only by `apiName`.
112 &quot;A String&quot;,
113 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700114 &quot;customDefinition&quot;: True or False, # True if the dimension is a custom dimension for this property.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800115 &quot;apiName&quot;: &quot;A String&quot;, # This dimension&#x27;s name. Useable in [Dimension](#Dimension)&#x27;s `name`. For example, `eventName`.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700116 },
117 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800118 &quot;name&quot;: &quot;A String&quot;, # Resource name of this metadata.
119 &quot;metrics&quot;: [ # The metric descriptions.
120 { # Explains a metric.
121 &quot;deprecatedApiNames&quot;: [ # Still usable but deprecated names for this metric. If populated, this metric is available by either `apiName` or one of `deprecatedApiNames` for a period of time. After the deprecation period, the metric will be available only by `apiName`.
122 &quot;A String&quot;,
123 ],
124 &quot;description&quot;: &quot;A String&quot;, # Description of how this metric is used and calculated.
125 &quot;apiName&quot;: &quot;A String&quot;, # A metric name. Useable in [Metric](#Metric)&#x27;s `name`. For example, `eventCount`.
126 &quot;type&quot;: &quot;A String&quot;, # The type of this metric.
127 &quot;uiName&quot;: &quot;A String&quot;, # This metric&#x27;s name within the Google Analytics user interface. For example, `Event count`.
128 &quot;customDefinition&quot;: True or False, # True if the metric is a custom metric for this property.
129 &quot;expression&quot;: &quot;A String&quot;, # The mathematical expression for this derived metric. Can be used in [Metric](#Metric)&#x27;s `expression` field for equivalent reports. Most metrics are not expressions, and for non-expressions, this field is empty.
130 },
131 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700132 }</pre>
133</div>
134
135<div class="method">
136 <code class="details" id="runRealtimeReport">runRealtimeReport(property, body=None, x__xgafv=None)</code>
137 <pre>The Google Analytics Realtime API returns a customized report of realtime event data for your property. These reports show events and usage from the last 30 minutes.
138
139Args:
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800140 property: string, A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Example: properties/1234 (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700141 body: object, The request body.
142 The object takes the form of:
143
144{ # The request to generate a realtime report.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800145 &quot;dimensions&quot;: [ # The dimensions requested and displayed.
146 { # Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, city could be &quot;Paris&quot; or &quot;New York&quot;. Requests are allowed up to 8 dimensions.
147 &quot;name&quot;: &quot;A String&quot;, # The name of the dimension. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) for the list of dimension names. If `dimensionExpression` is specified, `name` can be any string that you would like. For example if a `dimensionExpression` concatenates `country` and `city`, you could call that dimension `countryAndCity`. Dimensions are referenced by `name` in `dimensionFilter`, `orderBys`, `dimensionExpression`, and `pivots`.
148 &quot;dimensionExpression&quot;: { # Used to express a dimension which is the result of a formula of multiple dimensions. Example usages: 1) lower_case(dimension) 2) concatenate(dimension1, symbol, dimension2). # One dimension can be the result of an expression of multiple dimensions. For example, dimension &quot;country, city&quot;: concatenate(country, &quot;, &quot;, city).
149 &quot;upperCase&quot;: { # Used to convert a dimension value to a single case. # Used to convert a dimension value to upper case.
150 &quot;dimensionName&quot;: &quot;A String&quot;, # Name of a dimension. The name must refer back to a name in dimensions field of the request.
151 },
152 &quot;lowerCase&quot;: { # Used to convert a dimension value to a single case. # Used to convert a dimension value to lower case.
153 &quot;dimensionName&quot;: &quot;A String&quot;, # Name of a dimension. The name must refer back to a name in dimensions field of the request.
154 },
155 &quot;concatenate&quot;: { # Used to combine dimension values to a single dimension. # Used to combine dimension values to a single dimension. For example, dimension &quot;country, city&quot;: concatenate(country, &quot;, &quot;, city).
156 &quot;dimensionNames&quot;: [ # Names of dimensions. The names must refer back to names in the dimensions field of the request.
157 &quot;A String&quot;,
158 ],
159 &quot;delimiter&quot;: &quot;A String&quot;, # The delimiter placed between dimension names. Delimiters are often single characters such as &quot;|&quot; or &quot;,&quot; but can be longer strings. If a dimension value contains the delimiter, both will be present in response with no distinction. For example if dimension 1 value = &quot;US,FR&quot;, dimension 2 value = &quot;JP&quot;, and delimiter = &quot;,&quot;, then the response will contain &quot;US,FR,JP&quot;.
160 },
161 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800162 },
163 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800164 &quot;metricAggregations&quot;: [ # Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to &quot;RESERVED_(MetricAggregation)&quot;.
165 &quot;A String&quot;,
166 ],
167 &quot;metricFilter&quot;: { # To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics. # The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Metrics must be requested to be used in this filter. Dimensions cannot be used in this filter.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800168 &quot;filter&quot;: { # An expression to filter dimension or metric values. # A primitive filter. All fields in filter in same FilterExpression needs to be either all dimensions or metrics.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800169 &quot;nullFilter&quot;: True or False, # A filter for null values. If True, a null dimension value is matched by this filter. Null filter is commonly used inside a NOT filter expression. For example, a NOT expression of a null filter removes rows when a dimension is null.
170 &quot;betweenFilter&quot;: { # To express that the result needs to be between two numbers (inclusive). # A filter for two values.
171 &quot;toValue&quot;: { # To represent a number. # Ends with this number.
172 &quot;doubleValue&quot;: 3.14, # Double value
173 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value
174 },
175 &quot;fromValue&quot;: { # To represent a number. # Begins with this number.
176 &quot;doubleValue&quot;: 3.14, # Double value
177 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value
178 },
179 },
180 &quot;stringFilter&quot;: { # The filter for string # Strings related filter.
181 &quot;value&quot;: &quot;A String&quot;, # The string value used for the matching.
182 &quot;caseSensitive&quot;: True or False, # If true, the string value is case sensitive.
183 &quot;matchType&quot;: &quot;A String&quot;, # The match type for this filter.
184 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800185 &quot;numericFilter&quot;: { # Filters for numeric or date values. # A filter for numeric or date values.
186 &quot;operation&quot;: &quot;A String&quot;, # The operation type for this filter.
187 &quot;value&quot;: { # To represent a number. # A numeric value or a date value.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800188 &quot;doubleValue&quot;: 3.14, # Double value
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800189 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800190 },
191 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800192 &quot;fieldName&quot;: &quot;A String&quot;, # The dimension name or metric name. Must be a name defined in dimensions or metrics.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800193 &quot;inListFilter&quot;: { # The result needs to be in a list of string values. # A filter for in list values.
194 &quot;values&quot;: [ # The list of string values. Must be non-empty.
195 &quot;A String&quot;,
196 ],
197 &quot;caseSensitive&quot;: True or False, # If true, the string value is case sensitive.
198 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800199 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800200 &quot;orGroup&quot;: { # A list of filter expressions. # The FilterExpressions in or_group have an OR relationship.
201 &quot;expressions&quot;: [ # A list of filter expressions.
202 # Object with schema name: FilterExpression
203 ],
204 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800205 &quot;andGroup&quot;: { # A list of filter expressions. # The FilterExpressions in and_group have an AND relationship.
206 &quot;expressions&quot;: [ # A list of filter expressions.
207 # Object with schema name: FilterExpression
208 ],
209 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800210 &quot;notExpression&quot;: # Object with schema name: FilterExpression # The FilterExpression is NOT of not_expression.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800211 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800212 &quot;returnPropertyQuota&quot;: True or False, # Toggles whether to return the current state of this Analytics Property&#x27;s Realtime quota. Quota is returned in [PropertyQuota](#PropertyQuota).
213 &quot;limit&quot;: &quot;A String&quot;, # The number of rows to return. If unspecified, 10 rows are returned. If -1, all rows are returned.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800214 &quot;orderBys&quot;: [ # Specifies how rows are ordered in the response.
215 { # The sort options.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800216 &quot;metric&quot;: { # Sorts by metric values. # Sorts results by a metric&#x27;s values.
217 &quot;metricName&quot;: &quot;A String&quot;, # A metric name in the request to order by.
218 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800219 &quot;desc&quot;: True or False, # If true, sorts by descending order.
220 &quot;pivot&quot;: { # Sorts by a pivot column group. # Sorts results by a metric&#x27;s values within a pivot column group.
221 &quot;pivotSelections&quot;: [ # Used to select a dimension name and value pivot. If multiple pivot selections are given, the sort occurs on rows where all pivot selection dimension name and value pairs match the row&#x27;s dimension name and value pair.
222 { # A pair of dimension names and values. Rows with this dimension pivot pair are ordered by the metric&#x27;s value. For example if pivots = {{&quot;browser&quot;, &quot;Chrome&quot;}} and metric_name = &quot;Sessions&quot;, then the rows will be sorted based on Sessions in Chrome. ---------|----------|----------------|----------|---------------- | Chrome | Chrome | Safari | Safari ---------|----------|----------------|----------|---------------- Country | Sessions | Pages/Sessions | Sessions | Pages/Sessions ---------|----------|----------------|----------|---------------- US | 2 | 2 | 3 | 1 ---------|----------|----------------|----------|---------------- Canada | 3 | 1 | 4 | 1 ---------|----------|----------------|----------|----------------
223 &quot;dimensionName&quot;: &quot;A String&quot;, # Must be a dimension name from the request.
224 &quot;dimensionValue&quot;: &quot;A String&quot;, # Order by only when the named dimension is this value.
225 },
226 ],
227 &quot;metricName&quot;: &quot;A String&quot;, # In the response to order by, order rows by this column. Must be a metric name from the request.
228 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800229 &quot;dimension&quot;: { # Sorts by dimension values. # Sorts results by a dimension&#x27;s values.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800230 &quot;dimensionName&quot;: &quot;A String&quot;, # A dimension name in the request to order by.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800231 &quot;orderType&quot;: &quot;A String&quot;, # Controls the rule for dimension value ordering.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800232 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800233 },
234 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800235 &quot;metrics&quot;: [ # The metrics requested and displayed.
236 { # The quantitative measurements of a report. For example, the metric `eventCount` is the total number of events. Requests are allowed up to 10 metrics.
237 &quot;name&quot;: &quot;A String&quot;, # The name of the metric. See the [API Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) for the list of metric names. If `expression` is specified, `name` can be any string that you would like. For example if `expression` is `screenPageViews/sessions`, you could call that metric&#x27;s name = `viewsPerSession`. Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric `expression`.
238 &quot;invisible&quot;: True or False, # Indicates if a metric is invisible in the report response. If a metric is invisible, the metric will not produce a column in the response, but can be used in `metricFilter`, `orderBys`, or a metric `expression`.
239 &quot;expression&quot;: &quot;A String&quot;, # A mathematical expression for derived metrics. For example, the metric Event count per user is `eventCount/totalUsers`.
240 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800241 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800242 &quot;dimensionFilter&quot;: { # To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics. # The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800243 &quot;filter&quot;: { # An expression to filter dimension or metric values. # A primitive filter. All fields in filter in same FilterExpression needs to be either all dimensions or metrics.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800244 &quot;nullFilter&quot;: True or False, # A filter for null values. If True, a null dimension value is matched by this filter. Null filter is commonly used inside a NOT filter expression. For example, a NOT expression of a null filter removes rows when a dimension is null.
245 &quot;betweenFilter&quot;: { # To express that the result needs to be between two numbers (inclusive). # A filter for two values.
246 &quot;toValue&quot;: { # To represent a number. # Ends with this number.
247 &quot;doubleValue&quot;: 3.14, # Double value
248 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value
249 },
250 &quot;fromValue&quot;: { # To represent a number. # Begins with this number.
251 &quot;doubleValue&quot;: 3.14, # Double value
252 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value
253 },
254 },
255 &quot;stringFilter&quot;: { # The filter for string # Strings related filter.
256 &quot;value&quot;: &quot;A String&quot;, # The string value used for the matching.
257 &quot;caseSensitive&quot;: True or False, # If true, the string value is case sensitive.
258 &quot;matchType&quot;: &quot;A String&quot;, # The match type for this filter.
259 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800260 &quot;numericFilter&quot;: { # Filters for numeric or date values. # A filter for numeric or date values.
261 &quot;operation&quot;: &quot;A String&quot;, # The operation type for this filter.
262 &quot;value&quot;: { # To represent a number. # A numeric value or a date value.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800263 &quot;doubleValue&quot;: 3.14, # Double value
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800264 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800265 },
266 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800267 &quot;fieldName&quot;: &quot;A String&quot;, # The dimension name or metric name. Must be a name defined in dimensions or metrics.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800268 &quot;inListFilter&quot;: { # The result needs to be in a list of string values. # A filter for in list values.
269 &quot;values&quot;: [ # The list of string values. Must be non-empty.
270 &quot;A String&quot;,
271 ],
272 &quot;caseSensitive&quot;: True or False, # If true, the string value is case sensitive.
273 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800274 },
275 &quot;orGroup&quot;: { # A list of filter expressions. # The FilterExpressions in or_group have an OR relationship.
276 &quot;expressions&quot;: [ # A list of filter expressions.
277 # Object with schema name: FilterExpression
278 ],
279 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800280 &quot;andGroup&quot;: { # A list of filter expressions. # The FilterExpressions in and_group have an AND relationship.
281 &quot;expressions&quot;: [ # A list of filter expressions.
282 # Object with schema name: FilterExpression
283 ],
284 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800285 &quot;notExpression&quot;: # Object with schema name: FilterExpression # The FilterExpression is NOT of not_expression.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800286 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700287 }
288
289 x__xgafv: string, V1 error format.
290 Allowed values
291 1 - v1 error format
292 2 - v2 error format
293
294Returns:
295 An object of the form:
296
297 { # The response realtime report table corresponding to a request.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800298 &quot;maximums&quot;: [ # If requested, the maximum values of metrics.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700299 { # Report data for each row. For example if RunReportRequest contains: ```none &quot;dimensions&quot;: [ { &quot;name&quot;: &quot;eventName&quot; }, { &quot;name&quot;: &quot;countryId&quot; } ], &quot;metrics&quot;: [ { &quot;name&quot;: &quot;eventCount&quot; } ] ``` One row with &#x27;in_app_purchase&#x27; as the eventName, &#x27;JP&#x27; as the countryId, and 15 as the eventCount, would be: ```none &quot;dimensionValues&quot;: [ { &quot;value&quot;: &quot;in_app_purchase&quot; }, { &quot;value&quot;: &quot;JP&quot; } ], &quot;metricValues&quot;: [ { &quot;value&quot;: &quot;15&quot; } ] ```
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700300 &quot;metricValues&quot;: [ # List of requested visible metric values.
301 { # The value of a metric.
302 &quot;value&quot;: &quot;A String&quot;, # Measurement value. See MetricHeader for type.
303 },
304 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800305 &quot;dimensionValues&quot;: [ # List of requested dimension values. In a PivotReport, dimension_values are only listed for dimensions included in a pivot.
306 { # The value of a dimension.
307 &quot;value&quot;: &quot;A String&quot;, # Value as a string if the dimension type is a string.
308 },
309 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700310 },
311 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800312 &quot;metricHeaders&quot;: [ # Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.
313 { # Describes a metric column in the report. Visible metrics requested in a report produce column entries within rows and MetricHeaders. However, metrics used exclusively within filters or expressions do not produce columns in a report; correspondingly, those metrics do not produce headers.
314 &quot;name&quot;: &quot;A String&quot;, # The metric&#x27;s name.
315 &quot;type&quot;: &quot;A String&quot;, # The metric&#x27;s data type.
316 },
317 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800318 &quot;rows&quot;: [ # Rows of dimension value combinations and metric values in the report.
319 { # Report data for each row. For example if RunReportRequest contains: ```none &quot;dimensions&quot;: [ { &quot;name&quot;: &quot;eventName&quot; }, { &quot;name&quot;: &quot;countryId&quot; } ], &quot;metrics&quot;: [ { &quot;name&quot;: &quot;eventCount&quot; } ] ``` One row with &#x27;in_app_purchase&#x27; as the eventName, &#x27;JP&#x27; as the countryId, and 15 as the eventCount, would be: ```none &quot;dimensionValues&quot;: [ { &quot;value&quot;: &quot;in_app_purchase&quot; }, { &quot;value&quot;: &quot;JP&quot; } ], &quot;metricValues&quot;: [ { &quot;value&quot;: &quot;15&quot; } ] ```
320 &quot;metricValues&quot;: [ # List of requested visible metric values.
321 { # The value of a metric.
322 &quot;value&quot;: &quot;A String&quot;, # Measurement value. See MetricHeader for type.
323 },
324 ],
325 &quot;dimensionValues&quot;: [ # List of requested dimension values. In a PivotReport, dimension_values are only listed for dimensions included in a pivot.
326 { # The value of a dimension.
327 &quot;value&quot;: &quot;A String&quot;, # Value as a string if the dimension type is a string.
328 },
329 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800330 },
331 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800332 &quot;minimums&quot;: [ # If requested, the minimum values of metrics.
333 { # Report data for each row. For example if RunReportRequest contains: ```none &quot;dimensions&quot;: [ { &quot;name&quot;: &quot;eventName&quot; }, { &quot;name&quot;: &quot;countryId&quot; } ], &quot;metrics&quot;: [ { &quot;name&quot;: &quot;eventCount&quot; } ] ``` One row with &#x27;in_app_purchase&#x27; as the eventName, &#x27;JP&#x27; as the countryId, and 15 as the eventCount, would be: ```none &quot;dimensionValues&quot;: [ { &quot;value&quot;: &quot;in_app_purchase&quot; }, { &quot;value&quot;: &quot;JP&quot; } ], &quot;metricValues&quot;: [ { &quot;value&quot;: &quot;15&quot; } ] ```
334 &quot;metricValues&quot;: [ # List of requested visible metric values.
335 { # The value of a metric.
336 &quot;value&quot;: &quot;A String&quot;, # Measurement value. See MetricHeader for type.
337 },
338 ],
339 &quot;dimensionValues&quot;: [ # List of requested dimension values. In a PivotReport, dimension_values are only listed for dimensions included in a pivot.
340 { # The value of a dimension.
341 &quot;value&quot;: &quot;A String&quot;, # Value as a string if the dimension type is a string.
342 },
343 ],
344 },
345 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800346 &quot;dimensionHeaders&quot;: [ # Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.
347 { # Describes a dimension column in the report. Dimensions requested in a report produce column entries within rows and DimensionHeaders. However, dimensions used exclusively within filters or expressions do not produce columns in a report; correspondingly, those dimensions do not produce headers.
348 &quot;name&quot;: &quot;A String&quot;, # The dimension&#x27;s name.
349 },
350 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800351 &quot;totals&quot;: [ # If requested, the totaled values of metrics.
352 { # Report data for each row. For example if RunReportRequest contains: ```none &quot;dimensions&quot;: [ { &quot;name&quot;: &quot;eventName&quot; }, { &quot;name&quot;: &quot;countryId&quot; } ], &quot;metrics&quot;: [ { &quot;name&quot;: &quot;eventCount&quot; } ] ``` One row with &#x27;in_app_purchase&#x27; as the eventName, &#x27;JP&#x27; as the countryId, and 15 as the eventCount, would be: ```none &quot;dimensionValues&quot;: [ { &quot;value&quot;: &quot;in_app_purchase&quot; }, { &quot;value&quot;: &quot;JP&quot; } ], &quot;metricValues&quot;: [ { &quot;value&quot;: &quot;15&quot; } ] ```
353 &quot;metricValues&quot;: [ # List of requested visible metric values.
354 { # The value of a metric.
355 &quot;value&quot;: &quot;A String&quot;, # Measurement value. See MetricHeader for type.
356 },
357 ],
358 &quot;dimensionValues&quot;: [ # List of requested dimension values. In a PivotReport, dimension_values are only listed for dimensions included in a pivot.
359 { # The value of a dimension.
360 &quot;value&quot;: &quot;A String&quot;, # Value as a string if the dimension type is a string.
361 },
362 ],
363 },
364 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800365 &quot;propertyQuota&quot;: { # Current state of all quotas for this Analytics Property. If any quota for a property is exhausted, all requests to that property will return Resource Exhausted errors. # This Analytics Property&#x27;s Realtime quota state including this request.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800366 &quot;concurrentRequests&quot;: { # Current state for a particular quota group. # Standard Analytics Properties can send up to 10 concurrent requests; Analytics 360 Properties can use up to 50 concurrent requests.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800367 &quot;consumed&quot;: 42, # Quota consumed by this request.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800368 &quot;remaining&quot;: 42, # Quota remaining after this request.
369 },
370 &quot;tokensPerHour&quot;: { # Current state for a particular quota group. # Standard Analytics Properties can use up to 5,000 tokens per day; Analytics 360 Properties can use 50,000 tokens per day. An API request consumes a single number of tokens, and that number is deducted from both the hourly and daily quotas.
371 &quot;consumed&quot;: 42, # Quota consumed by this request.
372 &quot;remaining&quot;: 42, # Quota remaining after this request.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800373 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800374 &quot;serverErrorsPerProjectPerHour&quot;: { # Current state for a particular quota group. # Standard Analytics Properties and cloud project pairs can have up to 10 server errors per hour; Analytics 360 Properties and cloud project pairs can have up to 50 server errors per hour.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800375 &quot;consumed&quot;: 42, # Quota consumed by this request.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800376 &quot;remaining&quot;: 42, # Quota remaining after this request.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800377 },
378 &quot;tokensPerDay&quot;: { # Current state for a particular quota group. # Standard Analytics Properties can use up to 25,000 tokens per day; Analytics 360 Properties can use 250,000 tokens per day. Most requests consume fewer than 10 tokens.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800379 &quot;consumed&quot;: 42, # Quota consumed by this request.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800380 &quot;remaining&quot;: 42, # Quota remaining after this request.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800381 },
382 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800383 &quot;rowCount&quot;: 42, # The total number of rows in the query result, regardless of the number of rows returned in the response. For example if a query returns 175 rows and includes limit = 50 in the API request, the response will contain row_count = 175 but only 50 rows.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700384 }</pre>
385</div>
386
387</body></html>