google-analytics-admin-v1alpha 0.17.0 → 0.19.0

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

@@ -0,0 +1,158 @@
+# 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::ChannelGroupFilter::StringFilter]
+        #     A filter for a string-type dimension that matches a particular pattern.
+        # @!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.
+        # @!attribute [rw] field_name
+        #   @return [::String]
+        #     Required. Immutable. The dimension name to filter.
+        class ChannelGroupFilter
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Filter where the field value is a String. The match is case insensitive.
+          # @!attribute [rw] match_type
+          #   @return [::Google::Analytics::Admin::V1alpha::ChannelGroupFilter::StringFilter::MatchType]
+          #     Required. The match type for the string filter.
+          # @!attribute [rw] value
+          #   @return [::String]
+          #     Required. The string value to be matched against.
+          class StringFilter
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # How the filter will be used to determine a match.
+            module MatchType
+              # Default match type.
+              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 match with the string value.
+              FULL_REGEXP = 5
+
+              # Partial regular expression match with the string value.
+              PARTIAL_REGEXP = 6
+            end
+          end
+
+          # A filter for a string dimension that matches a particular list of options.
+          # The match is case insensitive.
+          # @!attribute [rw] values
+          #   @return [::Array<::String>]
+          #     Required. The list of possible string values to match against. Must be
+          #     non-empty.
+          class InListFilter
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # A logical expression of Channel Group dimension filters.
+        # @!attribute [rw] and_group
+        #   @return [::Google::Analytics::Admin::V1alpha::ChannelGroupFilterExpressionList]
+        #     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.
+        # @!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.
+        # @!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.
+        # @!attribute [rw] filter
+        #   @return [::Google::Analytics::Admin::V1alpha::ChannelGroupFilter]
+        #     A filter on a single dimension. This cannot be set on the top
+        #     level ChannelGroupFilterExpression.
+        class ChannelGroupFilterExpression
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A list of Channel Group filter expressions.
+        # @!attribute [rw] filter_expressions
+        #   @return [::Array<::Google::Analytics::Admin::V1alpha::ChannelGroupFilterExpression>]
+        #     A list of Channel Group filter expressions.
+        class ChannelGroupFilterExpressionList
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The rules that govern how traffic is grouped into one channel.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. Customer defined display name for the channel.
+        # @!attribute [rw] expression
+        #   @return [::Google::Analytics::Admin::V1alpha::ChannelGroupFilterExpression]
+        #     Required. The Filter Expression that defines the Grouping Rule.
+        class GroupingRule
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A resource message representing a Channel Group.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. The resource name for this Channel Group resource.
+        #     Format: properties/\\{property}/channelGroups/\\{channel_group}
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. The display name of the Channel Group. Max length of 80
+        #     characters.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     The description of the Channel Group. Max length of 256 characters.
+        # @!attribute [rw] grouping_rule
+        #   @return [::Array<::Google::Analytics::Admin::V1alpha::GroupingRule>]
+        #     Required. The grouping rules of channels. Maximum number of rules is 25.
+        # @!attribute [r] system_defined
+        #   @return [::Boolean]
+        #     Output only. Default Channel Group defined by Google, which cannot be
+        #     updated.
+        class ChannelGroup
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,167 @@
+# 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
+        # Defines an event parameter to mutate.
+        # @!attribute [rw] parameter
+        #   @return [::String]
+        #     Required. The name of the parameter to mutate.
+        #     This value must:
+        #     * be less than 40 characters.
+        #     * be unique across across all mutations within the rule
+        #     * consist only of letters, digits or _ (underscores)
+        #     For event edit rules, the name may also be set to 'event_name' to modify
+        #     the event_name in place.
+        # @!attribute [rw] parameter_value
+        #   @return [::String]
+        #     Required. The value mutation to perform.
+        #     * Must be less than 100 characters.
+        #     * To specify a constant value for the param, use the value's string.
+        #     * To copy value from another parameter, use syntax like
+        #     "[[other_parameter]]" For more details, see this [help center
+        #     article](https://support.google.com/analytics/answer/10085872#modify-an-event&zippy=%2Cin-this-article%2Cmodify-parameters).
+        class ParameterMutation
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # An Event Create Rule defines conditions that will trigger the creation
+        # of an entirely new event based upon matched criteria of a source event.
+        # Additional mutations of the parameters from the source event can be defined.
+        #
+        # Unlike Event Edit rules, Event Creation Rules have no defined order.  They
+        # will all be run independently.
+        #
+        # Event Edit and Event Create rules can't be used to modify an event created
+        # from an Event Create rule.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. Resource name for this EventCreateRule resource.
+        #     Format:
+        #     properties/\\{property}/dataStreams/\\{data_stream}/eventCreateRules/\\{event_create_rule}
+        # @!attribute [rw] destination_event
+        #   @return [::String]
+        #     Required. The name of the new event to be created.
+        #
+        #     This value must:
+        #     * be less than 40 characters
+        #     * consist only of letters, digits or _ (underscores)
+        #     * start with a letter
+        # @!attribute [rw] event_conditions
+        #   @return [::Array<::Google::Analytics::Admin::V1alpha::MatchingCondition>]
+        #     Required. Must have at least one condition, and can have up to 10 max.
+        #     Conditions on the source event must match for this rule to be applied.
+        # @!attribute [rw] source_copy_parameters
+        #   @return [::Boolean]
+        #     If true, the source parameters are copied to the new event.
+        #     If false, or unset, all non-internal parameters are not copied from the
+        #     source event. Parameter mutations are applied after the parameters have
+        #     been copied.
+        # @!attribute [rw] parameter_mutations
+        #   @return [::Array<::Google::Analytics::Admin::V1alpha::ParameterMutation>]
+        #     Parameter mutations define parameter behavior on the new event, and
+        #     are applied in order.
+        #     A maximum of 20 mutations can be applied.
+        class EventCreateRule
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Defines a condition for when an Event Edit or Event Creation rule applies to
+        # an event.
+        # @!attribute [rw] field
+        #   @return [::String]
+        #     Required. The name of the field that is compared against for the condition.
+        #     If 'event_name' is specified this condition will apply to the name of the
+        #     event.  Otherwise the condition will apply to a parameter with the
+        #     specified name.
+        #
+        #     This value cannot contain spaces.
+        # @!attribute [rw] comparison_type
+        #   @return [::Google::Analytics::Admin::V1alpha::MatchingCondition::ComparisonType]
+        #     Required. The type of comparison to be applied to the value.
+        # @!attribute [rw] value
+        #   @return [::String]
+        #     Required. The value being compared against for this condition.  The runtime
+        #     implementation may perform type coercion of this value to evaluate this
+        #     condition based on the type of the parameter value.
+        # @!attribute [rw] negated
+        #   @return [::Boolean]
+        #     Whether or not the result of the comparison should be negated. For example,
+        #     if `negated` is true, then 'equals' comparisons would function as 'not
+        #     equals'.
+        class MatchingCondition
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Comparison type for matching condition
+          module ComparisonType
+            # Unknown
+            COMPARISON_TYPE_UNSPECIFIED = 0
+
+            # Equals, case sensitive
+            EQUALS = 1
+
+            # Equals, case insensitive
+            EQUALS_CASE_INSENSITIVE = 2
+
+            # Contains, case sensitive
+            CONTAINS = 3
+
+            # Contains, case insensitive
+            CONTAINS_CASE_INSENSITIVE = 4
+
+            # Starts with, case sensitive
+            STARTS_WITH = 5
+
+            # Starts with, case insensitive
+            STARTS_WITH_CASE_INSENSITIVE = 6
+
+            # Ends with, case sensitive
+            ENDS_WITH = 7
+
+            # Ends with, case insensitive
+            ENDS_WITH_CASE_INSENSITIVE = 8
+
+            # Greater than
+            GREATER_THAN = 9
+
+            # Greater than or equal
+            GREATER_THAN_OR_EQUAL = 10
+
+            # Less than
+            LESS_THAN = 11
+
+            # Less than or equal
+            LESS_THAN_OR_EQUAL = 12
+
+            # regular expression. Only supported for web streams.
+            REGULAR_EXPRESSION = 13
+
+            # regular expression, case insensitive. Only supported for web streams.
+            REGULAR_EXPRESSION_CASE_INSENSITIVE = 14
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -91,7 +91,7 @@ module Google
         #     ExpandedDataSetFilterExpression.
         # @!attribute [rw] not_expression
         #   @return [::Google::Analytics::Admin::V1alpha::ExpandedDataSetFilterExpression]
-        #     A filter expression to be NOT'ed (i.e., inverted, complemented). It
+        #     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.
         # @!attribute [rw] filter
@@ -141,7 +141,7 @@ module Google
         #   @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`.
+        #     the number of rows and thus the chance 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/proto_docs/google/analytics/admin/v1alpha/resources.rb

@@ -549,12 +549,24 @@ module Google
           # @!attribute [rw] expanded_data_set
           #   @return [::Google::Analytics::Admin::V1alpha::ExpandedDataSet]
           #     A snapshot of an ExpandedDataSet resource in change history.
+          # @!attribute [rw] channel_group
+          #   @return [::Google::Analytics::Admin::V1alpha::ChannelGroup]
+          #     A snapshot of a ChannelGroup resource in change history.
           # @!attribute [rw] bigquery_link
           #   @return [::Google::Analytics::Admin::V1alpha::BigQueryLink]
           #     A snapshot of a BigQuery link resource in change history.
           # @!attribute [rw] enhanced_measurement_settings
           #   @return [::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings]
           #     A snapshot of EnhancedMeasurementSettings resource in change history.
+          # @!attribute [rw] adsense_link
+          #   @return [::Google::Analytics::Admin::V1alpha::AdSenseLink]
+          #     A snapshot of an AdSenseLink resource in change history.
+          # @!attribute [rw] audience
+          #   @return [::Google::Analytics::Admin::V1alpha::Audience]
+          #     A snapshot of an Audience resource in change history.
+          # @!attribute [rw] event_create_rule
+          #   @return [::Google::Analytics::Admin::V1alpha::EventCreateRule]
+          #     A snapshot of an EventCreateRule resource in change history.
           class ChangeHistoryResource
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -761,6 +773,9 @@ module Google
         #     If this is an event-scoped dimension, then this is the event parameter
         #     name.
         #
+        #     If this is an item-scoped dimension, then this is the parameter
+        #     name found in the eCommerce items array.
+        #
         #     May only contain alphanumeric and underscore characters, starting with a
         #     letter. Max length of 24 characters for user-scoped dimensions, 40
         #     characters for event-scoped dimensions.
@@ -798,6 +813,9 @@ module Google
 
             # Dimension scoped to a user.
             USER = 2
+
+            # Dimension scoped to eCommerce items
+            ITEM = 3
           end
         end
 
@@ -1189,6 +1207,21 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # A link between a GA4 Property and an AdSense for Content ad client.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. The resource name for this AdSense Link resource.
+        #     Format: properties/\\{propertyId}/adSenseLinks/\\{linkId}
+        #     Example: properties/1234/adSenseLinks/6789
+        # @!attribute [rw] ad_client_code
+        #   @return [::String]
+        #     Immutable. The AdSense ad client code that the GA4 property is linked to.
+        #     Example format: "ca-pub-1234567890"
+        class AdSenseLink
+          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
@@ -1374,6 +1407,15 @@ module Google
 
           # EnhancedMeasurementSettings resource
           ENHANCED_MEASUREMENT_SETTINGS = 24
+
+          # AdSenseLink resource
+          ADSENSE_LINK = 27
+
+          # Audience resource
+          AUDIENCE = 28
+
+          # EventCreateRule resource
+          EVENT_CREATE_RULE = 29
         end
 
         # Status of the Google Signals settings.

data/proto_docs/google/api/client.rb

@@ -83,7 +83,7 @@ module Google
     #     long-running operation pattern.
     # @!attribute [rw] new_issue_uri
     #   @return [::String]
-    #     Link to a place that API users can report issues.  Example:
+    #     Link to a *public* URI where users can report issues.  Example:
     #     https://issuetracker.google.com/issues/new?component=190865&template=1161103
     # @!attribute [rw] documentation_uri
     #   @return [::String]
@@ -209,9 +209,57 @@ module Google
     # @!attribute [rw] common
     #   @return [::Google::Api::CommonLanguageSettings]
     #     Some settings.
+    # @!attribute [rw] renamed_services
+    #   @return [::Google::Protobuf::Map{::String => ::String}]
+    #     Map from original service names to renamed versions.
+    #     This is used when the default generated types
+    #     would cause a naming conflict. (Neither name is
+    #     fully-qualified.)
+    #     Example: Subscriber to SubscriberServiceApi.
+    # @!attribute [rw] renamed_resources
+    #   @return [::Google::Protobuf::Map{::String => ::String}]
+    #     Map from full resource types to the effective short name
+    #     for the resource. This is used when otherwise resource
+    #     named from different services would cause naming collisions.
+    #     Example entry:
+    #     "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
+    # @!attribute [rw] ignored_resources
+    #   @return [::Array<::String>]
+    #     List of full resource types to ignore during generation.
+    #     This is typically used for API-specific Location resources,
+    #     which should be handled by the generator as if they were actually
+    #     the common Location resources.
+    #     Example entry: "documentai.googleapis.com/Location"
+    # @!attribute [rw] forced_namespace_aliases
+    #   @return [::Array<::String>]
+    #     Namespaces which must be aliased in snippets due to
+    #     a known (but non-generator-predictable) naming collision
+    # @!attribute [rw] handwritten_signatures
+    #   @return [::Array<::String>]
+    #     Method signatures (in the form "service.method(signature)")
+    #     which are provided separately, so shouldn't be generated.
+    #     Snippets *calling* these methods are still generated, however.
     class DotnetSettings
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # @!attribute [rw] key
+      #   @return [::String]
+      # @!attribute [rw] value
+      #   @return [::String]
+      class RenamedServicesEntry
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
+
+      # @!attribute [rw] key
+      #   @return [::String]
+      # @!attribute [rw] value
+      #   @return [::String]
+      class RenamedResourcesEntry
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
     end
 
     # Settings for Ruby client libraries.
@@ -305,6 +353,15 @@ module Google
 
       # Street View Org.
       STREET_VIEW = 4
+
+      # Shopping Org.
+      SHOPPING = 5
+
+      # Geo Org.
+      GEO = 6
+
+      # Generative AI - https://developers.generativeai.google
+      GENERATIVE_AI = 7
     end
 
     # To where should client libraries be published?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-analytics-admin-v1alpha
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-23 00:00:00.000000000 Z
+date: 2023-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -183,6 +183,8 @@ files:
 - lib/google/analytics/admin/v1alpha/analytics_admin_service/rest/service_stub.rb
 - lib/google/analytics/admin/v1alpha/analytics_admin_services_pb.rb
 - lib/google/analytics/admin/v1alpha/audience_pb.rb
+- lib/google/analytics/admin/v1alpha/channel_group_pb.rb
+- lib/google/analytics/admin/v1alpha/event_create_and_edit_pb.rb
 - 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
@@ -191,6 +193,8 @@ files:
 - proto_docs/google/analytics/admin/v1alpha/access_report.rb
 - proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb
 - proto_docs/google/analytics/admin/v1alpha/audience.rb
+- proto_docs/google/analytics/admin/v1alpha/channel_group.rb
+- 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/api/client.rb