google-analytics-data-v1beta 0.2.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c021234dd6f81ba0f39dbbb777517e6fab6c15dea6311094c80dd8447aa0531e
-  data.tar.gz: db84e46a4f4f7685a998f618ec3111b21b5acf247718485807cbe024c2e2e82d
+  metadata.gz: c40efb926046dba710813a862995ecf1fa6977310260cf32c5764bed0e774e3f
+  data.tar.gz: 94af9ace5240c1e9118dfe8cfe78a47f4ac1bbecbd8105ad997567af466a3e13
 SHA512:
-  metadata.gz: d1d8d6dbabc2913006e761cc2901de043317fafe472bb5feb8e8f9be540fa597fabebc33fc66045baf354ae8a414d53a01f0cd20a1f3f67323d1e1a7e04b53bc
-  data.tar.gz: 2ccdcf5ff209db69140d5e7726f9beb2df795003ee8142430bbc5d571f6c68cef93c91133851b240e50209a965fa36069a0164529bb6fb555eac8e126c73c193
+  metadata.gz: '0513853b524f0c4fec34d6d500dd9100bfb1da6484d963a88b9e2208687f6bd5a4b83a36720d08e4a2b79c613cc260716c1962f05d6f600f0ee2c5c738bcb358'
+  data.tar.gz: 29d50d4789fc694204d83f43843d478a0e83313c670836e0f884d682a7b2c95453d55825f2098d6d2d92f8bda3796d524788040990d44b81d51179f3dd6b016c

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

@@ -41,13 +41,12 @@ module Google
             # See {::Google::Analytics::Data::V1beta::AnalyticsData::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all AnalyticsData clients:
-            #
-            #     ::Google::Analytics::Data::V1beta::AnalyticsData::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all AnalyticsData clients
+            #   ::Google::Analytics::Data::V1beta::AnalyticsData::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -109,19 +108,15 @@ module Google
             ##
             # Create a new AnalyticsData client object.
             #
-            # ## Examples
-            #
-            # To create a new AnalyticsData client with the default
-            # configuration:
+            # @example
             #
-            #     client = ::Google::Analytics::Data::V1beta::AnalyticsData::Client.new
+            #   # Create a client using the default configuration
+            #   client = ::Google::Analytics::Data::V1beta::AnalyticsData::Client.new
             #
-            # To create a new AnalyticsData client with a custom
-            # configuration:
-            #
-            #     client = ::Google::Analytics::Data::V1beta::AnalyticsData::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Analytics::Data::V1beta::AnalyticsData::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the AnalyticsData client.
             # @yieldparam config [Client::Configuration]
@@ -141,10 +136,9 @@ module Google
 
               # Create credentials
               credentials = @config.credentials
-              # Use self-signed JWT if the scope and endpoint are unchanged from default,
+              # Use self-signed JWT if the endpoint is unchanged from default,
               # but only if the default endpoint does not have a region prefix.
-              enable_self_signed_jwt = @config.scope == Client.configure.scope &&
-                                       @config.endpoint == Client.configure.endpoint &&
+              enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                                        !@config.endpoint.split(".").first.include?("-")
               credentials ||= Credentials.default scope: @config.scope,
                                                   enable_self_signed_jwt: enable_self_signed_jwt
@@ -209,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.
             #
@@ -265,6 +260,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/analytics/data/v1beta"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Analytics::Data::V1beta::AnalyticsData::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Analytics::Data::V1beta::RunReportRequest.new
+            #
+            #   # Call the run_report method.
+            #   result = client.run_report request
+            #
+            #   # The returned object is of type Google::Analytics::Data::V1beta::RunReportResponse.
+            #   p result
+            #
             def run_report request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -282,16 +292,20 @@ module Google
                 gapic_version: ::Google::Analytics::Data::V1beta::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "property" => request.property
-              }
+              header_params = {}
+              if request.property
+                header_params["property"] = request.property
+              end
+
               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.run_report.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.run_report.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @analytics_data_stub.call_rpc :run_report, request, options: options do |response, operation|
@@ -380,6 +394,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/analytics/data/v1beta"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Analytics::Data::V1beta::AnalyticsData::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Analytics::Data::V1beta::RunPivotReportRequest.new
+            #
+            #   # Call the run_pivot_report method.
+            #   result = client.run_pivot_report request
+            #
+            #   # The returned object is of type Google::Analytics::Data::V1beta::RunPivotReportResponse.
+            #   p result
+            #
             def run_pivot_report request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -397,16 +426,20 @@ module Google
                 gapic_version: ::Google::Analytics::Data::V1beta::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "property" => request.property
-              }
+              header_params = {}
+              if request.property
+                header_params["property"] = request.property
+              end
+
               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.run_pivot_report.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.run_pivot_report.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @analytics_data_stub.call_rpc :run_pivot_report, request, options: options do |response, operation|
@@ -458,6 +491,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/analytics/data/v1beta"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Analytics::Data::V1beta::AnalyticsData::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Analytics::Data::V1beta::BatchRunReportsRequest.new
+            #
+            #   # Call the batch_run_reports method.
+            #   result = client.batch_run_reports request
+            #
+            #   # The returned object is of type Google::Analytics::Data::V1beta::BatchRunReportsResponse.
+            #   p result
+            #
             def batch_run_reports request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -475,16 +523,20 @@ module Google
                 gapic_version: ::Google::Analytics::Data::V1beta::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "property" => request.property
-              }
+              header_params = {}
+              if request.property
+                header_params["property"] = request.property
+              end
+
               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.batch_run_reports.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.batch_run_reports.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @analytics_data_stub.call_rpc :batch_run_reports, request, options: options do |response, operation|
@@ -536,6 +588,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/analytics/data/v1beta"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Analytics::Data::V1beta::AnalyticsData::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Analytics::Data::V1beta::BatchRunPivotReportsRequest.new
+            #
+            #   # Call the batch_run_pivot_reports method.
+            #   result = client.batch_run_pivot_reports request
+            #
+            #   # The returned object is of type Google::Analytics::Data::V1beta::BatchRunPivotReportsResponse.
+            #   p result
+            #
             def batch_run_pivot_reports request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -553,16 +620,20 @@ module Google
                 gapic_version: ::Google::Analytics::Data::V1beta::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "property" => request.property
-              }
+              header_params = {}
+              if request.property
+                header_params["property"] = request.property
+              end
+
               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.batch_run_pivot_reports.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.batch_run_pivot_reports.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @analytics_data_stub.call_rpc :batch_run_pivot_reports, request, options: options do |response, operation|
@@ -621,6 +692,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/analytics/data/v1beta"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Analytics::Data::V1beta::AnalyticsData::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Analytics::Data::V1beta::GetMetadataRequest.new
+            #
+            #   # Call the get_metadata method.
+            #   result = client.get_metadata request
+            #
+            #   # The returned object is of type Google::Analytics::Data::V1beta::Metadata.
+            #   p result
+            #
             def get_metadata request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -638,16 +724,20 @@ module Google
                 gapic_version: ::Google::Analytics::Data::V1beta::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               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.get_metadata.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.get_metadata.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @analytics_data_stub.call_rpc :get_metadata, request, options: options do |response, operation|
@@ -729,6 +819,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/analytics/data/v1beta"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Analytics::Data::V1beta::AnalyticsData::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Analytics::Data::V1beta::RunRealtimeReportRequest.new
+            #
+            #   # Call the run_realtime_report method.
+            #   result = client.run_realtime_report request
+            #
+            #   # The returned object is of type Google::Analytics::Data::V1beta::RunRealtimeReportResponse.
+            #   p result
+            #
             def run_realtime_report request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -746,16 +851,20 @@ module Google
                 gapic_version: ::Google::Analytics::Data::V1beta::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "property" => request.property
-              }
+              header_params = {}
+              if request.property
+                header_params["property"] = request.property
+              end
+
               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.run_realtime_report.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.run_realtime_report.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @analytics_data_stub.call_rpc :run_realtime_report, request, options: options do |response, operation|
@@ -766,6 +875,125 @@ 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.
+            #
+            # @example Basic example
+            #   require "google/analytics/data/v1beta"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Analytics::Data::V1beta::AnalyticsData::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Analytics::Data::V1beta::CheckCompatibilityRequest.new
+            #
+            #   # Call the check_compatibility method.
+            #   result = client.check_compatibility request
+            #
+            #   # The returned object is of type Google::Analytics::Data::V1beta::CheckCompatibilityResponse.
+            #   p result
+            #
+            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 = {}
+              if request.property
+                header_params["property"] = request.property
+              end
+
+              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.
             #
@@ -779,22 +1007,21 @@ module Google
             # Configuration can be applied globally to all clients, or to a single client
             # on construction.
             #
-            # # Examples
-            #
-            # To modify the global config, setting the timeout for run_report
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Analytics::Data::V1beta::AnalyticsData::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.run_report.timeout = 20.0
-            #     end
+            # @example
             #
-            # To apply the above configuration only to a new client:
+            #   # Modify the global config, setting the timeout for
+            #   # run_report to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Analytics::Data::V1beta::AnalyticsData::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.run_report.timeout = 20.0
+            #   end
             #
-            #     client = ::Google::Analytics::Data::V1beta::AnalyticsData::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.run_report.timeout = 20.0
-            #     end
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Analytics::Data::V1beta::AnalyticsData::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.run_report.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.
@@ -932,6 +1159,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
@@ -947,6 +1179,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

@@ -1,15 +1,27 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/analytics/data/v1beta/analytics_data_api.proto
 
-require 'google/protobuf'
-
 require 'google/analytics/data/v1beta/data_pb'
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
+require 'google/protobuf'
+
 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

@@ -27,7 +27,7 @@ module Google
           # Google Analytics reporting data service.
           class Service
 
-            include GRPC::GenericService
+            include ::GRPC::GenericService
 
             self.marshal_class_method = :encode
             self.unmarshal_class_method = :decode
@@ -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

@@ -154,6 +154,17 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     end
     add_message "google.analytics.data.v1beta.ResponseMetaData" do
       optional :data_loss_from_other_row, :bool, 3
+      proto3_optional :schema_restriction_response, :message, 4, "google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponse"
+      proto3_optional :currency_code, :string, 5
+      proto3_optional :time_zone, :string, 6
+      proto3_optional :empty_reason, :string, 7
+    end
+    add_message "google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponse" do
+      repeated :active_metric_restrictions, :message, 1, "google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponse.ActiveMetricRestriction"
+    end
+    add_message "google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponse.ActiveMetricRestriction" do
+      proto3_optional :metric_name, :string, 1
+      repeated :restricted_metric_types, :enum, 2, "google.analytics.data.v1beta.RestrictedMetricType"
     end
     add_message "google.analytics.data.v1beta.DimensionHeader" do
       optional :name, :string, 1
@@ -206,6 +217,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 +227,21 @@ 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
+      repeated :blocked_reasons, :enum, 8, "google.analytics.data.v1beta.MetricMetadata.BlockedReason"
+      optional :category, :string, 10
+    end
+    add_enum "google.analytics.data.v1beta.MetricMetadata.BlockedReason" do
+      value :BLOCKED_REASON_UNSPECIFIED, 0
+      value :NO_REVENUE_METRICS, 1
+      value :NO_COST_METRICS, 2
+    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 +265,16 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :TYPE_METERS, 12
       value :TYPE_KILOMETERS, 13
     end
+    add_enum "google.analytics.data.v1beta.RestrictedMetricType" do
+      value :RESTRICTED_METRIC_TYPE_UNSPECIFIED, 0
+      value :COST_DATA, 1
+      value :REVENUE_DATA, 2
+    end
+    add_enum "google.analytics.data.v1beta.Compatibility" do
+      value :COMPATIBILITY_UNSPECIFIED, 0
+      value :COMPATIBLE, 1
+      value :INCOMPATIBLE, 2
+    end
   end
 end
 
@@ -274,6 +311,8 @@ module Google
         CohortsRange::Granularity = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.CohortsRange.Granularity").enummodule
         CohortReportSettings = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.CohortReportSettings").msgclass
         ResponseMetaData = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.ResponseMetaData").msgclass
+        ResponseMetaData::SchemaRestrictionResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponse").msgclass
+        ResponseMetaData::SchemaRestrictionResponse::ActiveMetricRestriction = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponse.ActiveMetricRestriction").msgclass
         DimensionHeader = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.DimensionHeader").msgclass
         MetricHeader = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.MetricHeader").msgclass
         PivotHeader = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.PivotHeader").msgclass
@@ -286,8 +325,13 @@ 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
+        MetricMetadata::BlockedReason = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.MetricMetadata.BlockedReason").enummodule
+        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
+        RestrictedMetricType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.RestrictedMetricType").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.0"
+        VERSION = "0.4.1"
       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

@@ -618,9 +618,61 @@ module Google
         #   @return [::Boolean]
         #     If true, indicates some buckets of dimension combinations are rolled into
         #     "(other)" row. This can happen for high cardinality reports.
+        # @!attribute [rw] schema_restriction_response
+        #   @return [::Google::Analytics::Data::V1beta::ResponseMetaData::SchemaRestrictionResponse]
+        #     Describes the schema restrictions actively enforced in creating this
+        #     report. To learn more, see [Access and data-restriction
+        #     management](https://support.google.com/analytics/answer/10851388).
+        # @!attribute [rw] currency_code
+        #   @return [::String]
+        #     The currency code used in this report. Intended to be used in formatting
+        #     currency metrics like `purchaseRevenue` for visualization. If currency_code
+        #     was specified in the request, this response parameter will echo the request
+        #     parameter; otherwise, this response parameter is the property's current
+        #     currency_code.
+        #
+        #     Currency codes are string encodings of currency types from the ISO 4217
+        #     standard (https://en.wikipedia.org/wiki/ISO_4217); for example "USD",
+        #     "EUR", "JPY". To learn more, see
+        #     https://support.google.com/analytics/answer/9796179.
+        # @!attribute [rw] time_zone
+        #   @return [::String]
+        #     The property's current timezone. Intended to be used to interpret
+        #     time-based dimensions like `hour` and `minute`. Formatted as strings from
+        #     the IANA Time Zone database (https://www.iana.org/time-zones); for example
+        #     "America/New_York" or "Asia/Tokyo".
+        # @!attribute [rw] empty_reason
+        #   @return [::String]
+        #     If empty reason is specified, the report is empty for this reason.
         class ResponseMetaData
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The schema restrictions actively enforced in creating this report. To learn
+          # more, see [Access and data-restriction
+          # management](https://support.google.com/analytics/answer/10851388).
+          # @!attribute [rw] active_metric_restrictions
+          #   @return [::Array<::Google::Analytics::Data::V1beta::ResponseMetaData::SchemaRestrictionResponse::ActiveMetricRestriction>]
+          #     All restrictions actively enforced in creating the report. For example,
+          #     `purchaseRevenue` always has the restriction type `REVENUE_DATA`.
+          #     However, this active response restriction is only populated if the user's
+          #     custom role disallows access to `REVENUE_DATA`.
+          class SchemaRestrictionResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # A metric actively restricted in creating the report.
+            # @!attribute [rw] metric_name
+            #   @return [::String]
+            #     The name of the restricted metric.
+            # @!attribute [rw] restricted_metric_types
+            #   @return [::Array<::Google::Analytics::Data::V1beta::RestrictedMetricType>]
+            #     The reason for this metric's restriction.
+            class ActiveMetricRestriction
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
         end
 
         # Describes a dimension column in the report. Dimensions requested in a report
@@ -820,6 +872,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,9 +910,67 @@ module Google
         # @!attribute [rw] custom_definition
         #   @return [::Boolean]
         #     True if the metric is a custom metric for this property.
+        # @!attribute [rw] blocked_reasons
+        #   @return [::Array<::Google::Analytics::Data::V1beta::MetricMetadata::BlockedReason>]
+        #     If reasons are specified, your access is blocked to this metric for this
+        #     property. API requests from you to this property for this metric will
+        #     succeed; however, the report will contain only zeros for this metric. API
+        #     requests with metric filters on blocked metrics will fail. If reasons are
+        #     empty, you have access to this metric.
+        #
+        #     To learn more, see [Access and data-restriction
+        #     management](https://support.google.com/analytics/answer/10851388).
+        # @!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
+
+          # Justifications for why this metric is blocked.
+          module BlockedReason
+            # Will never be specified in API response.
+            BLOCKED_REASON_UNSPECIFIED = 0
+
+            # If present, your access is blocked to revenue related metrics for this
+            # property, and this metric is revenue related.
+            NO_REVENUE_METRICS = 1
+
+            # If present, your access is blocked to cost related metrics for this
+            # property, and this metric is cost related.
+            NO_COST_METRICS = 2
+          end
+        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.
@@ -918,6 +1032,33 @@ module Google
           # A length in kilometers; a special floating point type.
           TYPE_KILOMETERS = 13
         end
+
+        # Categories of data that you may be restricted from viewing on certain GA4
+        # properties.
+        module RestrictedMetricType
+          # Unspecified type.
+          RESTRICTED_METRIC_TYPE_UNSPECIFIED = 0
+
+          # Cost metrics such as `adCost`.
+          COST_DATA = 1
+
+          # Revenue metrics such as `purchaseRevenue`.
+          REVENUE_DATA = 2
+        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.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-12 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a