class Google::Ads::GoogleAds::V7::Services::OfflineUserDataJobService::Client

Client for the OfflineUserDataJobService service.

Service to manage offline user data jobs.

Attributes

offline_user_data_job_service_stub[R]

@private

operations_client[R]

Get the associated client for long-running operations.

@return [::Google::Ads::GoogleAds::V7::Services::OfflineUserDataJobService::Operations]

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the OfflineUserDataJobService Client class.

See {::Google::Ads::GoogleAds::V7::Services::OfflineUserDataJobService::Client::Configuration} for a description of the configuration fields.

## Example

To modify the configuration for all OfflineUserDataJobService clients:

::Google::Ads::GoogleAds::V7::Services::OfflineUserDataJobService::Client.configure do |config|
  config.timeout = 10.0
end

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/ads/google_ads/v7/services/offline_user_data_job_service/client.rb, line 58
def self.configure
  @configure ||= begin
    default_config = Client::Configuration.new

    default_config.timeout = 3600.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
new() { |config| ... } click to toggle source

Create a new OfflineUserDataJobService client object.

## Examples

To create a new OfflineUserDataJobService client with the default configuration:

client = ::Google::Ads::GoogleAds::V7::Services::OfflineUserDataJobService::Client.new

To create a new OfflineUserDataJobService client with a custom configuration:

client = ::Google::Ads::GoogleAds::V7::Services::OfflineUserDataJobService::Client.new do |config|
  config.timeout = 10.0
end

@yield [config] Configure the OfflineUserDataJobService client. @yieldparam config [Client::Configuration]

# File lib/google/ads/google_ads/v7/services/offline_user_data_job_service/client.rb, line 116
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/v7/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 scope and endpoint are unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.scope == Client.configure.scope &&
                           @config.endpoint == Client.configure.endpoint &&
                           !@config.endpoint.split(".").first.include?("-")
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(String) || credentials.is_a?(Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

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

  @offline_user_data_job_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Ads::GoogleAds::V7::Services::OfflineUserDataJobService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Public Instance Methods

add_offline_user_data_job_operations(request, options = nil) { |response, operation| ... } click to toggle source

Adds operations to the offline user data job.

List of thrown errors:

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

@overload add_offline_user_data_job_operations(request, options = nil)

Pass arguments to `add_offline_user_data_job_operations` via a request object, either of type
{::Google::Ads::GoogleAds::V7::Services::AddOfflineUserDataJobOperationsRequest} or an equivalent Hash.

@param request [::Google::Ads::GoogleAds::V7::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload add_offline_user_data_job_operations(resource_name: nil, enable_partial_failure: nil, operations: nil, validate_only: nil)

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

@param resource_name [::String]
  Required. The resource name of the OfflineUserDataJob.
@param enable_partial_failure [::Boolean]
  True to enable partial failure for the offline user data job.
@param operations [::Array<::Google::Ads::GoogleAds::V7::Services::OfflineUserDataJobOperation, ::Hash>]
  Required. The list of operations to be done.
@param validate_only [::Boolean]
  If true, the request is validated but not executed. Only errors are
  returned, not results.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Ads::GoogleAds::V7::Services::AddOfflineUserDataJobOperationsResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Ads::GoogleAds::V7::Services::AddOfflineUserDataJobOperationsResponse]

@raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.

# File lib/google/ads/google_ads/v7/services/offline_user_data_job_service/client.rb, line 376
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::V7::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 = {
    "resource_name" => request.resource_name
  }
  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 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| ... } click to toggle source

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 {Client.configure}.

See {::Google::Ads::GoogleAds::V7::Services::OfflineUserDataJobService::Client::Configuration} for a description of the configuration fields.

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/ads/google_ads/v7/services/offline_user_data_job_service/client.rb, line 91
def configure
  yield @config if block_given?
  @config
end
create_offline_user_data_job(request, options = nil) { |response, operation| ... } click to toggle source

Creates an offline user data job.

List of thrown errors:

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

@overload create_offline_user_data_job(request, options = nil)

Pass arguments to `create_offline_user_data_job` via a request object, either of type
{::Google::Ads::GoogleAds::V7::Services::CreateOfflineUserDataJobRequest} or an equivalent Hash.

@param request [::Google::Ads::GoogleAds::V7::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload create_offline_user_data_job(customer_id: nil, job: nil, validate_only: nil)

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

@param customer_id [::String]
  Required. The ID of the customer for which to create an offline user data job.
@param job [::Google::Ads::GoogleAds::V7::Resources::OfflineUserDataJob, ::Hash]
  Required. The offline user data job to be created.
@param validate_only [::Boolean]
  If true, the request is validated but not executed. Only errors are
  returned, not results.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Ads::GoogleAds::V7::Services::CreateOfflineUserDataJobResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Ads::GoogleAds::V7::Services::CreateOfflineUserDataJobResponse]

@raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.

# File lib/google/ads/google_ads/v7/services/offline_user_data_job_service/client.rb, line 213
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::V7::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 = {
    "customer_id" => request.customer_id
  }
  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 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
get_offline_user_data_job(request, options = nil) { |response, operation| ... } click to toggle source

Returns the offline user data job.

List of thrown errors:

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

@overload get_offline_user_data_job(request, options = nil)

Pass arguments to `get_offline_user_data_job` via a request object, either of type
{::Google::Ads::GoogleAds::V7::Services::GetOfflineUserDataJobRequest} or an equivalent Hash.

@param request [::Google::Ads::GoogleAds::V7::Services::GetOfflineUserDataJobRequest, ::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload get_offline_user_data_job(resource_name: nil)

Pass arguments to `get_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).

@param resource_name [::String]
  Required. The resource name of the OfflineUserDataJob to get.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Ads::GoogleAds::V7::Resources::OfflineUserDataJob] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Ads::GoogleAds::V7::Resources::OfflineUserDataJob]

@raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.

# File lib/google/ads/google_ads/v7/services/offline_user_data_job_service/client.rb, line 289
def get_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::V7::Services::GetOfflineUserDataJobRequest

  # 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.get_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 = {
    "resource_name" => request.resource_name
  }
  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.get_offline_user_data_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_offline_user_data_job.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @offline_user_data_job_service_stub.call_rpc :get_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) { |response, operation| ... } click to toggle source

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

@overload run_offline_user_data_job(request, options = nil)

Pass arguments to `run_offline_user_data_job` via a request object, either of type
{::Google::Ads::GoogleAds::V7::Services::RunOfflineUserDataJobRequest} or an equivalent Hash.

@param request [::Google::Ads::GoogleAds::V7::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload run_offline_user_data_job(resource_name: nil, validate_only: nil)

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

@param resource_name [::String]
  Required. The resource name of the OfflineUserDataJob to run.
@param validate_only [::Boolean]
  If true, the request is validated but not executed. Only errors are
  returned, not results.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::Operation]

@raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.

# File lib/google/ads/google_ads/v7/services/offline_user_data_job_service/client.rb, line 460
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::V7::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 = {
    "resource_name" => request.resource_name
  }
  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 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