google-analytics-admin-v1alpha 0.12.0 → 0.13.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,420 @@
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 set to
45
+ # 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 number of
54
+ # days. If not set, then audience data is evaluated against lifetime data
55
+ # (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
+
102
+ # Partial regular expression matches with the string value.
103
+ PARTIAL_REGEXP = 6
104
+ end
105
+ end
106
+
107
+ # A filter for a string dimension that matches a particular list of options.
108
+ # @!attribute [rw] values
109
+ # @return [::Array<::String>]
110
+ # Required. The list of possible string values to match against. Must be non-empty.
111
+ # @!attribute [rw] case_sensitive
112
+ # @return [::Boolean]
113
+ # Optional. If true, the match is case-sensitive. If false, the match is
114
+ # case-insensitive.
115
+ class InListFilter
116
+ include ::Google::Protobuf::MessageExts
117
+ extend ::Google::Protobuf::MessageExts::ClassMethods
118
+ end
119
+
120
+ # To represent a number.
121
+ # @!attribute [rw] int64_value
122
+ # @return [::Integer]
123
+ # Integer value.
124
+ # @!attribute [rw] double_value
125
+ # @return [::Float]
126
+ # Double value.
127
+ class NumericValue
128
+ include ::Google::Protobuf::MessageExts
129
+ extend ::Google::Protobuf::MessageExts::ClassMethods
130
+ end
131
+
132
+ # A filter for numeric or date values on a dimension or metric.
133
+ # @!attribute [rw] operation
134
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericFilter::Operation]
135
+ # Required. The operation applied to a numeric filter.
136
+ # @!attribute [rw] value
137
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericValue]
138
+ # Required. The numeric or date value to match against.
139
+ class NumericFilter
140
+ include ::Google::Protobuf::MessageExts
141
+ extend ::Google::Protobuf::MessageExts::ClassMethods
142
+
143
+ # The operation applied to a numeric filter.
144
+ module Operation
145
+ # Unspecified.
146
+ OPERATION_UNSPECIFIED = 0
147
+
148
+ # Equal.
149
+ EQUAL = 1
150
+
151
+ # Less than.
152
+ LESS_THAN = 2
153
+
154
+ # Less than or equal.
155
+ LESS_THAN_OR_EQUAL = 3
156
+
157
+ # Greater than.
158
+ GREATER_THAN = 4
159
+
160
+ # Greater than or equal.
161
+ GREATER_THAN_OR_EQUAL = 5
162
+ end
163
+ end
164
+
165
+ # A filter for numeric or date values between certain values on a dimension
166
+ # or metric.
167
+ # @!attribute [rw] from_value
168
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericValue]
169
+ # Required. Begins with this number, inclusive.
170
+ # @!attribute [rw] to_value
171
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericValue]
172
+ # Required. Ends with this number, inclusive.
173
+ class BetweenFilter
174
+ include ::Google::Protobuf::MessageExts
175
+ extend ::Google::Protobuf::MessageExts::ClassMethods
176
+ end
177
+ end
178
+
179
+ # A filter that matches events of a single event name. If an event parameter
180
+ # is specified, only the subset of events that match both the single event name
181
+ # and the parameter filter expressions match this event filter.
182
+ # @!attribute [rw] event_name
183
+ # @return [::String]
184
+ # Required. Immutable. The name of the event to match against.
185
+ # @!attribute [rw] event_parameter_filter_expression
186
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceFilterExpression]
187
+ # Optional. If specified, this filter matches events that match both the single
188
+ # event name and the parameter filter expressions. AudienceEventFilter
189
+ # inside the parameter filter expression cannot be set (i.e., nested
190
+ # event filters are not supported). This should be a single and_group of
191
+ # dimension_or_metric_filter or not_expression; ANDs of ORs are not
192
+ # supported. Also, if it includes a filter for "eventCount", only that one
193
+ # will be considered; all the other filters will be ignored.
194
+ class AudienceEventFilter
195
+ include ::Google::Protobuf::MessageExts
196
+ extend ::Google::Protobuf::MessageExts::ClassMethods
197
+ end
198
+
199
+ # A logical expression of Audience dimension, metric, or event filters.
200
+ # @!attribute [rw] and_group
201
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceFilterExpressionList]
202
+ # A list of expressions to be AND’ed together. It can only contain
203
+ # AudienceFilterExpressions with or_group. This must be set for the top
204
+ # level AudienceFilterExpression.
205
+ # @!attribute [rw] or_group
206
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceFilterExpressionList]
207
+ # A list of expressions to OR’ed together. It cannot contain
208
+ # AudienceFilterExpressions with and_group or or_group.
209
+ # @!attribute [rw] not_expression
210
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceFilterExpression]
211
+ # A filter expression to be NOT'ed (i.e., inverted, complemented). It
212
+ # can only include a dimension_or_metric_filter. This cannot be set on the
213
+ # top level AudienceFilterExpression.
214
+ # @!attribute [rw] dimension_or_metric_filter
215
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter]
216
+ # A filter on a single dimension or metric. This cannot be set on the top
217
+ # level AudienceFilterExpression.
218
+ # @!attribute [rw] event_filter
219
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceEventFilter]
220
+ # Creates a filter that matches a specific event. This cannot be set on the
221
+ # top level AudienceFilterExpression.
222
+ class AudienceFilterExpression
223
+ include ::Google::Protobuf::MessageExts
224
+ extend ::Google::Protobuf::MessageExts::ClassMethods
225
+ end
226
+
227
+ # A list of Audience filter expressions.
228
+ # @!attribute [rw] filter_expressions
229
+ # @return [::Array<::Google::Analytics::Admin::V1alpha::AudienceFilterExpression>]
230
+ # A list of Audience filter expressions.
231
+ class AudienceFilterExpressionList
232
+ include ::Google::Protobuf::MessageExts
233
+ extend ::Google::Protobuf::MessageExts::ClassMethods
234
+ end
235
+
236
+ # Defines a simple filter that a user must satisfy to be a member of the
237
+ # Audience.
238
+ # @!attribute [rw] scope
239
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceFilterScope]
240
+ # Required. Immutable. Specifies the scope for this filter.
241
+ # @!attribute [rw] filter_expression
242
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceFilterExpression]
243
+ # Required. Immutable. A logical expression of Audience dimension, metric, or event filters.
244
+ class AudienceSimpleFilter
245
+ include ::Google::Protobuf::MessageExts
246
+ extend ::Google::Protobuf::MessageExts::ClassMethods
247
+ end
248
+
249
+ # Defines filters that must occur in a specific order for the user to be a
250
+ # member of the Audience.
251
+ # @!attribute [rw] scope
252
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceFilterScope]
253
+ # Required. Immutable. Specifies the scope for this filter.
254
+ # @!attribute [rw] sequence_maximum_duration
255
+ # @return [::Google::Protobuf::Duration]
256
+ # Optional. Defines the time period in which the whole sequence must occur.
257
+ # @!attribute [rw] sequence_steps
258
+ # @return [::Array<::Google::Analytics::Admin::V1alpha::AudienceSequenceFilter::AudienceSequenceStep>]
259
+ # Required. An ordered sequence of steps. A user must complete each step in order to
260
+ # join the sequence filter.
261
+ class AudienceSequenceFilter
262
+ include ::Google::Protobuf::MessageExts
263
+ extend ::Google::Protobuf::MessageExts::ClassMethods
264
+
265
+ # A condition that must occur in the specified step order for this user
266
+ # to match the sequence.
267
+ # @!attribute [rw] scope
268
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceFilterScope]
269
+ # Required. Immutable. Specifies the scope for this step.
270
+ # @!attribute [rw] immediately_follows
271
+ # @return [::Boolean]
272
+ # Optional. If true, the event satisfying this step must be the very next event
273
+ # after the event satisfying the last step. If unset or false, this
274
+ # step indirectly follows the prior step; for example, there may be
275
+ # events between the prior step and this step. It is ignored for the
276
+ # first step.
277
+ # @!attribute [rw] constraint_duration
278
+ # @return [::Google::Protobuf::Duration]
279
+ # Optional. When set, this step must be satisfied within the constraint_duration of
280
+ # the previous step (i.e., t[i] - t[i-1] <= constraint_duration). If not
281
+ # set, there is no duration requirement (the duration is effectively
282
+ # unlimited). It is ignored for the first step.
283
+ # @!attribute [rw] filter_expression
284
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceFilterExpression]
285
+ # Required. Immutable. A logical expression of Audience dimension, metric, or event filters in
286
+ # each step.
287
+ class AudienceSequenceStep
288
+ include ::Google::Protobuf::MessageExts
289
+ extend ::Google::Protobuf::MessageExts::ClassMethods
290
+ end
291
+ end
292
+
293
+ # A clause for defining either a simple or sequence filter. A filter can be
294
+ # inclusive (i.e., users satisfying the filter clause are included in the
295
+ # Audience) or exclusive (i.e., users satisfying the filter clause are
296
+ # excluded from the Audience).
297
+ # @!attribute [rw] simple_filter
298
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceSimpleFilter]
299
+ # A simple filter that a user must satisfy to be a member of the Audience.
300
+ # @!attribute [rw] sequence_filter
301
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceSequenceFilter]
302
+ # Filters that must occur in a specific order for the user to be a member
303
+ # of the Audience.
304
+ # @!attribute [rw] clause_type
305
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceFilterClause::AudienceClauseType]
306
+ # Required. Specifies whether this is an include or exclude filter clause.
307
+ class AudienceFilterClause
308
+ include ::Google::Protobuf::MessageExts
309
+ extend ::Google::Protobuf::MessageExts::ClassMethods
310
+
311
+ # Specifies whether this is an include or exclude filter clause.
312
+ module AudienceClauseType
313
+ # Unspecified clause type.
314
+ AUDIENCE_CLAUSE_TYPE_UNSPECIFIED = 0
315
+
316
+ # Users will be included in the Audience if the filter clause is met.
317
+ INCLUDE = 1
318
+
319
+ # Users will be excluded from the Audience if the filter clause is met.
320
+ EXCLUDE = 2
321
+ end
322
+ end
323
+
324
+ # Specifies an event to log when a user joins the Audience.
325
+ # @!attribute [rw] event_name
326
+ # @return [::String]
327
+ # Required. The event name that will be logged.
328
+ # @!attribute [rw] log_condition
329
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceEventTrigger::LogCondition]
330
+ # Required. When to log the event.
331
+ class AudienceEventTrigger
332
+ include ::Google::Protobuf::MessageExts
333
+ extend ::Google::Protobuf::MessageExts::ClassMethods
334
+
335
+ # Determines when to log the event.
336
+ module LogCondition
337
+ # Log condition is not specified.
338
+ LOG_CONDITION_UNSPECIFIED = 0
339
+
340
+ # The event should be logged only when a user is joined.
341
+ AUDIENCE_JOINED = 1
342
+
343
+ # The event should be logged whenever the Audience condition is met, even
344
+ # if the user is already a member of the Audience.
345
+ AUDIENCE_MEMBERSHIP_RENEWED = 2
346
+ end
347
+ end
348
+
349
+ # A resource message representing a GA4 Audience.
350
+ # @!attribute [r] name
351
+ # @return [::String]
352
+ # Output only. The resource name for this Audience resource.
353
+ # Format: properties/\\{propertyId}/audiences/\\{audienceId}
354
+ # @!attribute [rw] display_name
355
+ # @return [::String]
356
+ # Required. The display name of the Audience.
357
+ # @!attribute [rw] description
358
+ # @return [::String]
359
+ # Required. The description of the Audience.
360
+ # @!attribute [rw] membership_duration_days
361
+ # @return [::Integer]
362
+ # Required. Immutable. The duration a user should stay in an Audience. It cannot be set to more
363
+ # than 540 days.
364
+ # @!attribute [r] ads_personalization_enabled
365
+ # @return [::Boolean]
366
+ # Output only. It is automatically set by GA to false if this is an NPA Audience and is
367
+ # excluded from ads personalization.
368
+ # @!attribute [rw] event_trigger
369
+ # @return [::Google::Analytics::Admin::V1alpha::AudienceEventTrigger]
370
+ # Optional. Specifies an event to log when a user joins the Audience. If not set, no
371
+ # event is logged when a user joins the Audience.
372
+ # @!attribute [rw] exclusion_duration_mode
373
+ # @return [::Google::Analytics::Admin::V1alpha::Audience::AudienceExclusionDurationMode]
374
+ # Immutable. Specifies how long an exclusion lasts for users that meet the exclusion
375
+ # filter. It is applied to all EXCLUDE filter clauses and is ignored when
376
+ # there is no EXCLUDE filter clause in the Audience.
377
+ # @!attribute [rw] filter_clauses
378
+ # @return [::Array<::Google::Analytics::Admin::V1alpha::AudienceFilterClause>]
379
+ # Required. Immutable. null Filter clauses that define the Audience. All clauses will be AND’ed
380
+ # together.
381
+ class Audience
382
+ include ::Google::Protobuf::MessageExts
383
+ extend ::Google::Protobuf::MessageExts::ClassMethods
384
+
385
+ # Specifies how long an exclusion lasts for users that meet the exclusion
386
+ # filter.
387
+ module AudienceExclusionDurationMode
388
+ # Not specified.
389
+ AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED = 0
390
+
391
+ # Exclude users from the Audience during periods when they meet the
392
+ # filter clause.
393
+ EXCLUDE_TEMPORARILY = 1
394
+
395
+ # Exclude users from the Audience if they've ever met the filter clause.
396
+ EXCLUDE_PERMANENTLY = 2
397
+ end
398
+ end
399
+
400
+ # Specifies how to evaluate users for joining an Audience.
401
+ module AudienceFilterScope
402
+ # Scope is not specified.
403
+ AUDIENCE_FILTER_SCOPE_UNSPECIFIED = 0
404
+
405
+ # User joins the Audience if the filter condition is met within one
406
+ # event.
407
+ AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT = 1
408
+
409
+ # User joins the Audience if the filter condition is met within one
410
+ # session.
411
+ AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION = 2
412
+
413
+ # User joins the Audience if the filter condition is met by any event
414
+ # across any session.
415
+ AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS = 3
416
+ end
417
+ end
418
+ end
419
+ end
420
+ end
@@ -54,6 +54,12 @@ module Google
54
54
  # Output only. Resource name of this property.
55
55
  # Format: properties/\\{property_id}
56
56
  # Example: "properties/1000"
57
+ # @!attribute [rw] property_type
58
+ # @return [::Google::Analytics::Admin::V1alpha::PropertyType]
59
+ # Immutable. The property type for this Property resource. When creating a property, if
60
+ # the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be
61
+ # implied. "SUBPROPERTY" and "ROLLUP_PROPERTY" types cannot yet be created
62
+ # via Google Analytics Admin API.
57
63
  # @!attribute [r] create_time
58
64
  # @return [::Google::Protobuf::Timestamp]
59
65
  # Output only. Time when the entity was originally created.
@@ -65,8 +71,8 @@ module Google
65
71
  # Immutable. Resource name of this property's logical parent.
66
72
  #
67
73
  # Note: The Property-Moving UI can be used to change the parent.
68
- # Format: accounts/\\{account}
69
- # Example: "accounts/100"
74
+ # Format: accounts/\\{account}, properties/\\{property}
75
+ # Example: "accounts/100", "properties/101"
70
76
  # @!attribute [rw] display_name
71
77
  # @return [::String]
72
78
  # Required. Human-readable display name for this property.
@@ -405,6 +411,16 @@ module Google
405
411
  # @!attribute [rw] display_name
406
412
  # @return [::String]
407
413
  # Display name for the property referred to in this property summary.
414
+ # @!attribute [rw] property_type
415
+ # @return [::Google::Analytics::Admin::V1alpha::PropertyType]
416
+ # The property's property type.
417
+ # @!attribute [rw] parent
418
+ # @return [::String]
419
+ # Resource name of this property's logical parent.
420
+ #
421
+ # Note: The Property-Moving UI can be used to change the parent.
422
+ # Format: accounts/\\{account}, properties/\\{property}
423
+ # Example: "accounts/100", "properties/200"
408
424
  class PropertySummary
409
425
  include ::Google::Protobuf::MessageExts
410
426
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -416,7 +432,7 @@ module Google
416
432
  # Output only. Resource name of this secret. This secret may be a child of any type of
417
433
  # stream.
418
434
  # Format:
419
- # properties/\\{property}/webDataStreams/\\{webDataStream}/measurementProtocolSecrets/\\{measurementProtocolSecret}
435
+ # properties/\\{property}/dataStreams/\\{dataStream}/measurementProtocolSecrets/\\{measurementProtocolSecret}
420
436
  # @!attribute [rw] display_name
421
437
  # @return [::String]
422
438
  # Required. Human-readable display name for this secret.
@@ -523,6 +539,9 @@ module Google
523
539
  # @!attribute [rw] data_stream
524
540
  # @return [::Google::Analytics::Admin::V1alpha::DataStream]
525
541
  # A snapshot of a DataStream resource in change history.
542
+ # @!attribute [rw] attribution_settings
543
+ # @return [::Google::Analytics::Admin::V1alpha::AttributionSettings]
544
+ # A snapshot of AttributionSettings resource in change history.
526
545
  class ChangeHistoryResource
527
546
  include ::Google::Protobuf::MessageExts
528
547
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -868,6 +887,103 @@ module Google
868
887
  end
869
888
  end
870
889
 
890
+ # The attribution settings used for a given property. This is a singleton
891
+ # resource.
892
+ # @!attribute [r] name
893
+ # @return [::String]
894
+ # Output only. Resource name of this attribution settings resource.
895
+ # Format: properties/\\{property_id}/attributionSettings
896
+ # Example: "properties/1000/attributionSettings"
897
+ # @!attribute [rw] acquisition_conversion_event_lookback_window
898
+ # @return [::Google::Analytics::Admin::V1alpha::AttributionSettings::AcquisitionConversionEventLookbackWindow]
899
+ # Required. The lookback window configuration for acquisition conversion events.
900
+ # The default window size is 30 days.
901
+ # @!attribute [rw] other_conversion_event_lookback_window
902
+ # @return [::Google::Analytics::Admin::V1alpha::AttributionSettings::OtherConversionEventLookbackWindow]
903
+ # Required. The lookback window for all other, non-acquisition conversion events.
904
+ # The default window size is 90 days.
905
+ # @!attribute [rw] reporting_attribution_model
906
+ # @return [::Google::Analytics::Admin::V1alpha::AttributionSettings::ReportingAttributionModel]
907
+ # Required. The reporting attribution model used to calculate conversion credit in this
908
+ # property's reports.
909
+ #
910
+ # Changing the attribution model will apply to both historical and future
911
+ # data. These changes will be reflected in reports with conversion and
912
+ # revenue data. User and session data will be unaffected.
913
+ class AttributionSettings
914
+ include ::Google::Protobuf::MessageExts
915
+ extend ::Google::Protobuf::MessageExts::ClassMethods
916
+
917
+ # How far back in time events should be considered for inclusion in a
918
+ # converting path which leads to the first install of an app or the first
919
+ # visit to a site.
920
+ module AcquisitionConversionEventLookbackWindow
921
+ # Lookback window size unspecified.
922
+ ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_UNSPECIFIED = 0
923
+
924
+ # 7-day lookback window.
925
+ ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_7_DAYS = 1
926
+
927
+ # 30-day lookback window.
928
+ ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_30_DAYS = 2
929
+ end
930
+
931
+ # How far back in time events should be considered for inclusion in a
932
+ # converting path for all conversions other than first app install/first site
933
+ # visit.
934
+ module OtherConversionEventLookbackWindow
935
+ # Lookback window size unspecified.
936
+ OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_UNSPECIFIED = 0
937
+
938
+ # 30-day lookback window.
939
+ OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_30_DAYS = 1
940
+
941
+ # 60-day lookback window.
942
+ OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_60_DAYS = 2
943
+
944
+ # 90-day lookback window.
945
+ OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_90_DAYS = 3
946
+ end
947
+
948
+ # The reporting attribution model used to calculate conversion credit in this
949
+ # property's reports.
950
+ module ReportingAttributionModel
951
+ # Reporting attribution model unspecified.
952
+ REPORTING_ATTRIBUTION_MODEL_UNSPECIFIED = 0
953
+
954
+ # Data-driven attribution distributes credit for the conversion based on
955
+ # data for each conversion event. Each Data-driven model is specific to
956
+ # each advertiser and each conversion event.
957
+ CROSS_CHANNEL_DATA_DRIVEN = 1
958
+
959
+ # Ignores direct traffic and attributes 100% of the conversion value to the
960
+ # last channel that the customer clicked through (or engaged view through
961
+ # for YouTube) before converting.
962
+ CROSS_CHANNEL_LAST_CLICK = 2
963
+
964
+ # Gives all credit for the conversion to the first channel that a customer
965
+ # clicked (or engaged view through for YouTube) before converting.
966
+ CROSS_CHANNEL_FIRST_CLICK = 3
967
+
968
+ # Distributes the credit for the conversion equally across all the channels
969
+ # a customer clicked (or engaged view through for YouTube) before
970
+ # converting.
971
+ CROSS_CHANNEL_LINEAR = 4
972
+
973
+ # Attributes 40% credit to the first and last interaction, and the
974
+ # remaining 20% credit is distributed evenly to the middle interactions.
975
+ CROSS_CHANNEL_POSITION_BASED = 5
976
+
977
+ # Gives more credit to the touchpoints that happened closer in time to
978
+ # the conversion.
979
+ CROSS_CHANNEL_TIME_DECAY = 6
980
+
981
+ # Attributes 100% of the conversion value to the last Google Ads channel
982
+ # that the customer clicked through before converting.
983
+ ADS_PREFERRED_LAST_CLICK = 7
984
+ end
985
+ end
986
+
871
987
  # The category selected for this property, used for industry benchmarking.
872
988
  module IndustryCategory
873
989
  # Industry category unspecified
@@ -1036,8 +1152,14 @@ module Google
1036
1152
  # DisplayVideo360AdvertiserLinkProposal resource
1037
1153
  DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL = 15
1038
1154
 
1155
+ # SearchAds360Link resource
1156
+ SEARCH_ADS_360_LINK = 16
1157
+
1039
1158
  # DataStream resource
1040
1159
  DATA_STREAM = 18
1160
+
1161
+ # AttributionSettings resource
1162
+ ATTRIBUTION_SETTINGS = 20
1041
1163
  end
1042
1164
 
1043
1165
  # Status of the Google Signals settings (i.e., whether this feature has been
@@ -1113,6 +1235,21 @@ module Google
1113
1235
  # proposal will be automatically deleted after some time.
1114
1236
  OBSOLETE = 6
1115
1237
  end
1238
+
1239
+ # Types of Property resources.
1240
+ module PropertyType
1241
+ # Unknown or unspecified property type
1242
+ PROPERTY_TYPE_UNSPECIFIED = 0
1243
+
1244
+ # Ordinary GA4 property
1245
+ PROPERTY_TYPE_ORDINARY = 1
1246
+
1247
+ # GA4 subproperty
1248
+ PROPERTY_TYPE_SUBPROPERTY = 2
1249
+
1250
+ # GA4 rollup property
1251
+ PROPERTY_TYPE_ROLLUP = 3
1252
+ end
1116
1253
  end
1117
1254
  end
1118
1255
  end