google-apis-analyticsadmin_v1beta 0.3.0 → 0.4.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e5006799e9f8455a924cfb35b7a1a1e8b62b3861dd01fccd1c7f79b8e885f93b
4
- data.tar.gz: 3870f0947c96c4a7108cf2a925abd06bffc870529980094b961a3e2e4b4a1437
3
+ metadata.gz: 589b4e324dcc2ad3fb0d73d757c78f0b76a22e6caa73fb59f8ab1bb58c9f0441
4
+ data.tar.gz: c0f5d32cb049727d50c6aa113f52841929fa45ab655e85806699d1974dab0254
5
5
  SHA512:
6
- metadata.gz: 5735c2a7ec278f2a1972241f2351e4062ac4e566a94284bfe6b5129f534a48593f281a0a30ed2f490341b6fff572da401480eaface974eade73ed141cf1095ae
7
- data.tar.gz: 373842ea01d10a4aa5a04f23bcca0627fc0fbaa87aa2a443185dfe1cd14c8511f9d30782785b2079642e976b48109433ba515ce1f0b0de92292c79e2e3c7b8c4
6
+ metadata.gz: 5c67aff139cdd929b0a0c901b5450af33629200ab813c47bd6d4b726f4b0914673600284380092eaeebf76653ac1102e29c05cea7d3751f62d248334399d55fe
7
+ data.tar.gz: 0d04628c7ae7d72c61dad2e960cd00e869a33c4cb640716839ed9fda6fb8f4eaeac6337f598723716e5d37d7d56251526cfccbcfc69bc6a196db2de85b7c9dd3
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-analyticsadmin_v1beta
2
2
 
3
+ ### v0.4.0 (2023-03-26)
4
+
5
+ * Regenerated from discovery document revision 20230322
6
+
3
7
  ### v0.3.0 (2023-03-05)
4
8
 
5
9
  * Regenerated from discovery document revision 20230226
@@ -22,6 +22,552 @@ module Google
22
22
  module Apis
23
23
  module AnalyticsadminV1beta
24
24
 
25
+ # To express that the result needs to be between two numbers (inclusive).
26
+ class GoogleAnalyticsAdminV1betaAccessBetweenFilter
27
+ include Google::Apis::Core::Hashable
28
+
29
+ # To represent a number.
30
+ # Corresponds to the JSON property `fromValue`
31
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaNumericValue]
32
+ attr_accessor :from_value
33
+
34
+ # To represent a number.
35
+ # Corresponds to the JSON property `toValue`
36
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaNumericValue]
37
+ attr_accessor :to_value
38
+
39
+ def initialize(**args)
40
+ update!(**args)
41
+ end
42
+
43
+ # Update properties of this object
44
+ def update!(**args)
45
+ @from_value = args[:from_value] if args.key?(:from_value)
46
+ @to_value = args[:to_value] if args.key?(:to_value)
47
+ end
48
+ end
49
+
50
+ # A contiguous range of days: startDate, startDate + 1, ..., endDate.
51
+ class GoogleAnalyticsAdminV1betaAccessDateRange
52
+ include Google::Apis::Core::Hashable
53
+
54
+ # The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot be
55
+ # before `startDate`. The format `NdaysAgo`, `yesterday`, or `today` is also
56
+ # accepted, and in that case, the date is inferred based on the current time in
57
+ # the request's time zone.
58
+ # Corresponds to the JSON property `endDate`
59
+ # @return [String]
60
+ attr_accessor :end_date
61
+
62
+ # The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot be
63
+ # after `endDate`. The format `NdaysAgo`, `yesterday`, or `today` is also
64
+ # accepted, and in that case, the date is inferred based on the current time in
65
+ # the request's time zone.
66
+ # Corresponds to the JSON property `startDate`
67
+ # @return [String]
68
+ attr_accessor :start_date
69
+
70
+ def initialize(**args)
71
+ update!(**args)
72
+ end
73
+
74
+ # Update properties of this object
75
+ def update!(**args)
76
+ @end_date = args[:end_date] if args.key?(:end_date)
77
+ @start_date = args[:start_date] if args.key?(:start_date)
78
+ end
79
+ end
80
+
81
+ # Dimensions are attributes of your data. For example, the dimension `userEmail`
82
+ # indicates the email of the user that accessed reporting data. Dimension values
83
+ # in report responses are strings.
84
+ class GoogleAnalyticsAdminV1betaAccessDimension
85
+ include Google::Apis::Core::Hashable
86
+
87
+ # The API name of the dimension. See [Data Access Schema](https://developers.
88
+ # google.com/analytics/devguides/config/admin/v1/access-api-schema) for the list
89
+ # of dimensions supported in this API. Dimensions are referenced by name in `
90
+ # dimensionFilter` and `orderBys`.
91
+ # Corresponds to the JSON property `dimensionName`
92
+ # @return [String]
93
+ attr_accessor :dimension_name
94
+
95
+ def initialize(**args)
96
+ update!(**args)
97
+ end
98
+
99
+ # Update properties of this object
100
+ def update!(**args)
101
+ @dimension_name = args[:dimension_name] if args.key?(:dimension_name)
102
+ end
103
+ end
104
+
105
+ # Describes a dimension column in the report. Dimensions requested in a report
106
+ # produce column entries within rows and DimensionHeaders. However, dimensions
107
+ # used exclusively within filters or expressions do not produce columns in a
108
+ # report; correspondingly, those dimensions do not produce headers.
109
+ class GoogleAnalyticsAdminV1betaAccessDimensionHeader
110
+ include Google::Apis::Core::Hashable
111
+
112
+ # The dimension's name; for example 'userEmail'.
113
+ # Corresponds to the JSON property `dimensionName`
114
+ # @return [String]
115
+ attr_accessor :dimension_name
116
+
117
+ def initialize(**args)
118
+ update!(**args)
119
+ end
120
+
121
+ # Update properties of this object
122
+ def update!(**args)
123
+ @dimension_name = args[:dimension_name] if args.key?(:dimension_name)
124
+ end
125
+ end
126
+
127
+ # The value of a dimension.
128
+ class GoogleAnalyticsAdminV1betaAccessDimensionValue
129
+ include Google::Apis::Core::Hashable
130
+
131
+ # The dimension value. For example, this value may be 'France' for the 'country'
132
+ # dimension.
133
+ # Corresponds to the JSON property `value`
134
+ # @return [String]
135
+ attr_accessor :value
136
+
137
+ def initialize(**args)
138
+ update!(**args)
139
+ end
140
+
141
+ # Update properties of this object
142
+ def update!(**args)
143
+ @value = args[:value] if args.key?(:value)
144
+ end
145
+ end
146
+
147
+ # An expression to filter dimension or metric values.
148
+ class GoogleAnalyticsAdminV1betaAccessFilter
149
+ include Google::Apis::Core::Hashable
150
+
151
+ # To express that the result needs to be between two numbers (inclusive).
152
+ # Corresponds to the JSON property `betweenFilter`
153
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessBetweenFilter]
154
+ attr_accessor :between_filter
155
+
156
+ # The dimension name or metric name.
157
+ # Corresponds to the JSON property `fieldName`
158
+ # @return [String]
159
+ attr_accessor :field_name
160
+
161
+ # The result needs to be in a list of string values.
162
+ # Corresponds to the JSON property `inListFilter`
163
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessInListFilter]
164
+ attr_accessor :in_list_filter
165
+
166
+ # Filters for numeric or date values.
167
+ # Corresponds to the JSON property `numericFilter`
168
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessNumericFilter]
169
+ attr_accessor :numeric_filter
170
+
171
+ # The filter for strings.
172
+ # Corresponds to the JSON property `stringFilter`
173
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessStringFilter]
174
+ attr_accessor :string_filter
175
+
176
+ def initialize(**args)
177
+ update!(**args)
178
+ end
179
+
180
+ # Update properties of this object
181
+ def update!(**args)
182
+ @between_filter = args[:between_filter] if args.key?(:between_filter)
183
+ @field_name = args[:field_name] if args.key?(:field_name)
184
+ @in_list_filter = args[:in_list_filter] if args.key?(:in_list_filter)
185
+ @numeric_filter = args[:numeric_filter] if args.key?(:numeric_filter)
186
+ @string_filter = args[:string_filter] if args.key?(:string_filter)
187
+ end
188
+ end
189
+
190
+ # Expresses dimension or metric filters. The fields in the same expression need
191
+ # to be either all dimensions or all metrics.
192
+ class GoogleAnalyticsAdminV1betaAccessFilterExpression
193
+ include Google::Apis::Core::Hashable
194
+
195
+ # An expression to filter dimension or metric values.
196
+ # Corresponds to the JSON property `accessFilter`
197
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessFilter]
198
+ attr_accessor :access_filter
199
+
200
+ # A list of filter expressions.
201
+ # Corresponds to the JSON property `andGroup`
202
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessFilterExpressionList]
203
+ attr_accessor :and_group
204
+
205
+ # Expresses dimension or metric filters. The fields in the same expression need
206
+ # to be either all dimensions or all metrics.
207
+ # Corresponds to the JSON property `notExpression`
208
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessFilterExpression]
209
+ attr_accessor :not_expression
210
+
211
+ # A list of filter expressions.
212
+ # Corresponds to the JSON property `orGroup`
213
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessFilterExpressionList]
214
+ attr_accessor :or_group
215
+
216
+ def initialize(**args)
217
+ update!(**args)
218
+ end
219
+
220
+ # Update properties of this object
221
+ def update!(**args)
222
+ @access_filter = args[:access_filter] if args.key?(:access_filter)
223
+ @and_group = args[:and_group] if args.key?(:and_group)
224
+ @not_expression = args[:not_expression] if args.key?(:not_expression)
225
+ @or_group = args[:or_group] if args.key?(:or_group)
226
+ end
227
+ end
228
+
229
+ # A list of filter expressions.
230
+ class GoogleAnalyticsAdminV1betaAccessFilterExpressionList
231
+ include Google::Apis::Core::Hashable
232
+
233
+ # A list of filter expressions.
234
+ # Corresponds to the JSON property `expressions`
235
+ # @return [Array<Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessFilterExpression>]
236
+ attr_accessor :expressions
237
+
238
+ def initialize(**args)
239
+ update!(**args)
240
+ end
241
+
242
+ # Update properties of this object
243
+ def update!(**args)
244
+ @expressions = args[:expressions] if args.key?(:expressions)
245
+ end
246
+ end
247
+
248
+ # The result needs to be in a list of string values.
249
+ class GoogleAnalyticsAdminV1betaAccessInListFilter
250
+ include Google::Apis::Core::Hashable
251
+
252
+ # If true, the string value is case sensitive.
253
+ # Corresponds to the JSON property `caseSensitive`
254
+ # @return [Boolean]
255
+ attr_accessor :case_sensitive
256
+ alias_method :case_sensitive?, :case_sensitive
257
+
258
+ # The list of string values. Must be non-empty.
259
+ # Corresponds to the JSON property `values`
260
+ # @return [Array<String>]
261
+ attr_accessor :values
262
+
263
+ def initialize(**args)
264
+ update!(**args)
265
+ end
266
+
267
+ # Update properties of this object
268
+ def update!(**args)
269
+ @case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive)
270
+ @values = args[:values] if args.key?(:values)
271
+ end
272
+ end
273
+
274
+ # The quantitative measurements of a report. For example, the metric `
275
+ # accessCount` is the total number of data access records.
276
+ class GoogleAnalyticsAdminV1betaAccessMetric
277
+ include Google::Apis::Core::Hashable
278
+
279
+ # The API name of the metric. See [Data Access Schema](https://developers.google.
280
+ # com/analytics/devguides/config/admin/v1/access-api-schema) for the list of
281
+ # metrics supported in this API. Metrics are referenced by name in `metricFilter`
282
+ # & `orderBys`.
283
+ # Corresponds to the JSON property `metricName`
284
+ # @return [String]
285
+ attr_accessor :metric_name
286
+
287
+ def initialize(**args)
288
+ update!(**args)
289
+ end
290
+
291
+ # Update properties of this object
292
+ def update!(**args)
293
+ @metric_name = args[:metric_name] if args.key?(:metric_name)
294
+ end
295
+ end
296
+
297
+ # Describes a metric column in the report. Visible metrics requested in a report
298
+ # produce column entries within rows and MetricHeaders. However, metrics used
299
+ # exclusively within filters or expressions do not produce columns in a report;
300
+ # correspondingly, those metrics do not produce headers.
301
+ class GoogleAnalyticsAdminV1betaAccessMetricHeader
302
+ include Google::Apis::Core::Hashable
303
+
304
+ # The metric's name; for example 'accessCount'.
305
+ # Corresponds to the JSON property `metricName`
306
+ # @return [String]
307
+ attr_accessor :metric_name
308
+
309
+ def initialize(**args)
310
+ update!(**args)
311
+ end
312
+
313
+ # Update properties of this object
314
+ def update!(**args)
315
+ @metric_name = args[:metric_name] if args.key?(:metric_name)
316
+ end
317
+ end
318
+
319
+ # The value of a metric.
320
+ class GoogleAnalyticsAdminV1betaAccessMetricValue
321
+ include Google::Apis::Core::Hashable
322
+
323
+ # The measurement value. For example, this value may be '13'.
324
+ # Corresponds to the JSON property `value`
325
+ # @return [String]
326
+ attr_accessor :value
327
+
328
+ def initialize(**args)
329
+ update!(**args)
330
+ end
331
+
332
+ # Update properties of this object
333
+ def update!(**args)
334
+ @value = args[:value] if args.key?(:value)
335
+ end
336
+ end
337
+
338
+ # Filters for numeric or date values.
339
+ class GoogleAnalyticsAdminV1betaAccessNumericFilter
340
+ include Google::Apis::Core::Hashable
341
+
342
+ # The operation type for this filter.
343
+ # Corresponds to the JSON property `operation`
344
+ # @return [String]
345
+ attr_accessor :operation
346
+
347
+ # To represent a number.
348
+ # Corresponds to the JSON property `value`
349
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaNumericValue]
350
+ attr_accessor :value
351
+
352
+ def initialize(**args)
353
+ update!(**args)
354
+ end
355
+
356
+ # Update properties of this object
357
+ def update!(**args)
358
+ @operation = args[:operation] if args.key?(:operation)
359
+ @value = args[:value] if args.key?(:value)
360
+ end
361
+ end
362
+
363
+ # Order bys define how rows will be sorted in the response. For example,
364
+ # ordering rows by descending access count is one ordering, and ordering rows by
365
+ # the country string is a different ordering.
366
+ class GoogleAnalyticsAdminV1betaAccessOrderBy
367
+ include Google::Apis::Core::Hashable
368
+
369
+ # If true, sorts by descending order. If false or unspecified, sorts in
370
+ # ascending order.
371
+ # Corresponds to the JSON property `desc`
372
+ # @return [Boolean]
373
+ attr_accessor :desc
374
+ alias_method :desc?, :desc
375
+
376
+ # Sorts by dimension values.
377
+ # Corresponds to the JSON property `dimension`
378
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessOrderByDimensionOrderBy]
379
+ attr_accessor :dimension
380
+
381
+ # Sorts by metric values.
382
+ # Corresponds to the JSON property `metric`
383
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessOrderByMetricOrderBy]
384
+ attr_accessor :metric
385
+
386
+ def initialize(**args)
387
+ update!(**args)
388
+ end
389
+
390
+ # Update properties of this object
391
+ def update!(**args)
392
+ @desc = args[:desc] if args.key?(:desc)
393
+ @dimension = args[:dimension] if args.key?(:dimension)
394
+ @metric = args[:metric] if args.key?(:metric)
395
+ end
396
+ end
397
+
398
+ # Sorts by dimension values.
399
+ class GoogleAnalyticsAdminV1betaAccessOrderByDimensionOrderBy
400
+ include Google::Apis::Core::Hashable
401
+
402
+ # A dimension name in the request to order by.
403
+ # Corresponds to the JSON property `dimensionName`
404
+ # @return [String]
405
+ attr_accessor :dimension_name
406
+
407
+ # Controls the rule for dimension value ordering.
408
+ # Corresponds to the JSON property `orderType`
409
+ # @return [String]
410
+ attr_accessor :order_type
411
+
412
+ def initialize(**args)
413
+ update!(**args)
414
+ end
415
+
416
+ # Update properties of this object
417
+ def update!(**args)
418
+ @dimension_name = args[:dimension_name] if args.key?(:dimension_name)
419
+ @order_type = args[:order_type] if args.key?(:order_type)
420
+ end
421
+ end
422
+
423
+ # Sorts by metric values.
424
+ class GoogleAnalyticsAdminV1betaAccessOrderByMetricOrderBy
425
+ include Google::Apis::Core::Hashable
426
+
427
+ # A metric name in the request to order by.
428
+ # Corresponds to the JSON property `metricName`
429
+ # @return [String]
430
+ attr_accessor :metric_name
431
+
432
+ def initialize(**args)
433
+ update!(**args)
434
+ end
435
+
436
+ # Update properties of this object
437
+ def update!(**args)
438
+ @metric_name = args[:metric_name] if args.key?(:metric_name)
439
+ end
440
+ end
441
+
442
+ # Current state of all quotas for this Analytics property. If any quota for a
443
+ # property is exhausted, all requests to that property will return Resource
444
+ # Exhausted errors.
445
+ class GoogleAnalyticsAdminV1betaAccessQuota
446
+ include Google::Apis::Core::Hashable
447
+
448
+ # Current state for a particular quota group.
449
+ # Corresponds to the JSON property `concurrentRequests`
450
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessQuotaStatus]
451
+ attr_accessor :concurrent_requests
452
+
453
+ # Current state for a particular quota group.
454
+ # Corresponds to the JSON property `serverErrorsPerProjectPerHour`
455
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessQuotaStatus]
456
+ attr_accessor :server_errors_per_project_per_hour
457
+
458
+ # Current state for a particular quota group.
459
+ # Corresponds to the JSON property `tokensPerDay`
460
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessQuotaStatus]
461
+ attr_accessor :tokens_per_day
462
+
463
+ # Current state for a particular quota group.
464
+ # Corresponds to the JSON property `tokensPerHour`
465
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessQuotaStatus]
466
+ attr_accessor :tokens_per_hour
467
+
468
+ # Current state for a particular quota group.
469
+ # Corresponds to the JSON property `tokensPerProjectPerHour`
470
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessQuotaStatus]
471
+ attr_accessor :tokens_per_project_per_hour
472
+
473
+ def initialize(**args)
474
+ update!(**args)
475
+ end
476
+
477
+ # Update properties of this object
478
+ def update!(**args)
479
+ @concurrent_requests = args[:concurrent_requests] if args.key?(:concurrent_requests)
480
+ @server_errors_per_project_per_hour = args[:server_errors_per_project_per_hour] if args.key?(:server_errors_per_project_per_hour)
481
+ @tokens_per_day = args[:tokens_per_day] if args.key?(:tokens_per_day)
482
+ @tokens_per_hour = args[:tokens_per_hour] if args.key?(:tokens_per_hour)
483
+ @tokens_per_project_per_hour = args[:tokens_per_project_per_hour] if args.key?(:tokens_per_project_per_hour)
484
+ end
485
+ end
486
+
487
+ # Current state for a particular quota group.
488
+ class GoogleAnalyticsAdminV1betaAccessQuotaStatus
489
+ include Google::Apis::Core::Hashable
490
+
491
+ # Quota consumed by this request.
492
+ # Corresponds to the JSON property `consumed`
493
+ # @return [Fixnum]
494
+ attr_accessor :consumed
495
+
496
+ # Quota remaining after this request.
497
+ # Corresponds to the JSON property `remaining`
498
+ # @return [Fixnum]
499
+ attr_accessor :remaining
500
+
501
+ def initialize(**args)
502
+ update!(**args)
503
+ end
504
+
505
+ # Update properties of this object
506
+ def update!(**args)
507
+ @consumed = args[:consumed] if args.key?(:consumed)
508
+ @remaining = args[:remaining] if args.key?(:remaining)
509
+ end
510
+ end
511
+
512
+ # Access report data for each row.
513
+ class GoogleAnalyticsAdminV1betaAccessRow
514
+ include Google::Apis::Core::Hashable
515
+
516
+ # List of dimension values. These values are in the same order as specified in
517
+ # the request.
518
+ # Corresponds to the JSON property `dimensionValues`
519
+ # @return [Array<Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessDimensionValue>]
520
+ attr_accessor :dimension_values
521
+
522
+ # List of metric values. These values are in the same order as specified in the
523
+ # request.
524
+ # Corresponds to the JSON property `metricValues`
525
+ # @return [Array<Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessMetricValue>]
526
+ attr_accessor :metric_values
527
+
528
+ def initialize(**args)
529
+ update!(**args)
530
+ end
531
+
532
+ # Update properties of this object
533
+ def update!(**args)
534
+ @dimension_values = args[:dimension_values] if args.key?(:dimension_values)
535
+ @metric_values = args[:metric_values] if args.key?(:metric_values)
536
+ end
537
+ end
538
+
539
+ # The filter for strings.
540
+ class GoogleAnalyticsAdminV1betaAccessStringFilter
541
+ include Google::Apis::Core::Hashable
542
+
543
+ # If true, the string value is case sensitive.
544
+ # Corresponds to the JSON property `caseSensitive`
545
+ # @return [Boolean]
546
+ attr_accessor :case_sensitive
547
+ alias_method :case_sensitive?, :case_sensitive
548
+
549
+ # The match type for this filter.
550
+ # Corresponds to the JSON property `matchType`
551
+ # @return [String]
552
+ attr_accessor :match_type
553
+
554
+ # The string value used for the matching.
555
+ # Corresponds to the JSON property `value`
556
+ # @return [String]
557
+ attr_accessor :value
558
+
559
+ def initialize(**args)
560
+ update!(**args)
561
+ end
562
+
563
+ # Update properties of this object
564
+ def update!(**args)
565
+ @case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive)
566
+ @match_type = args[:match_type] if args.key?(:match_type)
567
+ @value = args[:value] if args.key?(:value)
568
+ end
569
+ end
570
+
25
571
  # A resource message representing a Google Analytics account.
26
572
  class GoogleAnalyticsAdminV1betaAccount
27
573
  include Google::Apis::Core::Hashable
@@ -1151,6 +1697,31 @@ module Google
1151
1697
  end
1152
1698
  end
1153
1699
 
1700
+ # To represent a number.
1701
+ class GoogleAnalyticsAdminV1betaNumericValue
1702
+ include Google::Apis::Core::Hashable
1703
+
1704
+ # Double value
1705
+ # Corresponds to the JSON property `doubleValue`
1706
+ # @return [Float]
1707
+ attr_accessor :double_value
1708
+
1709
+ # Integer value
1710
+ # Corresponds to the JSON property `int64Value`
1711
+ # @return [Fixnum]
1712
+ attr_accessor :int64_value
1713
+
1714
+ def initialize(**args)
1715
+ update!(**args)
1716
+ end
1717
+
1718
+ # Update properties of this object
1719
+ def update!(**args)
1720
+ @double_value = args[:double_value] if args.key?(:double_value)
1721
+ @int64_value = args[:int64_value] if args.key?(:int64_value)
1722
+ end
1723
+ end
1724
+
1154
1725
  # A resource message representing a Google Analytics GA4 property.
1155
1726
  class GoogleAnalyticsAdminV1betaProperty
1156
1727
  include Google::Apis::Core::Hashable
@@ -1343,6 +1914,160 @@ module Google
1343
1914
  end
1344
1915
  end
1345
1916
 
1917
+ # The request for a Data Access Record Report.
1918
+ class GoogleAnalyticsAdminV1betaRunAccessReportRequest
1919
+ include Google::Apis::Core::Hashable
1920
+
1921
+ # Date ranges of access records to read. If multiple date ranges are requested,
1922
+ # each response row will contain a zero based date range index. If two date
1923
+ # ranges overlap, the access records for the overlapping days is included in the
1924
+ # response rows for both date ranges. Requests are allowed up to 2 date ranges.
1925
+ # Corresponds to the JSON property `dateRanges`
1926
+ # @return [Array<Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessDateRange>]
1927
+ attr_accessor :date_ranges
1928
+
1929
+ # Expresses dimension or metric filters. The fields in the same expression need
1930
+ # to be either all dimensions or all metrics.
1931
+ # Corresponds to the JSON property `dimensionFilter`
1932
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessFilterExpression]
1933
+ attr_accessor :dimension_filter
1934
+
1935
+ # The dimensions requested and displayed in the response. Requests are allowed
1936
+ # up to 9 dimensions.
1937
+ # Corresponds to the JSON property `dimensions`
1938
+ # @return [Array<Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessDimension>]
1939
+ attr_accessor :dimensions
1940
+
1941
+ # The number of rows to return. If unspecified, 10,000 rows are returned. The
1942
+ # API returns a maximum of 100,000 rows per request, no matter how many you ask
1943
+ # for. `limit` must be positive. The API may return fewer rows than the
1944
+ # requested `limit`, if there aren't as many remaining rows as the `limit`. For
1945
+ # instance, there are fewer than 300 possible values for the dimension `country`,
1946
+ # so when reporting on only `country`, you can't get more than 300 rows, even
1947
+ # if you set `limit` to a higher value. To learn more about this pagination
1948
+ # parameter, see [Pagination](https://developers.google.com/analytics/devguides/
1949
+ # reporting/data/v1/basics#pagination).
1950
+ # Corresponds to the JSON property `limit`
1951
+ # @return [Fixnum]
1952
+ attr_accessor :limit
1953
+
1954
+ # Expresses dimension or metric filters. The fields in the same expression need
1955
+ # to be either all dimensions or all metrics.
1956
+ # Corresponds to the JSON property `metricFilter`
1957
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessFilterExpression]
1958
+ attr_accessor :metric_filter
1959
+
1960
+ # The metrics requested and displayed in the response. Requests are allowed up
1961
+ # to 10 metrics.
1962
+ # Corresponds to the JSON property `metrics`
1963
+ # @return [Array<Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessMetric>]
1964
+ attr_accessor :metrics
1965
+
1966
+ # The row count of the start row. The first row is counted as row 0. If offset
1967
+ # is unspecified, it is treated as 0. If offset is zero, then this method will
1968
+ # return the first page of results with `limit` entries. To learn more about
1969
+ # this pagination parameter, see [Pagination](https://developers.google.com/
1970
+ # analytics/devguides/reporting/data/v1/basics#pagination).
1971
+ # Corresponds to the JSON property `offset`
1972
+ # @return [Fixnum]
1973
+ attr_accessor :offset
1974
+
1975
+ # Specifies how rows are ordered in the response.
1976
+ # Corresponds to the JSON property `orderBys`
1977
+ # @return [Array<Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessOrderBy>]
1978
+ attr_accessor :order_bys
1979
+
1980
+ # Toggles whether to return the current state of this Analytics Property's quota.
1981
+ # Quota is returned in [AccessQuota](#AccessQuota). For account-level requests,
1982
+ # this field must be false.
1983
+ # Corresponds to the JSON property `returnEntityQuota`
1984
+ # @return [Boolean]
1985
+ attr_accessor :return_entity_quota
1986
+ alias_method :return_entity_quota?, :return_entity_quota
1987
+
1988
+ # This request's time zone if specified. If unspecified, the property's time
1989
+ # zone is used. The request's time zone is used to interpret the start & end
1990
+ # dates of the report. Formatted as strings from the IANA Time Zone database (
1991
+ # https://www.iana.org/time-zones); for example "America/New_York" or "Asia/
1992
+ # Tokyo".
1993
+ # Corresponds to the JSON property `timeZone`
1994
+ # @return [String]
1995
+ attr_accessor :time_zone
1996
+
1997
+ def initialize(**args)
1998
+ update!(**args)
1999
+ end
2000
+
2001
+ # Update properties of this object
2002
+ def update!(**args)
2003
+ @date_ranges = args[:date_ranges] if args.key?(:date_ranges)
2004
+ @dimension_filter = args[:dimension_filter] if args.key?(:dimension_filter)
2005
+ @dimensions = args[:dimensions] if args.key?(:dimensions)
2006
+ @limit = args[:limit] if args.key?(:limit)
2007
+ @metric_filter = args[:metric_filter] if args.key?(:metric_filter)
2008
+ @metrics = args[:metrics] if args.key?(:metrics)
2009
+ @offset = args[:offset] if args.key?(:offset)
2010
+ @order_bys = args[:order_bys] if args.key?(:order_bys)
2011
+ @return_entity_quota = args[:return_entity_quota] if args.key?(:return_entity_quota)
2012
+ @time_zone = args[:time_zone] if args.key?(:time_zone)
2013
+ end
2014
+ end
2015
+
2016
+ # The customized Data Access Record Report response.
2017
+ class GoogleAnalyticsAdminV1betaRunAccessReportResponse
2018
+ include Google::Apis::Core::Hashable
2019
+
2020
+ # The header for a column in the report that corresponds to a specific dimension.
2021
+ # The number of DimensionHeaders and ordering of DimensionHeaders matches the
2022
+ # dimensions present in rows.
2023
+ # Corresponds to the JSON property `dimensionHeaders`
2024
+ # @return [Array<Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessDimensionHeader>]
2025
+ attr_accessor :dimension_headers
2026
+
2027
+ # The header for a column in the report that corresponds to a specific metric.
2028
+ # The number of MetricHeaders and ordering of MetricHeaders matches the metrics
2029
+ # present in rows.
2030
+ # Corresponds to the JSON property `metricHeaders`
2031
+ # @return [Array<Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessMetricHeader>]
2032
+ attr_accessor :metric_headers
2033
+
2034
+ # Current state of all quotas for this Analytics property. If any quota for a
2035
+ # property is exhausted, all requests to that property will return Resource
2036
+ # Exhausted errors.
2037
+ # Corresponds to the JSON property `quota`
2038
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessQuota]
2039
+ attr_accessor :quota
2040
+
2041
+ # The total number of rows in the query result. `rowCount` is independent of the
2042
+ # number of rows returned in the response, the `limit` request parameter, and
2043
+ # the `offset` request parameter. For example if a query returns 175 rows and
2044
+ # includes `limit` of 50 in the API request, the response will contain `rowCount`
2045
+ # of 175 but only 50 rows. To learn more about this pagination parameter, see [
2046
+ # Pagination](https://developers.google.com/analytics/devguides/reporting/data/
2047
+ # v1/basics#pagination).
2048
+ # Corresponds to the JSON property `rowCount`
2049
+ # @return [Fixnum]
2050
+ attr_accessor :row_count
2051
+
2052
+ # Rows of dimension value combinations and metric values in the report.
2053
+ # Corresponds to the JSON property `rows`
2054
+ # @return [Array<Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessRow>]
2055
+ attr_accessor :rows
2056
+
2057
+ def initialize(**args)
2058
+ update!(**args)
2059
+ end
2060
+
2061
+ # Update properties of this object
2062
+ def update!(**args)
2063
+ @dimension_headers = args[:dimension_headers] if args.key?(:dimension_headers)
2064
+ @metric_headers = args[:metric_headers] if args.key?(:metric_headers)
2065
+ @quota = args[:quota] if args.key?(:quota)
2066
+ @row_count = args[:row_count] if args.key?(:row_count)
2067
+ @rows = args[:rows] if args.key?(:rows)
2068
+ end
2069
+ end
2070
+
1346
2071
  # Request message for SearchChangeHistoryEvents RPC.
1347
2072
  class GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsRequest
1348
2073
  include Google::Apis::Core::Hashable
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module AnalyticsadminV1beta
18
18
  # Version of the google-apis-analyticsadmin_v1beta gem
19
- GEM_VERSION = "0.3.0"
19
+ GEM_VERSION = "0.4.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.12.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20230226"
25
+ REVISION = "20230322"
26
26
  end
27
27
  end
28
28
  end
@@ -22,6 +22,126 @@ module Google
22
22
  module Apis
23
23
  module AnalyticsadminV1beta
24
24
 
25
+ class GoogleAnalyticsAdminV1betaAccessBetweenFilter
26
+ class Representation < Google::Apis::Core::JsonRepresentation; end
27
+
28
+ include Google::Apis::Core::JsonObjectSupport
29
+ end
30
+
31
+ class GoogleAnalyticsAdminV1betaAccessDateRange
32
+ class Representation < Google::Apis::Core::JsonRepresentation; end
33
+
34
+ include Google::Apis::Core::JsonObjectSupport
35
+ end
36
+
37
+ class GoogleAnalyticsAdminV1betaAccessDimension
38
+ class Representation < Google::Apis::Core::JsonRepresentation; end
39
+
40
+ include Google::Apis::Core::JsonObjectSupport
41
+ end
42
+
43
+ class GoogleAnalyticsAdminV1betaAccessDimensionHeader
44
+ class Representation < Google::Apis::Core::JsonRepresentation; end
45
+
46
+ include Google::Apis::Core::JsonObjectSupport
47
+ end
48
+
49
+ class GoogleAnalyticsAdminV1betaAccessDimensionValue
50
+ class Representation < Google::Apis::Core::JsonRepresentation; end
51
+
52
+ include Google::Apis::Core::JsonObjectSupport
53
+ end
54
+
55
+ class GoogleAnalyticsAdminV1betaAccessFilter
56
+ class Representation < Google::Apis::Core::JsonRepresentation; end
57
+
58
+ include Google::Apis::Core::JsonObjectSupport
59
+ end
60
+
61
+ class GoogleAnalyticsAdminV1betaAccessFilterExpression
62
+ class Representation < Google::Apis::Core::JsonRepresentation; end
63
+
64
+ include Google::Apis::Core::JsonObjectSupport
65
+ end
66
+
67
+ class GoogleAnalyticsAdminV1betaAccessFilterExpressionList
68
+ class Representation < Google::Apis::Core::JsonRepresentation; end
69
+
70
+ include Google::Apis::Core::JsonObjectSupport
71
+ end
72
+
73
+ class GoogleAnalyticsAdminV1betaAccessInListFilter
74
+ class Representation < Google::Apis::Core::JsonRepresentation; end
75
+
76
+ include Google::Apis::Core::JsonObjectSupport
77
+ end
78
+
79
+ class GoogleAnalyticsAdminV1betaAccessMetric
80
+ class Representation < Google::Apis::Core::JsonRepresentation; end
81
+
82
+ include Google::Apis::Core::JsonObjectSupport
83
+ end
84
+
85
+ class GoogleAnalyticsAdminV1betaAccessMetricHeader
86
+ class Representation < Google::Apis::Core::JsonRepresentation; end
87
+
88
+ include Google::Apis::Core::JsonObjectSupport
89
+ end
90
+
91
+ class GoogleAnalyticsAdminV1betaAccessMetricValue
92
+ class Representation < Google::Apis::Core::JsonRepresentation; end
93
+
94
+ include Google::Apis::Core::JsonObjectSupport
95
+ end
96
+
97
+ class GoogleAnalyticsAdminV1betaAccessNumericFilter
98
+ class Representation < Google::Apis::Core::JsonRepresentation; end
99
+
100
+ include Google::Apis::Core::JsonObjectSupport
101
+ end
102
+
103
+ class GoogleAnalyticsAdminV1betaAccessOrderBy
104
+ class Representation < Google::Apis::Core::JsonRepresentation; end
105
+
106
+ include Google::Apis::Core::JsonObjectSupport
107
+ end
108
+
109
+ class GoogleAnalyticsAdminV1betaAccessOrderByDimensionOrderBy
110
+ class Representation < Google::Apis::Core::JsonRepresentation; end
111
+
112
+ include Google::Apis::Core::JsonObjectSupport
113
+ end
114
+
115
+ class GoogleAnalyticsAdminV1betaAccessOrderByMetricOrderBy
116
+ class Representation < Google::Apis::Core::JsonRepresentation; end
117
+
118
+ include Google::Apis::Core::JsonObjectSupport
119
+ end
120
+
121
+ class GoogleAnalyticsAdminV1betaAccessQuota
122
+ class Representation < Google::Apis::Core::JsonRepresentation; end
123
+
124
+ include Google::Apis::Core::JsonObjectSupport
125
+ end
126
+
127
+ class GoogleAnalyticsAdminV1betaAccessQuotaStatus
128
+ class Representation < Google::Apis::Core::JsonRepresentation; end
129
+
130
+ include Google::Apis::Core::JsonObjectSupport
131
+ end
132
+
133
+ class GoogleAnalyticsAdminV1betaAccessRow
134
+ class Representation < Google::Apis::Core::JsonRepresentation; end
135
+
136
+ include Google::Apis::Core::JsonObjectSupport
137
+ end
138
+
139
+ class GoogleAnalyticsAdminV1betaAccessStringFilter
140
+ class Representation < Google::Apis::Core::JsonRepresentation; end
141
+
142
+ include Google::Apis::Core::JsonObjectSupport
143
+ end
144
+
25
145
  class GoogleAnalyticsAdminV1betaAccount
26
146
  class Representation < Google::Apis::Core::JsonRepresentation; end
27
147
 
@@ -208,6 +328,12 @@ module Google
208
328
  include Google::Apis::Core::JsonObjectSupport
209
329
  end
210
330
 
331
+ class GoogleAnalyticsAdminV1betaNumericValue
332
+ class Representation < Google::Apis::Core::JsonRepresentation; end
333
+
334
+ include Google::Apis::Core::JsonObjectSupport
335
+ end
336
+
211
337
  class GoogleAnalyticsAdminV1betaProperty
212
338
  class Representation < Google::Apis::Core::JsonRepresentation; end
213
339
 
@@ -232,6 +358,18 @@ module Google
232
358
  include Google::Apis::Core::JsonObjectSupport
233
359
  end
234
360
 
361
+ class GoogleAnalyticsAdminV1betaRunAccessReportRequest
362
+ class Representation < Google::Apis::Core::JsonRepresentation; end
363
+
364
+ include Google::Apis::Core::JsonObjectSupport
365
+ end
366
+
367
+ class GoogleAnalyticsAdminV1betaRunAccessReportResponse
368
+ class Representation < Google::Apis::Core::JsonRepresentation; end
369
+
370
+ include Google::Apis::Core::JsonObjectSupport
371
+ end
372
+
235
373
  class GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsRequest
236
374
  class Representation < Google::Apis::Core::JsonRepresentation; end
237
375
 
@@ -250,6 +388,189 @@ module Google
250
388
  include Google::Apis::Core::JsonObjectSupport
251
389
  end
252
390
 
391
+ class GoogleAnalyticsAdminV1betaAccessBetweenFilter
392
+ # @private
393
+ class Representation < Google::Apis::Core::JsonRepresentation
394
+ property :from_value, as: 'fromValue', class: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaNumericValue, decorator: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaNumericValue::Representation
395
+
396
+ property :to_value, as: 'toValue', class: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaNumericValue, decorator: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaNumericValue::Representation
397
+
398
+ end
399
+ end
400
+
401
+ class GoogleAnalyticsAdminV1betaAccessDateRange
402
+ # @private
403
+ class Representation < Google::Apis::Core::JsonRepresentation
404
+ property :end_date, as: 'endDate'
405
+ property :start_date, as: 'startDate'
406
+ end
407
+ end
408
+
409
+ class GoogleAnalyticsAdminV1betaAccessDimension
410
+ # @private
411
+ class Representation < Google::Apis::Core::JsonRepresentation
412
+ property :dimension_name, as: 'dimensionName'
413
+ end
414
+ end
415
+
416
+ class GoogleAnalyticsAdminV1betaAccessDimensionHeader
417
+ # @private
418
+ class Representation < Google::Apis::Core::JsonRepresentation
419
+ property :dimension_name, as: 'dimensionName'
420
+ end
421
+ end
422
+
423
+ class GoogleAnalyticsAdminV1betaAccessDimensionValue
424
+ # @private
425
+ class Representation < Google::Apis::Core::JsonRepresentation
426
+ property :value, as: 'value'
427
+ end
428
+ end
429
+
430
+ class GoogleAnalyticsAdminV1betaAccessFilter
431
+ # @private
432
+ class Representation < Google::Apis::Core::JsonRepresentation
433
+ property :between_filter, as: 'betweenFilter', class: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessBetweenFilter, decorator: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessBetweenFilter::Representation
434
+
435
+ property :field_name, as: 'fieldName'
436
+ property :in_list_filter, as: 'inListFilter', class: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessInListFilter, decorator: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessInListFilter::Representation
437
+
438
+ property :numeric_filter, as: 'numericFilter', class: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessNumericFilter, decorator: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessNumericFilter::Representation
439
+
440
+ property :string_filter, as: 'stringFilter', class: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessStringFilter, decorator: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessStringFilter::Representation
441
+
442
+ end
443
+ end
444
+
445
+ class GoogleAnalyticsAdminV1betaAccessFilterExpression
446
+ # @private
447
+ class Representation < Google::Apis::Core::JsonRepresentation
448
+ property :access_filter, as: 'accessFilter', class: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessFilter, decorator: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessFilter::Representation
449
+
450
+ property :and_group, as: 'andGroup', class: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessFilterExpressionList, decorator: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessFilterExpressionList::Representation
451
+
452
+ property :not_expression, as: 'notExpression', class: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessFilterExpression, decorator: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessFilterExpression::Representation
453
+
454
+ property :or_group, as: 'orGroup', class: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessFilterExpressionList, decorator: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessFilterExpressionList::Representation
455
+
456
+ end
457
+ end
458
+
459
+ class GoogleAnalyticsAdminV1betaAccessFilterExpressionList
460
+ # @private
461
+ class Representation < Google::Apis::Core::JsonRepresentation
462
+ collection :expressions, as: 'expressions', class: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessFilterExpression, decorator: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessFilterExpression::Representation
463
+
464
+ end
465
+ end
466
+
467
+ class GoogleAnalyticsAdminV1betaAccessInListFilter
468
+ # @private
469
+ class Representation < Google::Apis::Core::JsonRepresentation
470
+ property :case_sensitive, as: 'caseSensitive'
471
+ collection :values, as: 'values'
472
+ end
473
+ end
474
+
475
+ class GoogleAnalyticsAdminV1betaAccessMetric
476
+ # @private
477
+ class Representation < Google::Apis::Core::JsonRepresentation
478
+ property :metric_name, as: 'metricName'
479
+ end
480
+ end
481
+
482
+ class GoogleAnalyticsAdminV1betaAccessMetricHeader
483
+ # @private
484
+ class Representation < Google::Apis::Core::JsonRepresentation
485
+ property :metric_name, as: 'metricName'
486
+ end
487
+ end
488
+
489
+ class GoogleAnalyticsAdminV1betaAccessMetricValue
490
+ # @private
491
+ class Representation < Google::Apis::Core::JsonRepresentation
492
+ property :value, as: 'value'
493
+ end
494
+ end
495
+
496
+ class GoogleAnalyticsAdminV1betaAccessNumericFilter
497
+ # @private
498
+ class Representation < Google::Apis::Core::JsonRepresentation
499
+ property :operation, as: 'operation'
500
+ property :value, as: 'value', class: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaNumericValue, decorator: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaNumericValue::Representation
501
+
502
+ end
503
+ end
504
+
505
+ class GoogleAnalyticsAdminV1betaAccessOrderBy
506
+ # @private
507
+ class Representation < Google::Apis::Core::JsonRepresentation
508
+ property :desc, as: 'desc'
509
+ property :dimension, as: 'dimension', class: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessOrderByDimensionOrderBy, decorator: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessOrderByDimensionOrderBy::Representation
510
+
511
+ property :metric, as: 'metric', class: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessOrderByMetricOrderBy, decorator: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessOrderByMetricOrderBy::Representation
512
+
513
+ end
514
+ end
515
+
516
+ class GoogleAnalyticsAdminV1betaAccessOrderByDimensionOrderBy
517
+ # @private
518
+ class Representation < Google::Apis::Core::JsonRepresentation
519
+ property :dimension_name, as: 'dimensionName'
520
+ property :order_type, as: 'orderType'
521
+ end
522
+ end
523
+
524
+ class GoogleAnalyticsAdminV1betaAccessOrderByMetricOrderBy
525
+ # @private
526
+ class Representation < Google::Apis::Core::JsonRepresentation
527
+ property :metric_name, as: 'metricName'
528
+ end
529
+ end
530
+
531
+ class GoogleAnalyticsAdminV1betaAccessQuota
532
+ # @private
533
+ class Representation < Google::Apis::Core::JsonRepresentation
534
+ property :concurrent_requests, as: 'concurrentRequests', class: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessQuotaStatus, decorator: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessQuotaStatus::Representation
535
+
536
+ property :server_errors_per_project_per_hour, as: 'serverErrorsPerProjectPerHour', class: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessQuotaStatus, decorator: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessQuotaStatus::Representation
537
+
538
+ property :tokens_per_day, as: 'tokensPerDay', class: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessQuotaStatus, decorator: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessQuotaStatus::Representation
539
+
540
+ property :tokens_per_hour, as: 'tokensPerHour', class: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessQuotaStatus, decorator: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessQuotaStatus::Representation
541
+
542
+ property :tokens_per_project_per_hour, as: 'tokensPerProjectPerHour', class: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessQuotaStatus, decorator: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessQuotaStatus::Representation
543
+
544
+ end
545
+ end
546
+
547
+ class GoogleAnalyticsAdminV1betaAccessQuotaStatus
548
+ # @private
549
+ class Representation < Google::Apis::Core::JsonRepresentation
550
+ property :consumed, as: 'consumed'
551
+ property :remaining, as: 'remaining'
552
+ end
553
+ end
554
+
555
+ class GoogleAnalyticsAdminV1betaAccessRow
556
+ # @private
557
+ class Representation < Google::Apis::Core::JsonRepresentation
558
+ collection :dimension_values, as: 'dimensionValues', class: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessDimensionValue, decorator: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessDimensionValue::Representation
559
+
560
+ collection :metric_values, as: 'metricValues', class: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessMetricValue, decorator: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessMetricValue::Representation
561
+
562
+ end
563
+ end
564
+
565
+ class GoogleAnalyticsAdminV1betaAccessStringFilter
566
+ # @private
567
+ class Representation < Google::Apis::Core::JsonRepresentation
568
+ property :case_sensitive, as: 'caseSensitive'
569
+ property :match_type, as: 'matchType'
570
+ property :value, as: 'value'
571
+ end
572
+ end
573
+
253
574
  class GoogleAnalyticsAdminV1betaAccount
254
575
  # @private
255
576
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -565,6 +886,14 @@ module Google
565
886
  end
566
887
  end
567
888
 
889
+ class GoogleAnalyticsAdminV1betaNumericValue
890
+ # @private
891
+ class Representation < Google::Apis::Core::JsonRepresentation
892
+ property :double_value, as: 'doubleValue'
893
+ property :int64_value, :numeric_string => true, as: 'int64Value'
894
+ end
895
+ end
896
+
568
897
  class GoogleAnalyticsAdminV1betaProperty
569
898
  # @private
570
899
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -610,6 +939,43 @@ module Google
610
939
  end
611
940
  end
612
941
 
942
+ class GoogleAnalyticsAdminV1betaRunAccessReportRequest
943
+ # @private
944
+ class Representation < Google::Apis::Core::JsonRepresentation
945
+ collection :date_ranges, as: 'dateRanges', class: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessDateRange, decorator: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessDateRange::Representation
946
+
947
+ property :dimension_filter, as: 'dimensionFilter', class: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessFilterExpression, decorator: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessFilterExpression::Representation
948
+
949
+ collection :dimensions, as: 'dimensions', class: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessDimension, decorator: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessDimension::Representation
950
+
951
+ property :limit, :numeric_string => true, as: 'limit'
952
+ property :metric_filter, as: 'metricFilter', class: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessFilterExpression, decorator: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessFilterExpression::Representation
953
+
954
+ collection :metrics, as: 'metrics', class: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessMetric, decorator: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessMetric::Representation
955
+
956
+ property :offset, :numeric_string => true, as: 'offset'
957
+ collection :order_bys, as: 'orderBys', class: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessOrderBy, decorator: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessOrderBy::Representation
958
+
959
+ property :return_entity_quota, as: 'returnEntityQuota'
960
+ property :time_zone, as: 'timeZone'
961
+ end
962
+ end
963
+
964
+ class GoogleAnalyticsAdminV1betaRunAccessReportResponse
965
+ # @private
966
+ class Representation < Google::Apis::Core::JsonRepresentation
967
+ collection :dimension_headers, as: 'dimensionHeaders', class: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessDimensionHeader, decorator: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessDimensionHeader::Representation
968
+
969
+ collection :metric_headers, as: 'metricHeaders', class: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessMetricHeader, decorator: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessMetricHeader::Representation
970
+
971
+ property :quota, as: 'quota', class: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessQuota, decorator: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessQuota::Representation
972
+
973
+ property :row_count, as: 'rowCount'
974
+ collection :rows, as: 'rows', class: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessRow, decorator: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessRow::Representation
975
+
976
+ end
977
+ end
978
+
613
979
  class GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsRequest
614
980
  # @private
615
981
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -301,6 +301,54 @@ module Google
301
301
  execute_or_queue_command(command, &block)
302
302
  end
303
303
 
304
+ # Returns a customized report of data access records. The report provides
305
+ # records of each time a user reads Google Analytics reporting data. Access
306
+ # records are retained for up to 2 years. Data Access Reports can be requested
307
+ # for a property. The property must be in Google Analytics 360. This method is
308
+ # only available to Administrators. These data access records include GA4 UI
309
+ # Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase
310
+ # & Admob that can retrieve data from Google Analytics through a linkage. These
311
+ # records don't include property configuration changes like adding a stream or
312
+ # changing a property's time zone. For configuration change history, see [
313
+ # searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/
314
+ # config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).
315
+ # @param [String] entity
316
+ # The Data Access Report supports requesting at the property level or account
317
+ # level. If requested at the account level, Data Access Reports include all
318
+ # access for all properties under that account. To request at the property level,
319
+ # entity should be for example 'properties/123' if "123" is your GA4 property
320
+ # ID. To request at the account level, entity should be for example 'accounts/
321
+ # 1234' if "1234" is your GA4 Account ID.
322
+ # @param [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaRunAccessReportRequest] google_analytics_admin_v1beta_run_access_report_request_object
323
+ # @param [String] fields
324
+ # Selector specifying which fields to include in a partial response.
325
+ # @param [String] quota_user
326
+ # Available to use for quota purposes for server-side applications. Can be any
327
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
328
+ # @param [Google::Apis::RequestOptions] options
329
+ # Request-specific options
330
+ #
331
+ # @yield [result, err] Result & error if block supplied
332
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaRunAccessReportResponse] parsed result object
333
+ # @yieldparam err [StandardError] error object if request failed
334
+ #
335
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaRunAccessReportResponse]
336
+ #
337
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
338
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
339
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
340
+ def run_account_access_report(entity, google_analytics_admin_v1beta_run_access_report_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
341
+ command = make_simple_command(:post, 'v1beta/{+entity}:runAccessReport', options)
342
+ command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaRunAccessReportRequest::Representation
343
+ command.request_object = google_analytics_admin_v1beta_run_access_report_request_object
344
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaRunAccessReportResponse::Representation
345
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaRunAccessReportResponse
346
+ command.params['entity'] = entity unless entity.nil?
347
+ command.query['fields'] = fields unless fields.nil?
348
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
349
+ execute_or_queue_command(command, &block)
350
+ end
351
+
304
352
  # Searches through all changes to an account or its children given the specified
305
353
  # set of filters.
306
354
  # @param [String] account
@@ -595,6 +643,54 @@ module Google
595
643
  execute_or_queue_command(command, &block)
596
644
  end
597
645
 
646
+ # Returns a customized report of data access records. The report provides
647
+ # records of each time a user reads Google Analytics reporting data. Access
648
+ # records are retained for up to 2 years. Data Access Reports can be requested
649
+ # for a property. The property must be in Google Analytics 360. This method is
650
+ # only available to Administrators. These data access records include GA4 UI
651
+ # Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase
652
+ # & Admob that can retrieve data from Google Analytics through a linkage. These
653
+ # records don't include property configuration changes like adding a stream or
654
+ # changing a property's time zone. For configuration change history, see [
655
+ # searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/
656
+ # config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).
657
+ # @param [String] entity
658
+ # The Data Access Report supports requesting at the property level or account
659
+ # level. If requested at the account level, Data Access Reports include all
660
+ # access for all properties under that account. To request at the property level,
661
+ # entity should be for example 'properties/123' if "123" is your GA4 property
662
+ # ID. To request at the account level, entity should be for example 'accounts/
663
+ # 1234' if "1234" is your GA4 Account ID.
664
+ # @param [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaRunAccessReportRequest] google_analytics_admin_v1beta_run_access_report_request_object
665
+ # @param [String] fields
666
+ # Selector specifying which fields to include in a partial response.
667
+ # @param [String] quota_user
668
+ # Available to use for quota purposes for server-side applications. Can be any
669
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
670
+ # @param [Google::Apis::RequestOptions] options
671
+ # Request-specific options
672
+ #
673
+ # @yield [result, err] Result & error if block supplied
674
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaRunAccessReportResponse] parsed result object
675
+ # @yieldparam err [StandardError] error object if request failed
676
+ #
677
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaRunAccessReportResponse]
678
+ #
679
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
680
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
681
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
682
+ def run_property_access_report(entity, google_analytics_admin_v1beta_run_access_report_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
683
+ command = make_simple_command(:post, 'v1beta/{+entity}:runAccessReport', options)
684
+ command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaRunAccessReportRequest::Representation
685
+ command.request_object = google_analytics_admin_v1beta_run_access_report_request_object
686
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaRunAccessReportResponse::Representation
687
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaRunAccessReportResponse
688
+ command.params['entity'] = entity unless entity.nil?
689
+ command.query['fields'] = fields unless fields.nil?
690
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
691
+ execute_or_queue_command(command, &block)
692
+ end
693
+
598
694
  # Updates the singleton data retention settings for this property.
599
695
  # @param [String] name
600
696
  # Output only. Resource name for this DataRetentionSetting resource. Format:
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-analyticsadmin_v1beta
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.0
4
+ version: 0.4.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: 2023-03-05 00:00:00.000000000 Z
11
+ date: 2023-04-02 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-analyticsadmin_v1beta/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsadmin_v1beta/v0.3.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsadmin_v1beta/v0.4.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-analyticsadmin_v1beta
63
63
  post_install_message:
64
64
  rdoc_options: []