Show / Hide Table of Contents

Class ProductSearchParams

Parameters for a product search request.

Inheritance
System.Object
ProductSearchParams
Implements
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.Vision.v1.Data
Assembly: Google.Apis.Vision.v1.dll
Syntax
public class ProductSearchParams : IDirectResponseSchema

Properties

BoundingPoly

The bounding polygon around the area of interest in the image. If it is not specified, system discretion will be applied.

Declaration
[JsonProperty("boundingPoly")]
public virtual BoundingPoly BoundingPoly { get; set; }
Property Value
Type Description
BoundingPoly

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
System.String

Filter

The filtering expression. This can be used to restrict search results based on Product labels. We currently support an AND of OR of key-value expressions, where each expression within an OR must have the same key. An '=' should be used to connect the key and value. For example, "(color = red OR color = blue) AND brand = Google" is acceptable, but "(color = red OR brand = Google)" is not acceptable. "color: red" is not acceptable because it uses a ':' instead of an '='.

Declaration
[JsonProperty("filter")]
public virtual string Filter { get; set; }
Property Value
Type Description
System.String

ProductCategories

The list of product categories to search in. Currently, we only consider the first category, and either "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1", or "general-v1" should be specified. The legacy categories "homegoods", "apparel", and "toys" are still supported but will be deprecated. For new products, please use "homegoods-v2", "apparel-v2", or "toys-v2" for better product search accuracy. It is recommended to migrate existing products to these categories as well.

Declaration
[JsonProperty("productCategories")]
public virtual IList<string> ProductCategories { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<System.String>

ProductSet

The resource name of a ProductSet to be searched for similar images. Format is: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID.

Declaration
[JsonProperty("productSet")]
public virtual string ProductSet { get; set; }
Property Value
Type Description
System.String

Implements

IDirectResponseSchema
In This Article
Back to top