google-apis-analyticsdata_v1beta 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/CHANGELOG.md +17 -0
- data/lib/google/apis/analyticsdata_v1beta/classes.rb +200 -0
- data/lib/google/apis/analyticsdata_v1beta/gem_version.rb +3 -3
- data/lib/google/apis/analyticsdata_v1beta/representations.rb +86 -0
- data/lib/google/apis/analyticsdata_v1beta/service.rb +45 -0
- metadata +13 -7
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: aebbab886c0e4d17faf9b94cba17139b5664973e852365d1d458a566d4d1da37
|
4
|
+
data.tar.gz: f542ea9bf8630ceb54ecb22a5839ef6b31a11622d65f700336af11b0f2181248
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9f5745d90be012abe2a7b42574396d9d2f977c81c4836514796e07e84f9da85a0e7c5b32a79b48fcf63d2d69fc743089b42c0fbeb26c8dc79a4821cbb613d99a
|
7
|
+
data.tar.gz: 5607c47f1063b0698197a2283da9ab2fd564b3adf35dd10345445f3d7dd664dbe44c29462d32d6e01b0859e2fbb5dfce9a8df9216ecc7d02ef3177d9a1f88995
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,22 @@
|
|
1
1
|
# Release history for google-apis-analyticsdata_v1beta
|
2
2
|
|
3
|
+
### v0.6.0 (2021-08-26)
|
4
|
+
|
5
|
+
* Regenerated from discovery document revision 20210824
|
6
|
+
|
7
|
+
### v0.5.0 (2021-06-29)
|
8
|
+
|
9
|
+
* Regenerated from discovery document revision 20210625
|
10
|
+
* Regenerated using generator version 0.4.0
|
11
|
+
|
12
|
+
### v0.4.0 (2021-06-24)
|
13
|
+
|
14
|
+
* Regenerated using generator version 0.3.0
|
15
|
+
|
16
|
+
### v0.3.0 (2021-05-19)
|
17
|
+
|
18
|
+
* Unspecified changes
|
19
|
+
|
3
20
|
### v0.2.0 (2021-04-07)
|
4
21
|
|
5
22
|
* Regenerated from discovery document revision 20210403
|
@@ -161,6 +161,83 @@ module Google
|
|
161
161
|
end
|
162
162
|
end
|
163
163
|
|
164
|
+
# The request for compatibility information for a report's dimensions and
|
165
|
+
# metrics. Check compatibility provides a preview of the compatibility of a
|
166
|
+
# report; fields shared with the `runReport` request should be the same values
|
167
|
+
# as in your `runReport` request.
|
168
|
+
class CheckCompatibilityRequest
|
169
|
+
include Google::Apis::Core::Hashable
|
170
|
+
|
171
|
+
# Filters the dimensions and metrics in the response to just this compatibility.
|
172
|
+
# Commonly used as `”compatibilityFilter”: “COMPATIBLE”` to only return
|
173
|
+
# compatible dimensions & metrics.
|
174
|
+
# Corresponds to the JSON property `compatibilityFilter`
|
175
|
+
# @return [String]
|
176
|
+
attr_accessor :compatibility_filter
|
177
|
+
|
178
|
+
# To express dimension or metric filters. The fields in the same
|
179
|
+
# FilterExpression need to be either all dimensions or all metrics.
|
180
|
+
# Corresponds to the JSON property `dimensionFilter`
|
181
|
+
# @return [Google::Apis::AnalyticsdataV1beta::FilterExpression]
|
182
|
+
attr_accessor :dimension_filter
|
183
|
+
|
184
|
+
# The dimensions in this report. `dimensions` should be the same value as in
|
185
|
+
# your `runReport` request.
|
186
|
+
# Corresponds to the JSON property `dimensions`
|
187
|
+
# @return [Array<Google::Apis::AnalyticsdataV1beta::Dimension>]
|
188
|
+
attr_accessor :dimensions
|
189
|
+
|
190
|
+
# To express dimension or metric filters. The fields in the same
|
191
|
+
# FilterExpression need to be either all dimensions or all metrics.
|
192
|
+
# Corresponds to the JSON property `metricFilter`
|
193
|
+
# @return [Google::Apis::AnalyticsdataV1beta::FilterExpression]
|
194
|
+
attr_accessor :metric_filter
|
195
|
+
|
196
|
+
# The metrics in this report. `metrics` should be the same value as in your `
|
197
|
+
# runReport` request.
|
198
|
+
# Corresponds to the JSON property `metrics`
|
199
|
+
# @return [Array<Google::Apis::AnalyticsdataV1beta::Metric>]
|
200
|
+
attr_accessor :metrics
|
201
|
+
|
202
|
+
def initialize(**args)
|
203
|
+
update!(**args)
|
204
|
+
end
|
205
|
+
|
206
|
+
# Update properties of this object
|
207
|
+
def update!(**args)
|
208
|
+
@compatibility_filter = args[:compatibility_filter] if args.key?(:compatibility_filter)
|
209
|
+
@dimension_filter = args[:dimension_filter] if args.key?(:dimension_filter)
|
210
|
+
@dimensions = args[:dimensions] if args.key?(:dimensions)
|
211
|
+
@metric_filter = args[:metric_filter] if args.key?(:metric_filter)
|
212
|
+
@metrics = args[:metrics] if args.key?(:metrics)
|
213
|
+
end
|
214
|
+
end
|
215
|
+
|
216
|
+
# The compatibility response with the compatibility of each dimension & metric.
|
217
|
+
class CheckCompatibilityResponse
|
218
|
+
include Google::Apis::Core::Hashable
|
219
|
+
|
220
|
+
# The compatibility of each dimension.
|
221
|
+
# Corresponds to the JSON property `dimensionCompatibilities`
|
222
|
+
# @return [Array<Google::Apis::AnalyticsdataV1beta::DimensionCompatibility>]
|
223
|
+
attr_accessor :dimension_compatibilities
|
224
|
+
|
225
|
+
# The compatibility of each metric.
|
226
|
+
# Corresponds to the JSON property `metricCompatibilities`
|
227
|
+
# @return [Array<Google::Apis::AnalyticsdataV1beta::MetricCompatibility>]
|
228
|
+
attr_accessor :metric_compatibilities
|
229
|
+
|
230
|
+
def initialize(**args)
|
231
|
+
update!(**args)
|
232
|
+
end
|
233
|
+
|
234
|
+
# Update properties of this object
|
235
|
+
def update!(**args)
|
236
|
+
@dimension_compatibilities = args[:dimension_compatibilities] if args.key?(:dimension_compatibilities)
|
237
|
+
@metric_compatibilities = args[:metric_compatibilities] if args.key?(:metric_compatibilities)
|
238
|
+
end
|
239
|
+
end
|
240
|
+
|
164
241
|
# Defines a cohort selection criteria. A cohort is a group of users who share a
|
165
242
|
# common characteristic. For example, users with the same `firstSessionDate`
|
166
243
|
# belong to the same cohort.
|
@@ -421,6 +498,32 @@ module Google
|
|
421
498
|
end
|
422
499
|
end
|
423
500
|
|
501
|
+
# The compatibility for a single dimension.
|
502
|
+
class DimensionCompatibility
|
503
|
+
include Google::Apis::Core::Hashable
|
504
|
+
|
505
|
+
# The compatibility of this dimension. If the compatibility is COMPATIBLE, this
|
506
|
+
# dimension can be successfully added to the report.
|
507
|
+
# Corresponds to the JSON property `compatibility`
|
508
|
+
# @return [String]
|
509
|
+
attr_accessor :compatibility
|
510
|
+
|
511
|
+
# Explains a dimension.
|
512
|
+
# Corresponds to the JSON property `dimensionMetadata`
|
513
|
+
# @return [Google::Apis::AnalyticsdataV1beta::DimensionMetadata]
|
514
|
+
attr_accessor :dimension_metadata
|
515
|
+
|
516
|
+
def initialize(**args)
|
517
|
+
update!(**args)
|
518
|
+
end
|
519
|
+
|
520
|
+
# Update properties of this object
|
521
|
+
def update!(**args)
|
522
|
+
@compatibility = args[:compatibility] if args.key?(:compatibility)
|
523
|
+
@dimension_metadata = args[:dimension_metadata] if args.key?(:dimension_metadata)
|
524
|
+
end
|
525
|
+
end
|
526
|
+
|
424
527
|
# Used to express a dimension which is the result of a formula of multiple
|
425
528
|
# dimensions. Example usages: 1) lower_case(dimension) 2) concatenate(dimension1,
|
426
529
|
# symbol, dimension2).
|
@@ -486,6 +589,12 @@ module Google
|
|
486
589
|
# @return [String]
|
487
590
|
attr_accessor :api_name
|
488
591
|
|
592
|
+
# The display name of the category that this dimension belongs to. Similar
|
593
|
+
# dimensions and metrics are categorized together.
|
594
|
+
# Corresponds to the JSON property `category`
|
595
|
+
# @return [String]
|
596
|
+
attr_accessor :category
|
597
|
+
|
489
598
|
# True if the dimension is a custom dimension for this property.
|
490
599
|
# Corresponds to the JSON property `customDefinition`
|
491
600
|
# @return [Boolean]
|
@@ -518,6 +627,7 @@ module Google
|
|
518
627
|
# Update properties of this object
|
519
628
|
def update!(**args)
|
520
629
|
@api_name = args[:api_name] if args.key?(:api_name)
|
630
|
+
@category = args[:category] if args.key?(:category)
|
521
631
|
@custom_definition = args[:custom_definition] if args.key?(:custom_definition)
|
522
632
|
@deprecated_api_names = args[:deprecated_api_names] if args.key?(:deprecated_api_names)
|
523
633
|
@description = args[:description] if args.key?(:description)
|
@@ -771,6 +881,32 @@ module Google
|
|
771
881
|
end
|
772
882
|
end
|
773
883
|
|
884
|
+
# The compatibility for a single metric.
|
885
|
+
class MetricCompatibility
|
886
|
+
include Google::Apis::Core::Hashable
|
887
|
+
|
888
|
+
# The compatibility of this metric. If the compatibility is COMPATIBLE, this
|
889
|
+
# metric can be successfully added to the report.
|
890
|
+
# Corresponds to the JSON property `compatibility`
|
891
|
+
# @return [String]
|
892
|
+
attr_accessor :compatibility
|
893
|
+
|
894
|
+
# Explains a metric.
|
895
|
+
# Corresponds to the JSON property `metricMetadata`
|
896
|
+
# @return [Google::Apis::AnalyticsdataV1beta::MetricMetadata]
|
897
|
+
attr_accessor :metric_metadata
|
898
|
+
|
899
|
+
def initialize(**args)
|
900
|
+
update!(**args)
|
901
|
+
end
|
902
|
+
|
903
|
+
# Update properties of this object
|
904
|
+
def update!(**args)
|
905
|
+
@compatibility = args[:compatibility] if args.key?(:compatibility)
|
906
|
+
@metric_metadata = args[:metric_metadata] if args.key?(:metric_metadata)
|
907
|
+
end
|
908
|
+
end
|
909
|
+
|
774
910
|
# Describes a metric column in the report. Visible metrics requested in a report
|
775
911
|
# produce column entries within rows and MetricHeaders. However, metrics used
|
776
912
|
# exclusively within filters or expressions do not produce columns in a report;
|
@@ -809,6 +945,12 @@ module Google
|
|
809
945
|
# @return [String]
|
810
946
|
attr_accessor :api_name
|
811
947
|
|
948
|
+
# The display name of the category that this metrics belongs to. Similar
|
949
|
+
# dimensions and metrics are categorized together.
|
950
|
+
# Corresponds to the JSON property `category`
|
951
|
+
# @return [String]
|
952
|
+
attr_accessor :category
|
953
|
+
|
812
954
|
# True if the metric is a custom metric for this property.
|
813
955
|
# Corresponds to the JSON property `customDefinition`
|
814
956
|
# @return [Boolean]
|
@@ -853,6 +995,7 @@ module Google
|
|
853
995
|
# Update properties of this object
|
854
996
|
def update!(**args)
|
855
997
|
@api_name = args[:api_name] if args.key?(:api_name)
|
998
|
+
@category = args[:category] if args.key?(:category)
|
856
999
|
@custom_definition = args[:custom_definition] if args.key?(:custom_definition)
|
857
1000
|
@deprecated_api_names = args[:deprecated_api_names] if args.key?(:deprecated_api_names)
|
858
1001
|
@description = args[:description] if args.key?(:description)
|
@@ -900,6 +1043,53 @@ module Google
|
|
900
1043
|
end
|
901
1044
|
end
|
902
1045
|
|
1046
|
+
# A contiguous set of minutes: startMinutesAgo, startMinutesAgo + 1, ...,
|
1047
|
+
# endMinutesAgo. Requests are allowed up to 2 minute ranges.
|
1048
|
+
class MinuteRange
|
1049
|
+
include Google::Apis::Core::Hashable
|
1050
|
+
|
1051
|
+
# The inclusive end minute for the query as a number of minutes before now.
|
1052
|
+
# Cannot be before `startMinutesAgo`. For example, `"endMinutesAgo": 15`
|
1053
|
+
# specifies the report should include event data from prior to 15 minutes ago.
|
1054
|
+
# If unspecified, `endMinutesAgo` is defaulted to 0. Standard Analytics
|
1055
|
+
# properties can request any minute in the last 30 minutes of event data (`
|
1056
|
+
# endMinutesAgo <= 29`), and 360 Analytics properties can request any minute in
|
1057
|
+
# the last 60 minutes of event data (`endMinutesAgo <= 59`).
|
1058
|
+
# Corresponds to the JSON property `endMinutesAgo`
|
1059
|
+
# @return [Fixnum]
|
1060
|
+
attr_accessor :end_minutes_ago
|
1061
|
+
|
1062
|
+
# Assigns a name to this minute range. The dimension `dateRange` is valued to
|
1063
|
+
# this name in a report response. If set, cannot begin with `date_range_` or `
|
1064
|
+
# RESERVED_`. If not set, minute ranges are named by their zero based index in
|
1065
|
+
# the request: `date_range_0`, `date_range_1`, etc.
|
1066
|
+
# Corresponds to the JSON property `name`
|
1067
|
+
# @return [String]
|
1068
|
+
attr_accessor :name
|
1069
|
+
|
1070
|
+
# The inclusive start minute for the query as a number of minutes before now.
|
1071
|
+
# For example, `"startMinutesAgo": 29` specifies the report should include event
|
1072
|
+
# data from 29 minutes ago and after. Cannot be after `endMinutesAgo`. If
|
1073
|
+
# unspecified, `startMinutesAgo` is defaulted to 29. Standard Analytics
|
1074
|
+
# properties can request up to the last 30 minutes of event data (`
|
1075
|
+
# startMinutesAgo <= 29`), and 360 Analytics properties can request up to the
|
1076
|
+
# last 60 minutes of event data (`startMinutesAgo <= 59`).
|
1077
|
+
# Corresponds to the JSON property `startMinutesAgo`
|
1078
|
+
# @return [Fixnum]
|
1079
|
+
attr_accessor :start_minutes_ago
|
1080
|
+
|
1081
|
+
def initialize(**args)
|
1082
|
+
update!(**args)
|
1083
|
+
end
|
1084
|
+
|
1085
|
+
# Update properties of this object
|
1086
|
+
def update!(**args)
|
1087
|
+
@end_minutes_ago = args[:end_minutes_ago] if args.key?(:end_minutes_ago)
|
1088
|
+
@name = args[:name] if args.key?(:name)
|
1089
|
+
@start_minutes_ago = args[:start_minutes_ago] if args.key?(:start_minutes_ago)
|
1090
|
+
end
|
1091
|
+
end
|
1092
|
+
|
903
1093
|
# Filters for numeric or date values.
|
904
1094
|
class NumericFilter
|
905
1095
|
include Google::Apis::Core::Hashable
|
@@ -1507,6 +1697,15 @@ module Google
|
|
1507
1697
|
# @return [Array<Google::Apis::AnalyticsdataV1beta::Metric>]
|
1508
1698
|
attr_accessor :metrics
|
1509
1699
|
|
1700
|
+
# The minute ranges of event data to read. If unspecified, one minute range for
|
1701
|
+
# the last 30 minutes will be used. If multiple minute ranges are requested,
|
1702
|
+
# each response row will contain a zero based minute range index. If two minute
|
1703
|
+
# ranges overlap, the event data for the overlapping minutes is included in the
|
1704
|
+
# response rows for both minute ranges.
|
1705
|
+
# Corresponds to the JSON property `minuteRanges`
|
1706
|
+
# @return [Array<Google::Apis::AnalyticsdataV1beta::MinuteRange>]
|
1707
|
+
attr_accessor :minute_ranges
|
1708
|
+
|
1510
1709
|
# Specifies how rows are ordered in the response.
|
1511
1710
|
# Corresponds to the JSON property `orderBys`
|
1512
1711
|
# @return [Array<Google::Apis::AnalyticsdataV1beta::OrderBy>]
|
@@ -1531,6 +1730,7 @@ module Google
|
|
1531
1730
|
@metric_aggregations = args[:metric_aggregations] if args.key?(:metric_aggregations)
|
1532
1731
|
@metric_filter = args[:metric_filter] if args.key?(:metric_filter)
|
1533
1732
|
@metrics = args[:metrics] if args.key?(:metrics)
|
1733
|
+
@minute_ranges = args[:minute_ranges] if args.key?(:minute_ranges)
|
1534
1734
|
@order_bys = args[:order_bys] if args.key?(:order_bys)
|
1535
1735
|
@return_property_quota = args[:return_property_quota] if args.key?(:return_property_quota)
|
1536
1736
|
end
|
@@ -16,13 +16,13 @@ module Google
|
|
16
16
|
module Apis
|
17
17
|
module AnalyticsdataV1beta
|
18
18
|
# Version of the google-apis-analyticsdata_v1beta gem
|
19
|
-
GEM_VERSION = "0.
|
19
|
+
GEM_VERSION = "0.6.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
|
-
GENERATOR_VERSION = "0.
|
22
|
+
GENERATOR_VERSION = "0.4.0"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20210824"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -58,6 +58,18 @@ module Google
|
|
58
58
|
include Google::Apis::Core::JsonObjectSupport
|
59
59
|
end
|
60
60
|
|
61
|
+
class CheckCompatibilityRequest
|
62
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
63
|
+
|
64
|
+
include Google::Apis::Core::JsonObjectSupport
|
65
|
+
end
|
66
|
+
|
67
|
+
class CheckCompatibilityResponse
|
68
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
69
|
+
|
70
|
+
include Google::Apis::Core::JsonObjectSupport
|
71
|
+
end
|
72
|
+
|
61
73
|
class Cohort
|
62
74
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
63
75
|
|
@@ -100,6 +112,12 @@ module Google
|
|
100
112
|
include Google::Apis::Core::JsonObjectSupport
|
101
113
|
end
|
102
114
|
|
115
|
+
class DimensionCompatibility
|
116
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
117
|
+
|
118
|
+
include Google::Apis::Core::JsonObjectSupport
|
119
|
+
end
|
120
|
+
|
103
121
|
class DimensionExpression
|
104
122
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
105
123
|
|
@@ -166,6 +184,12 @@ module Google
|
|
166
184
|
include Google::Apis::Core::JsonObjectSupport
|
167
185
|
end
|
168
186
|
|
187
|
+
class MetricCompatibility
|
188
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
189
|
+
|
190
|
+
include Google::Apis::Core::JsonObjectSupport
|
191
|
+
end
|
192
|
+
|
169
193
|
class MetricHeader
|
170
194
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
171
195
|
|
@@ -190,6 +214,12 @@ module Google
|
|
190
214
|
include Google::Apis::Core::JsonObjectSupport
|
191
215
|
end
|
192
216
|
|
217
|
+
class MinuteRange
|
218
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
219
|
+
|
220
|
+
include Google::Apis::Core::JsonObjectSupport
|
221
|
+
end
|
222
|
+
|
193
223
|
class NumericFilter
|
194
224
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
195
225
|
|
@@ -355,6 +385,31 @@ module Google
|
|
355
385
|
end
|
356
386
|
end
|
357
387
|
|
388
|
+
class CheckCompatibilityRequest
|
389
|
+
# @private
|
390
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
391
|
+
property :compatibility_filter, as: 'compatibilityFilter'
|
392
|
+
property :dimension_filter, as: 'dimensionFilter', class: Google::Apis::AnalyticsdataV1beta::FilterExpression, decorator: Google::Apis::AnalyticsdataV1beta::FilterExpression::Representation
|
393
|
+
|
394
|
+
collection :dimensions, as: 'dimensions', class: Google::Apis::AnalyticsdataV1beta::Dimension, decorator: Google::Apis::AnalyticsdataV1beta::Dimension::Representation
|
395
|
+
|
396
|
+
property :metric_filter, as: 'metricFilter', class: Google::Apis::AnalyticsdataV1beta::FilterExpression, decorator: Google::Apis::AnalyticsdataV1beta::FilterExpression::Representation
|
397
|
+
|
398
|
+
collection :metrics, as: 'metrics', class: Google::Apis::AnalyticsdataV1beta::Metric, decorator: Google::Apis::AnalyticsdataV1beta::Metric::Representation
|
399
|
+
|
400
|
+
end
|
401
|
+
end
|
402
|
+
|
403
|
+
class CheckCompatibilityResponse
|
404
|
+
# @private
|
405
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
406
|
+
collection :dimension_compatibilities, as: 'dimensionCompatibilities', class: Google::Apis::AnalyticsdataV1beta::DimensionCompatibility, decorator: Google::Apis::AnalyticsdataV1beta::DimensionCompatibility::Representation
|
407
|
+
|
408
|
+
collection :metric_compatibilities, as: 'metricCompatibilities', class: Google::Apis::AnalyticsdataV1beta::MetricCompatibility, decorator: Google::Apis::AnalyticsdataV1beta::MetricCompatibility::Representation
|
409
|
+
|
410
|
+
end
|
411
|
+
end
|
412
|
+
|
358
413
|
class Cohort
|
359
414
|
# @private
|
360
415
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -419,6 +474,15 @@ module Google
|
|
419
474
|
end
|
420
475
|
end
|
421
476
|
|
477
|
+
class DimensionCompatibility
|
478
|
+
# @private
|
479
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
480
|
+
property :compatibility, as: 'compatibility'
|
481
|
+
property :dimension_metadata, as: 'dimensionMetadata', class: Google::Apis::AnalyticsdataV1beta::DimensionMetadata, decorator: Google::Apis::AnalyticsdataV1beta::DimensionMetadata::Representation
|
482
|
+
|
483
|
+
end
|
484
|
+
end
|
485
|
+
|
422
486
|
class DimensionExpression
|
423
487
|
# @private
|
424
488
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -442,6 +506,7 @@ module Google
|
|
442
506
|
# @private
|
443
507
|
class Representation < Google::Apis::Core::JsonRepresentation
|
444
508
|
property :api_name, as: 'apiName'
|
509
|
+
property :category, as: 'category'
|
445
510
|
property :custom_definition, as: 'customDefinition'
|
446
511
|
collection :deprecated_api_names, as: 'deprecatedApiNames'
|
447
512
|
property :description, as: 'description'
|
@@ -529,6 +594,15 @@ module Google
|
|
529
594
|
end
|
530
595
|
end
|
531
596
|
|
597
|
+
class MetricCompatibility
|
598
|
+
# @private
|
599
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
600
|
+
property :compatibility, as: 'compatibility'
|
601
|
+
property :metric_metadata, as: 'metricMetadata', class: Google::Apis::AnalyticsdataV1beta::MetricMetadata, decorator: Google::Apis::AnalyticsdataV1beta::MetricMetadata::Representation
|
602
|
+
|
603
|
+
end
|
604
|
+
end
|
605
|
+
|
532
606
|
class MetricHeader
|
533
607
|
# @private
|
534
608
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -541,6 +615,7 @@ module Google
|
|
541
615
|
# @private
|
542
616
|
class Representation < Google::Apis::Core::JsonRepresentation
|
543
617
|
property :api_name, as: 'apiName'
|
618
|
+
property :category, as: 'category'
|
544
619
|
property :custom_definition, as: 'customDefinition'
|
545
620
|
collection :deprecated_api_names, as: 'deprecatedApiNames'
|
546
621
|
property :description, as: 'description'
|
@@ -564,6 +639,15 @@ module Google
|
|
564
639
|
end
|
565
640
|
end
|
566
641
|
|
642
|
+
class MinuteRange
|
643
|
+
# @private
|
644
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
645
|
+
property :end_minutes_ago, as: 'endMinutesAgo'
|
646
|
+
property :name, as: 'name'
|
647
|
+
property :start_minutes_ago, as: 'startMinutesAgo'
|
648
|
+
end
|
649
|
+
end
|
650
|
+
|
567
651
|
class NumericFilter
|
568
652
|
# @private
|
569
653
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -739,6 +823,8 @@ module Google
|
|
739
823
|
|
740
824
|
collection :metrics, as: 'metrics', class: Google::Apis::AnalyticsdataV1beta::Metric, decorator: Google::Apis::AnalyticsdataV1beta::Metric::Representation
|
741
825
|
|
826
|
+
collection :minute_ranges, as: 'minuteRanges', class: Google::Apis::AnalyticsdataV1beta::MinuteRange, decorator: Google::Apis::AnalyticsdataV1beta::MinuteRange::Representation
|
827
|
+
|
742
828
|
collection :order_bys, as: 'orderBys', class: Google::Apis::AnalyticsdataV1beta::OrderBy, decorator: Google::Apis::AnalyticsdataV1beta::OrderBy::Representation
|
743
829
|
|
744
830
|
property :return_property_quota, as: 'returnPropertyQuota'
|
@@ -127,6 +127,51 @@ module Google
|
|
127
127
|
execute_or_queue_command(command, &block)
|
128
128
|
end
|
129
129
|
|
130
|
+
# This compatibility method lists dimensions and metrics that can be added to a
|
131
|
+
# report request and maintain compatibility. This method fails if the request's
|
132
|
+
# dimensions and metrics are incompatible. In Google Analytics, reports fail if
|
133
|
+
# they request incompatible dimensions and/or metrics; in that case, you will
|
134
|
+
# need to remove dimensions and/or metrics from the incompatible report until
|
135
|
+
# the report is compatible. The Realtime and Core reports have different
|
136
|
+
# compatibility rules. This method checks compatibility for Core reports.
|
137
|
+
# @param [String] property
|
138
|
+
# A Google Analytics GA4 property identifier whose events are tracked. To learn
|
139
|
+
# more, see [where to find your Property ID](https://developers.google.com/
|
140
|
+
# analytics/devguides/reporting/data/v1/property-id). `property` should be the
|
141
|
+
# same value as in your `runReport` request. Example: properties/1234 Set the
|
142
|
+
# Property ID to 0 for compatibility checking on dimensions and metrics common
|
143
|
+
# to all properties. In this special mode, this method will not return custom
|
144
|
+
# dimensions and metrics.
|
145
|
+
# @param [Google::Apis::AnalyticsdataV1beta::CheckCompatibilityRequest] check_compatibility_request_object
|
146
|
+
# @param [String] fields
|
147
|
+
# Selector specifying which fields to include in a partial response.
|
148
|
+
# @param [String] quota_user
|
149
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
150
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
151
|
+
# @param [Google::Apis::RequestOptions] options
|
152
|
+
# Request-specific options
|
153
|
+
#
|
154
|
+
# @yield [result, err] Result & error if block supplied
|
155
|
+
# @yieldparam result [Google::Apis::AnalyticsdataV1beta::CheckCompatibilityResponse] parsed result object
|
156
|
+
# @yieldparam err [StandardError] error object if request failed
|
157
|
+
#
|
158
|
+
# @return [Google::Apis::AnalyticsdataV1beta::CheckCompatibilityResponse]
|
159
|
+
#
|
160
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
161
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
162
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
163
|
+
def check_property_compatibility(property, check_compatibility_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
164
|
+
command = make_simple_command(:post, 'v1beta/{+property}:checkCompatibility', options)
|
165
|
+
command.request_representation = Google::Apis::AnalyticsdataV1beta::CheckCompatibilityRequest::Representation
|
166
|
+
command.request_object = check_compatibility_request_object
|
167
|
+
command.response_representation = Google::Apis::AnalyticsdataV1beta::CheckCompatibilityResponse::Representation
|
168
|
+
command.response_class = Google::Apis::AnalyticsdataV1beta::CheckCompatibilityResponse
|
169
|
+
command.params['property'] = property unless property.nil?
|
170
|
+
command.query['fields'] = fields unless fields.nil?
|
171
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
172
|
+
execute_or_queue_command(command, &block)
|
173
|
+
end
|
174
|
+
|
130
175
|
# Returns metadata for dimensions and metrics available in reporting methods.
|
131
176
|
# Used to explore the dimensions and metrics. In this method, a Google Analytics
|
132
177
|
# GA4 Property Identifier is specified in the request, and the metadata response
|
metadata
CHANGED
@@ -1,29 +1,35 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-analyticsdata_v1beta
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.6.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2021-
|
11
|
+
date: 2021-08-30 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: google-apis-core
|
15
15
|
requirement: !ruby/object:Gem::Requirement
|
16
16
|
requirements:
|
17
|
-
- - "
|
17
|
+
- - ">="
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version: '0.
|
19
|
+
version: '0.4'
|
20
|
+
- - "<"
|
21
|
+
- !ruby/object:Gem::Version
|
22
|
+
version: 2.a
|
20
23
|
type: :runtime
|
21
24
|
prerelease: false
|
22
25
|
version_requirements: !ruby/object:Gem::Requirement
|
23
26
|
requirements:
|
24
|
-
- - "
|
27
|
+
- - ">="
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
version: '0.4'
|
30
|
+
- - "<"
|
25
31
|
- !ruby/object:Gem::Version
|
26
|
-
version:
|
32
|
+
version: 2.a
|
27
33
|
description: This is the simple REST client for Google Analytics Data API V1beta.
|
28
34
|
Simple REST clients are Ruby client libraries that provide access to Google services
|
29
35
|
via their HTTP REST API endpoints. These libraries are generated and updated automatically
|
@@ -52,7 +58,7 @@ licenses:
|
|
52
58
|
metadata:
|
53
59
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
54
60
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-analyticsdata_v1beta/CHANGELOG.md
|
55
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsdata_v1beta/v0.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsdata_v1beta/v0.6.0
|
56
62
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-analyticsdata_v1beta
|
57
63
|
post_install_message:
|
58
64
|
rdoc_options: []
|