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.



2358
2359
2360
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2358

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. * The key must be a UTF-8 encoded string with a length limit of 128 characters. * For indexable attribute, the key must match the pattern: a-zA-Z0-9*. For example, key0LikeThis or KEY_1_LIKE_THIS. Corresponds to the JSON property attributes

Returns:



2063
2064
2065
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2063

def attributes
  @attributes
end

#audience ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAudience

An intended audience of the Product for whom it's sold. Corresponds to the JSON property audience

Returns:



2068
2069
2070
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2068

def audience
  @audience
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) 


2076
2077
2078
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2076

def availability
  @availability
end

#available_quantity ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2081
2082
2083
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2081

def available_quantity
  @available_quantity
end

#available_time ⇒ String

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

Returns:

  • (String) 


2086
2087
2088
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2086

def available_time
  @available_time
end

#brands ⇒ Array<String>

The brands of the product. A maximum of 30 brands are allowed. Each brand 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 brand. Schema.org property Product.brand. Corresponds to the JSON property brands

Returns:

  • (Array<String>) 


2095
2096
2097
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2095

def brands
  @brands
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>) 


2115
2116
2117
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2115

def categories
  @categories
end

#collection_member_ids ⇒ Array<String>

The id of the collection members when type is Type.COLLECTION. Should not set it for other types. A maximum of 1000 values are allowed. Otherwise, an INVALID_ARGUMENT error is return. Corresponds to the JSON property collectionMemberIds

Returns:

  • (Array<String>) 


2122
2123
2124
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2122

def collection_member_ids
  @collection_member_ids
end

#color_info ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaColorInfo

The color information of a Product. Corresponds to the JSON property colorInfo

Returns:



2127
2128
2129
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2127

def color_info
  @color_info
end

#conditions ⇒ Array<String>

The condition of the product. Strongly encouraged to use the standard values: " new", "refurbished", "used". A maximum of 5 values are allowed per Product. Each value 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 condition. Schema.org property Offer.itemCondition. Corresponds to the JSON property conditions

Returns:

  • (Array<String>) 


2138
2139
2140
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2138

def conditions
  @conditions
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) 


2147
2148
2149
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2147

def description
  @description
end

#expire_time ⇒ String

The timestamp when this product becomes unavailable for SearchService.Search. If it is set, the Product is not available for SearchService.Search after expire_time. However, the product can still be retrieved by ProductService. GetProduct and ProductService.ListProducts. Google Merchant Center property expiration_date. Corresponds to the JSON property expireTime

Returns:

  • (String) 


2156
2157
2158
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2156

def expire_time
  @expire_time
end

#fulfillment_info ⇒ Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaFulfillmentInfo>

Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods. All the elements must have distinct FulfillmentInfo.type. Otherwise, an INVALID_ARGUMENT error is returned. Corresponds to the JSON property fulfillmentInfo

Returns:



2163
2164
2165
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2163

def fulfillment_info
  @fulfillment_info
end

#gtin ⇒ String

The Global Trade Item Number (GTIN) of the product. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. This field must be a Unigram. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center property gtin. Schema.org property Product.isbn or Product.gtin8 or Product.gtin12 or Product.gtin13 or Product.gtin14. If the value is not a valid GTIN, an INVALID_ARGUMENT error is returned. Corresponds to the JSON property gtin

Returns:

  • (String) 


2176
2177
2178
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2176

def gtin
  @gtin
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) 


2187
2188
2189
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2187

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:



2195
2196
2197
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2195

def images
  @images
end

#language_code ⇒ String

Language of the title/description and other string attributes. Use language tags defined by BCP 47. For product prediction, this field is ignored and the model automatically detects the text language. The Product can include text in different languages, but duplicating Products to provide text in multiple languages can result in degraded model performance. For product search this field is in use. It defaults to "en-US" if unset. Corresponds to the JSON property languageCode

Returns:

  • (String) 


2205
2206
2207
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2205

def language_code
  @language_code
end

#materials ⇒ Array<String>

The material of the product. For example, "leather", "wooden". A maximum of 20 values are allowed. Each value 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 material. Schema.org property Product.material. Corresponds to the JSON property materials

Returns:

  • (Array<String>) 


2215
2216
2217
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2215

def materials
  @materials
end

#name ⇒ String

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

Returns:

  • (String) 


2221
2222
2223
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2221

def name
  @name
end

#patterns ⇒ Array<String>

The pattern or graphic print of the product. For example, "striped", "polka dot", "paisley". A maximum of 20 values are allowed per Product. Each value 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 pattern. Schema.org property Product.pattern. Corresponds to the JSON property patterns

Returns:

  • (Array<String>) 


2231
2232
2233
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2231

def patterns
  @patterns
end

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

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

Returns:



2236
2237
2238
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2236

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) 


2249
2250
2251
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2249

def primary_product_id
  @primary_product_id
end

#promotions ⇒ Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPromotion>

The promotions applied to the product. A maximum of 10 values are allowed per Product. Corresponds to the JSON property promotions

Returns:



2255
2256
2257
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2255

def promotions
  @promotions
end

#publish_time ⇒ String

The timestamp when the product is published by the retailer for the first time, which indicates the freshness of the products. Note that this field is different from available_time, given it purely describes product freshness regardless of when it is available on search and recommendation. Corresponds to the JSON property publishTime

Returns:

  • (String) 


2263
2264
2265
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2263

def publish_time
  @publish_time
end

#rating ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRating

The rating of a Product. Corresponds to the JSON property rating

Returns:



2268
2269
2270
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2268

def rating
  @rating
end

#retrievable_fields ⇒ String

Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type. COLLECTION: * categories * description * images Supported fields only for Type. VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is returned. Note: Returning more fields in SearchResponse may increase response payload size and serving latency. Corresponds to the JSON property retrievableFields

Returns:

  • (String) 


2285
2286
2287
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2285

def retrievable_fields
  @retrievable_fields
end

#sizes ⇒ Array<String>

The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value 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 size, size_type and size_system. Schema.org property Product.size. Corresponds to the JSON property sizes

Returns:

  • (Array<String>) 


2301
2302
2303
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2301

def sizes
  @sizes
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>) 


2311
2312
2313
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2311

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) 


2320
2321
2322
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2320

def title
  @title
end

#ttl ⇒ String

Input only. The TTL (time to live) of the product. If it is set, expire_time is set as current timestamp plus ttl. The derived expire_time is returned in the output and ttl is left blank when retrieving the Product. If it is set, the product is not available for SearchService.Search after current timestamp plus ttl. However, the product can still be retrieved by ProductService. GetProduct and ProductService.ListProducts. Corresponds to the JSON property ttl

Returns:

  • (String) 


2330
2331
2332
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2330

def ttl
  @ttl
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) 


2336
2337
2338
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2336

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) 


2347
2348
2349
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2347

def uri
  @uri
end

#variants ⇒ Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct>

Output only. Product variants grouped together on primary product which share similar product attributes. It's automatically grouped by primary_product_id for all the product variants. Only populated for Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. Corresponds to the JSON property variants

Returns:



2356
2357
2358
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2356

def variants
  @variants
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2363

def update!(**args)
  @attributes = args[:attributes] if args.key?(:attributes)
  @audience = args[:audience] if args.key?(:audience)
  @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)
  @brands = args[:brands] if args.key?(:brands)
  @categories = args[:categories] if args.key?(:categories)
  @collection_member_ids = args[:collection_member_ids] if args.key?(:collection_member_ids)
  @color_info = args[:color_info] if args.key?(:color_info)
  @conditions = args[:conditions] if args.key?(:conditions)
  @description = args[:description] if args.key?(:description)
  @expire_time = args[:expire_time] if args.key?(:expire_time)
  @fulfillment_info = args[:fulfillment_info] if args.key?(:fulfillment_info)
  @gtin = args[:gtin] if args.key?(:gtin)
  @id = args[:id] if args.key?(:id)
  @images = args[:images] if args.key?(:images)
  @language_code = args[:language_code] if args.key?(:language_code)
  @materials = args[:materials] if args.key?(:materials)
  @name = args[:name] if args.key?(:name)
  @patterns = args[:patterns] if args.key?(:patterns)
  @price_info = args[:price_info] if args.key?(:price_info)
  @primary_product_id = args[:primary_product_id] if args.key?(:primary_product_id)
  @promotions = args[:promotions] if args.key?(:promotions)
  @publish_time = args[:publish_time] if args.key?(:publish_time)
  @rating = args[:rating] if args.key?(:rating)
  @retrievable_fields = args[:retrievable_fields] if args.key?(:retrievable_fields)
  @sizes = args[:sizes] if args.key?(:sizes)
  @tags = args[:tags] if args.key?(:tags)
  @title = args[:title] if args.key?(:title)
  @ttl = args[:ttl] if args.key?(:ttl)
  @type = args[:type] if args.key?(:type)
  @uri = args[:uri] if args.key?(:uri)
  @variants = args[:variants] if args.key?(:variants)
end