google-analytics-data-v1beta 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64be66c7d2f44bf4750dbc690804a933a0fee5122c111989ff62f58d3d20c25f
-  data.tar.gz: 2b62c28348c001f627c472954f4810b0ab91fda3cf49e58aa7b3721a46edd4b0
+  metadata.gz: 5134b98fc41b7d917e3fe80a3c6562725c1379ebb19dbd61ea9d76c5b85cd9f5
+  data.tar.gz: 3df9c421232682bfd64758f0cb0a24922eef5aff90ef8f67f2f2bc0998da2da0
 SHA512:
-  metadata.gz: b1ffa099cb69913cdfdae6feb78ad781d1f7d4b833f4f7e0cbc72465bebd3278d95765a0391409344fb1853ddd6d6d1a7220b4cd892c274b3873d9f508130962
-  data.tar.gz: 1d5d101cebc0909b4d3481dfe30a7e3cbccedfb93bc4204fa2f70c63617181ca6f1304b972316089535845b9841666f790665312a2ad647462e1081359d34135
+  metadata.gz: 854cd6373f7222ab12711fbc63af02e1888a766e0752f5e28de8050e70707dd46ced34be8b00c75764b4adc046d69eb7f1cc43f89ac55c7a8493a2a85907d28d
+  data.tar.gz: 40b4ad526d172c8cbdaa85bfd46ec63400c9033f1509bc7d8510236010b077cf5053a2cf106322c5b8ca5362ac27f7424edf0121b4641650d70020e1ee235941

data/AUTHENTICATION.md

@@ -114,7 +114,7 @@ credentials are discovered.
 To configure your system for this, simply:
 
 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
-2. Authenticate using OAuth 2.0 `$ gcloud auth login`
+2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
 3. Write code as if already authenticated.
 
 **NOTE:** This is _not_ recommended for running in production. The Cloud SDK

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

@@ -77,8 +77,12 @@ module Google
 
                 default_config.rpcs.batch_run_pivot_reports.timeout = 60.0
 
+                default_config.rpcs.get_metadata.timeout = 60.0
+
                 default_config.rpcs.run_realtime_report.timeout = 60.0
 
+                default_config.rpcs.check_compatibility.timeout = 60.0
+
                 default_config
               end
               yield @configure if block_given?
@@ -168,6 +172,10 @@ module Google
             # event count. Dimensions break down metrics across some common criteria,
             # such as country or event name.
             #
+            # For a guide to constructing requests & understanding responses, see
+            # [Creating a
+            # Report](https://developers.google.com/analytics/devguides/reporting/data/v1/basics).
+            #
             # @overload run_report(request, options = nil)
             #   Pass arguments to `run_report` via a request object, either of type
             #   {::Google::Analytics::Data::V1beta::RunReportRequest} or an equivalent Hash.
@@ -208,8 +216,8 @@ module Google
             #     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. Dimensions cannot be used in this filter.
+            #     The filter clause of metrics. Applied after aggregating the report's rows,
+            #     similar to 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.
             #
@@ -749,9 +757,15 @@ module Google
             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.
+            # Returns a customized report of realtime event data for your property.
+            # Events appear in realtime reports seconds after they have been sent to
+            # the Google Analytics. Realtime reports show events and usage data for the
+            # periods of time ranging from the present moment to 30 minutes ago (up to
+            # 60 minutes for Google Analytics 360 properties).
+            #
+            # For a guide to constructing realtime requests & understanding responses,
+            # see [Creating a Realtime
+            # Report](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-basics).
             #
             # @overload run_realtime_report(request, options = nil)
             #   Pass arguments to `run_realtime_report` via a request object, either of type
@@ -780,12 +794,10 @@ module Google
             #   @param metrics [::Array<::Google::Analytics::Data::V1beta::Metric, ::Hash>]
             #     The metrics requested and displayed.
             #   @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.
+            #     The filter clause of dimensions. 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 limit [::Integer]
             #     The number of rows to return. If unspecified, 10,000 rows are returned. The
             #     API returns a maximum of 100,000 rows per request, no matter how many you

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

@@ -40,6 +40,10 @@ module Google
             # measurements of user activity on your property, such as active users or
             # event count. Dimensions break down metrics across some common criteria,
             # such as country or event name.
+            #
+            # For a guide to constructing requests & understanding responses, see
+            # [Creating a
+            # Report](https://developers.google.com/analytics/devguides/reporting/data/v1/basics).
             rpc :RunReport, ::Google::Analytics::Data::V1beta::RunReportRequest, ::Google::Analytics::Data::V1beta::RunReportResponse
             # Returns a customized pivot report of your Google Analytics event data.
             # Pivot reports are more advanced and expressive formats than regular
@@ -64,9 +68,15 @@ 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::V1beta::GetMetadataRequest, ::Google::Analytics::Data::V1beta::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.
+            # Returns a customized report of realtime event data for your property.
+            # Events appear in realtime reports seconds after they have been sent to
+            # the Google Analytics. Realtime reports show events and usage data for the
+            # periods of time ranging from the present moment to 30 minutes ago (up to
+            # 60 minutes for Google Analytics 360 properties).
+            #
+            # For a guide to constructing realtime requests & understanding responses,
+            # see [Creating a Realtime
+            # Report](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-basics).
             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

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

@@ -158,6 +158,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       proto3_optional :currency_code, :string, 5
       proto3_optional :time_zone, :string, 6
       proto3_optional :empty_reason, :string, 7
+      proto3_optional :subject_to_thresholding, :bool, 8
     end
     add_message "google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponse" do
       repeated :active_metric_restrictions, :message, 1, "google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponse.ActiveMetricRestriction"
@@ -206,6 +207,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :concurrent_requests, :message, 3, "google.analytics.data.v1beta.QuotaStatus"
       optional :server_errors_per_project_per_hour, :message, 4, "google.analytics.data.v1beta.QuotaStatus"
       optional :potentially_thresholded_requests_per_hour, :message, 5, "google.analytics.data.v1beta.QuotaStatus"
+      optional :tokens_per_project_per_hour, :message, 6, "google.analytics.data.v1beta.QuotaStatus"
     end
     add_message "google.analytics.data.v1beta.QuotaStatus" do
       optional :consumed, :int32, 1

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

@@ -21,7 +21,7 @@ module Google
   module Analytics
     module Data
       module V1beta
-        VERSION = "0.5.0"
+        VERSION = "0.6.0"
       end
     end
   end

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

@@ -122,8 +122,8 @@ module Google
         #     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. Dimensions cannot be used in this filter.
+        #     The filter clause of metrics. Applied after aggregating the report's rows,
+        #     similar to 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.
@@ -467,13 +467,11 @@ module Google
         #     The metrics requested and displayed.
         # @!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.
+        #     The filter clause of dimensions. 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] limit
         #   @return [::Integer]
         #     The number of rows to return. If unspecified, 10,000 rows are returned. The

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

@@ -56,8 +56,8 @@ module Google
         #
         #     If unspecified, `startMinutesAgo` is defaulted to 29. Standard Analytics
         #     properties can request up to the last 30 minutes of event data
-        #     (`startMinutesAgo <= 29`), and Google Analytics 360 properties can request
-        #     up to the last 60 minutes of event data (`startMinutesAgo <= 59`).
+        #     (`startMinutesAgo <= 29`), and 360 Analytics properties can request up to
+        #     the last 60 minutes of event data (`startMinutesAgo <= 59`).
         # @!attribute [rw] end_minutes_ago
         #   @return [::Integer]
         #     The inclusive end minute for the query as a number of minutes before now.
@@ -67,8 +67,8 @@ module Google
         #
         #     If unspecified, `endMinutesAgo` is defaulted to 0. Standard Analytics
         #     properties can request any minute in the last 30 minutes of event data
-        #     (`endMinutesAgo <= 29`), and Google Analytics 360 properties can request
-        #     any minute in the last 60 minutes of event data (`endMinutesAgo <= 59`).
+        #     (`endMinutesAgo <= 29`), and 360 Analytics properties can request any
+        #     minute in the last 60 minutes of event data (`endMinutesAgo <= 59`).
         # @!attribute [rw] name
         #   @return [::String]
         #     Assigns a name to this minute range. The dimension `dateRange` is valued to
@@ -82,7 +82,7 @@ module Google
 
         # 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".
+        # responses are strings; for example, the city could be "Paris" or "New York".
         # Requests are allowed up to 9 dimensions.
         # @!attribute [rw] name
         #   @return [::String]
@@ -186,9 +186,8 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # To express dimension or metric filters.
-        # The fields in the same FilterExpression need to be either all dimensions or
-        # all metrics.
+        # To express dimension or metric filters. The fields in the same
+        # FilterExpression need to be either all dimensions or all metrics.
         # @!attribute [rw] and_group
         #   @return [::Google::Analytics::Data::V1beta::FilterExpressionList]
         #     The FilterExpressions in and_group have an AND relationship.
@@ -200,9 +199,8 @@ module Google
         #     The FilterExpression is NOT of not_expression.
         # @!attribute [rw] filter
         #   @return [::Google::Analytics::Data::V1beta::Filter]
-        #     A primitive filter.
-        #     All fields in filter in same FilterExpression needs to be either all
-        #     dimensions or metrics.
+        #     A primitive filter. In the same FilterExpression, all of the filter's
+        #     field names need to be either all dimensions or all metrics.
         class FilterExpression
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -220,8 +218,12 @@ module Google
         # An expression to filter dimension or metric values.
         # @!attribute [rw] field_name
         #   @return [::String]
-        #     The dimension name or metric name. Must be a name defined in dimensions
-        #     or metrics.
+        #     The dimension name or metric name.
+        #
+        #     In most methods, dimensions & metrics can be used for the first time in
+        #     this field. However in a RunPivotReportRequest, this field must be
+        #     additionally specified by name in the RunPivotReportRequest's dimensions or
+        #     metrics.
         # @!attribute [rw] string_filter
         #   @return [::Google::Analytics::Data::V1beta::Filter::StringFilter]
         #     Strings related filter.
@@ -269,10 +271,10 @@ module Google
               # Contains the string value.
               CONTAINS = 4
 
-              # Full regular expression match with the string value.
+              # Full match for the regular expression with the string value.
               FULL_REGEXP = 5
 
-              # Partial regular expression match with the string value.
+              # Partial match for the regular expression with the string value.
               PARTIAL_REGEXP = 6
             end
           end
@@ -336,7 +338,9 @@ module Google
           end
         end
 
-        # The sort options.
+        # Order bys define how rows will be sorted in the response. For example,
+        # ordering rows by descending event count is one ordering, and ordering rows by
+        # the event name string is a different ordering.
         # @!attribute [rw] metric
         #   @return [::Google::Analytics::Data::V1beta::OrderBy::MetricOrderBy]
         #     Sorts results by a metric's values.
@@ -644,6 +648,16 @@ module Google
         # @!attribute [rw] empty_reason
         #   @return [::String]
         #     If empty reason is specified, the report is empty for this reason.
+        # @!attribute [rw] subject_to_thresholding
+        #   @return [::Boolean]
+        #     If `subjectToThresholding` is true, this report is subject to thresholding
+        #     and only returns data that meets the minimum aggregation thresholds. It is
+        #     possible for a request to be subject to thresholding thresholding and no
+        #     data is absent from the report, and this happens when all data is above the
+        #     thresholds. To learn more, see [Data
+        #     thresholds](https://support.google.com/analytics/answer/9383630) and [About
+        #     Demographics and
+        #     Interests](https://support.google.com/analytics/answer/2799357).
         class ResponseMetaData
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -817,8 +831,8 @@ module Google
         #   @return [::Google::Analytics::Data::V1beta::QuotaStatus]
         #     Standard Analytics Properties can use up to 5,000 tokens per hour;
         #     Analytics 360 Properties can use 50,000 tokens per hour. An API request
-        #     consumes a single number of tokens, and that number is deducted from both
-        #     the hourly and daily quotas.
+        #     consumes a single number of tokens, and that number is deducted from all of
+        #     the hourly, daily, and per project hourly quotas.
         # @!attribute [rw] concurrent_requests
         #   @return [::Google::Analytics::Data::V1beta::QuotaStatus]
         #     Standard Analytics Properties can send up to 10 concurrent requests;
@@ -834,6 +848,14 @@ module Google
         #     thresholded dimensions per hour. In a batch request, each report request
         #     is individually counted for this quota if the request contains potentially
         #     thresholded dimensions.
+        # @!attribute [rw] tokens_per_project_per_hour
+        #   @return [::Google::Analytics::Data::V1beta::QuotaStatus]
+        #     Analytics Properties can use up to 25% of their tokens per project per
+        #     hour. This amounts to standard Analytics Properties can use up to 1,250
+        #     tokens per project per hour, and Analytics 360 Properties can use 12,500
+        #     tokens per project per hour. An API request consumes a single number of
+        #     tokens, and that number is deducted from all of the hourly, daily, and per
+        #     project hourly quotas.
         class PropertyQuota
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-analytics-data-v1beta
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-01 00:00:00.000000000 Z
+date: 2022-10-18 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.10'
+        version: '0.12'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.12'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a