Class GoogleCloudRetailV2Product

Product captures all metadata information of items to be recommended or searched.

Inheritance

System.Object

GoogleCloudRetailV2Product

Implements

Google.Apis.Requests.IDirectResponseSchema

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Google.Apis.CloudRetail.v2.Data

Assembly: Google.Apis.CloudRetail.v2.dll

Syntax

public class GoogleCloudRetailV2Product : IDirectResponseSchema

Properties

Attributes

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.

Declaration

[JsonProperty("attributes")]
public virtual IDictionary<string, GoogleCloudRetailV2CustomAttribute> Attributes { get; set; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, GoogleCloudRetailV2CustomAttribute>

Availability

The online availability of the Product. Default to Availability.IN_STOCK. Google Merchant Center Property availability. Schema.org Property Offer.availability.

Declaration

[JsonProperty("availability")]
public virtual string Availability { get; set; }

Property Value

Type	Description
System.String

AvailableQuantity

The available quantity of the item.

Declaration

[JsonProperty("availableQuantity")]
public virtual int? AvailableQuantity { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

AvailableTime

The timestamp when this Product becomes available for recommendation.

Declaration

[JsonProperty("availableTime")]
public virtual object AvailableTime { get; set; }

Property Value

Type	Description
System.Object

Categories

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.

Declaration

[JsonProperty("categories")]
public virtual IList<string> Categories { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<System.String>

Description

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.

Declaration

[JsonProperty("description")]
public virtual string Description { get; set; }

Property Value

Type	Description
System.String

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
System.String

Id

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.

Declaration

[JsonProperty("id")]
public virtual string Id { get; set; }

Property Value

Type	Description
System.String

Images

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.

Declaration

[JsonProperty("images")]
public virtual IList<GoogleCloudRetailV2Image> Images { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<GoogleCloudRetailV2Image>

Name

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".

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
System.String

PriceInfo

Product price and cost information. Google Merchant Center property price.

Declaration

[JsonProperty("priceInfo")]
public virtual GoogleCloudRetailV2PriceInfo PriceInfo { get; set; }

Property Value

Type	Description
GoogleCloudRetailV2PriceInfo

PrimaryProductId

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.

Declaration

[JsonProperty("primaryProductId")]
public virtual string PrimaryProductId { get; set; }

Property Value

Type	Description
System.String

Tags

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.

Declaration

[JsonProperty("tags")]
public virtual IList<string> Tags { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<System.String>

Title

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.

Declaration

[JsonProperty("title")]
public virtual string Title { get; set; }

Property Value

Type	Description
System.String

Type

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

Declaration

[JsonProperty("type")]
public virtual string Type { get; set; }

Property Value

Type	Description
System.String

Uri

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.

Declaration

[JsonProperty("uri")]
public virtual string Uri { get; set; }

Property Value

Type	Description
System.String

Implements

Google.Apis.Requests.IDirectResponseSchema