Vertex AI Search for Retail API (retail:v2alpha)

Additions

Methods


• ▼ ▲ retail.projects.locations.catalogs.branches.list

  Path : v2alpha/{+parent}/branches

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

  HTTP Method : GET

  Parameters :

  parent

  Description : Required. The parent catalog resource name.

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

  Location : path

  Required : Yes

  Type : string

  view

  Description : The view to apply to the returned Branch. Defaults to [Branch.BranchView.BASIC] if unspecified. See documentation of fields of Branch to find what fields are excluded from BASIC view.

  Location : query

  Type : string

  Enum Descriptions :

  • The value when it's unspecified. This defaults to the BASIC view.
  • Includes basic metadata about the branch, but not statistical fields. See documentation of fields of Branch to find what fields are excluded from BASIC view.
  • Includes all fields of a Branch.

  Enum :

  • BRANCH_VIEW_UNSPECIFIED
  • BRANCH_VIEW_BASIC
  • BRANCH_VIEW_FULL

  Parameter Order : parent

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

  Description : Lists all Branchs under the specified parent Catalog.

• ▼ ▲ retail.projects.locations.catalogs.branches.get

  Path : v2alpha/{+name}

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

  HTTP Method : GET

  Parameters :

  name

  Description : Required. The name of the branch to retrieve. Format: `projects/*/locations/global/catalogs/default_catalog/branches/some_branch_id`. "default_branch" can be used as a special branch_id, it returns the default branch that has been set for the catalog.

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

  Location : path

  Required : Yes

  Type : string

  view

  Description : The view to apply to the returned Branch. Defaults to [Branch.BranchView.BASIC] if unspecified. See documentation of fields of Branch to find what fields are excluded from BASIC view.

  Location : query

  Type : string

  Enum Descriptions :

  • The value when it's unspecified. This defaults to the BASIC view.
  • Includes basic metadata about the branch, but not statistical fields. See documentation of fields of Branch to find what fields are excluded from BASIC view.
  • Includes all fields of a Branch.

  Enum :

  • BRANCH_VIEW_UNSPECIFIED
  • BRANCH_VIEW_BASIC
  • BRANCH_VIEW_FULL

  Parameter Order : name

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

  Description : Retrieves a Branch.