google-analytics-admin-v1alpha 0.24.0 → 0.26.0

data/proto_docs/google/analytics/admin/v1alpha/resources.rb

@@ -58,8 +58,7 @@ module Google
         #   @return [::Google::Analytics::Admin::V1alpha::PropertyType]
         #     Immutable. The property type for this Property resource. When creating a
         #     property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then
-        #     "ORDINARY_PROPERTY" will be implied. "SUBPROPERTY" and "ROLLUP_PROPERTY"
-        #     types cannot yet be created with the Google Analytics Admin API.
+        #     "ORDINARY_PROPERTY" will be implied.
         # @!attribute [r] create_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Output only. Time when the entity was originally created.
@@ -224,62 +223,6 @@ module Google
           end
         end
 
-        # A resource message representing a user's permissions on an Account or
-        # Property resource.
-        # @!attribute [r] name
-        #   @return [::String]
-        #     Output only. Example format: properties/1234/userLinks/5678
-        # @!attribute [rw] email_address
-        #   @return [::String]
-        #     Immutable. Email address of the user to link
-        # @!attribute [rw] direct_roles
-        #   @return [::Array<::String>]
-        #     Roles directly assigned to this user for this account or property.
-        #
-        #     Valid values:
-        #     predefinedRoles/viewer
-        #     predefinedRoles/analyst
-        #     predefinedRoles/editor
-        #     predefinedRoles/admin
-        #     predefinedRoles/no-cost-data
-        #     predefinedRoles/no-revenue-data
-        #
-        #     Excludes roles that are inherited from a higher-level entity, group,
-        #     or organization admin role.
-        #
-        #     A UserLink that is updated to have an empty list of direct_roles will be
-        #     deleted.
-        class UserLink
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-        end
-
-        # Read-only resource used to summarize a principal's effective roles.
-        # @!attribute [rw] name
-        #   @return [::String]
-        #     Example format: properties/1234/userLinks/5678
-        # @!attribute [rw] email_address
-        #   @return [::String]
-        #     Email address of the linked user
-        # @!attribute [rw] direct_roles
-        #   @return [::Array<::String>]
-        #     Roles directly assigned to this user for this entity.
-        #
-        #     Format: predefinedRoles/viewer
-        #
-        #     Excludes roles that are inherited from an account (if this is for a
-        #     property), group, or organization admin role.
-        # @!attribute [rw] effective_roles
-        #   @return [::Array<::String>]
-        #     Union of all permissions a user has at this account or property (includes
-        #     direct permissions, group-inherited permissions, etc.).
-        #
-        #     Format: predefinedRoles/viewer
-        class AuditUserLink
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-        end
-
         # A link between a GA4 property and a Firebase project.
         # @!attribute [r] name
         #   @return [::String]
@@ -688,6 +631,9 @@ module Google
           # @!attribute [rw] enhanced_measurement_settings
           #   @return [::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings]
           #     A snapshot of EnhancedMeasurementSettings resource in change history.
+          # @!attribute [rw] data_redaction_settings
+          #   @return [::Google::Analytics::Admin::V1alpha::DataRedactionSettings]
+          #     A snapshot of DataRedactionSettings resource in change history.
           # @!attribute [rw] skadnetwork_conversion_value_schema
           #   @return [::Google::Analytics::Admin::V1alpha::SKAdNetworkConversionValueSchema]
           #     A snapshot of SKAdNetworkConversionValueSchema resource in change
@@ -877,10 +823,30 @@ module Google
         #     Optional. The method by which conversions will be counted across multiple
         #     events within a session. If this value is not provided, it will be set to
         #     `ONCE_PER_EVENT`.
+        # @!attribute [rw] default_conversion_value
+        #   @return [::Google::Analytics::Admin::V1alpha::ConversionEvent::DefaultConversionValue]
+        #     Optional. Defines a default value/currency for a conversion event.
         class ConversionEvent
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
 
+          # Defines a default value/currency for a conversion event. Both value and
+          # currency must be provided.
+          # @!attribute [rw] value
+          #   @return [::Float]
+          #     This value will be used to populate the value for all conversions
+          #     of the specified event_name where the event "value" parameter is unset.
+          # @!attribute [rw] currency_code
+          #   @return [::String]
+          #     When a conversion event for this event_name has no set currency,
+          #     this currency will be applied as the default. Must be in ISO 4217
+          #     currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for
+          #     more.
+          class DefaultConversionValue
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
           # The method by which conversions will be counted across multiple events
           # within a session.
           module ConversionCountingMethod
@@ -1195,55 +1161,6 @@ module Google
             # Previously CROSS_CHANNEL_LAST_CLICK
             PAID_AND_ORGANIC_CHANNELS_LAST_CLICK = 2
 
-            # Starting in June 2023, new properties can no longer use this model.
-            # See
-            # [Analytics
-            # Help](https://support.google.com/analytics/answer/9164320#040623)
-            # for more details.
-            # Starting in September 2023, we will sunset this model for all properties.
-            #
-            # Gives all credit for the conversion to the first channel that a customer
-            # clicked (or engaged view through for YouTube) before converting.
-            # Previously CROSS_CHANNEL_FIRST_CLICK
-            PAID_AND_ORGANIC_CHANNELS_FIRST_CLICK = 3
-
-            # Starting in June 2023, new properties can no longer use this model.
-            # See
-            # [Analytics
-            # Help](https://support.google.com/analytics/answer/9164320#040623)
-            # for more details.
-            # Starting in September 2023, we will sunset this model for all properties.
-            #
-            # Distributes the credit for the conversion equally across all the channels
-            # a customer clicked (or engaged view through for YouTube) before
-            # converting.
-            # Previously CROSS_CHANNEL_LINEAR
-            PAID_AND_ORGANIC_CHANNELS_LINEAR = 4
-
-            # Starting in June 2023, new properties can no longer use this model.
-            # See
-            # [Analytics
-            # Help](https://support.google.com/analytics/answer/9164320#040623)
-            # for more details.
-            # Starting in September 2023, we will sunset this model for all properties.
-            #
-            # Attributes 40% credit to the first and last interaction, and the
-            # remaining 20% credit is distributed evenly to the middle interactions.
-            # Previously CROSS_CHANNEL_POSITION_BASED
-            PAID_AND_ORGANIC_CHANNELS_POSITION_BASED = 5
-
-            # Starting in June 2023, new properties can no longer use this model.
-            # See
-            # [Analytics
-            # Help](https://support.google.com/analytics/answer/9164320#040623)
-            # for more details.
-            # Starting in September 2023, we will sunset this model for all properties.
-            #
-            # Gives more credit to the touchpoints that happened closer in time to
-            # the conversion.
-            # Previously CROSS_CHANNEL_TIME_DECAY
-            PAID_AND_ORGANIC_CHANNELS_TIME_DECAY = 6
-
             # Attributes 100% of the conversion value to the last Google Paid channel
             # that the customer clicked through before converting.
             # Previously ADS_PREFERRED_LAST_CLICK
@@ -1420,6 +1337,37 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Settings for client-side data redaction. Singleton resource under a Web
+        # Stream.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. Name of this Data Redaction Settings resource.
+        #     Format:
+        #     properties/\\{property_id}/dataStreams/\\{data_stream}/dataRedactionSettings
+        #     Example: "properties/1000/dataStreams/2000/dataRedactionSettings"
+        # @!attribute [rw] email_redaction_enabled
+        #   @return [::Boolean]
+        #     If enabled, any event parameter or user property values that look like an
+        #     email will be redacted.
+        # @!attribute [rw] query_parameter_redaction_enabled
+        #   @return [::Boolean]
+        #     Query Parameter redaction removes the key and value portions of a
+        #     query parameter if it is in the configured set of query parameters.
+        #
+        #     If enabled, URL query replacement logic will be run for the Stream. Any
+        #     query parameters defined in query_parameter_keys will be redacted.
+        # @!attribute [rw] query_parameter_keys
+        #   @return [::Array<::String>]
+        #     The query parameter keys to apply redaction logic to if present in the URL.
+        #     Query parameter matching is case-insensitive.
+        #
+        #     Must contain at least one element if query_parameter_replacement_enabled
+        #     is true. Keys cannot contain commas.
+        class DataRedactionSettings
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # A link between a GA4 Property and an AdSense for Content ad client.
         # @!attribute [r] name
         #   @return [::String]
@@ -1435,6 +1383,23 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # A link that references a source property under the parent rollup property.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. Resource name of this RollupPropertySourceLink.
+        #     Format:
+        #     'properties/\\{property_id}/rollupPropertySourceLinks/\\{rollup_property_source_link}'
+        #     Format: 'properties/123/rollupPropertySourceLinks/456'
+        # @!attribute [rw] source_property
+        #   @return [::String]
+        #     Immutable. Resource name of the source property.
+        #     Format: properties/\\{property_id}
+        #     Example: "properties/789"
+        class RollupPropertySourceLink
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # The category selected for this property, used for industry benchmarking.
         module IndustryCategory
           # Industry category unspecified
@@ -1621,6 +1586,9 @@ module Google
           # EnhancedMeasurementSettings resource
           ENHANCED_MEASUREMENT_SETTINGS = 24
 
+          # DataRedactionSettings resource
+          DATA_REDACTION_SETTINGS = 25
+
           # SKAdNetworkConversionValueSchema resource
           SKADNETWORK_CONVERSION_VALUE_SCHEMA = 26
 

data/proto_docs/google/analytics/admin/v1alpha/subproperty_event_filter.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Analytics
+    module Admin
+      module V1alpha
+        # A specific filter expression
+        # @!attribute [rw] null_filter
+        #   @return [::Boolean]
+        #     A filter for null values.
+        # @!attribute [rw] string_filter
+        #   @return [::Google::Analytics::Admin::V1alpha::SubpropertyEventFilterCondition::StringFilter]
+        #     A filter for a string-type dimension that matches a particular pattern.
+        # @!attribute [rw] field_name
+        #   @return [::String]
+        #     Required. The field that is being filtered.
+        class SubpropertyEventFilterCondition
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # A filter for a string-type dimension that matches a particular pattern.
+          # @!attribute [rw] match_type
+          #   @return [::Google::Analytics::Admin::V1alpha::SubpropertyEventFilterCondition::StringFilter::MatchType]
+          #     Required. The match type for the string filter.
+          # @!attribute [rw] value
+          #   @return [::String]
+          #     Required. The string value used for the matching.
+          # @!attribute [rw] case_sensitive
+          #   @return [::Boolean]
+          #     Optional. If true, the string value is case sensitive. If false, the
+          #     match is case-insensitive.
+          class StringFilter
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # How the filter will be used to determine a match.
+            module MatchType
+              # Match type unknown or not specified.
+              MATCH_TYPE_UNSPECIFIED = 0
+
+              # Exact match of the string value.
+              EXACT = 1
+
+              # Begins with the string value.
+              BEGINS_WITH = 2
+
+              # Ends with the string value.
+              ENDS_WITH = 3
+
+              # Contains the string value.
+              CONTAINS = 4
+
+              # Full regular expression matches with the string value.
+              FULL_REGEXP = 5
+
+              # Partial regular expression matches with the string value.
+              PARTIAL_REGEXP = 6
+            end
+          end
+        end
+
+        # A logical expression of Subproperty event filters.
+        # @!attribute [rw] or_group
+        #   @return [::Google::Analytics::Admin::V1alpha::SubpropertyEventFilterExpressionList]
+        #     A list of expressions to OR’ed together. Must only contain
+        #     not_expression or filter_condition expressions.
+        # @!attribute [rw] not_expression
+        #   @return [::Google::Analytics::Admin::V1alpha::SubpropertyEventFilterExpression]
+        #     A filter expression to be NOT'ed (inverted, complemented). It can only
+        #     include a filter. This cannot be set on the top level
+        #     SubpropertyEventFilterExpression.
+        # @!attribute [rw] filter_condition
+        #   @return [::Google::Analytics::Admin::V1alpha::SubpropertyEventFilterCondition]
+        #     Creates a filter that matches a specific event. This cannot be set on the
+        #     top level SubpropertyEventFilterExpression.
+        class SubpropertyEventFilterExpression
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A list of Subproperty event filter expressions.
+        # @!attribute [rw] filter_expressions
+        #   @return [::Array<::Google::Analytics::Admin::V1alpha::SubpropertyEventFilterExpression>]
+        #     Required. Unordered list. A list of Subproperty event filter expressions
+        class SubpropertyEventFilterExpressionList
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A clause for defining a filter. A filter may be inclusive (events satisfying
+        # the filter clause are included in the subproperty's data) or exclusive
+        # (events satisfying the filter clause are excluded from the subproperty's
+        # data).
+        # @!attribute [rw] filter_clause_type
+        #   @return [::Google::Analytics::Admin::V1alpha::SubpropertyEventFilterClause::FilterClauseType]
+        #     Required. The type for the filter clause.
+        # @!attribute [rw] filter_expression
+        #   @return [::Google::Analytics::Admin::V1alpha::SubpropertyEventFilterExpression]
+        #     Required. The logical expression for what events are sent to the
+        #     subproperty.
+        class SubpropertyEventFilterClause
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Specifies whether this is an include or exclude filter clause.
+          module FilterClauseType
+            # Filter clause type unknown or not specified.
+            FILTER_CLAUSE_TYPE_UNSPECIFIED = 0
+
+            # Events will be included in the Sub property if the filter clause is met.
+            INCLUDE = 1
+
+            # Events will be excluded from the Sub property if the filter clause is
+            # met.
+            EXCLUDE = 2
+          end
+        end
+
+        # A resource message representing a GA4 Subproperty event filter.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. Format:
+        #     properties/\\{ordinary_property_id}/subpropertyEventFilters/\\{sub_property_event_filter}
+        #     Example: properties/1234/subpropertyEventFilters/5678
+        # @!attribute [rw] apply_to_property
+        #   @return [::String]
+        #     Immutable. Resource name of the Subproperty that uses this filter.
+        # @!attribute [rw] filter_clauses
+        #   @return [::Array<::Google::Analytics::Admin::V1alpha::SubpropertyEventFilterClause>]
+        #     Required. Unordered list. Filter clauses that define the
+        #     SubpropertyEventFilter. All clauses are AND'ed together to determine what
+        #     data is sent to the subproperty.
+        class SubpropertyEventFilter
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/api/client.rb

@@ -304,6 +304,19 @@ module Google
     #                seconds: 360 # 6 minutes
     #              total_poll_timeout:
     #                 seconds: 54000 # 90 minutes
+    # @!attribute [rw] auto_populated_fields
+    #   @return [::Array<::String>]
+    #     List of top-level fields of the request message, that should be
+    #     automatically populated by the client libraries based on their
+    #     (google.api.field_info).format. Currently supported format: UUID4.
+    #
+    #     Example of a YAML configuration:
+    #
+    #      publishing:
+    #        method_settings:
+    #          - selector: google.example.v1.ExampleService.CreateExample
+    #            auto_populated_fields:
+    #            - request_id
     class MethodSettings
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-analytics-admin-v1alpha
 version: !ruby/object:Gem::Version
-  version: 0.24.0
+  version: 0.26.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-07 00:00:00.000000000 Z
+date: 2024-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.20.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.20.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -188,6 +188,7 @@ files:
 - lib/google/analytics/admin/v1alpha/expanded_data_set_pb.rb
 - lib/google/analytics/admin/v1alpha/resources_pb.rb
 - lib/google/analytics/admin/v1alpha/rest.rb
+- lib/google/analytics/admin/v1alpha/subproperty_event_filter_pb.rb
 - lib/google/analytics/admin/v1alpha/version.rb
 - proto_docs/README.md
 - proto_docs/google/analytics/admin/v1alpha/access_report.rb
@@ -197,6 +198,7 @@ files:
 - proto_docs/google/analytics/admin/v1alpha/event_create_and_edit.rb
 - proto_docs/google/analytics/admin/v1alpha/expanded_data_set.rb
 - proto_docs/google/analytics/admin/v1alpha/resources.rb
+- proto_docs/google/analytics/admin/v1alpha/subproperty_event_filter.rb
 - proto_docs/google/api/client.rb
 - proto_docs/google/api/field_behavior.rb
 - proto_docs/google/api/launch_stage.rb
@@ -225,7 +227,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: 'Manage properties in Google Analytics. Warning: Creating multiple Customer