REST Resource: projects.locations.products

Resource: Product

A Product contains ReferenceImages.

JSON representation
{
  "name": string,
  "displayName": string,
  "description": string,
  "productCategory": string,
  "productLabels": [
    {
      object(KeyValue)
    }
  ]
}
Fields
name

string

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.

displayName

string

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

description

string

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

productCategory

string

The category for the product identified by the reference image. This should be either "homegoods" or "apparel".

This field is immutable.

productLabels[]

object(KeyValue)

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

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 100 productLabels.

KeyValue

A product label represented as a key-value pair.

JSON representation
{
  "key": string,
  "value": string
}
Fields
key

string

The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.

value

string

The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.

Methods

create

Creates and returns a new product resource.

delete

Permanently deletes a product and its reference images.

get

Gets information associated with a Product.

list

Lists products in an unspecified order.

patch

Makes changes to a Product resource.
Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Vision API