Class GoogleCloudRecommendationengineV1beta1CatalogItem
CatalogItem captures all metadata information of items to be recommended.
Implements
Inherited Members
Namespace: Google.Apis.RecommendationsAI.v1beta1.Data
Assembly: Google.Apis.RecommendationsAI.v1beta1.dll
Syntax
public class GoogleCloudRecommendationengineV1beta1CatalogItem : IDirectResponseSchema
Properties
CategoryHierarchies
Required. 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" -> "Shoes"] and ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be represented as: "categoryHierarchies": [ { "categories": ["Shoes & Accessories", "Shoes"]}, { "categories": ["Sports & Fitness", "Athletic Clothing", "Shoes"] } ]
Declaration
[JsonProperty("categoryHierarchies")]
public virtual IList<GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchy> CategoryHierarchies { get; set; }
Property Value
Type | Description |
---|---|
IList<GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchy> |
Description
Optional. Catalog item description. UTF-8 encoded string with a length limit of 5 KiB.
Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type | Description |
---|---|
string |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
Id
Required. Catalog item identifier. UTF-8 encoded string with a length limit of 128 bytes. This id must be unique among all catalog items within the same catalog. It should also be used when logging user events in order for the user events to be joined with the Catalog.
Declaration
[JsonProperty("id")]
public virtual string Id { get; set; }
Property Value
Type | Description |
---|---|
string |
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.
Declaration
[JsonProperty("itemAttributes")]
public virtual GoogleCloudRecommendationengineV1beta1FeatureMap ItemAttributes { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudRecommendationengineV1beta1FeatureMap |
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.
Declaration
[JsonProperty("itemGroupId")]
public virtual string ItemGroupId { get; set; }
Property Value
Type | Description |
---|---|
string |
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.
Declaration
[JsonProperty("languageCode")]
public virtual string LanguageCode { get; set; }
Property Value
Type | Description |
---|---|
string |
ProductMetadata
Optional. Metadata specific to retail products.
Declaration
[JsonProperty("productMetadata")]
public virtual GoogleCloudRecommendationengineV1beta1ProductCatalogItem ProductMetadata { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudRecommendationengineV1beta1ProductCatalogItem |
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.
Declaration
[JsonProperty("tags")]
public virtual IList<string> Tags { get; set; }
Property Value
Type | Description |
---|---|
IList<string> |
Title
Required. Catalog item title. UTF-8 encoded string with a length limit of 1 KiB.
Declaration
[JsonProperty("title")]
public virtual string Title { get; set; }
Property Value
Type | Description |
---|---|
string |