Class: Google::Ads::GoogleAds::V15::Services::BatchJobService::Client
- Inherits:
-
Object
- Object
- Google::Ads::GoogleAds::V15::Services::BatchJobService::Client
- Includes:
- Paths
- Defined in:
- lib/google/ads/google_ads/v15/services/batch_job_service/client.rb
Overview
Client for the BatchJobService service.
Service to manage batch jobs.
Defined Under Namespace
Classes: Configuration
Instance Attribute Summary collapse
- #batch_job_service_stub ⇒ Object readonly
-
#operations_client ⇒ ::Google::Ads::GoogleAds::V15::Services::BatchJobService::Operations
readonly
Get the associated client for long-running operations.
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the BatchJobService Client class.
Instance Method Summary collapse
-
#add_batch_job_operations(request, options = nil) {|response, operation| ... } ⇒ ::Google::Ads::GoogleAds::V15::Services::AddBatchJobOperationsResponse
Add operations to the batch job.
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the BatchJobService Client instance.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new BatchJobService client object.
-
#list_batch_job_results(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Ads::GoogleAds::V15::Services::BatchJobResult>
Returns the results of the batch job.
-
#mutate_batch_job(request, options = nil) {|response, operation| ... } ⇒ ::Google::Ads::GoogleAds::V15::Services::MutateBatchJobResponse
Mutates a batch job.
-
#run_batch_job(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Runs the batch job.
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, #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, #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, #label_path, #language_constant_path, #mobile_app_category_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.
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 149 |
# File 'lib/google/ads/google_ads/v15/services/batch_job_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/v15/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 == 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 @batch_job_service_stub = ::Gapic::ServiceStub.new( ::Google::Ads::GoogleAds::V15::Services::BatchJobService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors, channel_pool_config: @config.channel_pool ) end |
Instance Attribute Details
#batch_job_service_stub ⇒ Object (readonly)
37 38 39 |
# File 'lib/google/ads/google_ads/v15/services/batch_job_service/client.rb', line 37 def batch_job_service_stub @batch_job_service_stub end |
#operations_client ⇒ ::Google::Ads::GoogleAds::V15::Services::BatchJobService::Operations (readonly)
Get the associated client for long-running operations.
156 157 158 |
# File 'lib/google/ads/google_ads/v15/services/batch_job_service/client.rb', line 156 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.
57 58 59 60 61 62 63 64 65 66 67 68 69 70 |
# File 'lib/google/ads/google_ads/v15/services/batch_job_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
#add_batch_job_operations(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V15::Services::AddBatchJobOperationsResponse #add_batch_job_operations(resource_name: nil, sequence_token: nil, mutate_operations: nil) ⇒ ::Google::Ads::GoogleAds::V15::Services::AddBatchJobOperationsResponse
Add operations to the batch job.
List of thrown errors:
[AuthenticationError]()
[AuthorizationError]()
[BatchJobError]()
[HeaderError]()
[InternalError]()
[QuotaError]()
[RequestError]()
[ResourceCountLimitExceededError]()
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 582 583 584 585 586 587 588 589 590 591 592 |
# File 'lib/google/ads/google_ads/v15/services/batch_job_service/client.rb', line 551 def add_batch_job_operations request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V15::Services::AddBatchJobOperationsRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.add_batch_job_operations..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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 [:"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("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.add_batch_job_operations.timeout, metadata: , retry_policy: @config.rpcs.add_batch_job_operations.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @batch_job_service_stub.call_rpc :add_batch_job_operations, request, 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 |
#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.
87 88 89 90 |
# File 'lib/google/ads/google_ads/v15/services/batch_job_service/client.rb', line 87 def configure yield @config if block_given? @config end |
#list_batch_job_results(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Ads::GoogleAds::V15::Services::BatchJobResult> #list_batch_job_results(resource_name: nil, page_token: nil, page_size: nil, response_content_type: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Ads::GoogleAds::V15::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]()
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 364 365 366 367 368 369 370 371 |
# File 'lib/google/ads/google_ads/v15/services/batch_job_service/client.rb', line 328 def list_batch_job_results request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V15::Services::ListBatchJobResultsRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.list_batch_job_results..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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 [:"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("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.list_batch_job_results.timeout, metadata: , retry_policy: @config.rpcs.list_batch_job_results.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @batch_job_service_stub.call_rpc :list_batch_job_results, request, options: do |response, operation| response = ::Gapic::PagedEnumerable.new @batch_job_service_stub, :list_batch_job_results, request, 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 |
#mutate_batch_job(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V15::Services::MutateBatchJobResponse #mutate_batch_job(customer_id: nil, operation: nil) ⇒ ::Google::Ads::GoogleAds::V15::Services::MutateBatchJobResponse
Mutates a batch job.
List of thrown errors:
[AuthenticationError]()
[AuthorizationError]()
[HeaderError]()
[InternalError]()
[QuotaError]()
[RequestError]()
[ResourceCountLimitExceededError]()
215 216 217 218 219 220 221 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 |
# File 'lib/google/ads/google_ads/v15/services/batch_job_service/client.rb', line 215 def mutate_batch_job request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V15::Services::MutateBatchJobRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.mutate_batch_job..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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 [:"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("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.mutate_batch_job.timeout, metadata: , retry_policy: @config.rpcs.mutate_batch_job.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @batch_job_service_stub.call_rpc :mutate_batch_job, request, 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 |
#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]()
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 478 |
# File 'lib/google/ads/google_ads/v15/services/batch_job_service/client.rb', line 437 def run_batch_job request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V15::Services::RunBatchJobRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.run_batch_job..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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 [:"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("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.run_batch_job.timeout, metadata: , retry_policy: @config.rpcs.run_batch_job.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @batch_job_service_stub.call_rpc :run_batch_job, request, options: do |response, operation| response = ::Gapic::Operation.new response, @operations_client, 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 |