Class: Google::Cloud::Retail::V2::Image

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/retail/v2/common.rb

Overview

Product image. Recommendations AI and Retail Search use product images to improve prediction and search results. Product images can be returned in results, and are shown in prediction or search previews in the console. Please try to provide correct product images and avoid using images with size too small.

Instance Attribute Summary collapse

Instance Attribute Details

#height ⇒ ::Integer

Height of the image in number of pixels.

This field must be nonnegative. Otherwise, an INVALID_ARGUMENT error is returned.

Returns:

  • (::Integer) —

    Height of the image in number of pixels.

    This field must be nonnegative. Otherwise, an INVALID_ARGUMENT error is returned.



671
672
673
674
 
# File 'proto_docs/google/cloud/retail/v2/common.rb', line 671

class Image
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#uri ⇒ ::String

Returns Required. URI of the image.

This field must be a valid UTF-8 encoded URI with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Google Merchant Center property image_link. Schema.org property Product.image.

Returns:

  • (::String) —

    Required. URI of the image.

    This field must be a valid UTF-8 encoded URI with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

    Google Merchant Center property image_link. Schema.org property Product.image.



671
672
673
674
 
# File 'proto_docs/google/cloud/retail/v2/common.rb', line 671

class Image
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#width ⇒ ::Integer

Width of the image in number of pixels.

This field must be nonnegative. Otherwise, an INVALID_ARGUMENT error is returned.

Returns:

  • (::Integer) —

    Width of the image in number of pixels.

    This field must be nonnegative. Otherwise, an INVALID_ARGUMENT error is returned.



671
672
673
674
 
# File 'proto_docs/google/cloud/retail/v2/common.rb', line 671

class Image
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end