google-analytics-data-v1alpha 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35dc803cd72fb7120194aeb04b1ccfb640f200165deabc568f6b420c167bf730
-  data.tar.gz: 77d920b3c591b727e85234aa878175726f34771e7e1f8f706ec123d69b19d137
+  metadata.gz: 7e855e82e44e32830f8170a32d2675893ff52d9417bd318dd4984eb3a2129784
+  data.tar.gz: 183e42b1ca3b3128e6aac9b7956f7f1021bf5c76ae66008877e83b3ab2b21501
 SHA512:
-  metadata.gz: 6fc6b8aee8c8753c8c1364a336cb8608343a0d8a55a7eea5f8d691f02b301fc97644e537d0055c3c24ce81246673016e58faa9c22e45d3eccab484623f24a3ca
-  data.tar.gz: 5f6c53ce9599acdd2eb667b0313e3c09ea8cde19d8a3735d03fff422de03a8a58b14d4713b23e2818663069814dead092118e39700ce4db7b91f1b87e230f6ce
+  metadata.gz: e1b6a4a2b53daa127d558dbe8ff7c2f182a418e92bedb9ac028d2a52a76b674ae5c91004237c9485a937871e65100b5401709f9320db2ed28c2bb91b7be9eada
+  data.tar.gz: e477689c2bf4e53211f46c26497ecda51112f17265593a035ffcdb97bd5c5c0637742b30e21d8eedb2ea637a89a04952bf4ec9aa47d242ab73d94d6dc2d66dcb

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

@@ -638,6 +638,101 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # The Google Analytics Realtime API returns a customized report of realtime
+            # event data for your property. These reports show events and usage from the
+            # last 30 minutes.
+            #
+            # @overload run_realtime_report(request, options = nil)
+            #   Pass arguments to `run_realtime_report` via a request object, either of type
+            #   {::Google::Analytics::Data::V1alpha::RunRealtimeReportRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Analytics::Data::V1alpha::RunRealtimeReportRequest, ::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 run_realtime_report(property: nil, dimensions: nil, metrics: nil, limit: nil, dimension_filter: nil, metric_filter: nil, metric_aggregations: nil, order_bys: nil, return_property_quota: nil)
+            #   Pass arguments to `run_realtime_report` 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.
+            #     Specified in the URL path and not the body. To learn more, see [where to
+            #     find your Property
+            #     ID](https://developers.google.com/analytics/trusted-testing/analytics-data/property-id).
+            #
+            #     Example: properties/1234
+            #   @param dimensions [::Array<::Google::Analytics::Data::V1alpha::Dimension, ::Hash>]
+            #     The dimensions requested and displayed.
+            #   @param metrics [::Array<::Google::Analytics::Data::V1alpha::Metric, ::Hash>]
+            #     The metrics requested and displayed.
+            #   @param limit [::Integer]
+            #     The number of rows to return. If unspecified, 10 rows are returned. If
+            #     -1, all rows are returned.
+            #   @param dimension_filter [::Google::Analytics::Data::V1alpha::FilterExpression, ::Hash]
+            #     The filter clause of dimensions. Dimensions must be requested to be used in
+            #     this filter. Metrics cannot be used in this filter.
+            #   @param metric_filter [::Google::Analytics::Data::V1alpha::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.
+            #   @param metric_aggregations [::Array<::Google::Analytics::Data::V1alpha::MetricAggregation>]
+            #     Aggregation of metrics. Aggregated metric values will be shown in rows
+            #     where the dimension_values are set to "RESERVED_(MetricAggregation)".
+            #   @param order_bys [::Array<::Google::Analytics::Data::V1alpha::OrderBy, ::Hash>]
+            #     Specifies how rows are ordered in the response.
+            #   @param return_property_quota [::Boolean]
+            #     Toggles whether to return the current state of this Analytics Property's
+            #     Realtime quota. Quota is returned in [PropertyQuota](#PropertyQuota).
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Analytics::Data::V1alpha::RunRealtimeReportResponse]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Analytics::Data::V1alpha::RunRealtimeReportResponse]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            def run_realtime_report request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Data::V1alpha::RunRealtimeReportRequest
+
+              # 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.run_realtime_report.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::V1alpha::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.run_realtime_report.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.run_realtime_report.retry_policy
+              options.apply_defaults metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @analytics_data_stub.call_rpc :run_realtime_report, 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.
             #
@@ -804,6 +899,11 @@ module Google
                 # @return [::Gapic::Config::Method]
                 #
                 attr_reader :get_metadata
+                ##
+                # RPC-specific configuration for `run_realtime_report`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :run_realtime_report
 
                 # @private
                 def initialize parent_rpcs = nil
@@ -819,6 +919,8 @@ module Google
                   @get_universal_metadata = ::Gapic::Config::Method.new get_universal_metadata_config
                   get_metadata_config = parent_rpcs&.get_metadata if parent_rpcs&.respond_to? :get_metadata
                   @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
 
                   yield self if block_given?
                 end

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

@@ -87,6 +87,27 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     add_message "google.analytics.data.v1alpha.GetMetadataRequest" do
       optional :name, :string, 1
     end
+    add_message "google.analytics.data.v1alpha.RunRealtimeReportRequest" do
+      optional :property, :string, 1
+      repeated :dimensions, :message, 2, "google.analytics.data.v1alpha.Dimension"
+      repeated :metrics, :message, 3, "google.analytics.data.v1alpha.Metric"
+      optional :limit, :int64, 4
+      optional :dimension_filter, :message, 5, "google.analytics.data.v1alpha.FilterExpression"
+      optional :metric_filter, :message, 6, "google.analytics.data.v1alpha.FilterExpression"
+      repeated :metric_aggregations, :enum, 7, "google.analytics.data.v1alpha.MetricAggregation"
+      repeated :order_bys, :message, 8, "google.analytics.data.v1alpha.OrderBy"
+      optional :return_property_quota, :bool, 9
+    end
+    add_message "google.analytics.data.v1alpha.RunRealtimeReportResponse" do
+      repeated :dimension_headers, :message, 1, "google.analytics.data.v1alpha.DimensionHeader"
+      repeated :metric_headers, :message, 2, "google.analytics.data.v1alpha.MetricHeader"
+      repeated :rows, :message, 3, "google.analytics.data.v1alpha.Row"
+      repeated :totals, :message, 4, "google.analytics.data.v1alpha.Row"
+      repeated :maximums, :message, 5, "google.analytics.data.v1alpha.Row"
+      repeated :minimums, :message, 6, "google.analytics.data.v1alpha.Row"
+      optional :row_count, :int32, 7
+      optional :property_quota, :message, 8, "google.analytics.data.v1alpha.PropertyQuota"
+    end
   end
 end
 
@@ -106,6 +127,8 @@ module Google
         GetUniversalMetadataRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.GetUniversalMetadataRequest").msgclass
         UniversalMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.UniversalMetadata").msgclass
         GetMetadataRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.GetMetadataRequest").msgclass
+        RunRealtimeReportRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.RunRealtimeReportRequest").msgclass
+        RunRealtimeReportResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.RunRealtimeReportResponse").msgclass
       end
     end
   end

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

@@ -71,6 +71,10 @@ module Google
             # `customEvent:levels_unlocked`. Universal metadata are dimensions and
             # metrics applicable to any property such as `country` and `totalUsers`.
             rpc :GetMetadata, ::Google::Analytics::Data::V1alpha::GetMetadataRequest, ::Google::Analytics::Data::V1alpha::Metadata
+            # The Google Analytics Realtime API returns a customized report of realtime
+            # event data for your property. These reports show events and usage from the
+            # last 30 minutes.
+            rpc :RunRealtimeReport, ::Google::Analytics::Data::V1alpha::RunRealtimeReportRequest, ::Google::Analytics::Data::V1alpha::RunRealtimeReportResponse
           end
 
           Stub = Service.rpc_stub_class

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

@@ -21,7 +21,7 @@ module Google
   module Analytics
     module Data
       module V1alpha
-        VERSION = "0.3.1"
+        VERSION = "0.4.0"
       end
     end
   end

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

@@ -27,7 +27,7 @@ module Google
         #     Resource name of this metadata.
         # @!attribute [rw] dimensions
         #   @return [::Array<::Google::Analytics::Data::V1alpha::DimensionMetadata>]
-        #     The dimensions descriptions.
+        #     The dimension descriptions.
         # @!attribute [rw] metrics
         #   @return [::Array<::Google::Analytics::Data::V1alpha::MetricMetadata>]
         #     The metric descriptions.
@@ -340,6 +340,85 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # The request to generate a realtime report.
+        # @!attribute [rw] property
+        #   @return [::String]
+        #     A Google Analytics GA4 property identifier whose events are tracked.
+        #     Specified in the URL path and not the body. To learn more, see [where to
+        #     find your Property
+        #     ID](https://developers.google.com/analytics/trusted-testing/analytics-data/property-id).
+        #
+        #     Example: properties/1234
+        # @!attribute [rw] dimensions
+        #   @return [::Array<::Google::Analytics::Data::V1alpha::Dimension>]
+        #     The dimensions requested and displayed.
+        # @!attribute [rw] metrics
+        #   @return [::Array<::Google::Analytics::Data::V1alpha::Metric>]
+        #     The metrics requested and displayed.
+        # @!attribute [rw] limit
+        #   @return [::Integer]
+        #     The number of rows to return. If unspecified, 10 rows are returned. If
+        #     -1, all rows are returned.
+        # @!attribute [rw] dimension_filter
+        #   @return [::Google::Analytics::Data::V1alpha::FilterExpression]
+        #     The filter clause of dimensions. Dimensions must be requested to be used in
+        #     this filter. Metrics cannot be used in this filter.
+        # @!attribute [rw] metric_filter
+        #   @return [::Google::Analytics::Data::V1alpha::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.
+        # @!attribute [rw] metric_aggregations
+        #   @return [::Array<::Google::Analytics::Data::V1alpha::MetricAggregation>]
+        #     Aggregation of metrics. Aggregated metric values will be shown in rows
+        #     where the dimension_values are set to "RESERVED_(MetricAggregation)".
+        # @!attribute [rw] order_bys
+        #   @return [::Array<::Google::Analytics::Data::V1alpha::OrderBy>]
+        #     Specifies how rows are ordered in the response.
+        # @!attribute [rw] return_property_quota
+        #   @return [::Boolean]
+        #     Toggles whether to return the current state of this Analytics Property's
+        #     Realtime quota. Quota is returned in [PropertyQuota](#PropertyQuota).
+        class RunRealtimeReportRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The response realtime report table corresponding to a request.
+        # @!attribute [rw] dimension_headers
+        #   @return [::Array<::Google::Analytics::Data::V1alpha::DimensionHeader>]
+        #     Describes dimension columns. The number of DimensionHeaders and ordering of
+        #     DimensionHeaders matches the dimensions present in rows.
+        # @!attribute [rw] metric_headers
+        #   @return [::Array<::Google::Analytics::Data::V1alpha::MetricHeader>]
+        #     Describes metric columns. The number of MetricHeaders and ordering of
+        #     MetricHeaders matches the metrics present in rows.
+        # @!attribute [rw] rows
+        #   @return [::Array<::Google::Analytics::Data::V1alpha::Row>]
+        #     Rows of dimension value combinations and metric values in the report.
+        # @!attribute [rw] totals
+        #   @return [::Array<::Google::Analytics::Data::V1alpha::Row>]
+        #     If requested, the totaled values of metrics.
+        # @!attribute [rw] maximums
+        #   @return [::Array<::Google::Analytics::Data::V1alpha::Row>]
+        #     If requested, the maximum values of metrics.
+        # @!attribute [rw] minimums
+        #   @return [::Array<::Google::Analytics::Data::V1alpha::Row>]
+        #     If requested, the minimum values of metrics.
+        # @!attribute [rw] row_count
+        #   @return [::Integer]
+        #     The total number of rows in the query result, regardless of the number of
+        #     rows returned in the response. For example if a query returns 175 rows and
+        #     includes limit = 50 in the API request, the response will contain row_count
+        #     = 175 but only 50 rows.
+        # @!attribute [rw] property_quota
+        #   @return [::Google::Analytics::Data::V1alpha::PropertyQuota]
+        #     This Analytics Property's Realtime quota state including this request.
+        class RunRealtimeReportResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
       end
     end
   end

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

@@ -50,18 +50,30 @@ module Google
         # The unique identifier of the property whose events are tracked.
         # @!attribute [rw] property_id
         #   @return [::String]
-        #     A Google Analytics 4 (GA4) property id.
+        #     A Google Analytics GA4 property id. To learn more, see [where to find your
+        #     Property
+        #     ID](https://developers.google.com/analytics/trusted-testing/analytics-data/property-id).
         class Entity
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Dimensions are attributes of your data. For example, the dimension City
-        # indicates the city, for example, "Paris" or "New York", from which an event
-        # originates. Requests are allowed up to 8 dimensions.
+        # Dimensions are attributes of your data. For example, the dimension city
+        # indicates the city from which an event originates. Dimension values in report
+        # responses are strings; for example, city could be "Paris" or "New York".
+        # Requests are allowed up to 8 dimensions.
         # @!attribute [rw] name
         #   @return [::String]
-        #     The name of the dimension.
+        #     The name of the dimension. See the [API
+        #     Dimensions](https://developers.google.com/analytics/trusted-testing/analytics-data/api-schema#dimensions)
+        #     for the list of dimension names.
+        #
+        #     If `dimensionExpression` is specified, `name` can be any string that you
+        #     would like. For example if a `dimensionExpression` concatenates `country`
+        #     and `city`, you could call that dimension `countryAndCity`.
+        #
+        #     Dimensions are referenced by `name` in `dimensionFilter`, `orderBys`,
+        #     `dimensionExpression`, and `pivots`.
         # @!attribute [rw] dimension_expression
         #   @return [::Google::Analytics::Data::V1alpha::DimensionExpression]
         #     One dimension can be the result of an expression of multiple dimensions.
@@ -119,20 +131,30 @@ module Google
           end
         end
 
-        # The quantitative measurements of a report. For example, the metric eventCount
-        # is the total number of events. Requests are allowed up to 10 metrics.
+        # The quantitative measurements of a report. For example, the metric
+        # `eventCount` is the total number of events. Requests are allowed up to 10
+        # metrics.
         # @!attribute [rw] name
         #   @return [::String]
-        #     The name of the metric.
+        #     The name of the metric. See the [API
+        #     Metrics](https://developers.google.com/analytics/trusted-testing/analytics-data/api-schema#metrics)
+        #     for the list of metric names.
+        #
+        #     If `expression` is specified, `name` can be any string that you would like.
+        #     For example if `expression` is `screenPageViews/sessions`, you could call
+        #     that metric's name = `viewsPerSession`.
+        #
+        #     Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric
+        #     `expression`.
         # @!attribute [rw] expression
         #   @return [::String]
         #     A mathematical expression for derived metrics. For example, the metric
-        #     Event count per user is eventCount/totalUsers.
+        #     Event count per user is `eventCount/totalUsers`.
         # @!attribute [rw] invisible
         #   @return [::Boolean]
-        #     Indicates if a metric is invisible.
-        #     If a metric is invisible, the metric is not in the response, but can be
-        #     used in filters, order_bys or being referred to in a metric expression.
+        #     Indicates if a metric is invisible in the report response. If a metric is
+        #     invisible, the metric will not produce a column in the response, but can be
+        #     used in `metricFilter`, `orderBys`, or a metric `expression`.
         class Metric
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -176,7 +198,10 @@ module Google
         #     or metrics.
         # @!attribute [rw] null_filter
         #   @return [::Boolean]
-        #     A filter for null values.
+        #     A filter for null values. If True, a null dimension value is matched by
+        #     this filter. Null filter is commonly used inside a NOT filter
+        #     expression. For example, a NOT expression of a null filter removes rows
+        #     when a dimension is null.
         # @!attribute [rw] string_filter
         #   @return [::Google::Analytics::Data::V1alpha::Filter::StringFilter]
         #     Strings related filter.
@@ -577,28 +602,38 @@ module Google
         # For example if RunReportRequest contains:
         #
         # ```none
-        # dimensions {
-        #   name: "eventName"
-        # }
-        # dimensions {
-        #   name: "countryId"
-        # }
-        # metrics {
-        #   name: "eventCount"
-        # }
+        # "dimensions": [
+        #   {
+        #     "name": "eventName"
+        #   },
+        #   {
+        #     "name": "countryId"
+        #   }
+        # ],
+        # "metrics": [
+        #   {
+        #     "name": "eventCount"
+        #   }
+        # ]
         # ```
         #
-        # One row with 'in_app_purchase' as the eventName, 'us' as the countryId, and
+        # One row with 'in_app_purchase' as the eventName, 'JP' as the countryId, and
         # 15 as the eventCount, would be:
         #
         # ```none
-        # dimension_values {
-        #   name: 'in_app_purchase'
-        #   name: 'us'
-        # }
-        # metric_values {
-        #   int64_value: 15
-        # }
+        # "dimensionValues": [
+        #   {
+        #     "value": "in_app_purchase"
+        #   },
+        #   {
+        #     "value": "JP"
+        #   }
+        # ],
+        # "metricValues": [
+        #   {
+        #     "value": "15"
+        #   }
+        # ]
         # ```
         # @!attribute [rw] dimension_values
         #   @return [::Array<::Google::Analytics::Data::V1alpha::DimensionValue>]
@@ -647,20 +682,24 @@ module Google
         # Exhausted errors.
         # @!attribute [rw] tokens_per_day
         #   @return [::Google::Analytics::Data::V1alpha::QuotaStatus]
-        #     Analytics Properties can use up to 25,000 tokens per day. Most requests
+        #     Standard Analytics Properties can use up to 25,000 tokens per day;
+        #     Analytics 360 Properties can use 250,000 tokens per day. Most requests
         #     consume fewer than 10 tokens.
         # @!attribute [rw] tokens_per_hour
         #   @return [::Google::Analytics::Data::V1alpha::QuotaStatus]
-        #     Analytics Properties can use up to 5,000 tokens per day. An API request
-        #     consumes a single number of tokens, and that number is deducted from both
-        #     the hourly and daily quotas.
+        #     Standard Analytics Properties can use up to 5,000 tokens per day; Analytics
+        #     360 Properties can use 50,000 tokens per day. An API request consumes a
+        #     single number of tokens, and that number is deducted from both the hourly
+        #     and daily quotas.
         # @!attribute [rw] concurrent_requests
         #   @return [::Google::Analytics::Data::V1alpha::QuotaStatus]
-        #     Analytics Properties can send up to 10 concurrent requests.
+        #     Standard Analytics Properties can send up to 10 concurrent requests;
+        #     Analytics 360 Properties can use up to 50 concurrent requests.
         # @!attribute [rw] server_errors_per_project_per_hour
         #   @return [::Google::Analytics::Data::V1alpha::QuotaStatus]
-        #     Analytics Properties and cloud project pairs can have up to 10
-        #     server errors per hour.
+        #     Standard Analytics Properties and cloud project pairs can have up to 10
+        #     server errors per hour; Analytics 360 Properties and cloud project pairs
+        #     can have up to 50 server errors per hour.
         class PropertyQuota
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-analytics-data-v1alpha
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-04 00:00:00.000000000 Z
+date: 2020-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common