google-apis-analyticsadmin_v1alpha 0.29.0 → 0.32.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +14 -0
- data/lib/google/apis/analyticsadmin_v1alpha/classes.rb +766 -0
- data/lib/google/apis/analyticsadmin_v1alpha/gem_version.rb +3 -3
- data/lib/google/apis/analyticsadmin_v1alpha/representations.rb +382 -0
- data/lib/google/apis/analyticsadmin_v1alpha/service.rb +115 -0
- metadata +5 -5
@@ -22,6 +22,542 @@ module Google
|
|
22
22
|
module Apis
|
23
23
|
module AnalyticsadminV1alpha
|
24
24
|
|
25
|
+
# To express that the result needs to be between two numbers (inclusive).
|
26
|
+
class GoogleAnalyticsAdminV1alphaAccessBetweenFilter
|
27
|
+
include Google::Apis::Core::Hashable
|
28
|
+
|
29
|
+
# To represent a number.
|
30
|
+
# Corresponds to the JSON property `fromValue`
|
31
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaNumericValue]
|
32
|
+
attr_accessor :from_value
|
33
|
+
|
34
|
+
# To represent a number.
|
35
|
+
# Corresponds to the JSON property `toValue`
|
36
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaNumericValue]
|
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 GoogleAnalyticsAdminV1alphaAccessDateRange
|
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 GoogleAnalyticsAdminV1alphaAccessDimension
|
85
|
+
include Google::Apis::Core::Hashable
|
86
|
+
|
87
|
+
# The API name of the dimension. Dimensions are referenced by name in `
|
88
|
+
# dimensionFilter` and `orderBys`.
|
89
|
+
# Corresponds to the JSON property `dimensionName`
|
90
|
+
# @return [String]
|
91
|
+
attr_accessor :dimension_name
|
92
|
+
|
93
|
+
def initialize(**args)
|
94
|
+
update!(**args)
|
95
|
+
end
|
96
|
+
|
97
|
+
# Update properties of this object
|
98
|
+
def update!(**args)
|
99
|
+
@dimension_name = args[:dimension_name] if args.key?(:dimension_name)
|
100
|
+
end
|
101
|
+
end
|
102
|
+
|
103
|
+
# Describes a dimension column in the report. Dimensions requested in a report
|
104
|
+
# produce column entries within rows and DimensionHeaders. However, dimensions
|
105
|
+
# used exclusively within filters or expressions do not produce columns in a
|
106
|
+
# report; correspondingly, those dimensions do not produce headers.
|
107
|
+
class GoogleAnalyticsAdminV1alphaAccessDimensionHeader
|
108
|
+
include Google::Apis::Core::Hashable
|
109
|
+
|
110
|
+
# The dimension's name; for example 'country'.
|
111
|
+
# Corresponds to the JSON property `dimensionName`
|
112
|
+
# @return [String]
|
113
|
+
attr_accessor :dimension_name
|
114
|
+
|
115
|
+
def initialize(**args)
|
116
|
+
update!(**args)
|
117
|
+
end
|
118
|
+
|
119
|
+
# Update properties of this object
|
120
|
+
def update!(**args)
|
121
|
+
@dimension_name = args[:dimension_name] if args.key?(:dimension_name)
|
122
|
+
end
|
123
|
+
end
|
124
|
+
|
125
|
+
# The value of a dimension.
|
126
|
+
class GoogleAnalyticsAdminV1alphaAccessDimensionValue
|
127
|
+
include Google::Apis::Core::Hashable
|
128
|
+
|
129
|
+
# The dimension value. For example, this value may be 'France' for the 'country'
|
130
|
+
# dimension.
|
131
|
+
# Corresponds to the JSON property `value`
|
132
|
+
# @return [String]
|
133
|
+
attr_accessor :value
|
134
|
+
|
135
|
+
def initialize(**args)
|
136
|
+
update!(**args)
|
137
|
+
end
|
138
|
+
|
139
|
+
# Update properties of this object
|
140
|
+
def update!(**args)
|
141
|
+
@value = args[:value] if args.key?(:value)
|
142
|
+
end
|
143
|
+
end
|
144
|
+
|
145
|
+
# An expression to filter dimension or metric values.
|
146
|
+
class GoogleAnalyticsAdminV1alphaAccessFilter
|
147
|
+
include Google::Apis::Core::Hashable
|
148
|
+
|
149
|
+
# To express that the result needs to be between two numbers (inclusive).
|
150
|
+
# Corresponds to the JSON property `betweenFilter`
|
151
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessBetweenFilter]
|
152
|
+
attr_accessor :between_filter
|
153
|
+
|
154
|
+
# The dimension name or metric name.
|
155
|
+
# Corresponds to the JSON property `fieldName`
|
156
|
+
# @return [String]
|
157
|
+
attr_accessor :field_name
|
158
|
+
|
159
|
+
# The result needs to be in a list of string values.
|
160
|
+
# Corresponds to the JSON property `inListFilter`
|
161
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessInListFilter]
|
162
|
+
attr_accessor :in_list_filter
|
163
|
+
|
164
|
+
# Filters for numeric or date values.
|
165
|
+
# Corresponds to the JSON property `numericFilter`
|
166
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessNumericFilter]
|
167
|
+
attr_accessor :numeric_filter
|
168
|
+
|
169
|
+
# The filter for strings.
|
170
|
+
# Corresponds to the JSON property `stringFilter`
|
171
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessStringFilter]
|
172
|
+
attr_accessor :string_filter
|
173
|
+
|
174
|
+
def initialize(**args)
|
175
|
+
update!(**args)
|
176
|
+
end
|
177
|
+
|
178
|
+
# Update properties of this object
|
179
|
+
def update!(**args)
|
180
|
+
@between_filter = args[:between_filter] if args.key?(:between_filter)
|
181
|
+
@field_name = args[:field_name] if args.key?(:field_name)
|
182
|
+
@in_list_filter = args[:in_list_filter] if args.key?(:in_list_filter)
|
183
|
+
@numeric_filter = args[:numeric_filter] if args.key?(:numeric_filter)
|
184
|
+
@string_filter = args[:string_filter] if args.key?(:string_filter)
|
185
|
+
end
|
186
|
+
end
|
187
|
+
|
188
|
+
# Expresses dimension or metric filters. The fields in the same expression need
|
189
|
+
# to be either all dimensions or all metrics.
|
190
|
+
class GoogleAnalyticsAdminV1alphaAccessFilterExpression
|
191
|
+
include Google::Apis::Core::Hashable
|
192
|
+
|
193
|
+
# An expression to filter dimension or metric values.
|
194
|
+
# Corresponds to the JSON property `accessFilter`
|
195
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessFilter]
|
196
|
+
attr_accessor :access_filter
|
197
|
+
|
198
|
+
# A list of filter expressions.
|
199
|
+
# Corresponds to the JSON property `andGroup`
|
200
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessFilterExpressionList]
|
201
|
+
attr_accessor :and_group
|
202
|
+
|
203
|
+
# Expresses dimension or metric filters. The fields in the same expression need
|
204
|
+
# to be either all dimensions or all metrics.
|
205
|
+
# Corresponds to the JSON property `notExpression`
|
206
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessFilterExpression]
|
207
|
+
attr_accessor :not_expression
|
208
|
+
|
209
|
+
# A list of filter expressions.
|
210
|
+
# Corresponds to the JSON property `orGroup`
|
211
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessFilterExpressionList]
|
212
|
+
attr_accessor :or_group
|
213
|
+
|
214
|
+
def initialize(**args)
|
215
|
+
update!(**args)
|
216
|
+
end
|
217
|
+
|
218
|
+
# Update properties of this object
|
219
|
+
def update!(**args)
|
220
|
+
@access_filter = args[:access_filter] if args.key?(:access_filter)
|
221
|
+
@and_group = args[:and_group] if args.key?(:and_group)
|
222
|
+
@not_expression = args[:not_expression] if args.key?(:not_expression)
|
223
|
+
@or_group = args[:or_group] if args.key?(:or_group)
|
224
|
+
end
|
225
|
+
end
|
226
|
+
|
227
|
+
# A list of filter expressions.
|
228
|
+
class GoogleAnalyticsAdminV1alphaAccessFilterExpressionList
|
229
|
+
include Google::Apis::Core::Hashable
|
230
|
+
|
231
|
+
# A list of filter expressions.
|
232
|
+
# Corresponds to the JSON property `expressions`
|
233
|
+
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessFilterExpression>]
|
234
|
+
attr_accessor :expressions
|
235
|
+
|
236
|
+
def initialize(**args)
|
237
|
+
update!(**args)
|
238
|
+
end
|
239
|
+
|
240
|
+
# Update properties of this object
|
241
|
+
def update!(**args)
|
242
|
+
@expressions = args[:expressions] if args.key?(:expressions)
|
243
|
+
end
|
244
|
+
end
|
245
|
+
|
246
|
+
# The result needs to be in a list of string values.
|
247
|
+
class GoogleAnalyticsAdminV1alphaAccessInListFilter
|
248
|
+
include Google::Apis::Core::Hashable
|
249
|
+
|
250
|
+
# If true, the string value is case sensitive.
|
251
|
+
# Corresponds to the JSON property `caseSensitive`
|
252
|
+
# @return [Boolean]
|
253
|
+
attr_accessor :case_sensitive
|
254
|
+
alias_method :case_sensitive?, :case_sensitive
|
255
|
+
|
256
|
+
# The list of string values. Must be non-empty.
|
257
|
+
# Corresponds to the JSON property `values`
|
258
|
+
# @return [Array<String>]
|
259
|
+
attr_accessor :values
|
260
|
+
|
261
|
+
def initialize(**args)
|
262
|
+
update!(**args)
|
263
|
+
end
|
264
|
+
|
265
|
+
# Update properties of this object
|
266
|
+
def update!(**args)
|
267
|
+
@case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive)
|
268
|
+
@values = args[:values] if args.key?(:values)
|
269
|
+
end
|
270
|
+
end
|
271
|
+
|
272
|
+
# The quantitative measurements of a report. For example, the metric `
|
273
|
+
# accessCount` is the total number of data access records.
|
274
|
+
class GoogleAnalyticsAdminV1alphaAccessMetric
|
275
|
+
include Google::Apis::Core::Hashable
|
276
|
+
|
277
|
+
# The API name of the metric. Metrics are referenced by name in `metricFilter` &
|
278
|
+
# `orderBys`.
|
279
|
+
# Corresponds to the JSON property `metricName`
|
280
|
+
# @return [String]
|
281
|
+
attr_accessor :metric_name
|
282
|
+
|
283
|
+
def initialize(**args)
|
284
|
+
update!(**args)
|
285
|
+
end
|
286
|
+
|
287
|
+
# Update properties of this object
|
288
|
+
def update!(**args)
|
289
|
+
@metric_name = args[:metric_name] if args.key?(:metric_name)
|
290
|
+
end
|
291
|
+
end
|
292
|
+
|
293
|
+
# Describes a metric column in the report. Visible metrics requested in a report
|
294
|
+
# produce column entries within rows and MetricHeaders. However, metrics used
|
295
|
+
# exclusively within filters or expressions do not produce columns in a report;
|
296
|
+
# correspondingly, those metrics do not produce headers.
|
297
|
+
class GoogleAnalyticsAdminV1alphaAccessMetricHeader
|
298
|
+
include Google::Apis::Core::Hashable
|
299
|
+
|
300
|
+
# The metric's name; for example 'accessCount'.
|
301
|
+
# Corresponds to the JSON property `metricName`
|
302
|
+
# @return [String]
|
303
|
+
attr_accessor :metric_name
|
304
|
+
|
305
|
+
def initialize(**args)
|
306
|
+
update!(**args)
|
307
|
+
end
|
308
|
+
|
309
|
+
# Update properties of this object
|
310
|
+
def update!(**args)
|
311
|
+
@metric_name = args[:metric_name] if args.key?(:metric_name)
|
312
|
+
end
|
313
|
+
end
|
314
|
+
|
315
|
+
# The value of a metric.
|
316
|
+
class GoogleAnalyticsAdminV1alphaAccessMetricValue
|
317
|
+
include Google::Apis::Core::Hashable
|
318
|
+
|
319
|
+
# The measurement value. For example, this value may be '13'.
|
320
|
+
# Corresponds to the JSON property `value`
|
321
|
+
# @return [String]
|
322
|
+
attr_accessor :value
|
323
|
+
|
324
|
+
def initialize(**args)
|
325
|
+
update!(**args)
|
326
|
+
end
|
327
|
+
|
328
|
+
# Update properties of this object
|
329
|
+
def update!(**args)
|
330
|
+
@value = args[:value] if args.key?(:value)
|
331
|
+
end
|
332
|
+
end
|
333
|
+
|
334
|
+
# Filters for numeric or date values.
|
335
|
+
class GoogleAnalyticsAdminV1alphaAccessNumericFilter
|
336
|
+
include Google::Apis::Core::Hashable
|
337
|
+
|
338
|
+
# The operation type for this filter.
|
339
|
+
# Corresponds to the JSON property `operation`
|
340
|
+
# @return [String]
|
341
|
+
attr_accessor :operation
|
342
|
+
|
343
|
+
# To represent a number.
|
344
|
+
# Corresponds to the JSON property `value`
|
345
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaNumericValue]
|
346
|
+
attr_accessor :value
|
347
|
+
|
348
|
+
def initialize(**args)
|
349
|
+
update!(**args)
|
350
|
+
end
|
351
|
+
|
352
|
+
# Update properties of this object
|
353
|
+
def update!(**args)
|
354
|
+
@operation = args[:operation] if args.key?(:operation)
|
355
|
+
@value = args[:value] if args.key?(:value)
|
356
|
+
end
|
357
|
+
end
|
358
|
+
|
359
|
+
# Order bys define how rows will be sorted in the response. For example,
|
360
|
+
# ordering rows by descending access count is one ordering, and ordering rows by
|
361
|
+
# the country string is a different ordering.
|
362
|
+
class GoogleAnalyticsAdminV1alphaAccessOrderBy
|
363
|
+
include Google::Apis::Core::Hashable
|
364
|
+
|
365
|
+
# If true, sorts by descending order. If false or unspecified, sorts in
|
366
|
+
# ascending order.
|
367
|
+
# Corresponds to the JSON property `desc`
|
368
|
+
# @return [Boolean]
|
369
|
+
attr_accessor :desc
|
370
|
+
alias_method :desc?, :desc
|
371
|
+
|
372
|
+
# Sorts by dimension values.
|
373
|
+
# Corresponds to the JSON property `dimension`
|
374
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessOrderByDimensionOrderBy]
|
375
|
+
attr_accessor :dimension
|
376
|
+
|
377
|
+
# Sorts by metric values.
|
378
|
+
# Corresponds to the JSON property `metric`
|
379
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessOrderByMetricOrderBy]
|
380
|
+
attr_accessor :metric
|
381
|
+
|
382
|
+
def initialize(**args)
|
383
|
+
update!(**args)
|
384
|
+
end
|
385
|
+
|
386
|
+
# Update properties of this object
|
387
|
+
def update!(**args)
|
388
|
+
@desc = args[:desc] if args.key?(:desc)
|
389
|
+
@dimension = args[:dimension] if args.key?(:dimension)
|
390
|
+
@metric = args[:metric] if args.key?(:metric)
|
391
|
+
end
|
392
|
+
end
|
393
|
+
|
394
|
+
# Sorts by dimension values.
|
395
|
+
class GoogleAnalyticsAdminV1alphaAccessOrderByDimensionOrderBy
|
396
|
+
include Google::Apis::Core::Hashable
|
397
|
+
|
398
|
+
# A dimension name in the request to order by.
|
399
|
+
# Corresponds to the JSON property `dimensionName`
|
400
|
+
# @return [String]
|
401
|
+
attr_accessor :dimension_name
|
402
|
+
|
403
|
+
# Controls the rule for dimension value ordering.
|
404
|
+
# Corresponds to the JSON property `orderType`
|
405
|
+
# @return [String]
|
406
|
+
attr_accessor :order_type
|
407
|
+
|
408
|
+
def initialize(**args)
|
409
|
+
update!(**args)
|
410
|
+
end
|
411
|
+
|
412
|
+
# Update properties of this object
|
413
|
+
def update!(**args)
|
414
|
+
@dimension_name = args[:dimension_name] if args.key?(:dimension_name)
|
415
|
+
@order_type = args[:order_type] if args.key?(:order_type)
|
416
|
+
end
|
417
|
+
end
|
418
|
+
|
419
|
+
# Sorts by metric values.
|
420
|
+
class GoogleAnalyticsAdminV1alphaAccessOrderByMetricOrderBy
|
421
|
+
include Google::Apis::Core::Hashable
|
422
|
+
|
423
|
+
# A metric name in the request to order by.
|
424
|
+
# Corresponds to the JSON property `metricName`
|
425
|
+
# @return [String]
|
426
|
+
attr_accessor :metric_name
|
427
|
+
|
428
|
+
def initialize(**args)
|
429
|
+
update!(**args)
|
430
|
+
end
|
431
|
+
|
432
|
+
# Update properties of this object
|
433
|
+
def update!(**args)
|
434
|
+
@metric_name = args[:metric_name] if args.key?(:metric_name)
|
435
|
+
end
|
436
|
+
end
|
437
|
+
|
438
|
+
# Current state of all quotas for this Analytics property. If any quota for a
|
439
|
+
# property is exhausted, all requests to that property will return Resource
|
440
|
+
# Exhausted errors.
|
441
|
+
class GoogleAnalyticsAdminV1alphaAccessQuota
|
442
|
+
include Google::Apis::Core::Hashable
|
443
|
+
|
444
|
+
# Current state for a particular quota group.
|
445
|
+
# Corresponds to the JSON property `concurrentRequests`
|
446
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessQuotaStatus]
|
447
|
+
attr_accessor :concurrent_requests
|
448
|
+
|
449
|
+
# Current state for a particular quota group.
|
450
|
+
# Corresponds to the JSON property `serverErrorsPerProjectPerHour`
|
451
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessQuotaStatus]
|
452
|
+
attr_accessor :server_errors_per_project_per_hour
|
453
|
+
|
454
|
+
# Current state for a particular quota group.
|
455
|
+
# Corresponds to the JSON property `tokensPerDay`
|
456
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessQuotaStatus]
|
457
|
+
attr_accessor :tokens_per_day
|
458
|
+
|
459
|
+
# Current state for a particular quota group.
|
460
|
+
# Corresponds to the JSON property `tokensPerHour`
|
461
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessQuotaStatus]
|
462
|
+
attr_accessor :tokens_per_hour
|
463
|
+
|
464
|
+
def initialize(**args)
|
465
|
+
update!(**args)
|
466
|
+
end
|
467
|
+
|
468
|
+
# Update properties of this object
|
469
|
+
def update!(**args)
|
470
|
+
@concurrent_requests = args[:concurrent_requests] if args.key?(:concurrent_requests)
|
471
|
+
@server_errors_per_project_per_hour = args[:server_errors_per_project_per_hour] if args.key?(:server_errors_per_project_per_hour)
|
472
|
+
@tokens_per_day = args[:tokens_per_day] if args.key?(:tokens_per_day)
|
473
|
+
@tokens_per_hour = args[:tokens_per_hour] if args.key?(:tokens_per_hour)
|
474
|
+
end
|
475
|
+
end
|
476
|
+
|
477
|
+
# Current state for a particular quota group.
|
478
|
+
class GoogleAnalyticsAdminV1alphaAccessQuotaStatus
|
479
|
+
include Google::Apis::Core::Hashable
|
480
|
+
|
481
|
+
# Quota consumed by this request.
|
482
|
+
# Corresponds to the JSON property `consumed`
|
483
|
+
# @return [Fixnum]
|
484
|
+
attr_accessor :consumed
|
485
|
+
|
486
|
+
# Quota remaining after this request.
|
487
|
+
# Corresponds to the JSON property `remaining`
|
488
|
+
# @return [Fixnum]
|
489
|
+
attr_accessor :remaining
|
490
|
+
|
491
|
+
def initialize(**args)
|
492
|
+
update!(**args)
|
493
|
+
end
|
494
|
+
|
495
|
+
# Update properties of this object
|
496
|
+
def update!(**args)
|
497
|
+
@consumed = args[:consumed] if args.key?(:consumed)
|
498
|
+
@remaining = args[:remaining] if args.key?(:remaining)
|
499
|
+
end
|
500
|
+
end
|
501
|
+
|
502
|
+
# Access report data for each row.
|
503
|
+
class GoogleAnalyticsAdminV1alphaAccessRow
|
504
|
+
include Google::Apis::Core::Hashable
|
505
|
+
|
506
|
+
# List of dimension values. These values are in the same order as specified in
|
507
|
+
# the request.
|
508
|
+
# Corresponds to the JSON property `dimensionValues`
|
509
|
+
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessDimensionValue>]
|
510
|
+
attr_accessor :dimension_values
|
511
|
+
|
512
|
+
# List of metric values. These values are in the same order as specified in the
|
513
|
+
# request.
|
514
|
+
# Corresponds to the JSON property `metricValues`
|
515
|
+
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessMetricValue>]
|
516
|
+
attr_accessor :metric_values
|
517
|
+
|
518
|
+
def initialize(**args)
|
519
|
+
update!(**args)
|
520
|
+
end
|
521
|
+
|
522
|
+
# Update properties of this object
|
523
|
+
def update!(**args)
|
524
|
+
@dimension_values = args[:dimension_values] if args.key?(:dimension_values)
|
525
|
+
@metric_values = args[:metric_values] if args.key?(:metric_values)
|
526
|
+
end
|
527
|
+
end
|
528
|
+
|
529
|
+
# The filter for strings.
|
530
|
+
class GoogleAnalyticsAdminV1alphaAccessStringFilter
|
531
|
+
include Google::Apis::Core::Hashable
|
532
|
+
|
533
|
+
# If true, the string value is case sensitive.
|
534
|
+
# Corresponds to the JSON property `caseSensitive`
|
535
|
+
# @return [Boolean]
|
536
|
+
attr_accessor :case_sensitive
|
537
|
+
alias_method :case_sensitive?, :case_sensitive
|
538
|
+
|
539
|
+
# The match type for this filter.
|
540
|
+
# Corresponds to the JSON property `matchType`
|
541
|
+
# @return [String]
|
542
|
+
attr_accessor :match_type
|
543
|
+
|
544
|
+
# The string value used for the matching.
|
545
|
+
# Corresponds to the JSON property `value`
|
546
|
+
# @return [String]
|
547
|
+
attr_accessor :value
|
548
|
+
|
549
|
+
def initialize(**args)
|
550
|
+
update!(**args)
|
551
|
+
end
|
552
|
+
|
553
|
+
# Update properties of this object
|
554
|
+
def update!(**args)
|
555
|
+
@case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive)
|
556
|
+
@match_type = args[:match_type] if args.key?(:match_type)
|
557
|
+
@value = args[:value] if args.key?(:value)
|
558
|
+
end
|
559
|
+
end
|
560
|
+
|
25
561
|
# A resource message representing a Google Analytics account.
|
26
562
|
class GoogleAnalyticsAdminV1alphaAccount
|
27
563
|
include Google::Apis::Core::Hashable
|
@@ -209,6 +745,51 @@ module Google
|
|
209
745
|
end
|
210
746
|
end
|
211
747
|
|
748
|
+
# The attribution settings used for a given property. This is a singleton
|
749
|
+
# resource.
|
750
|
+
class GoogleAnalyticsAdminV1alphaAttributionSettings
|
751
|
+
include Google::Apis::Core::Hashable
|
752
|
+
|
753
|
+
# Required. The lookback window configuration for acquisition conversion events.
|
754
|
+
# The default window size is 30 days.
|
755
|
+
# Corresponds to the JSON property `acquisitionConversionEventLookbackWindow`
|
756
|
+
# @return [String]
|
757
|
+
attr_accessor :acquisition_conversion_event_lookback_window
|
758
|
+
|
759
|
+
# Output only. Resource name of this attribution settings resource. Format:
|
760
|
+
# properties/`property_id`/attributionSettings Example: "properties/1000/
|
761
|
+
# attributionSettings"
|
762
|
+
# Corresponds to the JSON property `name`
|
763
|
+
# @return [String]
|
764
|
+
attr_accessor :name
|
765
|
+
|
766
|
+
# Required. The lookback window for all other, non-acquisition conversion events.
|
767
|
+
# The default window size is 90 days.
|
768
|
+
# Corresponds to the JSON property `otherConversionEventLookbackWindow`
|
769
|
+
# @return [String]
|
770
|
+
attr_accessor :other_conversion_event_lookback_window
|
771
|
+
|
772
|
+
# Required. The reporting attribution model used to calculate conversion credit
|
773
|
+
# in this property's reports. Changing the attribution model will apply to both
|
774
|
+
# historical and future data. These changes will be reflected in reports with
|
775
|
+
# conversion and revenue data. User and session data will be unaffected.
|
776
|
+
# Corresponds to the JSON property `reportingAttributionModel`
|
777
|
+
# @return [String]
|
778
|
+
attr_accessor :reporting_attribution_model
|
779
|
+
|
780
|
+
def initialize(**args)
|
781
|
+
update!(**args)
|
782
|
+
end
|
783
|
+
|
784
|
+
# Update properties of this object
|
785
|
+
def update!(**args)
|
786
|
+
@acquisition_conversion_event_lookback_window = args[:acquisition_conversion_event_lookback_window] if args.key?(:acquisition_conversion_event_lookback_window)
|
787
|
+
@name = args[:name] if args.key?(:name)
|
788
|
+
@other_conversion_event_lookback_window = args[:other_conversion_event_lookback_window] if args.key?(:other_conversion_event_lookback_window)
|
789
|
+
@reporting_attribution_model = args[:reporting_attribution_model] if args.key?(:reporting_attribution_model)
|
790
|
+
end
|
791
|
+
end
|
792
|
+
|
212
793
|
# Read-only resource used to summarize a principal's effective roles.
|
213
794
|
class GoogleAnalyticsAdminV1alphaAuditUserLink
|
214
795
|
include Google::Apis::Core::Hashable
|
@@ -494,6 +1075,12 @@ module Google
|
|
494
1075
|
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccount]
|
495
1076
|
attr_accessor :account
|
496
1077
|
|
1078
|
+
# The attribution settings used for a given property. This is a singleton
|
1079
|
+
# resource.
|
1080
|
+
# Corresponds to the JSON property `attributionSettings`
|
1081
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAttributionSettings]
|
1082
|
+
attr_accessor :attribution_settings
|
1083
|
+
|
497
1084
|
# A conversion event in a Google Analytics property.
|
498
1085
|
# Corresponds to the JSON property `conversionEvent`
|
499
1086
|
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent]
|
@@ -564,6 +1151,7 @@ module Google
|
|
564
1151
|
# Update properties of this object
|
565
1152
|
def update!(**args)
|
566
1153
|
@account = args[:account] if args.key?(:account)
|
1154
|
+
@attribution_settings = args[:attribution_settings] if args.key?(:attribution_settings)
|
567
1155
|
@conversion_event = args[:conversion_event] if args.key?(:conversion_event)
|
568
1156
|
@custom_dimension = args[:custom_dimension] if args.key?(:custom_dimension)
|
569
1157
|
@custom_metric = args[:custom_metric] if args.key?(:custom_metric)
|
@@ -1822,6 +2410,31 @@ module Google
|
|
1822
2410
|
end
|
1823
2411
|
end
|
1824
2412
|
|
2413
|
+
# To represent a number.
|
2414
|
+
class GoogleAnalyticsAdminV1alphaNumericValue
|
2415
|
+
include Google::Apis::Core::Hashable
|
2416
|
+
|
2417
|
+
# Double value
|
2418
|
+
# Corresponds to the JSON property `doubleValue`
|
2419
|
+
# @return [Float]
|
2420
|
+
attr_accessor :double_value
|
2421
|
+
|
2422
|
+
# Integer value
|
2423
|
+
# Corresponds to the JSON property `int64Value`
|
2424
|
+
# @return [Fixnum]
|
2425
|
+
attr_accessor :int64_value
|
2426
|
+
|
2427
|
+
def initialize(**args)
|
2428
|
+
update!(**args)
|
2429
|
+
end
|
2430
|
+
|
2431
|
+
# Update properties of this object
|
2432
|
+
def update!(**args)
|
2433
|
+
@double_value = args[:double_value] if args.key?(:double_value)
|
2434
|
+
@int64_value = args[:int64_value] if args.key?(:int64_value)
|
2435
|
+
end
|
2436
|
+
end
|
2437
|
+
|
1825
2438
|
# A resource message representing a Google Analytics GA4 property.
|
1826
2439
|
class GoogleAnalyticsAdminV1alphaProperty
|
1827
2440
|
include Google::Apis::Core::Hashable
|
@@ -2014,6 +2627,159 @@ module Google
|
|
2014
2627
|
end
|
2015
2628
|
end
|
2016
2629
|
|
2630
|
+
# The request for a Data Access Record Report.
|
2631
|
+
class GoogleAnalyticsAdminV1alphaRunAccessReportRequest
|
2632
|
+
include Google::Apis::Core::Hashable
|
2633
|
+
|
2634
|
+
# Date ranges of access records to read. If multiple date ranges are requested,
|
2635
|
+
# each response row will contain a zero based date range index. If two date
|
2636
|
+
# ranges overlap, the access records for the overlapping days is included in the
|
2637
|
+
# response rows for both date ranges. Requests are allowed up to 2 date ranges.
|
2638
|
+
# Corresponds to the JSON property `dateRanges`
|
2639
|
+
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessDateRange>]
|
2640
|
+
attr_accessor :date_ranges
|
2641
|
+
|
2642
|
+
# Expresses dimension or metric filters. The fields in the same expression need
|
2643
|
+
# to be either all dimensions or all metrics.
|
2644
|
+
# Corresponds to the JSON property `dimensionFilter`
|
2645
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessFilterExpression]
|
2646
|
+
attr_accessor :dimension_filter
|
2647
|
+
|
2648
|
+
# The dimensions requested and displayed in the response. Requests are allowed
|
2649
|
+
# up to 9 dimensions.
|
2650
|
+
# Corresponds to the JSON property `dimensions`
|
2651
|
+
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessDimension>]
|
2652
|
+
attr_accessor :dimensions
|
2653
|
+
|
2654
|
+
# The number of rows to return. If unspecified, 10,000 rows are returned. The
|
2655
|
+
# API returns a maximum of 100,000 rows per request, no matter how many you ask
|
2656
|
+
# for. `limit` must be positive. The API may return fewer rows than the
|
2657
|
+
# requested `limit`, if there aren't as many remaining rows as the `limit`. For
|
2658
|
+
# instance, there are fewer than 300 possible values for the dimension `country`,
|
2659
|
+
# so when reporting on only `country`, you can't get more than 300 rows, even
|
2660
|
+
# if you set `limit` to a higher value. To learn more about this pagination
|
2661
|
+
# parameter, see [Pagination](https://developers.google.com/analytics/devguides/
|
2662
|
+
# reporting/data/v1/basics#pagination).
|
2663
|
+
# Corresponds to the JSON property `limit`
|
2664
|
+
# @return [Fixnum]
|
2665
|
+
attr_accessor :limit
|
2666
|
+
|
2667
|
+
# Expresses dimension or metric filters. The fields in the same expression need
|
2668
|
+
# to be either all dimensions or all metrics.
|
2669
|
+
# Corresponds to the JSON property `metricFilter`
|
2670
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessFilterExpression]
|
2671
|
+
attr_accessor :metric_filter
|
2672
|
+
|
2673
|
+
# The metrics requested and displayed in the response. Requests are allowed up
|
2674
|
+
# to 10 metrics.
|
2675
|
+
# Corresponds to the JSON property `metrics`
|
2676
|
+
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessMetric>]
|
2677
|
+
attr_accessor :metrics
|
2678
|
+
|
2679
|
+
# The row count of the start row. The first row is counted as row 0. If offset
|
2680
|
+
# is unspecified, it is treated as 0. If offset is zero, then this method will
|
2681
|
+
# return the first page of results with `limit` entries. To learn more about
|
2682
|
+
# this pagination parameter, see [Pagination](https://developers.google.com/
|
2683
|
+
# analytics/devguides/reporting/data/v1/basics#pagination).
|
2684
|
+
# Corresponds to the JSON property `offset`
|
2685
|
+
# @return [Fixnum]
|
2686
|
+
attr_accessor :offset
|
2687
|
+
|
2688
|
+
# Specifies how rows are ordered in the response.
|
2689
|
+
# Corresponds to the JSON property `orderBys`
|
2690
|
+
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessOrderBy>]
|
2691
|
+
attr_accessor :order_bys
|
2692
|
+
|
2693
|
+
# Toggles whether to return the current state of this Analytics Property's quota.
|
2694
|
+
# Quota is returned in [PropertyQuota](#PropertyQuota).
|
2695
|
+
# Corresponds to the JSON property `returnPropertyQuota`
|
2696
|
+
# @return [Boolean]
|
2697
|
+
attr_accessor :return_property_quota
|
2698
|
+
alias_method :return_property_quota?, :return_property_quota
|
2699
|
+
|
2700
|
+
# This request's time zone if specified. If unspecified, the property's time
|
2701
|
+
# zone is used. The request's time zone is used to interpret the start & end
|
2702
|
+
# dates of the report. Formatted as strings from the IANA Time Zone database (
|
2703
|
+
# https://www.iana.org/time-zones); for example "America/New_York" or "Asia/
|
2704
|
+
# Tokyo".
|
2705
|
+
# Corresponds to the JSON property `timeZone`
|
2706
|
+
# @return [String]
|
2707
|
+
attr_accessor :time_zone
|
2708
|
+
|
2709
|
+
def initialize(**args)
|
2710
|
+
update!(**args)
|
2711
|
+
end
|
2712
|
+
|
2713
|
+
# Update properties of this object
|
2714
|
+
def update!(**args)
|
2715
|
+
@date_ranges = args[:date_ranges] if args.key?(:date_ranges)
|
2716
|
+
@dimension_filter = args[:dimension_filter] if args.key?(:dimension_filter)
|
2717
|
+
@dimensions = args[:dimensions] if args.key?(:dimensions)
|
2718
|
+
@limit = args[:limit] if args.key?(:limit)
|
2719
|
+
@metric_filter = args[:metric_filter] if args.key?(:metric_filter)
|
2720
|
+
@metrics = args[:metrics] if args.key?(:metrics)
|
2721
|
+
@offset = args[:offset] if args.key?(:offset)
|
2722
|
+
@order_bys = args[:order_bys] if args.key?(:order_bys)
|
2723
|
+
@return_property_quota = args[:return_property_quota] if args.key?(:return_property_quota)
|
2724
|
+
@time_zone = args[:time_zone] if args.key?(:time_zone)
|
2725
|
+
end
|
2726
|
+
end
|
2727
|
+
|
2728
|
+
# The customized Data Access Record Report response.
|
2729
|
+
class GoogleAnalyticsAdminV1alphaRunAccessReportResponse
|
2730
|
+
include Google::Apis::Core::Hashable
|
2731
|
+
|
2732
|
+
# The header for a column in the report that corresponds to a specific dimension.
|
2733
|
+
# The number of DimensionHeaders and ordering of DimensionHeaders matches the
|
2734
|
+
# dimensions present in rows.
|
2735
|
+
# Corresponds to the JSON property `dimensionHeaders`
|
2736
|
+
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessDimensionHeader>]
|
2737
|
+
attr_accessor :dimension_headers
|
2738
|
+
|
2739
|
+
# The header for a column in the report that corresponds to a specific metric.
|
2740
|
+
# The number of MetricHeaders and ordering of MetricHeaders matches the metrics
|
2741
|
+
# present in rows.
|
2742
|
+
# Corresponds to the JSON property `metricHeaders`
|
2743
|
+
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessMetricHeader>]
|
2744
|
+
attr_accessor :metric_headers
|
2745
|
+
|
2746
|
+
# Current state of all quotas for this Analytics property. If any quota for a
|
2747
|
+
# property is exhausted, all requests to that property will return Resource
|
2748
|
+
# Exhausted errors.
|
2749
|
+
# Corresponds to the JSON property `quota`
|
2750
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessQuota]
|
2751
|
+
attr_accessor :quota
|
2752
|
+
|
2753
|
+
# The total number of rows in the query result. `rowCount` is independent of the
|
2754
|
+
# number of rows returned in the response, the `limit` request parameter, and
|
2755
|
+
# the `offset` request parameter. For example if a query returns 175 rows and
|
2756
|
+
# includes `limit` of 50 in the API request, the response will contain `rowCount`
|
2757
|
+
# of 175 but only 50 rows. To learn more about this pagination parameter, see [
|
2758
|
+
# Pagination](https://developers.google.com/analytics/devguides/reporting/data/
|
2759
|
+
# v1/basics#pagination).
|
2760
|
+
# Corresponds to the JSON property `rowCount`
|
2761
|
+
# @return [Fixnum]
|
2762
|
+
attr_accessor :row_count
|
2763
|
+
|
2764
|
+
# Rows of dimension value combinations and metric values in the report.
|
2765
|
+
# Corresponds to the JSON property `rows`
|
2766
|
+
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessRow>]
|
2767
|
+
attr_accessor :rows
|
2768
|
+
|
2769
|
+
def initialize(**args)
|
2770
|
+
update!(**args)
|
2771
|
+
end
|
2772
|
+
|
2773
|
+
# Update properties of this object
|
2774
|
+
def update!(**args)
|
2775
|
+
@dimension_headers = args[:dimension_headers] if args.key?(:dimension_headers)
|
2776
|
+
@metric_headers = args[:metric_headers] if args.key?(:metric_headers)
|
2777
|
+
@quota = args[:quota] if args.key?(:quota)
|
2778
|
+
@row_count = args[:row_count] if args.key?(:row_count)
|
2779
|
+
@rows = args[:rows] if args.key?(:rows)
|
2780
|
+
end
|
2781
|
+
end
|
2782
|
+
|
2017
2783
|
# Request message for SearchChangeHistoryEvents RPC.
|
2018
2784
|
class GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsRequest
|
2019
2785
|
include Google::Apis::Core::Hashable
|