Class: Google::Ads::GoogleAds::V14::Services::ExperimentService::Client

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

Overview

Client for the ExperimentService service.

Service to manage experiments.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#campaign_budget_path, #campaign_path, #experiment_path

Constructor Details

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

Create a new ExperimentService client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the ExperimentService client.

Yield Parameters:



108
109
110
111
112
113
114
115
116
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
 
# File 'lib/google/ads/google_ads/v14/services/experiment_service/client.rb', line 108

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/v14/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 == 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
  end

  @experiment_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Ads::GoogleAds::V14::Services::ExperimentService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Instance Attribute Details

#experiment_service_stub ⇒ Object (readonly) 



37
38
39
 
# File 'lib/google/ads/google_ads/v14/services/experiment_service/client.rb', line 37

def experiment_service_stub
  @experiment_service_stub
end

#operations_client ⇒ ::Google::Ads::GoogleAds::V14::Services::ExperimentService::Operations (readonly)

Get the associated client for long-running operations.

Returns:



155
156
157
 
# File 'lib/google/ads/google_ads/v14/services/experiment_service/client.rb', line 155

def operations_client
  @operations_client
end

Class Method Details

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

Configure the ExperimentService Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/google/ads/google_ads/v14/services/experiment_service/client.rb', line 57

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

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



87
88
89
90
 
# File 'lib/google/ads/google_ads/v14/services/experiment_service/client.rb', line 87

def configure
  yield @config if block_given?
  @config
end

#end_experiment(request, options = nil) ⇒ ::Google::Protobuf::Empty #end_experiment(experiment: nil, validate_only: nil) ⇒ ::Google::Protobuf::Empty

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

Examples:

Basic example

require "google/ads/google_ads/v14/services"

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

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

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

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

Overloads:

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

    Pass arguments to ‘end_experiment` via a request object, either of type Google::Ads::GoogleAds::V14::Services::EndExperimentRequest or an equivalent Hash.

    Parameters:

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

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

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

  • #end_experiment(experiment: nil, validate_only: nil) ⇒ ::Google::Protobuf::Empty

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

    Parameters:

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



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/google/ads/google_ads/v14/services/experiment_service/client.rb', line 323

def end_experiment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V14::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

#graduate_experiment(request, options = nil) ⇒ ::Google::Protobuf::Empty #graduate_experiment(experiment: nil, campaign_budget_mappings: nil, validate_only: nil) ⇒ ::Google::Protobuf::Empty

Graduates an experiment to a full campaign.

List of thrown errors:

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

Examples:

Basic example

require "google/ads/google_ads/v14/services"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

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

  • #graduate_experiment(experiment: nil, campaign_budget_mappings: nil, validate_only: nil) ⇒ ::Google::Protobuf::Empty

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

    Parameters:

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

      Required. The experiment to be graduated.

    • campaign_budget_mappings (::Array<::Google::Ads::GoogleAds::V14::Services::CampaignBudgetMapping, ::Hash>) (defaults to: nil) —

      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.

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



540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'lib/google/ads/google_ads/v14/services/experiment_service/client.rb', line 540

def graduate_experiment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V14::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

#list_experiment_async_errors(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Rpc::Status> #list_experiment_async_errors(resource_name: nil, page_token: nil, page_size: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Rpc::Status>

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

Examples:

Basic example

require "google/ads/google_ads/v14/services"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Ads::GoogleAds::V14::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

Overloads:

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

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

    Parameters:

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

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

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

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

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

    Parameters:

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

      Required. The name of the 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. The maximum page size is 1000.

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.



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/google/ads/google_ads/v14/services/experiment_service/client.rb', line 434

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::V14::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

#mutate_experiments(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V14::Services::MutateExperimentsResponse #mutate_experiments(customer_id: nil, operations: nil, partial_failure: nil, validate_only: nil) ⇒ ::Google::Ads::GoogleAds::V14::Services::MutateExperimentsResponse

Creates, updates, or removes experiments. Operation statuses are returned.

List of thrown errors:

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

Examples:

Basic example

require "google/ads/google_ads/v14/services"

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

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

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

# The returned object is of type Google::Ads::GoogleAds::V14::Services::MutateExperimentsResponse.
p result

Overloads:

  • #mutate_experiments(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V14::Services::MutateExperimentsResponse

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

    Parameters:

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

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

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

  • #mutate_experiments(customer_id: nil, operations: nil, partial_failure: nil, validate_only: nil) ⇒ ::Google::Ads::GoogleAds::V14::Services::MutateExperimentsResponse

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

    Parameters:

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

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

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

      Required. The list of operations to perform on individual 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.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/google/ads/google_ads/v14/services/experiment_service/client.rb', line 222

def mutate_experiments request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V14::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

#promote_experiment(request, options = nil) ⇒ ::Gapic::Operation #promote_experiment(resource_name: nil, validate_only: nil) ⇒ ::Gapic::Operation

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

Examples:

Basic example

require "google/ads/google_ads/v14/services"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Ads::GoogleAds::V14::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

Overloads:

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

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

    Parameters:

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

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

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

  • #promote_experiment(resource_name: nil, validate_only: nil) ⇒ ::Gapic::Operation

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

    Parameters:

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

      Required. The resource name of the experiment to promote.

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



773
774
775
776
777
778
779
780
781
782
783
784
785
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
 
# File 'lib/google/ads/google_ads/v14/services/experiment_service/client.rb', line 773

def promote_experiment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V14::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

#schedule_experiment(request, options = nil) ⇒ ::Gapic::Operation #schedule_experiment(resource_name: nil, validate_only: nil) ⇒ ::Gapic::Operation

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

Examples:

Basic example

require "google/ads/google_ads/v14/services"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Ads::GoogleAds::V14::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

Overloads:

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

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

    Parameters:

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

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

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

  • #schedule_experiment(resource_name: nil, validate_only: nil) ⇒ ::Gapic::Operation

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

    Parameters:

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

      Required. The scheduled 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:

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

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



660
661
662
663
664
665
666
667
668
669
670
671
672
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
 
# File 'lib/google/ads/google_ads/v14/services/experiment_service/client.rb', line 660

def schedule_experiment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V14::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