google-analytics-data-v1beta 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d114d8fed5d58e2b0cb42f79eba9a85059277c39bd84bf9b7481115230d7dc2
-  data.tar.gz: dcc62abb49ac5f51735b1801929db4908cff339fc1a9ba2b080b7b9b595af059
+  metadata.gz: 2d361901325beca50c3db3d44d2110e75312b33708aa639c3a5c7a5581e28a87
+  data.tar.gz: 5ac4d0717a3e89ff33ba31b52a9a8c5b910bdb26785b570fd938eaedeb084f70
 SHA512:
-  metadata.gz: 1505e1edb9255c9c0ec6b1d7678d65ce0ac261c0dae6c9f67f173e685e0e46ddf2a30ce026ca27889feeb94968a0254c174e659dfe661728efbc4b0e0dba8f9f
-  data.tar.gz: 78b98bd515ae9e69af162cb365e31c11080d4b802f130bc1cb31f895e10b5ce5cfe75027284b01791ca329e68c98c15e2cd0f44e17fb6f55b63a1b7b0de26566
+  metadata.gz: 79546585bba50ca3798b5323ad471b95a1a3abfe1e024d8dd5b7f1c3d57cef4cc428b36857b4dbc0e3b8a811078a0eae5c4789e9b40e6f74fc149dec11183910
+  data.tar.gz: 279a03e5fa854ab7f3a3bab921dc4e8dfbb1d6b9ba31bd064dc6dd524fafd8aab0f67bf435c9fa26639e78463cb6223cb6c34b5e7cc46ff69972acc779e0d41f

data/lib/google/analytics/data/v1beta/analytics_data/client.rb

@@ -203,12 +203,13 @@ module Google
             #     response rows for both date ranges. In a cohort request, this `dateRanges`
             #     must be unspecified.
             #   @param dimension_filter [::Google::Analytics::Data::V1beta::FilterExpression, ::Hash]
-            #     The filter clause of dimensions. Dimensions must be requested to be used in
-            #     this filter. Metrics cannot be used in this filter.
+            #     Dimension filters allow you to ask for only specific dimension values in
+            #     the report. To learn more, see [Fundamentals of Dimension
+            #     Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
+            #     for examples. Metrics cannot be used in this filter.
             #   @param metric_filter [::Google::Analytics::Data::V1beta::FilterExpression, ::Hash]
             #     The filter clause of metrics. Applied at post aggregation phase, similar to
-            #     SQL having-clause. Metrics must be requested to be used in this filter.
-            #     Dimensions cannot be used in this filter.
+            #     SQL having-clause. Dimensions cannot be used in this filter.
             #   @param offset [::Integer]
             #     The row count of the start row. The first row is counted as row 0.
             #
@@ -772,6 +773,108 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             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.
+            #
+            # @overload check_compatibility(request, options = nil)
+            #   Pass arguments to `check_compatibility` via a request object, either of type
+            #   {::Google::Analytics::Data::V1beta::CheckCompatibilityRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Analytics::Data::V1beta::CheckCompatibilityRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload check_compatibility(property: nil, dimensions: nil, metrics: nil, dimension_filter: nil, metric_filter: nil, compatibility_filter: nil)
+            #   Pass arguments to `check_compatibility` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param property [::String]
+            #     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 dimensions [::Array<::Google::Analytics::Data::V1beta::Dimension, ::Hash>]
+            #     The dimensions in this report. `dimensions` should be the same value as in
+            #     your `runReport` request.
+            #   @param metrics [::Array<::Google::Analytics::Data::V1beta::Metric, ::Hash>]
+            #     The metrics in this report. `metrics` should be the same value as in your
+            #     `runReport` request.
+            #   @param dimension_filter [::Google::Analytics::Data::V1beta::FilterExpression, ::Hash]
+            #     The filter clause of dimensions. `dimensionFilter` should be the same value
+            #     as in your `runReport` request.
+            #   @param metric_filter [::Google::Analytics::Data::V1beta::FilterExpression, ::Hash]
+            #     The filter clause of metrics. `metricFilter` should be the same value as in
+            #     your `runReport` request
+            #   @param compatibility_filter [::Google::Analytics::Data::V1beta::Compatibility]
+            #     Filters the dimensions and metrics in the response to just this
+            #     compatibility. Commonly used as `”compatibilityFilter”: “COMPATIBLE”`
+            #     to only return compatible dimensions & metrics.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Analytics::Data::V1beta::CheckCompatibilityResponse]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Analytics::Data::V1beta::CheckCompatibilityResponse]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            def check_compatibility request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Data::V1beta::CheckCompatibilityRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.check_compatibility.metadata.to_h
+
+              # Set x-goog-api-client and x-goog-user-project headers
+              metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                lib_name: @config.lib_name, lib_version: @config.lib_version,
+                gapic_version: ::Google::Analytics::Data::V1beta::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {
+                "property" => request.property
+              }
+              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              metadata[:"x-goog-request-params"] ||= request_params_header
+
+              options.apply_defaults timeout:      @config.rpcs.check_compatibility.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.check_compatibility.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @analytics_data_stub.call_rpc :check_compatibility, request, options: options do |response, operation|
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Configuration class for the AnalyticsData API.
             #
@@ -937,6 +1040,11 @@ module Google
                 # @return [::Gapic::Config::Method]
                 #
                 attr_reader :run_realtime_report
+                ##
+                # RPC-specific configuration for `check_compatibility`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :check_compatibility
 
                 # @private
                 def initialize parent_rpcs = nil
@@ -952,6 +1060,8 @@ module Google
                   @get_metadata = ::Gapic::Config::Method.new get_metadata_config
                   run_realtime_report_config = parent_rpcs.run_realtime_report if parent_rpcs.respond_to? :run_realtime_report
                   @run_realtime_report = ::Gapic::Config::Method.new run_realtime_report_config
+                  check_compatibility_config = parent_rpcs.check_compatibility if parent_rpcs.respond_to? :check_compatibility
+                  @check_compatibility = ::Gapic::Config::Method.new check_compatibility_config
 
                   yield self if block_given?
                 end

data/lib/google/analytics/data/v1beta/analytics_data_api_pb.rb

@@ -10,6 +10,18 @@ require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/analytics/data/v1beta/analytics_data_api.proto", :syntax => :proto3) do
+    add_message "google.analytics.data.v1beta.CheckCompatibilityRequest" do
+      optional :property, :string, 1
+      repeated :dimensions, :message, 2, "google.analytics.data.v1beta.Dimension"
+      repeated :metrics, :message, 3, "google.analytics.data.v1beta.Metric"
+      optional :dimension_filter, :message, 4, "google.analytics.data.v1beta.FilterExpression"
+      optional :metric_filter, :message, 5, "google.analytics.data.v1beta.FilterExpression"
+      optional :compatibility_filter, :enum, 6, "google.analytics.data.v1beta.Compatibility"
+    end
+    add_message "google.analytics.data.v1beta.CheckCompatibilityResponse" do
+      repeated :dimension_compatibilities, :message, 1, "google.analytics.data.v1beta.DimensionCompatibility"
+      repeated :metric_compatibilities, :message, 2, "google.analytics.data.v1beta.MetricCompatibility"
+    end
     add_message "google.analytics.data.v1beta.Metadata" do
       optional :name, :string, 3
       repeated :dimensions, :message, 1, "google.analytics.data.v1beta.DimensionMetadata"
@@ -115,6 +127,8 @@ module Google
   module Analytics
     module Data
       module V1beta
+        CheckCompatibilityRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.CheckCompatibilityRequest").msgclass
+        CheckCompatibilityResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.CheckCompatibilityResponse").msgclass
         Metadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.Metadata").msgclass
         RunReportRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.RunReportRequest").msgclass
         RunReportResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.RunReportResponse").msgclass

data/lib/google/analytics/data/v1beta/analytics_data_api_services_pb.rb

@@ -68,6 +68,17 @@ module Google
             # event data for your property. These reports show events and usage from the
             # last 30 minutes.
             rpc :RunRealtimeReport, ::Google::Analytics::Data::V1beta::RunRealtimeReportRequest, ::Google::Analytics::Data::V1beta::RunRealtimeReportResponse
+            # 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.
+            rpc :CheckCompatibility, ::Google::Analytics::Data::V1beta::CheckCompatibilityRequest, ::Google::Analytics::Data::V1beta::CheckCompatibilityResponse
           end
 
           Stub = Service.rpc_stub_class

data/lib/google/analytics/data/v1beta/data_pb.rb

@@ -206,6 +206,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :description, :string, 3
       repeated :deprecated_api_names, :string, 4
       optional :custom_definition, :bool, 5
+      optional :category, :string, 7
     end
     add_message "google.analytics.data.v1beta.MetricMetadata" do
       optional :api_name, :string, 1
@@ -215,6 +216,15 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :type, :enum, 5, "google.analytics.data.v1beta.MetricType"
       optional :expression, :string, 6
       optional :custom_definition, :bool, 7
+      optional :category, :string, 10
+    end
+    add_message "google.analytics.data.v1beta.DimensionCompatibility" do
+      proto3_optional :dimension_metadata, :message, 1, "google.analytics.data.v1beta.DimensionMetadata"
+      proto3_optional :compatibility, :enum, 2, "google.analytics.data.v1beta.Compatibility"
+    end
+    add_message "google.analytics.data.v1beta.MetricCompatibility" do
+      proto3_optional :metric_metadata, :message, 1, "google.analytics.data.v1beta.MetricMetadata"
+      proto3_optional :compatibility, :enum, 2, "google.analytics.data.v1beta.Compatibility"
     end
     add_enum "google.analytics.data.v1beta.MetricAggregation" do
       value :METRIC_AGGREGATION_UNSPECIFIED, 0
@@ -238,6 +248,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :TYPE_METERS, 12
       value :TYPE_KILOMETERS, 13
     end
+    add_enum "google.analytics.data.v1beta.Compatibility" do
+      value :COMPATIBILITY_UNSPECIFIED, 0
+      value :COMPATIBLE, 1
+      value :INCOMPATIBLE, 2
+    end
   end
 end
 
@@ -286,8 +301,11 @@ module Google
         QuotaStatus = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.QuotaStatus").msgclass
         DimensionMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.DimensionMetadata").msgclass
         MetricMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.MetricMetadata").msgclass
+        DimensionCompatibility = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.DimensionCompatibility").msgclass
+        MetricCompatibility = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.MetricCompatibility").msgclass
         MetricAggregation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.MetricAggregation").enummodule
         MetricType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.MetricType").enummodule
+        Compatibility = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.Compatibility").enummodule
       end
     end
   end

data/lib/google/analytics/data/v1beta/version.rb

@@ -21,7 +21,7 @@ module Google
   module Analytics
     module Data
       module V1beta
-        VERSION = "0.2.1"
+        VERSION = "0.3.0"
       end
     end
   end

data/proto_docs/google/analytics/data/v1beta/analytics_data_api.rb

@@ -21,6 +21,60 @@ module Google
   module Analytics
     module Data
       module V1beta
+        # 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.
+        # @!attribute [rw] property
+        #   @return [::String]
+        #     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.
+        # @!attribute [rw] dimensions
+        #   @return [::Array<::Google::Analytics::Data::V1beta::Dimension>]
+        #     The dimensions in this report. `dimensions` should be the same value as in
+        #     your `runReport` request.
+        # @!attribute [rw] metrics
+        #   @return [::Array<::Google::Analytics::Data::V1beta::Metric>]
+        #     The metrics in this report. `metrics` should be the same value as in your
+        #     `runReport` request.
+        # @!attribute [rw] dimension_filter
+        #   @return [::Google::Analytics::Data::V1beta::FilterExpression]
+        #     The filter clause of dimensions. `dimensionFilter` should be the same value
+        #     as in your `runReport` request.
+        # @!attribute [rw] metric_filter
+        #   @return [::Google::Analytics::Data::V1beta::FilterExpression]
+        #     The filter clause of metrics. `metricFilter` should be the same value as in
+        #     your `runReport` request
+        # @!attribute [rw] compatibility_filter
+        #   @return [::Google::Analytics::Data::V1beta::Compatibility]
+        #     Filters the dimensions and metrics in the response to just this
+        #     compatibility. Commonly used as `”compatibilityFilter”: “COMPATIBLE”`
+        #     to only return compatible dimensions & metrics.
+        class CheckCompatibilityRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The compatibility response with the compatibility of each dimension & metric.
+        # @!attribute [rw] dimension_compatibilities
+        #   @return [::Array<::Google::Analytics::Data::V1beta::DimensionCompatibility>]
+        #     The compatibility of each dimension.
+        # @!attribute [rw] metric_compatibilities
+        #   @return [::Array<::Google::Analytics::Data::V1beta::MetricCompatibility>]
+        #     The compatibility of each metric.
+        class CheckCompatibilityResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # The dimensions and metrics currently accepted in reporting methods.
         # @!attribute [rw] name
         #   @return [::String]
@@ -62,13 +116,14 @@ module Google
         #     must be unspecified.
         # @!attribute [rw] dimension_filter
         #   @return [::Google::Analytics::Data::V1beta::FilterExpression]
-        #     The filter clause of dimensions. Dimensions must be requested to be used in
-        #     this filter. Metrics cannot be used in this filter.
+        #     Dimension filters allow you to ask for only specific dimension values in
+        #     the report. To learn more, see [Fundamentals of Dimension
+        #     Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
+        #     for examples. Metrics cannot be used in this filter.
         # @!attribute [rw] metric_filter
         #   @return [::Google::Analytics::Data::V1beta::FilterExpression]
         #     The filter clause of metrics. Applied at post aggregation phase, similar to
-        #     SQL having-clause. Metrics must be requested to be used in this filter.
-        #     Dimensions cannot be used in this filter.
+        #     SQL having-clause. Dimensions cannot be used in this filter.
         # @!attribute [rw] offset
         #   @return [::Integer]
         #     The row count of the start row. The first row is counted as row 0.

data/proto_docs/google/analytics/data/v1beta/data.rb

@@ -820,6 +820,10 @@ module Google
         # @!attribute [rw] custom_definition
         #   @return [::Boolean]
         #     True if the dimension is a custom dimension for this property.
+        # @!attribute [rw] category
+        #   @return [::String]
+        #     The display name of the category that this dimension belongs to. Similar
+        #     dimensions and metrics are categorized together.
         class DimensionMetadata
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -854,11 +858,45 @@ module Google
         # @!attribute [rw] custom_definition
         #   @return [::Boolean]
         #     True if the metric is a custom metric for this property.
+        # @!attribute [rw] category
+        #   @return [::String]
+        #     The display name of the category that this metrics belongs to. Similar
+        #     dimensions and metrics are categorized together.
         class MetricMetadata
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # The compatibility for a single dimension.
+        # @!attribute [rw] dimension_metadata
+        #   @return [::Google::Analytics::Data::V1beta::DimensionMetadata]
+        #     The dimension metadata contains the API name for this compatibility
+        #     information. The dimension metadata also contains other helpful information
+        #     like the UI name and description.
+        # @!attribute [rw] compatibility
+        #   @return [::Google::Analytics::Data::V1beta::Compatibility]
+        #     The compatibility of this dimension. If the compatibility is COMPATIBLE,
+        #     this dimension can be successfully added to the report.
+        class DimensionCompatibility
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The compatibility for a single metric.
+        # @!attribute [rw] metric_metadata
+        #   @return [::Google::Analytics::Data::V1beta::MetricMetadata]
+        #     The metric metadata contains the API name for this compatibility
+        #     information. The metric metadata also contains other helpful information
+        #     like the UI name and description.
+        # @!attribute [rw] compatibility
+        #   @return [::Google::Analytics::Data::V1beta::Compatibility]
+        #     The compatibility of this metric. If the compatibility is COMPATIBLE,
+        #     this metric can be successfully added to the report.
+        class MetricCompatibility
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Represents aggregation of metrics.
         module MetricAggregation
           # Unspecified operator.
@@ -918,6 +956,20 @@ module Google
           # A length in kilometers; a special floating point type.
           TYPE_KILOMETERS = 13
         end
+
+        # The compatibility types for a single dimension or metric.
+        module Compatibility
+          # Unspecified compatibility.
+          COMPATIBILITY_UNSPECIFIED = 0
+
+          # The dimension or metric is compatible. This dimension or metric can be
+          # successfully added to a report.
+          COMPATIBLE = 1
+
+          # The dimension or metric is incompatible. This dimension or metric cannot be
+          # successfully added to a report.
+          INCOMPATIBLE = 2
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-analytics-data-v1beta
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-11 00:00:00.000000000 Z
+date: 2021-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common