Class: Google::Shopping::Css::V1::CssProductInputsService::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/shopping/css/v1/css_product_inputs_service/rest/client.rb

Overview

REST client for the CssProductInputsService service.

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

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#account_path, #css_product_input_path

Constructor Details

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

Create a new CssProductInputsService REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Shopping::Css::V1::CssProductInputsService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Shopping::Css::V1::CssProductInputsService::Rest::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the CssProductInputsService client.

Yield Parameters:



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
 
# File 'lib/google/shopping/css/v1/css_product_inputs_service/rest/client.rb', line 133

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

  @css_product_inputs_service_stub = ::Google::Shopping::Css::V1::CssProductInputsService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials,
    logger: @config.logger
  )

  @css_product_inputs_service_stub.logger(stub: true)&.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 CssProductInputsService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all CssProductInputsService clients
::Google::Shopping::Css::V1::CssProductInputsService::Rest::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
86
 
# File 'lib/google/shopping/css/v1/css_product_inputs_service/rest/client.rb', line 65

def self.configure
  @configure ||= begin
    namespace = ["Google", "Shopping", "Css", "V1"]
    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.rpcs.insert_css_product_input.timeout = 60.0

    default_config.rpcs.update_css_product_input.timeout = 60.0

    default_config.rpcs.delete_css_product_input.timeout = 60.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

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

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



103
104
105
106
 
# File 'lib/google/shopping/css/v1/css_product_inputs_service/rest/client.rb', line 103

def configure
  yield @config if block_given?
  @config
end

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

Deletes a CSS Product input from your CSS Center account.

After a delete it may take several minutes until the input is no longer available.

Examples:

Basic example

require "google/shopping/css/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Shopping::Css::V1::CssProductInputsService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Shopping::Css::V1::DeleteCssProductInputRequest.new

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Shopping::Css::V1::DeleteCssProductInputRequest, ::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_css_product_input(name: nil, supplemental_feed_id: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_css_product_input 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 CSS product input resource to delete. Format: accounts/{account}/cssProductInputs/{css_product_input}, where the last section css_product_input consists of 3 parts: contentLanguage~feedLabel~offerId. Example: accounts/123/cssProductInputs/de~DE~rawProvidedId123

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

      The Content API Supplemental Feed ID. The field must not be set if the action applies to a primary feed. If the field is set, then product action applies to a supplemental feed instead of primary Content API feed.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/google/shopping/css/v1/css_product_inputs_service/rest/client.rb', line 434

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Css::V1::DeleteCssProductInputRequest

  # 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
  call_metadata = @config.rpcs.delete_css_product_input.metadata.to_h

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

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_css_product_input.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_css_product_input.retry_policy

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

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

#insert_css_product_input(request, options = nil) ⇒ ::Google::Shopping::Css::V1::CssProductInput #insert_css_product_input(parent: nil, css_product_input: nil, feed_id: nil) ⇒ ::Google::Shopping::Css::V1::CssProductInput

Uploads a CssProductInput to your CSS Center account. If an input with the same contentLanguage, identity, feedLabel and feedId already exists, this method replaces that entry.

After inserting, updating, or deleting a CSS Product input, it may take several minutes before the processed CSS Product can be retrieved.

Examples:

Basic example

require "google/shopping/css/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Shopping::Css::V1::CssProductInputsService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Shopping::Css::V1::InsertCssProductInputRequest.new

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

# The returned object is of type Google::Shopping::Css::V1::CssProductInput.
p result

Overloads:

  • #insert_css_product_input(request, options = nil) ⇒ ::Google::Shopping::Css::V1::CssProductInput

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

    Parameters:

    • request (::Google::Shopping::Css::V1::InsertCssProductInputRequest, ::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_css_product_input(parent: nil, css_product_input: nil, feed_id: nil) ⇒ ::Google::Shopping::Css::V1::CssProductInput

    Pass arguments to insert_css_product_input 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 account where this CSS Product will be inserted. Format: accounts/{account}

    • css_product_input (::Google::Shopping::Css::V1::CssProductInput, ::Hash) (defaults to: nil) —

      Required. The CSS Product Input to insert.

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

      Optional. DEPRECATED. Feed id is not required for CSS Products. The primary or supplemental feed id. If CSS Product already exists and feed id provided is different, then the CSS Product will be moved to a new feed. Note: For now, CSSs do not need to provide feed ids as we create feeds on the fly. We do not have supplemental feed support for CSS Products yet.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
 
# File 'lib/google/shopping/css/v1/css_product_inputs_service/rest/client.rb', line 245

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Css::V1::InsertCssProductInputRequest

  # 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
  call_metadata = @config.rpcs.insert_css_product_input.metadata.to_h

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

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.insert_css_product_input.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.insert_css_product_input.retry_policy

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

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

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


180
181
182
 
# File 'lib/google/shopping/css/v1/css_product_inputs_service/rest/client.rb', line 180

def logger
  @css_product_inputs_service_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


113
114
115
 
# File 'lib/google/shopping/css/v1/css_product_inputs_service/rest/client.rb', line 113

def universe_domain
  @css_product_inputs_service_stub.universe_domain
end

#update_css_product_input(request, options = nil) ⇒ ::Google::Shopping::Css::V1::CssProductInput #update_css_product_input(css_product_input: nil, update_mask: nil) ⇒ ::Google::Shopping::Css::V1::CssProductInput

Updates the existing Css Product input in your CSS Center account.

After inserting, updating, or deleting a CSS Product input, it may take several minutes before the processed Css Product can be retrieved.

Examples:

Basic example

require "google/shopping/css/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Shopping::Css::V1::CssProductInputsService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Shopping::Css::V1::UpdateCssProductInputRequest.new

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

# The returned object is of type Google::Shopping::Css::V1::CssProductInput.
p result

Overloads:

  • #update_css_product_input(request, options = nil) ⇒ ::Google::Shopping::Css::V1::CssProductInput

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

    Parameters:

    • request (::Google::Shopping::Css::V1::UpdateCssProductInputRequest, ::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.

  • #update_css_product_input(css_product_input: nil, update_mask: nil) ⇒ ::Google::Shopping::Css::V1::CssProductInput

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

    • css_product_input (::Google::Shopping::Css::V1::CssProductInput, ::Hash) (defaults to: nil) —

      Required. The CSS product input resource to update. Information you submit will be applied to the processed CSS product as well.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      The list of CSS product attributes to be updated.

      If the update mask is omitted, then it is treated as implied field mask equivalent to all fields that are populated (have a non-empty value).

      Attributes specified in the update mask without a value specified in the body will be deleted from the CSS product.

      Update mask can only be specified for top level fields in attributes and custom attributes.

      To specify the update mask for custom attributes you need to add the custom_attribute. prefix.

      Providing special "*" value for full CSS product replacement is not supported.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
369
370
371
372
373
374
375
376
377
 
# File 'lib/google/shopping/css/v1/css_product_inputs_service/rest/client.rb', line 344

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Css::V1::UpdateCssProductInputRequest

  # 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
  call_metadata = @config.rpcs.update_css_product_input.metadata.to_h

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

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_css_product_input.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_css_product_input.retry_policy

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

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