Google Cloud Vision v1 API - Class Product (3.4.0)

public sealed class Product : IMessage<Product>, IEquatable<Product>, IDeepCloneable<Product>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Vision v1 API class Product.

A Product contains ReferenceImages.

Inheritance

object > Product

Namespace

Google.Cloud.Vision.V1

Assembly

Google.Cloud.Vision.V1.dll

Constructors

Product()

public Product()

Product(Product)

public Product(Product other)
Parameter
NameDescription
otherProduct

Properties

Description

public string Description { get; set; }

User-provided metadata to be stored with this product. Must be at most 4096 characters long.

Property Value
TypeDescription
string

DisplayName

public string DisplayName { get; set; }

The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.

Property Value
TypeDescription
string

Name

public string Name { get; set; }

The resource name of the product.

Format is: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID.

This field is ignored when creating a product.

Property Value
TypeDescription
string

ProductCategory

public string ProductCategory { get; set; }

Immutable. The category for the product identified by the reference image. This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products.

Property Value
TypeDescription
string

ProductLabels

public RepeatedField<Product.Types.KeyValue> ProductLabels { get; }

Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels.

Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon.

Multiple values can be assigned to the same key. One product may have up to 500 product_labels.

Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet.

Property Value
TypeDescription
RepeatedFieldProductTypesKeyValue

ProductName

public ProductName ProductName { get; set; }

ProductName-typed view over the Name resource name property.

Property Value
TypeDescription
ProductName