Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1323281242.5 KB
projects

Creates and returns a new product resource. Possible errors: * Returns INVALID_ARGUMENT if display_name is missing or longer than 4096 characters. * Returns INVALID_ARGUMENT if description is longer than 4096 characters. * Returns INVALID_ARGUMENT if product_category is missing or invalid.

post/v1/{+parent}/products

Path parameters

parentstring required

Required. The project in which the Product should be created. Format is projects/PROJECT_ID/locations/LOC_ID.

Query parameters

productIdstring

A user-supplied resource id for this Product. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character /.

Request body

productCategorystring

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.

namestring

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.

descriptionstring

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

displayNamestring

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

Response

Successful response