google-apis-analyticsdata_v1beta 0.35.0 → 0.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 517f29df6df17dc4f5807875dd1b2a611463faa0fac2c3b58356298dbb38087c
-  data.tar.gz: 92df3f7ed57002204072f2bd311d85ae7d212825b21037fe7b6e901ae7e54c22
+  metadata.gz: b855afea40621b074ffd7be8aaf4b1678cfeb04d77d77ed98c48ae25092f9968
+  data.tar.gz: c88f7e1808465b2bef4aa0d4e28d5a96a21590e15afaf7a8d9e399d034f78827
 SHA512:
-  metadata.gz: d7c6fade76738b871ce716be3bc9e087701379258ea92b0b20de89c8dd46120cad14a922d4f6ac28f5ac048f9f3ec14e18d13999aaa8fdfe8e4e14a19a856b0f
-  data.tar.gz: 6438840c8043dbb0e33d5fea5572bc66af5a771c8be81436f957d77b2a96369030a155c7b61b0df0f9fb9292bd8a7a4340f5d4146bcb40cbf99353f8045770b1
+  metadata.gz: f5780e614ef1b4222d2e2dd35bfff0618c59fff5b141fe8474f6714de84c6f03cd0a2d0131e33c298b7b266fb26701761f5955cb45c82f44951555a74f474c6c
+  data.tar.gz: 94143a3c53e0cbacfe6f2434c426b4df07a3c771a0d3bce1eca7cdd9a4456361c95deb512f894910e080a0d4862fcac35df5a87512905c299fb67dbc675e4473

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Release history for google-apis-analyticsdata_v1beta
 
+### v0.37.0 (2024-08-04)
+
+* Regenerated from discovery document revision 20240731
+* Regenerated using generator version 0.15.1
+
+### v0.36.0 (2024-05-19)
+
+* Regenerated from discovery document revision 20240512
+* Regenerated using generator version 0.15.0
+
 ### v0.35.0 (2024-02-24)
 
 * Regenerated using generator version 0.14.0

data/lib/google/apis/analyticsdata_v1beta/classes.rb

@@ -514,6 +514,74 @@ module Google
         end
       end
       
+      # Defines an individual comparison. Most requests will include multiple
+      # comparisons so that the report compares between the comparisons.
+      class Comparison
+        include Google::Apis::Core::Hashable
+      
+        # A saved comparison identified by the comparison's resource name. For example, '
+        # comparisons/1234'.
+        # Corresponds to the JSON property `comparison`
+        # @return [String]
+        attr_accessor :comparison
+      
+        # To express dimension or metric filters. The fields in the same
+        # FilterExpression need to be either all dimensions or all metrics.
+        # Corresponds to the JSON property `dimensionFilter`
+        # @return [Google::Apis::AnalyticsdataV1beta::FilterExpression]
+        attr_accessor :dimension_filter
+      
+        # Each comparison produces separate rows in the response. In the response, this
+        # comparison is identified by this name. If name is unspecified, we will use the
+        # saved comparisons display name.
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @comparison = args[:comparison] if args.key?(:comparison)
+          @dimension_filter = args[:dimension_filter] if args.key?(:dimension_filter)
+          @name = args[:name] if args.key?(:name)
+        end
+      end
+      
+      # The metadata for a single comparison.
+      class ComparisonMetadata
+        include Google::Apis::Core::Hashable
+      
+        # This comparison's resource name. Useable in [Comparison](#Comparison)'s `
+        # comparison` field. For example, 'comparisons/1234'.
+        # Corresponds to the JSON property `apiName`
+        # @return [String]
+        attr_accessor :api_name
+      
+        # This comparison's description.
+        # Corresponds to the JSON property `description`
+        # @return [String]
+        attr_accessor :description
+      
+        # This comparison's name within the Google Analytics user interface.
+        # Corresponds to the JSON property `uiName`
+        # @return [String]
+        attr_accessor :ui_name
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @api_name = args[:api_name] if args.key?(:api_name)
+          @description = args[:description] if args.key?(:description)
+          @ui_name = args[:ui_name] if args.key?(:ui_name)
+        end
+      end
+      
       # Used to combine dimension values to a single dimension.
       class ConcatenateExpression
         include Google::Apis::Core::Hashable
@@ -975,6 +1043,11 @@ module Google
       class Metadata
         include Google::Apis::Core::Hashable
       
+        # The comparison descriptions.
+        # Corresponds to the JSON property `comparisons`
+        # @return [Array<Google::Apis::AnalyticsdataV1beta::ComparisonMetadata>]
+        attr_accessor :comparisons
+      
         # The dimension descriptions.
         # Corresponds to the JSON property `dimensions`
         # @return [Array<Google::Apis::AnalyticsdataV1beta::DimensionMetadata>]
@@ -996,6 +1069,7 @@ module Google
       
         # Update properties of this object
         def update!(**args)
+          @comparisons = args[:comparisons] if args.key?(:comparisons)
           @dimensions = args[:dimensions] if args.key?(:dimensions)
           @metrics = args[:metrics] if args.key?(:metrics)
           @name = args[:name] if args.key?(:name)
@@ -1879,6 +1953,13 @@ module Google
         # @return [Google::Apis::AnalyticsdataV1beta::CohortSpec]
         attr_accessor :cohort_spec
       
+        # Optional. The configuration of comparisons requested and displayed. The
+        # request requires both a comparisons field and a comparisons dimension to
+        # receive a comparison column in the response.
+        # Corresponds to the JSON property `comparisons`
+        # @return [Array<Google::Apis::AnalyticsdataV1beta::Comparison>]
+        attr_accessor :comparisons
+      
         # A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field
         # is empty, the report uses the property's default currency.
         # Corresponds to the JSON property `currencyCode`
@@ -1963,6 +2044,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @cohort_spec = args[:cohort_spec] if args.key?(:cohort_spec)
+          @comparisons = args[:comparisons] if args.key?(:comparisons)
           @currency_code = args[:currency_code] if args.key?(:currency_code)
           @date_ranges = args[:date_ranges] if args.key?(:date_ranges)
           @dimension_filter = args[:dimension_filter] if args.key?(:dimension_filter)
@@ -2231,6 +2313,13 @@ module Google
         # @return [Google::Apis::AnalyticsdataV1beta::CohortSpec]
         attr_accessor :cohort_spec
       
+        # Optional. The configuration of comparisons requested and displayed. The
+        # request only requires a comparisons field in order to receive a comparison
+        # column in the response.
+        # Corresponds to the JSON property `comparisons`
+        # @return [Array<Google::Apis::AnalyticsdataV1beta::Comparison>]
+        attr_accessor :comparisons
+      
         # A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field
         # is empty, the report uses the property's default currency.
         # Corresponds to the JSON property `currencyCode`
@@ -2283,7 +2372,9 @@ module Google
         attr_accessor :limit
       
         # Aggregation of metrics. Aggregated metric values will be shown in rows where
-        # the dimension_values are set to "RESERVED_(MetricAggregation)".
+        # the dimension_values are set to "RESERVED_(MetricAggregation)". Aggregates
+        # including both comparisons and multiple date ranges will be aggregated based
+        # on the date ranges.
         # Corresponds to the JSON property `metricAggregations`
         # @return [Array<String>]
         attr_accessor :metric_aggregations
@@ -2310,7 +2401,9 @@ module Google
         # @return [Fixnum]
         attr_accessor :offset
       
-        # Specifies how rows are ordered in the response.
+        # Specifies how rows are ordered in the response. Requests including both
+        # comparisons and multiple date ranges will have order bys applied on the
+        # comparisons.
         # Corresponds to the JSON property `orderBys`
         # @return [Array<Google::Apis::AnalyticsdataV1beta::OrderBy>]
         attr_accessor :order_bys
@@ -2339,6 +2432,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @cohort_spec = args[:cohort_spec] if args.key?(:cohort_spec)
+          @comparisons = args[:comparisons] if args.key?(:comparisons)
           @currency_code = args[:currency_code] if args.key?(:currency_code)
           @date_ranges = args[:date_ranges] if args.key?(:date_ranges)
           @dimension_filter = args[:dimension_filter] if args.key?(:dimension_filter)

data/lib/google/apis/analyticsdata_v1beta/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module AnalyticsdataV1beta
       # Version of the google-apis-analyticsdata_v1beta gem
-      GEM_VERSION = "0.35.0"
+      GEM_VERSION = "0.37.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.14.0"
+      GENERATOR_VERSION = "0.15.1"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20240128"
+      REVISION = "20240731"
     end
   end
 end

data/lib/google/apis/analyticsdata_v1beta/representations.rb

@@ -112,6 +112,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class Comparison
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class ComparisonMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class ConcatenateExpression
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -557,6 +569,25 @@ module Google
         end
       end
       
+      class Comparison
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :comparison, as: 'comparison'
+          property :dimension_filter, as: 'dimensionFilter', class: Google::Apis::AnalyticsdataV1beta::FilterExpression, decorator: Google::Apis::AnalyticsdataV1beta::FilterExpression::Representation
+      
+          property :name, as: 'name'
+        end
+      end
+      
+      class ComparisonMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :api_name, as: 'apiName'
+          property :description, as: 'description'
+          property :ui_name, as: 'uiName'
+        end
+      end
+      
       class ConcatenateExpression
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -695,6 +726,8 @@ module Google
       class Metadata
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
+          collection :comparisons, as: 'comparisons', class: Google::Apis::AnalyticsdataV1beta::ComparisonMetadata, decorator: Google::Apis::AnalyticsdataV1beta::ComparisonMetadata::Representation
+      
           collection :dimensions, as: 'dimensions', class: Google::Apis::AnalyticsdataV1beta::DimensionMetadata, decorator: Google::Apis::AnalyticsdataV1beta::DimensionMetadata::Representation
       
           collection :metrics, as: 'metrics', class: Google::Apis::AnalyticsdataV1beta::MetricMetadata, decorator: Google::Apis::AnalyticsdataV1beta::MetricMetadata::Representation
@@ -930,6 +963,8 @@ module Google
         class Representation < Google::Apis::Core::JsonRepresentation
           property :cohort_spec, as: 'cohortSpec', class: Google::Apis::AnalyticsdataV1beta::CohortSpec, decorator: Google::Apis::AnalyticsdataV1beta::CohortSpec::Representation
       
+          collection :comparisons, as: 'comparisons', class: Google::Apis::AnalyticsdataV1beta::Comparison, decorator: Google::Apis::AnalyticsdataV1beta::Comparison::Representation
+      
           property :currency_code, as: 'currencyCode'
           collection :date_ranges, as: 'dateRanges', class: Google::Apis::AnalyticsdataV1beta::DateRange, decorator: Google::Apis::AnalyticsdataV1beta::DateRange::Representation
       
@@ -1018,6 +1053,8 @@ module Google
         class Representation < Google::Apis::Core::JsonRepresentation
           property :cohort_spec, as: 'cohortSpec', class: Google::Apis::AnalyticsdataV1beta::CohortSpec, decorator: Google::Apis::AnalyticsdataV1beta::CohortSpec::Representation
       
+          collection :comparisons, as: 'comparisons', class: Google::Apis::AnalyticsdataV1beta::Comparison, decorator: Google::Apis::AnalyticsdataV1beta::Comparison::Representation
+      
           property :currency_code, as: 'currencyCode'
           collection :date_ranges, as: 'dateRanges', class: Google::Apis::AnalyticsdataV1beta::DateRange, decorator: Google::Apis::AnalyticsdataV1beta::DateRange::Representation
       

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-analyticsdata_v1beta
 version: !ruby/object:Gem::Version
-  version: 0.35.0
+  version: 0.37.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-25 00:00:00.000000000 Z
+date: 2024-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.15.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.15.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-analyticsdata_v1beta/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsdata_v1beta/v0.35.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsdata_v1beta/v0.37.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-analyticsdata_v1beta
 post_install_message: 
 rdoc_options: []