Retail V2 API - Class Google::Cloud::Retail::V2::Image (v1.2.0)

Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::Image.

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#height

def height() -> ::Integer
Returns
  • (::Integer) — Height of the image in number of pixels.

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

#height=

def height=(value) -> ::Integer
Parameter
  • value (::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.

#uri

def uri() -> ::String
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.

#uri=

def uri=(value) -> ::String
Parameter
  • value (::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.

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.

#width

def width() -> ::Integer
Returns
  • (::Integer) — Width of the image in number of pixels.

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

#width=

def width=(value) -> ::Integer
Parameter
  • value (::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.