class Google::Ads::GoogleAds::V8::Services::CampaignExperimentService::Client

Client for the CampaignExperimentService service.

CampaignExperimentService manages the life cycle of campaign experiments. It is used to create new experiments from drafts, modify experiment properties, promote changes in an experiment back to its base campaign, graduate experiments into new stand-alone campaigns, and to remove an experiment.

An experiment consists of two variants or arms - the base campaign and the experiment campaign, directing a fixed share of traffic to each arm. A campaign experiment is created from a draft of changes to the base campaign and will be a snapshot of changes in the draft at the time of creation.

Attributes

campaign_experiment_service_stub[R]

@private

operations_client[R]

Get the associated client for long-running operations.

@return [::Google::Ads::GoogleAds::V8::Services::CampaignExperimentService::Operations]

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the CampaignExperimentService Client class.

See {::Google::Ads::GoogleAds::V8::Services::CampaignExperimentService::Client::Configuration} for a description of the configuration fields.

@example

# Modify the configuration for all CampaignExperimentService clients
::Google::Ads::GoogleAds::V8::Services::CampaignExperimentService::Client.configure do |config|
  config.timeout = 10.0
end

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/ads/google_ads/v8/services/campaign_experiment_service/client.rb, line 66
def self.configure
  @configure ||= begin
    default_config = Client::Configuration.new

    default_config.timeout = 3600.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
new() { |config| ... } click to toggle source

Create a new CampaignExperimentService client object.

@example

# Create a client using the default configuration
client = ::Google::Ads::GoogleAds::V8::Services::CampaignExperimentService::Client.new

# Create a client using a custom configuration
client = ::Google::Ads::GoogleAds::V8::Services::CampaignExperimentService::Client.new do |config|
  config.timeout = 10.0
end

@yield [config] Configure the CampaignExperimentService client. @yieldparam config [Client::Configuration]

# File lib/google/ads/google_ads/v8/services/campaign_experiment_service/client.rb, line 117
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/v8/services/campaign_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 == Client.configure.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.endpoint = @config.endpoint
  end

  @campaign_experiment_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Ads::GoogleAds::V8::Services::CampaignExperimentService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Public Instance Methods

configure() { |config| ... } click to toggle source

Configure the CampaignExperimentService 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::V8::Services::CampaignExperimentService::Client::Configuration} for a description of the configuration fields.

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/ads/google_ads/v8/services/campaign_experiment_service/client.rb, line 96
def configure
  yield @config if block_given?
  @config
end
create_campaign_experiment(request, options = nil) { |response, operation| ... } click to toggle source

Creates a campaign experiment based on a campaign draft. The draft campaign will be forked into a real campaign (called the experiment campaign) that will begin serving ads if successfully created.

The campaign experiment is created immediately with status INITIALIZING. This method return a long running operation that tracks the forking of the draft campaign. If the forking fails, a list of errors can be retrieved using the ListCampaignExperimentAsyncErrors method. The operation's metadata will be a StringValue containing the resource name of the created campaign experiment.

List of thrown errors:

[AuthenticationError]()
[AuthorizationError]()
[CampaignExperimentError]()
[DatabaseError]()
[DateError]()
[DateRangeError]()
[FieldError]()
[HeaderError]()
[InternalError]()
[QuotaError]()
[RangeError]()
[RequestError]()

@overload create_campaign_experiment(request, options = nil)

Pass arguments to `create_campaign_experiment` via a request object, either of type
{::Google::Ads::GoogleAds::V8::Services::CreateCampaignExperimentRequest} or an equivalent Hash.

@param request [::Google::Ads::GoogleAds::V8::Services::CreateCampaignExperimentRequest, ::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 create_campaign_experiment(customer_id: nil, campaign_experiment: nil, validate_only: nil)

Pass arguments to `create_campaign_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 customer_id [::String]
  Required. The ID of the customer whose campaign experiment is being created.
@param campaign_experiment [::Google::Ads::GoogleAds::V8::Resources::CampaignExperiment, ::Hash]
  Required. The campaign experiment to be created.
@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.

# File lib/google/ads/google_ads/v8/services/campaign_experiment_service/client.rb, line 302
def create_campaign_experiment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V8::Services::CreateCampaignExperimentRequest

  # 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.create_campaign_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 = {
    "customer_id" => request.customer_id
  }
  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.create_campaign_experiment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_campaign_experiment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @campaign_experiment_service_stub.call_rpc :create_campaign_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
end_campaign_experiment(request, options = nil) { |response, operation| ... } click to toggle source

Immediately ends a campaign 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]()
[CampaignExperimentError]()
[HeaderError]()
[InternalError]()
[QuotaError]()
[RequestError]()

@overload end_campaign_experiment(request, options = nil)

Pass arguments to `end_campaign_experiment` via a request object, either of type
{::Google::Ads::GoogleAds::V8::Services::EndCampaignExperimentRequest} or an equivalent Hash.

@param request [::Google::Ads::GoogleAds::V8::Services::EndCampaignExperimentRequest, ::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_campaign_experiment(campaign_experiment: nil, validate_only: nil)

Pass arguments to `end_campaign_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 campaign_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.

# File lib/google/ads/google_ads/v8/services/campaign_experiment_service/client.rb, line 653
def end_campaign_experiment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V8::Services::EndCampaignExperimentRequest

  # 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_campaign_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 = {
    "campaign_experiment" => request.campaign_experiment
  }
  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_campaign_experiment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.end_campaign_experiment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @campaign_experiment_service_stub.call_rpc :end_campaign_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
get_campaign_experiment(request, options = nil) { |response, operation| ... } click to toggle source

Returns the requested campaign experiment in full detail.

List of thrown errors:

[AuthenticationError]()
[AuthorizationError]()
[HeaderError]()
[InternalError]()
[QuotaError]()
[RequestError]()

@overload get_campaign_experiment(request, options = nil)

Pass arguments to `get_campaign_experiment` via a request object, either of type
{::Google::Ads::GoogleAds::V8::Services::GetCampaignExperimentRequest} or an equivalent Hash.

@param request [::Google::Ads::GoogleAds::V8::Services::GetCampaignExperimentRequest, ::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 get_campaign_experiment(resource_name: nil)

Pass arguments to `get_campaign_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 campaign experiment to fetch.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Ads::GoogleAds::V8::Resources::CampaignExperiment] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Ads::GoogleAds::V8::Resources::CampaignExperiment]

@raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.

# File lib/google/ads/google_ads/v8/services/campaign_experiment_service/client.rb, line 204
def get_campaign_experiment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V8::Services::GetCampaignExperimentRequest

  # 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.get_campaign_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 = {
    "resource_name" => request.resource_name
  }
  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.get_campaign_experiment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_campaign_experiment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @campaign_experiment_service_stub.call_rpc :get_campaign_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
graduate_campaign_experiment(request, options = nil) { |response, operation| ... } click to toggle source

Graduates a campaign experiment to a full campaign. The base and experiment campaigns will start running independently with their own budgets.

List of thrown errors:

[AuthenticationError]()
[AuthorizationError]()
[CampaignExperimentError]()
[HeaderError]()
[InternalError]()
[MutateError]()
[QuotaError]()
[RequestError]()

@overload graduate_campaign_experiment(request, options = nil)

Pass arguments to `graduate_campaign_experiment` via a request object, either of type
{::Google::Ads::GoogleAds::V8::Services::GraduateCampaignExperimentRequest} or an equivalent Hash.

@param request [::Google::Ads::GoogleAds::V8::Services::GraduateCampaignExperimentRequest, ::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_campaign_experiment(campaign_experiment: nil, campaign_budget: nil, validate_only: nil)

Pass arguments to `graduate_campaign_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 campaign_experiment [::String]
  Required. The resource name of the campaign experiment to graduate.
@param campaign_budget [::String]
  Required. Resource name of the budget to attach to the campaign graduated from the
  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 [::Google::Ads::GoogleAds::V8::Services::GraduateCampaignExperimentResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Ads::GoogleAds::V8::Services::GraduateCampaignExperimentResponse]

@raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.

# File lib/google/ads/google_ads/v8/services/campaign_experiment_service/client.rb, line 482
def graduate_campaign_experiment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V8::Services::GraduateCampaignExperimentRequest

  # 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_campaign_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 = {
    "campaign_experiment" => request.campaign_experiment
  }
  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_campaign_experiment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.graduate_campaign_experiment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @campaign_experiment_service_stub.call_rpc :graduate_campaign_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
list_campaign_experiment_async_errors(request, options = nil) { |response, operation| ... } click to toggle source

Returns all errors that occurred during CampaignExperiment create or promote (whichever occurred last). Supports standard list paging.

List of thrown errors:

[AuthenticationError]()
[AuthorizationError]()
[HeaderError]()
[InternalError]()
[QuotaError]()
[RequestError]()

@overload list_campaign_experiment_async_errors(request, options = nil)

Pass arguments to `list_campaign_experiment_async_errors` via a request object, either of type
{::Google::Ads::GoogleAds::V8::Services::ListCampaignExperimentAsyncErrorsRequest} or an equivalent Hash.

@param request [::Google::Ads::GoogleAds::V8::Services::ListCampaignExperimentAsyncErrorsRequest, ::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_campaign_experiment_async_errors(resource_name: nil, page_token: nil, page_size: nil)

Pass arguments to `list_campaign_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 campaign 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.

@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.

# File lib/google/ads/google_ads/v8/services/campaign_experiment_service/client.rb, line 743
def list_campaign_experiment_async_errors request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V8::Services::ListCampaignExperimentAsyncErrorsRequest

  # 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_campaign_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 = {
    "resource_name" => request.resource_name
  }
  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_campaign_experiment_async_errors.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_campaign_experiment_async_errors.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @campaign_experiment_service_stub.call_rpc :list_campaign_experiment_async_errors, request,
                                             options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @campaign_experiment_service_stub,
                                            :list_campaign_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
mutate_campaign_experiments(request, options = nil) { |response, operation| ... } click to toggle source

Updates campaign experiments. Operation statuses are returned.

List of thrown errors:

[AuthenticationError]()
[AuthorizationError]()
[CampaignExperimentError]()
[HeaderError]()
[InternalError]()
[QuotaError]()
[RequestError]()

@overload mutate_campaign_experiments(request, options = nil)

Pass arguments to `mutate_campaign_experiments` via a request object, either of type
{::Google::Ads::GoogleAds::V8::Services::MutateCampaignExperimentsRequest} or an equivalent Hash.

@param request [::Google::Ads::GoogleAds::V8::Services::MutateCampaignExperimentsRequest, ::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_campaign_experiments(customer_id: nil, operations: nil, partial_failure: nil, validate_only: nil, response_content_type: nil)

Pass arguments to `mutate_campaign_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 campaign experiments are being modified.
@param operations [::Array<::Google::Ads::GoogleAds::V8::Services::CampaignExperimentOperation, ::Hash>]
  Required. The list of operations to perform on individual campaign 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.
@param response_content_type [::Google::Ads::GoogleAds::V8::Enums::ResponseContentTypeEnum::ResponseContentType]
  The response content type setting. Determines whether the mutable resource
  or just the resource name should be returned post mutation.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Ads::GoogleAds::V8::Services::MutateCampaignExperimentsResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Ads::GoogleAds::V8::Services::MutateCampaignExperimentsResponse]

@raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.

# File lib/google/ads/google_ads/v8/services/campaign_experiment_service/client.rb, line 395
def mutate_campaign_experiments request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V8::Services::MutateCampaignExperimentsRequest

  # 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_campaign_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 = {
    "customer_id" => request.customer_id
  }
  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_campaign_experiments.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.mutate_campaign_experiments.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @campaign_experiment_service_stub.call_rpc :mutate_campaign_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
promote_campaign_experiment(request, options = nil) { |response, operation| ... } click to toggle source

Promotes the changes in a experiment campaign back to the base campaign.

The campaign experiment is updated immediately with status PROMOTING. This method return a long running operation that tracks the promoting of the experiment campaign. If the promoting fails, a list of errors can be retrieved using the ListCampaignExperimentAsyncErrors method.

List of thrown errors:

[AuthenticationError]()
[AuthorizationError]()
[HeaderError]()
[InternalError]()
[QuotaError]()
[RequestError]()

@overload promote_campaign_experiment(request, options = nil)

Pass arguments to `promote_campaign_experiment` via a request object, either of type
{::Google::Ads::GoogleAds::V8::Services::PromoteCampaignExperimentRequest} or an equivalent Hash.

@param request [::Google::Ads::GoogleAds::V8::Services::PromoteCampaignExperimentRequest, ::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_campaign_experiment(campaign_experiment: nil, validate_only: nil)

Pass arguments to `promote_campaign_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 campaign_experiment [::String]
  Required. The resource name of the campaign experiment to promote.
@param validate_only [::Boolean]
  If true, the request is validated but no Long Running Operation is created.
  Only errors are returned.

@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.

# File lib/google/ads/google_ads/v8/services/campaign_experiment_service/client.rb, line 568
def promote_campaign_experiment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V8::Services::PromoteCampaignExperimentRequest

  # 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_campaign_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 = {
    "campaign_experiment" => request.campaign_experiment
  }
  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_campaign_experiment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.promote_campaign_experiment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @campaign_experiment_service_stub.call_rpc :promote_campaign_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