# frozen_string_literal: true # Copyright 2024 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/v16/services/experiment_service_pb" module Google module Ads module GoogleAds module V16 module Services module ExperimentService ## # Client for the ExperimentService service. # # Service to manage experiments. # class Client # @private DEFAULT_ENDPOINT_TEMPLATE = "googleads.$UNIVERSE_DOMAIN$" include Paths # @private attr_reader :experiment_service_stub ## # Configure the ExperimentService Client class. # # See {::Google::Ads::GoogleAds::V16::Services::ExperimentService::Client::Configuration} # for a description of the configuration fields. # # @example # # # Modify the configuration for all ExperimentService clients # ::Google::Ads::GoogleAds::V16::Services::ExperimentService::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 ExperimentService 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::V16::Services::ExperimentService::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 @experiment_service_stub.universe_domain end ## # Create a new ExperimentService client object. # # @example # # # Create a client using the default configuration # client = ::Google::Ads::GoogleAds::V16::Services::ExperimentService::Client.new # # # Create a client using a custom configuration # client = ::Google::Ads::GoogleAds::V16::Services::ExperimentService::Client.new do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the ExperimentService 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/v16/services/experiment_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 @operations_client = Operations.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint config.universe_domain = @config.universe_domain end @experiment_service_stub = ::Gapic::ServiceStub.new( ::Google::Ads::GoogleAds::V16::Services::ExperimentService::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 ) end ## # Get the associated client for long-running operations. # # @return [::Google::Ads::GoogleAds::V16::Services::ExperimentService::Operations] # attr_reader :operations_client # Service calls ## # Creates, updates, or removes experiments. Operation statuses are returned. # # List of thrown errors: # [AuthenticationError]() # [AuthorizationError]() # [ExperimentError]() # [HeaderError]() # [InternalError]() # [QuotaError]() # [RequestError]() # # @overload mutate_experiments(request, options = nil) # Pass arguments to `mutate_experiments` via a request object, either of type # {::Google::Ads::GoogleAds::V16::Services::MutateExperimentsRequest} or an equivalent Hash. # # @param request [::Google::Ads::GoogleAds::V16::Services::MutateExperimentsRequest, ::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 mutate_experiments(customer_id: nil, operations: nil, partial_failure: nil, validate_only: nil) # Pass arguments to `mutate_experiments` 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 whose experiments are being modified. # @param operations [::Array<::Google::Ads::GoogleAds::V16::Services::ExperimentOperation, ::Hash>] # Required. The list of operations to perform on individual experiments. # @param partial_failure [::Boolean] # If true, successful operations will be carried out and invalid # operations will return errors. If false, all operations will be carried # out in one transaction if and only if they are all valid. # Default is false. # @param validate_only [::Boolean] # If true, the request is validated but not executed. Only errors are # returned, not results. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Ads::GoogleAds::V16::Services::MutateExperimentsResponse] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Ads::GoogleAds::V16::Services::MutateExperimentsResponse] # # @raise [Google::Ads::GoogleAds::Error] if the RPC is aborted. # # @example Basic example # require "google/ads/google_ads/v16/services" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Ads::GoogleAds::V16::Services::ExperimentService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Ads::GoogleAds::V16::Services::MutateExperimentsRequest.new # # # Call the mutate_experiments method. # result = client.mutate_experiments request # # # The returned object is of type Google::Ads::GoogleAds::V16::Services::MutateExperimentsResponse. # p result # def mutate_experiments request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V16::Services::MutateExperimentsRequest # 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.mutate_experiments.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Ads::GoogleAds::VERSION 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.mutate_experiments.timeout, metadata: metadata, retry_policy: @config.rpcs.mutate_experiments.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @experiment_service_stub.call_rpc :mutate_experiments, request, options: options do |response, operation| yield response, operation if block_given? return response end # rescue GRPC::BadStatus => grpc_error # raise Google::Ads::GoogleAds::Error.new grpc_error.message end ## # Immediately ends an experiment, changing the experiment's scheduled # end date and without waiting for end of day. End date is updated to be the # time of the request. # # List of thrown errors: # [AuthenticationError]() # [AuthorizationError]() # [ExperimentError]() # [HeaderError]() # [InternalError]() # [QuotaError]() # [RequestError]() # # @overload end_experiment(request, options = nil) # Pass arguments to `end_experiment` via a request object, either of type # {::Google::Ads::GoogleAds::V16::Services::EndExperimentRequest} or an equivalent Hash. # # @param request [::Google::Ads::GoogleAds::V16::Services::EndExperimentRequest, ::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 end_experiment(experiment: nil, validate_only: nil) # Pass arguments to `end_experiment` 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 experiment [::String] # Required. The resource name of the campaign experiment to end. # @param validate_only [::Boolean] # If true, the request is validated but not executed. Only errors are # returned, not results. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Protobuf::Empty] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Protobuf::Empty] # # @raise [Google::Ads::GoogleAds::Error] if the RPC is aborted. # # @example Basic example # require "google/ads/google_ads/v16/services" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Ads::GoogleAds::V16::Services::ExperimentService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Ads::GoogleAds::V16::Services::EndExperimentRequest.new # # # Call the end_experiment method. # result = client.end_experiment request # # # The returned object is of type Google::Protobuf::Empty. # p result # def end_experiment request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V16::Services::EndExperimentRequest # 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.end_experiment.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Ads::GoogleAds::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.experiment header_params["experiment"] = request.experiment 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.end_experiment.timeout, metadata: metadata, retry_policy: @config.rpcs.end_experiment.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @experiment_service_stub.call_rpc :end_experiment, request, options: options do |response, operation| yield response, operation if block_given? return response end # rescue GRPC::BadStatus => grpc_error # raise Google::Ads::GoogleAds::Error.new grpc_error.message end ## # Returns all errors that occurred during the last Experiment update (either # scheduling or promotion). # Supports standard list paging. # # List of thrown errors: # [AuthenticationError]() # [AuthorizationError]() # [HeaderError]() # [InternalError]() # [QuotaError]() # [RequestError]() # # @overload list_experiment_async_errors(request, options = nil) # Pass arguments to `list_experiment_async_errors` via a request object, either of type # {::Google::Ads::GoogleAds::V16::Services::ListExperimentAsyncErrorsRequest} or an equivalent Hash. # # @param request [::Google::Ads::GoogleAds::V16::Services::ListExperimentAsyncErrorsRequest, ::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_experiment_async_errors(resource_name: nil, page_token: nil, page_size: nil) # Pass arguments to `list_experiment_async_errors` 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 resource_name [::String] # Required. The name of the experiment from which to retrieve the async # errors. # @param page_token [::String] # Token of the page to retrieve. If not specified, the first # page of results will be returned. Use the value obtained from # `next_page_token` in the previous response in order to request # the next page of results. # @param page_size [::Integer] # Number of elements to retrieve in a single page. # When a page request is too large, the server may decide to # further limit the number of returned resources. # The maximum page size is 1000. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::PagedEnumerable<::Google::Rpc::Status>] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::PagedEnumerable<::Google::Rpc::Status>] # # @raise [Google::Ads::GoogleAds::Error] if the RPC is aborted. # # @example Basic example # require "google/ads/google_ads/v16/services" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Ads::GoogleAds::V16::Services::ExperimentService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Ads::GoogleAds::V16::Services::ListExperimentAsyncErrorsRequest.new # # # Call the list_experiment_async_errors method. # result = client.list_experiment_async_errors request # # # The returned object is of type Gapic::PagedEnumerable. You can iterate # # over elements, and API calls will be issued to fetch pages as needed. # result.each do |item| # # Each element is of type ::Google::Rpc::Status. # p item # end # def list_experiment_async_errors request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V16::Services::ListExperimentAsyncErrorsRequest # 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_experiment_async_errors.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Ads::GoogleAds::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.resource_name header_params["resource_name"] = request.resource_name 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.list_experiment_async_errors.timeout, metadata: metadata, retry_policy: @config.rpcs.list_experiment_async_errors.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @experiment_service_stub.call_rpc :list_experiment_async_errors, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @experiment_service_stub, :list_experiment_async_errors, request, response, operation, options yield response, operation if block_given? return response end # rescue GRPC::BadStatus => grpc_error # raise Google::Ads::GoogleAds::Error.new grpc_error.message end ## # Graduates an experiment to a full campaign. # # List of thrown errors: # [AuthenticationError]() # [AuthorizationError]() # [ExperimentError]() # [HeaderError]() # [InternalError]() # [MutateError]() # [QuotaError]() # [RequestError]() # # @overload graduate_experiment(request, options = nil) # Pass arguments to `graduate_experiment` via a request object, either of type # {::Google::Ads::GoogleAds::V16::Services::GraduateExperimentRequest} or an equivalent Hash. # # @param request [::Google::Ads::GoogleAds::V16::Services::GraduateExperimentRequest, ::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 graduate_experiment(experiment: nil, campaign_budget_mappings: nil, validate_only: nil) # Pass arguments to `graduate_experiment` 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 experiment [::String] # Required. The experiment to be graduated. # @param campaign_budget_mappings [::Array<::Google::Ads::GoogleAds::V16::Services::CampaignBudgetMapping, ::Hash>] # Required. List of campaign budget mappings for graduation. Each campaign # that appears here will graduate, and will be assigned a new budget that is # paired with it in the mapping. The maximum size is one. # @param validate_only [::Boolean] # If true, the request is validated but not executed. Only errors are # returned, not results. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Protobuf::Empty] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Protobuf::Empty] # # @raise [Google::Ads::GoogleAds::Error] if the RPC is aborted. # # @example Basic example # require "google/ads/google_ads/v16/services" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Ads::GoogleAds::V16::Services::ExperimentService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Ads::GoogleAds::V16::Services::GraduateExperimentRequest.new # # # Call the graduate_experiment method. # result = client.graduate_experiment request # # # The returned object is of type Google::Protobuf::Empty. # p result # def graduate_experiment request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V16::Services::GraduateExperimentRequest # 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.graduate_experiment.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Ads::GoogleAds::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.experiment header_params["experiment"] = request.experiment 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.graduate_experiment.timeout, metadata: metadata, retry_policy: @config.rpcs.graduate_experiment.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @experiment_service_stub.call_rpc :graduate_experiment, request, options: options do |response, operation| yield response, operation if block_given? return response end # rescue GRPC::BadStatus => grpc_error # raise Google::Ads::GoogleAds::Error.new grpc_error.message end ## # Schedule an experiment. The in design campaign # will be converted into a real campaign (called the experiment campaign) # that will begin serving ads if successfully created. # # The experiment is scheduled immediately with status INITIALIZING. # This method returns a long running operation that tracks the forking of the # in design campaign. If the forking fails, a list of errors can be retrieved # using the ListExperimentAsyncErrors method. The operation's # metadata will be a string containing the resource name of the created # experiment. # # List of thrown errors: # [AuthenticationError]() # [AuthorizationError]() # [ExperimentError]() # [DatabaseError]() # [DateError]() # [DateRangeError]() # [FieldError]() # [HeaderError]() # [InternalError]() # [QuotaError]() # [RangeError]() # [RequestError]() # # @overload schedule_experiment(request, options = nil) # Pass arguments to `schedule_experiment` via a request object, either of type # {::Google::Ads::GoogleAds::V16::Services::ScheduleExperimentRequest} or an equivalent Hash. # # @param request [::Google::Ads::GoogleAds::V16::Services::ScheduleExperimentRequest, ::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 schedule_experiment(resource_name: nil, validate_only: nil) # Pass arguments to `schedule_experiment` 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 resource_name [::String] # Required. The scheduled experiment. # @param validate_only [::Boolean] # If true, the request is validated but not executed. Only errors are # returned, not results. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::Operation] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::Operation] # # @raise [Google::Ads::GoogleAds::Error] if the RPC is aborted. # # @example Basic example # require "google/ads/google_ads/v16/services" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Ads::GoogleAds::V16::Services::ExperimentService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Ads::GoogleAds::V16::Services::ScheduleExperimentRequest.new # # # Call the schedule_experiment method. # result = client.schedule_experiment request # # # The returned object is of type Gapic::Operation. You can use it to # # check the status of an operation, cancel it, or wait for results. # # Here is how to wait for a response. # result.wait_until_done! timeout: 60 # if result.response? # p result.response # else # puts "No response received." # end # def schedule_experiment request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V16::Services::ScheduleExperimentRequest # 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.schedule_experiment.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Ads::GoogleAds::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.resource_name header_params["resource_name"] = request.resource_name 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.schedule_experiment.timeout, metadata: metadata, retry_policy: @config.rpcs.schedule_experiment.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @experiment_service_stub.call_rpc :schedule_experiment, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end # rescue GRPC::BadStatus => grpc_error # raise Google::Ads::GoogleAds::Error.new grpc_error.message end ## # Promotes the trial campaign thus applying changes in the trial campaign # to the base campaign. # This method returns a long running operation that tracks the promotion of # the experiment campaign. If it fails, a list of errors can be retrieved # using the ListExperimentAsyncErrors method. The operation's # metadata will be a string containing the resource name of the created # experiment. # # List of thrown errors: # [AuthenticationError]() # [AuthorizationError]() # [ExperimentError]() # [HeaderError]() # [InternalError]() # [QuotaError]() # [RequestError]() # # @overload promote_experiment(request, options = nil) # Pass arguments to `promote_experiment` via a request object, either of type # {::Google::Ads::GoogleAds::V16::Services::PromoteExperimentRequest} or an equivalent Hash. # # @param request [::Google::Ads::GoogleAds::V16::Services::PromoteExperimentRequest, ::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 promote_experiment(resource_name: nil, validate_only: nil) # Pass arguments to `promote_experiment` 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 resource_name [::String] # Required. The resource name of the experiment to promote. # @param validate_only [::Boolean] # If true, the request is validated but not executed. Only errors are # returned, not results. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::Operation] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::Operation] # # @raise [Google::Ads::GoogleAds::Error] if the RPC is aborted. # # @example Basic example # require "google/ads/google_ads/v16/services" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Ads::GoogleAds::V16::Services::ExperimentService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Ads::GoogleAds::V16::Services::PromoteExperimentRequest.new # # # Call the promote_experiment method. # result = client.promote_experiment request # # # The returned object is of type Gapic::Operation. You can use it to # # check the status of an operation, cancel it, or wait for results. # # Here is how to wait for a response. # result.wait_until_done! timeout: 60 # if result.response? # p result.response # else # puts "No response received." # end # def promote_experiment request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V16::Services::PromoteExperimentRequest # 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.promote_experiment.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Ads::GoogleAds::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.resource_name header_params["resource_name"] = request.resource_name 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.promote_experiment.timeout, metadata: metadata, retry_policy: @config.rpcs.promote_experiment.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @experiment_service_stub.call_rpc :promote_experiment, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end # rescue GRPC::BadStatus => grpc_error # raise Google::Ads::GoogleAds::Error.new grpc_error.message end ## # Configuration class for the ExperimentService API. # # This class represents the configuration for ExperimentService, # 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::V16::Services::ExperimentService::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 # # mutate_experiments to 20 seconds, # # and all remaining timeouts to 10 seconds. # ::Google::Ads::GoogleAds::V16::Services::ExperimentService::Client.configure do |config| # config.timeout = 10.0 # config.rpcs.mutate_experiments.timeout = 20.0 # end # # # Apply the above configuration only to a new client. # client = ::Google::Ads::GoogleAds::V16::Services::ExperimentService::Client.new do |config| # config.timeout = 10.0 # config.rpcs.mutate_experiments.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: # * (`String`) The path to a service account key file in JSON format # * (`Hash`) A service account key as a Hash # * (`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 # @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. # * `:retry_codes` (*type:* `Array`) - 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] # 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, ::Signet::OAuth2::Client, nil] allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC 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 # @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 ExperimentService 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. # * `:retry_codes` (*type:* `Array`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `mutate_experiments` # @return [::Gapic::Config::Method] # attr_reader :mutate_experiments ## # RPC-specific configuration for `end_experiment` # @return [::Gapic::Config::Method] # attr_reader :end_experiment ## # RPC-specific configuration for `list_experiment_async_errors` # @return [::Gapic::Config::Method] # attr_reader :list_experiment_async_errors ## # RPC-specific configuration for `graduate_experiment` # @return [::Gapic::Config::Method] # attr_reader :graduate_experiment ## # RPC-specific configuration for `schedule_experiment` # @return [::Gapic::Config::Method] # attr_reader :schedule_experiment ## # RPC-specific configuration for `promote_experiment` # @return [::Gapic::Config::Method] # attr_reader :promote_experiment # @private def initialize parent_rpcs = nil mutate_experiments_config = parent_rpcs.mutate_experiments if parent_rpcs.respond_to? :mutate_experiments @mutate_experiments = ::Gapic::Config::Method.new mutate_experiments_config end_experiment_config = parent_rpcs.end_experiment if parent_rpcs.respond_to? :end_experiment @end_experiment = ::Gapic::Config::Method.new end_experiment_config list_experiment_async_errors_config = parent_rpcs.list_experiment_async_errors if parent_rpcs.respond_to? :list_experiment_async_errors @list_experiment_async_errors = ::Gapic::Config::Method.new list_experiment_async_errors_config graduate_experiment_config = parent_rpcs.graduate_experiment if parent_rpcs.respond_to? :graduate_experiment @graduate_experiment = ::Gapic::Config::Method.new graduate_experiment_config schedule_experiment_config = parent_rpcs.schedule_experiment if parent_rpcs.respond_to? :schedule_experiment @schedule_experiment = ::Gapic::Config::Method.new schedule_experiment_config promote_experiment_config = parent_rpcs.promote_experiment if parent_rpcs.respond_to? :promote_experiment @promote_experiment = ::Gapic::Config::Method.new promote_experiment_config yield self if block_given? end end end end end end end end end end