Class: Google::Ads::GoogleAds::V11::Services::CampaignExperimentService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/ads/google_ads/v11/services/campaign_experiment_service/client.rb

Overview

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.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#campaign_draft_path, #campaign_experiment_path, #campaign_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new CampaignExperimentService client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the CampaignExperimentService client.

Yield Parameters:



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/google/ads/google_ads/v11/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/v11/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.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
  end

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

Instance Attribute Details

#campaign_experiment_service_stub ⇒ Object (readonly) 



46
47
48
 
# File 'lib/google/ads/google_ads/v11/services/campaign_experiment_service/client.rb', line 46

def campaign_experiment_service_stub
  @campaign_experiment_service_stub
end

#operations_client ⇒ ::Google::Ads::GoogleAds::V11::Services::CampaignExperimentService::Operations (readonly)

Get the associated client for long-running operations.

Returns:



164
165
166
 
# File 'lib/google/ads/google_ads/v11/services/campaign_experiment_service/client.rb', line 164

def operations_client
  @operations_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the CampaignExperimentService Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/google/ads/google_ads/v11/services/campaign_experiment_service/client.rb', line 66

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

Instance Method Details

#configure {|config| ... } ⇒ Client::Configuration

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

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



96
97
98
99
 
# File 'lib/google/ads/google_ads/v11/services/campaign_experiment_service/client.rb', line 96

def configure
  yield @config if block_given?
  @config
end

#create_campaign_experiment(request, options = nil) ⇒ ::Gapic::Operation #create_campaign_experiment(customer_id: nil, campaign_experiment: nil, validate_only: nil) ⇒ ::Gapic::Operation

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]()

Examples:

Basic example

require "google/ads/google_ads/v11/services"

# Create a client object. The client can be reused for multiple calls.
client = Google::Ads::GoogleAds::V11::Services::CampaignExperimentService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Ads::GoogleAds::V11::Services::CreateCampaignExperimentRequest.new

# Call the create_campaign_experiment method.
result = client.create_campaign_experiment request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end

Overloads:

  • #create_campaign_experiment(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Ads::GoogleAds::V11::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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_campaign_experiment(customer_id: nil, campaign_experiment: nil, validate_only: nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • customer_id (::String) (defaults to: nil) —

      Required. The ID of the customer whose campaign experiment is being created.

    • campaign_experiment (::Google::Ads::GoogleAds::V11::Resources::CampaignExperiment, ::Hash) (defaults to: nil) —

      Required. The campaign experiment to be created.

    • validate_only (::Boolean) (defaults to: nil) —

      If true, the request is validated but not executed. Only errors are returned, not results.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (Google::Ads::GoogleAds::Error) —

    if the RPC is aborted.



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/google/ads/google_ads/v11/services/campaign_experiment_service/client.rb', line 247

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::V11::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 = {}
  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.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) ⇒ ::Google::Protobuf::Empty #end_campaign_experiment(campaign_experiment: nil, validate_only: nil) ⇒ ::Google::Protobuf::Empty

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]()

Examples:

Basic example

require "google/ads/google_ads/v11/services"

# Create a client object. The client can be reused for multiple calls.
client = Google::Ads::GoogleAds::V11::Services::CampaignExperimentService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Ads::GoogleAds::V11::Services::EndCampaignExperimentRequest.new

# Call the end_campaign_experiment method.
result = client.end_campaign_experiment request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #end_campaign_experiment(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to ‘end_campaign_experiment` via a request object, either of type EndCampaignExperimentRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Ads::GoogleAds::V11::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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #end_campaign_experiment(campaign_experiment: nil, validate_only: nil) ⇒ ::Google::Protobuf::Empty

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

    Parameters:

    • campaign_experiment (::String) (defaults to: nil) —

      Required. The resource name of the campaign experiment to end.

    • validate_only (::Boolean) (defaults to: nil) —

      If true, the request is validated but not executed. Only errors are returned, not results.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Google::Protobuf::Empty)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Google::Protobuf::Empty)

Raises:

  • (Google::Ads::GoogleAds::Error) —

    if the RPC is aborted.



673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
 
# File 'lib/google/ads/google_ads/v11/services/campaign_experiment_service/client.rb', line 673

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::V11::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 = {}
  if request.campaign_experiment
    header_params["campaign_experiment"] = request.campaign_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_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

#graduate_campaign_experiment(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V11::Services::GraduateCampaignExperimentResponse #graduate_campaign_experiment(campaign_experiment: nil, campaign_budget: nil, validate_only: nil) ⇒ ::Google::Ads::GoogleAds::V11::Services::GraduateCampaignExperimentResponse

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]()

Examples:

Basic example

require "google/ads/google_ads/v11/services"

# Create a client object. The client can be reused for multiple calls.
client = Google::Ads::GoogleAds::V11::Services::CampaignExperimentService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Ads::GoogleAds::V11::Services::GraduateCampaignExperimentRequest.new

# Call the graduate_campaign_experiment method.
result = client.graduate_campaign_experiment request

# The returned object is of type Google::Ads::GoogleAds::V11::Services::GraduateCampaignExperimentResponse.
p result

Overloads:

  • #graduate_campaign_experiment(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V11::Services::GraduateCampaignExperimentResponse

    Pass arguments to ‘graduate_campaign_experiment` via a request object, either of type GraduateCampaignExperimentRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Ads::GoogleAds::V11::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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #graduate_campaign_experiment(campaign_experiment: nil, campaign_budget: nil, validate_only: nil) ⇒ ::Google::Ads::GoogleAds::V11::Services::GraduateCampaignExperimentResponse

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

    Parameters:

    • campaign_experiment (::String) (defaults to: nil) —

      Required. The resource name of the campaign experiment to graduate.

    • campaign_budget (::String) (defaults to: nil) —

      Required. Resource name of the budget to attach to the campaign graduated from the experiment.

    • validate_only (::Boolean) (defaults to: nil) —

      If true, the request is validated but not executed. Only errors are returned, not results.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Ads::GoogleAds::Error) —

    if the RPC is aborted.



461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
 
# File 'lib/google/ads/google_ads/v11/services/campaign_experiment_service/client.rb', line 461

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::V11::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 = {}
  if request.campaign_experiment
    header_params["campaign_experiment"] = request.campaign_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_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) ⇒ ::Gapic::PagedEnumerable<::Google::Rpc::Status> #list_campaign_experiment_async_errors(resource_name: nil, page_token: nil, page_size: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Rpc::Status>

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]()

Examples:

Basic example

require "google/ads/google_ads/v11/services"

# Create a client object. The client can be reused for multiple calls.
client = Google::Ads::GoogleAds::V11::Services::CampaignExperimentService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Ads::GoogleAds::V11::Services::ListCampaignExperimentAsyncErrorsRequest.new

# Call the list_campaign_experiment_async_errors method.
result = client.list_campaign_experiment_async_errors request

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Rpc::Status.
  p response
end

Overloads:

  • #list_campaign_experiment_async_errors(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Rpc::Status>

    Pass arguments to ‘list_campaign_experiment_async_errors` via a request object, either of type ListCampaignExperimentAsyncErrorsRequest or an equivalent Hash.

    Parameters:

  • #list_campaign_experiment_async_errors(resource_name: nil, page_token: nil, page_size: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Rpc::Status>

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

    Parameters:

    • resource_name (::String) (defaults to: nil) —

      Required. The name of the campaign experiment from which to retrieve the async errors.

    • page_token (::String) (defaults to: nil) —

      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.

    • page_size (::Integer) (defaults to: nil) —

      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.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::PagedEnumerable<::Google::Rpc::Status>)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::PagedEnumerable<::Google::Rpc::Status>)

Raises:

  • (Google::Ads::GoogleAds::Error) —

    if the RPC is aborted.



786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
 
# File 'lib/google/ads/google_ads/v11/services/campaign_experiment_service/client.rb', line 786

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::V11::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 = {}
  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_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) ⇒ ::Google::Ads::GoogleAds::V11::Services::MutateCampaignExperimentsResponse #mutate_campaign_experiments(customer_id: nil, operations: nil, partial_failure: nil, validate_only: nil, response_content_type: nil) ⇒ ::Google::Ads::GoogleAds::V11::Services::MutateCampaignExperimentsResponse

Updates campaign experiments. Operation statuses are returned.

List of thrown errors:

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

Examples:

Basic example

require "google/ads/google_ads/v11/services"

# Create a client object. The client can be reused for multiple calls.
client = Google::Ads::GoogleAds::V11::Services::CampaignExperimentService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Ads::GoogleAds::V11::Services::MutateCampaignExperimentsRequest.new

# Call the mutate_campaign_experiments method.
result = client.mutate_campaign_experiments request

# The returned object is of type Google::Ads::GoogleAds::V11::Services::MutateCampaignExperimentsResponse.
p result

Overloads:

  • #mutate_campaign_experiments(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V11::Services::MutateCampaignExperimentsResponse

    Pass arguments to ‘mutate_campaign_experiments` via a request object, either of type MutateCampaignExperimentsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Ads::GoogleAds::V11::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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #mutate_campaign_experiments(customer_id: nil, operations: nil, partial_failure: nil, validate_only: nil, response_content_type: nil) ⇒ ::Google::Ads::GoogleAds::V11::Services::MutateCampaignExperimentsResponse

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

    Parameters:

    • customer_id (::String) (defaults to: nil) —

      Required. The ID of the customer whose campaign experiments are being modified.

    • operations (::Array<::Google::Ads::GoogleAds::V11::Services::CampaignExperimentOperation, ::Hash>) (defaults to: nil) —

      Required. The list of operations to perform on individual campaign experiments.

    • partial_failure (::Boolean) (defaults to: nil) —

      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.

    • validate_only (::Boolean) (defaults to: nil) —

      If true, the request is validated but not executed. Only errors are returned, not results.

    • response_content_type (::Google::Ads::GoogleAds::V11::Enums::ResponseContentTypeEnum::ResponseContentType) (defaults to: nil) —

      The response content type setting. Determines whether the mutable resource or just the resource name should be returned post mutation.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Ads::GoogleAds::Error) —

    if the RPC is aborted.



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/google/ads/google_ads/v11/services/campaign_experiment_service/client.rb', line 357

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::V11::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 = {}
  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_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) ⇒ ::Gapic::Operation #promote_campaign_experiment(campaign_experiment: nil, validate_only: nil) ⇒ ::Gapic::Operation

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]()

Examples:

Basic example

require "google/ads/google_ads/v11/services"

# Create a client object. The client can be reused for multiple calls.
client = Google::Ads::GoogleAds::V11::Services::CampaignExperimentService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Ads::GoogleAds::V11::Services::PromoteCampaignExperimentRequest.new

# Call the promote_campaign_experiment method.
result = client.promote_campaign_experiment request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end

Overloads:

  • #promote_campaign_experiment(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to ‘promote_campaign_experiment` via a request object, either of type PromoteCampaignExperimentRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Ads::GoogleAds::V11::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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #promote_campaign_experiment(campaign_experiment: nil, validate_only: nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • campaign_experiment (::String) (defaults to: nil) —

      Required. The resource name of the campaign experiment to promote.

    • validate_only (::Boolean) (defaults to: nil) —

      If true, the request is validated but no Long Running Operation is created. Only errors are returned.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (Google::Ads::GoogleAds::Error) —

    if the RPC is aborted.



571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
 
# File 'lib/google/ads/google_ads/v11/services/campaign_experiment_service/client.rb', line 571

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::V11::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 = {}
  if request.campaign_experiment
    header_params["campaign_experiment"] = request.campaign_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.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