google-apis-analyticsadmin_v1alpha 0.33.0 → 0.36.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 +12 -0
- data/lib/google/apis/analyticsadmin_v1alpha/classes.rb +1393 -108
- data/lib/google/apis/analyticsadmin_v1alpha/gem_version.rb +2 -2
- data/lib/google/apis/analyticsadmin_v1alpha/representations.rb +640 -0
- data/lib/google/apis/analyticsadmin_v1alpha/service.rb +222 -0
- metadata +3 -3
@@ -22,42 +22,993 @@ 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. 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 GoogleAnalyticsAdminV1alphaAccessDimensionHeader
|
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 GoogleAnalyticsAdminV1alphaAccessDimensionValue
|
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 GoogleAnalyticsAdminV1alphaAccessFilter
|
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::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessBetweenFilter]
|
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::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessInListFilter]
|
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::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessNumericFilter]
|
169
|
+
attr_accessor :numeric_filter
|
170
|
+
|
171
|
+
# The filter for strings.
|
172
|
+
# Corresponds to the JSON property `stringFilter`
|
173
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessStringFilter]
|
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 GoogleAnalyticsAdminV1alphaAccessFilterExpression
|
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::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessFilter]
|
198
|
+
attr_accessor :access_filter
|
199
|
+
|
200
|
+
# A list of filter expressions.
|
201
|
+
# Corresponds to the JSON property `andGroup`
|
202
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessFilterExpressionList]
|
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::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessFilterExpression]
|
209
|
+
attr_accessor :not_expression
|
210
|
+
|
211
|
+
# A list of filter expressions.
|
212
|
+
# Corresponds to the JSON property `orGroup`
|
213
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessFilterExpressionList]
|
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 GoogleAnalyticsAdminV1alphaAccessFilterExpressionList
|
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::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessFilterExpression>]
|
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 GoogleAnalyticsAdminV1alphaAccessInListFilter
|
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 GoogleAnalyticsAdminV1alphaAccessMetric
|
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 GoogleAnalyticsAdminV1alphaAccessMetricHeader
|
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 GoogleAnalyticsAdminV1alphaAccessMetricValue
|
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 GoogleAnalyticsAdminV1alphaAccessNumericFilter
|
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::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaNumericValue]
|
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 GoogleAnalyticsAdminV1alphaAccessOrderBy
|
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::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessOrderByDimensionOrderBy]
|
379
|
+
attr_accessor :dimension
|
380
|
+
|
381
|
+
# Sorts by metric values.
|
382
|
+
# Corresponds to the JSON property `metric`
|
383
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessOrderByMetricOrderBy]
|
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 GoogleAnalyticsAdminV1alphaAccessOrderByDimensionOrderBy
|
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 GoogleAnalyticsAdminV1alphaAccessOrderByMetricOrderBy
|
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 GoogleAnalyticsAdminV1alphaAccessQuota
|
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::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessQuotaStatus]
|
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::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessQuotaStatus]
|
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::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessQuotaStatus]
|
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::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessQuotaStatus]
|
466
|
+
attr_accessor :tokens_per_hour
|
467
|
+
|
468
|
+
def initialize(**args)
|
469
|
+
update!(**args)
|
470
|
+
end
|
471
|
+
|
472
|
+
# Update properties of this object
|
473
|
+
def update!(**args)
|
474
|
+
@concurrent_requests = args[:concurrent_requests] if args.key?(:concurrent_requests)
|
475
|
+
@server_errors_per_project_per_hour = args[:server_errors_per_project_per_hour] if args.key?(:server_errors_per_project_per_hour)
|
476
|
+
@tokens_per_day = args[:tokens_per_day] if args.key?(:tokens_per_day)
|
477
|
+
@tokens_per_hour = args[:tokens_per_hour] if args.key?(:tokens_per_hour)
|
478
|
+
end
|
479
|
+
end
|
480
|
+
|
481
|
+
# Current state for a particular quota group.
|
482
|
+
class GoogleAnalyticsAdminV1alphaAccessQuotaStatus
|
483
|
+
include Google::Apis::Core::Hashable
|
484
|
+
|
485
|
+
# Quota consumed by this request.
|
486
|
+
# Corresponds to the JSON property `consumed`
|
487
|
+
# @return [Fixnum]
|
488
|
+
attr_accessor :consumed
|
489
|
+
|
490
|
+
# Quota remaining after this request.
|
491
|
+
# Corresponds to the JSON property `remaining`
|
492
|
+
# @return [Fixnum]
|
493
|
+
attr_accessor :remaining
|
494
|
+
|
495
|
+
def initialize(**args)
|
496
|
+
update!(**args)
|
497
|
+
end
|
498
|
+
|
499
|
+
# Update properties of this object
|
500
|
+
def update!(**args)
|
501
|
+
@consumed = args[:consumed] if args.key?(:consumed)
|
502
|
+
@remaining = args[:remaining] if args.key?(:remaining)
|
503
|
+
end
|
504
|
+
end
|
505
|
+
|
506
|
+
# Access report data for each row.
|
507
|
+
class GoogleAnalyticsAdminV1alphaAccessRow
|
508
|
+
include Google::Apis::Core::Hashable
|
509
|
+
|
510
|
+
# List of dimension values. These values are in the same order as specified in
|
511
|
+
# the request.
|
512
|
+
# Corresponds to the JSON property `dimensionValues`
|
513
|
+
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessDimensionValue>]
|
514
|
+
attr_accessor :dimension_values
|
515
|
+
|
516
|
+
# List of metric values. These values are in the same order as specified in the
|
517
|
+
# request.
|
518
|
+
# Corresponds to the JSON property `metricValues`
|
519
|
+
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessMetricValue>]
|
520
|
+
attr_accessor :metric_values
|
521
|
+
|
522
|
+
def initialize(**args)
|
523
|
+
update!(**args)
|
524
|
+
end
|
525
|
+
|
526
|
+
# Update properties of this object
|
527
|
+
def update!(**args)
|
528
|
+
@dimension_values = args[:dimension_values] if args.key?(:dimension_values)
|
529
|
+
@metric_values = args[:metric_values] if args.key?(:metric_values)
|
530
|
+
end
|
531
|
+
end
|
532
|
+
|
533
|
+
# The filter for strings.
|
534
|
+
class GoogleAnalyticsAdminV1alphaAccessStringFilter
|
535
|
+
include Google::Apis::Core::Hashable
|
536
|
+
|
537
|
+
# If true, the string value is case sensitive.
|
538
|
+
# Corresponds to the JSON property `caseSensitive`
|
539
|
+
# @return [Boolean]
|
540
|
+
attr_accessor :case_sensitive
|
541
|
+
alias_method :case_sensitive?, :case_sensitive
|
542
|
+
|
543
|
+
# The match type for this filter.
|
544
|
+
# Corresponds to the JSON property `matchType`
|
545
|
+
# @return [String]
|
546
|
+
attr_accessor :match_type
|
547
|
+
|
548
|
+
# The string value used for the matching.
|
549
|
+
# Corresponds to the JSON property `value`
|
550
|
+
# @return [String]
|
551
|
+
attr_accessor :value
|
552
|
+
|
553
|
+
def initialize(**args)
|
554
|
+
update!(**args)
|
555
|
+
end
|
556
|
+
|
557
|
+
# Update properties of this object
|
558
|
+
def update!(**args)
|
559
|
+
@case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive)
|
560
|
+
@match_type = args[:match_type] if args.key?(:match_type)
|
561
|
+
@value = args[:value] if args.key?(:value)
|
562
|
+
end
|
563
|
+
end
|
564
|
+
|
25
565
|
# A resource message representing a Google Analytics account.
|
26
566
|
class GoogleAnalyticsAdminV1alphaAccount
|
27
567
|
include Google::Apis::Core::Hashable
|
28
568
|
|
29
|
-
# Output only. Time when this account was originally created.
|
30
|
-
# Corresponds to the JSON property `createTime`
|
31
|
-
# @return [String]
|
32
|
-
attr_accessor :create_time
|
569
|
+
# Output only. Time when this account was originally created.
|
570
|
+
# Corresponds to the JSON property `createTime`
|
571
|
+
# @return [String]
|
572
|
+
attr_accessor :create_time
|
573
|
+
|
574
|
+
# Output only. Indicates whether this Account is soft-deleted or not. Deleted
|
575
|
+
# accounts are excluded from List results unless specifically requested.
|
576
|
+
# Corresponds to the JSON property `deleted`
|
577
|
+
# @return [Boolean]
|
578
|
+
attr_accessor :deleted
|
579
|
+
alias_method :deleted?, :deleted
|
580
|
+
|
581
|
+
# Required. Human-readable display name for this account.
|
582
|
+
# Corresponds to the JSON property `displayName`
|
583
|
+
# @return [String]
|
584
|
+
attr_accessor :display_name
|
585
|
+
|
586
|
+
# Output only. Resource name of this account. Format: accounts/`account` Example:
|
587
|
+
# "accounts/100"
|
588
|
+
# Corresponds to the JSON property `name`
|
589
|
+
# @return [String]
|
590
|
+
attr_accessor :name
|
591
|
+
|
592
|
+
# Country of business. Must be a Unicode CLDR region code.
|
593
|
+
# Corresponds to the JSON property `regionCode`
|
594
|
+
# @return [String]
|
595
|
+
attr_accessor :region_code
|
596
|
+
|
597
|
+
# Output only. Time when account payload fields were last updated.
|
598
|
+
# Corresponds to the JSON property `updateTime`
|
599
|
+
# @return [String]
|
600
|
+
attr_accessor :update_time
|
601
|
+
|
602
|
+
def initialize(**args)
|
603
|
+
update!(**args)
|
604
|
+
end
|
605
|
+
|
606
|
+
# Update properties of this object
|
607
|
+
def update!(**args)
|
608
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
609
|
+
@deleted = args[:deleted] if args.key?(:deleted)
|
610
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
611
|
+
@name = args[:name] if args.key?(:name)
|
612
|
+
@region_code = args[:region_code] if args.key?(:region_code)
|
613
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
614
|
+
end
|
615
|
+
end
|
616
|
+
|
617
|
+
# A virtual resource representing an overview of an account and all its child
|
618
|
+
# GA4 properties.
|
619
|
+
class GoogleAnalyticsAdminV1alphaAccountSummary
|
620
|
+
include Google::Apis::Core::Hashable
|
621
|
+
|
622
|
+
# Resource name of account referred to by this account summary Format: accounts/`
|
623
|
+
# account_id` Example: "accounts/1000"
|
624
|
+
# Corresponds to the JSON property `account`
|
625
|
+
# @return [String]
|
626
|
+
attr_accessor :account
|
627
|
+
|
628
|
+
# Display name for the account referred to in this account summary.
|
629
|
+
# Corresponds to the JSON property `displayName`
|
630
|
+
# @return [String]
|
631
|
+
attr_accessor :display_name
|
632
|
+
|
633
|
+
# Resource name for this account summary. Format: accountSummaries/`account_id`
|
634
|
+
# Example: "accountSummaries/1000"
|
635
|
+
# Corresponds to the JSON property `name`
|
636
|
+
# @return [String]
|
637
|
+
attr_accessor :name
|
638
|
+
|
639
|
+
# List of summaries for child accounts of this account.
|
640
|
+
# Corresponds to the JSON property `propertySummaries`
|
641
|
+
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaPropertySummary>]
|
642
|
+
attr_accessor :property_summaries
|
643
|
+
|
644
|
+
def initialize(**args)
|
645
|
+
update!(**args)
|
646
|
+
end
|
647
|
+
|
648
|
+
# Update properties of this object
|
649
|
+
def update!(**args)
|
650
|
+
@account = args[:account] if args.key?(:account)
|
651
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
652
|
+
@name = args[:name] if args.key?(:name)
|
653
|
+
@property_summaries = args[:property_summaries] if args.key?(:property_summaries)
|
654
|
+
end
|
655
|
+
end
|
656
|
+
|
657
|
+
# Request message for AcknowledgeUserDataCollection RPC.
|
658
|
+
class GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionRequest
|
659
|
+
include Google::Apis::Core::Hashable
|
660
|
+
|
661
|
+
# Required. An acknowledgement that the caller of this method understands the
|
662
|
+
# terms of user data collection. This field must contain the exact value: "I
|
663
|
+
# acknowledge that I have the necessary privacy disclosures and rights from my
|
664
|
+
# end users for the collection and processing of their data, including the
|
665
|
+
# association of such data with the visitation information Google Analytics
|
666
|
+
# collects from my site and/or app property."
|
667
|
+
# Corresponds to the JSON property `acknowledgement`
|
668
|
+
# @return [String]
|
669
|
+
attr_accessor :acknowledgement
|
670
|
+
|
671
|
+
def initialize(**args)
|
672
|
+
update!(**args)
|
673
|
+
end
|
674
|
+
|
675
|
+
# Update properties of this object
|
676
|
+
def update!(**args)
|
677
|
+
@acknowledgement = args[:acknowledgement] if args.key?(:acknowledgement)
|
678
|
+
end
|
679
|
+
end
|
680
|
+
|
681
|
+
# Response message for AcknowledgeUserDataCollection RPC.
|
682
|
+
class GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionResponse
|
683
|
+
include Google::Apis::Core::Hashable
|
684
|
+
|
685
|
+
def initialize(**args)
|
686
|
+
update!(**args)
|
687
|
+
end
|
688
|
+
|
689
|
+
# Update properties of this object
|
690
|
+
def update!(**args)
|
691
|
+
end
|
692
|
+
end
|
693
|
+
|
694
|
+
# Request message for ApproveDisplayVideo360AdvertiserLinkProposal RPC.
|
695
|
+
class GoogleAnalyticsAdminV1alphaApproveDisplayVideo360AdvertiserLinkProposalRequest
|
696
|
+
include Google::Apis::Core::Hashable
|
697
|
+
|
698
|
+
def initialize(**args)
|
699
|
+
update!(**args)
|
700
|
+
end
|
701
|
+
|
702
|
+
# Update properties of this object
|
703
|
+
def update!(**args)
|
704
|
+
end
|
705
|
+
end
|
706
|
+
|
707
|
+
# Response message for ApproveDisplayVideo360AdvertiserLinkProposal RPC.
|
708
|
+
class GoogleAnalyticsAdminV1alphaApproveDisplayVideo360AdvertiserLinkProposalResponse
|
709
|
+
include Google::Apis::Core::Hashable
|
710
|
+
|
711
|
+
# A link between a GA4 property and a Display & Video 360 advertiser.
|
712
|
+
# Corresponds to the JSON property `displayVideo360AdvertiserLink`
|
713
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink]
|
714
|
+
attr_accessor :display_video360_advertiser_link
|
715
|
+
|
716
|
+
def initialize(**args)
|
717
|
+
update!(**args)
|
718
|
+
end
|
719
|
+
|
720
|
+
# Update properties of this object
|
721
|
+
def update!(**args)
|
722
|
+
@display_video360_advertiser_link = args[:display_video360_advertiser_link] if args.key?(:display_video360_advertiser_link)
|
723
|
+
end
|
724
|
+
end
|
725
|
+
|
726
|
+
# Request message for ArchiveAudience RPC.
|
727
|
+
class GoogleAnalyticsAdminV1alphaArchiveAudienceRequest
|
728
|
+
include Google::Apis::Core::Hashable
|
729
|
+
|
730
|
+
def initialize(**args)
|
731
|
+
update!(**args)
|
732
|
+
end
|
733
|
+
|
734
|
+
# Update properties of this object
|
735
|
+
def update!(**args)
|
736
|
+
end
|
737
|
+
end
|
738
|
+
|
739
|
+
# Request message for ArchiveCustomDimension RPC.
|
740
|
+
class GoogleAnalyticsAdminV1alphaArchiveCustomDimensionRequest
|
741
|
+
include Google::Apis::Core::Hashable
|
742
|
+
|
743
|
+
def initialize(**args)
|
744
|
+
update!(**args)
|
745
|
+
end
|
746
|
+
|
747
|
+
# Update properties of this object
|
748
|
+
def update!(**args)
|
749
|
+
end
|
750
|
+
end
|
751
|
+
|
752
|
+
# Request message for ArchiveCustomMetric RPC.
|
753
|
+
class GoogleAnalyticsAdminV1alphaArchiveCustomMetricRequest
|
754
|
+
include Google::Apis::Core::Hashable
|
755
|
+
|
756
|
+
def initialize(**args)
|
757
|
+
update!(**args)
|
758
|
+
end
|
759
|
+
|
760
|
+
# Update properties of this object
|
761
|
+
def update!(**args)
|
762
|
+
end
|
763
|
+
end
|
764
|
+
|
765
|
+
# The attribution settings used for a given property. This is a singleton
|
766
|
+
# resource.
|
767
|
+
class GoogleAnalyticsAdminV1alphaAttributionSettings
|
768
|
+
include Google::Apis::Core::Hashable
|
769
|
+
|
770
|
+
# Required. The lookback window configuration for acquisition conversion events.
|
771
|
+
# The default window size is 30 days.
|
772
|
+
# Corresponds to the JSON property `acquisitionConversionEventLookbackWindow`
|
773
|
+
# @return [String]
|
774
|
+
attr_accessor :acquisition_conversion_event_lookback_window
|
775
|
+
|
776
|
+
# Output only. Resource name of this attribution settings resource. Format:
|
777
|
+
# properties/`property_id`/attributionSettings Example: "properties/1000/
|
778
|
+
# attributionSettings"
|
779
|
+
# Corresponds to the JSON property `name`
|
780
|
+
# @return [String]
|
781
|
+
attr_accessor :name
|
782
|
+
|
783
|
+
# Required. The lookback window for all other, non-acquisition conversion events.
|
784
|
+
# The default window size is 90 days.
|
785
|
+
# Corresponds to the JSON property `otherConversionEventLookbackWindow`
|
786
|
+
# @return [String]
|
787
|
+
attr_accessor :other_conversion_event_lookback_window
|
788
|
+
|
789
|
+
# Required. The reporting attribution model used to calculate conversion credit
|
790
|
+
# in this property's reports. Changing the attribution model will apply to both
|
791
|
+
# historical and future data. These changes will be reflected in reports with
|
792
|
+
# conversion and revenue data. User and session data will be unaffected.
|
793
|
+
# Corresponds to the JSON property `reportingAttributionModel`
|
794
|
+
# @return [String]
|
795
|
+
attr_accessor :reporting_attribution_model
|
796
|
+
|
797
|
+
def initialize(**args)
|
798
|
+
update!(**args)
|
799
|
+
end
|
800
|
+
|
801
|
+
# Update properties of this object
|
802
|
+
def update!(**args)
|
803
|
+
@acquisition_conversion_event_lookback_window = args[:acquisition_conversion_event_lookback_window] if args.key?(:acquisition_conversion_event_lookback_window)
|
804
|
+
@name = args[:name] if args.key?(:name)
|
805
|
+
@other_conversion_event_lookback_window = args[:other_conversion_event_lookback_window] if args.key?(:other_conversion_event_lookback_window)
|
806
|
+
@reporting_attribution_model = args[:reporting_attribution_model] if args.key?(:reporting_attribution_model)
|
807
|
+
end
|
808
|
+
end
|
809
|
+
|
810
|
+
# A resource message representing a GA4 Audience.
|
811
|
+
class GoogleAnalyticsAdminV1alphaAudience
|
812
|
+
include Google::Apis::Core::Hashable
|
813
|
+
|
814
|
+
# Output only. It is automatically set by GA to false if this is an NPA Audience
|
815
|
+
# and is excluded from ads personalization.
|
816
|
+
# Corresponds to the JSON property `adsPersonalizationEnabled`
|
817
|
+
# @return [Boolean]
|
818
|
+
attr_accessor :ads_personalization_enabled
|
819
|
+
alias_method :ads_personalization_enabled?, :ads_personalization_enabled
|
820
|
+
|
821
|
+
# Required. The description of the Audience.
|
822
|
+
# Corresponds to the JSON property `description`
|
823
|
+
# @return [String]
|
824
|
+
attr_accessor :description
|
825
|
+
|
826
|
+
# Required. The display name of the Audience.
|
827
|
+
# Corresponds to the JSON property `displayName`
|
828
|
+
# @return [String]
|
829
|
+
attr_accessor :display_name
|
830
|
+
|
831
|
+
# Specifies an event to log when a user joins the Audience.
|
832
|
+
# Corresponds to the JSON property `eventTrigger`
|
833
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceEventTrigger]
|
834
|
+
attr_accessor :event_trigger
|
835
|
+
|
836
|
+
# Immutable. Specifies how long an exclusion lasts for users that meet the
|
837
|
+
# exclusion filter. It is applied to all EXCLUDE filter clauses and is ignored
|
838
|
+
# when there is no EXCLUDE filter clause in the Audience.
|
839
|
+
# Corresponds to the JSON property `exclusionDurationMode`
|
840
|
+
# @return [String]
|
841
|
+
attr_accessor :exclusion_duration_mode
|
842
|
+
|
843
|
+
# Required. Immutable. null Filter clauses that define the Audience. All clauses
|
844
|
+
# will be AND’ed together.
|
845
|
+
# Corresponds to the JSON property `filterClauses`
|
846
|
+
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterClause>]
|
847
|
+
attr_accessor :filter_clauses
|
848
|
+
|
849
|
+
# Required. Immutable. The duration a user should stay in an Audience. It cannot
|
850
|
+
# be set to more than 540 days.
|
851
|
+
# Corresponds to the JSON property `membershipDurationDays`
|
852
|
+
# @return [Fixnum]
|
853
|
+
attr_accessor :membership_duration_days
|
854
|
+
|
855
|
+
# Output only. The resource name for this Audience resource. Format: properties/`
|
856
|
+
# propertyId`/audiences/`audienceId`
|
857
|
+
# Corresponds to the JSON property `name`
|
858
|
+
# @return [String]
|
859
|
+
attr_accessor :name
|
860
|
+
|
861
|
+
def initialize(**args)
|
862
|
+
update!(**args)
|
863
|
+
end
|
864
|
+
|
865
|
+
# Update properties of this object
|
866
|
+
def update!(**args)
|
867
|
+
@ads_personalization_enabled = args[:ads_personalization_enabled] if args.key?(:ads_personalization_enabled)
|
868
|
+
@description = args[:description] if args.key?(:description)
|
869
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
870
|
+
@event_trigger = args[:event_trigger] if args.key?(:event_trigger)
|
871
|
+
@exclusion_duration_mode = args[:exclusion_duration_mode] if args.key?(:exclusion_duration_mode)
|
872
|
+
@filter_clauses = args[:filter_clauses] if args.key?(:filter_clauses)
|
873
|
+
@membership_duration_days = args[:membership_duration_days] if args.key?(:membership_duration_days)
|
874
|
+
@name = args[:name] if args.key?(:name)
|
875
|
+
end
|
876
|
+
end
|
877
|
+
|
878
|
+
# A specific filter for a single dimension or metric.
|
879
|
+
class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilter
|
880
|
+
include Google::Apis::Core::Hashable
|
881
|
+
|
882
|
+
# Optional. Indicates whether this filter needs dynamic evaluation or not. If
|
883
|
+
# set to true, users join the Audience if they ever met the condition (static
|
884
|
+
# evaluation). If unset or set to false, user evaluation for an Audience is
|
885
|
+
# dynamic; users are added to an Audience when they meet the conditions and then
|
886
|
+
# removed when they no longer meet them. This can only be set when Audience
|
887
|
+
# scope is ACROSS_ALL_SESSIONS.
|
888
|
+
# Corresponds to the JSON property `atAnyPointInTime`
|
889
|
+
# @return [Boolean]
|
890
|
+
attr_accessor :at_any_point_in_time
|
891
|
+
alias_method :at_any_point_in_time?, :at_any_point_in_time
|
892
|
+
|
893
|
+
# A filter for numeric or date values between certain values on a dimension or
|
894
|
+
# metric.
|
895
|
+
# Corresponds to the JSON property `betweenFilter`
|
896
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterBetweenFilter]
|
897
|
+
attr_accessor :between_filter
|
898
|
+
|
899
|
+
# Required. Immutable. The dimension name or metric name to filter.
|
900
|
+
# Corresponds to the JSON property `fieldName`
|
901
|
+
# @return [String]
|
902
|
+
attr_accessor :field_name
|
903
|
+
|
904
|
+
# Optional. If set, specifies the time window for which to evaluate data in
|
905
|
+
# number of days. If not set, then audience data is evaluated against lifetime
|
906
|
+
# data (i.e., infinite time window). For example, if set to 1 day, only the
|
907
|
+
# current day's data is evaluated. The reference point is the current day when
|
908
|
+
# at_any_point_in_time is unset or false. It can only be set when Audience scope
|
909
|
+
# is ACROSS_ALL_SESSIONS and cannot be greater than 60 days.
|
910
|
+
# Corresponds to the JSON property `inAnyNDayPeriod`
|
911
|
+
# @return [Fixnum]
|
912
|
+
attr_accessor :in_any_n_day_period
|
913
|
+
|
914
|
+
# A filter for a string dimension that matches a particular list of options.
|
915
|
+
# Corresponds to the JSON property `inListFilter`
|
916
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterInListFilter]
|
917
|
+
attr_accessor :in_list_filter
|
918
|
+
|
919
|
+
# A filter for numeric or date values on a dimension or metric.
|
920
|
+
# Corresponds to the JSON property `numericFilter`
|
921
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericFilter]
|
922
|
+
attr_accessor :numeric_filter
|
923
|
+
|
924
|
+
# A filter for a string-type dimension that matches a particular pattern.
|
925
|
+
# Corresponds to the JSON property `stringFilter`
|
926
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterStringFilter]
|
927
|
+
attr_accessor :string_filter
|
928
|
+
|
929
|
+
def initialize(**args)
|
930
|
+
update!(**args)
|
931
|
+
end
|
932
|
+
|
933
|
+
# Update properties of this object
|
934
|
+
def update!(**args)
|
935
|
+
@at_any_point_in_time = args[:at_any_point_in_time] if args.key?(:at_any_point_in_time)
|
936
|
+
@between_filter = args[:between_filter] if args.key?(:between_filter)
|
937
|
+
@field_name = args[:field_name] if args.key?(:field_name)
|
938
|
+
@in_any_n_day_period = args[:in_any_n_day_period] if args.key?(:in_any_n_day_period)
|
939
|
+
@in_list_filter = args[:in_list_filter] if args.key?(:in_list_filter)
|
940
|
+
@numeric_filter = args[:numeric_filter] if args.key?(:numeric_filter)
|
941
|
+
@string_filter = args[:string_filter] if args.key?(:string_filter)
|
942
|
+
end
|
943
|
+
end
|
944
|
+
|
945
|
+
# A filter for numeric or date values between certain values on a dimension or
|
946
|
+
# metric.
|
947
|
+
class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterBetweenFilter
|
948
|
+
include Google::Apis::Core::Hashable
|
949
|
+
|
950
|
+
# To represent a number.
|
951
|
+
# Corresponds to the JSON property `fromValue`
|
952
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue]
|
953
|
+
attr_accessor :from_value
|
954
|
+
|
955
|
+
# To represent a number.
|
956
|
+
# Corresponds to the JSON property `toValue`
|
957
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue]
|
958
|
+
attr_accessor :to_value
|
959
|
+
|
960
|
+
def initialize(**args)
|
961
|
+
update!(**args)
|
962
|
+
end
|
33
963
|
|
34
|
-
#
|
35
|
-
|
36
|
-
|
964
|
+
# Update properties of this object
|
965
|
+
def update!(**args)
|
966
|
+
@from_value = args[:from_value] if args.key?(:from_value)
|
967
|
+
@to_value = args[:to_value] if args.key?(:to_value)
|
968
|
+
end
|
969
|
+
end
|
970
|
+
|
971
|
+
# A filter for a string dimension that matches a particular list of options.
|
972
|
+
class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterInListFilter
|
973
|
+
include Google::Apis::Core::Hashable
|
974
|
+
|
975
|
+
# Optional. If true, the match is case-sensitive. If false, the match is case-
|
976
|
+
# insensitive.
|
977
|
+
# Corresponds to the JSON property `caseSensitive`
|
37
978
|
# @return [Boolean]
|
38
|
-
attr_accessor :
|
39
|
-
alias_method :
|
979
|
+
attr_accessor :case_sensitive
|
980
|
+
alias_method :case_sensitive?, :case_sensitive
|
40
981
|
|
41
|
-
# Required.
|
42
|
-
#
|
43
|
-
#
|
44
|
-
|
982
|
+
# Required. The list of possible string values to match against. Must be non-
|
983
|
+
# empty.
|
984
|
+
# Corresponds to the JSON property `values`
|
985
|
+
# @return [Array<String>]
|
986
|
+
attr_accessor :values
|
45
987
|
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
# @return [String]
|
50
|
-
attr_accessor :name
|
988
|
+
def initialize(**args)
|
989
|
+
update!(**args)
|
990
|
+
end
|
51
991
|
|
52
|
-
#
|
53
|
-
|
54
|
-
|
55
|
-
|
992
|
+
# Update properties of this object
|
993
|
+
def update!(**args)
|
994
|
+
@case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive)
|
995
|
+
@values = args[:values] if args.key?(:values)
|
996
|
+
end
|
997
|
+
end
|
56
998
|
|
57
|
-
|
58
|
-
|
999
|
+
# A filter for numeric or date values on a dimension or metric.
|
1000
|
+
class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericFilter
|
1001
|
+
include Google::Apis::Core::Hashable
|
1002
|
+
|
1003
|
+
# Required. The operation applied to a numeric filter.
|
1004
|
+
# Corresponds to the JSON property `operation`
|
59
1005
|
# @return [String]
|
60
|
-
attr_accessor :
|
1006
|
+
attr_accessor :operation
|
1007
|
+
|
1008
|
+
# To represent a number.
|
1009
|
+
# Corresponds to the JSON property `value`
|
1010
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue]
|
1011
|
+
attr_accessor :value
|
61
1012
|
|
62
1013
|
def initialize(**args)
|
63
1014
|
update!(**args)
|
@@ -65,41 +1016,56 @@ module Google
|
|
65
1016
|
|
66
1017
|
# Update properties of this object
|
67
1018
|
def update!(**args)
|
68
|
-
@
|
69
|
-
@
|
70
|
-
@display_name = args[:display_name] if args.key?(:display_name)
|
71
|
-
@name = args[:name] if args.key?(:name)
|
72
|
-
@region_code = args[:region_code] if args.key?(:region_code)
|
73
|
-
@update_time = args[:update_time] if args.key?(:update_time)
|
1019
|
+
@operation = args[:operation] if args.key?(:operation)
|
1020
|
+
@value = args[:value] if args.key?(:value)
|
74
1021
|
end
|
75
1022
|
end
|
76
1023
|
|
77
|
-
#
|
78
|
-
|
79
|
-
class GoogleAnalyticsAdminV1alphaAccountSummary
|
1024
|
+
# To represent a number.
|
1025
|
+
class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue
|
80
1026
|
include Google::Apis::Core::Hashable
|
81
1027
|
|
82
|
-
#
|
83
|
-
#
|
84
|
-
#
|
85
|
-
|
86
|
-
attr_accessor :account
|
1028
|
+
# Double value.
|
1029
|
+
# Corresponds to the JSON property `doubleValue`
|
1030
|
+
# @return [Float]
|
1031
|
+
attr_accessor :double_value
|
87
1032
|
|
88
|
-
#
|
89
|
-
# Corresponds to the JSON property `
|
90
|
-
# @return [
|
91
|
-
attr_accessor :
|
1033
|
+
# Integer value.
|
1034
|
+
# Corresponds to the JSON property `int64Value`
|
1035
|
+
# @return [Fixnum]
|
1036
|
+
attr_accessor :int64_value
|
92
1037
|
|
93
|
-
|
94
|
-
|
95
|
-
|
1038
|
+
def initialize(**args)
|
1039
|
+
update!(**args)
|
1040
|
+
end
|
1041
|
+
|
1042
|
+
# Update properties of this object
|
1043
|
+
def update!(**args)
|
1044
|
+
@double_value = args[:double_value] if args.key?(:double_value)
|
1045
|
+
@int64_value = args[:int64_value] if args.key?(:int64_value)
|
1046
|
+
end
|
1047
|
+
end
|
1048
|
+
|
1049
|
+
# A filter for a string-type dimension that matches a particular pattern.
|
1050
|
+
class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterStringFilter
|
1051
|
+
include Google::Apis::Core::Hashable
|
1052
|
+
|
1053
|
+
# Optional. If true, the match is case-sensitive. If false, the match is case-
|
1054
|
+
# insensitive.
|
1055
|
+
# Corresponds to the JSON property `caseSensitive`
|
1056
|
+
# @return [Boolean]
|
1057
|
+
attr_accessor :case_sensitive
|
1058
|
+
alias_method :case_sensitive?, :case_sensitive
|
1059
|
+
|
1060
|
+
# Required. The match type for the string filter.
|
1061
|
+
# Corresponds to the JSON property `matchType`
|
96
1062
|
# @return [String]
|
97
|
-
attr_accessor :
|
1063
|
+
attr_accessor :match_type
|
98
1064
|
|
99
|
-
#
|
100
|
-
# Corresponds to the JSON property `
|
101
|
-
# @return [
|
102
|
-
attr_accessor :
|
1065
|
+
# Required. The string value to be matched against.
|
1066
|
+
# Corresponds to the JSON property `value`
|
1067
|
+
# @return [String]
|
1068
|
+
attr_accessor :value
|
103
1069
|
|
104
1070
|
def initialize(**args)
|
105
1071
|
update!(**args)
|
@@ -107,26 +1073,27 @@ module Google
|
|
107
1073
|
|
108
1074
|
# Update properties of this object
|
109
1075
|
def update!(**args)
|
110
|
-
@
|
111
|
-
@
|
112
|
-
@
|
113
|
-
@property_summaries = args[:property_summaries] if args.key?(:property_summaries)
|
1076
|
+
@case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive)
|
1077
|
+
@match_type = args[:match_type] if args.key?(:match_type)
|
1078
|
+
@value = args[:value] if args.key?(:value)
|
114
1079
|
end
|
115
1080
|
end
|
116
1081
|
|
117
|
-
#
|
118
|
-
|
1082
|
+
# A filter that matches events of a single event name. If an event parameter is
|
1083
|
+
# specified, only the subset of events that match both the single event name and
|
1084
|
+
# the parameter filter expressions match this event filter.
|
1085
|
+
class GoogleAnalyticsAdminV1alphaAudienceEventFilter
|
119
1086
|
include Google::Apis::Core::Hashable
|
120
1087
|
|
121
|
-
# Required.
|
122
|
-
#
|
123
|
-
# acknowledge that I have the necessary privacy disclosures and rights from my
|
124
|
-
# end users for the collection and processing of their data, including the
|
125
|
-
# association of such data with the visitation information Google Analytics
|
126
|
-
# collects from my site and/or app property."
|
127
|
-
# Corresponds to the JSON property `acknowledgement`
|
1088
|
+
# Required. Immutable. The name of the event to match against.
|
1089
|
+
# Corresponds to the JSON property `eventName`
|
128
1090
|
# @return [String]
|
129
|
-
attr_accessor :
|
1091
|
+
attr_accessor :event_name
|
1092
|
+
|
1093
|
+
# A logical expression of Audience dimension, metric, or event filters.
|
1094
|
+
# Corresponds to the JSON property `eventParameterFilterExpression`
|
1095
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpression]
|
1096
|
+
attr_accessor :event_parameter_filter_expression
|
130
1097
|
|
131
1098
|
def initialize(**args)
|
132
1099
|
update!(**args)
|
@@ -134,44 +1101,102 @@ module Google
|
|
134
1101
|
|
135
1102
|
# Update properties of this object
|
136
1103
|
def update!(**args)
|
137
|
-
@
|
1104
|
+
@event_name = args[:event_name] if args.key?(:event_name)
|
1105
|
+
@event_parameter_filter_expression = args[:event_parameter_filter_expression] if args.key?(:event_parameter_filter_expression)
|
138
1106
|
end
|
139
1107
|
end
|
140
1108
|
|
141
|
-
#
|
142
|
-
class
|
1109
|
+
# Specifies an event to log when a user joins the Audience.
|
1110
|
+
class GoogleAnalyticsAdminV1alphaAudienceEventTrigger
|
143
1111
|
include Google::Apis::Core::Hashable
|
144
1112
|
|
1113
|
+
# Required. The event name that will be logged.
|
1114
|
+
# Corresponds to the JSON property `eventName`
|
1115
|
+
# @return [String]
|
1116
|
+
attr_accessor :event_name
|
1117
|
+
|
1118
|
+
# Required. When to log the event.
|
1119
|
+
# Corresponds to the JSON property `logCondition`
|
1120
|
+
# @return [String]
|
1121
|
+
attr_accessor :log_condition
|
1122
|
+
|
145
1123
|
def initialize(**args)
|
146
1124
|
update!(**args)
|
147
1125
|
end
|
148
1126
|
|
149
1127
|
# Update properties of this object
|
150
1128
|
def update!(**args)
|
1129
|
+
@event_name = args[:event_name] if args.key?(:event_name)
|
1130
|
+
@log_condition = args[:log_condition] if args.key?(:log_condition)
|
151
1131
|
end
|
152
1132
|
end
|
153
1133
|
|
154
|
-
#
|
155
|
-
|
1134
|
+
# A clause for defining either a simple or sequence filter. A filter can be
|
1135
|
+
# inclusive (i.e., users satisfying the filter clause are included in the
|
1136
|
+
# Audience) or exclusive (i.e., users satisfying the filter clause are excluded
|
1137
|
+
# from the Audience).
|
1138
|
+
class GoogleAnalyticsAdminV1alphaAudienceFilterClause
|
156
1139
|
include Google::Apis::Core::Hashable
|
157
1140
|
|
1141
|
+
# Required. Specifies whether this is an include or exclude filter clause.
|
1142
|
+
# Corresponds to the JSON property `clauseType`
|
1143
|
+
# @return [String]
|
1144
|
+
attr_accessor :clause_type
|
1145
|
+
|
1146
|
+
# Defines filters that must occur in a specific order for the user to be a
|
1147
|
+
# member of the Audience.
|
1148
|
+
# Corresponds to the JSON property `sequenceFilter`
|
1149
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceSequenceFilter]
|
1150
|
+
attr_accessor :sequence_filter
|
1151
|
+
|
1152
|
+
# Defines a simple filter that a user must satisfy to be a member of the
|
1153
|
+
# Audience.
|
1154
|
+
# Corresponds to the JSON property `simpleFilter`
|
1155
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceSimpleFilter]
|
1156
|
+
attr_accessor :simple_filter
|
1157
|
+
|
158
1158
|
def initialize(**args)
|
159
1159
|
update!(**args)
|
160
1160
|
end
|
161
1161
|
|
162
1162
|
# Update properties of this object
|
163
1163
|
def update!(**args)
|
1164
|
+
@clause_type = args[:clause_type] if args.key?(:clause_type)
|
1165
|
+
@sequence_filter = args[:sequence_filter] if args.key?(:sequence_filter)
|
1166
|
+
@simple_filter = args[:simple_filter] if args.key?(:simple_filter)
|
164
1167
|
end
|
165
1168
|
end
|
166
1169
|
|
167
|
-
#
|
168
|
-
class
|
1170
|
+
# A logical expression of Audience dimension, metric, or event filters.
|
1171
|
+
class GoogleAnalyticsAdminV1alphaAudienceFilterExpression
|
169
1172
|
include Google::Apis::Core::Hashable
|
170
1173
|
|
171
|
-
# A
|
172
|
-
# Corresponds to the JSON property `
|
173
|
-
# @return [Google::Apis::AnalyticsadminV1alpha::
|
174
|
-
attr_accessor :
|
1174
|
+
# A list of Audience filter expressions.
|
1175
|
+
# Corresponds to the JSON property `andGroup`
|
1176
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpressionList]
|
1177
|
+
attr_accessor :and_group
|
1178
|
+
|
1179
|
+
# A specific filter for a single dimension or metric.
|
1180
|
+
# Corresponds to the JSON property `dimensionOrMetricFilter`
|
1181
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilter]
|
1182
|
+
attr_accessor :dimension_or_metric_filter
|
1183
|
+
|
1184
|
+
# A filter that matches events of a single event name. If an event parameter is
|
1185
|
+
# specified, only the subset of events that match both the single event name and
|
1186
|
+
# the parameter filter expressions match this event filter.
|
1187
|
+
# Corresponds to the JSON property `eventFilter`
|
1188
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceEventFilter]
|
1189
|
+
attr_accessor :event_filter
|
1190
|
+
|
1191
|
+
# A logical expression of Audience dimension, metric, or event filters.
|
1192
|
+
# Corresponds to the JSON property `notExpression`
|
1193
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpression]
|
1194
|
+
attr_accessor :not_expression
|
1195
|
+
|
1196
|
+
# A list of Audience filter expressions.
|
1197
|
+
# Corresponds to the JSON property `orGroup`
|
1198
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpressionList]
|
1199
|
+
attr_accessor :or_group
|
175
1200
|
|
176
1201
|
def initialize(**args)
|
177
1202
|
update!(**args)
|
@@ -179,67 +1204,125 @@ module Google
|
|
179
1204
|
|
180
1205
|
# Update properties of this object
|
181
1206
|
def update!(**args)
|
182
|
-
@
|
1207
|
+
@and_group = args[:and_group] if args.key?(:and_group)
|
1208
|
+
@dimension_or_metric_filter = args[:dimension_or_metric_filter] if args.key?(:dimension_or_metric_filter)
|
1209
|
+
@event_filter = args[:event_filter] if args.key?(:event_filter)
|
1210
|
+
@not_expression = args[:not_expression] if args.key?(:not_expression)
|
1211
|
+
@or_group = args[:or_group] if args.key?(:or_group)
|
183
1212
|
end
|
184
1213
|
end
|
185
1214
|
|
186
|
-
#
|
187
|
-
class
|
1215
|
+
# A list of Audience filter expressions.
|
1216
|
+
class GoogleAnalyticsAdminV1alphaAudienceFilterExpressionList
|
188
1217
|
include Google::Apis::Core::Hashable
|
189
1218
|
|
1219
|
+
# A list of Audience filter expressions.
|
1220
|
+
# Corresponds to the JSON property `filterExpressions`
|
1221
|
+
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpression>]
|
1222
|
+
attr_accessor :filter_expressions
|
1223
|
+
|
190
1224
|
def initialize(**args)
|
191
1225
|
update!(**args)
|
192
1226
|
end
|
193
1227
|
|
194
1228
|
# Update properties of this object
|
195
1229
|
def update!(**args)
|
1230
|
+
@filter_expressions = args[:filter_expressions] if args.key?(:filter_expressions)
|
196
1231
|
end
|
197
1232
|
end
|
198
1233
|
|
199
|
-
#
|
200
|
-
|
1234
|
+
# Defines filters that must occur in a specific order for the user to be a
|
1235
|
+
# member of the Audience.
|
1236
|
+
class GoogleAnalyticsAdminV1alphaAudienceSequenceFilter
|
201
1237
|
include Google::Apis::Core::Hashable
|
202
1238
|
|
1239
|
+
# Required. Immutable. Specifies the scope for this filter.
|
1240
|
+
# Corresponds to the JSON property `scope`
|
1241
|
+
# @return [String]
|
1242
|
+
attr_accessor :scope
|
1243
|
+
|
1244
|
+
# Optional. Defines the time period in which the whole sequence must occur.
|
1245
|
+
# Corresponds to the JSON property `sequenceMaximumDuration`
|
1246
|
+
# @return [String]
|
1247
|
+
attr_accessor :sequence_maximum_duration
|
1248
|
+
|
1249
|
+
# Required. An ordered sequence of steps. A user must complete each step in
|
1250
|
+
# order to join the sequence filter.
|
1251
|
+
# Corresponds to the JSON property `sequenceSteps`
|
1252
|
+
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceSequenceFilterAudienceSequenceStep>]
|
1253
|
+
attr_accessor :sequence_steps
|
1254
|
+
|
203
1255
|
def initialize(**args)
|
204
1256
|
update!(**args)
|
205
1257
|
end
|
206
1258
|
|
207
1259
|
# Update properties of this object
|
208
1260
|
def update!(**args)
|
1261
|
+
@scope = args[:scope] if args.key?(:scope)
|
1262
|
+
@sequence_maximum_duration = args[:sequence_maximum_duration] if args.key?(:sequence_maximum_duration)
|
1263
|
+
@sequence_steps = args[:sequence_steps] if args.key?(:sequence_steps)
|
209
1264
|
end
|
210
1265
|
end
|
211
1266
|
|
212
|
-
#
|
213
|
-
#
|
214
|
-
class
|
1267
|
+
# A condition that must occur in the specified step order for this user to match
|
1268
|
+
# the sequence.
|
1269
|
+
class GoogleAnalyticsAdminV1alphaAudienceSequenceFilterAudienceSequenceStep
|
215
1270
|
include Google::Apis::Core::Hashable
|
216
1271
|
|
217
|
-
#
|
218
|
-
#
|
219
|
-
#
|
1272
|
+
# Optional. When set, this step must be satisfied within the constraint_duration
|
1273
|
+
# of the previous step (i.e., t[i] - t[i-1] <= constraint_duration). If not set,
|
1274
|
+
# there is no duration requirement (the duration is effectively unlimited). It
|
1275
|
+
# is ignored for the first step.
|
1276
|
+
# Corresponds to the JSON property `constraintDuration`
|
220
1277
|
# @return [String]
|
221
|
-
attr_accessor :
|
1278
|
+
attr_accessor :constraint_duration
|
222
1279
|
|
223
|
-
#
|
224
|
-
#
|
225
|
-
#
|
226
|
-
|
227
|
-
# @return [String]
|
228
|
-
attr_accessor :name
|
1280
|
+
# A logical expression of Audience dimension, metric, or event filters.
|
1281
|
+
# Corresponds to the JSON property `filterExpression`
|
1282
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpression]
|
1283
|
+
attr_accessor :filter_expression
|
229
1284
|
|
230
|
-
#
|
231
|
-
#
|
232
|
-
#
|
1285
|
+
# Optional. If true, the event satisfying this step must be the very next event
|
1286
|
+
# after the event satisfying the last step. If unset or false, this step
|
1287
|
+
# indirectly follows the prior step; for example, there may be events between
|
1288
|
+
# the prior step and this step. It is ignored for the first step.
|
1289
|
+
# Corresponds to the JSON property `immediatelyFollows`
|
1290
|
+
# @return [Boolean]
|
1291
|
+
attr_accessor :immediately_follows
|
1292
|
+
alias_method :immediately_follows?, :immediately_follows
|
1293
|
+
|
1294
|
+
# Required. Immutable. Specifies the scope for this step.
|
1295
|
+
# Corresponds to the JSON property `scope`
|
233
1296
|
# @return [String]
|
234
|
-
attr_accessor :
|
1297
|
+
attr_accessor :scope
|
235
1298
|
|
236
|
-
|
237
|
-
|
238
|
-
|
239
|
-
|
240
|
-
#
|
1299
|
+
def initialize(**args)
|
1300
|
+
update!(**args)
|
1301
|
+
end
|
1302
|
+
|
1303
|
+
# Update properties of this object
|
1304
|
+
def update!(**args)
|
1305
|
+
@constraint_duration = args[:constraint_duration] if args.key?(:constraint_duration)
|
1306
|
+
@filter_expression = args[:filter_expression] if args.key?(:filter_expression)
|
1307
|
+
@immediately_follows = args[:immediately_follows] if args.key?(:immediately_follows)
|
1308
|
+
@scope = args[:scope] if args.key?(:scope)
|
1309
|
+
end
|
1310
|
+
end
|
1311
|
+
|
1312
|
+
# Defines a simple filter that a user must satisfy to be a member of the
|
1313
|
+
# Audience.
|
1314
|
+
class GoogleAnalyticsAdminV1alphaAudienceSimpleFilter
|
1315
|
+
include Google::Apis::Core::Hashable
|
1316
|
+
|
1317
|
+
# A logical expression of Audience dimension, metric, or event filters.
|
1318
|
+
# Corresponds to the JSON property `filterExpression`
|
1319
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpression]
|
1320
|
+
attr_accessor :filter_expression
|
1321
|
+
|
1322
|
+
# Required. Immutable. Specifies the scope for this filter.
|
1323
|
+
# Corresponds to the JSON property `scope`
|
241
1324
|
# @return [String]
|
242
|
-
attr_accessor :
|
1325
|
+
attr_accessor :scope
|
243
1326
|
|
244
1327
|
def initialize(**args)
|
245
1328
|
update!(**args)
|
@@ -247,10 +1330,8 @@ module Google
|
|
247
1330
|
|
248
1331
|
# Update properties of this object
|
249
1332
|
def update!(**args)
|
250
|
-
@
|
251
|
-
@
|
252
|
-
@other_conversion_event_lookback_window = args[:other_conversion_event_lookback_window] if args.key?(:other_conversion_event_lookback_window)
|
253
|
-
@reporting_attribution_model = args[:reporting_attribution_model] if args.key?(:reporting_attribution_model)
|
1333
|
+
@filter_expression = args[:filter_expression] if args.key?(:filter_expression)
|
1334
|
+
@scope = args[:scope] if args.key?(:scope)
|
254
1335
|
end
|
255
1336
|
end
|
256
1337
|
|
@@ -1552,6 +2633,32 @@ module Google
|
|
1552
2633
|
end
|
1553
2634
|
end
|
1554
2635
|
|
2636
|
+
# Response message for ListAudiences RPC.
|
2637
|
+
class GoogleAnalyticsAdminV1alphaListAudiencesResponse
|
2638
|
+
include Google::Apis::Core::Hashable
|
2639
|
+
|
2640
|
+
# List of Audiences.
|
2641
|
+
# Corresponds to the JSON property `audiences`
|
2642
|
+
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience>]
|
2643
|
+
attr_accessor :audiences
|
2644
|
+
|
2645
|
+
# A token, which can be sent as `page_token` to retrieve the next page. If this
|
2646
|
+
# field is omitted, there are no subsequent pages.
|
2647
|
+
# Corresponds to the JSON property `nextPageToken`
|
2648
|
+
# @return [String]
|
2649
|
+
attr_accessor :next_page_token
|
2650
|
+
|
2651
|
+
def initialize(**args)
|
2652
|
+
update!(**args)
|
2653
|
+
end
|
2654
|
+
|
2655
|
+
# Update properties of this object
|
2656
|
+
def update!(**args)
|
2657
|
+
@audiences = args[:audiences] if args.key?(:audiences)
|
2658
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
2659
|
+
end
|
2660
|
+
end
|
2661
|
+
|
1555
2662
|
# Response message for ListConversionEvents RPC.
|
1556
2663
|
class GoogleAnalyticsAdminV1alphaListConversionEventsResponse
|
1557
2664
|
include Google::Apis::Core::Hashable
|
@@ -1874,6 +2981,31 @@ module Google
|
|
1874
2981
|
end
|
1875
2982
|
end
|
1876
2983
|
|
2984
|
+
# To represent a number.
|
2985
|
+
class GoogleAnalyticsAdminV1alphaNumericValue
|
2986
|
+
include Google::Apis::Core::Hashable
|
2987
|
+
|
2988
|
+
# Double value
|
2989
|
+
# Corresponds to the JSON property `doubleValue`
|
2990
|
+
# @return [Float]
|
2991
|
+
attr_accessor :double_value
|
2992
|
+
|
2993
|
+
# Integer value
|
2994
|
+
# Corresponds to the JSON property `int64Value`
|
2995
|
+
# @return [Fixnum]
|
2996
|
+
attr_accessor :int64_value
|
2997
|
+
|
2998
|
+
def initialize(**args)
|
2999
|
+
update!(**args)
|
3000
|
+
end
|
3001
|
+
|
3002
|
+
# Update properties of this object
|
3003
|
+
def update!(**args)
|
3004
|
+
@double_value = args[:double_value] if args.key?(:double_value)
|
3005
|
+
@int64_value = args[:int64_value] if args.key?(:int64_value)
|
3006
|
+
end
|
3007
|
+
end
|
3008
|
+
|
1877
3009
|
# A resource message representing a Google Analytics GA4 property.
|
1878
3010
|
class GoogleAnalyticsAdminV1alphaProperty
|
1879
3011
|
include Google::Apis::Core::Hashable
|
@@ -2066,6 +3198,159 @@ module Google
|
|
2066
3198
|
end
|
2067
3199
|
end
|
2068
3200
|
|
3201
|
+
# The request for a Data Access Record Report.
|
3202
|
+
class GoogleAnalyticsAdminV1alphaRunAccessReportRequest
|
3203
|
+
include Google::Apis::Core::Hashable
|
3204
|
+
|
3205
|
+
# Date ranges of access records to read. If multiple date ranges are requested,
|
3206
|
+
# each response row will contain a zero based date range index. If two date
|
3207
|
+
# ranges overlap, the access records for the overlapping days is included in the
|
3208
|
+
# response rows for both date ranges. Requests are allowed up to 2 date ranges.
|
3209
|
+
# Corresponds to the JSON property `dateRanges`
|
3210
|
+
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessDateRange>]
|
3211
|
+
attr_accessor :date_ranges
|
3212
|
+
|
3213
|
+
# Expresses dimension or metric filters. The fields in the same expression need
|
3214
|
+
# to be either all dimensions or all metrics.
|
3215
|
+
# Corresponds to the JSON property `dimensionFilter`
|
3216
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessFilterExpression]
|
3217
|
+
attr_accessor :dimension_filter
|
3218
|
+
|
3219
|
+
# The dimensions requested and displayed in the response. Requests are allowed
|
3220
|
+
# up to 9 dimensions.
|
3221
|
+
# Corresponds to the JSON property `dimensions`
|
3222
|
+
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessDimension>]
|
3223
|
+
attr_accessor :dimensions
|
3224
|
+
|
3225
|
+
# The number of rows to return. If unspecified, 10,000 rows are returned. The
|
3226
|
+
# API returns a maximum of 100,000 rows per request, no matter how many you ask
|
3227
|
+
# for. `limit` must be positive. The API may return fewer rows than the
|
3228
|
+
# requested `limit`, if there aren't as many remaining rows as the `limit`. For
|
3229
|
+
# instance, there are fewer than 300 possible values for the dimension `country`,
|
3230
|
+
# so when reporting on only `country`, you can't get more than 300 rows, even
|
3231
|
+
# if you set `limit` to a higher value. To learn more about this pagination
|
3232
|
+
# parameter, see [Pagination](https://developers.google.com/analytics/devguides/
|
3233
|
+
# reporting/data/v1/basics#pagination).
|
3234
|
+
# Corresponds to the JSON property `limit`
|
3235
|
+
# @return [Fixnum]
|
3236
|
+
attr_accessor :limit
|
3237
|
+
|
3238
|
+
# Expresses dimension or metric filters. The fields in the same expression need
|
3239
|
+
# to be either all dimensions or all metrics.
|
3240
|
+
# Corresponds to the JSON property `metricFilter`
|
3241
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessFilterExpression]
|
3242
|
+
attr_accessor :metric_filter
|
3243
|
+
|
3244
|
+
# The metrics requested and displayed in the response. Requests are allowed up
|
3245
|
+
# to 10 metrics.
|
3246
|
+
# Corresponds to the JSON property `metrics`
|
3247
|
+
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessMetric>]
|
3248
|
+
attr_accessor :metrics
|
3249
|
+
|
3250
|
+
# The row count of the start row. The first row is counted as row 0. If offset
|
3251
|
+
# is unspecified, it is treated as 0. If offset is zero, then this method will
|
3252
|
+
# return the first page of results with `limit` entries. To learn more about
|
3253
|
+
# this pagination parameter, see [Pagination](https://developers.google.com/
|
3254
|
+
# analytics/devguides/reporting/data/v1/basics#pagination).
|
3255
|
+
# Corresponds to the JSON property `offset`
|
3256
|
+
# @return [Fixnum]
|
3257
|
+
attr_accessor :offset
|
3258
|
+
|
3259
|
+
# Specifies how rows are ordered in the response.
|
3260
|
+
# Corresponds to the JSON property `orderBys`
|
3261
|
+
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessOrderBy>]
|
3262
|
+
attr_accessor :order_bys
|
3263
|
+
|
3264
|
+
# Toggles whether to return the current state of this Analytics Property's quota.
|
3265
|
+
# Quota is returned in [AccessQuota](#AccessQuota).
|
3266
|
+
# Corresponds to the JSON property `returnEntityQuota`
|
3267
|
+
# @return [Boolean]
|
3268
|
+
attr_accessor :return_entity_quota
|
3269
|
+
alias_method :return_entity_quota?, :return_entity_quota
|
3270
|
+
|
3271
|
+
# This request's time zone if specified. If unspecified, the property's time
|
3272
|
+
# zone is used. The request's time zone is used to interpret the start & end
|
3273
|
+
# dates of the report. Formatted as strings from the IANA Time Zone database (
|
3274
|
+
# https://www.iana.org/time-zones); for example "America/New_York" or "Asia/
|
3275
|
+
# Tokyo".
|
3276
|
+
# Corresponds to the JSON property `timeZone`
|
3277
|
+
# @return [String]
|
3278
|
+
attr_accessor :time_zone
|
3279
|
+
|
3280
|
+
def initialize(**args)
|
3281
|
+
update!(**args)
|
3282
|
+
end
|
3283
|
+
|
3284
|
+
# Update properties of this object
|
3285
|
+
def update!(**args)
|
3286
|
+
@date_ranges = args[:date_ranges] if args.key?(:date_ranges)
|
3287
|
+
@dimension_filter = args[:dimension_filter] if args.key?(:dimension_filter)
|
3288
|
+
@dimensions = args[:dimensions] if args.key?(:dimensions)
|
3289
|
+
@limit = args[:limit] if args.key?(:limit)
|
3290
|
+
@metric_filter = args[:metric_filter] if args.key?(:metric_filter)
|
3291
|
+
@metrics = args[:metrics] if args.key?(:metrics)
|
3292
|
+
@offset = args[:offset] if args.key?(:offset)
|
3293
|
+
@order_bys = args[:order_bys] if args.key?(:order_bys)
|
3294
|
+
@return_entity_quota = args[:return_entity_quota] if args.key?(:return_entity_quota)
|
3295
|
+
@time_zone = args[:time_zone] if args.key?(:time_zone)
|
3296
|
+
end
|
3297
|
+
end
|
3298
|
+
|
3299
|
+
# The customized Data Access Record Report response.
|
3300
|
+
class GoogleAnalyticsAdminV1alphaRunAccessReportResponse
|
3301
|
+
include Google::Apis::Core::Hashable
|
3302
|
+
|
3303
|
+
# The header for a column in the report that corresponds to a specific dimension.
|
3304
|
+
# The number of DimensionHeaders and ordering of DimensionHeaders matches the
|
3305
|
+
# dimensions present in rows.
|
3306
|
+
# Corresponds to the JSON property `dimensionHeaders`
|
3307
|
+
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessDimensionHeader>]
|
3308
|
+
attr_accessor :dimension_headers
|
3309
|
+
|
3310
|
+
# The header for a column in the report that corresponds to a specific metric.
|
3311
|
+
# The number of MetricHeaders and ordering of MetricHeaders matches the metrics
|
3312
|
+
# present in rows.
|
3313
|
+
# Corresponds to the JSON property `metricHeaders`
|
3314
|
+
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessMetricHeader>]
|
3315
|
+
attr_accessor :metric_headers
|
3316
|
+
|
3317
|
+
# Current state of all quotas for this Analytics property. If any quota for a
|
3318
|
+
# property is exhausted, all requests to that property will return Resource
|
3319
|
+
# Exhausted errors.
|
3320
|
+
# Corresponds to the JSON property `quota`
|
3321
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessQuota]
|
3322
|
+
attr_accessor :quota
|
3323
|
+
|
3324
|
+
# The total number of rows in the query result. `rowCount` is independent of the
|
3325
|
+
# number of rows returned in the response, the `limit` request parameter, and
|
3326
|
+
# the `offset` request parameter. For example if a query returns 175 rows and
|
3327
|
+
# includes `limit` of 50 in the API request, the response will contain `rowCount`
|
3328
|
+
# of 175 but only 50 rows. To learn more about this pagination parameter, see [
|
3329
|
+
# Pagination](https://developers.google.com/analytics/devguides/reporting/data/
|
3330
|
+
# v1/basics#pagination).
|
3331
|
+
# Corresponds to the JSON property `rowCount`
|
3332
|
+
# @return [Fixnum]
|
3333
|
+
attr_accessor :row_count
|
3334
|
+
|
3335
|
+
# Rows of dimension value combinations and metric values in the report.
|
3336
|
+
# Corresponds to the JSON property `rows`
|
3337
|
+
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessRow>]
|
3338
|
+
attr_accessor :rows
|
3339
|
+
|
3340
|
+
def initialize(**args)
|
3341
|
+
update!(**args)
|
3342
|
+
end
|
3343
|
+
|
3344
|
+
# Update properties of this object
|
3345
|
+
def update!(**args)
|
3346
|
+
@dimension_headers = args[:dimension_headers] if args.key?(:dimension_headers)
|
3347
|
+
@metric_headers = args[:metric_headers] if args.key?(:metric_headers)
|
3348
|
+
@quota = args[:quota] if args.key?(:quota)
|
3349
|
+
@row_count = args[:row_count] if args.key?(:row_count)
|
3350
|
+
@rows = args[:rows] if args.key?(:rows)
|
3351
|
+
end
|
3352
|
+
end
|
3353
|
+
|
2069
3354
|
# Request message for SearchChangeHistoryEvents RPC.
|
2070
3355
|
class GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsRequest
|
2071
3356
|
include Google::Apis::Core::Hashable
|