Method: projects.locations.products.patch

Makes changes to a Product resource. Only the displayName, description, and labels fields can be updated right now.

If labels are updated, the change will not be reflected in queries until the next index time.

Possible errors:

  • Returns NOT_FOUND if the Product does not exist.
  • Returns INVALID_ARGUMENT if displayName is present in updateMask but is missing from the request or longer than 4096 characters.
  • Returns INVALID_ARGUMENT if description is present in updateMask but is longer than 4096 characters.
  • Returns INVALID_ARGUMENT if productCategory is present in updateMask.

HTTP request

PATCH https://vision.googleapis.com/v1p3beta1/{product.name=projects/*/locations/*/products/*}

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
product.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.

Query parameters

Parameters
updateMask

string (FieldMask format)

The FieldMask that specifies which fields to update. If updateMask isn't specified, all mutable fields are to be updated. Valid mask paths include productLabels, displayName, and description.

A comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of Product.

Response body

If successful, the response body contains an instance of Product.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

For more information, see the Authentication Overview.

Try it!

Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Vision API
Need help? Visit our support page.