google-apis-analyticsdata_v1beta 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c43297e4165777adafb6b161944f1fe3f6d93cac0e4cd66963cf726e76ae17f1
-  data.tar.gz: bf9ceea4e69014d627e50df9ac7933b4249a238a2711775c25811daca5dff470
+  metadata.gz: aebbab886c0e4d17faf9b94cba17139b5664973e852365d1d458a566d4d1da37
+  data.tar.gz: f542ea9bf8630ceb54ecb22a5839ef6b31a11622d65f700336af11b0f2181248
 SHA512:
-  metadata.gz: b6203ac39f8c4b1c6c36bdf247204fa60eaa96b6fb11bc6a82806057fda6c1ece5e4cf561fc52e02ba5ab577a1c7b022f39befc43a1e3d1a2d93831e5c100aeb
-  data.tar.gz: aec142e8be710b8f4765fb07c9010cc637408d4a069821b49f426f673fc82abc02780094b626ec60d2a9be6d4bd0e01178f43976a5b4cd0d111c84984edc5083
+  metadata.gz: 9f5745d90be012abe2a7b42574396d9d2f977c81c4836514796e07e84f9da85a0e7c5b32a79b48fcf63d2d69fc743089b42c0fbeb26c8dc79a4821cbb613d99a
+  data.tar.gz: 5607c47f1063b0698197a2283da9ab2fd564b3adf35dd10345445f3d7dd664dbe44c29462d32d6e01b0859e2fbb5dfce9a8df9216ecc7d02ef3177d9a1f88995

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-analyticsdata_v1beta
 
+### v0.6.0 (2021-08-26)
+
+* Regenerated from discovery document revision 20210824
+
 ### v0.5.0 (2021-06-29)
 
 * Regenerated from discovery document revision 20210625

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

@@ -161,6 +161,83 @@ module Google
         end
       end
       
+      # The request for compatibility information for a report's dimensions and
+      # metrics. Check compatibility provides a preview of the compatibility of a
+      # report; fields shared with the `runReport` request should be the same values
+      # as in your `runReport` request.
+      class CheckCompatibilityRequest
+        include Google::Apis::Core::Hashable
+      
+        # Filters the dimensions and metrics in the response to just this compatibility.
+        # Commonly used as `”compatibilityFilter”: “COMPATIBLE”` to only return
+        # compatible dimensions & metrics.
+        # Corresponds to the JSON property `compatibilityFilter`
+        # @return [String]
+        attr_accessor :compatibility_filter
+      
+        # 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
+      
+        # The dimensions in this report. `dimensions` should be the same value as in
+        # your `runReport` request.
+        # Corresponds to the JSON property `dimensions`
+        # @return [Array<Google::Apis::AnalyticsdataV1beta::Dimension>]
+        attr_accessor :dimensions
+      
+        # 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 `metricFilter`
+        # @return [Google::Apis::AnalyticsdataV1beta::FilterExpression]
+        attr_accessor :metric_filter
+      
+        # The metrics in this report. `metrics` should be the same value as in your `
+        # runReport` request.
+        # Corresponds to the JSON property `metrics`
+        # @return [Array<Google::Apis::AnalyticsdataV1beta::Metric>]
+        attr_accessor :metrics
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @compatibility_filter = args[:compatibility_filter] if args.key?(:compatibility_filter)
+          @dimension_filter = args[:dimension_filter] if args.key?(:dimension_filter)
+          @dimensions = args[:dimensions] if args.key?(:dimensions)
+          @metric_filter = args[:metric_filter] if args.key?(:metric_filter)
+          @metrics = args[:metrics] if args.key?(:metrics)
+        end
+      end
+      
+      # The compatibility response with the compatibility of each dimension & metric.
+      class CheckCompatibilityResponse
+        include Google::Apis::Core::Hashable
+      
+        # The compatibility of each dimension.
+        # Corresponds to the JSON property `dimensionCompatibilities`
+        # @return [Array<Google::Apis::AnalyticsdataV1beta::DimensionCompatibility>]
+        attr_accessor :dimension_compatibilities
+      
+        # The compatibility of each metric.
+        # Corresponds to the JSON property `metricCompatibilities`
+        # @return [Array<Google::Apis::AnalyticsdataV1beta::MetricCompatibility>]
+        attr_accessor :metric_compatibilities
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @dimension_compatibilities = args[:dimension_compatibilities] if args.key?(:dimension_compatibilities)
+          @metric_compatibilities = args[:metric_compatibilities] if args.key?(:metric_compatibilities)
+        end
+      end
+      
       # Defines a cohort selection criteria. A cohort is a group of users who share a
       # common characteristic. For example, users with the same `firstSessionDate`
       # belong to the same cohort.
@@ -421,6 +498,32 @@ module Google
         end
       end
       
+      # The compatibility for a single dimension.
+      class DimensionCompatibility
+        include Google::Apis::Core::Hashable
+      
+        # The compatibility of this dimension. If the compatibility is COMPATIBLE, this
+        # dimension can be successfully added to the report.
+        # Corresponds to the JSON property `compatibility`
+        # @return [String]
+        attr_accessor :compatibility
+      
+        # Explains a dimension.
+        # Corresponds to the JSON property `dimensionMetadata`
+        # @return [Google::Apis::AnalyticsdataV1beta::DimensionMetadata]
+        attr_accessor :dimension_metadata
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @compatibility = args[:compatibility] if args.key?(:compatibility)
+          @dimension_metadata = args[:dimension_metadata] if args.key?(:dimension_metadata)
+        end
+      end
+      
       # Used to express a dimension which is the result of a formula of multiple
       # dimensions. Example usages: 1) lower_case(dimension) 2) concatenate(dimension1,
       # symbol, dimension2).
@@ -486,6 +589,12 @@ module Google
         # @return [String]
         attr_accessor :api_name
       
+        # The display name of the category that this dimension belongs to. Similar
+        # dimensions and metrics are categorized together.
+        # Corresponds to the JSON property `category`
+        # @return [String]
+        attr_accessor :category
+      
         # True if the dimension is a custom dimension for this property.
         # Corresponds to the JSON property `customDefinition`
         # @return [Boolean]
@@ -518,6 +627,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @api_name = args[:api_name] if args.key?(:api_name)
+          @category = args[:category] if args.key?(:category)
           @custom_definition = args[:custom_definition] if args.key?(:custom_definition)
           @deprecated_api_names = args[:deprecated_api_names] if args.key?(:deprecated_api_names)
           @description = args[:description] if args.key?(:description)
@@ -771,6 +881,32 @@ module Google
         end
       end
       
+      # The compatibility for a single metric.
+      class MetricCompatibility
+        include Google::Apis::Core::Hashable
+      
+        # The compatibility of this metric. If the compatibility is COMPATIBLE, this
+        # metric can be successfully added to the report.
+        # Corresponds to the JSON property `compatibility`
+        # @return [String]
+        attr_accessor :compatibility
+      
+        # Explains a metric.
+        # Corresponds to the JSON property `metricMetadata`
+        # @return [Google::Apis::AnalyticsdataV1beta::MetricMetadata]
+        attr_accessor :metric_metadata
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @compatibility = args[:compatibility] if args.key?(:compatibility)
+          @metric_metadata = args[:metric_metadata] if args.key?(:metric_metadata)
+        end
+      end
+      
       # Describes a metric column in the report. Visible metrics requested in a report
       # produce column entries within rows and MetricHeaders. However, metrics used
       # exclusively within filters or expressions do not produce columns in a report;
@@ -809,6 +945,12 @@ module Google
         # @return [String]
         attr_accessor :api_name
       
+        # The display name of the category that this metrics belongs to. Similar
+        # dimensions and metrics are categorized together.
+        # Corresponds to the JSON property `category`
+        # @return [String]
+        attr_accessor :category
+      
         # True if the metric is a custom metric for this property.
         # Corresponds to the JSON property `customDefinition`
         # @return [Boolean]
@@ -853,6 +995,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @api_name = args[:api_name] if args.key?(:api_name)
+          @category = args[:category] if args.key?(:category)
           @custom_definition = args[:custom_definition] if args.key?(:custom_definition)
           @deprecated_api_names = args[:deprecated_api_names] if args.key?(:deprecated_api_names)
           @description = args[:description] if args.key?(:description)

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.5.0"
+      GEM_VERSION = "0.6.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.4.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20210625"
+      REVISION = "20210824"
     end
   end
 end

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

@@ -58,6 +58,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class CheckCompatibilityRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class CheckCompatibilityResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Cohort
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -100,6 +112,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class DimensionCompatibility
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class DimensionExpression
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -166,6 +184,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class MetricCompatibility
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class MetricHeader
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -361,6 +385,31 @@ module Google
         end
       end
       
+      class CheckCompatibilityRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :compatibility_filter, as: 'compatibilityFilter'
+          property :dimension_filter, as: 'dimensionFilter', class: Google::Apis::AnalyticsdataV1beta::FilterExpression, decorator: Google::Apis::AnalyticsdataV1beta::FilterExpression::Representation
+      
+          collection :dimensions, as: 'dimensions', class: Google::Apis::AnalyticsdataV1beta::Dimension, decorator: Google::Apis::AnalyticsdataV1beta::Dimension::Representation
+      
+          property :metric_filter, as: 'metricFilter', class: Google::Apis::AnalyticsdataV1beta::FilterExpression, decorator: Google::Apis::AnalyticsdataV1beta::FilterExpression::Representation
+      
+          collection :metrics, as: 'metrics', class: Google::Apis::AnalyticsdataV1beta::Metric, decorator: Google::Apis::AnalyticsdataV1beta::Metric::Representation
+      
+        end
+      end
+      
+      class CheckCompatibilityResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :dimension_compatibilities, as: 'dimensionCompatibilities', class: Google::Apis::AnalyticsdataV1beta::DimensionCompatibility, decorator: Google::Apis::AnalyticsdataV1beta::DimensionCompatibility::Representation
+      
+          collection :metric_compatibilities, as: 'metricCompatibilities', class: Google::Apis::AnalyticsdataV1beta::MetricCompatibility, decorator: Google::Apis::AnalyticsdataV1beta::MetricCompatibility::Representation
+      
+        end
+      end
+      
       class Cohort
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -425,6 +474,15 @@ module Google
         end
       end
       
+      class DimensionCompatibility
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :compatibility, as: 'compatibility'
+          property :dimension_metadata, as: 'dimensionMetadata', class: Google::Apis::AnalyticsdataV1beta::DimensionMetadata, decorator: Google::Apis::AnalyticsdataV1beta::DimensionMetadata::Representation
+      
+        end
+      end
+      
       class DimensionExpression
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -448,6 +506,7 @@ module Google
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
           property :api_name, as: 'apiName'
+          property :category, as: 'category'
           property :custom_definition, as: 'customDefinition'
           collection :deprecated_api_names, as: 'deprecatedApiNames'
           property :description, as: 'description'
@@ -535,6 +594,15 @@ module Google
         end
       end
       
+      class MetricCompatibility
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :compatibility, as: 'compatibility'
+          property :metric_metadata, as: 'metricMetadata', class: Google::Apis::AnalyticsdataV1beta::MetricMetadata, decorator: Google::Apis::AnalyticsdataV1beta::MetricMetadata::Representation
+      
+        end
+      end
+      
       class MetricHeader
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -547,6 +615,7 @@ module Google
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
           property :api_name, as: 'apiName'
+          property :category, as: 'category'
           property :custom_definition, as: 'customDefinition'
           collection :deprecated_api_names, as: 'deprecatedApiNames'
           property :description, as: 'description'

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

@@ -127,6 +127,51 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # This compatibility method lists dimensions and metrics that can be added to a
+        # report request and maintain compatibility. This method fails if the request's
+        # dimensions and metrics are incompatible. In Google Analytics, reports fail if
+        # they request incompatible dimensions and/or metrics; in that case, you will
+        # need to remove dimensions and/or metrics from the incompatible report until
+        # the report is compatible. The Realtime and Core reports have different
+        # compatibility rules. This method checks compatibility for Core reports.
+        # @param [String] property
+        #   A Google Analytics GA4 property identifier whose events are tracked. To learn
+        #   more, see [where to find your Property ID](https://developers.google.com/
+        #   analytics/devguides/reporting/data/v1/property-id). `property` should be the
+        #   same value as in your `runReport` request. Example: properties/1234 Set the
+        #   Property ID to 0 for compatibility checking on dimensions and metrics common
+        #   to all properties. In this special mode, this method will not return custom
+        #   dimensions and metrics.
+        # @param [Google::Apis::AnalyticsdataV1beta::CheckCompatibilityRequest] check_compatibility_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::AnalyticsdataV1beta::CheckCompatibilityResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AnalyticsdataV1beta::CheckCompatibilityResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def check_property_compatibility(property, check_compatibility_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1beta/{+property}:checkCompatibility', options)
+          command.request_representation = Google::Apis::AnalyticsdataV1beta::CheckCompatibilityRequest::Representation
+          command.request_object = check_compatibility_request_object
+          command.response_representation = Google::Apis::AnalyticsdataV1beta::CheckCompatibilityResponse::Representation
+          command.response_class = Google::Apis::AnalyticsdataV1beta::CheckCompatibilityResponse
+          command.params['property'] = property unless property.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Returns metadata for dimensions and metrics available in reporting methods.
         # Used to explore the dimensions and metrics. In this method, a Google Analytics
         # GA4 Property Identifier is specified in the request, and the metadata response

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-analyticsdata_v1beta
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-05 00:00:00.000000000 Z
+date: 2021-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -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/master/generated/google-apis-analyticsdata_v1beta/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsdata_v1beta/v0.5.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsdata_v1beta/v0.6.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-analyticsdata_v1beta
 post_install_message: 
 rdoc_options: []