Class: Google::Apis::RetailV2::GoogleCloudRetailV2Product

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

Overview

Product captures all metadata information of items to be recommended or searched.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2Product

Returns a new instance of GoogleCloudRetailV2Product.



1034
1035
1036
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1034

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

Instance Attribute Details

#attributes ⇒ Hash<String,Google::Apis::RetailV2::GoogleCloudRetailV2CustomAttribute>

Highly encouraged. Extra product attributes to be included. For example, for products, this could include the store name, vendor, style, color, etc. These are very strong signals for recommendation model, thus we highly recommend providing the attributes here. Features that can take on one of a limited number of possible values. Two types of features can be set are: Textual features. some examples would be the brand/maker of a product, or country of a customer. Numerical features. Some examples would be the height/weight of a product, or age of a customer. For example: "vendor": `"text": ["vendor123", "vendor456"]`, "lengths_cm": `"numbers":[2.3, 15.4]`, "heights_cm": `"numbers" :[8.1, 6.4]`. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * Max entries count: 150 by default; 100 for Type.VARIANT. * Max indexable entries count: 150 by default; 40 for Type. VARIANT. * Max searchable entries count: 30. * The key must be a UTF-8 encoded string with a length limit of 128 characters. Corresponds to the JSON property attributes

Returns:



907
908
909
 
# File 'lib/google/apis/retail_v2/classes.rb', line 907

def attributes
  @attributes
end

#availability ⇒ String

The online availability of the Product. Default to Availability.IN_STOCK. Google Merchant Center Property availability. Schema.org Property Offer.availability. Corresponds to the JSON property availability

Returns:

  • (String) 


915
916
917
 
# File 'lib/google/apis/retail_v2/classes.rb', line 915

def availability
  @availability
end

#available_quantity ⇒ Fixnum

The available quantity of the item. Corresponds to the JSON property availableQuantity

Returns:

  • (Fixnum) 


920
921
922
 
# File 'lib/google/apis/retail_v2/classes.rb', line 920

def available_quantity
  @available_quantity
end

#available_time ⇒ String

The timestamp when this Product becomes available recommendation and search. Corresponds to the JSON property availableTime

Returns:

  • (String) 


925
926
927
 
# File 'lib/google/apis/retail_v2/classes.rb', line 925

def available_time
  @available_time
end

#categories ⇒ Array<String>

Product categories. This field is repeated for supporting one product belonging to several parallel categories. Strongly recommended using the full path for better search / recommendation quality. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, please replace it with other character(s). For example, if a shoes product belongs to both ["Shoes & Accessories" -> "Shoes"] and [" Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be represented as: "categories": [ "Shoes & Accessories > Shoes", "Sports & Fitness > Athletic Clothing > Shoes" ] Must be set for Type.PRIMARY Product otherwise an INVALID_ARGUMENT error is returned. At most 250 values are allowed per Product. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center property google_product_category. Schema.org property Product.category. [ mc_google_product_category]: https://support.google.com/merchants/answer/ 6324436 Corresponds to the JSON property categories

Returns:

  • (Array<String>) 


945
946
947
 
# File 'lib/google/apis/retail_v2/classes.rb', line 945

def categories
  @categories
end

#description ⇒ String

Product description. This field must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center property description. schema.org property Product.description. Corresponds to the JSON property description

Returns:

  • (String) 


954
955
956
 
# File 'lib/google/apis/retail_v2/classes.rb', line 954

def description
  @description
end

#id ⇒ String

Immutable. Product identifier, which is the final component of name. For example, this field is "id_1", if name is projects/*/locations/global/ catalogs/default_catalog/branches/default_branch/products/id_1. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center property id. Schema.org Property Product.sku. Corresponds to the JSON property id

Returns:

  • (String) 


965
966
967
 
# File 'lib/google/apis/retail_v2/classes.rb', line 965

def id
  @id
end

#images ⇒ Array<Google::Apis::RetailV2::GoogleCloudRetailV2Image>

Product images for the product. A maximum of 300 images are allowed. Google Merchant Center property image_link. Schema.org property Product.image. Corresponds to the JSON property images

Returns:



972
973
974
 
# File 'lib/google/apis/retail_v2/classes.rb', line 972

def images
  @images
end

#name ⇒ String

Immutable. Full resource name of the product, such as projects/*/locations/ global/catalogs/default_catalog/branches/default_branch/products/product_id. The branch ID must be "default_branch". Corresponds to the JSON property name

Returns:

  • (String) 


979
980
981
 
# File 'lib/google/apis/retail_v2/classes.rb', line 979

def name
  @name
end

#price_info ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2PriceInfo

The price information of a Product. Corresponds to the JSON property priceInfo

Returns:



984
985
986
 
# File 'lib/google/apis/retail_v2/classes.rb', line 984

def price_info
  @price_info
end

#primary_product_id ⇒ String

Variant group identifier. Must be an id, with the same parent branch with this product. Otherwise, an error is thrown. For Type.PRIMARY Products, this field can only be empty or set to the same value as id. For VARIANT Products, this field cannot be empty. A maximum of 2,000 products are allowed to share the same Type.PRIMARY Product. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center Property item_group_id. Schema.org Property Product.inProductGroupWithID. This field must be enabled before it can be used. Learn more. Corresponds to the JSON property primaryProductId

Returns:

  • (String) 


997
998
999
 
# File 'lib/google/apis/retail_v2/classes.rb', line 997

def primary_product_id
  @primary_product_id
end

#tags ⇒ Array<String>

Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1, 000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Google Merchant Center property custom_label_0–4. Corresponds to the JSON property tags

Returns:

  • (Array<String>) 


1007
1008
1009
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1007

def tags
  @tags
end

#title ⇒ String

Required. Product title. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center property title. Schema.org property Product.name. Corresponds to the JSON property title

Returns:

  • (String) 


1016
1017
1018
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1016

def title
  @title
end

#type ⇒ String

Immutable. The type of the product. This field is output-only. Corresponds to the JSON property type

Returns:

  • (String) 


1021
1022
1023
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1021

def type
  @type
end

#uri ⇒ String

Canonical URL directly linking to the product detail page. It is strongly recommended to provide a valid uri for the product, otherwise the service performance could be significantly degraded. This field must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center property link. Schema.org property Offer.url. Corresponds to the JSON property uri

Returns:

  • (String) 


1032
1033
1034
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1032

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1039

def update!(**args)
  @attributes = args[:attributes] if args.key?(:attributes)
  @availability = args[:availability] if args.key?(:availability)
  @available_quantity = args[:available_quantity] if args.key?(:available_quantity)
  @available_time = args[:available_time] if args.key?(:available_time)
  @categories = args[:categories] if args.key?(:categories)
  @description = args[:description] if args.key?(:description)
  @id = args[:id] if args.key?(:id)
  @images = args[:images] if args.key?(:images)
  @name = args[:name] if args.key?(:name)
  @price_info = args[:price_info] if args.key?(:price_info)
  @primary_product_id = args[:primary_product_id] if args.key?(:primary_product_id)
  @tags = args[:tags] if args.key?(:tags)
  @title = args[:title] if args.key?(:title)
  @type = args[:type] if args.key?(:type)
  @uri = args[:uri] if args.key?(:uri)
end