google-analytics-admin-v1alpha 0.12.0 → 0.14.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,413 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Analytics
22
+ module Admin
23
+ module V1alpha
24
+ # A specific filter for a single dimension or metric.
25
+ # @!attribute [rw] string_filter
26
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::StringFilter]
27
+ # A filter for a string-type dimension that matches a particular pattern.
28
+ # @!attribute [rw] in_list_filter
29
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::InListFilter]
30
+ # A filter for a string dimension that matches a particular list of
31
+ # options.
32
+ # @!attribute [rw] numeric_filter
33
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericFilter]
34
+ # A filter for numeric or date values on a dimension or metric.
35
+ # @!attribute [rw] between_filter
36
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::BetweenFilter]
37
+ # A filter for numeric or date values between certain values on a dimension
38
+ # or metric.
39
+ # @!attribute [rw] field_name
40
+ # @return [::String]
41
+ # Required. Immutable. The dimension name or metric name to filter.
42
+ # @!attribute [rw] at_any_point_in_time
43
+ # @return [::Boolean]
44
+ # Optional. Indicates whether this filter needs dynamic evaluation or not. If
45
+ # set to true, users join the Audience if they ever met the condition (static
46
+ # evaluation). If unset or set to false, user evaluation for an Audience is
47
+ # dynamic; users are added to an Audience when they meet the conditions and
48
+ # then removed when they no longer meet them.
49
+ #
50
+ # This can only be set when Audience scope is ACROSS_ALL_SESSIONS.
51
+ # @!attribute [rw] in_any_n_day_period
52
+ # @return [::Integer]
53
+ # Optional. If set, specifies the time window for which to evaluate data in
54
+ # number of days. If not set, then audience data is evaluated against
55
+ # lifetime data (i.e., infinite time window).
56
+ #
57
+ # For example, if set to 1 day, only the current day's data is evaluated. The
58
+ # reference point is the current day when at_any_point_in_time is unset or
59
+ # false.
60
+ #
61
+ # It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be
62
+ # greater than 60 days.
63
+ class AudienceDimensionOrMetricFilter
64
+ include ::Google::Protobuf::MessageExts
65
+ extend ::Google::Protobuf::MessageExts::ClassMethods
66
+
67
+ # A filter for a string-type dimension that matches a particular pattern.
68
+ # @!attribute [rw] match_type
69
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::StringFilter::MatchType]
70
+ # Required. The match type for the string filter.
71
+ # @!attribute [rw] value
72
+ # @return [::String]
73
+ # Required. The string value to be matched against.
74
+ # @!attribute [rw] case_sensitive
75
+ # @return [::Boolean]
76
+ # Optional. If true, the match is case-sensitive. If false, the match is
77
+ # case-insensitive.
78
+ class StringFilter
79
+ include ::Google::Protobuf::MessageExts
80
+ extend ::Google::Protobuf::MessageExts::ClassMethods
81
+
82
+ # The match type for the string filter.
83
+ module MatchType
84
+ # Unspecified
85
+ MATCH_TYPE_UNSPECIFIED = 0
86
+
87
+ # Exact match of the string value.
88
+ EXACT = 1
89
+
90
+ # Begins with the string value.
91
+ BEGINS_WITH = 2
92
+
93
+ # Ends with the string value.
94
+ ENDS_WITH = 3
95
+
96
+ # Contains the string value.
97
+ CONTAINS = 4
98
+
99
+ # Full regular expression matches with the string value.
100
+ FULL_REGEXP = 5
101
+ end
102
+ end
103
+
104
+ # A filter for a string dimension that matches a particular list of options.
105
+ # @!attribute [rw] values
106
+ # @return [::Array<::String>]
107
+ # Required. The list of possible string values to match against. Must be
108
+ # non-empty.
109
+ # @!attribute [rw] case_sensitive
110
+ # @return [::Boolean]
111
+ # Optional. If true, the match is case-sensitive. If false, the match is
112
+ # case-insensitive.
113
+ class InListFilter
114
+ include ::Google::Protobuf::MessageExts
115
+ extend ::Google::Protobuf::MessageExts::ClassMethods
116
+ end
117
+
118
+ # To represent a number.
119
+ # @!attribute [rw] int64_value
120
+ # @return [::Integer]
121
+ # Integer value.
122
+ # @!attribute [rw] double_value
123
+ # @return [::Float]
124
+ # Double value.
125
+ class NumericValue
126
+ include ::Google::Protobuf::MessageExts
127
+ extend ::Google::Protobuf::MessageExts::ClassMethods
128
+ end
129
+
130
+ # A filter for numeric or date values on a dimension or metric.
131
+ # @!attribute [rw] operation
132
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericFilter::Operation]
133
+ # Required. The operation applied to a numeric filter.
134
+ # @!attribute [rw] value
135
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericValue]
136
+ # Required. The numeric or date value to match against.
137
+ class NumericFilter
138
+ include ::Google::Protobuf::MessageExts
139
+ extend ::Google::Protobuf::MessageExts::ClassMethods
140
+
141
+ # The operation applied to a numeric filter.
142
+ module Operation
143
+ # Unspecified.
144
+ OPERATION_UNSPECIFIED = 0
145
+
146
+ # Equal.
147
+ EQUAL = 1
148
+
149
+ # Less than.
150
+ LESS_THAN = 2
151
+
152
+ # Greater than.
153
+ GREATER_THAN = 4
154
+ end
155
+ end
156
+
157
+ # A filter for numeric or date values between certain values on a dimension
158
+ # or metric.
159
+ # @!attribute [rw] from_value
160
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericValue]
161
+ # Required. Begins with this number, inclusive.
162
+ # @!attribute [rw] to_value
163
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericValue]
164
+ # Required. Ends with this number, inclusive.
165
+ class BetweenFilter
166
+ include ::Google::Protobuf::MessageExts
167
+ extend ::Google::Protobuf::MessageExts::ClassMethods
168
+ end
169
+ end
170
+
171
+ # A filter that matches events of a single event name. If an event parameter
172
+ # is specified, only the subset of events that match both the single event name
173
+ # and the parameter filter expressions match this event filter.
174
+ # @!attribute [rw] event_name
175
+ # @return [::String]
176
+ # Required. Immutable. The name of the event to match against.
177
+ # @!attribute [rw] event_parameter_filter_expression
178
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceFilterExpression]
179
+ # Optional. If specified, this filter matches events that match both the
180
+ # single event name and the parameter filter expressions. AudienceEventFilter
181
+ # inside the parameter filter expression cannot be set (i.e., nested
182
+ # event filters are not supported). This should be a single and_group of
183
+ # dimension_or_metric_filter or not_expression; ANDs of ORs are not
184
+ # supported. Also, if it includes a filter for "eventCount", only that one
185
+ # will be considered; all the other filters will be ignored.
186
+ class AudienceEventFilter
187
+ include ::Google::Protobuf::MessageExts
188
+ extend ::Google::Protobuf::MessageExts::ClassMethods
189
+ end
190
+
191
+ # A logical expression of Audience dimension, metric, or event filters.
192
+ # @!attribute [rw] and_group
193
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceFilterExpressionList]
194
+ # A list of expressions to be AND’ed together. It can only contain
195
+ # AudienceFilterExpressions with or_group. This must be set for the top
196
+ # level AudienceFilterExpression.
197
+ # @!attribute [rw] or_group
198
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceFilterExpressionList]
199
+ # A list of expressions to OR’ed together. It cannot contain
200
+ # AudienceFilterExpressions with and_group or or_group.
201
+ # @!attribute [rw] not_expression
202
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceFilterExpression]
203
+ # A filter expression to be NOT'ed (i.e., inverted, complemented). It
204
+ # can only include a dimension_or_metric_filter. This cannot be set on the
205
+ # top level AudienceFilterExpression.
206
+ # @!attribute [rw] dimension_or_metric_filter
207
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter]
208
+ # A filter on a single dimension or metric. This cannot be set on the top
209
+ # level AudienceFilterExpression.
210
+ # @!attribute [rw] event_filter
211
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceEventFilter]
212
+ # Creates a filter that matches a specific event. This cannot be set on the
213
+ # top level AudienceFilterExpression.
214
+ class AudienceFilterExpression
215
+ include ::Google::Protobuf::MessageExts
216
+ extend ::Google::Protobuf::MessageExts::ClassMethods
217
+ end
218
+
219
+ # A list of Audience filter expressions.
220
+ # @!attribute [rw] filter_expressions
221
+ # @return [::Array<::Google::Analytics::Admin::V1alpha::AudienceFilterExpression>]
222
+ # A list of Audience filter expressions.
223
+ class AudienceFilterExpressionList
224
+ include ::Google::Protobuf::MessageExts
225
+ extend ::Google::Protobuf::MessageExts::ClassMethods
226
+ end
227
+
228
+ # Defines a simple filter that a user must satisfy to be a member of the
229
+ # Audience.
230
+ # @!attribute [rw] scope
231
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceFilterScope]
232
+ # Required. Immutable. Specifies the scope for this filter.
233
+ # @!attribute [rw] filter_expression
234
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceFilterExpression]
235
+ # Required. Immutable. A logical expression of Audience dimension, metric, or
236
+ # event filters.
237
+ class AudienceSimpleFilter
238
+ include ::Google::Protobuf::MessageExts
239
+ extend ::Google::Protobuf::MessageExts::ClassMethods
240
+ end
241
+
242
+ # Defines filters that must occur in a specific order for the user to be a
243
+ # member of the Audience.
244
+ # @!attribute [rw] scope
245
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceFilterScope]
246
+ # Required. Immutable. Specifies the scope for this filter.
247
+ # @!attribute [rw] sequence_maximum_duration
248
+ # @return [::Google::Protobuf::Duration]
249
+ # Optional. Defines the time period in which the whole sequence must occur.
250
+ # @!attribute [rw] sequence_steps
251
+ # @return [::Array<::Google::Analytics::Admin::V1alpha::AudienceSequenceFilter::AudienceSequenceStep>]
252
+ # Required. An ordered sequence of steps. A user must complete each step in
253
+ # order to join the sequence filter.
254
+ class AudienceSequenceFilter
255
+ include ::Google::Protobuf::MessageExts
256
+ extend ::Google::Protobuf::MessageExts::ClassMethods
257
+
258
+ # A condition that must occur in the specified step order for this user
259
+ # to match the sequence.
260
+ # @!attribute [rw] scope
261
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceFilterScope]
262
+ # Required. Immutable. Specifies the scope for this step.
263
+ # @!attribute [rw] immediately_follows
264
+ # @return [::Boolean]
265
+ # Optional. If true, the event satisfying this step must be the very next
266
+ # event after the event satisfying the last step. If unset or false, this
267
+ # step indirectly follows the prior step; for example, there may be
268
+ # events between the prior step and this step. It is ignored for the
269
+ # first step.
270
+ # @!attribute [rw] constraint_duration
271
+ # @return [::Google::Protobuf::Duration]
272
+ # Optional. When set, this step must be satisfied within the
273
+ # constraint_duration of the previous step (i.e., t[i] - t[i-1] <=
274
+ # constraint_duration). If not set, there is no duration requirement (the
275
+ # duration is effectively unlimited). It is ignored for the first step.
276
+ # @!attribute [rw] filter_expression
277
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceFilterExpression]
278
+ # Required. Immutable. A logical expression of Audience dimension, metric,
279
+ # or event filters in each step.
280
+ class AudienceSequenceStep
281
+ include ::Google::Protobuf::MessageExts
282
+ extend ::Google::Protobuf::MessageExts::ClassMethods
283
+ end
284
+ end
285
+
286
+ # A clause for defining either a simple or sequence filter. A filter can be
287
+ # inclusive (i.e., users satisfying the filter clause are included in the
288
+ # Audience) or exclusive (i.e., users satisfying the filter clause are
289
+ # excluded from the Audience).
290
+ # @!attribute [rw] simple_filter
291
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceSimpleFilter]
292
+ # A simple filter that a user must satisfy to be a member of the Audience.
293
+ # @!attribute [rw] sequence_filter
294
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceSequenceFilter]
295
+ # Filters that must occur in a specific order for the user to be a member
296
+ # of the Audience.
297
+ # @!attribute [rw] clause_type
298
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceFilterClause::AudienceClauseType]
299
+ # Required. Specifies whether this is an include or exclude filter clause.
300
+ class AudienceFilterClause
301
+ include ::Google::Protobuf::MessageExts
302
+ extend ::Google::Protobuf::MessageExts::ClassMethods
303
+
304
+ # Specifies whether this is an include or exclude filter clause.
305
+ module AudienceClauseType
306
+ # Unspecified clause type.
307
+ AUDIENCE_CLAUSE_TYPE_UNSPECIFIED = 0
308
+
309
+ # Users will be included in the Audience if the filter clause is met.
310
+ INCLUDE = 1
311
+
312
+ # Users will be excluded from the Audience if the filter clause is met.
313
+ EXCLUDE = 2
314
+ end
315
+ end
316
+
317
+ # Specifies an event to log when a user joins the Audience.
318
+ # @!attribute [rw] event_name
319
+ # @return [::String]
320
+ # Required. The event name that will be logged.
321
+ # @!attribute [rw] log_condition
322
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceEventTrigger::LogCondition]
323
+ # Required. When to log the event.
324
+ class AudienceEventTrigger
325
+ include ::Google::Protobuf::MessageExts
326
+ extend ::Google::Protobuf::MessageExts::ClassMethods
327
+
328
+ # Determines when to log the event.
329
+ module LogCondition
330
+ # Log condition is not specified.
331
+ LOG_CONDITION_UNSPECIFIED = 0
332
+
333
+ # The event should be logged only when a user is joined.
334
+ AUDIENCE_JOINED = 1
335
+
336
+ # The event should be logged whenever the Audience condition is met, even
337
+ # if the user is already a member of the Audience.
338
+ AUDIENCE_MEMBERSHIP_RENEWED = 2
339
+ end
340
+ end
341
+
342
+ # A resource message representing a GA4 Audience.
343
+ # @!attribute [r] name
344
+ # @return [::String]
345
+ # Output only. The resource name for this Audience resource.
346
+ # Format: properties/\\{propertyId}/audiences/\\{audienceId}
347
+ # @!attribute [rw] display_name
348
+ # @return [::String]
349
+ # Required. The display name of the Audience.
350
+ # @!attribute [rw] description
351
+ # @return [::String]
352
+ # Required. The description of the Audience.
353
+ # @!attribute [rw] membership_duration_days
354
+ # @return [::Integer]
355
+ # Required. Immutable. The duration a user should stay in an Audience. It
356
+ # cannot be set to more than 540 days.
357
+ # @!attribute [r] ads_personalization_enabled
358
+ # @return [::Boolean]
359
+ # Output only. It is automatically set by GA to false if this is an NPA
360
+ # Audience and is excluded from ads personalization.
361
+ # @!attribute [rw] event_trigger
362
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceEventTrigger]
363
+ # Optional. Specifies an event to log when a user joins the Audience. If not
364
+ # set, no event is logged when a user joins the Audience.
365
+ # @!attribute [rw] exclusion_duration_mode
366
+ # @return [::Google::Analytics::Admin::V1alpha::Audience::AudienceExclusionDurationMode]
367
+ # Immutable. Specifies how long an exclusion lasts for users that meet the
368
+ # exclusion filter. It is applied to all EXCLUDE filter clauses and is
369
+ # ignored when there is no EXCLUDE filter clause in the Audience.
370
+ # @!attribute [rw] filter_clauses
371
+ # @return [::Array<::Google::Analytics::Admin::V1alpha::AudienceFilterClause>]
372
+ # Required. Immutable. Unordered list. Filter clauses that define the
373
+ # Audience. All clauses will be AND’ed together.
374
+ class Audience
375
+ include ::Google::Protobuf::MessageExts
376
+ extend ::Google::Protobuf::MessageExts::ClassMethods
377
+
378
+ # Specifies how long an exclusion lasts for users that meet the exclusion
379
+ # filter.
380
+ module AudienceExclusionDurationMode
381
+ # Not specified.
382
+ AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED = 0
383
+
384
+ # Exclude users from the Audience during periods when they meet the
385
+ # filter clause.
386
+ EXCLUDE_TEMPORARILY = 1
387
+
388
+ # Exclude users from the Audience if they've ever met the filter clause.
389
+ EXCLUDE_PERMANENTLY = 2
390
+ end
391
+ end
392
+
393
+ # Specifies how to evaluate users for joining an Audience.
394
+ module AudienceFilterScope
395
+ # Scope is not specified.
396
+ AUDIENCE_FILTER_SCOPE_UNSPECIFIED = 0
397
+
398
+ # User joins the Audience if the filter condition is met within one
399
+ # event.
400
+ AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT = 1
401
+
402
+ # User joins the Audience if the filter condition is met within one
403
+ # session.
404
+ AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION = 2
405
+
406
+ # User joins the Audience if the filter condition is met by any event
407
+ # across any session.
408
+ AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS = 3
409
+ end
410
+ end
411
+ end
412
+ end
413
+ end
@@ -0,0 +1,156 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Analytics
22
+ module Admin
23
+ module V1alpha
24
+ # A specific filter for a single dimension
25
+ # @!attribute [rw] string_filter
26
+ # @return [::Google::Analytics::Admin::V1alpha::ExpandedDataSetFilter::StringFilter]
27
+ # A filter for a string-type dimension that matches a particular pattern.
28
+ # @!attribute [rw] in_list_filter
29
+ # @return [::Google::Analytics::Admin::V1alpha::ExpandedDataSetFilter::InListFilter]
30
+ # A filter for a string dimension that matches a particular list of
31
+ # options.
32
+ # @!attribute [rw] field_name
33
+ # @return [::String]
34
+ # Required. The dimension name to filter.
35
+ class ExpandedDataSetFilter
36
+ include ::Google::Protobuf::MessageExts
37
+ extend ::Google::Protobuf::MessageExts::ClassMethods
38
+
39
+ # A filter for a string-type dimension that matches a particular pattern.
40
+ # @!attribute [rw] match_type
41
+ # @return [::Google::Analytics::Admin::V1alpha::ExpandedDataSetFilter::StringFilter::MatchType]
42
+ # Required. The match type for the string filter.
43
+ # @!attribute [rw] value
44
+ # @return [::String]
45
+ # Required. The string value to be matched against.
46
+ # @!attribute [rw] case_sensitive
47
+ # @return [::Boolean]
48
+ # Optional. If true, the match is case-sensitive. If false, the match is
49
+ # case-insensitive.
50
+ # Must be true when match_type is EXACT.
51
+ # Must be false when match_type is CONTAINS.
52
+ class StringFilter
53
+ include ::Google::Protobuf::MessageExts
54
+ extend ::Google::Protobuf::MessageExts::ClassMethods
55
+
56
+ # The match type for the string filter.
57
+ module MatchType
58
+ # Unspecified
59
+ MATCH_TYPE_UNSPECIFIED = 0
60
+
61
+ # Exact match of the string value.
62
+ EXACT = 1
63
+
64
+ # Contains the string value.
65
+ CONTAINS = 2
66
+ end
67
+ end
68
+
69
+ # A filter for a string dimension that matches a particular list of options.
70
+ # @!attribute [rw] values
71
+ # @return [::Array<::String>]
72
+ # Required. The list of possible string values to match against. Must be
73
+ # non-empty.
74
+ # @!attribute [rw] case_sensitive
75
+ # @return [::Boolean]
76
+ # Optional. If true, the match is case-sensitive. If false, the match is
77
+ # case-insensitive.
78
+ # Must be true.
79
+ class InListFilter
80
+ include ::Google::Protobuf::MessageExts
81
+ extend ::Google::Protobuf::MessageExts::ClassMethods
82
+ end
83
+ end
84
+
85
+ # A logical expression of EnhancedDataSet dimension filters.
86
+ # @!attribute [rw] and_group
87
+ # @return [::Google::Analytics::Admin::V1alpha::ExpandedDataSetFilterExpressionList]
88
+ # A list of expressions to be AND’ed together. It must contain a
89
+ # ExpandedDataSetFilterExpression with either not_expression or
90
+ # dimension_filter. This must be set for the top level
91
+ # ExpandedDataSetFilterExpression.
92
+ # @!attribute [rw] not_expression
93
+ # @return [::Google::Analytics::Admin::V1alpha::ExpandedDataSetFilterExpression]
94
+ # A filter expression to be NOT'ed (i.e., inverted, complemented). It
95
+ # must include a dimension_filter. This cannot be set on the
96
+ # top level ExpandedDataSetFilterExpression.
97
+ # @!attribute [rw] filter
98
+ # @return [::Google::Analytics::Admin::V1alpha::ExpandedDataSetFilter]
99
+ # A filter on a single dimension. This cannot be set on the top
100
+ # level ExpandedDataSetFilterExpression.
101
+ class ExpandedDataSetFilterExpression
102
+ include ::Google::Protobuf::MessageExts
103
+ extend ::Google::Protobuf::MessageExts::ClassMethods
104
+ end
105
+
106
+ # A list of ExpandedDataSet filter expressions.
107
+ # @!attribute [rw] filter_expressions
108
+ # @return [::Array<::Google::Analytics::Admin::V1alpha::ExpandedDataSetFilterExpression>]
109
+ # A list of ExpandedDataSet filter expressions.
110
+ class ExpandedDataSetFilterExpressionList
111
+ include ::Google::Protobuf::MessageExts
112
+ extend ::Google::Protobuf::MessageExts::ClassMethods
113
+ end
114
+
115
+ # A resource message representing a GA4 ExpandedDataSet.
116
+ # @!attribute [r] name
117
+ # @return [::String]
118
+ # Output only. The resource name for this ExpandedDataSet resource.
119
+ # Format: properties/\\{property_id}/expandedDataSets/\\{expanded_data_set}
120
+ # @!attribute [rw] display_name
121
+ # @return [::String]
122
+ # Required. The display name of the ExpandedDataSet.
123
+ # Max 200 chars.
124
+ # @!attribute [rw] description
125
+ # @return [::String]
126
+ # Optional. The description of the ExpandedDataSet.
127
+ # Max 50 chars.
128
+ # @!attribute [rw] dimension_names
129
+ # @return [::Array<::String>]
130
+ # Immutable. The list of dimensions included in the ExpandedDataSet.
131
+ # See the [API
132
+ # Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions)
133
+ # for the list of dimension names.
134
+ # @!attribute [rw] metric_names
135
+ # @return [::Array<::String>]
136
+ # Immutable. The list of metrics included in the ExpandedDataSet.
137
+ # See the [API
138
+ # Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics)
139
+ # for the list of dimension names.
140
+ # @!attribute [rw] dimension_filter_expression
141
+ # @return [::Google::Analytics::Admin::V1alpha::ExpandedDataSetFilterExpression]
142
+ # Immutable. A logical expression of ExpandedDataSet filters applied to
143
+ # dimension included in the ExpandedDataSet. This filter is used to reduce
144
+ # the number of rows and thus the change of encountering `other row`.
145
+ # @!attribute [r] data_collection_start_time
146
+ # @return [::Google::Protobuf::Timestamp]
147
+ # Output only. Time when expanded data set began (or will begin) collecing
148
+ # data.
149
+ class ExpandedDataSet
150
+ include ::Google::Protobuf::MessageExts
151
+ extend ::Google::Protobuf::MessageExts::ClassMethods
152
+ end
153
+ end
154
+ end
155
+ end
156
+ end