google-ads-googleads 45.1.0 → 46.0.0

data/lib/google/ads/google_ads/v26/services/benchmarks_service/client.rb

@@ -0,0 +1,907 @@
+# frozen_string_literal: true
+
+# Copyright 2026 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+# require "google/ads/google_ads/error"
+require "google/ads/google_ads/v26/services/benchmarks_service_pb"
+
+module Google
+  module Ads
+    module GoogleAds
+      module V26
+        module Services
+          module BenchmarksService
+            ##
+            # Client for the BenchmarksService service.
+            #
+            # BenchmarksService helps users compare YouTube advertisement data against
+            # industry benchmarks. Accessible to allowlisted customers only.
+            #
+            class Client
+              # @private
+              API_VERSION = ""
+
+              # @private
+              DEFAULT_ENDPOINT_TEMPLATE = "googleads.$UNIVERSE_DOMAIN$"
+
+              # @private
+              attr_reader :benchmarks_service_stub
+
+              ##
+              # Configure the BenchmarksService Client class.
+              #
+              # See {::Google::Ads::GoogleAds::V26::Services::BenchmarksService::Client::Configuration}
+              # for a description of the configuration fields.
+              #
+              # @example
+              #
+              #   # Modify the configuration for all BenchmarksService clients
+              #   ::Google::Ads::GoogleAds::V26::Services::BenchmarksService::Client.configure do |config|
+              #     config.timeout = 10.0
+              #   end
+              #
+              # @yield [config] Configure the Client client.
+              # @yieldparam config [Client::Configuration]
+              #
+              # @return [Client::Configuration]
+              #
+              def self.configure
+                @configure ||= begin
+                  default_config = Client::Configuration.new
+
+                  default_config.timeout = 14_400.0
+                  default_config.retry_policy = {
+                    initial_delay: 5.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
+                  }
+
+                  default_config
+                end
+                yield @configure if block_given?
+                @configure
+              end
+
+              ##
+              # Configure the BenchmarksService Client instance.
+              #
+              # The configuration is set to the derived mode, meaning that values can be changed,
+              # but structural changes (adding new fields, etc.) are not allowed. Structural changes
+              # should be made on {Client.configure}.
+              #
+              # See {::Google::Ads::GoogleAds::V26::Services::BenchmarksService::Client::Configuration}
+              # for a description of the configuration fields.
+              #
+              # @yield [config] Configure the Client client.
+              # @yieldparam config [Client::Configuration]
+              #
+              # @return [Client::Configuration]
+              #
+              def configure
+                yield @config if block_given?
+                @config
+              end
+
+              ##
+              # The effective universe domain
+              #
+              # @return [String]
+              #
+              def universe_domain
+                @benchmarks_service_stub.universe_domain
+              end
+
+              ##
+              # Create a new BenchmarksService client object.
+              #
+              # @example
+              #
+              #   # Create a client using the default configuration
+              #   client = ::Google::Ads::GoogleAds::V26::Services::BenchmarksService::Client.new
+              #
+              #   # Create a client using a custom configuration
+              #   client = ::Google::Ads::GoogleAds::V26::Services::BenchmarksService::Client.new do |config|
+              #     config.timeout = 10.0
+              #   end
+              #
+              # @yield [config] Configure the BenchmarksService client.
+              # @yieldparam config [Client::Configuration]
+              #
+              def initialize
+                # These require statements are intentionally placed here to initialize
+                # the gRPC module only when it's required.
+                # See https://github.com/googleapis/toolkit/issues/446
+                require "gapic/grpc"
+                require "google/ads/google_ads/v26/services/benchmarks_service_services_pb"
+
+                # Create the configuration object
+                @config = Configuration.new Client.configure
+
+                # Yield the configuration if needed
+                yield @config if block_given?
+
+                # Create credentials
+                credentials = @config.credentials
+                # Use self-signed JWT if the endpoint is unchanged from default,
+                # but only if the default endpoint does not have a region prefix.
+                enable_self_signed_jwt = @config.endpoint.nil? ||
+                                         (@config.endpoint == Configuration::DEFAULT_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
+                @quota_project_id = @config.quota_project
+                @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
+
+                @benchmarks_service_stub = ::Gapic::ServiceStub.new(
+                  ::Google::Ads::GoogleAds::V26::Services::BenchmarksService::Stub,
+                  credentials: credentials,
+                  endpoint: @config.endpoint,
+                  endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
+                  universe_domain: @config.universe_domain,
+                  channel_args: @config.channel_args,
+                  interceptors: @config.interceptors,
+                  channel_pool_config: @config.channel_pool,
+                  logger: @config.logger
+                )
+
+                @benchmarks_service_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
+
+              ##
+              # The logger used for request/response debug logging.
+              #
+              # @return [Logger]
+              #
+              def logger
+                @benchmarks_service_stub.logger
+              end
+
+              # Service calls
+
+              ##
+              # Returns a date range that supports benchmarks.
+              #
+              # List of thrown errors:
+              #   [AuthenticationError]()
+              #   [AuthorizationError]()
+              #   [FieldError]()
+              #   [HeaderError]()
+              #   [InternalError]()
+              #   [QuotaError]()
+              #   [RequestError]()
+              #
+              # @overload list_benchmarks_available_dates(request, options = nil)
+              #   Pass arguments to `list_benchmarks_available_dates` via a request object, either of type
+              #   {::Google::Ads::GoogleAds::V26::Services::ListBenchmarksAvailableDatesRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Ads::GoogleAds::V26::Services::ListBenchmarksAvailableDatesRequest, ::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 list_benchmarks_available_dates(application_info: nil)
+              #   Pass arguments to `list_benchmarks_available_dates` 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 application_info [::Google::Ads::GoogleAds::V26::Common::AdditionalApplicationInfo, ::Hash]
+              #     Additional information on the application issuing the request.
+              #
+              # @yield [response, operation] Access the result along with the RPC operation
+              # @yieldparam response [::Google::Ads::GoogleAds::V26::Services::ListBenchmarksAvailableDatesResponse]
+              # @yieldparam operation [::GRPC::ActiveCall::Operation]
+              #
+              # @return [::Google::Ads::GoogleAds::V26::Services::ListBenchmarksAvailableDatesResponse]
+              #
+              # @raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.
+              #
+              # @example Basic example
+              #   require "google/ads/google_ads/v26/services"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Ads::GoogleAds::V26::Services::BenchmarksService::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Ads::GoogleAds::V26::Services::ListBenchmarksAvailableDatesRequest.new
+              #
+              #   # Call the list_benchmarks_available_dates method.
+              #   result = client.list_benchmarks_available_dates request
+              #
+              #   # The returned object is of type Google::Ads::GoogleAds::V26::Services::ListBenchmarksAvailableDatesResponse.
+              #   p result
+              #
+              def list_benchmarks_available_dates request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V26::Services::ListBenchmarksAvailableDatesRequest
+
+                # 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.list_benchmarks_available_dates.metadata.to_h
+
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+                metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Ads::GoogleAds::VERSION
+                metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+                metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.list_benchmarks_available_dates.timeout,
+                                       metadata:     metadata,
+                                       retry_policy: @config.rpcs.list_benchmarks_available_dates.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @benchmarks_service_stub.call_rpc :list_benchmarks_available_dates, request,
+                                                  options: options do |response, operation|
+                  yield response, operation if block_given?
+                end
+                # rescue GRPC::BadStatus => grpc_error
+                #  raise Google::Ads::GoogleAds::Error.new grpc_error.message
+              end
+
+              ##
+              # Returns the list of locations that support benchmarks (for example,
+              # countries).
+              #
+              # List of thrown errors:
+              #   [AuthenticationError]()
+              #   [AuthorizationError]()
+              #   [FieldError]()
+              #   [HeaderError]()
+              #   [InternalError]()
+              #   [QuotaError]()
+              #   [RequestError]()
+              #
+              # @overload list_benchmarks_locations(request, options = nil)
+              #   Pass arguments to `list_benchmarks_locations` via a request object, either of type
+              #   {::Google::Ads::GoogleAds::V26::Services::ListBenchmarksLocationsRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Ads::GoogleAds::V26::Services::ListBenchmarksLocationsRequest, ::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 list_benchmarks_locations(application_info: nil)
+              #   Pass arguments to `list_benchmarks_locations` 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 application_info [::Google::Ads::GoogleAds::V26::Common::AdditionalApplicationInfo, ::Hash]
+              #     Additional information on the application issuing the request.
+              #
+              # @yield [response, operation] Access the result along with the RPC operation
+              # @yieldparam response [::Google::Ads::GoogleAds::V26::Services::ListBenchmarksLocationsResponse]
+              # @yieldparam operation [::GRPC::ActiveCall::Operation]
+              #
+              # @return [::Google::Ads::GoogleAds::V26::Services::ListBenchmarksLocationsResponse]
+              #
+              # @raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.
+              #
+              # @example Basic example
+              #   require "google/ads/google_ads/v26/services"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Ads::GoogleAds::V26::Services::BenchmarksService::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Ads::GoogleAds::V26::Services::ListBenchmarksLocationsRequest.new
+              #
+              #   # Call the list_benchmarks_locations method.
+              #   result = client.list_benchmarks_locations request
+              #
+              #   # The returned object is of type Google::Ads::GoogleAds::V26::Services::ListBenchmarksLocationsResponse.
+              #   p result
+              #
+              def list_benchmarks_locations request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V26::Services::ListBenchmarksLocationsRequest
+
+                # 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.list_benchmarks_locations.metadata.to_h
+
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+                metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Ads::GoogleAds::VERSION
+                metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+                metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.list_benchmarks_locations.timeout,
+                                       metadata:     metadata,
+                                       retry_policy: @config.rpcs.list_benchmarks_locations.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @benchmarks_service_stub.call_rpc :list_benchmarks_locations, request,
+                                                  options: options do |response, operation|
+                  yield response, operation if block_given?
+                end
+                # rescue GRPC::BadStatus => grpc_error
+                #  raise Google::Ads::GoogleAds::Error.new grpc_error.message
+              end
+
+              ##
+              # Returns the list of products that supports benchmarks.
+              #
+              # List of thrown errors:
+              #   [AuthenticationError]()
+              #   [AuthorizationError]()
+              #   [FieldError]()
+              #   [HeaderError]()
+              #   [InternalError]()
+              #   [QuotaError]()
+              #   [RequestError]()
+              #
+              # @overload list_benchmarks_products(request, options = nil)
+              #   Pass arguments to `list_benchmarks_products` via a request object, either of type
+              #   {::Google::Ads::GoogleAds::V26::Services::ListBenchmarksProductsRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Ads::GoogleAds::V26::Services::ListBenchmarksProductsRequest, ::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 list_benchmarks_products(application_info: nil)
+              #   Pass arguments to `list_benchmarks_products` 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 application_info [::Google::Ads::GoogleAds::V26::Common::AdditionalApplicationInfo, ::Hash]
+              #     Additional information on the application issuing the request.
+              #
+              # @yield [response, operation] Access the result along with the RPC operation
+              # @yieldparam response [::Google::Ads::GoogleAds::V26::Services::ListBenchmarksProductsResponse]
+              # @yieldparam operation [::GRPC::ActiveCall::Operation]
+              #
+              # @return [::Google::Ads::GoogleAds::V26::Services::ListBenchmarksProductsResponse]
+              #
+              # @raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.
+              #
+              # @example Basic example
+              #   require "google/ads/google_ads/v26/services"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Ads::GoogleAds::V26::Services::BenchmarksService::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Ads::GoogleAds::V26::Services::ListBenchmarksProductsRequest.new
+              #
+              #   # Call the list_benchmarks_products method.
+              #   result = client.list_benchmarks_products request
+              #
+              #   # The returned object is of type Google::Ads::GoogleAds::V26::Services::ListBenchmarksProductsResponse.
+              #   p result
+              #
+              def list_benchmarks_products request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V26::Services::ListBenchmarksProductsRequest
+
+                # 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.list_benchmarks_products.metadata.to_h
+
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+                metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Ads::GoogleAds::VERSION
+                metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+                metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.list_benchmarks_products.timeout,
+                                       metadata:     metadata,
+                                       retry_policy: @config.rpcs.list_benchmarks_products.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @benchmarks_service_stub.call_rpc :list_benchmarks_products, request,
+                                                  options: options do |response, operation|
+                  yield response, operation if block_given?
+                end
+                # rescue GRPC::BadStatus => grpc_error
+                #  raise Google::Ads::GoogleAds::Error.new grpc_error.message
+              end
+
+              ##
+              # Returns the list of benchmarks sources (for example, Industry Verticals).
+              #
+              # List of thrown errors:
+              #   [AuthenticationError]()
+              #   [AuthorizationError]()
+              #   [FieldError]()
+              #   [HeaderError]()
+              #   [InternalError]()
+              #   [QuotaError]()
+              #   [RequestError]()
+              #
+              # @overload list_benchmarks_sources(request, options = nil)
+              #   Pass arguments to `list_benchmarks_sources` via a request object, either of type
+              #   {::Google::Ads::GoogleAds::V26::Services::ListBenchmarksSourcesRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Ads::GoogleAds::V26::Services::ListBenchmarksSourcesRequest, ::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 list_benchmarks_sources(benchmarks_sources: nil, application_info: nil)
+              #   Pass arguments to `list_benchmarks_sources` 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 benchmarks_sources [::Array<::Google::Ads::GoogleAds::V26::Enums::BenchmarksSourceTypeEnum::BenchmarksSourceType>]
+              #     Required. The types of benchmarks sources to be returned. Supported sources
+              #     include INDUSTRY_VERTICAL and CATEGORY. Categories are used as filters for
+              #     scoping the benchmarks analysis when benchmarking against all advertisers.
+              #   @param application_info [::Google::Ads::GoogleAds::V26::Common::AdditionalApplicationInfo, ::Hash]
+              #     Additional information on the application issuing the request.
+              #
+              # @yield [response, operation] Access the result along with the RPC operation
+              # @yieldparam response [::Google::Ads::GoogleAds::V26::Services::ListBenchmarksSourcesResponse]
+              # @yieldparam operation [::GRPC::ActiveCall::Operation]
+              #
+              # @return [::Google::Ads::GoogleAds::V26::Services::ListBenchmarksSourcesResponse]
+              #
+              # @raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.
+              #
+              # @example Basic example
+              #   require "google/ads/google_ads/v26/services"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Ads::GoogleAds::V26::Services::BenchmarksService::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Ads::GoogleAds::V26::Services::ListBenchmarksSourcesRequest.new
+              #
+              #   # Call the list_benchmarks_sources method.
+              #   result = client.list_benchmarks_sources request
+              #
+              #   # The returned object is of type Google::Ads::GoogleAds::V26::Services::ListBenchmarksSourcesResponse.
+              #   p result
+              #
+              def list_benchmarks_sources request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V26::Services::ListBenchmarksSourcesRequest
+
+                # 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.list_benchmarks_sources.metadata.to_h
+
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+                metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Ads::GoogleAds::VERSION
+                metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+                metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.list_benchmarks_sources.timeout,
+                                       metadata:     metadata,
+                                       retry_policy: @config.rpcs.list_benchmarks_sources.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @benchmarks_service_stub.call_rpc :list_benchmarks_sources, request,
+                                                  options: options do |response, operation|
+                  yield response, operation if block_given?
+                end
+                # rescue GRPC::BadStatus => grpc_error
+                #  raise Google::Ads::GoogleAds::Error.new grpc_error.message
+              end
+
+              ##
+              # Returns YouTube advertisement metrics for the given client against industry
+              # benchmarks.
+              #
+              # List of thrown errors:
+              #   [AuthenticationError]()
+              #   [AuthorizationError]()
+              #   [BenchmarksError]()
+              #   [FieldError]()
+              #   [HeaderError]()
+              #   [InternalError]()
+              #   [QuotaError]()
+              #   [RangeError]()
+              #   [RequestError]()
+              #
+              # @overload generate_benchmarks_metrics(request, options = nil)
+              #   Pass arguments to `generate_benchmarks_metrics` via a request object, either of type
+              #   {::Google::Ads::GoogleAds::V26::Services::GenerateBenchmarksMetricsRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Ads::GoogleAds::V26::Services::GenerateBenchmarksMetricsRequest, ::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 generate_benchmarks_metrics(customer_id: nil, date_range: nil, location: nil, benchmarks_source: nil, category_filter: nil, product_filter: nil, breakdown_definition: nil, currency_code: nil, customer_benchmarks_group: nil, supplemental_data: nil, application_info: nil)
+              #   Pass arguments to `generate_benchmarks_metrics` 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 customer_id [::String]
+              #     Required. The ID of the customer. Supply a client customer ID to generate
+              #     metrics for the customer. A manager account customer ID will not return
+              #     customer metrics since it does not have any associated direct ad campaigns.
+              #   @param date_range [::Google::Ads::GoogleAds::V26::Common::DateRange, ::Hash]
+              #     The date range to aggregate metrics over. If unset, data will be returned
+              #     for the most recent quarter for which data is available. Dates can be
+              #     retrieved using
+              #     {::Google::Ads::GoogleAds::V26::Services::BenchmarksService::Client#list_benchmarks_available_dates BenchmarksService.ListBenchmarksAvailableDates}.
+              #   @param location [::Google::Ads::GoogleAds::V26::Common::LocationInfo, ::Hash]
+              #     Required. The location to generate benchmarks metrics for.
+              #   @param benchmarks_source [::Google::Ads::GoogleAds::V26::Services::BenchmarksSource, ::Hash]
+              #     Required. The source used to generate benchmarks metrics for.
+              #   @param category_filter [::Google::Ads::GoogleAds::V26::Services::CategoryFilter, ::Hash]
+              #     A list of Product & Service Categories for scoping a YouTube benchmarks
+              #     analysis. For example, when category "/Apparel/Clothing" is selected,
+              #     customer metrics represent Ad performance for "/Apparel/Clothing" Ads only
+              #     and the customer is benchmarking against all advertisers’ Ads in the
+              #     "/Apparel/Clothing" category.
+              #
+              #     This filter can only be used when `all_advertisers` is used as the
+              #     {::Google::Ads::GoogleAds::V26::Services::GenerateBenchmarksMetricsRequest#benchmarks_source benchmarks_source}.
+              #   @param product_filter [::Google::Ads::GoogleAds::V26::Services::ProductFilter, ::Hash]
+              #     Required. The products to aggregate metrics over. Product filter settings
+              #     support a list of product IDs or a list of marketing objectives.
+              #   @param breakdown_definition [::Google::Ads::GoogleAds::V26::Services::BreakdownDefinition, ::Hash]
+              #     Optional. The set of dimensions to group metrics by. If multiple dimensions
+              #     are selected, cross-dimension breakdowns are returned.
+              #   @param currency_code [::String]
+              #     Optional. The three-character ISO 4217 currency code. If unspecified, the
+              #     default currency for monetary values is USD.
+              #   @param customer_benchmarks_group [::String]
+              #     The name of the customer being planned for. This is a user-defined value.
+              #   @param supplemental_data [::Array<::Google::Ads::GoogleAds::V26::Enums::BenchmarksSupplementalDataEnum::BenchmarksSupplementalData>]
+              #     Optional. Optional features to include in the response. By default, only
+              #     core data is returned. Including supplemental data here will populate
+              #     additional metrics in the response such as percentile metrics.
+              #   @param application_info [::Google::Ads::GoogleAds::V26::Common::AdditionalApplicationInfo, ::Hash]
+              #     Additional information on the application issuing the request.
+              #
+              # @yield [response, operation] Access the result along with the RPC operation
+              # @yieldparam response [::Google::Ads::GoogleAds::V26::Services::GenerateBenchmarksMetricsResponse]
+              # @yieldparam operation [::GRPC::ActiveCall::Operation]
+              #
+              # @return [::Google::Ads::GoogleAds::V26::Services::GenerateBenchmarksMetricsResponse]
+              #
+              # @raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.
+              #
+              # @example Basic example
+              #   require "google/ads/google_ads/v26/services"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Ads::GoogleAds::V26::Services::BenchmarksService::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Ads::GoogleAds::V26::Services::GenerateBenchmarksMetricsRequest.new
+              #
+              #   # Call the generate_benchmarks_metrics method.
+              #   result = client.generate_benchmarks_metrics request
+              #
+              #   # The returned object is of type Google::Ads::GoogleAds::V26::Services::GenerateBenchmarksMetricsResponse.
+              #   p result
+              #
+              def generate_benchmarks_metrics request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V26::Services::GenerateBenchmarksMetricsRequest
+
+                # 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.generate_benchmarks_metrics.metadata.to_h
+
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+                metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Ads::GoogleAds::VERSION
+                metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+                metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                header_params = {}
+                if request.customer_id
+                  header_params["customer_id"] = request.customer_id
+                end
+
+                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.generate_benchmarks_metrics.timeout,
+                                       metadata:     metadata,
+                                       retry_policy: @config.rpcs.generate_benchmarks_metrics.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @benchmarks_service_stub.call_rpc :generate_benchmarks_metrics, request,
+                                                  options: options do |response, operation|
+                  yield response, operation if block_given?
+                end
+                # rescue GRPC::BadStatus => grpc_error
+                #  raise Google::Ads::GoogleAds::Error.new grpc_error.message
+              end
+
+              ##
+              # Configuration class for the BenchmarksService API.
+              #
+              # This class represents the configuration for BenchmarksService,
+              # providing control over timeouts, retry behavior, logging, transport
+              # parameters, and other low-level controls. Certain parameters can also be
+              # applied individually to specific RPCs. See
+              # {::Google::Ads::GoogleAds::V26::Services::BenchmarksService::Client::Configuration::Rpcs}
+              # for a list of RPCs that can be configured independently.
+              #
+              # Configuration can be applied globally to all clients, or to a single client
+              # on construction.
+              #
+              # @example
+              #
+              #   # Modify the global config, setting the timeout for
+              #   # list_benchmarks_available_dates to 20 seconds,
+              #   # and all remaining timeouts to 10 seconds.
+              #   ::Google::Ads::GoogleAds::V26::Services::BenchmarksService::Client.configure do |config|
+              #     config.timeout = 10.0
+              #     config.rpcs.list_benchmarks_available_dates.timeout = 20.0
+              #   end
+              #
+              #   # Apply the above configuration only to a new client.
+              #   client = ::Google::Ads::GoogleAds::V26::Services::BenchmarksService::Client.new do |config|
+              #     config.timeout = 10.0
+              #     config.rpcs.list_benchmarks_available_dates.timeout = 20.0
+              #   end
+              #
+              # @!attribute [rw] endpoint
+              #   A custom service endpoint, as a hostname or hostname:port. The default is
+              #   nil, indicating to use the default endpoint in the current universe domain.
+              #   @return [::String,nil]
+              # @!attribute [rw] credentials
+              #   Credentials to send with calls. You may provide any of the following types:
+              #    *  (`Google::Auth::Credentials`) A googleauth credentials object
+              #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
+              #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
+              #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
+              #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
+              #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
+              #    *  (`nil`) indicating no credentials
+              #
+              #   @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
+              #     is deprecated. Providing an unvalidated credential configuration to
+              #     Google APIs can compromise the security of your systems and data.
+              #
+              #   @example
+              #
+              #     # The recommended way to provide credentials is to use the `make_creds` method
+              #     # on the appropriate credentials class for your environment.
+              #
+              #     require "googleauth"
+              #
+              #     credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
+              #       json_key_io: ::File.open("/path/to/keyfile.json")
+              #     )
+              #
+              #     client = ::Google::Ads::GoogleAds::V26::Services::BenchmarksService::Client.new do |config|
+              #       config.credentials = credentials
+              #     end
+              #
+              #   @note Warning: If you accept a credential configuration (JSON file or Hash) from an
+              #   external source for authentication to Google Cloud, you must validate it before
+              #   providing it to a Google API client library. Providing an unvalidated credential
+              #   configuration to Google APIs can compromise the security of your systems and data.
+              #   For more information, refer to [Validate credential configurations from external
+              #   sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
+              #   @return [::Object]
+              # @!attribute [rw] scope
+              #   The OAuth scopes
+              #   @return [::Array<::String>]
+              # @!attribute [rw] lib_name
+              #   The library name as recorded in instrumentation and logging
+              #   @return [::String]
+              # @!attribute [rw] lib_version
+              #   The library version as recorded in instrumentation and logging
+              #   @return [::String]
+              # @!attribute [rw] channel_args
+              #   Extra parameters passed to the gRPC channel. Note: this is ignored if a
+              #   `GRPC::Core::Channel` object is provided as the credential.
+              #   @return [::Hash]
+              # @!attribute [rw] interceptors
+              #   An array of interceptors that are run before calls are executed.
+              #   @return [::Array<::GRPC::ClientInterceptor>]
+              # @!attribute [rw] timeout
+              #   The call timeout in seconds.
+              #   @return [::Numeric]
+              # @!attribute [rw] metadata
+              #   Additional gRPC headers to be sent with the call.
+              #   @return [::Hash{::Symbol=>::String}]
+              # @!attribute [rw] retry_policy
+              #   The retry policy. The value is a hash with the following keys:
+              #    *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
+              #    *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
+              #    *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+              #    *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
+              #    *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
+              #       trigger a retry.
+              #   @return [::Hash]
+              # @!attribute [rw] quota_project
+              #   A separate project against which to charge quota.
+              #   @return [::String]
+              # @!attribute [rw] universe_domain
+              #   The universe domain within which to make requests. This determines the
+              #   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
+
+                # @private
+                # The endpoint specific to the default "googleapis.com" universe. Deprecated.
+                DEFAULT_ENDPOINT = "googleads.googleapis.com"
+
+                config_attr :endpoint,      nil, ::String, nil
+                config_attr :credentials,   nil do |value|
+                  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials,
+                             ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
+                  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC::Core::Channel
+                  allowed.any? { |klass| klass === value }
+                end
+                config_attr :scope,         nil, ::String, ::Array, nil
+                config_attr :lib_name,      nil, ::String, nil
+                config_attr :lib_version,   nil, ::String, nil
+                config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
+                config_attr :interceptors,  nil, ::Array, nil
+                config_attr :timeout,       nil, ::Numeric, nil
+                config_attr :metadata,      nil, ::Hash, nil
+                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
+                  @parent_config = parent_config unless parent_config.nil?
+
+                  yield self if block_given?
+                end
+
+                ##
+                # Configurations for individual RPCs
+                # @return [Rpcs]
+                #
+                def rpcs
+                  @rpcs ||= begin
+                    parent_rpcs = nil
+                    parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
+                    Rpcs.new parent_rpcs
+                  end
+                end
+
+                ##
+                # Configuration for the channel pool
+                # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
+                #
+                def channel_pool
+                  @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
+                end
+
+                ##
+                # Configuration RPC class for the BenchmarksService API.
+                #
+                # Includes fields providing the configuration for each RPC in this service.
+                # Each configuration object is of type `Gapic::Config::Method` and includes
+                # the following configuration fields:
+                #
+                #  *  `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:
+                #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
+                #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
+                #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+                #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
+                #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
+                #         trigger a retry.
+                #
+                class Rpcs
+                  ##
+                  # RPC-specific configuration for `list_benchmarks_available_dates`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :list_benchmarks_available_dates
+                  ##
+                  # RPC-specific configuration for `list_benchmarks_locations`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :list_benchmarks_locations
+                  ##
+                  # RPC-specific configuration for `list_benchmarks_products`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :list_benchmarks_products
+                  ##
+                  # RPC-specific configuration for `list_benchmarks_sources`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :list_benchmarks_sources
+                  ##
+                  # RPC-specific configuration for `generate_benchmarks_metrics`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :generate_benchmarks_metrics
+
+                  # @private
+                  def initialize parent_rpcs = nil
+                    list_benchmarks_available_dates_config = parent_rpcs.list_benchmarks_available_dates if parent_rpcs.respond_to? :list_benchmarks_available_dates
+                    @list_benchmarks_available_dates = ::Gapic::Config::Method.new list_benchmarks_available_dates_config
+                    list_benchmarks_locations_config = parent_rpcs.list_benchmarks_locations if parent_rpcs.respond_to? :list_benchmarks_locations
+                    @list_benchmarks_locations = ::Gapic::Config::Method.new list_benchmarks_locations_config
+                    list_benchmarks_products_config = parent_rpcs.list_benchmarks_products if parent_rpcs.respond_to? :list_benchmarks_products
+                    @list_benchmarks_products = ::Gapic::Config::Method.new list_benchmarks_products_config
+                    list_benchmarks_sources_config = parent_rpcs.list_benchmarks_sources if parent_rpcs.respond_to? :list_benchmarks_sources
+                    @list_benchmarks_sources = ::Gapic::Config::Method.new list_benchmarks_sources_config
+                    generate_benchmarks_metrics_config = parent_rpcs.generate_benchmarks_metrics if parent_rpcs.respond_to? :generate_benchmarks_metrics
+                    @generate_benchmarks_metrics = ::Gapic::Config::Method.new generate_benchmarks_metrics_config
+
+                    yield self if block_given?
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end