google-analytics-admin-v1alpha 0.25.0 → 0.26.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -58,8 +58,7 @@ module Google
58
58
  # @return [::Google::Analytics::Admin::V1alpha::PropertyType]
59
59
  # Immutable. The property type for this Property resource. When creating a
60
60
  # property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then
61
- # "ORDINARY_PROPERTY" will be implied. "SUBPROPERTY" and "ROLLUP_PROPERTY"
62
- # types cannot yet be created with the Google Analytics Admin API.
61
+ # "ORDINARY_PROPERTY" will be implied.
63
62
  # @!attribute [r] create_time
64
63
  # @return [::Google::Protobuf::Timestamp]
65
64
  # Output only. Time when the entity was originally created.
@@ -224,62 +223,6 @@ module Google
224
223
  end
225
224
  end
226
225
 
227
- # A resource message representing a user's permissions on an Account or
228
- # Property resource.
229
- # @!attribute [r] name
230
- # @return [::String]
231
- # Output only. Example format: properties/1234/userLinks/5678
232
- # @!attribute [rw] email_address
233
- # @return [::String]
234
- # Immutable. Email address of the user to link
235
- # @!attribute [rw] direct_roles
236
- # @return [::Array<::String>]
237
- # Roles directly assigned to this user for this account or property.
238
- #
239
- # Valid values:
240
- # predefinedRoles/viewer
241
- # predefinedRoles/analyst
242
- # predefinedRoles/editor
243
- # predefinedRoles/admin
244
- # predefinedRoles/no-cost-data
245
- # predefinedRoles/no-revenue-data
246
- #
247
- # Excludes roles that are inherited from a higher-level entity, group,
248
- # or organization admin role.
249
- #
250
- # A UserLink that is updated to have an empty list of direct_roles will be
251
- # deleted.
252
- class UserLink
253
- include ::Google::Protobuf::MessageExts
254
- extend ::Google::Protobuf::MessageExts::ClassMethods
255
- end
256
-
257
- # Read-only resource used to summarize a principal's effective roles.
258
- # @!attribute [rw] name
259
- # @return [::String]
260
- # Example format: properties/1234/userLinks/5678
261
- # @!attribute [rw] email_address
262
- # @return [::String]
263
- # Email address of the linked user
264
- # @!attribute [rw] direct_roles
265
- # @return [::Array<::String>]
266
- # Roles directly assigned to this user for this entity.
267
- #
268
- # Format: predefinedRoles/viewer
269
- #
270
- # Excludes roles that are inherited from an account (if this is for a
271
- # property), group, or organization admin role.
272
- # @!attribute [rw] effective_roles
273
- # @return [::Array<::String>]
274
- # Union of all permissions a user has at this account or property (includes
275
- # direct permissions, group-inherited permissions, etc.).
276
- #
277
- # Format: predefinedRoles/viewer
278
- class AuditUserLink
279
- include ::Google::Protobuf::MessageExts
280
- extend ::Google::Protobuf::MessageExts::ClassMethods
281
- end
282
-
283
226
  # A link between a GA4 property and a Firebase project.
284
227
  # @!attribute [r] name
285
228
  # @return [::String]
@@ -688,6 +631,9 @@ module Google
688
631
  # @!attribute [rw] enhanced_measurement_settings
689
632
  # @return [::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings]
690
633
  # A snapshot of EnhancedMeasurementSettings resource in change history.
634
+ # @!attribute [rw] data_redaction_settings
635
+ # @return [::Google::Analytics::Admin::V1alpha::DataRedactionSettings]
636
+ # A snapshot of DataRedactionSettings resource in change history.
691
637
  # @!attribute [rw] skadnetwork_conversion_value_schema
692
638
  # @return [::Google::Analytics::Admin::V1alpha::SKAdNetworkConversionValueSchema]
693
639
  # A snapshot of SKAdNetworkConversionValueSchema resource in change
@@ -877,10 +823,30 @@ module Google
877
823
  # Optional. The method by which conversions will be counted across multiple
878
824
  # events within a session. If this value is not provided, it will be set to
879
825
  # `ONCE_PER_EVENT`.
826
+ # @!attribute [rw] default_conversion_value
827
+ # @return [::Google::Analytics::Admin::V1alpha::ConversionEvent::DefaultConversionValue]
828
+ # Optional. Defines a default value/currency for a conversion event.
880
829
  class ConversionEvent
881
830
  include ::Google::Protobuf::MessageExts
882
831
  extend ::Google::Protobuf::MessageExts::ClassMethods
883
832
 
833
+ # Defines a default value/currency for a conversion event. Both value and
834
+ # currency must be provided.
835
+ # @!attribute [rw] value
836
+ # @return [::Float]
837
+ # This value will be used to populate the value for all conversions
838
+ # of the specified event_name where the event "value" parameter is unset.
839
+ # @!attribute [rw] currency_code
840
+ # @return [::String]
841
+ # When a conversion event for this event_name has no set currency,
842
+ # this currency will be applied as the default. Must be in ISO 4217
843
+ # currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for
844
+ # more.
845
+ class DefaultConversionValue
846
+ include ::Google::Protobuf::MessageExts
847
+ extend ::Google::Protobuf::MessageExts::ClassMethods
848
+ end
849
+
884
850
  # The method by which conversions will be counted across multiple events
885
851
  # within a session.
886
852
  module ConversionCountingMethod
@@ -1195,55 +1161,6 @@ module Google
1195
1161
  # Previously CROSS_CHANNEL_LAST_CLICK
1196
1162
  PAID_AND_ORGANIC_CHANNELS_LAST_CLICK = 2
1197
1163
 
1198
- # Starting in June 2023, new properties can no longer use this model.
1199
- # See
1200
- # [Analytics
1201
- # Help](https://support.google.com/analytics/answer/9164320#040623)
1202
- # for more details.
1203
- # Starting in September 2023, we will sunset this model for all properties.
1204
- #
1205
- # Gives all credit for the conversion to the first channel that a customer
1206
- # clicked (or engaged view through for YouTube) before converting.
1207
- # Previously CROSS_CHANNEL_FIRST_CLICK
1208
- PAID_AND_ORGANIC_CHANNELS_FIRST_CLICK = 3
1209
-
1210
- # Starting in June 2023, new properties can no longer use this model.
1211
- # See
1212
- # [Analytics
1213
- # Help](https://support.google.com/analytics/answer/9164320#040623)
1214
- # for more details.
1215
- # Starting in September 2023, we will sunset this model for all properties.
1216
- #
1217
- # Distributes the credit for the conversion equally across all the channels
1218
- # a customer clicked (or engaged view through for YouTube) before
1219
- # converting.
1220
- # Previously CROSS_CHANNEL_LINEAR
1221
- PAID_AND_ORGANIC_CHANNELS_LINEAR = 4
1222
-
1223
- # Starting in June 2023, new properties can no longer use this model.
1224
- # See
1225
- # [Analytics
1226
- # Help](https://support.google.com/analytics/answer/9164320#040623)
1227
- # for more details.
1228
- # Starting in September 2023, we will sunset this model for all properties.
1229
- #
1230
- # Attributes 40% credit to the first and last interaction, and the
1231
- # remaining 20% credit is distributed evenly to the middle interactions.
1232
- # Previously CROSS_CHANNEL_POSITION_BASED
1233
- PAID_AND_ORGANIC_CHANNELS_POSITION_BASED = 5
1234
-
1235
- # Starting in June 2023, new properties can no longer use this model.
1236
- # See
1237
- # [Analytics
1238
- # Help](https://support.google.com/analytics/answer/9164320#040623)
1239
- # for more details.
1240
- # Starting in September 2023, we will sunset this model for all properties.
1241
- #
1242
- # Gives more credit to the touchpoints that happened closer in time to
1243
- # the conversion.
1244
- # Previously CROSS_CHANNEL_TIME_DECAY
1245
- PAID_AND_ORGANIC_CHANNELS_TIME_DECAY = 6
1246
-
1247
1164
  # Attributes 100% of the conversion value to the last Google Paid channel
1248
1165
  # that the customer clicked through before converting.
1249
1166
  # Previously ADS_PREFERRED_LAST_CLICK
@@ -1420,6 +1337,37 @@ module Google
1420
1337
  extend ::Google::Protobuf::MessageExts::ClassMethods
1421
1338
  end
1422
1339
 
1340
+ # Settings for client-side data redaction. Singleton resource under a Web
1341
+ # Stream.
1342
+ # @!attribute [r] name
1343
+ # @return [::String]
1344
+ # Output only. Name of this Data Redaction Settings resource.
1345
+ # Format:
1346
+ # properties/\\{property_id}/dataStreams/\\{data_stream}/dataRedactionSettings
1347
+ # Example: "properties/1000/dataStreams/2000/dataRedactionSettings"
1348
+ # @!attribute [rw] email_redaction_enabled
1349
+ # @return [::Boolean]
1350
+ # If enabled, any event parameter or user property values that look like an
1351
+ # email will be redacted.
1352
+ # @!attribute [rw] query_parameter_redaction_enabled
1353
+ # @return [::Boolean]
1354
+ # Query Parameter redaction removes the key and value portions of a
1355
+ # query parameter if it is in the configured set of query parameters.
1356
+ #
1357
+ # If enabled, URL query replacement logic will be run for the Stream. Any
1358
+ # query parameters defined in query_parameter_keys will be redacted.
1359
+ # @!attribute [rw] query_parameter_keys
1360
+ # @return [::Array<::String>]
1361
+ # The query parameter keys to apply redaction logic to if present in the URL.
1362
+ # Query parameter matching is case-insensitive.
1363
+ #
1364
+ # Must contain at least one element if query_parameter_replacement_enabled
1365
+ # is true. Keys cannot contain commas.
1366
+ class DataRedactionSettings
1367
+ include ::Google::Protobuf::MessageExts
1368
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1369
+ end
1370
+
1423
1371
  # A link between a GA4 Property and an AdSense for Content ad client.
1424
1372
  # @!attribute [r] name
1425
1373
  # @return [::String]
@@ -1435,6 +1383,23 @@ module Google
1435
1383
  extend ::Google::Protobuf::MessageExts::ClassMethods
1436
1384
  end
1437
1385
 
1386
+ # A link that references a source property under the parent rollup property.
1387
+ # @!attribute [r] name
1388
+ # @return [::String]
1389
+ # Output only. Resource name of this RollupPropertySourceLink.
1390
+ # Format:
1391
+ # 'properties/\\{property_id}/rollupPropertySourceLinks/\\{rollup_property_source_link}'
1392
+ # Format: 'properties/123/rollupPropertySourceLinks/456'
1393
+ # @!attribute [rw] source_property
1394
+ # @return [::String]
1395
+ # Immutable. Resource name of the source property.
1396
+ # Format: properties/\\{property_id}
1397
+ # Example: "properties/789"
1398
+ class RollupPropertySourceLink
1399
+ include ::Google::Protobuf::MessageExts
1400
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1401
+ end
1402
+
1438
1403
  # The category selected for this property, used for industry benchmarking.
1439
1404
  module IndustryCategory
1440
1405
  # Industry category unspecified
@@ -1621,6 +1586,9 @@ module Google
1621
1586
  # EnhancedMeasurementSettings resource
1622
1587
  ENHANCED_MEASUREMENT_SETTINGS = 24
1623
1588
 
1589
+ # DataRedactionSettings resource
1590
+ DATA_REDACTION_SETTINGS = 25
1591
+
1624
1592
  # SKAdNetworkConversionValueSchema resource
1625
1593
  SKADNETWORK_CONVERSION_VALUE_SCHEMA = 26
1626
1594
 
@@ -0,0 +1,157 @@
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 expression
25
+ # @!attribute [rw] null_filter
26
+ # @return [::Boolean]
27
+ # A filter for null values.
28
+ # @!attribute [rw] string_filter
29
+ # @return [::Google::Analytics::Admin::V1alpha::SubpropertyEventFilterCondition::StringFilter]
30
+ # A filter for a string-type dimension that matches a particular pattern.
31
+ # @!attribute [rw] field_name
32
+ # @return [::String]
33
+ # Required. The field that is being filtered.
34
+ class SubpropertyEventFilterCondition
35
+ include ::Google::Protobuf::MessageExts
36
+ extend ::Google::Protobuf::MessageExts::ClassMethods
37
+
38
+ # A filter for a string-type dimension that matches a particular pattern.
39
+ # @!attribute [rw] match_type
40
+ # @return [::Google::Analytics::Admin::V1alpha::SubpropertyEventFilterCondition::StringFilter::MatchType]
41
+ # Required. The match type for the string filter.
42
+ # @!attribute [rw] value
43
+ # @return [::String]
44
+ # Required. The string value used for the matching.
45
+ # @!attribute [rw] case_sensitive
46
+ # @return [::Boolean]
47
+ # Optional. If true, the string value is case sensitive. If false, the
48
+ # match is case-insensitive.
49
+ class StringFilter
50
+ include ::Google::Protobuf::MessageExts
51
+ extend ::Google::Protobuf::MessageExts::ClassMethods
52
+
53
+ # How the filter will be used to determine a match.
54
+ module MatchType
55
+ # Match type unknown or not specified.
56
+ MATCH_TYPE_UNSPECIFIED = 0
57
+
58
+ # Exact match of the string value.
59
+ EXACT = 1
60
+
61
+ # Begins with the string value.
62
+ BEGINS_WITH = 2
63
+
64
+ # Ends with the string value.
65
+ ENDS_WITH = 3
66
+
67
+ # Contains the string value.
68
+ CONTAINS = 4
69
+
70
+ # Full regular expression matches with the string value.
71
+ FULL_REGEXP = 5
72
+
73
+ # Partial regular expression matches with the string value.
74
+ PARTIAL_REGEXP = 6
75
+ end
76
+ end
77
+ end
78
+
79
+ # A logical expression of Subproperty event filters.
80
+ # @!attribute [rw] or_group
81
+ # @return [::Google::Analytics::Admin::V1alpha::SubpropertyEventFilterExpressionList]
82
+ # A list of expressions to OR’ed together. Must only contain
83
+ # not_expression or filter_condition expressions.
84
+ # @!attribute [rw] not_expression
85
+ # @return [::Google::Analytics::Admin::V1alpha::SubpropertyEventFilterExpression]
86
+ # A filter expression to be NOT'ed (inverted, complemented). It can only
87
+ # include a filter. This cannot be set on the top level
88
+ # SubpropertyEventFilterExpression.
89
+ # @!attribute [rw] filter_condition
90
+ # @return [::Google::Analytics::Admin::V1alpha::SubpropertyEventFilterCondition]
91
+ # Creates a filter that matches a specific event. This cannot be set on the
92
+ # top level SubpropertyEventFilterExpression.
93
+ class SubpropertyEventFilterExpression
94
+ include ::Google::Protobuf::MessageExts
95
+ extend ::Google::Protobuf::MessageExts::ClassMethods
96
+ end
97
+
98
+ # A list of Subproperty event filter expressions.
99
+ # @!attribute [rw] filter_expressions
100
+ # @return [::Array<::Google::Analytics::Admin::V1alpha::SubpropertyEventFilterExpression>]
101
+ # Required. Unordered list. A list of Subproperty event filter expressions
102
+ class SubpropertyEventFilterExpressionList
103
+ include ::Google::Protobuf::MessageExts
104
+ extend ::Google::Protobuf::MessageExts::ClassMethods
105
+ end
106
+
107
+ # A clause for defining a filter. A filter may be inclusive (events satisfying
108
+ # the filter clause are included in the subproperty's data) or exclusive
109
+ # (events satisfying the filter clause are excluded from the subproperty's
110
+ # data).
111
+ # @!attribute [rw] filter_clause_type
112
+ # @return [::Google::Analytics::Admin::V1alpha::SubpropertyEventFilterClause::FilterClauseType]
113
+ # Required. The type for the filter clause.
114
+ # @!attribute [rw] filter_expression
115
+ # @return [::Google::Analytics::Admin::V1alpha::SubpropertyEventFilterExpression]
116
+ # Required. The logical expression for what events are sent to the
117
+ # subproperty.
118
+ class SubpropertyEventFilterClause
119
+ include ::Google::Protobuf::MessageExts
120
+ extend ::Google::Protobuf::MessageExts::ClassMethods
121
+
122
+ # Specifies whether this is an include or exclude filter clause.
123
+ module FilterClauseType
124
+ # Filter clause type unknown or not specified.
125
+ FILTER_CLAUSE_TYPE_UNSPECIFIED = 0
126
+
127
+ # Events will be included in the Sub property if the filter clause is met.
128
+ INCLUDE = 1
129
+
130
+ # Events will be excluded from the Sub property if the filter clause is
131
+ # met.
132
+ EXCLUDE = 2
133
+ end
134
+ end
135
+
136
+ # A resource message representing a GA4 Subproperty event filter.
137
+ # @!attribute [r] name
138
+ # @return [::String]
139
+ # Output only. Format:
140
+ # properties/\\{ordinary_property_id}/subpropertyEventFilters/\\{sub_property_event_filter}
141
+ # Example: properties/1234/subpropertyEventFilters/5678
142
+ # @!attribute [rw] apply_to_property
143
+ # @return [::String]
144
+ # Immutable. Resource name of the Subproperty that uses this filter.
145
+ # @!attribute [rw] filter_clauses
146
+ # @return [::Array<::Google::Analytics::Admin::V1alpha::SubpropertyEventFilterClause>]
147
+ # Required. Unordered list. Filter clauses that define the
148
+ # SubpropertyEventFilter. All clauses are AND'ed together to determine what
149
+ # data is sent to the subproperty.
150
+ class SubpropertyEventFilter
151
+ include ::Google::Protobuf::MessageExts
152
+ extend ::Google::Protobuf::MessageExts::ClassMethods
153
+ end
154
+ end
155
+ end
156
+ end
157
+ end
@@ -304,6 +304,19 @@ module Google
304
304
  # seconds: 360 # 6 minutes
305
305
  # total_poll_timeout:
306
306
  # seconds: 54000 # 90 minutes
307
+ # @!attribute [rw] auto_populated_fields
308
+ # @return [::Array<::String>]
309
+ # List of top-level fields of the request message, that should be
310
+ # automatically populated by the client libraries based on their
311
+ # (google.api.field_info).format. Currently supported format: UUID4.
312
+ #
313
+ # Example of a YAML configuration:
314
+ #
315
+ # publishing:
316
+ # method_settings:
317
+ # - selector: google.example.v1.ExampleService.CreateExample
318
+ # auto_populated_fields:
319
+ # - request_id
307
320
  class MethodSettings
308
321
  include ::Google::Protobuf::MessageExts
309
322
  extend ::Google::Protobuf::MessageExts::ClassMethods
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-analytics-admin-v1alpha
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.25.0
4
+ version: 0.26.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-09-12 00:00:00.000000000 Z
11
+ date: 2024-01-03 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -188,6 +188,7 @@ files:
188
188
  - lib/google/analytics/admin/v1alpha/expanded_data_set_pb.rb
189
189
  - lib/google/analytics/admin/v1alpha/resources_pb.rb
190
190
  - lib/google/analytics/admin/v1alpha/rest.rb
191
+ - lib/google/analytics/admin/v1alpha/subproperty_event_filter_pb.rb
191
192
  - lib/google/analytics/admin/v1alpha/version.rb
192
193
  - proto_docs/README.md
193
194
  - proto_docs/google/analytics/admin/v1alpha/access_report.rb
@@ -197,6 +198,7 @@ files:
197
198
  - proto_docs/google/analytics/admin/v1alpha/event_create_and_edit.rb
198
199
  - proto_docs/google/analytics/admin/v1alpha/expanded_data_set.rb
199
200
  - proto_docs/google/analytics/admin/v1alpha/resources.rb
201
+ - proto_docs/google/analytics/admin/v1alpha/subproperty_event_filter.rb
200
202
  - proto_docs/google/api/client.rb
201
203
  - proto_docs/google/api/field_behavior.rb
202
204
  - proto_docs/google/api/launch_stage.rb
@@ -225,7 +227,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
225
227
  - !ruby/object:Gem::Version
226
228
  version: '0'
227
229
  requirements: []
228
- rubygems_version: 3.4.19
230
+ rubygems_version: 3.5.3
229
231
  signing_key:
230
232
  specification_version: 4
231
233
  summary: 'Manage properties in Google Analytics. Warning: Creating multiple Customer