Class: Google::Ads::GoogleAds::V16::Services::OfflineUserDataJobService::Client

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

Overview

Client for the OfflineUserDataJobService service.

Service to manage offline user data jobs.

Defined Under Namespace

Classes: Configuration

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"googleads.$UNIVERSE_DOMAIN$"

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#offline_user_data_job_path

Constructor Details

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

Create a new OfflineUserDataJobService client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the OfflineUserDataJobService client.

Yield Parameters:



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
158
159
160
161
162
163
164
165
 
# File 'lib/google/ads/google_ads/v16/services/offline_user_data_job_service/client.rb', line 120

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/v16/services/offline_user_data_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

  @offline_user_data_job_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Ads::GoogleAds::V16::Services::OfflineUserDataJobService::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
  )
end

Instance Attribute Details

#offline_user_data_job_service_stub ⇒ Object (readonly) 



40
41
42
 
# File 'lib/google/ads/google_ads/v16/services/offline_user_data_job_service/client.rb', line 40

def offline_user_data_job_service_stub
  @offline_user_data_job_service_stub
end

#operations_client ⇒ ::Google::Ads::GoogleAds::V16::Services::OfflineUserDataJobService::Operations (readonly)

Get the associated client for long-running operations.

Returns:



172
173
174
 
# File 'lib/google/ads/google_ads/v16/services/offline_user_data_job_service/client.rb', line 172

def operations_client
  @operations_client
end

Class Method Details

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

Configure the OfflineUserDataJobService Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/google/ads/google_ads/v16/services/offline_user_data_job_service/client.rb', line 60

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_offline_user_data_job_operations(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V16::Services::AddOfflineUserDataJobOperationsResponse #add_offline_user_data_job_operations(resource_name: nil, enable_partial_failure: nil, enable_warnings: nil, operations: nil, validate_only: nil) ⇒ ::Google::Ads::GoogleAds::V16::Services::AddOfflineUserDataJobOperationsResponse

Adds operations to the offline user data job.

List of thrown errors:

[AuthenticationError]()
[AuthorizationError]()
[DatabaseError]()
[FieldError]()
[HeaderError]()
[InternalError]()
[MutateError]()
[OfflineUserDataJobError]()
[QuotaError]()
[RequestError]()

Examples:

Basic example

require "google/ads/google_ads/v16/services"

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

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

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

# The returned object is of type Google::Ads::GoogleAds::V16::Services::AddOfflineUserDataJobOperationsResponse.
p result

Overloads:

  • #add_offline_user_data_job_operations(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V16::Services::AddOfflineUserDataJobOperationsResponse

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

    Parameters:

    • request (::Google::Ads::GoogleAds::V16::Services::AddOfflineUserDataJobOperationsRequest, ::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_offline_user_data_job_operations(resource_name: nil, enable_partial_failure: nil, enable_warnings: nil, operations: nil, validate_only: nil) ⇒ ::Google::Ads::GoogleAds::V16::Services::AddOfflineUserDataJobOperationsResponse

    Pass arguments to ‘add_offline_user_data_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 OfflineUserDataJob.

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

      True to enable partial failure for the offline user data job.

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

      True to enable warnings for the offline user data job. When enabled, a warning will not block the OfflineUserDataJobOperation, and will also return warning messages about malformed field values.

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

      Required. The list of operations to be done.

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



351
352
353
354
355
356
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
 
# File 'lib/google/ads/google_ads/v16/services/offline_user_data_job_service/client.rb', line 351

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

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V16::Services::AddOfflineUserDataJobOperationsRequest

  # 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_offline_user_data_job_operations.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.add_offline_user_data_job_operations.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.add_offline_user_data_job_operations.retry_policy

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

  @offline_user_data_job_service_stub.call_rpc :add_offline_user_data_job_operations, 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

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

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



90
91
92
93
 
# File 'lib/google/ads/google_ads/v16/services/offline_user_data_job_service/client.rb', line 90

def configure
  yield @config if block_given?
  @config
end

#create_offline_user_data_job(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V16::Services::CreateOfflineUserDataJobResponse #create_offline_user_data_job(customer_id: nil, job: nil, validate_only: nil, enable_match_rate_range_preview: nil) ⇒ ::Google::Ads::GoogleAds::V16::Services::CreateOfflineUserDataJobResponse

Creates an offline user data job.

List of thrown errors:

[AuthenticationError]()
[AuthorizationError]()
[DatabaseError]()
[FieldError]()
[HeaderError]()
[InternalError]()
[NotAllowlistedError]()
[OfflineUserDataJobError]()
[QuotaError]()
[RequestError]()

Examples:

Basic example

require "google/ads/google_ads/v16/services"

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

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

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

# The returned object is of type Google::Ads::GoogleAds::V16::Services::CreateOfflineUserDataJobResponse.
p result

Overloads:

  • #create_offline_user_data_job(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V16::Services::CreateOfflineUserDataJobResponse

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

    Parameters:

    • request (::Google::Ads::GoogleAds::V16::Services::CreateOfflineUserDataJobRequest, ::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_offline_user_data_job(customer_id: nil, job: nil, validate_only: nil, enable_match_rate_range_preview: nil) ⇒ ::Google::Ads::GoogleAds::V16::Services::CreateOfflineUserDataJobResponse

    Pass arguments to ‘create_offline_user_data_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:

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

      Required. The ID of the customer for which to create an offline user data job.

    • job (::Google::Ads::GoogleAds::V16::Resources::OfflineUserDataJob, ::Hash) (defaults to: nil) —

      Required. The offline user data job to be created.

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

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

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

      If true, match rate range for the offline user data job is calculated and made available in the resource.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



241
242
243
244
245
246
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
 
# File 'lib/google/ads/google_ads/v16/services/offline_user_data_job_service/client.rb', line 241

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

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V16::Services::CreateOfflineUserDataJobRequest

  # 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_offline_user_data_job.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_offline_user_data_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_offline_user_data_job.retry_policy

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

  @offline_user_data_job_service_stub.call_rpc :create_offline_user_data_job, 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

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

Runs the offline user data job.

When finished, the long running operation will contain the processing result or failure information, if any.

List of thrown errors:

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

Examples:

Basic example

require "google/ads/google_ads/v16/services"

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

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

# Call the run_offline_user_data_job method.
result = client.run_offline_user_data_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_offline_user_data_job(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Ads::GoogleAds::V16::Services::RunOfflineUserDataJobRequest, ::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_offline_user_data_job(resource_name: nil, validate_only: nil) ⇒ ::Gapic::Operation

    Pass arguments to ‘run_offline_user_data_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 OfflineUserDataJob to run.

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



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
503
 
# File 'lib/google/ads/google_ads/v16/services/offline_user_data_job_service/client.rb', line 461

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

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V16::Services::RunOfflineUserDataJobRequest

  # 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_offline_user_data_job.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.run_offline_user_data_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.run_offline_user_data_job.retry_policy

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

  @offline_user_data_job_service_stub.call_rpc :run_offline_user_data_job, 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

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


100
101
102
 
# File 'lib/google/ads/google_ads/v16/services/offline_user_data_job_service/client.rb', line 100

def universe_domain
  @offline_user_data_job_service_stub.universe_domain
end