Class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct

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 captures all metadata information of items to be recommended or searched.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2alphaProduct

Returns a new instance of GoogleCloudRetailV2alphaProduct.



1359
1360
1361
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1359

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

Instance Attribute Details

#attributes ⇒ Hash<String,Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute>

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: 200 by default; 100 for Type.VARIANT. * The key must be a UTF-8 encoded string with a length limit of 128 characters. Corresponds to the JSON property attributes

Returns:



1230
1231
1232
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1230

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) 


1238
1239
1240
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1238

def availability
  @availability
end

#available_quantity ⇒ Fixnum

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

Returns:

  • (Fixnum) 


1243
1244
1245
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1243

def available_quantity
  @available_quantity
end

#available_time ⇒ String

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

Returns:

  • (String) 


1248
1249
1250
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1248

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>) 


1268
1269
1270
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1268

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) 


1277
1278
1279
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1277

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) 


1288
1289
1290
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1288

def id
  @id
end

#images ⇒ Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaImage>

Product images for the product.Highly recommended to put the main image to the first. 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:



1296
1297
1298
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1296

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) 


1303
1304
1305
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1303

def name
  @name
end

#price_info ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPriceInfo

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

Returns:



1308
1309
1310
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1308

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) 


1321
1322
1323
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1321

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>) 


1331
1332
1333
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1331

def tags
  @tags
end

#title ⇒ String

Required. Product title. This field must be a UTF-8 encoded string with a length limit of 1,000 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) 


1340
1341
1342
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1340

def title
  @title
end

#type ⇒ String

Immutable. The type of the product. Default to Catalog.product_level_config. ingestion_product_type if unset. Corresponds to the JSON property type

Returns:

  • (String) 


1346
1347
1348
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1346

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) 


1357
1358
1359
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1357

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1364

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