Class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaImage

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/retail_v2alpha/classes.rb,
lib/google/apis/retail_v2alpha/representations.rb,
lib/google/apis/retail_v2alpha/representations.rb

Overview

Product image. Recommendations AI and Retail Search do not use product images to improve prediction and search results. However, product images can be returned in results, and are shown in prediction or search previews in the console.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2alphaImage

Returns a new instance of GoogleCloudRetailV2alphaImage.



1884
1885
1886
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1884

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#heightFixnum

Height of the image in number of pixels. This field must be nonnegative. Otherwise, an INVALID_ARGUMENT error is returned. Corresponds to the JSON property height

Returns:

  • (Fixnum)


1867
1868
1869
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1867

def height
  @height
end

#uriString

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. Corresponds to the JSON property uri

Returns:

  • (String)


1876
1877
1878
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1876

def uri
  @uri
end

#widthFixnum

Width of the image in number of pixels. This field must be nonnegative. Otherwise, an INVALID_ARGUMENT error is returned. Corresponds to the JSON property width

Returns:

  • (Fixnum)


1882
1883
1884
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1882

def width
  @width
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1889
1890
1891
1892
1893
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1889

def update!(**args)
  @height = args[:height] if args.key?(:height)
  @uri = args[:uri] if args.key?(:uri)
  @width = args[:width] if args.key?(:width)
end