Module: Google::Shopping::Merchant::Products

Defined in:
lib/google/shopping/merchant/products.rb,
lib/google/shopping/merchant/products/version.rb

Constant Summary collapse

VERSION = 
"0.3.0"

Class Method Summary collapse

Class Method Details

.product_inputs_service(version: :v1beta, transport: :grpc, &block) ⇒ ::Object

Create a new client object for ProductInputsService.

By default, this returns an instance of Google::Shopping::Merchant::Products::V1beta::ProductInputsService::Client for a gRPC client for version V1beta of the API. However, you can specify a different API version by passing it in the version parameter. If the ProductInputsService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the ProductInputsService service. You can determine whether the method will succeed by calling product_inputs_service_available?.

About ProductInputsService

Service to use ProductInput resource. This service works for products with online channel only.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1beta) —

    The API version to connect to. Optional. Defaults to :v1beta.

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object) —

    A client object for the specified version.



59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/google/shopping/merchant/products.rb', line 59

def self.product_inputs_service version: :v1beta, transport: :grpc, &block
  require "google/shopping/merchant/products/#{version.to_s.downcase}"

  package_name = Google::Shopping::Merchant::Products
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Shopping::Merchant::Products.const_get(package_name).const_get(:ProductInputsService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.product_inputs_service_available?(version: :v1beta, transport: :grpc) ⇒ boolean

Determines whether the ProductInputsService service is supported by the current client. If true, you can retrieve a client object by calling product_inputs_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the ProductInputsService service, or if the versioned client gem needs an update to support the ProductInputsService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1beta) —

    The API version to connect to. Optional. Defaults to :v1beta.

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean) —

    Whether the service is available.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/google/shopping/merchant/products.rb', line 83

def self.product_inputs_service_available? version: :v1beta, transport: :grpc
  require "google/shopping/merchant/products/#{version.to_s.downcase}"
  package_name = Google::Shopping::Merchant::Products
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Shopping::Merchant::Products.const_get package_name
  return false unless service_module.const_defined? :ProductInputsService
  service_module = service_module.const_get :ProductInputsService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.products_service(version: :v1beta, transport: :grpc, &block) ⇒ ::Object

Create a new client object for ProductsService.

By default, this returns an instance of Google::Shopping::Merchant::Products::V1beta::ProductsService::Client for a gRPC client for version V1beta of the API. However, you can specify a different API version by passing it in the version parameter. If the ProductsService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the ProductsService service. You can determine whether the method will succeed by calling products_service_available?.

About ProductsService

Service to use Product resource.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1beta) —

    The API version to connect to. Optional. Defaults to :v1beta.

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object) —

    A client object for the specified version.



129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/google/shopping/merchant/products.rb', line 129

def self.products_service version: :v1beta, transport: :grpc, &block
  require "google/shopping/merchant/products/#{version.to_s.downcase}"

  package_name = Google::Shopping::Merchant::Products
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Shopping::Merchant::Products.const_get(package_name).const_get(:ProductsService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.products_service_available?(version: :v1beta, transport: :grpc) ⇒ boolean

Determines whether the ProductsService service is supported by the current client. If true, you can retrieve a client object by calling products_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the ProductsService service, or if the versioned client gem needs an update to support the ProductsService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1beta) —

    The API version to connect to. Optional. Defaults to :v1beta.

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean) —

    Whether the service is available.



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/google/shopping/merchant/products.rb', line 153

def self.products_service_available? version: :v1beta, transport: :grpc
  require "google/shopping/merchant/products/#{version.to_s.downcase}"
  package_name = Google::Shopping::Merchant::Products
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Shopping::Merchant::Products.const_get package_name
  return false unless service_module.const_defined? :ProductsService
  service_module = service_module.const_get :ProductsService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end