Vertex AI Search for Retail API (retail:v2alpha)

2022-02-23

5 new methods

Additions

    Methods

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

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

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

      Path: v2alpha/{+attributesConfig}:addCatalogAttribute

      Parameter Order: attributesConfig

      Parameters:

        attributesConfig

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

          Type: string

          Required: Yes

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

          Location: path

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

      HTTP Method: POST

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

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

      Parameter Order: attributesConfig

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

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

      Parameters:

        attributesConfig

          Location: path

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

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

          Required: Yes

          Type: string

      Path: v2alpha/{+attributesConfig}:removeCatalogAttribute

      HTTP Method: POST

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

      Parameter Order: attributesConfig

      Path: v2alpha/{+attributesConfig}:replaceCatalogAttribute

      HTTP Method: POST

      Parameters:

        attributesConfig

          Required: Yes

          Type: string

          Location: path

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

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

      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

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

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

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

      Parameters:

        name

          Required: Yes

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

          Type: string

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

          Location: path

        updateMask

          Location: query

          Type: string

          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.

          Format: google-fieldmask

      Path: v2alpha/{+name}

      HTTP Method: PATCH

      Parameter Order: name

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

      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.

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

      Description: Gets an AttributesConfig.

      Parameter Order: name

      HTTP Method: GET

      Parameters:

        name

          Required: Yes

          Location: path

          Type: string

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

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

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

      Path: v2alpha/{+name}

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