Module: Google::Shopping::Css

Defined in:
lib/google/shopping/css.rb,
lib/google/shopping/css/version.rb

Constant Summary collapse

VERSION = 
"1.2.2"

Class Method Summary collapse

Class Method Details

.account_labels_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for AccountLabelsService.

By default, this returns an instance of Google::Shopping::Css::V1::AccountLabelsService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the AccountLabelsService 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 AccountLabelsService service. You can determine whether the method will succeed by calling account_labels_service_available?.

About AccountLabelsService

Manages Merchant Center and CSS accounts labels.

Parameters:

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

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

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

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object) —

    A client object for the specified version.



127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/google/shopping/css.rb', line 127

def self. version: :v1, transport: :grpc, &block
  require "google/shopping/css/#{version.to_s.downcase}"

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

.account_labels_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the AccountLabelsService service is supported by the current client. If true, you can retrieve a client object by calling account_labels_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 AccountLabelsService service, or if the versioned client gem needs an update to support the AccountLabelsService service.

Parameters:

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

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

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

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean) —

    Whether the service is available.



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/google/shopping/css.rb', line 151

def self. version: :v1, transport: :grpc
  require "google/shopping/css/#{version.to_s.downcase}"
  package_name = Google::Shopping::Css
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Shopping::Css.const_get package_name
  return false unless service_module.const_defined? :AccountLabelsService
  service_module = service_module.const_get :AccountLabelsService
  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

.accounts_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for AccountsService.

By default, this returns an instance of Google::Shopping::Css::V1::AccountsService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the AccountsService 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 AccountsService service. You can determine whether the method will succeed by calling accounts_service_available?.

About AccountsService

Service for managing CSS/MC account information.

Parameters:

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

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

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

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object) —

    A client object for the specified version.



57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/google/shopping/css.rb', line 57

def self.accounts_service version: :v1, transport: :grpc, &block
  require "google/shopping/css/#{version.to_s.downcase}"

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

.accounts_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the AccountsService service is supported by the current client. If true, you can retrieve a client object by calling accounts_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 AccountsService service, or if the versioned client gem needs an update to support the AccountsService service.

Parameters:

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

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

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

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean) —

    Whether the service is available.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/google/shopping/css.rb', line 81

def self.accounts_service_available? version: :v1, transport: :grpc
  require "google/shopping/css/#{version.to_s.downcase}"
  package_name = Google::Shopping::Css
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Shopping::Css.const_get package_name
  return false unless service_module.const_defined? :AccountsService
  service_module = service_module.const_get :AccountsService
  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

.css_product_inputs_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for CssProductInputsService.

By default, this returns an instance of Google::Shopping::Css::V1::CssProductInputsService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the CssProductInputsService 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 CssProductInputsService service. You can determine whether the method will succeed by calling css_product_inputs_service_available?.

About CssProductInputsService

Service to use CssProductInput resource. This service helps to insert/update/delete CSS Products.

Parameters:

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

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

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

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object) —

    A client object for the specified version.



198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/google/shopping/css.rb', line 198

def self.css_product_inputs_service version: :v1, transport: :grpc, &block
  require "google/shopping/css/#{version.to_s.downcase}"

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

.css_product_inputs_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the CssProductInputsService service is supported by the current client. If true, you can retrieve a client object by calling css_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 CssProductInputsService service, or if the versioned client gem needs an update to support the CssProductInputsService service.

Parameters:

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

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

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

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean) —

    Whether the service is available.



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/google/shopping/css.rb', line 222

def self.css_product_inputs_service_available? version: :v1, transport: :grpc
  require "google/shopping/css/#{version.to_s.downcase}"
  package_name = Google::Shopping::Css
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Shopping::Css.const_get package_name
  return false unless service_module.const_defined? :CssProductInputsService
  service_module = service_module.const_get :CssProductInputsService
  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

.css_products_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for CssProductsService.

By default, this returns an instance of Google::Shopping::Css::V1::CssProductsService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the CssProductsService 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 CssProductsService service. You can determine whether the method will succeed by calling css_products_service_available?.

About CssProductsService

Service for doing get and list on Css Products(a.k.a Aggregate Offers internally).

Parameters:

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

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

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

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object) —

    A client object for the specified version.



269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/google/shopping/css.rb', line 269

def self.css_products_service version: :v1, transport: :grpc, &block
  require "google/shopping/css/#{version.to_s.downcase}"

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

.css_products_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the CssProductsService service is supported by the current client. If true, you can retrieve a client object by calling css_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 CssProductsService service, or if the versioned client gem needs an update to support the CssProductsService service.

Parameters:

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

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

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

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean) —

    Whether the service is available.



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/google/shopping/css.rb', line 293

def self.css_products_service_available? version: :v1, transport: :grpc
  require "google/shopping/css/#{version.to_s.downcase}"
  package_name = Google::Shopping::Css
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Shopping::Css.const_get package_name
  return false unless service_module.const_defined? :CssProductsService
  service_module = service_module.const_get :CssProductsService
  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

.quota_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for QuotaService.

By default, this returns an instance of Google::Shopping::Css::V1::QuotaService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the QuotaService 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 QuotaService service. You can determine whether the method will succeed by calling quota_service_available?.

About QuotaService

Service to get method call quota information per CSS API method.

Parameters:

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

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

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

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object) —

    A client object for the specified version.



339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/google/shopping/css.rb', line 339

def self.quota_service version: :v1, transport: :grpc, &block
  require "google/shopping/css/#{version.to_s.downcase}"

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

.quota_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the QuotaService service is supported by the current client. If true, you can retrieve a client object by calling quota_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 QuotaService service, or if the versioned client gem needs an update to support the QuotaService service.

Parameters:

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

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

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

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean) —

    Whether the service is available.



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/google/shopping/css.rb', line 363

def self.quota_service_available? version: :v1, transport: :grpc
  require "google/shopping/css/#{version.to_s.downcase}"
  package_name = Google::Shopping::Css
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Shopping::Css.const_get package_name
  return false unless service_module.const_defined? :QuotaService
  service_module = service_module.const_get :QuotaService
  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