Class: Google::Shopping::Merchant::Conversions::V1beta::ConversionSourcesService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/shopping/merchant/conversions/v1beta/conversion_sources_service/client.rb

Overview

Client for the ConversionSourcesService service.

Service for managing conversion sources for a merchant account.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#account_path, #conversion_source_path

Constructor Details

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

Create a new ConversionSourcesService client object.

Examples:


# Create a client using the default configuration
client = ::Google::Shopping::Merchant::Conversions::V1beta::ConversionSourcesService::Client.new

# Create a client using a custom configuration
client = ::Google::Shopping::Merchant::Conversions::V1beta::ConversionSourcesService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the ConversionSourcesService client.

Yield Parameters:



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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/google/shopping/merchant/conversions/v1beta/conversion_sources_service/client.rb', line 130

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/shopping/merchant/conversions/v1beta/conversionsources_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_sources_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Shopping::Merchant::Conversions::V1beta::ConversionSourcesService::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,
    logger: @config.logger
  )

  @conversion_sources_service_stub.stub_logger&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end
end

Class Method Details

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

Configure the ConversionSourcesService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all ConversionSourcesService clients
::Google::Shopping::Merchant::Conversions::V1beta::ConversionSourcesService::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
77
78
79
80
81
82
83
 
# File 'lib/google/shopping/merchant/conversions/v1beta/conversion_sources_service/client.rb', line 63

def self.configure
  @configure ||= begin
    namespace = ["Google", "Shopping", "Merchant", "Conversions", "V1beta"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.timeout = 60.0
    default_config.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

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

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



100
101
102
103
 
# File 'lib/google/shopping/merchant/conversions/v1beta/conversion_sources_service/client.rb', line 100

def configure
  yield @config if block_given?
  @config
end

#create_conversion_source(request, options = nil) ⇒ ::Google::Shopping::Merchant::Conversions::V1beta::ConversionSource #create_conversion_source(parent: nil, conversion_source: nil) ⇒ ::Google::Shopping::Merchant::Conversions::V1beta::ConversionSource

Creates a new conversion source.

Examples:

Basic example

require "google/shopping/merchant/conversions/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Shopping::Merchant::Conversions::V1beta::ConversionSourcesService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Shopping::Merchant::Conversions::V1beta::CreateConversionSourceRequest.new

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

# The returned object is of type Google::Shopping::Merchant::Conversions::V1beta::ConversionSource.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



240
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
 
# File 'lib/google/shopping/merchant/conversions/v1beta/conversion_sources_service/client.rb', line 240

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Conversions::V1beta::CreateConversionSourceRequest

  # 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_conversion_source.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::Shopping::Merchant::Conversions::V1beta::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.parent
    header_params["parent"] = request.parent
  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_conversion_source.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_conversion_source.retry_policy

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

  @conversion_sources_service_stub.call_rpc :create_conversion_source, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_conversion_source(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_conversion_source(name: nil) ⇒ ::Google::Protobuf::Empty

Archives an existing conversion source. If the conversion source is a Merchant Center Destination, it will be recoverable for 30 days. If the conversion source is a Google Analytics Link, it will be deleted immediately and can be restored by creating a new one.

Examples:

Basic example

require "google/shopping/merchant/conversions/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Shopping::Merchant::Conversions::V1beta::ConversionSourcesService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Shopping::Merchant::Conversions::V1beta::DeleteConversionSourceRequest.new

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

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #delete_conversion_source(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_conversion_source via a request object, either of type DeleteConversionSourceRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Shopping::Merchant::Conversions::V1beta::DeleteConversionSourceRequest, ::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.

  • #delete_conversion_source(name: nil) ⇒ ::Google::Protobuf::Empty

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

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

      Required. The name of the conversion source to be deleted. Format: accounts/{account}/conversionSources/{conversion_source}

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
 
# File 'lib/google/shopping/merchant/conversions/v1beta/conversion_sources_service/client.rb', line 418

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Conversions::V1beta::DeleteConversionSourceRequest

  # 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.delete_conversion_source.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::Shopping::Merchant::Conversions::V1beta::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.name
    header_params["name"] = request.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.delete_conversion_source.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_conversion_source.retry_policy

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

  @conversion_sources_service_stub.call_rpc :delete_conversion_source, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_conversion_source(request, options = nil) ⇒ ::Google::Shopping::Merchant::Conversions::V1beta::ConversionSource #get_conversion_source(name: nil) ⇒ ::Google::Shopping::Merchant::Conversions::V1beta::ConversionSource

Fetches a conversion source.

Examples:

Basic example

require "google/shopping/merchant/conversions/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Shopping::Merchant::Conversions::V1beta::ConversionSourcesService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Shopping::Merchant::Conversions::V1beta::GetConversionSourceRequest.new

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

# The returned object is of type Google::Shopping::Merchant::Conversions::V1beta::ConversionSource.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
 
# File 'lib/google/shopping/merchant/conversions/v1beta/conversion_sources_service/client.rb', line 591

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Conversions::V1beta::GetConversionSourceRequest

  # 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_conversion_source.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::Shopping::Merchant::Conversions::V1beta::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.name
    header_params["name"] = request.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.get_conversion_source.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_conversion_source.retry_policy

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

  @conversion_sources_service_stub.call_rpc :get_conversion_source, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_conversion_sources(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Shopping::Merchant::Conversions::V1beta::ConversionSource> #list_conversion_sources(parent: nil, page_size: nil, page_token: nil, show_deleted: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Shopping::Merchant::Conversions::V1beta::ConversionSource>

Retrieves the list of conversion sources the caller has access to.

Examples:

Basic example

require "google/shopping/merchant/conversions/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Shopping::Merchant::Conversions::V1beta::ConversionSourcesService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Shopping::Merchant::Conversions::V1beta::ListConversionSourcesRequest.new

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Shopping::Merchant::Conversions::V1beta::ConversionSource.
  p item
end

Overloads:

  • #list_conversion_sources(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Shopping::Merchant::Conversions::V1beta::ConversionSource>

    Pass arguments to list_conversion_sources via a request object, either of type ListConversionSourcesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Shopping::Merchant::Conversions::V1beta::ListConversionSourcesRequest, ::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.

  • #list_conversion_sources(parent: nil, page_size: nil, page_token: nil, show_deleted: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Shopping::Merchant::Conversions::V1beta::ConversionSource>

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

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

      Required. The merchant account who owns the collection of conversion sources. Format: accounts/{account}

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

      Optional. The maximum number of conversion sources to return in a page. If no page_size is specified, 100 is used as the default value. The maximum value is 200. Values above 200 will be coerced to 200. Regardless of pagination, at most 200 conversion sources are returned in total.

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

      Optional. Page token.

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

      Optional. Show deleted (archived) option.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
 
# File 'lib/google/shopping/merchant/conversions/v1beta/conversion_sources_service/client.rb', line 691

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Conversions::V1beta::ListConversionSourcesRequest

  # 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.list_conversion_sources.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::Shopping::Merchant::Conversions::V1beta::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.parent
    header_params["parent"] = request.parent
  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.list_conversion_sources.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_conversion_sources.retry_policy

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

  @conversion_sources_service_stub.call_rpc :list_conversion_sources, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @conversion_sources_service_stub, :list_conversion_sources, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


186
187
188
 
# File 'lib/google/shopping/merchant/conversions/v1beta/conversion_sources_service/client.rb', line 186

def logger
  @conversion_sources_service_stub.logger
end

#undelete_conversion_source(request, options = nil) ⇒ ::Google::Shopping::Merchant::Conversions::V1beta::ConversionSource #undelete_conversion_source(name: nil) ⇒ ::Google::Shopping::Merchant::Conversions::V1beta::ConversionSource

Re-enables an archived conversion source. Only Available for Merchant Center Destination conversion sources.

Examples:

Basic example

require "google/shopping/merchant/conversions/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Shopping::Merchant::Conversions::V1beta::ConversionSourcesService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Shopping::Merchant::Conversions::V1beta::UndeleteConversionSourceRequest.new

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

# The returned object is of type Google::Shopping::Merchant::Conversions::V1beta::ConversionSource.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'lib/google/shopping/merchant/conversions/v1beta/conversion_sources_service/client.rb', line 505

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Conversions::V1beta::UndeleteConversionSourceRequest

  # 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.undelete_conversion_source.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::Shopping::Merchant::Conversions::V1beta::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.name
    header_params["name"] = request.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.undelete_conversion_source.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.undelete_conversion_source.retry_policy

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

  @conversion_sources_service_stub.call_rpc :undelete_conversion_source, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


110
111
112
 
# File 'lib/google/shopping/merchant/conversions/v1beta/conversion_sources_service/client.rb', line 110

def universe_domain
  @conversion_sources_service_stub.universe_domain
end

#update_conversion_source(request, options = nil) ⇒ ::Google::Shopping::Merchant::Conversions::V1beta::ConversionSource #update_conversion_source(conversion_source: nil, update_mask: nil) ⇒ ::Google::Shopping::Merchant::Conversions::V1beta::ConversionSource

Updates information of an existing conversion source. Available only for Merchant Center Destination conversion sources.

Examples:

Basic example

require "google/shopping/merchant/conversions/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Shopping::Merchant::Conversions::V1beta::ConversionSourcesService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Shopping::Merchant::Conversions::V1beta::UpdateConversionSourceRequest.new

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

# The returned object is of type Google::Shopping::Merchant::Conversions::V1beta::ConversionSource.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



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
 
# File 'lib/google/shopping/merchant/conversions/v1beta/conversion_sources_service/client.rb', line 329

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Conversions::V1beta::UpdateConversionSourceRequest

  # 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.update_conversion_source.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::Shopping::Merchant::Conversions::V1beta::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.conversion_source&.name
    header_params["conversion_source.name"] = request.conversion_source.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.update_conversion_source.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_conversion_source.retry_policy

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

  @conversion_sources_service_stub.call_rpc :update_conversion_source, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end