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

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

Overview

Client for the ConversionUploadService service.

Service to upload conversions.

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

#conversion_custom_variable_path

Constructor Details

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

Create a new ConversionUploadService client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the ConversionUploadService 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
 
# File 'lib/google/ads/google_ads/v17/services/conversion_upload_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/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 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

  @conversion_upload_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Ads::GoogleAds::V17::Services::ConversionUploadService::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

#conversion_upload_service_stub ⇒ Object (readonly) 



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

def conversion_upload_service_stub
  @conversion_upload_service_stub
end

Class Method Details

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

Configure the ConversionUploadService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all ConversionUploadService clients
::Google::Ads::GoogleAds::V17::Services::ConversionUploadService::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/conversion_upload_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

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

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 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/conversion_upload_service/client.rb', line 93

def configure
  yield @config if block_given?
  @config
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


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

def universe_domain
  @conversion_upload_service_stub.universe_domain
end

#upload_call_conversions(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::UploadCallConversionsResponse #upload_call_conversions(customer_id: nil, conversions: nil, partial_failure: nil, validate_only: nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::UploadCallConversionsResponse

Processes the given call conversions.

List of thrown errors:

[AuthenticationError]()
[AuthorizationError]()
[HeaderError]()
[InternalError]()
[PartialFailureError]()
[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::ConversionUploadService::Client.new

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

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

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

Overloads:

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

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

    Parameters:

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

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #upload_call_conversions(customer_id: nil, conversions: nil, partial_failure: nil, validate_only: nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::UploadCallConversionsResponse

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

    Parameters:

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

      Required. The ID of the customer performing the upload.

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

      Required. The conversions that are being uploaded.

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

      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 developers.google.com/google-ads/api/docs/best-practices/partial-failures for more information about partial failure.

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



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
 
# File 'lib/google/ads/google_ads/v17/services/conversion_upload_service/client.rb', line 367

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

  options.apply_defaults timeout:      @config.timeout,
                         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) ⇒ ::Google::Ads::GoogleAds::V17::Services::UploadClickConversionsResponse #upload_click_conversions(customer_id: nil, conversions: nil, partial_failure: nil, validate_only: nil, debug_enabled: nil, job_id: nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::UploadClickConversionsResponse

Processes the given click conversions.

List of thrown errors:

[AuthenticationError]()
[AuthorizationError]()
[ConversionUploadError]()
[HeaderError]()
[InternalError]()
[PartialFailureError]()
[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::ConversionUploadService::Client.new

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

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

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

Overloads:

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

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

    Parameters:

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

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #upload_click_conversions(customer_id: nil, conversions: nil, partial_failure: nil, validate_only: nil, debug_enabled: nil, job_id: nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::UploadClickConversionsResponse

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

    Parameters:

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

      Required. The ID of the customer performing the upload.

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

      Required. The conversions that are being uploaded.

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

      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 developers.google.com/google-ads/api/docs/best-practices/partial-failures for more information about partial failure.

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

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

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

      If true, the API will perform all upload checks and return errors if any are found. If false, it will perform only basic input validation, skip subsequent upload checks, and return success even if no click was found for the provided ‘user_identifiers`.

      This setting only affects Enhanced conversions for leads uploads that use ‘user_identifiers` instead of `GCLID`, `GBRAID`, or `WBRAID`. When uploading enhanced conversions for leads, you should upload all conversion events to the API, including those that may not come from Google Ads campaigns. The upload of an event that is not from a Google Ads campaign will result in a `CLICK_NOT_FOUND` error if this field is set to `true`. Since these errors are expected for such events, set this field to `false` so you can confirm your uploads are properly formatted but ignore `CLICK_NOT_FOUND` errors from all of the conversions that are not from a Google Ads campaign. This will allow you to focus only on errors that you can address.

      Default is false.

    • job_id (::Integer) (defaults to: nil) —

      Optional. Optional input to set job ID. Must be a non-negative number that is less than 2^31 if provided. If this field is not provided, the API will generate a job ID in the range [2^31, (2^63)-1]. The API will return the value for this request in the ‘job_id` field of the `UploadClickConversionsResponse`.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
295
296
297
298
299
 
# File 'lib/google/ads/google_ads/v17/services/conversion_upload_service/client.rb', line 257

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

  options.apply_defaults timeout:      @config.timeout,
                         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