google-analytics-admin-v1alpha 0.31.0 → 0.32.1

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

@@ -73,16 +73,24 @@ module Google
         # @!attribute [rw] and_group
         #   @return [::Google::Analytics::Admin::V1alpha::AccessFilterExpressionList]
         #     Each of the FilterExpressions in the and_group has an AND relationship.
+        #
+        #     Note: The following fields are mutually exclusive: `and_group`, `or_group`, `not_expression`, `access_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] or_group
         #   @return [::Google::Analytics::Admin::V1alpha::AccessFilterExpressionList]
         #     Each of the FilterExpressions in the or_group has an OR relationship.
+        #
+        #     Note: The following fields are mutually exclusive: `or_group`, `and_group`, `not_expression`, `access_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] not_expression
         #   @return [::Google::Analytics::Admin::V1alpha::AccessFilterExpression]
         #     The FilterExpression is NOT of not_expression.
+        #
+        #     Note: The following fields are mutually exclusive: `not_expression`, `and_group`, `or_group`, `access_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] access_filter
         #   @return [::Google::Analytics::Admin::V1alpha::AccessFilter]
         #     A primitive filter. In the same FilterExpression, all of the filter's
         #     field names need to be either all dimensions or all metrics.
+        #
+        #     Note: The following fields are mutually exclusive: `access_filter`, `and_group`, `or_group`, `not_expression`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         class AccessFilterExpression
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -101,15 +109,23 @@ module Google
         # @!attribute [rw] string_filter
         #   @return [::Google::Analytics::Admin::V1alpha::AccessStringFilter]
         #     Strings related filter.
+        #
+        #     Note: The following fields are mutually exclusive: `string_filter`, `in_list_filter`, `numeric_filter`, `between_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] in_list_filter
         #   @return [::Google::Analytics::Admin::V1alpha::AccessInListFilter]
         #     A filter for in list values.
+        #
+        #     Note: The following fields are mutually exclusive: `in_list_filter`, `string_filter`, `numeric_filter`, `between_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] numeric_filter
         #   @return [::Google::Analytics::Admin::V1alpha::AccessNumericFilter]
         #     A filter for numeric or date values.
+        #
+        #     Note: The following fields are mutually exclusive: `numeric_filter`, `string_filter`, `in_list_filter`, `between_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] between_filter
         #   @return [::Google::Analytics::Admin::V1alpha::AccessBetweenFilter]
         #     A filter for two values.
+        #
+        #     Note: The following fields are mutually exclusive: `between_filter`, `string_filter`, `in_list_filter`, `numeric_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] field_name
         #   @return [::String]
         #     The dimension name or metric name.
@@ -218,9 +234,13 @@ module Google
         # @!attribute [rw] int64_value
         #   @return [::Integer]
         #     Integer value
+        #
+        #     Note: The following fields are mutually exclusive: `int64_value`, `double_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] double_value
         #   @return [::Float]
         #     Double value
+        #
+        #     Note: The following fields are mutually exclusive: `double_value`, `int64_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         class NumericValue
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -232,9 +252,13 @@ module Google
         # @!attribute [rw] metric
         #   @return [::Google::Analytics::Admin::V1alpha::AccessOrderBy::MetricOrderBy]
         #     Sorts results by a metric's values.
+        #
+        #     Note: The following fields are mutually exclusive: `metric`, `dimension`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] dimension
         #   @return [::Google::Analytics::Admin::V1alpha::AccessOrderBy::DimensionOrderBy]
         #     Sorts results by a dimension's values.
+        #
+        #     Note: The following fields are mutually exclusive: `dimension`, `metric`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] desc
         #   @return [::Boolean]
         #     If true, sorts by descending order. If false or unspecified, sorts in

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

@@ -29,9 +29,9 @@ module Google
         #     access for all properties under that account.
         #
         #     To request at the property level, entity should be for example
-        #     'properties/123' if "123" is your GA4 property ID. To request at the
-        #     account level, entity should be for example 'accounts/1234' if "1234" is
-        #     your GA4 Account ID.
+        #     'properties/123' if "123" is your Google Analytics property ID. To request
+        #     at the account level, entity should be for example 'accounts/1234' if
+        #     "1234" is your Google Analytics Account ID.
         # @!attribute [rw] dimensions
         #   @return [::Array<::Google::Analytics::Admin::V1alpha::AccessDimension>]
         #     The dimensions requested and displayed in the response. Requests are
@@ -598,9 +598,14 @@ module Google
         # @!attribute [rw] page_size
         #   @return [::Integer]
         #     Optional. The maximum number of ChangeHistoryEvent items to return.
-        #     The service may return fewer than this value, even if there are additional
-        #     pages. If unspecified, at most 50 items will be returned.
-        #     The maximum value is 200 (higher values will be coerced to the maximum).
+        #     If unspecified, at most 50 items will be returned. The maximum value is 200
+        #     (higher values will be coerced to the maximum).
+        #
+        #     Note that the service may return a page with fewer items than this value
+        #     specifies (potentially even zero), and that there still may be additional
+        #     pages. If you want a particular number of items, you'll need to continue
+        #     requesting additional pages using `page_token` until you get the needed
+        #     number.
         # @!attribute [rw] page_token
         #   @return [::String]
         #     Optional. A page token, received from a previous

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

@@ -25,17 +25,25 @@ module Google
         # @!attribute [rw] string_filter
         #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::StringFilter]
         #     A filter for a string-type dimension that matches a particular pattern.
+        #
+        #     Note: The following fields are mutually exclusive: `string_filter`, `in_list_filter`, `numeric_filter`, `between_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] in_list_filter
         #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::InListFilter]
         #     A filter for a string dimension that matches a particular list of
         #     options.
+        #
+        #     Note: The following fields are mutually exclusive: `in_list_filter`, `string_filter`, `numeric_filter`, `between_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] numeric_filter
         #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericFilter]
         #     A filter for numeric or date values on a dimension or metric.
+        #
+        #     Note: The following fields are mutually exclusive: `numeric_filter`, `string_filter`, `in_list_filter`, `between_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] between_filter
         #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::BetweenFilter]
         #     A filter for numeric or date values between certain values on a dimension
         #     or metric.
+        #
+        #     Note: The following fields are mutually exclusive: `between_filter`, `string_filter`, `in_list_filter`, `numeric_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] field_name
         #   @return [::String]
         #     Required. Immutable. The dimension name or metric name to filter. If the
@@ -124,9 +132,13 @@ module Google
           # @!attribute [rw] int64_value
           #   @return [::Integer]
           #     Integer value.
+          #
+          #     Note: The following fields are mutually exclusive: `int64_value`, `double_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] double_value
           #   @return [::Float]
           #     Double value.
+          #
+          #     Note: The following fields are mutually exclusive: `double_value`, `int64_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           class NumericValue
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -199,23 +211,33 @@ module Google
         #     A list of expressions to be AND’ed together. It can only contain
         #     AudienceFilterExpressions with or_group. This must be set for the top
         #     level AudienceFilterExpression.
+        #
+        #     Note: The following fields are mutually exclusive: `and_group`, `or_group`, `not_expression`, `dimension_or_metric_filter`, `event_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] or_group
         #   @return [::Google::Analytics::Admin::V1alpha::AudienceFilterExpressionList]
         #     A list of expressions to OR’ed together. It cannot contain
         #     AudienceFilterExpressions with and_group or or_group.
+        #
+        #     Note: The following fields are mutually exclusive: `or_group`, `and_group`, `not_expression`, `dimension_or_metric_filter`, `event_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] not_expression
         #   @return [::Google::Analytics::Admin::V1alpha::AudienceFilterExpression]
         #     A filter expression to be NOT'ed (For example, inverted, complemented).
         #     It can only include a dimension_or_metric_filter. This cannot be set on
         #     the top level AudienceFilterExpression.
+        #
+        #     Note: The following fields are mutually exclusive: `not_expression`, `and_group`, `or_group`, `dimension_or_metric_filter`, `event_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] dimension_or_metric_filter
         #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter]
         #     A filter on a single dimension or metric. This cannot be set on the top
         #     level AudienceFilterExpression.
+        #
+        #     Note: The following fields are mutually exclusive: `dimension_or_metric_filter`, `and_group`, `or_group`, `not_expression`, `event_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] event_filter
         #   @return [::Google::Analytics::Admin::V1alpha::AudienceEventFilter]
         #     Creates a filter that matches a specific event. This cannot be set on the
         #     top level AudienceFilterExpression.
+        #
+        #     Note: The following fields are mutually exclusive: `event_filter`, `and_group`, `or_group`, `not_expression`, `dimension_or_metric_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         class AudienceFilterExpression
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -295,10 +317,14 @@ module Google
         # @!attribute [rw] simple_filter
         #   @return [::Google::Analytics::Admin::V1alpha::AudienceSimpleFilter]
         #     A simple filter that a user must satisfy to be a member of the Audience.
+        #
+        #     Note: The following fields are mutually exclusive: `simple_filter`, `sequence_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] sequence_filter
         #   @return [::Google::Analytics::Admin::V1alpha::AudienceSequenceFilter]
         #     Filters that must occur in a specific order for the user to be a member
         #     of the Audience.
+        #
+        #     Note: The following fields are mutually exclusive: `sequence_filter`, `simple_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] clause_type
         #   @return [::Google::Analytics::Admin::V1alpha::AudienceFilterClause::AudienceClauseType]
         #     Required. Specifies whether this is an include or exclude filter clause.
@@ -344,7 +370,7 @@ module Google
           end
         end
 
-        # A resource message representing a GA4 Audience.
+        # A resource message representing an Audience.
         # @!attribute [r] name
         #   @return [::String]
         #     Output only. The resource name for this Audience resource.

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

@@ -25,10 +25,14 @@ module Google
         # @!attribute [rw] string_filter
         #   @return [::Google::Analytics::Admin::V1alpha::ChannelGroupFilter::StringFilter]
         #     A filter for a string-type dimension that matches a particular pattern.
+        #
+        #     Note: The following fields are mutually exclusive: `string_filter`, `in_list_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] in_list_filter
         #   @return [::Google::Analytics::Admin::V1alpha::ChannelGroupFilter::InListFilter]
         #     A filter for a string dimension that matches a particular list of
         #     options.
+        #
+        #     Note: The following fields are mutually exclusive: `in_list_filter`, `string_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] field_name
         #   @return [::String]
         #     Required. Immutable. The dimension name to filter.
@@ -90,19 +94,27 @@ module Google
         #     A list of expressions to be AND’ed together. It can only contain
         #     ChannelGroupFilterExpressions with or_group. This must be set for the
         #     top level ChannelGroupFilterExpression.
+        #
+        #     Note: The following fields are mutually exclusive: `and_group`, `or_group`, `not_expression`, `filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] or_group
         #   @return [::Google::Analytics::Admin::V1alpha::ChannelGroupFilterExpressionList]
         #     A list of expressions to OR’ed together. It cannot contain
         #     ChannelGroupFilterExpressions with and_group or or_group.
+        #
+        #     Note: The following fields are mutually exclusive: `or_group`, `and_group`, `not_expression`, `filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] not_expression
         #   @return [::Google::Analytics::Admin::V1alpha::ChannelGroupFilterExpression]
         #     A filter expression to be NOT'ed (that is inverted, complemented). It
         #     can only include a dimension_or_metric_filter. This cannot be set on the
         #     top level ChannelGroupFilterExpression.
+        #
+        #     Note: The following fields are mutually exclusive: `not_expression`, `and_group`, `or_group`, `filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] filter
         #   @return [::Google::Analytics::Admin::V1alpha::ChannelGroupFilter]
         #     A filter on a single dimension. This cannot be set on the top
         #     level ChannelGroupFilterExpression.
+        #
+        #     Note: The following fields are mutually exclusive: `filter`, `and_group`, `or_group`, `not_expression`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         class ChannelGroupFilterExpression
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -25,10 +25,14 @@ module Google
         # @!attribute [rw] string_filter
         #   @return [::Google::Analytics::Admin::V1alpha::ExpandedDataSetFilter::StringFilter]
         #     A filter for a string-type dimension that matches a particular pattern.
+        #
+        #     Note: The following fields are mutually exclusive: `string_filter`, `in_list_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!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.
+        #
+        #     Note: The following fields are mutually exclusive: `in_list_filter`, `string_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] field_name
         #   @return [::String]
         #     Required. The dimension name to filter.
@@ -89,15 +93,21 @@ module Google
         #     ExpandedDataSetFilterExpression with either not_expression or
         #     dimension_filter. This must be set for the top level
         #     ExpandedDataSetFilterExpression.
+        #
+        #     Note: The following fields are mutually exclusive: `and_group`, `not_expression`, `filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] not_expression
         #   @return [::Google::Analytics::Admin::V1alpha::ExpandedDataSetFilterExpression]
         #     A filter expression to be NOT'ed (that is, inverted, complemented). It
         #     must include a dimension_filter. This cannot be set on the
         #     top level ExpandedDataSetFilterExpression.
+        #
+        #     Note: The following fields are mutually exclusive: `not_expression`, `and_group`, `filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] filter
         #   @return [::Google::Analytics::Admin::V1alpha::ExpandedDataSetFilter]
         #     A filter on a single dimension. This cannot be set on the top
         #     level ExpandedDataSetFilterExpression.
+        #
+        #     Note: The following fields are mutually exclusive: `filter`, `and_group`, `not_expression`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         class ExpandedDataSetFilterExpression
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -112,7 +122,7 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # A resource message representing a GA4 ExpandedDataSet.
+        # A resource message representing an `ExpandedDataSet`.
         # @!attribute [r] name
         #   @return [::String]
         #     Output only. The resource name for this ExpandedDataSet resource.