google-analytics-data-v1beta 0.13.1 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9fd7703e3b1e2f025cffe7f3a2bbcb0d579618caabca18b4d8a3e1db6bab1f9
-  data.tar.gz: b78a9d38b2c743a93a007fb372034c3095c581e5af8956f3acdce4e2347d63de
+  metadata.gz: 9ad671716cd7ce9e1da68e17b827923a556fac9d949ed2e2056926bafdc767ad
+  data.tar.gz: d64ed75c83d62ebdf0f1b0c61283ba60a1f8760d2dd4cd3fa41df28f23bffbc8
 SHA512:
-  metadata.gz: ce6faceb586228fb4d5225587e743d1780298c2f05618142ad8f50eb1c762cd5ef81549e362a570808efce775d880627d51543fe57ba24bbb785e4062ac439f4
-  data.tar.gz: e017fe80d12d35a0b639485e546fa5d46b5c8f4ee22e977d01b8e2a1391677f7c57f7bbf4aa0dbdd347f6a525167d11b06ff109fb86039b25076aa4b457e2230
+  metadata.gz: 87d4ea3da1da23b51e96a8b7d26154e1e63fad8c33b7b04e698f80ef56134ba013e08bb8ec0610d154cc9330bd372d5a83f95d9b43ada91b0369cb76529c8984
+  data.tar.gz: 4139e7a671417fa6c263474e6ce72ab14174979f0fce188e2fd79dce97e26fa3c95e3dc8f30e6aac3ac44ea9f8e41bbd798cdfd004ecec205e718e93e4767a86

data/README.md

@@ -43,33 +43,43 @@ for class and method documentation.
 See also the [Product Documentation](https://developers.google.com/analytics/devguides/reporting/data/v1)
 for general usage information.
 
-## Enabling Logging
-
-To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
-The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
-or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
-that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
-and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
-
-Configuring a Ruby stdlib logger:
+## Debug Logging
+
+This library comes with opt-in Debug Logging that can help you troubleshoot
+your application's integration with the API. When logging is activated, key
+events such as requests and responses, along with data payloads and metadata
+such as headers and client configuration, are logged to the standard error
+stream.
+
+**WARNING:** Client Library Debug Logging includes your data payloads in
+plaintext, which could include sensitive data such as PII for yourself or your
+customers, private keys, or other security data that could be compromising if
+leaked. Always practice good data hygiene with your application logs, and follow
+the principle of least access. Google also recommends that Client Library Debug
+Logging be enabled only temporarily during active debugging, and not used
+permanently in production.
+
+To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
+to the value `all`. Alternatively, you can set the value to a comma-delimited
+list of client library gem names. This will select the default logging behavior,
+which writes logs to the standard error stream. On a local workstation, this may
+result in logs appearing on the console. When running on a Google Cloud hosting
+service such as [Google Cloud Run](https://cloud.google.com/run), this generally
+results in logs appearing alongside your application logs in the
+[Google Cloud Logging](https://cloud.google.com/logging/) service.
+
+You can customize logging by modifying the `logger` configuration when
+constructing a client object. For example:
 
 ```ruby
+require "google/analytics/data/v1beta"
 require "logger"
 
-module MyLogger
-  LOGGER = Logger.new $stderr, level: Logger::WARN
-  def logger
-    LOGGER
-  end
-end
-
-# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
-module GRPC
-  extend MyLogger
+client = ::Google::Analytics::Data::V1beta::AnalyticsData::Client.new do |config|
+  config.logger = Logger.new "my-app.log"
 end
 ```
 
-
 ## Google Cloud Samples
 
 To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).

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

@@ -183,8 +183,19 @@ module Google
                 universe_domain: @config.universe_domain,
                 channel_args: @config.channel_args,
                 interceptors: @config.interceptors,
-                channel_pool_config: @config.channel_pool
+                channel_pool_config: @config.channel_pool,
+                logger: @config.logger
               )
+
+              @analytics_data_stub.stub_logger&.info do |entry|
+                entry.set_system_name
+                entry.set_service
+                entry.message = "Created client for #{entry.service}"
+                entry.set_credentials_fields credentials
+                entry.set "customEndpoint", @config.endpoint if @config.endpoint
+                entry.set "defaultTimeout", @config.timeout if @config.timeout
+                entry.set "quotaProject", @quota_project_id if @quota_project_id
+              end
             end
 
             ##
@@ -194,6 +205,15 @@ module Google
             #
             attr_reader :operations_client
 
+            ##
+            # The logger used for request/response debug logging.
+            #
+            # @return [Logger]
+            #
+            def logger
+              @analytics_data_stub.logger
+            end
+
             # Service calls
 
             ##
@@ -225,7 +245,7 @@ module Google
             #   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.
+            #     A Google Analytics 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).
@@ -277,8 +297,12 @@ module Google
             #   @param metric_aggregations [::Array<::Google::Analytics::Data::V1beta::MetricAggregation>]
             #     Aggregation of metrics. Aggregated metric values will be shown in rows
             #     where the dimension_values are set to "RESERVED_(MetricAggregation)".
+            #     Aggregates including both comparisons and multiple date ranges will
+            #     be aggregated based on the date ranges.
             #   @param order_bys [::Array<::Google::Analytics::Data::V1beta::OrderBy, ::Hash>]
             #     Specifies how rows are ordered in the response.
+            #     Requests including both comparisons and multiple date ranges will
+            #     have order bys applied on the comparisons.
             #   @param currency_code [::String]
             #     A currency code in ISO4217 format, such as "AED", "USD", "JPY".
             #     If the field is empty, the report uses the property's default currency.
@@ -291,14 +315,14 @@ module Google
             #     removed by a filter.
             #
             #     Regardless of this `keep_empty_rows` setting, only data recorded by the
-            #     Google Analytics (GA4) property can be displayed in a report.
+            #     Google Analytics property can be displayed in a report.
             #
             #     For example if a property never logs a `purchase` event, then a query for
             #     the `eventName` dimension and  `eventCount` metric will not have a row
             #     eventName: "purchase" and eventCount: 0.
             #   @param return_property_quota [::Boolean]
-            #     Toggles whether to return the current state of this Analytics Property's
-            #     quota. Quota is returned in [PropertyQuota](#PropertyQuota).
+            #     Toggles whether to return the current state of this Google Analytics
+            #     property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).
             #   @param comparisons [::Array<::Google::Analytics::Data::V1beta::Comparison, ::Hash>]
             #     Optional. The configuration of comparisons requested and displayed. The
             #     request only requires a comparisons field in order to receive a comparison
@@ -363,7 +387,6 @@ module Google
 
               @analytics_data_stub.call_rpc :run_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)
@@ -392,7 +415,7 @@ module Google
             #   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.
+            #     A Google Analytics 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).
@@ -437,14 +460,14 @@ module Google
             #     removed by a filter.
             #
             #     Regardless of this `keep_empty_rows` setting, only data recorded by the
-            #     Google Analytics (GA4) property can be displayed in a report.
+            #     Google Analytics property can be displayed in a report.
             #
             #     For example if a property never logs a `purchase` event, then a query for
             #     the `eventName` dimension and  `eventCount` metric will not have a row
             #     eventName: "purchase" and eventCount: 0.
             #   @param return_property_quota [::Boolean]
-            #     Toggles whether to return the current state of this Analytics Property's
-            #     quota. Quota is returned in [PropertyQuota](#PropertyQuota).
+            #     Toggles whether to return the current state of this Google Analytics
+            #     property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).
             #   @param comparisons [::Array<::Google::Analytics::Data::V1beta::Comparison, ::Hash>]
             #     Optional. The configuration of comparisons requested and displayed. The
             #     request requires both a comparisons field and a comparisons dimension to
@@ -509,7 +532,6 @@ module Google
 
               @analytics_data_stub.call_rpc :run_pivot_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)
@@ -517,7 +539,7 @@ module Google
 
             ##
             # Returns multiple reports in a batch. All reports must be for the same
-            # GA4 Property.
+            # Google Analytics property.
             #
             # @overload batch_run_reports(request, options = nil)
             #   Pass arguments to `batch_run_reports` via a request object, either of type
@@ -535,7 +557,7 @@ module Google
             #   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.
+            #     A Google Analytics 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).
@@ -607,7 +629,6 @@ module Google
 
               @analytics_data_stub.call_rpc :batch_run_reports, 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)
@@ -615,7 +636,7 @@ module Google
 
             ##
             # Returns multiple pivot reports in a batch. All reports must be for the same
-            # GA4 Property.
+            # Google Analytics property.
             #
             # @overload batch_run_pivot_reports(request, options = nil)
             #   Pass arguments to `batch_run_pivot_reports` via a request object, either of type
@@ -633,7 +654,7 @@ module Google
             #   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.
+            #     A Google Analytics 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).
@@ -705,7 +726,6 @@ module Google
 
               @analytics_data_stub.call_rpc :batch_run_pivot_reports, 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)
@@ -714,7 +734,7 @@ module Google
             ##
             # Returns metadata for dimensions and metrics available in reporting methods.
             # Used to explore the dimensions and metrics. In this method, a Google
-            # Analytics GA4 Property Identifier is specified in the request, and
+            # Analytics property identifier is specified in the request, and
             # the metadata response includes Custom dimensions and metrics as well as
             # Universal metadata.
             #
@@ -741,7 +761,7 @@ module Google
             #   @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
+            #     Google Analytics property identifier. To learn more, see [where to find
             #     your Property
             #     ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
             #
@@ -810,7 +830,6 @@ module Google
 
               @analytics_data_stub.call_rpc :get_metadata, 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)
@@ -843,7 +862,7 @@ module Google
             #   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.
+            #     A Google Analytics 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).
@@ -874,8 +893,9 @@ module Google
             #   @param order_bys [::Array<::Google::Analytics::Data::V1beta::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).
+            #     Toggles whether to return the current state of this Google Analytics
+            #     property's Realtime quota. Quota is returned in
+            #     [PropertyQuota](#PropertyQuota).
             #   @param minute_ranges [::Array<::Google::Analytics::Data::V1beta::MinuteRange, ::Hash>]
             #     The minute ranges of event data to read. If unspecified, one minute range
             #     for the last 30 minutes will be used. If multiple minute ranges are
@@ -942,7 +962,6 @@ module Google
 
               @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)
@@ -976,7 +995,7 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param property [::String]
-            #     A Google Analytics GA4 property identifier whose events are tracked. To
+            #     A Google Analytics property identifier whose events are tracked. To
             #     learn more, see [where to find your Property
             #     ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
             #     `property` should be the same value as in your `runReport` request.
@@ -1058,7 +1077,6 @@ module Google
 
               @analytics_data_stub.call_rpc :check_compatibility, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1179,7 +1197,7 @@ module Google
               @analytics_data_stub.call_rpc :create_audience_export, request, options: options do |response, operation|
                 response = ::Gapic::Operation.new response, @operations_client, options: options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1305,7 +1323,6 @@ module Google
 
               @analytics_data_stub.call_rpc :query_audience_export, 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)
@@ -1403,7 +1420,6 @@ module Google
 
               @analytics_data_stub.call_rpc :get_audience_export, 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)
@@ -1520,7 +1536,7 @@ module Google
               @analytics_data_stub.call_rpc :list_audience_exports, request, options: options do |response, operation|
                 response = ::Gapic::PagedEnumerable.new @analytics_data_stub, :list_audience_exports, request, response, operation, options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1609,6 +1625,11 @@ module Google
             #   default endpoint URL. The default value of nil uses the environment
             #   universe (usually the default "googleapis.com" universe).
             #   @return [::String,nil]
+            # @!attribute [rw] logger
+            #   A custom logger to use for request/response debug logging, or the value
+            #   `:default` (the default) to construct a default logger, or `nil` to
+            #   explicitly disable logging.
+            #   @return [::Logger,:default,nil]
             #
             class Configuration
               extend ::Gapic::Config
@@ -1633,6 +1654,7 @@ module Google
               config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
               config_attr :quota_project, nil, ::String, nil
               config_attr :universe_domain, nil, ::String, nil
+              config_attr :logger, :default, ::Logger, nil, :default
 
               # @private
               def initialize parent_config = nil

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

@@ -124,14 +124,6 @@ module Google
             # Lists operations that match the specified filter in the request. If the
             # server doesn't support this method, it returns `UNIMPLEMENTED`.
             #
-            # NOTE: the `name` binding allows API services to override the binding
-            # to use different resource name schemes, such as `users/*/operations`. To
-            # override the binding, API services can add a binding such as
-            # `"/v1/{name=users/*}/operations"` to their service configuration.
-            # For backwards compatibility, the default name includes the operations
-            # collection id, however overriding users must ensure the name binding
-            # is the parent resource, without the operations collection id.
-            #
             # @overload list_operations(request, options = nil)
             #   Pass arguments to `list_operations` via a request object, either of type
             #   {::Google::Longrunning::ListOperationsRequest} or an equivalent Hash.
@@ -221,7 +213,7 @@ module Google
                 wrap_lro_operation = ->(op_response) { ::Gapic::Operation.new op_response, @operations_client }
                 response = ::Gapic::PagedEnumerable.new @operations_stub, :list_operations, request, response, operation, options, format_resource: wrap_lro_operation
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -317,7 +309,7 @@ module Google
               @operations_stub.call_rpc :get_operation, request, options: options do |response, operation|
                 response = ::Gapic::Operation.new response, @operations_client, options: options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -406,7 +398,6 @@ module Google
 
               @operations_stub.call_rpc :delete_operation, 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)
@@ -421,8 +412,9 @@ module Google
             # other methods to check whether the cancellation succeeded or whether the
             # operation completed despite cancellation. On successful cancellation,
             # the operation is not deleted; instead, it becomes an operation with
-            # an {::Google::Longrunning::Operation#error Operation.error} value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1,
-            # corresponding to `Code.CANCELLED`.
+            # an {::Google::Longrunning::Operation#error Operation.error} value with a
+            # {::Google::Rpc::Status#code google.rpc.Status.code} of `1`, corresponding to
+            # `Code.CANCELLED`.
             #
             # @overload cancel_operation(request, options = nil)
             #   Pass arguments to `cancel_operation` via a request object, either of type
@@ -501,7 +493,6 @@ module Google
 
               @operations_stub.call_rpc :cancel_operation, 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)
@@ -599,7 +590,7 @@ module Google
               @operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
                 response = ::Gapic::Operation.new response, @operations_client, options: options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -688,6 +679,11 @@ module Google
             #   default endpoint URL. The default value of nil uses the environment
             #   universe (usually the default "googleapis.com" universe).
             #   @return [::String,nil]
+            # @!attribute [rw] logger
+            #   A custom logger to use for request/response debug logging, or the value
+            #   `:default` (the default) to construct a default logger, or `nil` to
+            #   explicitly disable logging.
+            #   @return [::Logger,:default,nil]
             #
             class Configuration
               extend ::Gapic::Config
@@ -712,6 +708,7 @@ module Google
               config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
               config_attr :quota_project, nil, ::String, nil
               config_attr :universe_domain, nil, ::String, nil
+              config_attr :logger, :default, ::Logger, nil, :default
 
               # @private
               def initialize parent_config = nil