Class: Google::Ads::GoogleAds::V17::Services::BatchJobService::Client

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

Overview

Client for the BatchJobService service.

Service to manage batch jobs.

Defined Under Namespace

Classes: Configuration

Constant Summary collapse

API_VERSION = 
""
DEFAULT_ENDPOINT_TEMPLATE = 
"googleads.$UNIVERSE_DOMAIN$"

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#accessible_bidding_strategy_path, #ad_group_ad_label_path, #ad_group_ad_path, #ad_group_asset_path, #ad_group_bid_modifier_path, #ad_group_criterion_customizer_path, #ad_group_criterion_label_path, #ad_group_criterion_path, #ad_group_customizer_path, #ad_group_extension_setting_path, #ad_group_feed_path, #ad_group_label_path, #ad_group_path, #ad_parameter_path, #ad_path, #asset_group_asset_path, #asset_group_listing_group_filter_path, #asset_group_path, #asset_group_signal_path, #asset_path, #asset_set_asset_path, #asset_set_path, #audience_path, #batch_job_path, #bidding_data_exclusion_path, #bidding_seasonality_adjustment_path, #bidding_strategy_path, #campaign_asset_path, #campaign_asset_set_path, #campaign_bid_modifier_path, #campaign_budget_path, #campaign_conversion_goal_path, #campaign_criterion_path, #campaign_customizer_path, #campaign_draft_path, #campaign_extension_setting_path, #campaign_feed_path, #campaign_group_path, #campaign_label_path, #campaign_path, #campaign_shared_set_path, #carrier_constant_path, #combined_audience_path, #conversion_action_path, #conversion_custom_variable_path, #conversion_goal_campaign_config_path, #conversion_value_rule_path, #conversion_value_rule_set_path, #custom_conversion_goal_path, #customer_asset_path, #customer_conversion_goal_path, #customer_customizer_path, #customer_extension_setting_path, #customer_feed_path, #customer_label_path, #customer_negative_criterion_path, #customer_path, #customizer_attribute_path, #detailed_demographic_path, #experiment_arm_path, #experiment_path, #extension_feed_item_path, #feed_item_path, #feed_item_set_link_path, #feed_item_set_path, #feed_item_target_path, #feed_mapping_path, #feed_path, #geo_target_constant_path, #keyword_plan_ad_group_keyword_path, #keyword_plan_ad_group_path, #keyword_plan_campaign_keyword_path, #keyword_plan_campaign_path, #keyword_plan_path, #keyword_theme_constant_path, #label_path, #language_constant_path, #life_event_path, #mobile_app_category_constant_path, #mobile_device_constant_path, #operating_system_version_constant_path, #recommendation_subscription_path, #remarketing_action_path, #shared_criterion_path, #shared_set_path, #smart_campaign_setting_path, #topic_constant_path, #user_interest_path, #user_list_path

Constructor Details

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

Create a new BatchJobService client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the BatchJobService client.

Yield Parameters:



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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/google/ads/google_ads/v17/services/batch_job_service/client.rb', line 123

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/v17/services/batch_job_service_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @operations_client = Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.universe_domain = @config.universe_domain
  end

  @batch_job_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Ads::GoogleAds::V17::Services::BatchJobService::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool,
    logger: @config.logger
  )

  @batch_job_service_stub.stub_logger&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end
end

Instance Attribute Details

#batch_job_service_stub ⇒ Object (readonly) 



43
44
45
 
# File 'lib/google/ads/google_ads/v17/services/batch_job_service/client.rb', line 43

def batch_job_service_stub
  @batch_job_service_stub
end

#operations_client ⇒ ::Google::Ads::GoogleAds::V17::Services::BatchJobService::Operations (readonly)

Get the associated client for long-running operations.

Returns:



186
187
188
 
# File 'lib/google/ads/google_ads/v17/services/batch_job_service/client.rb', line 186

def operations_client
  @operations_client
end

Class Method Details

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

Configure the BatchJobService Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/google/ads/google_ads/v17/services/batch_job_service/client.rb', line 63

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

#add_batch_job_operations(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::AddBatchJobOperationsResponse #add_batch_job_operations(resource_name: nil, sequence_token: nil, mutate_operations: nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::AddBatchJobOperationsResponse

Add operations to the batch job.

List of thrown errors:

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

Examples:

Basic example

require "google/ads/google_ads/v17/services"

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

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

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

# The returned object is of type Google::Ads::GoogleAds::V17::Services::AddBatchJobOperationsResponse.
p result

Overloads:

  • #add_batch_job_operations(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::AddBatchJobOperationsResponse

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

    Parameters:

    • request (::Google::Ads::GoogleAds::V17::Services::AddBatchJobOperationsRequest, ::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.

  • #add_batch_job_operations(resource_name: nil, sequence_token: nil, mutate_operations: nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::AddBatchJobOperationsResponse

    Pass arguments to ‘add_batch_job_operations` 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 batch job.

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

      A token used to enforce sequencing.

      The first AddBatchJobOperations request for a batch job should not set sequence_token. Subsequent requests must set sequence_token to the value of next_sequence_token received in the previous AddBatchJobOperations response.

    • mutate_operations (::Array<::Google::Ads::GoogleAds::V17::Services::MutateOperation, ::Hash>) (defaults to: nil) —

      Required. The list of mutates being added.

      Operations can use negative integers as temp ids to signify dependencies between entities created in this batch job. For example, a customer with id = 1234 can create a campaign and an ad group in that same campaign by creating a campaign in the first operation with the resource name explicitly set to “customers/1234/campaigns/-1”, and creating an ad group in the second operation with the campaign field also set to “customers/1234/campaigns/-1”.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
 
# File 'lib/google/ads/google_ads/v17/services/batch_job_service/client.rb', line 592

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

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V17::Services::AddBatchJobOperationsRequest

  # 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.add_batch_job_operations.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Ads::GoogleAds::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.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.add_batch_job_operations.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.add_batch_job_operations.retry_policy

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

  @batch_job_service_stub.call_rpc :add_batch_job_operations, request,
                                   options: options do |response, operation|
    yield response, operation if block_given?
  end
  # rescue GRPC::BadStatus => grpc_error
  #  raise Google::Ads::GoogleAds::Error.new grpc_error.message
end

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

Configure the BatchJobService 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:



93
94
95
96
 
# File 'lib/google/ads/google_ads/v17/services/batch_job_service/client.rb', line 93

def configure
  yield @config if block_given?
  @config
end

#list_batch_job_results(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Ads::GoogleAds::V17::Services::BatchJobResult> #list_batch_job_results(resource_name: nil, page_token: nil, page_size: nil, response_content_type: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Ads::GoogleAds::V17::Services::BatchJobResult>

Returns the results of the batch job. The job must be done. Supports standard list paging.

List of thrown errors:

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

Examples:

Basic example

require "google/ads/google_ads/v17/services"

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

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

# Call the list_batch_job_results method.
result = client.list_batch_job_results 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::Ads::GoogleAds::V17::Services::BatchJobResult.
  p item
end

Overloads:

  • #list_batch_job_results(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Ads::GoogleAds::V17::Services::BatchJobResult>

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

    Parameters:

    • request (::Google::Ads::GoogleAds::V17::Services::ListBatchJobResultsRequest, ::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_batch_job_results(resource_name: nil, page_token: nil, page_size: nil, response_content_type: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Ads::GoogleAds::V17::Services::BatchJobResult>

    Pass arguments to ‘list_batch_job_results` 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 batch job whose results are being listed.

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

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/google/ads/google_ads/v17/services/batch_job_service/client.rb', line 367

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

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V17::Services::ListBatchJobResultsRequest

  # 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_batch_job_results.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Ads::GoogleAds::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.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_batch_job_results.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_batch_job_results.retry_policy

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

  @batch_job_service_stub.call_rpc :list_batch_job_results, request,
                                   options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @batch_job_service_stub, :list_batch_job_results, request,
                                            response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
  # rescue GRPC::BadStatus => grpc_error
  #  raise Google::Ads::GoogleAds::Error.new grpc_error.message
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


193
194
195
 
# File 'lib/google/ads/google_ads/v17/services/batch_job_service/client.rb', line 193

def logger
  @batch_job_service_stub.logger
end

#mutate_batch_job(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::MutateBatchJobResponse #mutate_batch_job(customer_id: nil, operation: nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::MutateBatchJobResponse

Mutates a batch job.

List of thrown errors:

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

Examples:

Basic example

require "google/ads/google_ads/v17/services"

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

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

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

# The returned object is of type Google::Ads::GoogleAds::V17::Services::MutateBatchJobResponse.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
290
291
292
293
294
 
# File 'lib/google/ads/google_ads/v17/services/batch_job_service/client.rb', line 254

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

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V17::Services::MutateBatchJobRequest

  # 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_batch_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Ads::GoogleAds::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.customer_id
    header_params["customer_id"] = request.customer_id
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @batch_job_service_stub.call_rpc :mutate_batch_job, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
  # rescue GRPC::BadStatus => grpc_error
  #  raise Google::Ads::GoogleAds::Error.new grpc_error.message
end

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

Runs the batch job.

The Operation.metadata field type is BatchJobMetadata. When finished, the long running operation will not contain errors or a response. Instead, use ListBatchJobResults to get the results of the job.

List of thrown errors:

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

Examples:

Basic example

require "google/ads/google_ads/v17/services"

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

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

# Call the run_batch_job method.
result = client.run_batch_job 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:

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

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

    Parameters:

    • request (::Google::Ads::GoogleAds::V17::Services::RunBatchJobRequest, ::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.

  • #run_batch_job(resource_name: nil) ⇒ ::Gapic::Operation

    Pass arguments to ‘run_batch_job` 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 BatchJob to run.

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.



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
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
 
# File 'lib/google/ads/google_ads/v17/services/batch_job_service/client.rb', line 477

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

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V17::Services::RunBatchJobRequest

  # 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.run_batch_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Ads::GoogleAds::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.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.run_batch_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.run_batch_job.retry_policy

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

  @batch_job_service_stub.call_rpc :run_batch_job, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
  # rescue GRPC::BadStatus => grpc_error
  #  raise Google::Ads::GoogleAds::Error.new grpc_error.message
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


103
104
105
 
# File 'lib/google/ads/google_ads/v17/services/batch_job_service/client.rb', line 103

def universe_domain
  @batch_job_service_stub.universe_domain
end