Vertex AI Search for Retail API (retail:v2beta)

Additions

Methods


• ▼ ▲ retail.projects.locations.catalogs.attributesConfig.removeCatalogAttribute

  Path : v2beta/{+attributesConfig}:removeCatalogAttribute

  HTTP Method : POST

  Flat Path : v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/attributesConfig:removeCatalogAttribute

  Parameter Order : attributesConfig

  Description : Removes the specified CatalogAttribute from the AttributesConfig. If the CatalogAttribute to remove does not exist, a NOT_FOUND error is returned.

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

  Parameters :

  attributesConfig

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

  Type : string

  Required : Yes

  Location : path

  Description : Required. Full AttributesConfig resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig

• ▼ ▲ retail.projects.locations.catalogs.attributesConfig.addCatalogAttribute

  Parameter Order : attributesConfig

  Parameters :

  attributesConfig

  Type : string

  Location : path

  Required : Yes

  Description : Required. Full AttributesConfig resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig

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

  Path : v2beta/{+attributesConfig}:addCatalogAttribute

  HTTP Method : POST

  Flat Path : v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/attributesConfig:addCatalogAttribute

  Description : Adds the specified CatalogAttribute to the AttributesConfig. If the CatalogAttribute to add already exists, an ALREADY_EXISTS error is returned.

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

• ▼ ▲ retail.projects.locations.catalogs.attributesConfig.replaceCatalogAttribute

  Flat Path : v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/attributesConfig:replaceCatalogAttribute

  Path : v2beta/{+attributesConfig}:replaceCatalogAttribute

  Parameters :

  attributesConfig

  Location : path

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

  Type : string

  Description : Required. Full AttributesConfig resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig

  Required : Yes

  Parameter Order : attributesConfig

  HTTP Method : POST

  Description : Replaces the specified CatalogAttribute in the AttributesConfig by updating the catalog attribute with the same CatalogAttribute.key. If the CatalogAttribute to replace does not exist, a NOT_FOUND error is returned.

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

• ▼ ▲ retail.projects.locations.catalogs.getAttributesConfig

  HTTP Method : GET

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

  Parameter Order : name

  Flat Path : v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/attributesConfig

  Description : Gets an AttributesConfig.

  Path : v2beta/{+name}

  Parameters :

  name

  Required : Yes

  Type : string

  Description : Required. Full AttributesConfig resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig

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

  Location : path

• ▼ ▲ retail.projects.locations.catalogs.updateAttributesConfig

  Description : Updates the AttributesConfig. The catalog attributes in the request will be updated in the catalog, or inserted if they do not exist. Existing catalog attributes not included in the request will remain unchanged. Attributes that are assigned to products, but do not exist at the catalog level, are always included in the response. The product attribute is assigned default values for missing catalog attribute fields, e.g., searchable and dynamic facetable options.

  Flat Path : v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/attributesConfig

  HTTP Method : PATCH

  Parameters :

  updateMask

  Description : Indicates which fields in the provided AttributesConfig to update. The following is the only supported field: * AttributesConfig.catalog_attributes If not set, all supported fields are updated.

  Location : query

  Format : google-fieldmask

  Type : string

  name

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

  Type : string

  Required : Yes

  Description : Required. Immutable. The fully qualified resource name of the attribute config. Format: "projects/*/locations/*/catalogs/*/attributesConfig"

  Location : path

  Path : v2beta/{+name}

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

  Parameter Order : name