Vertex AI Search for Retail API (retail:v2alpha)

Additions

Methods


• ▼ ▲ retail.projects.locations.catalogs.branches.products.purge

  Parameter Order: parent

  Description: Permanently deletes all selected Products under a branch. This process is asynchronous. If the request is valid, the removal will be enqueued and processed offline. Depending on the number of Products, this operation could take hours to complete. Before the operation completes, some Products may still be returned by GetProduct or ListProducts. Depending on the number of Products, this operation could take hours to complete. To get a sample of Products that would be deleted, set PurgeProductsRequest.force to false.

  Path: v2alpha/{+parent}/products:purge

  HTTP Method: POST

  Parameters:

  parent

  Location: path

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

  Description: Required. The resource name of the branch under which the products are created. The format is `projects/${projectId}/locations/global/catalogs/${catalogId}/branches/${branchId}`

  Required: Yes

  Type: string

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

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