google-analytics-data-v1beta 0.13.1 → 0.15.0

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

@@ -176,8 +176,19 @@ module Google
                   endpoint: @config.endpoint,
                   endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
                   universe_domain: @config.universe_domain,
-                  credentials: credentials
+                  credentials: credentials,
+                  logger: @config.logger
                 )
+
+                @analytics_data_stub.logger(stub: true)&.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
 
               ##
@@ -187,6 +198,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
 
               ##
@@ -218,7 +238,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).
@@ -270,8 +290,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.
@@ -284,14 +308,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
@@ -349,7 +373,6 @@ module Google
 
                 @analytics_data_stub.run_report request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -378,7 +401,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).
@@ -423,14 +446,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
@@ -488,7 +511,6 @@ module Google
 
                 @analytics_data_stub.run_pivot_report request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -496,7 +518,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
@@ -514,7 +536,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).
@@ -579,7 +601,6 @@ module Google
 
                 @analytics_data_stub.batch_run_reports request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -587,7 +608,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
@@ -605,7 +626,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).
@@ -670,7 +691,6 @@ module Google
 
                 @analytics_data_stub.batch_run_pivot_reports request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -679,7 +699,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.
               #
@@ -706,7 +726,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).
               #
@@ -768,7 +788,6 @@ module Google
 
                 @analytics_data_stub.get_metadata request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -801,7 +820,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).
@@ -832,8 +851,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
@@ -893,7 +913,6 @@ module Google
 
                 @analytics_data_stub.run_realtime_report request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -927,7 +946,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.
@@ -1002,7 +1021,6 @@ module Google
 
                 @analytics_data_stub.check_compatibility request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -1116,7 +1134,7 @@ module Google
                 @analytics_data_stub.create_audience_export request, options do |result, operation|
                   result = ::Gapic::Operation.new result, @operations_client, options: options
                   yield result, operation if block_given?
-                  return result
+                  throw :response, result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -1235,7 +1253,6 @@ module Google
 
                 @analytics_data_stub.query_audience_export request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -1326,7 +1343,6 @@ module Google
 
                 @analytics_data_stub.get_audience_export request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -1436,7 +1452,7 @@ module Google
                 @analytics_data_stub.list_audience_exports request, options do |result, operation|
                   result = ::Gapic::Rest::PagedEnumerable.new @analytics_data_stub, :list_audience_exports, "audience_exports", request, result, options
                   yield result, operation if block_given?
-                  return result
+                  throw :response, result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -1516,6 +1532,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
@@ -1537,6 +1558,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/rest/operations.rb

@@ -115,14 +115,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.
@@ -204,7 +196,7 @@ module Google
                 @operations_stub.list_operations request, options do |result, operation|
                   result = ::Gapic::Rest::PagedEnumerable.new @operations_stub, :list_operations, "operations", request, result, options
                   yield result, operation if block_given?
-                  return result
+                  throw :response, result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -293,7 +285,7 @@ module Google
                 @operations_stub.get_operation request, options do |result, operation|
                   result = ::Gapic::Operation.new result, @operations_client, options: options
                   yield result, operation if block_given?
-                  return result
+                  throw :response, result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -375,7 +367,6 @@ module Google
 
                 @operations_stub.delete_operation request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -390,8 +381,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
@@ -463,7 +455,6 @@ module Google
 
                 @operations_stub.cancel_operation request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -543,6 +534,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
@@ -564,6 +560,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
@@ -683,16 +680,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "list_operations",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Longrunning::ListOperationsResponse.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -721,16 +720,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "get_operation",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -759,16 +760,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "delete_operation",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -797,16 +800,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "cancel_operation",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##