Vertex AI Search for Retail API (retail:v2)

2022-08-02

6 new methods

Additions

    Methods
  • retail.projects.locations.catalogs.updateAttributesConfig

      Parameter Order : name

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

      HTTP Method : PATCH

      Parameters :

        name

          Type : string

          Location : path

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

          Required : Yes

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

        updateMask

          Format : google-fieldmask

          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

          Type : string

      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 : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/attributesConfig

      Path : v2/{+name}

  • retail.projects.locations.catalogs.getCompletionConfig

      HTTP Method : GET

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

      Parameter Order : name

      Parameters :

        name

          Type : string

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

          Required : Yes

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

          Location : path

      Description : Gets a CompletionConfig.

      Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/completionConfig

      Path : v2/{+name}

  • retail.projects.locations.catalogs.updateCompletionConfig

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

      Path : v2/{+name}

      Parameter Order : name

      Parameters :

        name

          Type : string

          Required : Yes

          Location : path

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

          Description : Required. Immutable. Fully qualified name `projects/*/locations/*/catalogs/*/completionConfig`

        updateMask

          Format : google-fieldmask

          Type : string

          Description : Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.auto_learning If not set, all supported fields are updated.

          Location : query

      Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/completionConfig

      HTTP Method : PATCH

      Description : Updates the CompletionConfigs.

  • retail.projects.locations.catalogs.getAttributesConfig

      Parameter Order : name

      Description : Gets an AttributesConfig.

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

      Path : v2/{+name}

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

      HTTP Method : GET

      Parameters :

        name

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

          Location : path

          Required : Yes

          Type : string

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

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

      Parameter Order : attributesConfig

      Parameters :

        attributesConfig

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

          Location : path

          Required : Yes

          Type : string

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

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

      HTTP Method : POST

      Path : v2/{+attributesConfig}:addCatalogAttribute

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

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

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

      Parameter Order : attributesConfig

      Path : v2/{+attributesConfig}:removeCatalogAttribute

      Parameters :

        attributesConfig

          Required : Yes

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

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

          Location : path

          Type : string

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

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

      HTTP Method : POST

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