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

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

Overview

REST 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 REST client object.

Examples:


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

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

Yields:

  • (config)

    Configure the ConversionSourcesService client.

Yield Parameters:



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

def initialize
  # 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 = ::Google::Shopping::Merchant::Conversions::V1beta::ConversionSourcesService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials
  )
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::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config)

    Configure the Client client.

Yield Parameters:

Returns:



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
# File 'lib/google/shopping/merchant/conversions/v1beta/conversion_sources_service/rest/client.rb', line 62

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:



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

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::Rest::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:

  • (result, operation)

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
# File 'lib/google/shopping/merchant/conversions/v1beta/conversion_sources_service/rest/client.rb', line 209

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
   = @config.rpcs.create_conversion_source..to_h

  # Set x-goog-api-client and x-goog-user-project headers
  [:"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,
    transports_version_send: [:rest]

  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @conversion_sources_service_stub.create_conversion_source request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation)

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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

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
   = @config.rpcs.delete_conversion_source..to_h

  # Set x-goog-api-client and x-goog-user-project headers
  [:"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,
    transports_version_send: [:rest]

  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @conversion_sources_service_stub.delete_conversion_source request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation)

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
# File 'lib/google/shopping/merchant/conversions/v1beta/conversion_sources_service/rest/client.rb', line 532

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
   = @config.rpcs.get_conversion_source..to_h

  # Set x-goog-api-client and x-goog-user-project headers
  [:"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,
    transports_version_send: [:rest]

  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @conversion_sources_service_stub.get_conversion_source request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_conversion_sources(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Shopping::Merchant::Conversions::V1beta::ConversionSource> #list_conversion_sources(parent: nil, page_size: nil, page_token: nil, show_deleted: nil) ⇒ ::Gapic::Rest::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::Rest::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::Rest::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::Rest::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:

  • (result, operation)

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
# File 'lib/google/shopping/merchant/conversions/v1beta/conversion_sources_service/rest/client.rb', line 625

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
   = @config.rpcs.list_conversion_sources..to_h

  # Set x-goog-api-client and x-goog-user-project headers
  [:"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,
    transports_version_send: [:rest]

  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @conversion_sources_service_stub.list_conversion_sources request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @conversion_sources_service_stub, :list_conversion_sources, "conversion_sources", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
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::Rest::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:

  • (result, operation)

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



453
454
455
456
457
458
459
460
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
# File 'lib/google/shopping/merchant/conversions/v1beta/conversion_sources_service/rest/client.rb', line 453

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
   = @config.rpcs.undelete_conversion_source..to_h

  # Set x-goog-api-client and x-goog-user-project headers
  [:"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,
    transports_version_send: [:rest]

  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @conversion_sources_service_stub.undelete_conversion_source request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domainString

The effective universe domain

Returns:

  • (String)


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

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::Rest::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:

  • (result, operation)

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
# File 'lib/google/shopping/merchant/conversions/v1beta/conversion_sources_service/rest/client.rb', line 291

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
   = @config.rpcs.update_conversion_source..to_h

  # Set x-goog-api-client and x-goog-user-project headers
  [:"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,
    transports_version_send: [:rest]

  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @conversion_sources_service_stub.update_conversion_source request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end