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

Client for the ConversionUploadService service.

Service to upload conversions.

Attributes

conversion_upload_service_stub[R]

@private

Public Class Methods

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

Configure the ConversionUploadService Client class.

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

## Example

To modify the configuration for all ConversionUploadService clients:

::Google::Ads::GoogleAds::V7::Services::ConversionUploadService::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/conversion_upload_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 ConversionUploadService client object.

## Examples

To create a new ConversionUploadService client with the default configuration:

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

To create a new ConversionUploadService client with a custom configuration:

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

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

# File lib/google/ads/google_ads/v7/services/conversion_upload_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/conversion_upload_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

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

Public Instance Methods

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

Configure the ConversionUploadService 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::ConversionUploadService::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/conversion_upload_service/client.rb, line 91
def configure
  yield @config if block_given?
  @config
end
upload_call_conversions(request, options = nil) { |response, operation| ... } click to toggle source

Processes the given call conversions.

List of thrown errors:

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

@overload upload_call_conversions(request, options = nil)

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

@param request [::Google::Ads::GoogleAds::V7::Services::UploadCallConversionsRequest, ::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 upload_call_conversions(customer_id: nil, conversions: nil, partial_failure: nil, validate_only: nil)

Pass arguments to `upload_call_conversions` 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 performing the upload.
@param conversions [::Array<::Google::Ads::GoogleAds::V7::Services::CallConversion, ::Hash>]
  Required. The conversions that are being uploaded.
@param partial_failure [::Boolean]
  Required. 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.
  This should always be set to true.
  See
  https://developers.google.com/google-ads/api/docs/best-practices/partial-failures
  for more information about partial failure.
@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::UploadCallConversionsResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

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

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

# File lib/google/ads/google_ads/v7/services/conversion_upload_service/client.rb, line 297
def upload_call_conversions request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V7::Services::UploadCallConversionsRequest

  # 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.upload_call_conversions.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.upload_call_conversions.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.upload_call_conversions.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @conversion_upload_service_stub.call_rpc :upload_call_conversions, 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
upload_click_conversions(request, options = nil) { |response, operation| ... } click to toggle source

Processes the given click conversions.

List of thrown errors:

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

@overload upload_click_conversions(request, options = nil)

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

@param request [::Google::Ads::GoogleAds::V7::Services::UploadClickConversionsRequest, ::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 upload_click_conversions(customer_id: nil, conversions: nil, partial_failure: nil, validate_only: nil)

Pass arguments to `upload_click_conversions` 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 performing the upload.
@param conversions [::Array<::Google::Ads::GoogleAds::V7::Services::ClickConversion, ::Hash>]
  Required. The conversions that are being uploaded.
@param partial_failure [::Boolean]
  Required. 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.
  This should always be set to true.
  See
  https://developers.google.com/google-ads/api/docs/best-practices/partial-failures
  for more information about partial failure.
@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::UploadClickConversionsResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

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

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

# File lib/google/ads/google_ads/v7/services/conversion_upload_service/client.rb, line 207
def upload_click_conversions request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V7::Services::UploadClickConversionsRequest

  # 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.upload_click_conversions.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.upload_click_conversions.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.upload_click_conversions.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @conversion_upload_service_stub.call_rpc :upload_click_conversions, 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