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.



3061
3062
3063
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3061

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. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a non- empty UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. Corresponds to the JSON property attributes

Returns:



2756
2757
2758
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2756

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:



2761
2762
2763
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2761

def audience
  @audience
end

#availability ⇒ String

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

Returns:

  • (String) 


2769
2770
2771
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2769

def availability
  @availability
end

#available_quantity ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2774
2775
2776
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2774

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) 


2779
2780
2781
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2779

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. Corresponding properties: Google Merchant Center property brand. Schema.org property Product.brand. Corresponds to the JSON property brands

Returns:

  • (Array<String>) 


2788
2789
2790
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2788

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. Corresponding properties: 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>) 


2808
2809
2810
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2808

def categories
  @categories
end

#collection_member_ids ⇒ Array<String>

The id of the collection members when type is Type.COLLECTION. Non-existent product ids are allowed. The type of the members must be either Type.PRIMARY or Type.VARIANT otherwise and INVALID_ARGUMENT error is thrown. 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>) 


2817
2818
2819
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2817

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:



2822
2823
2824
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2822

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 1 value is 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. Corresponding properties: Google Merchant Center property condition. Schema.org property Offer.itemCondition. Corresponds to the JSON property conditions

Returns:

  • (Array<String>) 


2833
2834
2835
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2833

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. Corresponding properties: Google Merchant Center property description. Schema.org property Product. description. Corresponds to the JSON property description

Returns:

  • (String) 


2842
2843
2844
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2842

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. expire_time must be later than available_time and publish_time, otherwise an INVALID_ARGUMENT error is thrown. Corresponding properties: Google Merchant Center property expiration_date. Corresponds to the JSON property expireTime

Returns:

  • (String) 


2853
2854
2855
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2853

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:



2860
2861
2862
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2860

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. Corresponding properties: Google Merchant Center property gtin. Schema.org property Product.isbn, Product.gtin8, Product.gtin12, 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) 


2874
2875
2876
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2874

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. Corresponding properties: Google Merchant Center property id. Schema.org property Product.sku. Corresponds to the JSON property id

Returns:

  • (String) 


2885
2886
2887
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2885

def id
  @id
end

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

Product images for the product. We highly recommend putting the main image first. A maximum of 300 images are allowed. Corresponding properties: Google Merchant Center property image_link. Schema.org property Product.image. Corresponds to the JSON property images

Returns:



2893
2894
2895
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2893

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) 


2904
2905
2906
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2904

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 200 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property material. Schema.org property Product. material. Corresponds to the JSON property materials

Returns:

  • (Array<String>) 


2914
2915
2916
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2914

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) 


2920
2921
2922
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2920

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. Corresponding properties: Google Merchant Center property pattern. Schema.org property Product.pattern. Corresponds to the JSON property patterns

Returns:

  • (Array<String>) 


2931
2932
2933
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2931

def patterns
  @patterns
end

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

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

Returns:



2936
2937
2938
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2936

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. Corresponding properties: Google Merchant Center property item_group_id. Schema.org property Product.inProductGroupWithID. Corresponds to the JSON property primaryProductId

Returns:

  • (String) 


2948
2949
2950
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2948

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. Only Promotion.promotion_id will be used, other fields will be ignored if set. Corresponds to the JSON property promotions

Returns:



2955
2956
2957
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2955

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) 


2963
2964
2965
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2963

def publish_time
  @publish_time
end

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

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

Returns:



2968
2969
2970
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2968

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 The maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is returned. Note: Returning more fields in SearchResponse can increase response payload size and serving latency. Corresponds to the JSON property retrievableFields

Returns:

  • (String) 


2985
2986
2987
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2985

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. Corresponding properties: Google Merchant Center property size, size_type, and size_system. Schema.org property Product. size. Corresponds to the JSON property sizes

Returns:

  • (Array<String>) 


3002
3003
3004
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3002

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. Corresponding properties: Google Merchant Center property custom_label_0–4. Corresponds to the JSON property tags

Returns:

  • (Array<String>) 


3013
3014
3015
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3013

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. Corresponding properties: Google Merchant Center property title. Schema.org property Product.name. Corresponds to the JSON property title

Returns:

  • (String) 


3022
3023
3024
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3022

def title
  @title
end

#ttl ⇒ String

Input only. The TTL (time to live) of the product. If it is set, it must be a non-negative value, and 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) 


3033
3034
3035
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3033

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) 


3039
3040
3041
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3039

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. Corresponding properties: Google Merchant Center property link. Schema.org property Offer.url. Corresponds to the JSON property uri

Returns:

  • (String) 


3050
3051
3052
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3050

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:



3059
3060
3061
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3059

def variants
  @variants
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3066

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