GetCatalogItemResult class

Result data returned by getCatalogItem.

Constructors

GetCatalogItemResult({required List<GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchyResponse> categoryHierarchies, required String description, required GoogleCloudRecommendationengineV1beta1FeatureMapResponse itemAttributes, required String itemGroupId, required String languageCode, required GoogleCloudRecommendationengineV1beta1ProductCatalogItemResponse productMetadata, required List<String> tags, required String title})
Creates a new GetCatalogItemResult. categoryHierarchies Catalog item categories. This field is repeated for supporting one catalog item belonging to several parallel category hierarchies. For example, if a shoes product belongs to both "Shoes & Accessories" -&gt; "Shoes" and "Sports & Fitness" -&gt; "Athletic Clothing" -&gt; "Shoes", it could be represented as: "categoryHierarchies": [ { "categories": "Shoes & Accessories", "Shoes"}, { "categories": "Sports & Fitness", "Athletic Clothing", "Shoes" } ] description Optional. Catalog item description. UTF-8 encoded string with a length limit of 5 KiB. itemAttributes Optional. Highly encouraged. Extra catalog item attributes to be included in the recommendation model. For example, for retail 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 item attributes here. itemGroupId Optional. Variant group identifier for prediction results. UTF-8 encoded string with a length limit of 128 bytes. This field must be enabled before it can be used. Learn more. languageCode Optional. Deprecated. The model automatically detects the text language. Your catalog can include text in different languages, but duplicating catalog items to provide text in multiple languages can result in degraded model performance. productMetadata Optional. Metadata specific to retail products. tags Optional. Filtering tags associated with the catalog item. Each tag should be a UTF-8 encoded string with a length limit of 1 KiB. This tag can be used for filtering recommendation results by passing the tag as part of the predict request filter. title Catalog item title. UTF-8 encoded string with a length limit of 1 KiB.
const
GetCatalogItemResult.fromMap(Map<String, dynamic> map)
factory

Properties

categoryHierarchies → List<GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchyResponse>
Catalog item categories. This field is repeated for supporting one catalog item belonging to several parallel category hierarchies. For example, if a shoes product belongs to both "Shoes & Accessories" -&gt; "Shoes" and "Sports & Fitness" -&gt; "Athletic Clothing" -&gt; "Shoes", it could be represented as: "categoryHierarchies": [ { "categories": "Shoes & Accessories", "Shoes"}, { "categories": "Sports & Fitness", "Athletic Clothing", "Shoes" } ]
final
description → String
Optional. Catalog item description. UTF-8 encoded string with a length limit of 5 KiB.
final
hashCode → int
The hash code for this object.
no setterinherited
itemAttributes → GoogleCloudRecommendationengineV1beta1FeatureMapResponse
Optional. Highly encouraged. Extra catalog item attributes to be included in the recommendation model. For example, for retail 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 item attributes here.
final
itemGroupId → String
Optional. Variant group identifier for prediction results. UTF-8 encoded string with a length limit of 128 bytes. This field must be enabled before it can be used. Learn more.
final
languageCode → String
Optional. Deprecated. The model automatically detects the text language. Your catalog can include text in different languages, but duplicating catalog items to provide text in multiple languages can result in degraded model performance.
final
productMetadata → GoogleCloudRecommendationengineV1beta1ProductCatalogItemResponse
Optional. Metadata specific to retail products.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags → List<String>
Optional. Filtering tags associated with the catalog item. Each tag should be a UTF-8 encoded string with a length limit of 1 KiB. This tag can be used for filtering recommendation results by passing the tag as part of the predict request filter.
final
title → String
Catalog item title. UTF-8 encoded string with a length limit of 1 KiB.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited