google-analytics-data-v1beta 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,28 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2021 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://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,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Analytics
22
+ module Data
23
+ module V1beta
24
+ VERSION = "0.1.0"
25
+ end
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,4 @@
1
+ # Google Analytics Data V1beta Protocol Buffer Documentation
2
+
3
+ These files are for the YARD documentation of the generated protobuf files.
4
+ They are not intended to be required or loaded at runtime.
@@ -0,0 +1,492 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2021 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://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,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Analytics
22
+ module Data
23
+ module V1beta
24
+ # The dimensions and metrics currently accepted in reporting methods.
25
+ # @!attribute [rw] name
26
+ # @return [::String]
27
+ # Resource name of this metadata.
28
+ # @!attribute [rw] dimensions
29
+ # @return [::Array<::Google::Analytics::Data::V1beta::DimensionMetadata>]
30
+ # The dimension descriptions.
31
+ # @!attribute [rw] metrics
32
+ # @return [::Array<::Google::Analytics::Data::V1beta::MetricMetadata>]
33
+ # The metric descriptions.
34
+ class Metadata
35
+ include ::Google::Protobuf::MessageExts
36
+ extend ::Google::Protobuf::MessageExts::ClassMethods
37
+ end
38
+
39
+ # The request to generate a report.
40
+ # @!attribute [rw] property
41
+ # @return [::String]
42
+ # A Google Analytics GA4 property identifier whose events are tracked.
43
+ # Specified in the URL path and not the body. To learn more, see [where to
44
+ # find your Property
45
+ # ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
46
+ # Within a batch request, this property should either be unspecified or
47
+ # consistent with the batch-level property.
48
+ #
49
+ # Example: properties/1234
50
+ # @!attribute [rw] dimensions
51
+ # @return [::Array<::Google::Analytics::Data::V1beta::Dimension>]
52
+ # The dimensions requested and displayed.
53
+ # @!attribute [rw] metrics
54
+ # @return [::Array<::Google::Analytics::Data::V1beta::Metric>]
55
+ # The metrics requested and displayed.
56
+ # @!attribute [rw] date_ranges
57
+ # @return [::Array<::Google::Analytics::Data::V1beta::DateRange>]
58
+ # Date ranges of data to read. If multiple date ranges are requested, each
59
+ # response row will contain a zero based date range index. If two date
60
+ # ranges overlap, the event data for the overlapping days is included in the
61
+ # response rows for both date ranges. In a cohort request, this `dateRanges`
62
+ # must be unspecified.
63
+ # @!attribute [rw] dimension_filter
64
+ # @return [::Google::Analytics::Data::V1beta::FilterExpression]
65
+ # The filter clause of dimensions. Dimensions must be requested to be used in
66
+ # this filter. Metrics cannot be used in this filter.
67
+ # @!attribute [rw] metric_filter
68
+ # @return [::Google::Analytics::Data::V1beta::FilterExpression]
69
+ # The filter clause of metrics. Applied at post aggregation phase, similar to
70
+ # SQL having-clause. Metrics must be requested to be used in this filter.
71
+ # Dimensions cannot be used in this filter.
72
+ # @!attribute [rw] offset
73
+ # @return [::Integer]
74
+ # The row count of the start row. The first row is counted as row 0.
75
+ #
76
+ # When paging, the first request does not specify offset; or equivalently,
77
+ # sets offset to 0; the first request returns the first `limit` of rows. The
78
+ # second request sets offset to the `limit` of the first request; the second
79
+ # request returns the second `limit` of rows.
80
+ #
81
+ # To learn more about this pagination parameter, see
82
+ # [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
83
+ # @!attribute [rw] limit
84
+ # @return [::Integer]
85
+ # The number of rows to return. If unspecified, 10,000 rows are returned. The
86
+ # API returns a maximum of 100,000 rows per request, no matter how many you
87
+ # ask for. `limit` must be positive.
88
+ #
89
+ # The API can also return fewer rows than the requested `limit`, if there
90
+ # aren't as many dimension values as the `limit`. For instance, there are
91
+ # fewer than 300 possible values for the dimension `country`, so when
92
+ # reporting on only `country`, you can't get more than 300 rows, even if you
93
+ # set `limit` to a higher value.
94
+ #
95
+ # To learn more about this pagination parameter, see
96
+ # [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
97
+ # @!attribute [rw] metric_aggregations
98
+ # @return [::Array<::Google::Analytics::Data::V1beta::MetricAggregation>]
99
+ # Aggregation of metrics. Aggregated metric values will be shown in rows
100
+ # where the dimension_values are set to "RESERVED_(MetricAggregation)".
101
+ # @!attribute [rw] order_bys
102
+ # @return [::Array<::Google::Analytics::Data::V1beta::OrderBy>]
103
+ # Specifies how rows are ordered in the response.
104
+ # @!attribute [rw] currency_code
105
+ # @return [::String]
106
+ # A currency code in ISO4217 format, such as "AED", "USD", "JPY".
107
+ # If the field is empty, the report uses the property's default currency.
108
+ # @!attribute [rw] cohort_spec
109
+ # @return [::Google::Analytics::Data::V1beta::CohortSpec]
110
+ # Cohort group associated with this request. If there is a cohort group
111
+ # in the request the 'cohort' dimension must be present.
112
+ # @!attribute [rw] keep_empty_rows
113
+ # @return [::Boolean]
114
+ # If false or unspecified, each row with all metrics equal to 0 will not be
115
+ # returned. If true, these rows will be returned if they are not separately
116
+ # removed by a filter.
117
+ # @!attribute [rw] return_property_quota
118
+ # @return [::Boolean]
119
+ # Toggles whether to return the current state of this Analytics Property's
120
+ # quota. Quota is returned in [PropertyQuota](#PropertyQuota).
121
+ class RunReportRequest
122
+ include ::Google::Protobuf::MessageExts
123
+ extend ::Google::Protobuf::MessageExts::ClassMethods
124
+ end
125
+
126
+ # The response report table corresponding to a request.
127
+ # @!attribute [rw] dimension_headers
128
+ # @return [::Array<::Google::Analytics::Data::V1beta::DimensionHeader>]
129
+ # Describes dimension columns. The number of DimensionHeaders and ordering of
130
+ # DimensionHeaders matches the dimensions present in rows.
131
+ # @!attribute [rw] metric_headers
132
+ # @return [::Array<::Google::Analytics::Data::V1beta::MetricHeader>]
133
+ # Describes metric columns. The number of MetricHeaders and ordering of
134
+ # MetricHeaders matches the metrics present in rows.
135
+ # @!attribute [rw] rows
136
+ # @return [::Array<::Google::Analytics::Data::V1beta::Row>]
137
+ # Rows of dimension value combinations and metric values in the report.
138
+ # @!attribute [rw] totals
139
+ # @return [::Array<::Google::Analytics::Data::V1beta::Row>]
140
+ # If requested, the totaled values of metrics.
141
+ # @!attribute [rw] maximums
142
+ # @return [::Array<::Google::Analytics::Data::V1beta::Row>]
143
+ # If requested, the maximum values of metrics.
144
+ # @!attribute [rw] minimums
145
+ # @return [::Array<::Google::Analytics::Data::V1beta::Row>]
146
+ # If requested, the minimum values of metrics.
147
+ # @!attribute [rw] row_count
148
+ # @return [::Integer]
149
+ # The total number of rows in the query result. `rowCount` is independent of
150
+ # the number of rows returned in the response, the `limit` request
151
+ # parameter, and the `offset` request parameter. For example if a query
152
+ # returns 175 rows and includes `limit` of 50 in the API request, the
153
+ # response will contain `rowCount` of 175 but only 50 rows.
154
+ #
155
+ # To learn more about this pagination parameter, see
156
+ # [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
157
+ # @!attribute [rw] metadata
158
+ # @return [::Google::Analytics::Data::V1beta::ResponseMetaData]
159
+ # Metadata for the report.
160
+ # @!attribute [rw] property_quota
161
+ # @return [::Google::Analytics::Data::V1beta::PropertyQuota]
162
+ # This Analytics Property's quota state including this request.
163
+ # @!attribute [rw] kind
164
+ # @return [::String]
165
+ # Identifies what kind of resource this message is. This `kind` is always the
166
+ # fixed string "analyticsData#runReport". Useful to distinguish between
167
+ # response types in JSON.
168
+ class RunReportResponse
169
+ include ::Google::Protobuf::MessageExts
170
+ extend ::Google::Protobuf::MessageExts::ClassMethods
171
+ end
172
+
173
+ # The request to generate a pivot report.
174
+ # @!attribute [rw] property
175
+ # @return [::String]
176
+ # A Google Analytics GA4 property identifier whose events are tracked.
177
+ # Specified in the URL path and not the body. To learn more, see [where to
178
+ # find your Property
179
+ # ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
180
+ # Within a batch request, this property should either be unspecified or
181
+ # consistent with the batch-level property.
182
+ #
183
+ # Example: properties/1234
184
+ # @!attribute [rw] dimensions
185
+ # @return [::Array<::Google::Analytics::Data::V1beta::Dimension>]
186
+ # The dimensions requested. All defined dimensions must be used by one of the
187
+ # following: dimension_expression, dimension_filter, pivots, order_bys.
188
+ # @!attribute [rw] metrics
189
+ # @return [::Array<::Google::Analytics::Data::V1beta::Metric>]
190
+ # The metrics requested, at least one metric needs to be specified. All
191
+ # defined metrics must be used by one of the following: metric_expression,
192
+ # metric_filter, order_bys.
193
+ # @!attribute [rw] date_ranges
194
+ # @return [::Array<::Google::Analytics::Data::V1beta::DateRange>]
195
+ # The date range to retrieve event data for the report. If multiple date
196
+ # ranges are specified, event data from each date range is used in the
197
+ # report. A special dimension with field name "dateRange" can be included in
198
+ # a Pivot's field names; if included, the report compares between date
199
+ # ranges. In a cohort request, this `dateRanges` must be unspecified.
200
+ # @!attribute [rw] pivots
201
+ # @return [::Array<::Google::Analytics::Data::V1beta::Pivot>]
202
+ # Describes the visual format of the report's dimensions in columns or rows.
203
+ # The union of the fieldNames (dimension names) in all pivots must be a
204
+ # subset of dimension names defined in Dimensions. No two pivots can share a
205
+ # dimension. A dimension is only visible if it appears in a pivot.
206
+ # @!attribute [rw] dimension_filter
207
+ # @return [::Google::Analytics::Data::V1beta::FilterExpression]
208
+ # The filter clause of dimensions. Dimensions must be requested to be used in
209
+ # this filter. Metrics cannot be used in this filter.
210
+ # @!attribute [rw] metric_filter
211
+ # @return [::Google::Analytics::Data::V1beta::FilterExpression]
212
+ # The filter clause of metrics. Applied at post aggregation phase, similar to
213
+ # SQL having-clause. Metrics must be requested to be used in this filter.
214
+ # Dimensions cannot be used in this filter.
215
+ # @!attribute [rw] currency_code
216
+ # @return [::String]
217
+ # A currency code in ISO4217 format, such as "AED", "USD", "JPY".
218
+ # If the field is empty, the report uses the property's default currency.
219
+ # @!attribute [rw] cohort_spec
220
+ # @return [::Google::Analytics::Data::V1beta::CohortSpec]
221
+ # Cohort group associated with this request. If there is a cohort group
222
+ # in the request the 'cohort' dimension must be present.
223
+ # @!attribute [rw] keep_empty_rows
224
+ # @return [::Boolean]
225
+ # If false or unspecified, each row with all metrics equal to 0 will not be
226
+ # returned. If true, these rows will be returned if they are not separately
227
+ # removed by a filter.
228
+ # @!attribute [rw] return_property_quota
229
+ # @return [::Boolean]
230
+ # Toggles whether to return the current state of this Analytics Property's
231
+ # quota. Quota is returned in [PropertyQuota](#PropertyQuota).
232
+ class RunPivotReportRequest
233
+ include ::Google::Protobuf::MessageExts
234
+ extend ::Google::Protobuf::MessageExts::ClassMethods
235
+ end
236
+
237
+ # The response pivot report table corresponding to a pivot request.
238
+ # @!attribute [rw] pivot_headers
239
+ # @return [::Array<::Google::Analytics::Data::V1beta::PivotHeader>]
240
+ # Summarizes the columns and rows created by a pivot. Each pivot in the
241
+ # request produces one header in the response. If we have a request like
242
+ # this:
243
+ #
244
+ # "pivots": [{
245
+ # "fieldNames": ["country",
246
+ # "city"]
247
+ # },
248
+ # {
249
+ # "fieldNames": "eventName"
250
+ # }]
251
+ #
252
+ # We will have the following `pivotHeaders` in the response:
253
+ #
254
+ # "pivotHeaders" : [{
255
+ # "dimensionHeaders": [{
256
+ # "dimensionValues": [
257
+ # { "value": "United Kingdom" },
258
+ # { "value": "London" }
259
+ # ]
260
+ # },
261
+ # {
262
+ # "dimensionValues": [
263
+ # { "value": "Japan" },
264
+ # { "value": "Osaka" }
265
+ # ]
266
+ # }]
267
+ # },
268
+ # {
269
+ # "dimensionHeaders": [{
270
+ # "dimensionValues": [{ "value": "session_start" }]
271
+ # },
272
+ # {
273
+ # "dimensionValues": [{ "value": "scroll" }]
274
+ # }]
275
+ # }]
276
+ # @!attribute [rw] dimension_headers
277
+ # @return [::Array<::Google::Analytics::Data::V1beta::DimensionHeader>]
278
+ # Describes dimension columns. The number of DimensionHeaders and ordering of
279
+ # DimensionHeaders matches the dimensions present in rows.
280
+ # @!attribute [rw] metric_headers
281
+ # @return [::Array<::Google::Analytics::Data::V1beta::MetricHeader>]
282
+ # Describes metric columns. The number of MetricHeaders and ordering of
283
+ # MetricHeaders matches the metrics present in rows.
284
+ # @!attribute [rw] rows
285
+ # @return [::Array<::Google::Analytics::Data::V1beta::Row>]
286
+ # Rows of dimension value combinations and metric values in the report.
287
+ # @!attribute [rw] aggregates
288
+ # @return [::Array<::Google::Analytics::Data::V1beta::Row>]
289
+ # Aggregation of metric values. Can be totals, minimums, or maximums. The
290
+ # returned aggregations are controlled by the metric_aggregations in the
291
+ # pivot. The type of aggregation returned in each row is shown by the
292
+ # dimension_values which are set to "RESERVED_<MetricAggregation>".
293
+ # @!attribute [rw] metadata
294
+ # @return [::Google::Analytics::Data::V1beta::ResponseMetaData]
295
+ # Metadata for the report.
296
+ # @!attribute [rw] property_quota
297
+ # @return [::Google::Analytics::Data::V1beta::PropertyQuota]
298
+ # This Analytics Property's quota state including this request.
299
+ # @!attribute [rw] kind
300
+ # @return [::String]
301
+ # Identifies what kind of resource this message is. This `kind` is always the
302
+ # fixed string "analyticsData#runPivotReport". Useful to distinguish between
303
+ # response types in JSON.
304
+ class RunPivotReportResponse
305
+ include ::Google::Protobuf::MessageExts
306
+ extend ::Google::Protobuf::MessageExts::ClassMethods
307
+ end
308
+
309
+ # The batch request containing multiple report requests.
310
+ # @!attribute [rw] property
311
+ # @return [::String]
312
+ # A Google Analytics GA4 property identifier whose events are tracked.
313
+ # Specified in the URL path and not the body. To learn more, see [where to
314
+ # find your Property
315
+ # ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
316
+ # This property must be specified for the batch. The property within
317
+ # RunReportRequest may either be unspecified or consistent with this
318
+ # property.
319
+ #
320
+ # Example: properties/1234
321
+ # @!attribute [rw] requests
322
+ # @return [::Array<::Google::Analytics::Data::V1beta::RunReportRequest>]
323
+ # Individual requests. Each request has a separate report response. Each
324
+ # batch request is allowed up to 5 requests.
325
+ class BatchRunReportsRequest
326
+ include ::Google::Protobuf::MessageExts
327
+ extend ::Google::Protobuf::MessageExts::ClassMethods
328
+ end
329
+
330
+ # The batch response containing multiple reports.
331
+ # @!attribute [rw] reports
332
+ # @return [::Array<::Google::Analytics::Data::V1beta::RunReportResponse>]
333
+ # Individual responses. Each response has a separate report request.
334
+ # @!attribute [rw] kind
335
+ # @return [::String]
336
+ # Identifies what kind of resource this message is. This `kind` is always the
337
+ # fixed string "analyticsData#batchRunReports". Useful to distinguish between
338
+ # response types in JSON.
339
+ class BatchRunReportsResponse
340
+ include ::Google::Protobuf::MessageExts
341
+ extend ::Google::Protobuf::MessageExts::ClassMethods
342
+ end
343
+
344
+ # The batch request containing multiple pivot report requests.
345
+ # @!attribute [rw] property
346
+ # @return [::String]
347
+ # A Google Analytics GA4 property identifier whose events are tracked.
348
+ # Specified in the URL path and not the body. To learn more, see [where to
349
+ # find your Property
350
+ # ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
351
+ # This property must be specified for the batch. The property within
352
+ # RunPivotReportRequest may either be unspecified or consistent with this
353
+ # property.
354
+ #
355
+ # Example: properties/1234
356
+ # @!attribute [rw] requests
357
+ # @return [::Array<::Google::Analytics::Data::V1beta::RunPivotReportRequest>]
358
+ # Individual requests. Each request has a separate pivot report response.
359
+ # Each batch request is allowed up to 5 requests.
360
+ class BatchRunPivotReportsRequest
361
+ include ::Google::Protobuf::MessageExts
362
+ extend ::Google::Protobuf::MessageExts::ClassMethods
363
+ end
364
+
365
+ # The batch response containing multiple pivot reports.
366
+ # @!attribute [rw] pivot_reports
367
+ # @return [::Array<::Google::Analytics::Data::V1beta::RunPivotReportResponse>]
368
+ # Individual responses. Each response has a separate pivot report request.
369
+ # @!attribute [rw] kind
370
+ # @return [::String]
371
+ # Identifies what kind of resource this message is. This `kind` is always the
372
+ # fixed string "analyticsData#batchRunPivotReports". Useful to distinguish
373
+ # between response types in JSON.
374
+ class BatchRunPivotReportsResponse
375
+ include ::Google::Protobuf::MessageExts
376
+ extend ::Google::Protobuf::MessageExts::ClassMethods
377
+ end
378
+
379
+ # Request for a property's dimension and metric metadata.
380
+ # @!attribute [rw] name
381
+ # @return [::String]
382
+ # Required. The resource name of the metadata to retrieve. This name field is
383
+ # specified in the URL path and not URL parameters. Property is a numeric
384
+ # Google Analytics GA4 Property identifier. To learn more, see [where to find
385
+ # your Property
386
+ # ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
387
+ #
388
+ # Example: properties/1234/metadata
389
+ #
390
+ # Set the Property ID to 0 for dimensions and metrics common to all
391
+ # properties. In this special mode, this method will not return custom
392
+ # dimensions and metrics.
393
+ class GetMetadataRequest
394
+ include ::Google::Protobuf::MessageExts
395
+ extend ::Google::Protobuf::MessageExts::ClassMethods
396
+ end
397
+
398
+ # The request to generate a realtime report.
399
+ # @!attribute [rw] property
400
+ # @return [::String]
401
+ # A Google Analytics GA4 property identifier whose events are tracked.
402
+ # Specified in the URL path and not the body. To learn more, see [where to
403
+ # find your Property
404
+ # ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
405
+ #
406
+ # Example: properties/1234
407
+ # @!attribute [rw] dimensions
408
+ # @return [::Array<::Google::Analytics::Data::V1beta::Dimension>]
409
+ # The dimensions requested and displayed.
410
+ # @!attribute [rw] metrics
411
+ # @return [::Array<::Google::Analytics::Data::V1beta::Metric>]
412
+ # The metrics requested and displayed.
413
+ # @!attribute [rw] dimension_filter
414
+ # @return [::Google::Analytics::Data::V1beta::FilterExpression]
415
+ # The filter clause of dimensions. Dimensions must be requested to be used in
416
+ # this filter. Metrics cannot be used in this filter.
417
+ # @!attribute [rw] metric_filter
418
+ # @return [::Google::Analytics::Data::V1beta::FilterExpression]
419
+ # The filter clause of metrics. Applied at post aggregation phase, similar to
420
+ # SQL having-clause. Metrics must be requested to be used in this filter.
421
+ # Dimensions cannot be used in this filter.
422
+ # @!attribute [rw] limit
423
+ # @return [::Integer]
424
+ # The number of rows to return. If unspecified, 10,000 rows are returned. The
425
+ # API returns a maximum of 100,000 rows per request, no matter how many you
426
+ # ask for. `limit` must be positive.
427
+ #
428
+ # The API can also return fewer rows than the requested `limit`, if there
429
+ # aren't as many dimension values as the `limit`. For instance, there are
430
+ # fewer than 300 possible values for the dimension `country`, so when
431
+ # reporting on only `country`, you can't get more than 300 rows, even if you
432
+ # set `limit` to a higher value.
433
+ # @!attribute [rw] metric_aggregations
434
+ # @return [::Array<::Google::Analytics::Data::V1beta::MetricAggregation>]
435
+ # Aggregation of metrics. Aggregated metric values will be shown in rows
436
+ # where the dimension_values are set to "RESERVED_(MetricAggregation)".
437
+ # @!attribute [rw] order_bys
438
+ # @return [::Array<::Google::Analytics::Data::V1beta::OrderBy>]
439
+ # Specifies how rows are ordered in the response.
440
+ # @!attribute [rw] return_property_quota
441
+ # @return [::Boolean]
442
+ # Toggles whether to return the current state of this Analytics Property's
443
+ # Realtime quota. Quota is returned in [PropertyQuota](#PropertyQuota).
444
+ class RunRealtimeReportRequest
445
+ include ::Google::Protobuf::MessageExts
446
+ extend ::Google::Protobuf::MessageExts::ClassMethods
447
+ end
448
+
449
+ # The response realtime report table corresponding to a request.
450
+ # @!attribute [rw] dimension_headers
451
+ # @return [::Array<::Google::Analytics::Data::V1beta::DimensionHeader>]
452
+ # Describes dimension columns. The number of DimensionHeaders and ordering of
453
+ # DimensionHeaders matches the dimensions present in rows.
454
+ # @!attribute [rw] metric_headers
455
+ # @return [::Array<::Google::Analytics::Data::V1beta::MetricHeader>]
456
+ # Describes metric columns. The number of MetricHeaders and ordering of
457
+ # MetricHeaders matches the metrics present in rows.
458
+ # @!attribute [rw] rows
459
+ # @return [::Array<::Google::Analytics::Data::V1beta::Row>]
460
+ # Rows of dimension value combinations and metric values in the report.
461
+ # @!attribute [rw] totals
462
+ # @return [::Array<::Google::Analytics::Data::V1beta::Row>]
463
+ # If requested, the totaled values of metrics.
464
+ # @!attribute [rw] maximums
465
+ # @return [::Array<::Google::Analytics::Data::V1beta::Row>]
466
+ # If requested, the maximum values of metrics.
467
+ # @!attribute [rw] minimums
468
+ # @return [::Array<::Google::Analytics::Data::V1beta::Row>]
469
+ # If requested, the minimum values of metrics.
470
+ # @!attribute [rw] row_count
471
+ # @return [::Integer]
472
+ # The total number of rows in the query result. `rowCount` is independent of
473
+ # the number of rows returned in the response and the `limit` request
474
+ # parameter. For example if a query returns 175 rows and includes `limit`
475
+ # of 50 in the API request, the response will contain `rowCount` of 175 but
476
+ # only 50 rows.
477
+ # @!attribute [rw] property_quota
478
+ # @return [::Google::Analytics::Data::V1beta::PropertyQuota]
479
+ # This Analytics Property's Realtime quota state including this request.
480
+ # @!attribute [rw] kind
481
+ # @return [::String]
482
+ # Identifies what kind of resource this message is. This `kind` is always the
483
+ # fixed string "analyticsData#runRealtimeReport". Useful to distinguish
484
+ # between response types in JSON.
485
+ class RunRealtimeReportResponse
486
+ include ::Google::Protobuf::MessageExts
487
+ extend ::Google::Protobuf::MessageExts::ClassMethods
488
+ end
489
+ end
490
+ end
491
+ end
492
+ end