Class: Google::Shopping::Merchant::Lfp::V1beta::LfpStoreService::Client

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

Overview

Client for the LfpStoreService service.

Service for a LFP partner to submit local stores for a merchant.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#account_path, #lfp_store_path

Constructor Details

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

Create a new LfpStoreService client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the LfpStoreService client.

Yield Parameters:



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
 
# File 'lib/google/shopping/merchant/lfp/v1beta/lfp_store_service/client.rb', line 132

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/lfp/v1beta/lfpstore_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

  @lfp_store_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Shopping::Merchant::Lfp::V1beta::LfpStoreService::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

Class Method Details

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

Configure the LfpStoreService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all LfpStoreService clients
::Google::Shopping::Merchant::Lfp::V1beta::LfpStoreService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/google/shopping/merchant/lfp/v1beta/lfp_store_service/client.rb', line 65

def self.configure
  @configure ||= begin
    namespace = ["Google", "Shopping", "Merchant", "Lfp", "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 LfpStoreService 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:



102
103
104
105
 
# File 'lib/google/shopping/merchant/lfp/v1beta/lfp_store_service/client.rb', line 102

def configure
  yield @config if block_given?
  @config
end

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

Deletes a store for a target merchant.

Examples:

Basic example

require "google/shopping/merchant/lfp/v1beta"

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

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

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Shopping::Merchant::Lfp::V1beta::DeleteLfpStoreRequest, ::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_lfp_store(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_lfp_store 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 store to delete for the target merchant account. Format: accounts/{account}/lfpStores/{target_merchant}~{store_code}

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/google/shopping/merchant/lfp/v1beta/lfp_store_service/client.rb', line 396

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Lfp::V1beta::DeleteLfpStoreRequest

  # 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_lfp_store.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::Lfp::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_lfp_store.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_lfp_store.retry_policy

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

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

#get_lfp_store(request, options = nil) ⇒ ::Google::Shopping::Merchant::Lfp::V1beta::LfpStore #get_lfp_store(name: nil) ⇒ ::Google::Shopping::Merchant::Lfp::V1beta::LfpStore

Retrieves information about a store.

Examples:

Basic example

require "google/shopping/merchant/lfp/v1beta"

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

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

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

# The returned object is of type Google::Shopping::Merchant::Lfp::V1beta::LfpStore.
p result

Overloads:

  • #get_lfp_store(request, options = nil) ⇒ ::Google::Shopping::Merchant::Lfp::V1beta::LfpStore

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

    Parameters:

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

  • #get_lfp_store(name: nil) ⇒ ::Google::Shopping::Merchant::Lfp::V1beta::LfpStore

    Pass arguments to get_lfp_store 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 store to retrieve. Format: accounts/{account}/lfpStores/{target_merchant}~{store_code}

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/google/shopping/merchant/lfp/v1beta/lfp_store_service/client.rb', line 219

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Lfp::V1beta::GetLfpStoreRequest

  # 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_lfp_store.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::Lfp::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_lfp_store.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_lfp_store.retry_policy

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

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

#insert_lfp_store(request, options = nil) ⇒ ::Google::Shopping::Merchant::Lfp::V1beta::LfpStore #insert_lfp_store(parent: nil, lfp_store: nil) ⇒ ::Google::Shopping::Merchant::Lfp::V1beta::LfpStore

Inserts a store for the target merchant. If the store with the same store code already exists, it will be replaced.

Examples:

Basic example

require "google/shopping/merchant/lfp/v1beta"

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

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

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

# The returned object is of type Google::Shopping::Merchant::Lfp::V1beta::LfpStore.
p result

Overloads:

  • #insert_lfp_store(request, options = nil) ⇒ ::Google::Shopping::Merchant::Lfp::V1beta::LfpStore

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

    Parameters:

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

  • #insert_lfp_store(parent: nil, lfp_store: nil) ⇒ ::Google::Shopping::Merchant::Lfp::V1beta::LfpStore

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/google/shopping/merchant/lfp/v1beta/lfp_store_service/client.rb', line 309

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Lfp::V1beta::InsertLfpStoreRequest

  # 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.insert_lfp_store.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::Lfp::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.insert_lfp_store.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.insert_lfp_store.retry_policy

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

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

#list_lfp_stores(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Shopping::Merchant::Lfp::V1beta::LfpStore> #list_lfp_stores(parent: nil, target_account: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Shopping::Merchant::Lfp::V1beta::LfpStore>

Lists the stores of the target merchant, specified by the filter in ListLfpStoresRequest.

Examples:

Basic example

require "google/shopping/merchant/lfp/v1beta"

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

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

# Call the list_lfp_stores method.
result = client.list_lfp_stores 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::Lfp::V1beta::LfpStore.
  p item
end

Overloads:

  • #list_lfp_stores(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Shopping::Merchant::Lfp::V1beta::LfpStore>

    Pass arguments to list_lfp_stores via a request object, either of type Google::Shopping::Merchant::Lfp::V1beta::ListLfpStoresRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Shopping::Merchant::Lfp::V1beta::ListLfpStoresRequest, ::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_lfp_stores(parent: nil, target_account: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Shopping::Merchant::Lfp::V1beta::LfpStore>

    Pass arguments to list_lfp_stores 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 LFP partner. Format: accounts/{account}

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

      Required. The Merchant Center id of the merchant to list stores for.

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

      Optional. The maximum number of LfpStore resources for the given account to return. The service returns fewer than this value if the number of stores for the given account is less than the pageSize. The default value is 250. The maximum value is 1000; If a value higher than the maximum is specified, then the pageSize will default to the maximum.

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

      Optional. A page token, received from a previous ListLfpStoresRequest call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to ListLfpStoresRequest must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



503
504
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/lfp/v1beta/lfp_store_service/client.rb', line 503

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Lfp::V1beta::ListLfpStoresRequest

  # 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_lfp_stores.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::Lfp::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_lfp_stores.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_lfp_stores.retry_policy

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

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

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


112
113
114
 
# File 'lib/google/shopping/merchant/lfp/v1beta/lfp_store_service/client.rb', line 112

def universe_domain
  @lfp_store_service_stub.universe_domain
end