Vertex AI Search for Retail API (retail:v2alpha)

2021-12-08

1 new method

Additions

    Methods
  • retail.projects.locations.catalogs.branches.products.setLocalInventories

      Description: Set local inventory information for a Product with the provided list of places at a set timestamp. If a place in the provided list does not exist, the place will be created. If a place in the provided list already exists, it will be updated while respecting the last update timestamps of each inventory field. If an existing place is not in the provided list, it will be removed. This process is asynchronous. If the request is valid, the set operation will be enqueued and processed downstream. As a consequence, when a response is returned, set operations are not immediately manifested in the Product queried by GetProduct or ListProducts. When applying the set operation, this process takes a snapshot of currently existing places and their corresponding timestamps to determine the places to update. Avoid concurrent AddLocalInventories and RemoveLocalInventories calls, since they can introduce asynchronous updates that could be missed by the set operation. Local inventory information can only be updated with this method and other local inventory-specific methods. CreateProduct and UpdateProduct has no effect on local inventories. This feature is only available for users who have Retail Search enabled. Please submit a form [here](https://cloud.google.com/contact) to contact Cloud sales if you are interested in using Retail Search.

      Path: v2alpha/{+product}:setLocalInventories

      Parameters:

        product

          Required: Yes

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/branches/[^/]+/products/.*$

          Location: path

          Description: Required. Full resource name of Product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

      Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:setLocalInventories

      Parameter Order: product

      HTTP Method: POST

      Scopes: https://www.googleapis.com/auth/cloud-platform

1 removed method

Deletions

    Methods
  • retail.projects.locations.catalogs.branches.products.setLocalInventories

      Parameter Order: product

      HTTP Method: POST

      Path: v2alpha/{+product}:setLocalInventories

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Set local inventory information for a Product with the provided list of places at a set timestamp. If a place in the provided list does not exist, the place will be created. If a place in the provided list already exists, it will be updated while respecting the last update timestamps of each inventory field. If an existing place is not in the provided list, it will be removed. This process is asynchronous. If the request is valid, the set operation will be enqueued and processed downstream. As a consequence, when a response is returned, set operations are not immediately manifested in the Product queried by GetProduct or ListProducts. When applying the set operation, this process takes a snapshot of currently existing places and their corresponding timestamps to determine the places to update. Avoid concurrent AddLocalInventories and RemoveLocalInventories calls, since they can introduce asynchronous updates that could be missed by the set operation. Local inventory information can only be updated with this method and other local inventory-specific methods. CreateProduct and UpdateProduct has no effect on local inventories. This feature is only available for users who have Retail Search enabled. Please submit a form [here](https://cloud.google.com/contact) to contact Cloud sales if you are interested in using Retail Search.

      Parameters:

        product

          Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/branches/[^/]+/products/.*$

          Location: path

          Type: string

          Required: Yes

          Description: Required. Full resource name of Product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

      Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:setLocalInventories