google-analytics-admin-v1alpha 0.13.0 → 0.15.0

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

@@ -41,8 +41,8 @@ module Google
         #     Required. Immutable. The dimension name or metric name to filter.
         # @!attribute [rw] at_any_point_in_time
         #   @return [::Boolean]
-        #     Optional. Indicates whether this filter needs dynamic evaluation or not. If set to
-        #     true, users join the Audience if they ever met the condition (static
+        #     Optional. Indicates whether this filter needs dynamic evaluation or not. If
+        #     set to true, users join the Audience if they ever met the condition (static
         #     evaluation). If unset or set to false, user evaluation for an Audience is
         #     dynamic; users are added to an Audience when they meet the conditions and
         #     then removed when they no longer meet them.
@@ -50,9 +50,9 @@ module Google
         #     This can only be set when Audience scope is ACROSS_ALL_SESSIONS.
         # @!attribute [rw] in_any_n_day_period
         #   @return [::Integer]
-        #     Optional. If set, specifies the time window for which to evaluate data in number of
-        #     days. If not set, then audience data is evaluated against lifetime data
-        #     (i.e., infinite time window).
+        #     Optional. If set, specifies the time window for which to evaluate data in
+        #     number of days. If not set, then audience data is evaluated against
+        #     lifetime data (i.e., infinite time window).
         #
         #     For example, if set to 1 day, only the current day's data is evaluated. The
         #     reference point is the current day when at_any_point_in_time is unset or
@@ -98,16 +98,14 @@ module Google
 
               # Full regular expression matches with the string value.
               FULL_REGEXP = 5
-
-              # Partial regular expression matches with the string value.
-              PARTIAL_REGEXP = 6
             end
           end
 
           # A filter for a string dimension that matches a particular list of options.
           # @!attribute [rw] values
           #   @return [::Array<::String>]
-          #     Required. The list of possible string values to match against. Must be non-empty.
+          #     Required. The list of possible string values to match against. Must be
+          #     non-empty.
           # @!attribute [rw] case_sensitive
           #   @return [::Boolean]
           #     Optional. If true, the match is case-sensitive. If false, the match is
@@ -151,14 +149,8 @@ module Google
               # Less than.
               LESS_THAN = 2
 
-              # Less than or equal.
-              LESS_THAN_OR_EQUAL = 3
-
               # Greater than.
               GREATER_THAN = 4
-
-              # Greater than or equal.
-              GREATER_THAN_OR_EQUAL = 5
             end
           end
 
@@ -184,8 +176,8 @@ module Google
         #     Required. Immutable. The name of the event to match against.
         # @!attribute [rw] event_parameter_filter_expression
         #   @return [::Google::Analytics::Admin::V1alpha::AudienceFilterExpression]
-        #     Optional. If specified, this filter matches events that match both the single
-        #     event name and the parameter filter expressions. AudienceEventFilter
+        #     Optional. If specified, this filter matches events that match both the
+        #     single event name and the parameter filter expressions. AudienceEventFilter
         #     inside the parameter filter expression cannot be set (i.e., nested
         #     event filters are not supported). This should be a single and_group of
         #     dimension_or_metric_filter or not_expression; ANDs of ORs are not
@@ -240,7 +232,8 @@ module Google
         #     Required. Immutable. Specifies the scope for this filter.
         # @!attribute [rw] filter_expression
         #   @return [::Google::Analytics::Admin::V1alpha::AudienceFilterExpression]
-        #     Required. Immutable. A logical expression of Audience dimension, metric, or event filters.
+        #     Required. Immutable. A logical expression of Audience dimension, metric, or
+        #     event filters.
         class AudienceSimpleFilter
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -256,8 +249,8 @@ module Google
         #     Optional. Defines the time period in which the whole sequence must occur.
         # @!attribute [rw] sequence_steps
         #   @return [::Array<::Google::Analytics::Admin::V1alpha::AudienceSequenceFilter::AudienceSequenceStep>]
-        #     Required. An ordered sequence of steps. A user must complete each step in order to
-        #     join the sequence filter.
+        #     Required. An ordered sequence of steps. A user must complete each step in
+        #     order to join the sequence filter.
         class AudienceSequenceFilter
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -269,21 +262,21 @@ module Google
           #     Required. Immutable. Specifies the scope for this step.
           # @!attribute [rw] immediately_follows
           #   @return [::Boolean]
-          #     Optional. If true, the event satisfying this step must be the very next event
-          #     after the event satisfying the last step. If unset or false, this
+          #     Optional. If true, the event satisfying this step must be the very next
+          #     event after the event satisfying the last step. If unset or false, this
           #     step indirectly follows the prior step; for example, there may be
           #     events between the prior step and this step. It is ignored for the
           #     first step.
           # @!attribute [rw] constraint_duration
           #   @return [::Google::Protobuf::Duration]
-          #     Optional. When set, this step must be satisfied within the constraint_duration of
-          #     the previous step (i.e., t[i] - t[i-1] <= constraint_duration). If not
-          #     set, there is no duration requirement (the duration is effectively
-          #     unlimited). It is ignored for the first step.
+          #     Optional. When set, this step must be satisfied within the
+          #     constraint_duration of the previous step (i.e., t[i] - t[i-1] <=
+          #     constraint_duration). If not set, there is no duration requirement (the
+          #     duration is effectively unlimited). It is ignored for the first step.
           # @!attribute [rw] filter_expression
           #   @return [::Google::Analytics::Admin::V1alpha::AudienceFilterExpression]
-          #     Required. Immutable. A logical expression of Audience dimension, metric, or event filters in
-          #     each step.
+          #     Required. Immutable. A logical expression of Audience dimension, metric,
+          #     or event filters in each step.
           class AudienceSequenceStep
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -359,25 +352,25 @@ module Google
         #     Required. The description of the Audience.
         # @!attribute [rw] membership_duration_days
         #   @return [::Integer]
-        #     Required. Immutable. The duration a user should stay in an Audience. It cannot be set to more
-        #     than 540 days.
+        #     Required. Immutable. The duration a user should stay in an Audience. It
+        #     cannot be set to more than 540 days.
         # @!attribute [r] ads_personalization_enabled
         #   @return [::Boolean]
-        #     Output only. It is automatically set by GA to false if this is an NPA Audience and is
-        #     excluded from ads personalization.
+        #     Output only. It is automatically set by GA to false if this is an NPA
+        #     Audience and is excluded from ads personalization.
         # @!attribute [rw] event_trigger
         #   @return [::Google::Analytics::Admin::V1alpha::AudienceEventTrigger]
-        #     Optional. Specifies an event to log when a user joins the Audience. If not set, no
-        #     event is logged when a user joins the Audience.
+        #     Optional. Specifies an event to log when a user joins the Audience. If not
+        #     set, no event is logged when a user joins the Audience.
         # @!attribute [rw] exclusion_duration_mode
         #   @return [::Google::Analytics::Admin::V1alpha::Audience::AudienceExclusionDurationMode]
-        #     Immutable. Specifies how long an exclusion lasts for users that meet the exclusion
-        #     filter. It is applied to all EXCLUDE filter clauses and is ignored when
-        #     there is no EXCLUDE filter clause in the Audience.
+        #     Immutable. Specifies how long an exclusion lasts for users that meet the
+        #     exclusion filter. It is applied to all EXCLUDE filter clauses and is
+        #     ignored when there is no EXCLUDE filter clause in the Audience.
         # @!attribute [rw] filter_clauses
         #   @return [::Array<::Google::Analytics::Admin::V1alpha::AudienceFilterClause>]
-        #     Required. Immutable. null Filter clauses that define the Audience. All clauses will be AND’ed
-        #     together.
+        #     Required. Immutable. Unordered list. Filter clauses that define the
+        #     Audience. All clauses will be AND’ed together.
         class Audience
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -0,0 +1,156 @@
+# 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 for a single dimension
+        # @!attribute [rw] string_filter
+        #   @return [::Google::Analytics::Admin::V1alpha::ExpandedDataSetFilter::StringFilter]
+        #     A filter for a string-type dimension that matches a particular pattern.
+        # @!attribute [rw] in_list_filter
+        #   @return [::Google::Analytics::Admin::V1alpha::ExpandedDataSetFilter::InListFilter]
+        #     A filter for a string dimension that matches a particular list of
+        #     options.
+        # @!attribute [rw] field_name
+        #   @return [::String]
+        #     Required. The dimension name to filter.
+        class ExpandedDataSetFilter
+          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::ExpandedDataSetFilter::StringFilter::MatchType]
+          #     Required. The match type for the string filter.
+          # @!attribute [rw] value
+          #   @return [::String]
+          #     Required. The string value to be matched against.
+          # @!attribute [rw] case_sensitive
+          #   @return [::Boolean]
+          #     Optional. If true, the match is case-sensitive. If false, the match is
+          #     case-insensitive.
+          #     Must be true when match_type is EXACT.
+          #     Must be false when match_type is CONTAINS.
+          class StringFilter
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The match type for the string filter.
+            module MatchType
+              # Unspecified
+              MATCH_TYPE_UNSPECIFIED = 0
+
+              # Exact match of the string value.
+              EXACT = 1
+
+              # Contains the string value.
+              CONTAINS = 2
+            end
+          end
+
+          # A filter for a string dimension that matches a particular list of options.
+          # @!attribute [rw] values
+          #   @return [::Array<::String>]
+          #     Required. The list of possible string values to match against. Must be
+          #     non-empty.
+          # @!attribute [rw] case_sensitive
+          #   @return [::Boolean]
+          #     Optional. If true, the match is case-sensitive. If false, the match is
+          #     case-insensitive.
+          #     Must be true.
+          class InListFilter
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # A logical expression of EnhancedDataSet dimension filters.
+        # @!attribute [rw] and_group
+        #   @return [::Google::Analytics::Admin::V1alpha::ExpandedDataSetFilterExpressionList]
+        #     A list of expressions to be AND’ed together. It must contain a
+        #     ExpandedDataSetFilterExpression with either not_expression or
+        #     dimension_filter. This must be set for the top level
+        #     ExpandedDataSetFilterExpression.
+        # @!attribute [rw] not_expression
+        #   @return [::Google::Analytics::Admin::V1alpha::ExpandedDataSetFilterExpression]
+        #     A filter expression to be NOT'ed (i.e., inverted, complemented). It
+        #     must include a dimension_filter. This cannot be set on the
+        #     top level ExpandedDataSetFilterExpression.
+        # @!attribute [rw] filter
+        #   @return [::Google::Analytics::Admin::V1alpha::ExpandedDataSetFilter]
+        #     A filter on a single dimension. This cannot be set on the top
+        #     level ExpandedDataSetFilterExpression.
+        class ExpandedDataSetFilterExpression
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A list of ExpandedDataSet filter expressions.
+        # @!attribute [rw] filter_expressions
+        #   @return [::Array<::Google::Analytics::Admin::V1alpha::ExpandedDataSetFilterExpression>]
+        #     A list of ExpandedDataSet filter expressions.
+        class ExpandedDataSetFilterExpressionList
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A resource message representing a GA4 ExpandedDataSet.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. The resource name for this ExpandedDataSet resource.
+        #     Format: properties/\\{property_id}/expandedDataSets/\\{expanded_data_set}
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. The display name of the ExpandedDataSet.
+        #     Max 200 chars.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Optional. The description of the ExpandedDataSet.
+        #     Max 50 chars.
+        # @!attribute [rw] dimension_names
+        #   @return [::Array<::String>]
+        #     Immutable. The list of dimensions included in the ExpandedDataSet.
+        #     See the [API
+        #     Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions)
+        #     for the list of dimension names.
+        # @!attribute [rw] metric_names
+        #   @return [::Array<::String>]
+        #     Immutable. The list of metrics included in the ExpandedDataSet.
+        #     See the [API
+        #     Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics)
+        #     for the list of dimension names.
+        # @!attribute [rw] dimension_filter_expression
+        #   @return [::Google::Analytics::Admin::V1alpha::ExpandedDataSetFilterExpression]
+        #     Immutable. A logical expression of ExpandedDataSet filters applied to
+        #     dimension included in the ExpandedDataSet. This filter is used to reduce
+        #     the number of rows and thus the change of encountering `other row`.
+        # @!attribute [r] data_collection_start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Time when expanded data set began (or will begin) collecing
+        #     data.
+        class ExpandedDataSet
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end