google-analytics-data-v1alpha 0.3.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35dc803cd72fb7120194aeb04b1ccfb640f200165deabc568f6b420c167bf730
-  data.tar.gz: 77d920b3c591b727e85234aa878175726f34771e7e1f8f706ec123d69b19d137
+  metadata.gz: 4f1f102c64905a1dbbb3ca35ea1f45a1b6715f77bf0f49b9145f959bddad0618
+  data.tar.gz: 66274a94ad9f6695a6edb528e6b1c120b99596c44289412499aab5f162bd0b9a
 SHA512:
-  metadata.gz: 6fc6b8aee8c8753c8c1364a336cb8608343a0d8a55a7eea5f8d691f02b301fc97644e537d0055c3c24ce81246673016e58faa9c22e45d3eccab484623f24a3ca
-  data.tar.gz: 5f6c53ce9599acdd2eb667b0313e3c09ea8cde19d8a3735d03fff422de03a8a58b14d4713b23e2818663069814dead092118e39700ce4db7b91f1b87e230f6ce
+  metadata.gz: 659e65666d5dd59f4fc212e5e0f3d300da171793ff947c1681af291bf65310de4355599e9f3d7ab1f53496870002db4f902bbe3e38d144de306f86b9f34c0025
+  data.tar.gz: ad58507a7c5868124381d7f2a43c14a26f9088e6fcc185f0c2e4dfb3a07d4d998b3d65e27c84919c546d2f870cd23f31bd640e2233247cc11ab4cba3ea585c37

data/README.md

@@ -6,6 +6,12 @@ The Google Analytics Data API provides programmatic methods to access report dat
 
 https://github.com/googleapis/google-cloud-ruby
 
+This gem is a _versioned_ client. It provides basic client classes for a
+specific version of the Google Analytics Data V1alpha API. Most users should consider using
+the main client gem,
+[google-analytics-data](https://rubygems.org/gems/google-analytics-data).
+See the section below titled *Which client should I use?* for more information.
+
 ## Installation
 
 ```
@@ -70,3 +76,61 @@ in security maintenance, and not end of life. Currently, this means Ruby 2.4
 and later. Older versions of Ruby _may_ still work, but are unsupported and not
 recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
 about the Ruby support schedule.
+
+## Which client should I use?
+
+Most modern Ruby client libraries for Google APIs come in two flavors: the main
+client library with a name such as `google-analytics-data`,
+and lower-level _versioned_ client libraries with names such as
+`google-analytics-data-v1alpha`.
+_In most cases, you should install the main client._
+
+### What's the difference between the main client and a versioned client?
+
+A _versioned client_ provides a basic set of data types and client classes for
+a _single version_ of a specific service. (That is, for a service with multiple
+versions, there might be a separate versioned client for each service version.)
+Most versioned clients are written and maintained by a code generator.
+
+The _main client_ is designed to provide you with the _recommended_ client
+interfaces for the service. There will be only one main client for any given
+service, even a service with multiple versions. The main client includes
+factory methods for constructing the client objects we recommend for most
+users. In some cases, those will be classes provided by an underlying versioned
+client; in other cases, they will be handwritten higher-level client objects
+with additional capabilities, convenience methods, or best practices built in.
+Generally, the main client will default to a recommended service version,
+although in some cases you can override this if you need to talk to a specific
+service version.
+
+### Why would I want to use the main client?
+
+We recommend that most users install the main client gem for a service. You can
+identify this gem as the one _without_ a version in its name, e.g.
+`google-analytics-data`.
+The main client is recommended because it will embody the best practices for
+accessing the service, and may also provide more convenient interfaces or
+tighter integration into frameworks and third-party libraries. In addition, the
+documentation and samples published by Google will generally demonstrate use of
+the main client.
+
+### Why would I want to use a versioned client?
+
+You can use a versioned client if you are content with a possibly lower-level
+class interface, you explicitly want to avoid features provided by the main
+client, or you want to access a specific service version not be covered by the
+main client. You can identify versioned client gems because the service version
+is part of the name, e.g. `google-analytics-data-v1alpha`.
+
+### What about the google-apis-<name> clients?
+
+Client library gems with names that begin with `google-apis-` are based on an
+older code generation technology. They talk to a REST/JSON backend (whereas
+most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
+not offer the same performance, features, and ease of use provided by more
+modern clients.
+
+The `google-apis-` clients have wide coverage across Google services, so you
+might need to use one if there is no modern client available for the service.
+However, if a modern client is available, we generally recommend it over the
+older `google-apis-` clients.

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

@@ -33,3 +33,6 @@ module Google
     end
   end
 end
+
+helper_path = ::File.join __dir__, "v1alpha", "_helpers.rb"
+require "google/analytics/data/v1alpha/_helpers" if ::File.file? helper_path

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

@@ -142,7 +142,13 @@ module Google
 
               # Create credentials
               credentials = @config.credentials
-              credentials ||= Credentials.default scope: @config.scope
+              # Use self-signed JWT if the scope and endpoint are 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 &&
+                                       !@config.endpoint.split(".").first.include?("-")
+              credentials ||= Credentials.default scope:                  @config.scope,
+                                                  enable_self_signed_jwt: enable_self_signed_jwt
               if credentials.is_a?(String) || credentials.is_a?(Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
@@ -199,9 +205,15 @@ module Google
             #     must be unspecified.
             #   @param offset [::Integer]
             #     The row count of the start row. The first row is counted as row 0.
+            #
+            #     To learn more about this pagination parameter, see
+            #     [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
             #   @param limit [::Integer]
             #     The number of rows to return. If unspecified, 10 rows are returned. If
             #     -1, all rows are returned.
+            #
+            #     To learn more about this pagination parameter, see
+            #     [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
             #   @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)".
@@ -504,40 +516,62 @@ module Google
 
             ##
             # Returns metadata for dimensions and metrics available in reporting methods.
-            # Used to explore the dimensions and metrics. Dimensions and metrics will be
-            # mostly added over time, but renames and deletions may occur.
+            # Used to explore the dimensions and metrics. In this method, a Google
+            # Analytics GA4 Property Identifier is specified in the request, and
+            # the metadata response includes Custom dimensions and metrics as well as
+            # Universal metadata.
             #
-            # This method returns Universal Metadata. Universal Metadata are dimensions
-            # and metrics applicable to any property such as `country` and `totalUsers`.
+            # For example if a custom metric with parameter name `levels_unlocked` is
+            # registered to a property, the Metadata response will contain
+            # `customEvent:levels_unlocked`. Universal metadata are dimensions and
+            # metrics applicable to any property such as `country` and `totalUsers`.
             #
-            # @overload get_universal_metadata(request, options = nil)
-            #   Pass arguments to `get_universal_metadata` via a request object, either of type
-            #   {::Google::Analytics::Data::V1alpha::GetUniversalMetadataRequest} or an equivalent Hash.
+            # @overload get_metadata(request, options = nil)
+            #   Pass arguments to `get_metadata` via a request object, either of type
+            #   {::Google::Analytics::Data::V1alpha::GetMetadataRequest} or an equivalent Hash.
             #
-            #   @param request [::Google::Analytics::Data::V1alpha::GetUniversalMetadataRequest, ::Hash]
+            #   @param request [::Google::Analytics::Data::V1alpha::GetMetadataRequest, ::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 get_metadata(name: nil)
+            #   Pass arguments to `get_metadata` 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 name [::String]
+            #     Required. The resource name of the metadata to retrieve. This name field is
+            #     specified in the URL path and not URL parameters. Property is a numeric
+            #     Google Analytics GA4 Property identifier. To learn more, see [where to find
+            #     your Property
+            #     ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
+            #
+            #     Example: properties/1234/metadata
+            #
+            #     Set the Property ID to 0 for dimensions and metrics common to all
+            #     properties. In this special mode, this method will not return custom
+            #     dimensions and metrics.
+            #
             # @yield [response, operation] Access the result along with the RPC operation
-            # @yieldparam response [::Google::Analytics::Data::V1alpha::UniversalMetadata]
+            # @yieldparam response [::Google::Analytics::Data::V1alpha::Metadata]
             # @yieldparam operation [::GRPC::ActiveCall::Operation]
             #
-            # @return [::Google::Analytics::Data::V1alpha::UniversalMetadata]
+            # @return [::Google::Analytics::Data::V1alpha::Metadata]
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
-            def get_universal_metadata request, options = nil
+            def get_metadata request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
-              request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Data::V1alpha::GetUniversalMetadataRequest
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Data::V1alpha::GetMetadataRequest
 
               # 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.get_universal_metadata.metadata.to_h
+              metadata = @config.rpcs.get_metadata.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 \
@@ -545,13 +579,19 @@ module Google
                 gapic_version: ::Google::Analytics::Data::V1alpha::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              options.apply_defaults timeout:      @config.rpcs.get_universal_metadata.timeout,
+              header_params = {
+                "name" => request.name
+              }
+              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_universal_metadata.retry_policy
+                                     retry_policy: @config.rpcs.get_metadata.retry_policy
               options.apply_defaults metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
-              @analytics_data_stub.call_rpc :get_universal_metadata, request, options: options do |response, operation|
+              @analytics_data_stub.call_rpc :get_metadata, request, options: options do |response, operation|
                 yield response, operation if block_given?
                 return response
               end
@@ -560,57 +600,73 @@ module Google
             end
 
             ##
-            # Returns metadata for dimensions and metrics available in reporting methods.
-            # Used to explore the dimensions and metrics. In this method, a Google
-            # Analytics 4 (GA4) Property Identifier is specified in the request, and
-            # the metadata response includes Custom dimensions and metrics as well as
-            # Universal metadata.
-            #
-            # For example if a custom metric with parameter name `levels_unlocked` is
-            # registered to a property, the Metadata response will contain
-            # `customEvent:levels_unlocked`. Universal metadata are dimensions and
-            # metrics applicable to any property such as `country` and `totalUsers`.
+            # 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 get_metadata(request, options = nil)
-            #   Pass arguments to `get_metadata` via a request object, either of type
-            #   {::Google::Analytics::Data::V1alpha::GetMetadataRequest} or an equivalent Hash.
+            # @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::GetMetadataRequest, ::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 get_metadata(name: nil)
-            #   Pass arguments to `get_metadata` via keyword arguments. Note that at
+            # @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 name [::String]
-            #     Required. The resource name of the metadata to retrieve. This name field is
-            #     specified in the URL path and not URL parameters. Property is a numeric
-            #     Google Analytics 4 (GA4) Property identifier.
+            #   @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/devguides/reporting/data/v1/property-id).
             #
-            #     Example: properties/1234/metadata
+            #     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::Metadata]
+            # @yieldparam response [::Google::Analytics::Data::V1alpha::RunRealtimeReportResponse]
             # @yieldparam operation [::GRPC::ActiveCall::Operation]
             #
-            # @return [::Google::Analytics::Data::V1alpha::Metadata]
+            # @return [::Google::Analytics::Data::V1alpha::RunRealtimeReportResponse]
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
-            def get_metadata request, options = nil
+            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::GetMetadataRequest
+              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.get_metadata.metadata.to_h
+              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 \
@@ -619,18 +675,18 @@ module Google
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
               header_params = {
-                "name" => request.name
+                "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.get_metadata.timeout,
+              options.apply_defaults timeout:      @config.rpcs.run_realtime_report.timeout,
                                      metadata:     metadata,
-                                     retry_policy: @config.rpcs.get_metadata.retry_policy
+                                     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 :get_metadata, request, options: options do |response, operation|
+              @analytics_data_stub.call_rpc :run_realtime_report, request, options: options do |response, operation|
                 yield response, operation if block_given?
                 return response
               end
@@ -763,7 +819,7 @@ module Google
               # Each configuration object is of type `Gapic::Config::Method` and includes
               # the following configuration fields:
               #
-              #  *  `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
+              #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
               #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
               #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
               #     include the following keys:
@@ -795,15 +851,15 @@ module Google
                 #
                 attr_reader :batch_run_pivot_reports
                 ##
-                # RPC-specific configuration for `get_universal_metadata`
+                # RPC-specific configuration for `get_metadata`
                 # @return [::Gapic::Config::Method]
                 #
-                attr_reader :get_universal_metadata
+                attr_reader :get_metadata
                 ##
-                # RPC-specific configuration for `get_metadata`
+                # RPC-specific configuration for `run_realtime_report`
                 # @return [::Gapic::Config::Method]
                 #
-                attr_reader :get_metadata
+                attr_reader :run_realtime_report
 
                 # @private
                 def initialize parent_rpcs = nil
@@ -815,10 +871,10 @@ module Google
                   @batch_run_reports = ::Gapic::Config::Method.new batch_run_reports_config
                   batch_run_pivot_reports_config = parent_rpcs&.batch_run_pivot_reports if parent_rpcs&.respond_to? :batch_run_pivot_reports
                   @batch_run_pivot_reports = ::Gapic::Config::Method.new batch_run_pivot_reports_config
-                  get_universal_metadata_config = parent_rpcs&.get_universal_metadata if parent_rpcs&.respond_to? :get_universal_metadata
-                  @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

@@ -78,15 +78,30 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     add_message "google.analytics.data.v1alpha.BatchRunPivotReportsResponse" do
       repeated :pivot_reports, :message, 1, "google.analytics.data.v1alpha.RunPivotReportResponse"
     end
-    add_message "google.analytics.data.v1alpha.GetUniversalMetadataRequest" do
-    end
-    add_message "google.analytics.data.v1alpha.UniversalMetadata" do
-      repeated :dimensions, :message, 1, "google.analytics.data.v1alpha.DimensionMetadata"
-      repeated :metrics, :message, 2, "google.analytics.data.v1alpha.MetricMetadata"
-    end
     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
 
@@ -103,9 +118,9 @@ module Google
         BatchRunReportsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.BatchRunReportsResponse").msgclass
         BatchRunPivotReportsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.BatchRunPivotReportsRequest").msgclass
         BatchRunPivotReportsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.BatchRunPivotReportsResponse").msgclass
-        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

@@ -54,15 +54,8 @@ module Google
             # Entity.
             rpc :BatchRunPivotReports, ::Google::Analytics::Data::V1alpha::BatchRunPivotReportsRequest, ::Google::Analytics::Data::V1alpha::BatchRunPivotReportsResponse
             # Returns metadata for dimensions and metrics available in reporting methods.
-            # Used to explore the dimensions and metrics. Dimensions and metrics will be
-            # mostly added over time, but renames and deletions may occur.
-            #
-            # This method returns Universal Metadata. Universal Metadata are dimensions
-            # and metrics applicable to any property such as `country` and `totalUsers`.
-            rpc :GetUniversalMetadata, ::Google::Analytics::Data::V1alpha::GetUniversalMetadataRequest, ::Google::Analytics::Data::V1alpha::UniversalMetadata
-            # Returns metadata for dimensions and metrics available in reporting methods.
             # Used to explore the dimensions and metrics. In this method, a Google
-            # Analytics 4 (GA4) Property Identifier is specified in the request, and
+            # Analytics GA4 Property Identifier is specified in the request, and
             # the metadata response includes Custom dimensions and metrics as well as
             # Universal metadata.
             #
@@ -71,6 +64,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/data_pb.rb

@@ -137,9 +137,6 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :dimension, :string, 2
       optional :date_range, :message, 3, "google.analytics.data.v1alpha.DateRange"
     end
-    add_message "google.analytics.data.v1alpha.CohortReportSettings" do
-      optional :accumulate, :bool, 1
-    end
     add_message "google.analytics.data.v1alpha.CohortsRange" do
       optional :granularity, :enum, 1, "google.analytics.data.v1alpha.CohortsRange.Granularity"
       optional :start_offset, :int32, 2
@@ -151,6 +148,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :WEEKLY, 2
       value :MONTHLY, 3
     end
+    add_message "google.analytics.data.v1alpha.CohortReportSettings" do
+      optional :accumulate, :bool, 1
+    end
     add_message "google.analytics.data.v1alpha.ResponseMetaData" do
       optional :data_loss_from_other_row, :bool, 3
     end
@@ -203,6 +203,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :ui_name, :string, 2
       optional :description, :string, 3
       repeated :deprecated_api_names, :string, 4
+      optional :custom_definition, :bool, 5
     end
     add_message "google.analytics.data.v1alpha.MetricMetadata" do
       optional :api_name, :string, 1
@@ -211,6 +212,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       repeated :deprecated_api_names, :string, 4
       optional :type, :enum, 5, "google.analytics.data.v1alpha.MetricType"
       optional :expression, :string, 6
+      optional :custom_definition, :bool, 7
     end
     add_enum "google.analytics.data.v1alpha.MetricAggregation" do
       value :METRIC_AGGREGATION_UNSPECIFIED, 0
@@ -266,9 +268,9 @@ module Google
         Pivot = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.Pivot").msgclass
         CohortSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.CohortSpec").msgclass
         Cohort = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.Cohort").msgclass
-        CohortReportSettings = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.CohortReportSettings").msgclass
         CohortsRange = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.CohortsRange").msgclass
         CohortsRange::Granularity = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.CohortsRange.Granularity").enummodule
+        CohortReportSettings = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.CohortReportSettings").msgclass
         ResponseMetaData = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.ResponseMetaData").msgclass
         DimensionHeader = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.DimensionHeader").msgclass
         MetricHeader = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.MetricHeader").msgclass

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.7.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.
@@ -57,10 +57,16 @@ module Google
         # @!attribute [rw] offset
         #   @return [::Integer]
         #     The row count of the start row. The first row is counted as row 0.
+        #
+        #     To learn more about this pagination parameter, see
+        #     [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
         # @!attribute [rw] limit
         #   @return [::Integer]
         #     The number of rows to return. If unspecified, 10 rows are returned. If
         #     -1, all rows are returned.
+        #
+        #     To learn more about this pagination parameter, see
+        #     [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
         # @!attribute [rw] metric_aggregations
         #   @return [::Array<::Google::Analytics::Data::V1alpha::MetricAggregation>]
         #     Aggregation of metrics. Aggregated metric values will be shown in rows
@@ -126,6 +132,9 @@ module Google
         #     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.
+        #
+        #     To learn more about this pagination parameter, see
+        #     [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
         # @!attribute [rw] metadata
         #   @return [::Google::Analytics::Data::V1alpha::ResponseMetaData]
         #     Metadata for the report.
@@ -310,33 +319,100 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request for the universal dimension and metric metadata.
-        class GetUniversalMetadataRequest
+        # Request for a property's dimension and metric metadata.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the metadata to retrieve. This name field is
+        #     specified in the URL path and not URL parameters. Property is a numeric
+        #     Google Analytics GA4 Property identifier. To learn more, see [where to find
+        #     your Property
+        #     ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
+        #
+        #     Example: properties/1234/metadata
+        #
+        #     Set the Property ID to 0 for dimensions and metrics common to all
+        #     properties. In this special mode, this method will not return custom
+        #     dimensions and metrics.
+        class GetMetadataRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The dimensions and metrics currently accepted in reporting methods.
+        # 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/devguides/reporting/data/v1/property-id).
+        #
+        #     Example: properties/1234
         # @!attribute [rw] dimensions
-        #   @return [::Array<::Google::Analytics::Data::V1alpha::DimensionMetadata>]
-        #     The dimensions descriptions.
+        #   @return [::Array<::Google::Analytics::Data::V1alpha::Dimension>]
+        #     The dimensions requested and displayed.
         # @!attribute [rw] metrics
-        #   @return [::Array<::Google::Analytics::Data::V1alpha::MetricMetadata>]
-        #     The metric descriptions.
-        class UniversalMetadata
+        #   @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
 
-        # Request for a property's dimension and metric metadata.
-        # @!attribute [rw] name
-        #   @return [::String]
-        #     Required. The resource name of the metadata to retrieve. This name field is
-        #     specified in the URL path and not URL parameters. Property is a numeric
-        #     Google Analytics 4 (GA4) Property identifier.
-        #
-        #     Example: properties/1234/metadata
-        class GetMetadataRequest
+        # 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

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

@@ -22,8 +22,7 @@ module Google
     module Data
       module V1alpha
         # A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests
-        # are allowed up to 4 date ranges, and the union of the ranges can cover up to
-        # 1 year.
+        # are allowed up to 4 date ranges.
         # @!attribute [rw] start_date
         #   @return [::String]
         #     The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot
@@ -50,18 +49,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/devguides/reporting/data/v1/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/devguides/reporting/data/v1/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 +130,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/devguides/reporting/data/v1/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 +197,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.
@@ -423,23 +447,38 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Specification for a cohort report.
+        # Specification of cohorts for a cohort report.
+        # Cohort reports can be used for example to create a time series of user
+        # retention for the cohort. For example, you could select the cohort of users
+        # that were acquired in the first week of September and follow that cohort for
+        # the next six weeks. Selecting the users acquired in the first week of
+        # September cohort is specified in the `cohort` object. Following that
+        # cohort for the next six weeks is specified in the `cohortsRange` object.
+        #
+        # The report response could show a weekly time series where say your app has
+        # retained 60% of this cohort after three weeks and 25% of this cohort after
+        # six weeks. These two percentages can be calculated by the metric
+        # `cohortActiveUsers/cohortTotalUsers` and will be separate rows in the report.
         # @!attribute [rw] cohorts
         #   @return [::Array<::Google::Analytics::Data::V1alpha::Cohort>]
-        #     The definition for the cohorts.
+        #     Defines the selection criteria to group users into cohorts.
+        #
+        #     Most cohort reports define only a single cohort. If multiple cohorts are
+        #     specified, each cohort can be recognized in the report by their name.
         # @!attribute [rw] cohorts_range
         #   @return [::Google::Analytics::Data::V1alpha::CohortsRange]
-        #     The data ranges of cohorts.
+        #     Cohort reports follow cohorts over an extended reporting date range. This
+        #     range specifies an offset duration to follow the cohorts over.
         # @!attribute [rw] cohort_report_settings
         #   @return [::Google::Analytics::Data::V1alpha::CohortReportSettings]
-        #     Settings of a cohort report.
+        #     Optional settings for a cohort report.
         class CohortSpec
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Defines a cohort. A cohort is a group of users who share a common
-        # characteristic. For example, all users with the same acquisition date
+        # Defines a cohort selection criteria. A cohort is a group of users who share
+        # a common characteristic. For example, users with the same `firstTouchDate`
         # belong to the same cohort.
         # @!attribute [rw] name
         #   @return [::String]
@@ -449,69 +488,100 @@ module Google
         #     `cohort_0`, `cohort_1`, etc.
         # @!attribute [rw] dimension
         #   @return [::String]
-        #     The dimension used by cohort. Only supports `firstTouchDate` for retention
-        #     report.
+        #     Dimension used by the cohort. Required and only supports `firstTouchDate`.
         # @!attribute [rw] date_range
         #   @return [::Google::Analytics::Data::V1alpha::DateRange]
-        #     The cohort selects users whose first visit date is between start date
-        #     and end date defined in the `dateRange`. In a cohort request, this
-        #     `dateRange` is required and the `dateRanges` in the `RunReportRequest` or
-        #     `RunPivotReportRequest` must be unspecified.
+        #     The cohort selects users whose first touch date is between start date and
+        #     end date defined in the `dateRange`. This `dateRange` does not specify the
+        #     full date range of event data that is present in a cohort report. In a
+        #     cohort report, this `dateRange` is extended by the granularity and offset
+        #     present in the `cohortsRange`; event data for the extended reporting date
+        #     range is present in a cohort report.
         #
-        #     The date range should be aligned with the cohort's granularity. If
-        #     CohortsRange uses daily granularity, the date range can be aligned to any
-        #     day. If CohortsRange uses weekly granularity, the date range should be
-        #     aligned to the week boundary, starting at Sunday and ending Saturday. If
-        #     CohortsRange uses monthly granularity, the date range should be aligned to
-        #     the month, starting at the first and ending on the last day of the month.
+        #     In a cohort request, this `dateRange` is required and the `dateRanges` in
+        #     the `RunReportRequest` or `RunPivotReportRequest` must be unspecified.
+        #
+        #     This `dateRange` should generally be aligned with the cohort's granularity.
+        #     If `CohortsRange` uses daily granularity, this `dateRange` can be a single
+        #     day. If `CohortsRange` uses weekly granularity, this `dateRange` can be
+        #     aligned to a week boundary, starting at Sunday and ending Saturday. If
+        #     `CohortsRange` uses monthly granularity, this `dateRange` can be aligned to
+        #     a month, starting at the first and ending on the last day of the month.
         class Cohort
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Settings of a cohort report.
-        # @!attribute [rw] accumulate
-        #   @return [::Boolean]
-        #     If true, accumulates the result from first visit day to the end day. Not
-        #     supported in `RunReportRequest`.
-        class CohortReportSettings
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-        end
-
-        # Describes date range for a cohort report.
+        # Configures the extended reporting date range for a cohort report. Specifies
+        # an offset duration to follow the cohorts over.
         # @!attribute [rw] granularity
         #   @return [::Google::Analytics::Data::V1alpha::CohortsRange::Granularity]
-        #     Reporting date range for each cohort is calculated based on these three
-        #     fields.
+        #     The granularity used to interpret the `startOffset` and `endOffset` for the
+        #     extended reporting date range for a cohort report.
         # @!attribute [rw] start_offset
         #   @return [::Integer]
-        #     For daily cohorts, this will be the start day offset.
-        #     For weekly cohorts, this will be the week offset.
+        #     `startOffset` specifies the start date of the extended reporting date range
+        #     for a cohort report. `startOffset` is commonly set to 0 so that reports
+        #     contain data from the acquisition of the cohort forward.
+        #
+        #     If `granularity` is `DAILY`, the `startDate` of the extended reporting date
+        #     range is `startDate` of the cohort plus `startOffset` days.
+        #
+        #     If `granularity` is `WEEKLY`, the `startDate` of the extended reporting
+        #     date range is `startDate` of the cohort plus `startOffset * 7` days.
+        #
+        #     If `granularity` is `MONTHLY`, the `startDate` of the extended reporting
+        #     date range is `startDate` of the cohort plus `startOffset * 30` days.
         # @!attribute [rw] end_offset
         #   @return [::Integer]
-        #     For daily cohorts, this will be the end day offset.
-        #     For weekly cohorts, this will be the week offset.
+        #     `endOffset` specifies the end date of the extended reporting date range
+        #     for a cohort report. `endOffset` can be any positive integer but is
+        #     commonly set to 5 to 10 so that reports contain data on the cohort for the
+        #     next several granularity time periods.
+        #
+        #     If `granularity` is `DAILY`, the `endDate` of the extended reporting date
+        #     range is `endDate` of the cohort plus `endOffset` days.
+        #
+        #     If `granularity` is `WEEKLY`, the `endDate` of the extended reporting date
+        #     range is `endDate` of the cohort plus `endOffset * 7` days.
+        #
+        #     If `granularity` is `MONTHLY`, the `endDate` of the extended reporting date
+        #     range is `endDate` of the cohort plus `endOffset * 30` days.
         class CohortsRange
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
 
-          # Reporting granularity for the cohorts.
+          # The granularity used to interpret the `startOffset` and `endOffset` for the
+          # extended reporting date range for a cohort report.
           module Granularity
-            # Unspecified.
+            # Should never be specified.
             GRANULARITY_UNSPECIFIED = 0
 
-            # Daily
+            # Daily granularity. Commonly used if the cohort's `dateRange` is a single
+            # day and the request contains `cohortNthDay`.
             DAILY = 1
 
-            # Weekly
+            # Weekly granularity. Commonly used if the cohort's `dateRange` is a week
+            # in duration (starting on Sunday and ending on Saturday) and the request
+            # contains `cohortNthWeek`.
             WEEKLY = 2
 
-            # Monthly
+            # Monthly granularity. Commonly used if the cohort's `dateRange` is a month
+            # in duration and the request contains `cohortNthMonth`.
             MONTHLY = 3
           end
         end
 
+        # Optional settings of a cohort report.
+        # @!attribute [rw] accumulate
+        #   @return [::Boolean]
+        #     If true, accumulates the result from first touch day to the end day. Not
+        #     supported in `RunReportRequest`.
+        class CohortReportSettings
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Response's metadata carrying additional information about the report content.
         # @!attribute [rw] data_loss_from_other_row
         #   @return [::Boolean]
@@ -577,28 +647,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 +727,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
@@ -696,6 +780,9 @@ module Google
         #     dimension is available by either `apiName` or one of `deprecatedApiNames`
         #     for a period of time. After the deprecation period, the dimension will be
         #     available only by `apiName`.
+        # @!attribute [rw] custom_definition
+        #   @return [::Boolean]
+        #     True if the dimension is a custom dimension for this property.
         class DimensionMetadata
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -727,6 +814,9 @@ module Google
         #     The mathematical expression for this derived metric. Can be used in
         #     [Metric](#Metric)'s `expression` field for equivalent reports. Most metrics
         #     are not expressions, and for non-expressions, this field is empty.
+        # @!attribute [rw] custom_definition
+        #   @return [::Boolean]
+        #     True if the metric is a custom metric for this property.
         class MetricMetadata
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/api/field_behavior.rb

@@ -54,6 +54,12 @@ module Google
       # This indicates that the field may be set once in a request to create a
       # resource, but may not be changed thereafter.
       IMMUTABLE = 5
+
+      # Denotes that a (repeated) field is an unordered list.
+      # This indicates that the service may provide the elements of the list
+      # in any arbitrary order, rather than the order the user originally
+      # provided. Additionally, the list's order may or may not be stable.
+      UNORDERED_LIST = 6
     end
   end
 end

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.7.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-04 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -154,7 +154,9 @@ description: The Google Analytics Data API provides programmatic methods to acce
   report data in Google Analytics App+Web properties. With the Google Analytics Data
   API, you can build custom dashboards to display Google Analytics data, automate
   complex reporting tasks to save time, and integrate your Google Analytics data with
-  other business applications.
+  other business applications. Note that google-analytics-data-v1alpha is a version-specific
+  client library. For most uses, we recommend installing the main client library google-analytics-data
+  instead. See the readme for more details.
 email: googleapis-packages@google.com
 executables: []
 extensions: []
@@ -198,7 +200,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.6
 signing_key: 
 specification_version: 4
 summary: API Client library for the Google Analytics Data V1alpha API