google-apis-analyticsdata_v1beta 0.4.0 → 0.8.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 77de2decf607d912d4930d74eab9e27c90bbb8bfe785d30035ac4524623635c1
4
- data.tar.gz: 36366d1162bd24695ee298a9ed337eb93abf4517dde41ae841a469e9c9b589cd
3
+ metadata.gz: e1d8e66b9c480d2789d0ea8eedaf96b1ece932c1809fcdfd609d65ab2db40afc
4
+ data.tar.gz: 94b1e0463a316121cddc4fa61354212192209043fee690840a2e0cbcbcbdf00e
5
5
  SHA512:
6
- metadata.gz: d8a92b8e9271f6bb69ce4c33670b718d2f48e4135465d48d6e4c7d58232d39104638ac22de6ec7614996c3d0644add2c21fce2c5becd6d9757716fdcaff52e8f
7
- data.tar.gz: 2ce2049807bc41d5b8ba30838777eb47435dbb980f5c0ef690f2a656a3aeb4b7efae0a5cbb5a8fcb16eb681c83e12dd3b38de296306820eb37943d7856b121a9
6
+ metadata.gz: 62c25e27a04faa31edb34be3528effc63b693c603fb5e02603f14c01d058dbb4331ac2dce243e2eee8cbdc7d2bf1ed34c6415a8e178081e467be3eefca4062ce
7
+ data.tar.gz: 2d4224fbfacf219d8fe3c2662a947b757ae0fa338b466c72fac220fc92cbb38d4aab0b1fad6909552b06d95ebd4fa177d8ff57664ac30d7d93d91767804baf83
data/CHANGELOG.md CHANGED
@@ -1,5 +1,23 @@
1
1
  # Release history for google-apis-analyticsdata_v1beta
2
2
 
3
+ ### v0.8.0 (2021-10-22)
4
+
5
+ * Regenerated from discovery document revision 20211020
6
+ * Unspecified changes
7
+
8
+ ### v0.7.0 (2021-08-31)
9
+
10
+ * Regenerated from discovery document revision 20210827
11
+
12
+ ### v0.6.0 (2021-08-26)
13
+
14
+ * Regenerated from discovery document revision 20210824
15
+
16
+ ### v0.5.0 (2021-06-29)
17
+
18
+ * Regenerated from discovery document revision 20210625
19
+ * Regenerated using generator version 0.4.0
20
+
3
21
  ### v0.4.0 (2021-06-24)
4
22
 
5
23
  * Regenerated using generator version 0.3.0
data/OVERVIEW.md CHANGED
@@ -60,8 +60,8 @@ See the class reference docs for information on the methods you can call from a
60
60
 
61
61
  More detailed descriptions of the Google simple REST clients are available in two documents.
62
62
 
63
- * The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
64
- * The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
63
+ * The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/main/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
64
+ * The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/main/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
65
65
 
66
66
  (Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Analyticsdata service in particular.)
67
67
 
@@ -22,6 +22,31 @@ module Google
22
22
  module Apis
23
23
  module AnalyticsdataV1beta
24
24
 
25
+ # A metric actively restricted in creating the report.
26
+ class ActiveMetricRestriction
27
+ include Google::Apis::Core::Hashable
28
+
29
+ # The name of the restricted metric.
30
+ # Corresponds to the JSON property `metricName`
31
+ # @return [String]
32
+ attr_accessor :metric_name
33
+
34
+ # The reason for this metric's restriction.
35
+ # Corresponds to the JSON property `restrictedMetricTypes`
36
+ # @return [Array<String>]
37
+ attr_accessor :restricted_metric_types
38
+
39
+ def initialize(**args)
40
+ update!(**args)
41
+ end
42
+
43
+ # Update properties of this object
44
+ def update!(**args)
45
+ @metric_name = args[:metric_name] if args.key?(:metric_name)
46
+ @restricted_metric_types = args[:restricted_metric_types] if args.key?(:restricted_metric_types)
47
+ end
48
+ end
49
+
25
50
  # The batch request containing multiple pivot report requests.
26
51
  class BatchRunPivotReportsRequest
27
52
  include Google::Apis::Core::Hashable
@@ -161,6 +186,83 @@ module Google
161
186
  end
162
187
  end
163
188
 
189
+ # The request for compatibility information for a report's dimensions and
190
+ # metrics. Check compatibility provides a preview of the compatibility of a
191
+ # report; fields shared with the `runReport` request should be the same values
192
+ # as in your `runReport` request.
193
+ class CheckCompatibilityRequest
194
+ include Google::Apis::Core::Hashable
195
+
196
+ # Filters the dimensions and metrics in the response to just this compatibility.
197
+ # Commonly used as `”compatibilityFilter”: “COMPATIBLE”` to only return
198
+ # compatible dimensions & metrics.
199
+ # Corresponds to the JSON property `compatibilityFilter`
200
+ # @return [String]
201
+ attr_accessor :compatibility_filter
202
+
203
+ # To express dimension or metric filters. The fields in the same
204
+ # FilterExpression need to be either all dimensions or all metrics.
205
+ # Corresponds to the JSON property `dimensionFilter`
206
+ # @return [Google::Apis::AnalyticsdataV1beta::FilterExpression]
207
+ attr_accessor :dimension_filter
208
+
209
+ # The dimensions in this report. `dimensions` should be the same value as in
210
+ # your `runReport` request.
211
+ # Corresponds to the JSON property `dimensions`
212
+ # @return [Array<Google::Apis::AnalyticsdataV1beta::Dimension>]
213
+ attr_accessor :dimensions
214
+
215
+ # To express dimension or metric filters. The fields in the same
216
+ # FilterExpression need to be either all dimensions or all metrics.
217
+ # Corresponds to the JSON property `metricFilter`
218
+ # @return [Google::Apis::AnalyticsdataV1beta::FilterExpression]
219
+ attr_accessor :metric_filter
220
+
221
+ # The metrics in this report. `metrics` should be the same value as in your `
222
+ # runReport` request.
223
+ # Corresponds to the JSON property `metrics`
224
+ # @return [Array<Google::Apis::AnalyticsdataV1beta::Metric>]
225
+ attr_accessor :metrics
226
+
227
+ def initialize(**args)
228
+ update!(**args)
229
+ end
230
+
231
+ # Update properties of this object
232
+ def update!(**args)
233
+ @compatibility_filter = args[:compatibility_filter] if args.key?(:compatibility_filter)
234
+ @dimension_filter = args[:dimension_filter] if args.key?(:dimension_filter)
235
+ @dimensions = args[:dimensions] if args.key?(:dimensions)
236
+ @metric_filter = args[:metric_filter] if args.key?(:metric_filter)
237
+ @metrics = args[:metrics] if args.key?(:metrics)
238
+ end
239
+ end
240
+
241
+ # The compatibility response with the compatibility of each dimension & metric.
242
+ class CheckCompatibilityResponse
243
+ include Google::Apis::Core::Hashable
244
+
245
+ # The compatibility of each dimension.
246
+ # Corresponds to the JSON property `dimensionCompatibilities`
247
+ # @return [Array<Google::Apis::AnalyticsdataV1beta::DimensionCompatibility>]
248
+ attr_accessor :dimension_compatibilities
249
+
250
+ # The compatibility of each metric.
251
+ # Corresponds to the JSON property `metricCompatibilities`
252
+ # @return [Array<Google::Apis::AnalyticsdataV1beta::MetricCompatibility>]
253
+ attr_accessor :metric_compatibilities
254
+
255
+ def initialize(**args)
256
+ update!(**args)
257
+ end
258
+
259
+ # Update properties of this object
260
+ def update!(**args)
261
+ @dimension_compatibilities = args[:dimension_compatibilities] if args.key?(:dimension_compatibilities)
262
+ @metric_compatibilities = args[:metric_compatibilities] if args.key?(:metric_compatibilities)
263
+ end
264
+ end
265
+
164
266
  # Defines a cohort selection criteria. A cohort is a group of users who share a
165
267
  # common characteristic. For example, users with the same `firstSessionDate`
166
268
  # belong to the same cohort.
@@ -421,6 +523,32 @@ module Google
421
523
  end
422
524
  end
423
525
 
526
+ # The compatibility for a single dimension.
527
+ class DimensionCompatibility
528
+ include Google::Apis::Core::Hashable
529
+
530
+ # The compatibility of this dimension. If the compatibility is COMPATIBLE, this
531
+ # dimension can be successfully added to the report.
532
+ # Corresponds to the JSON property `compatibility`
533
+ # @return [String]
534
+ attr_accessor :compatibility
535
+
536
+ # Explains a dimension.
537
+ # Corresponds to the JSON property `dimensionMetadata`
538
+ # @return [Google::Apis::AnalyticsdataV1beta::DimensionMetadata]
539
+ attr_accessor :dimension_metadata
540
+
541
+ def initialize(**args)
542
+ update!(**args)
543
+ end
544
+
545
+ # Update properties of this object
546
+ def update!(**args)
547
+ @compatibility = args[:compatibility] if args.key?(:compatibility)
548
+ @dimension_metadata = args[:dimension_metadata] if args.key?(:dimension_metadata)
549
+ end
550
+ end
551
+
424
552
  # Used to express a dimension which is the result of a formula of multiple
425
553
  # dimensions. Example usages: 1) lower_case(dimension) 2) concatenate(dimension1,
426
554
  # symbol, dimension2).
@@ -486,6 +614,12 @@ module Google
486
614
  # @return [String]
487
615
  attr_accessor :api_name
488
616
 
617
+ # The display name of the category that this dimension belongs to. Similar
618
+ # dimensions and metrics are categorized together.
619
+ # Corresponds to the JSON property `category`
620
+ # @return [String]
621
+ attr_accessor :category
622
+
489
623
  # True if the dimension is a custom dimension for this property.
490
624
  # Corresponds to the JSON property `customDefinition`
491
625
  # @return [Boolean]
@@ -518,6 +652,7 @@ module Google
518
652
  # Update properties of this object
519
653
  def update!(**args)
520
654
  @api_name = args[:api_name] if args.key?(:api_name)
655
+ @category = args[:category] if args.key?(:category)
521
656
  @custom_definition = args[:custom_definition] if args.key?(:custom_definition)
522
657
  @deprecated_api_names = args[:deprecated_api_names] if args.key?(:deprecated_api_names)
523
658
  @description = args[:description] if args.key?(:description)
@@ -771,6 +906,32 @@ module Google
771
906
  end
772
907
  end
773
908
 
909
+ # The compatibility for a single metric.
910
+ class MetricCompatibility
911
+ include Google::Apis::Core::Hashable
912
+
913
+ # The compatibility of this metric. If the compatibility is COMPATIBLE, this
914
+ # metric can be successfully added to the report.
915
+ # Corresponds to the JSON property `compatibility`
916
+ # @return [String]
917
+ attr_accessor :compatibility
918
+
919
+ # Explains a metric.
920
+ # Corresponds to the JSON property `metricMetadata`
921
+ # @return [Google::Apis::AnalyticsdataV1beta::MetricMetadata]
922
+ attr_accessor :metric_metadata
923
+
924
+ def initialize(**args)
925
+ update!(**args)
926
+ end
927
+
928
+ # Update properties of this object
929
+ def update!(**args)
930
+ @compatibility = args[:compatibility] if args.key?(:compatibility)
931
+ @metric_metadata = args[:metric_metadata] if args.key?(:metric_metadata)
932
+ end
933
+ end
934
+
774
935
  # Describes a metric column in the report. Visible metrics requested in a report
775
936
  # produce column entries within rows and MetricHeaders. However, metrics used
776
937
  # exclusively within filters or expressions do not produce columns in a report;
@@ -809,6 +970,22 @@ module Google
809
970
  # @return [String]
810
971
  attr_accessor :api_name
811
972
 
973
+ # If reasons are specified, your access is blocked to this metric for this
974
+ # property. API requests from you to this property for this metric will succeed;
975
+ # however, the report will contain only zeros for this metric. API requests with
976
+ # metric filters on blocked metrics will fail. If reasons are empty, you have
977
+ # access to this metric. To learn more, see [Access and data-restriction
978
+ # management](https://support.google.com/analytics/answer/10851388).
979
+ # Corresponds to the JSON property `blockedReasons`
980
+ # @return [Array<String>]
981
+ attr_accessor :blocked_reasons
982
+
983
+ # The display name of the category that this metrics belongs to. Similar
984
+ # dimensions and metrics are categorized together.
985
+ # Corresponds to the JSON property `category`
986
+ # @return [String]
987
+ attr_accessor :category
988
+
812
989
  # True if the metric is a custom metric for this property.
813
990
  # Corresponds to the JSON property `customDefinition`
814
991
  # @return [Boolean]
@@ -853,6 +1030,8 @@ module Google
853
1030
  # Update properties of this object
854
1031
  def update!(**args)
855
1032
  @api_name = args[:api_name] if args.key?(:api_name)
1033
+ @blocked_reasons = args[:blocked_reasons] if args.key?(:blocked_reasons)
1034
+ @category = args[:category] if args.key?(:category)
856
1035
  @custom_definition = args[:custom_definition] if args.key?(:custom_definition)
857
1036
  @deprecated_api_names = args[:deprecated_api_names] if args.key?(:deprecated_api_names)
858
1037
  @description = args[:description] if args.key?(:description)
@@ -900,6 +1079,53 @@ module Google
900
1079
  end
901
1080
  end
902
1081
 
1082
+ # A contiguous set of minutes: startMinutesAgo, startMinutesAgo + 1, ...,
1083
+ # endMinutesAgo. Requests are allowed up to 2 minute ranges.
1084
+ class MinuteRange
1085
+ include Google::Apis::Core::Hashable
1086
+
1087
+ # The inclusive end minute for the query as a number of minutes before now.
1088
+ # Cannot be before `startMinutesAgo`. For example, `"endMinutesAgo": 15`
1089
+ # specifies the report should include event data from prior to 15 minutes ago.
1090
+ # If unspecified, `endMinutesAgo` is defaulted to 0. Standard Analytics
1091
+ # properties can request any minute in the last 30 minutes of event data (`
1092
+ # endMinutesAgo <= 29`), and 360 Analytics properties can request any minute in
1093
+ # the last 60 minutes of event data (`endMinutesAgo <= 59`).
1094
+ # Corresponds to the JSON property `endMinutesAgo`
1095
+ # @return [Fixnum]
1096
+ attr_accessor :end_minutes_ago
1097
+
1098
+ # Assigns a name to this minute range. The dimension `dateRange` is valued to
1099
+ # this name in a report response. If set, cannot begin with `date_range_` or `
1100
+ # RESERVED_`. If not set, minute ranges are named by their zero based index in
1101
+ # the request: `date_range_0`, `date_range_1`, etc.
1102
+ # Corresponds to the JSON property `name`
1103
+ # @return [String]
1104
+ attr_accessor :name
1105
+
1106
+ # The inclusive start minute for the query as a number of minutes before now.
1107
+ # For example, `"startMinutesAgo": 29` specifies the report should include event
1108
+ # data from 29 minutes ago and after. Cannot be after `endMinutesAgo`. If
1109
+ # unspecified, `startMinutesAgo` is defaulted to 29. Standard Analytics
1110
+ # properties can request up to the last 30 minutes of event data (`
1111
+ # startMinutesAgo <= 29`), and 360 Analytics properties can request up to the
1112
+ # last 60 minutes of event data (`startMinutesAgo <= 59`).
1113
+ # Corresponds to the JSON property `startMinutesAgo`
1114
+ # @return [Fixnum]
1115
+ attr_accessor :start_minutes_ago
1116
+
1117
+ def initialize(**args)
1118
+ update!(**args)
1119
+ end
1120
+
1121
+ # Update properties of this object
1122
+ def update!(**args)
1123
+ @end_minutes_ago = args[:end_minutes_ago] if args.key?(:end_minutes_ago)
1124
+ @name = args[:name] if args.key?(:name)
1125
+ @start_minutes_ago = args[:start_minutes_ago] if args.key?(:start_minutes_ago)
1126
+ end
1127
+ end
1128
+
903
1129
  # Filters for numeric or date values.
904
1130
  class NumericFilter
905
1131
  include Google::Apis::Core::Hashable
@@ -1226,6 +1452,18 @@ module Google
1226
1452
  class ResponseMetaData
1227
1453
  include Google::Apis::Core::Hashable
1228
1454
 
1455
+ # The currency code used in this report. Intended to be used in formatting
1456
+ # currency metrics like `purchaseRevenue` for visualization. If currency_code
1457
+ # was specified in the request, this response parameter will echo the request
1458
+ # parameter; otherwise, this response parameter is the property's current
1459
+ # currency_code. Currency codes are string encodings of currency types from the
1460
+ # ISO 4217 standard (https://en.wikipedia.org/wiki/ISO_4217); for example "USD",
1461
+ # "EUR", "JPY". To learn more, see https://support.google.com/analytics/answer/
1462
+ # 9796179.
1463
+ # Corresponds to the JSON property `currencyCode`
1464
+ # @return [String]
1465
+ attr_accessor :currency_code
1466
+
1229
1467
  # If true, indicates some buckets of dimension combinations are rolled into "(
1230
1468
  # other)" row. This can happen for high cardinality reports.
1231
1469
  # Corresponds to the JSON property `dataLossFromOtherRow`
@@ -1233,13 +1471,37 @@ module Google
1233
1471
  attr_accessor :data_loss_from_other_row
1234
1472
  alias_method :data_loss_from_other_row?, :data_loss_from_other_row
1235
1473
 
1474
+ # If empty reason is specified, the report is empty for this reason.
1475
+ # Corresponds to the JSON property `emptyReason`
1476
+ # @return [String]
1477
+ attr_accessor :empty_reason
1478
+
1479
+ # The schema restrictions actively enforced in creating this report. To learn
1480
+ # more, see [Access and data-restriction management](https://support.google.com/
1481
+ # analytics/answer/10851388).
1482
+ # Corresponds to the JSON property `schemaRestrictionResponse`
1483
+ # @return [Google::Apis::AnalyticsdataV1beta::SchemaRestrictionResponse]
1484
+ attr_accessor :schema_restriction_response
1485
+
1486
+ # The property's current timezone. Intended to be used to interpret time-based
1487
+ # dimensions like `hour` and `minute`. Formatted as strings from the IANA Time
1488
+ # Zone database (https://www.iana.org/time-zones); for example "America/New_York"
1489
+ # or "Asia/Tokyo".
1490
+ # Corresponds to the JSON property `timeZone`
1491
+ # @return [String]
1492
+ attr_accessor :time_zone
1493
+
1236
1494
  def initialize(**args)
1237
1495
  update!(**args)
1238
1496
  end
1239
1497
 
1240
1498
  # Update properties of this object
1241
1499
  def update!(**args)
1500
+ @currency_code = args[:currency_code] if args.key?(:currency_code)
1242
1501
  @data_loss_from_other_row = args[:data_loss_from_other_row] if args.key?(:data_loss_from_other_row)
1502
+ @empty_reason = args[:empty_reason] if args.key?(:empty_reason)
1503
+ @schema_restriction_response = args[:schema_restriction_response] if args.key?(:schema_restriction_response)
1504
+ @time_zone = args[:time_zone] if args.key?(:time_zone)
1243
1505
  end
1244
1506
  end
1245
1507
 
@@ -1507,6 +1769,15 @@ module Google
1507
1769
  # @return [Array<Google::Apis::AnalyticsdataV1beta::Metric>]
1508
1770
  attr_accessor :metrics
1509
1771
 
1772
+ # The minute ranges of event data to read. If unspecified, one minute range for
1773
+ # the last 30 minutes will be used. If multiple minute ranges are requested,
1774
+ # each response row will contain a zero based minute range index. If two minute
1775
+ # ranges overlap, the event data for the overlapping minutes is included in the
1776
+ # response rows for both minute ranges.
1777
+ # Corresponds to the JSON property `minuteRanges`
1778
+ # @return [Array<Google::Apis::AnalyticsdataV1beta::MinuteRange>]
1779
+ attr_accessor :minute_ranges
1780
+
1510
1781
  # Specifies how rows are ordered in the response.
1511
1782
  # Corresponds to the JSON property `orderBys`
1512
1783
  # @return [Array<Google::Apis::AnalyticsdataV1beta::OrderBy>]
@@ -1531,6 +1802,7 @@ module Google
1531
1802
  @metric_aggregations = args[:metric_aggregations] if args.key?(:metric_aggregations)
1532
1803
  @metric_filter = args[:metric_filter] if args.key?(:metric_filter)
1533
1804
  @metrics = args[:metrics] if args.key?(:metrics)
1805
+ @minute_ranges = args[:minute_ranges] if args.key?(:minute_ranges)
1534
1806
  @order_bys = args[:order_bys] if args.key?(:order_bys)
1535
1807
  @return_property_quota = args[:return_property_quota] if args.key?(:return_property_quota)
1536
1808
  end
@@ -1837,6 +2109,30 @@ module Google
1837
2109
  end
1838
2110
  end
1839
2111
 
2112
+ # The schema restrictions actively enforced in creating this report. To learn
2113
+ # more, see [Access and data-restriction management](https://support.google.com/
2114
+ # analytics/answer/10851388).
2115
+ class SchemaRestrictionResponse
2116
+ include Google::Apis::Core::Hashable
2117
+
2118
+ # All restrictions actively enforced in creating the report. For example, `
2119
+ # purchaseRevenue` always has the restriction type `REVENUE_DATA`. However, this
2120
+ # active response restriction is only populated if the user's custom role
2121
+ # disallows access to `REVENUE_DATA`.
2122
+ # Corresponds to the JSON property `activeMetricRestrictions`
2123
+ # @return [Array<Google::Apis::AnalyticsdataV1beta::ActiveMetricRestriction>]
2124
+ attr_accessor :active_metric_restrictions
2125
+
2126
+ def initialize(**args)
2127
+ update!(**args)
2128
+ end
2129
+
2130
+ # Update properties of this object
2131
+ def update!(**args)
2132
+ @active_metric_restrictions = args[:active_metric_restrictions] if args.key?(:active_metric_restrictions)
2133
+ end
2134
+ end
2135
+
1840
2136
  # The filter for string
1841
2137
  class StringFilter
1842
2138
  include Google::Apis::Core::Hashable
@@ -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.4.0"
19
+ GEM_VERSION = "0.8.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.3.0"
22
+ GENERATOR_VERSION = "0.4.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20210403"
25
+ REVISION = "20211020"
26
26
  end
27
27
  end
28
28
  end
@@ -22,6 +22,12 @@ module Google
22
22
  module Apis
23
23
  module AnalyticsdataV1beta
24
24
 
25
+ class ActiveMetricRestriction
26
+ class Representation < Google::Apis::Core::JsonRepresentation; end
27
+
28
+ include Google::Apis::Core::JsonObjectSupport
29
+ end
30
+
25
31
  class BatchRunPivotReportsRequest
26
32
  class Representation < Google::Apis::Core::JsonRepresentation; end
27
33
 
@@ -58,6 +64,18 @@ module Google
58
64
  include Google::Apis::Core::JsonObjectSupport
59
65
  end
60
66
 
67
+ class CheckCompatibilityRequest
68
+ class Representation < Google::Apis::Core::JsonRepresentation; end
69
+
70
+ include Google::Apis::Core::JsonObjectSupport
71
+ end
72
+
73
+ class CheckCompatibilityResponse
74
+ class Representation < Google::Apis::Core::JsonRepresentation; end
75
+
76
+ include Google::Apis::Core::JsonObjectSupport
77
+ end
78
+
61
79
  class Cohort
62
80
  class Representation < Google::Apis::Core::JsonRepresentation; end
63
81
 
@@ -100,6 +118,12 @@ module Google
100
118
  include Google::Apis::Core::JsonObjectSupport
101
119
  end
102
120
 
121
+ class DimensionCompatibility
122
+ class Representation < Google::Apis::Core::JsonRepresentation; end
123
+
124
+ include Google::Apis::Core::JsonObjectSupport
125
+ end
126
+
103
127
  class DimensionExpression
104
128
  class Representation < Google::Apis::Core::JsonRepresentation; end
105
129
 
@@ -166,6 +190,12 @@ module Google
166
190
  include Google::Apis::Core::JsonObjectSupport
167
191
  end
168
192
 
193
+ class MetricCompatibility
194
+ class Representation < Google::Apis::Core::JsonRepresentation; end
195
+
196
+ include Google::Apis::Core::JsonObjectSupport
197
+ end
198
+
169
199
  class MetricHeader
170
200
  class Representation < Google::Apis::Core::JsonRepresentation; end
171
201
 
@@ -190,6 +220,12 @@ module Google
190
220
  include Google::Apis::Core::JsonObjectSupport
191
221
  end
192
222
 
223
+ class MinuteRange
224
+ class Representation < Google::Apis::Core::JsonRepresentation; end
225
+
226
+ include Google::Apis::Core::JsonObjectSupport
227
+ end
228
+
193
229
  class NumericFilter
194
230
  class Representation < Google::Apis::Core::JsonRepresentation; end
195
231
 
@@ -298,12 +334,26 @@ module Google
298
334
  include Google::Apis::Core::JsonObjectSupport
299
335
  end
300
336
 
337
+ class SchemaRestrictionResponse
338
+ class Representation < Google::Apis::Core::JsonRepresentation; end
339
+
340
+ include Google::Apis::Core::JsonObjectSupport
341
+ end
342
+
301
343
  class StringFilter
302
344
  class Representation < Google::Apis::Core::JsonRepresentation; end
303
345
 
304
346
  include Google::Apis::Core::JsonObjectSupport
305
347
  end
306
348
 
349
+ class ActiveMetricRestriction
350
+ # @private
351
+ class Representation < Google::Apis::Core::JsonRepresentation
352
+ property :metric_name, as: 'metricName'
353
+ collection :restricted_metric_types, as: 'restrictedMetricTypes'
354
+ end
355
+ end
356
+
307
357
  class BatchRunPivotReportsRequest
308
358
  # @private
309
359
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -355,6 +405,31 @@ module Google
355
405
  end
356
406
  end
357
407
 
408
+ class CheckCompatibilityRequest
409
+ # @private
410
+ class Representation < Google::Apis::Core::JsonRepresentation
411
+ property :compatibility_filter, as: 'compatibilityFilter'
412
+ property :dimension_filter, as: 'dimensionFilter', class: Google::Apis::AnalyticsdataV1beta::FilterExpression, decorator: Google::Apis::AnalyticsdataV1beta::FilterExpression::Representation
413
+
414
+ collection :dimensions, as: 'dimensions', class: Google::Apis::AnalyticsdataV1beta::Dimension, decorator: Google::Apis::AnalyticsdataV1beta::Dimension::Representation
415
+
416
+ property :metric_filter, as: 'metricFilter', class: Google::Apis::AnalyticsdataV1beta::FilterExpression, decorator: Google::Apis::AnalyticsdataV1beta::FilterExpression::Representation
417
+
418
+ collection :metrics, as: 'metrics', class: Google::Apis::AnalyticsdataV1beta::Metric, decorator: Google::Apis::AnalyticsdataV1beta::Metric::Representation
419
+
420
+ end
421
+ end
422
+
423
+ class CheckCompatibilityResponse
424
+ # @private
425
+ class Representation < Google::Apis::Core::JsonRepresentation
426
+ collection :dimension_compatibilities, as: 'dimensionCompatibilities', class: Google::Apis::AnalyticsdataV1beta::DimensionCompatibility, decorator: Google::Apis::AnalyticsdataV1beta::DimensionCompatibility::Representation
427
+
428
+ collection :metric_compatibilities, as: 'metricCompatibilities', class: Google::Apis::AnalyticsdataV1beta::MetricCompatibility, decorator: Google::Apis::AnalyticsdataV1beta::MetricCompatibility::Representation
429
+
430
+ end
431
+ end
432
+
358
433
  class Cohort
359
434
  # @private
360
435
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -419,6 +494,15 @@ module Google
419
494
  end
420
495
  end
421
496
 
497
+ class DimensionCompatibility
498
+ # @private
499
+ class Representation < Google::Apis::Core::JsonRepresentation
500
+ property :compatibility, as: 'compatibility'
501
+ property :dimension_metadata, as: 'dimensionMetadata', class: Google::Apis::AnalyticsdataV1beta::DimensionMetadata, decorator: Google::Apis::AnalyticsdataV1beta::DimensionMetadata::Representation
502
+
503
+ end
504
+ end
505
+
422
506
  class DimensionExpression
423
507
  # @private
424
508
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -442,6 +526,7 @@ module Google
442
526
  # @private
443
527
  class Representation < Google::Apis::Core::JsonRepresentation
444
528
  property :api_name, as: 'apiName'
529
+ property :category, as: 'category'
445
530
  property :custom_definition, as: 'customDefinition'
446
531
  collection :deprecated_api_names, as: 'deprecatedApiNames'
447
532
  property :description, as: 'description'
@@ -529,6 +614,15 @@ module Google
529
614
  end
530
615
  end
531
616
 
617
+ class MetricCompatibility
618
+ # @private
619
+ class Representation < Google::Apis::Core::JsonRepresentation
620
+ property :compatibility, as: 'compatibility'
621
+ property :metric_metadata, as: 'metricMetadata', class: Google::Apis::AnalyticsdataV1beta::MetricMetadata, decorator: Google::Apis::AnalyticsdataV1beta::MetricMetadata::Representation
622
+
623
+ end
624
+ end
625
+
532
626
  class MetricHeader
533
627
  # @private
534
628
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -541,6 +635,8 @@ module Google
541
635
  # @private
542
636
  class Representation < Google::Apis::Core::JsonRepresentation
543
637
  property :api_name, as: 'apiName'
638
+ collection :blocked_reasons, as: 'blockedReasons'
639
+ property :category, as: 'category'
544
640
  property :custom_definition, as: 'customDefinition'
545
641
  collection :deprecated_api_names, as: 'deprecatedApiNames'
546
642
  property :description, as: 'description'
@@ -564,6 +660,15 @@ module Google
564
660
  end
565
661
  end
566
662
 
663
+ class MinuteRange
664
+ # @private
665
+ class Representation < Google::Apis::Core::JsonRepresentation
666
+ property :end_minutes_ago, as: 'endMinutesAgo'
667
+ property :name, as: 'name'
668
+ property :start_minutes_ago, as: 'startMinutesAgo'
669
+ end
670
+ end
671
+
567
672
  class NumericFilter
568
673
  # @private
569
674
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -667,7 +772,12 @@ module Google
667
772
  class ResponseMetaData
668
773
  # @private
669
774
  class Representation < Google::Apis::Core::JsonRepresentation
775
+ property :currency_code, as: 'currencyCode'
670
776
  property :data_loss_from_other_row, as: 'dataLossFromOtherRow'
777
+ property :empty_reason, as: 'emptyReason'
778
+ property :schema_restriction_response, as: 'schemaRestrictionResponse', class: Google::Apis::AnalyticsdataV1beta::SchemaRestrictionResponse, decorator: Google::Apis::AnalyticsdataV1beta::SchemaRestrictionResponse::Representation
779
+
780
+ property :time_zone, as: 'timeZone'
671
781
  end
672
782
  end
673
783
 
@@ -739,6 +849,8 @@ module Google
739
849
 
740
850
  collection :metrics, as: 'metrics', class: Google::Apis::AnalyticsdataV1beta::Metric, decorator: Google::Apis::AnalyticsdataV1beta::Metric::Representation
741
851
 
852
+ collection :minute_ranges, as: 'minuteRanges', class: Google::Apis::AnalyticsdataV1beta::MinuteRange, decorator: Google::Apis::AnalyticsdataV1beta::MinuteRange::Representation
853
+
742
854
  collection :order_bys, as: 'orderBys', class: Google::Apis::AnalyticsdataV1beta::OrderBy, decorator: Google::Apis::AnalyticsdataV1beta::OrderBy::Representation
743
855
 
744
856
  property :return_property_quota, as: 'returnPropertyQuota'
@@ -818,6 +930,14 @@ module Google
818
930
  end
819
931
  end
820
932
 
933
+ class SchemaRestrictionResponse
934
+ # @private
935
+ class Representation < Google::Apis::Core::JsonRepresentation
936
+ collection :active_metric_restrictions, as: 'activeMetricRestrictions', class: Google::Apis::AnalyticsdataV1beta::ActiveMetricRestriction, decorator: Google::Apis::AnalyticsdataV1beta::ActiveMetricRestriction::Representation
937
+
938
+ end
939
+ end
940
+
821
941
  class StringFilter
822
942
  # @private
823
943
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -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,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-analyticsdata_v1beta
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.0
4
+ version: 0.8.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-06-28 00:00:00.000000000 Z
11
+ date: 2021-10-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: '0.3'
19
+ version: '0.4'
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: '0.3'
29
+ version: '0.4'
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -57,9 +57,9 @@ licenses:
57
57
  - Apache-2.0
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
- changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-analyticsdata_v1beta/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsdata_v1beta/v0.4.0
62
- source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-analyticsdata_v1beta
60
+ changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-analyticsdata_v1beta/CHANGELOG.md
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsdata_v1beta/v0.8.0
62
+ source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-analyticsdata_v1beta
63
63
  post_install_message:
64
64
  rdoc_options: []
65
65
  require_paths: