google-analytics-data-v1alpha 0.2.0 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/google/analytics/data/v1alpha/analytics_data.rb +1 -0
- data/lib/google/analytics/data/v1alpha/analytics_data/client.rb +158 -20
- data/lib/google/analytics/data/v1alpha/analytics_data/paths.rb +47 -0
- data/lib/google/analytics/data/v1alpha/analytics_data_api_pb.rb +32 -6
- data/lib/google/analytics/data/v1alpha/analytics_data_api_services_pb.rb +13 -5
- data/lib/google/analytics/data/v1alpha/data_pb.rb +14 -4
- data/lib/google/analytics/data/v1alpha/version.rb +1 -1
- data/proto_docs/google/analytics/data/v1alpha/analytics_data_api.rb +112 -8
- data/proto_docs/google/analytics/data/v1alpha/data.rb +193 -79
- data/proto_docs/google/api/resource.rb +283 -0
- metadata +4 -2
@@ -21,6 +21,21 @@ module Google
|
|
21
21
|
module Analytics
|
22
22
|
module Data
|
23
23
|
module V1alpha
|
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::V1alpha::DimensionMetadata>]
|
30
|
+
# The dimension descriptions.
|
31
|
+
# @!attribute [rw] metrics
|
32
|
+
# @return [::Array<::Google::Analytics::Data::V1alpha::MetricMetadata>]
|
33
|
+
# The metric descriptions.
|
34
|
+
class Metadata
|
35
|
+
include ::Google::Protobuf::MessageExts
|
36
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
37
|
+
end
|
38
|
+
|
24
39
|
# The request to generate a report.
|
25
40
|
# @!attribute [rw] entity
|
26
41
|
# @return [::Google::Analytics::Data::V1alpha::Entity]
|
@@ -42,10 +57,16 @@ module Google
|
|
42
57
|
# @!attribute [rw] offset
|
43
58
|
# @return [::Integer]
|
44
59
|
# The row count of the start row. The first row is counted as row 0.
|
60
|
+
#
|
61
|
+
# To learn more about this pagination parameter, see
|
62
|
+
# [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
|
45
63
|
# @!attribute [rw] limit
|
46
64
|
# @return [::Integer]
|
47
65
|
# The number of rows to return. If unspecified, 10 rows are returned. If
|
48
66
|
# -1, all rows are returned.
|
67
|
+
#
|
68
|
+
# To learn more about this pagination parameter, see
|
69
|
+
# [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
|
49
70
|
# @!attribute [rw] metric_aggregations
|
50
71
|
# @return [::Array<::Google::Analytics::Data::V1alpha::MetricAggregation>]
|
51
72
|
# Aggregation of metrics. Aggregated metric values will be shown in rows
|
@@ -111,6 +132,9 @@ module Google
|
|
111
132
|
# rows returned in the response. For example if a query returns 175 rows and
|
112
133
|
# includes limit = 50 in the API request, the response will contain row_count
|
113
134
|
# = 175 but only 50 rows.
|
135
|
+
#
|
136
|
+
# To learn more about this pagination parameter, see
|
137
|
+
# [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
|
114
138
|
# @!attribute [rw] metadata
|
115
139
|
# @return [::Google::Analytics::Data::V1alpha::ResponseMetaData]
|
116
140
|
# Metadata for the report.
|
@@ -295,20 +319,100 @@ module Google
|
|
295
319
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
296
320
|
end
|
297
321
|
|
298
|
-
# Request for
|
299
|
-
|
322
|
+
# Request for a property's dimension and metric metadata.
|
323
|
+
# @!attribute [rw] name
|
324
|
+
# @return [::String]
|
325
|
+
# Required. The resource name of the metadata to retrieve. This name field is
|
326
|
+
# specified in the URL path and not URL parameters. Property is a numeric
|
327
|
+
# Google Analytics GA4 Property identifier. To learn more, see [where to find
|
328
|
+
# your Property
|
329
|
+
# ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
|
330
|
+
#
|
331
|
+
# Example: properties/1234/metadata
|
332
|
+
#
|
333
|
+
# Set the Property ID to 0 for dimensions and metrics common to all
|
334
|
+
# properties. In this special mode, this method will not return custom
|
335
|
+
# dimensions and metrics.
|
336
|
+
class GetMetadataRequest
|
300
337
|
include ::Google::Protobuf::MessageExts
|
301
338
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
302
339
|
end
|
303
340
|
|
304
|
-
# The
|
341
|
+
# The request to generate a realtime report.
|
342
|
+
# @!attribute [rw] property
|
343
|
+
# @return [::String]
|
344
|
+
# A Google Analytics GA4 property identifier whose events are tracked.
|
345
|
+
# Specified in the URL path and not the body. To learn more, see [where to
|
346
|
+
# find your Property
|
347
|
+
# ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
|
348
|
+
#
|
349
|
+
# Example: properties/1234
|
305
350
|
# @!attribute [rw] dimensions
|
306
|
-
# @return [::Array<::Google::Analytics::Data::V1alpha::
|
307
|
-
# The dimensions
|
351
|
+
# @return [::Array<::Google::Analytics::Data::V1alpha::Dimension>]
|
352
|
+
# The dimensions requested and displayed.
|
308
353
|
# @!attribute [rw] metrics
|
309
|
-
# @return [::Array<::Google::Analytics::Data::V1alpha::
|
310
|
-
# The
|
311
|
-
|
354
|
+
# @return [::Array<::Google::Analytics::Data::V1alpha::Metric>]
|
355
|
+
# The metrics requested and displayed.
|
356
|
+
# @!attribute [rw] limit
|
357
|
+
# @return [::Integer]
|
358
|
+
# The number of rows to return. If unspecified, 10 rows are returned. If
|
359
|
+
# -1, all rows are returned.
|
360
|
+
# @!attribute [rw] dimension_filter
|
361
|
+
# @return [::Google::Analytics::Data::V1alpha::FilterExpression]
|
362
|
+
# The filter clause of dimensions. Dimensions must be requested to be used in
|
363
|
+
# this filter. Metrics cannot be used in this filter.
|
364
|
+
# @!attribute [rw] metric_filter
|
365
|
+
# @return [::Google::Analytics::Data::V1alpha::FilterExpression]
|
366
|
+
# The filter clause of metrics. Applied at post aggregation phase, similar to
|
367
|
+
# SQL having-clause. Metrics must be requested to be used in this filter.
|
368
|
+
# Dimensions cannot be used in this filter.
|
369
|
+
# @!attribute [rw] metric_aggregations
|
370
|
+
# @return [::Array<::Google::Analytics::Data::V1alpha::MetricAggregation>]
|
371
|
+
# Aggregation of metrics. Aggregated metric values will be shown in rows
|
372
|
+
# where the dimension_values are set to "RESERVED_(MetricAggregation)".
|
373
|
+
# @!attribute [rw] order_bys
|
374
|
+
# @return [::Array<::Google::Analytics::Data::V1alpha::OrderBy>]
|
375
|
+
# Specifies how rows are ordered in the response.
|
376
|
+
# @!attribute [rw] return_property_quota
|
377
|
+
# @return [::Boolean]
|
378
|
+
# Toggles whether to return the current state of this Analytics Property's
|
379
|
+
# Realtime quota. Quota is returned in [PropertyQuota](#PropertyQuota).
|
380
|
+
class RunRealtimeReportRequest
|
381
|
+
include ::Google::Protobuf::MessageExts
|
382
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
383
|
+
end
|
384
|
+
|
385
|
+
# The response realtime report table corresponding to a request.
|
386
|
+
# @!attribute [rw] dimension_headers
|
387
|
+
# @return [::Array<::Google::Analytics::Data::V1alpha::DimensionHeader>]
|
388
|
+
# Describes dimension columns. The number of DimensionHeaders and ordering of
|
389
|
+
# DimensionHeaders matches the dimensions present in rows.
|
390
|
+
# @!attribute [rw] metric_headers
|
391
|
+
# @return [::Array<::Google::Analytics::Data::V1alpha::MetricHeader>]
|
392
|
+
# Describes metric columns. The number of MetricHeaders and ordering of
|
393
|
+
# MetricHeaders matches the metrics present in rows.
|
394
|
+
# @!attribute [rw] rows
|
395
|
+
# @return [::Array<::Google::Analytics::Data::V1alpha::Row>]
|
396
|
+
# Rows of dimension value combinations and metric values in the report.
|
397
|
+
# @!attribute [rw] totals
|
398
|
+
# @return [::Array<::Google::Analytics::Data::V1alpha::Row>]
|
399
|
+
# If requested, the totaled values of metrics.
|
400
|
+
# @!attribute [rw] maximums
|
401
|
+
# @return [::Array<::Google::Analytics::Data::V1alpha::Row>]
|
402
|
+
# If requested, the maximum values of metrics.
|
403
|
+
# @!attribute [rw] minimums
|
404
|
+
# @return [::Array<::Google::Analytics::Data::V1alpha::Row>]
|
405
|
+
# If requested, the minimum values of metrics.
|
406
|
+
# @!attribute [rw] row_count
|
407
|
+
# @return [::Integer]
|
408
|
+
# The total number of rows in the query result, regardless of the number of
|
409
|
+
# rows returned in the response. For example if a query returns 175 rows and
|
410
|
+
# includes limit = 50 in the API request, the response will contain row_count
|
411
|
+
# = 175 but only 50 rows.
|
412
|
+
# @!attribute [rw] property_quota
|
413
|
+
# @return [::Google::Analytics::Data::V1alpha::PropertyQuota]
|
414
|
+
# This Analytics Property's Realtime quota state including this request.
|
415
|
+
class RunRealtimeReportResponse
|
312
416
|
include ::Google::Protobuf::MessageExts
|
313
417
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
314
418
|
end
|
@@ -22,8 +22,7 @@ module Google
|
|
22
22
|
module Data
|
23
23
|
module V1alpha
|
24
24
|
# A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests
|
25
|
-
# are allowed up to 4 date ranges
|
26
|
-
# 1 year.
|
25
|
+
# are allowed up to 4 date ranges.
|
27
26
|
# @!attribute [rw] start_date
|
28
27
|
# @return [::String]
|
29
28
|
# The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot
|
@@ -50,18 +49,30 @@ module Google
|
|
50
49
|
# The unique identifier of the property whose events are tracked.
|
51
50
|
# @!attribute [rw] property_id
|
52
51
|
# @return [::String]
|
53
|
-
# A Google Analytics
|
52
|
+
# A Google Analytics GA4 property id. To learn more, see [where to find your
|
53
|
+
# Property
|
54
|
+
# ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
|
54
55
|
class Entity
|
55
56
|
include ::Google::Protobuf::MessageExts
|
56
57
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
57
58
|
end
|
58
59
|
|
59
|
-
# Dimensions are attributes of your data. For example, the dimension
|
60
|
-
# indicates the city
|
61
|
-
#
|
60
|
+
# Dimensions are attributes of your data. For example, the dimension city
|
61
|
+
# indicates the city from which an event originates. Dimension values in report
|
62
|
+
# responses are strings; for example, city could be "Paris" or "New York".
|
63
|
+
# Requests are allowed up to 8 dimensions.
|
62
64
|
# @!attribute [rw] name
|
63
65
|
# @return [::String]
|
64
|
-
# The name of the dimension.
|
66
|
+
# The name of the dimension. See the [API
|
67
|
+
# Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions)
|
68
|
+
# for the list of dimension names.
|
69
|
+
#
|
70
|
+
# If `dimensionExpression` is specified, `name` can be any string that you
|
71
|
+
# would like. For example if a `dimensionExpression` concatenates `country`
|
72
|
+
# and `city`, you could call that dimension `countryAndCity`.
|
73
|
+
#
|
74
|
+
# Dimensions are referenced by `name` in `dimensionFilter`, `orderBys`,
|
75
|
+
# `dimensionExpression`, and `pivots`.
|
65
76
|
# @!attribute [rw] dimension_expression
|
66
77
|
# @return [::Google::Analytics::Data::V1alpha::DimensionExpression]
|
67
78
|
# One dimension can be the result of an expression of multiple dimensions.
|
@@ -119,20 +130,30 @@ module Google
|
|
119
130
|
end
|
120
131
|
end
|
121
132
|
|
122
|
-
# The quantitative measurements of a report. For example, the metric
|
123
|
-
# is the total number of events. Requests are allowed up to 10
|
133
|
+
# The quantitative measurements of a report. For example, the metric
|
134
|
+
# `eventCount` is the total number of events. Requests are allowed up to 10
|
135
|
+
# metrics.
|
124
136
|
# @!attribute [rw] name
|
125
137
|
# @return [::String]
|
126
|
-
# The name of the metric.
|
138
|
+
# The name of the metric. See the [API
|
139
|
+
# Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics)
|
140
|
+
# for the list of metric names.
|
141
|
+
#
|
142
|
+
# If `expression` is specified, `name` can be any string that you would like.
|
143
|
+
# For example if `expression` is `screenPageViews/sessions`, you could call
|
144
|
+
# that metric's name = `viewsPerSession`.
|
145
|
+
#
|
146
|
+
# Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric
|
147
|
+
# `expression`.
|
127
148
|
# @!attribute [rw] expression
|
128
149
|
# @return [::String]
|
129
150
|
# A mathematical expression for derived metrics. For example, the metric
|
130
|
-
# Event count per user is eventCount/totalUsers
|
151
|
+
# Event count per user is `eventCount/totalUsers`.
|
131
152
|
# @!attribute [rw] invisible
|
132
153
|
# @return [::Boolean]
|
133
|
-
# Indicates if a metric is invisible.
|
134
|
-
#
|
135
|
-
# used in
|
154
|
+
# Indicates if a metric is invisible in the report response. If a metric is
|
155
|
+
# invisible, the metric will not produce a column in the response, but can be
|
156
|
+
# used in `metricFilter`, `orderBys`, or a metric `expression`.
|
136
157
|
class Metric
|
137
158
|
include ::Google::Protobuf::MessageExts
|
138
159
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -176,7 +197,10 @@ module Google
|
|
176
197
|
# or metrics.
|
177
198
|
# @!attribute [rw] null_filter
|
178
199
|
# @return [::Boolean]
|
179
|
-
# A filter for null values.
|
200
|
+
# A filter for null values. If True, a null dimension value is matched by
|
201
|
+
# this filter. Null filter is commonly used inside a NOT filter
|
202
|
+
# expression. For example, a NOT expression of a null filter removes rows
|
203
|
+
# when a dimension is null.
|
180
204
|
# @!attribute [rw] string_filter
|
181
205
|
# @return [::Google::Analytics::Data::V1alpha::Filter::StringFilter]
|
182
206
|
# Strings related filter.
|
@@ -423,23 +447,38 @@ module Google
|
|
423
447
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
424
448
|
end
|
425
449
|
|
426
|
-
# Specification for a cohort report.
|
450
|
+
# Specification of cohorts for a cohort report.
|
451
|
+
# Cohort reports can be used for example to create a time series of user
|
452
|
+
# retention for the cohort. For example, you could select the cohort of users
|
453
|
+
# that were acquired in the first week of September and follow that cohort for
|
454
|
+
# the next six weeks. Selecting the users acquired in the first week of
|
455
|
+
# September cohort is specified in the `cohort` object. Following that
|
456
|
+
# cohort for the next six weeks is specified in the `cohortsRange` object.
|
457
|
+
#
|
458
|
+
# The report response could show a weekly time series where say your app has
|
459
|
+
# retained 60% of this cohort after three weeks and 25% of this cohort after
|
460
|
+
# six weeks. These two percentages can be calculated by the metric
|
461
|
+
# `cohortActiveUsers/cohortTotalUsers` and will be separate rows in the report.
|
427
462
|
# @!attribute [rw] cohorts
|
428
463
|
# @return [::Array<::Google::Analytics::Data::V1alpha::Cohort>]
|
429
|
-
#
|
464
|
+
# Defines the selection criteria to group users into cohorts.
|
465
|
+
#
|
466
|
+
# Most cohort reports define only a single cohort. If multiple cohorts are
|
467
|
+
# specified, each cohort can be recognized in the report by their name.
|
430
468
|
# @!attribute [rw] cohorts_range
|
431
469
|
# @return [::Google::Analytics::Data::V1alpha::CohortsRange]
|
432
|
-
#
|
470
|
+
# Cohort reports follow cohorts over an extended reporting date range. This
|
471
|
+
# range specifies an offset duration to follow the cohorts over.
|
433
472
|
# @!attribute [rw] cohort_report_settings
|
434
473
|
# @return [::Google::Analytics::Data::V1alpha::CohortReportSettings]
|
435
|
-
#
|
474
|
+
# Optional settings for a cohort report.
|
436
475
|
class CohortSpec
|
437
476
|
include ::Google::Protobuf::MessageExts
|
438
477
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
439
478
|
end
|
440
479
|
|
441
|
-
# Defines a cohort. A cohort is a group of users who share
|
442
|
-
# characteristic. For example,
|
480
|
+
# Defines a cohort selection criteria. A cohort is a group of users who share
|
481
|
+
# a common characteristic. For example, users with the same `firstTouchDate`
|
443
482
|
# belong to the same cohort.
|
444
483
|
# @!attribute [rw] name
|
445
484
|
# @return [::String]
|
@@ -449,69 +488,100 @@ module Google
|
|
449
488
|
# `cohort_0`, `cohort_1`, etc.
|
450
489
|
# @!attribute [rw] dimension
|
451
490
|
# @return [::String]
|
452
|
-
#
|
453
|
-
# report.
|
491
|
+
# Dimension used by the cohort. Required and only supports `firstTouchDate`.
|
454
492
|
# @!attribute [rw] date_range
|
455
493
|
# @return [::Google::Analytics::Data::V1alpha::DateRange]
|
456
|
-
# The cohort selects users whose first
|
457
|
-
#
|
458
|
-
#
|
459
|
-
# `
|
494
|
+
# The cohort selects users whose first touch date is between start date and
|
495
|
+
# end date defined in the `dateRange`. This `dateRange` does not specify the
|
496
|
+
# full date range of event data that is present in a cohort report. In a
|
497
|
+
# cohort report, this `dateRange` is extended by the granularity and offset
|
498
|
+
# present in the `cohortsRange`; event data for the extended reporting date
|
499
|
+
# range is present in a cohort report.
|
500
|
+
#
|
501
|
+
# In a cohort request, this `dateRange` is required and the `dateRanges` in
|
502
|
+
# the `RunReportRequest` or `RunPivotReportRequest` must be unspecified.
|
460
503
|
#
|
461
|
-
#
|
462
|
-
# CohortsRange uses daily granularity,
|
463
|
-
# day. If CohortsRange uses weekly granularity,
|
464
|
-
# aligned to
|
465
|
-
# CohortsRange uses monthly granularity,
|
466
|
-
#
|
504
|
+
# This `dateRange` should generally be aligned with the cohort's granularity.
|
505
|
+
# If `CohortsRange` uses daily granularity, this `dateRange` can be a single
|
506
|
+
# day. If `CohortsRange` uses weekly granularity, this `dateRange` can be
|
507
|
+
# aligned to a week boundary, starting at Sunday and ending Saturday. If
|
508
|
+
# `CohortsRange` uses monthly granularity, this `dateRange` can be aligned to
|
509
|
+
# a month, starting at the first and ending on the last day of the month.
|
467
510
|
class Cohort
|
468
511
|
include ::Google::Protobuf::MessageExts
|
469
512
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
470
513
|
end
|
471
514
|
|
472
|
-
#
|
473
|
-
#
|
474
|
-
# @return [::Boolean]
|
475
|
-
# If true, accumulates the result from first visit day to the end day. Not
|
476
|
-
# supported in `RunReportRequest`.
|
477
|
-
class CohortReportSettings
|
478
|
-
include ::Google::Protobuf::MessageExts
|
479
|
-
extend ::Google::Protobuf::MessageExts::ClassMethods
|
480
|
-
end
|
481
|
-
|
482
|
-
# Describes date range for a cohort report.
|
515
|
+
# Configures the extended reporting date range for a cohort report. Specifies
|
516
|
+
# an offset duration to follow the cohorts over.
|
483
517
|
# @!attribute [rw] granularity
|
484
518
|
# @return [::Google::Analytics::Data::V1alpha::CohortsRange::Granularity]
|
485
|
-
#
|
486
|
-
#
|
519
|
+
# The granularity used to interpret the `startOffset` and `endOffset` for the
|
520
|
+
# extended reporting date range for a cohort report.
|
487
521
|
# @!attribute [rw] start_offset
|
488
522
|
# @return [::Integer]
|
489
|
-
#
|
490
|
-
#
|
523
|
+
# `startOffset` specifies the start date of the extended reporting date range
|
524
|
+
# for a cohort report. `startOffset` is commonly set to 0 so that reports
|
525
|
+
# contain data from the acquisition of the cohort forward.
|
526
|
+
#
|
527
|
+
# If `granularity` is `DAILY`, the `startDate` of the extended reporting date
|
528
|
+
# range is `startDate` of the cohort plus `startOffset` days.
|
529
|
+
#
|
530
|
+
# If `granularity` is `WEEKLY`, the `startDate` of the extended reporting
|
531
|
+
# date range is `startDate` of the cohort plus `startOffset * 7` days.
|
532
|
+
#
|
533
|
+
# If `granularity` is `MONTHLY`, the `startDate` of the extended reporting
|
534
|
+
# date range is `startDate` of the cohort plus `startOffset * 30` days.
|
491
535
|
# @!attribute [rw] end_offset
|
492
536
|
# @return [::Integer]
|
493
|
-
#
|
494
|
-
#
|
537
|
+
# `endOffset` specifies the end date of the extended reporting date range
|
538
|
+
# for a cohort report. `endOffset` can be any positive integer but is
|
539
|
+
# commonly set to 5 to 10 so that reports contain data on the cohort for the
|
540
|
+
# next several granularity time periods.
|
541
|
+
#
|
542
|
+
# If `granularity` is `DAILY`, the `endDate` of the extended reporting date
|
543
|
+
# range is `endDate` of the cohort plus `endOffset` days.
|
544
|
+
#
|
545
|
+
# If `granularity` is `WEEKLY`, the `endDate` of the extended reporting date
|
546
|
+
# range is `endDate` of the cohort plus `endOffset * 7` days.
|
547
|
+
#
|
548
|
+
# If `granularity` is `MONTHLY`, the `endDate` of the extended reporting date
|
549
|
+
# range is `endDate` of the cohort plus `endOffset * 30` days.
|
495
550
|
class CohortsRange
|
496
551
|
include ::Google::Protobuf::MessageExts
|
497
552
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
498
553
|
|
499
|
-
#
|
554
|
+
# The granularity used to interpret the `startOffset` and `endOffset` for the
|
555
|
+
# extended reporting date range for a cohort report.
|
500
556
|
module Granularity
|
501
|
-
#
|
557
|
+
# Should never be specified.
|
502
558
|
GRANULARITY_UNSPECIFIED = 0
|
503
559
|
|
504
|
-
# Daily
|
560
|
+
# Daily granularity. Commonly used if the cohort's `dateRange` is a single
|
561
|
+
# day and the request contains `cohortNthDay`.
|
505
562
|
DAILY = 1
|
506
563
|
|
507
|
-
# Weekly
|
564
|
+
# Weekly granularity. Commonly used if the cohort's `dateRange` is a week
|
565
|
+
# in duration (starting on Sunday and ending on Saturday) and the request
|
566
|
+
# contains `cohortNthWeek`.
|
508
567
|
WEEKLY = 2
|
509
568
|
|
510
|
-
# Monthly
|
569
|
+
# Monthly granularity. Commonly used if the cohort's `dateRange` is a month
|
570
|
+
# in duration and the request contains `cohortNthMonth`.
|
511
571
|
MONTHLY = 3
|
512
572
|
end
|
513
573
|
end
|
514
574
|
|
575
|
+
# Optional settings of a cohort report.
|
576
|
+
# @!attribute [rw] accumulate
|
577
|
+
# @return [::Boolean]
|
578
|
+
# If true, accumulates the result from first touch day to the end day. Not
|
579
|
+
# supported in `RunReportRequest`.
|
580
|
+
class CohortReportSettings
|
581
|
+
include ::Google::Protobuf::MessageExts
|
582
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
583
|
+
end
|
584
|
+
|
515
585
|
# Response's metadata carrying additional information about the report content.
|
516
586
|
# @!attribute [rw] data_loss_from_other_row
|
517
587
|
# @return [::Boolean]
|
@@ -577,28 +647,38 @@ module Google
|
|
577
647
|
# For example if RunReportRequest contains:
|
578
648
|
#
|
579
649
|
# ```none
|
580
|
-
# dimensions
|
581
|
-
#
|
582
|
-
#
|
583
|
-
#
|
584
|
-
#
|
585
|
-
#
|
586
|
-
#
|
587
|
-
#
|
588
|
-
#
|
650
|
+
# "dimensions": [
|
651
|
+
# {
|
652
|
+
# "name": "eventName"
|
653
|
+
# },
|
654
|
+
# {
|
655
|
+
# "name": "countryId"
|
656
|
+
# }
|
657
|
+
# ],
|
658
|
+
# "metrics": [
|
659
|
+
# {
|
660
|
+
# "name": "eventCount"
|
661
|
+
# }
|
662
|
+
# ]
|
589
663
|
# ```
|
590
664
|
#
|
591
|
-
# One row with 'in_app_purchase' as the eventName, '
|
665
|
+
# One row with 'in_app_purchase' as the eventName, 'JP' as the countryId, and
|
592
666
|
# 15 as the eventCount, would be:
|
593
667
|
#
|
594
668
|
# ```none
|
595
|
-
#
|
596
|
-
#
|
597
|
-
#
|
598
|
-
#
|
599
|
-
#
|
600
|
-
#
|
601
|
-
#
|
669
|
+
# "dimensionValues": [
|
670
|
+
# {
|
671
|
+
# "value": "in_app_purchase"
|
672
|
+
# },
|
673
|
+
# {
|
674
|
+
# "value": "JP"
|
675
|
+
# }
|
676
|
+
# ],
|
677
|
+
# "metricValues": [
|
678
|
+
# {
|
679
|
+
# "value": "15"
|
680
|
+
# }
|
681
|
+
# ]
|
602
682
|
# ```
|
603
683
|
# @!attribute [rw] dimension_values
|
604
684
|
# @return [::Array<::Google::Analytics::Data::V1alpha::DimensionValue>]
|
@@ -647,20 +727,24 @@ module Google
|
|
647
727
|
# Exhausted errors.
|
648
728
|
# @!attribute [rw] tokens_per_day
|
649
729
|
# @return [::Google::Analytics::Data::V1alpha::QuotaStatus]
|
650
|
-
# Analytics Properties can use up to 25,000 tokens per day
|
730
|
+
# Standard Analytics Properties can use up to 25,000 tokens per day;
|
731
|
+
# Analytics 360 Properties can use 250,000 tokens per day. Most requests
|
651
732
|
# consume fewer than 10 tokens.
|
652
733
|
# @!attribute [rw] tokens_per_hour
|
653
734
|
# @return [::Google::Analytics::Data::V1alpha::QuotaStatus]
|
654
|
-
# Analytics Properties can use up to 5,000 tokens per day
|
655
|
-
#
|
656
|
-
#
|
735
|
+
# Standard Analytics Properties can use up to 5,000 tokens per day; Analytics
|
736
|
+
# 360 Properties can use 50,000 tokens per day. An API request consumes a
|
737
|
+
# single number of tokens, and that number is deducted from both the hourly
|
738
|
+
# and daily quotas.
|
657
739
|
# @!attribute [rw] concurrent_requests
|
658
740
|
# @return [::Google::Analytics::Data::V1alpha::QuotaStatus]
|
659
|
-
# Analytics Properties can send up to 10 concurrent requests
|
741
|
+
# Standard Analytics Properties can send up to 10 concurrent requests;
|
742
|
+
# Analytics 360 Properties can use up to 50 concurrent requests.
|
660
743
|
# @!attribute [rw] server_errors_per_project_per_hour
|
661
744
|
# @return [::Google::Analytics::Data::V1alpha::QuotaStatus]
|
662
|
-
# Analytics Properties and cloud project pairs can have up to 10
|
663
|
-
# server errors per hour
|
745
|
+
# Standard Analytics Properties and cloud project pairs can have up to 10
|
746
|
+
# server errors per hour; Analytics 360 Properties and cloud project pairs
|
747
|
+
# can have up to 50 server errors per hour.
|
664
748
|
class PropertyQuota
|
665
749
|
include ::Google::Protobuf::MessageExts
|
666
750
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -696,6 +780,9 @@ module Google
|
|
696
780
|
# dimension is available by either `apiName` or one of `deprecatedApiNames`
|
697
781
|
# for a period of time. After the deprecation period, the dimension will be
|
698
782
|
# available only by `apiName`.
|
783
|
+
# @!attribute [rw] custom_definition
|
784
|
+
# @return [::Boolean]
|
785
|
+
# True if the dimension is a custom dimension for this property.
|
699
786
|
class DimensionMetadata
|
700
787
|
include ::Google::Protobuf::MessageExts
|
701
788
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -727,6 +814,9 @@ module Google
|
|
727
814
|
# The mathematical expression for this derived metric. Can be used in
|
728
815
|
# [Metric](#Metric)'s `expression` field for equivalent reports. Most metrics
|
729
816
|
# are not expressions, and for non-expressions, this field is empty.
|
817
|
+
# @!attribute [rw] custom_definition
|
818
|
+
# @return [::Boolean]
|
819
|
+
# True if the metric is a custom metric for this property.
|
730
820
|
class MetricMetadata
|
731
821
|
include ::Google::Protobuf::MessageExts
|
732
822
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -764,8 +854,32 @@ module Google
|
|
764
854
|
# A duration of seconds; a special floating point type.
|
765
855
|
TYPE_SECONDS = 4
|
766
856
|
|
857
|
+
# A duration in milliseconds; a special floating point type.
|
858
|
+
TYPE_MILLISECONDS = 5
|
859
|
+
|
860
|
+
# A duration in minutes; a special floating point type.
|
861
|
+
TYPE_MINUTES = 6
|
862
|
+
|
863
|
+
# A duration in hours; a special floating point type.
|
864
|
+
TYPE_HOURS = 7
|
865
|
+
|
866
|
+
# A custom metric of standard type; a special floating point type.
|
867
|
+
TYPE_STANDARD = 8
|
868
|
+
|
767
869
|
# An amount of money; a special floating point type.
|
768
870
|
TYPE_CURRENCY = 9
|
871
|
+
|
872
|
+
# A length in feet; a special floating point type.
|
873
|
+
TYPE_FEET = 10
|
874
|
+
|
875
|
+
# A length in miles; a special floating point type.
|
876
|
+
TYPE_MILES = 11
|
877
|
+
|
878
|
+
# A length in meters; a special floating point type.
|
879
|
+
TYPE_METERS = 12
|
880
|
+
|
881
|
+
# A length in kilometers; a special floating point type.
|
882
|
+
TYPE_KILOMETERS = 13
|
769
883
|
end
|
770
884
|
end
|
771
885
|
end
|