This is the unified documentation for Retail API. This includes Recommendations AI, Retail Search, and the unified Retail console (which is applicable to both Recommendations AI and Retail Search users). To use the new console or Retail Search while they are in the restricted GA phase, submit a form here to contact Cloud sales. If you are using the v1beta version of Recommendations AI, migrate to the GA version: Migrating to the Retail API from beta.

To see documentation for only Recommendations AI and the Recommendations AI-only console, go to the How-to guides for Recommendations AI and the API reference documentation for Recommendations AI.

Method: projects.locations.catalogs.getDefaultBranch

Get which branch is currently default branch set by CatalogService.SetDefaultBranch method under a specified parent catalog.

This feature is only available for users who have Retail placements.search enabled. Please submit a form here to contact cloud sales if you are interested in using Retail placements.search.

HTTP request

GET https://retail.googleapis.com/v2/{catalog=projects/*/locations/*/catalogs/*}:getDefaultBranch

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
catalog

string

The parent catalog resource name, such as projects/*/locations/global/catalogs/default_catalog.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response message of CatalogService.GetDefaultBranch.

JSON representation
{
  "branch": string,
  "setTime": string,
  "note": string
}
Fields
branch

string

Full resource name of the branch id currently set as default branch.

setTime

string (Timestamp format)

The time when this branch is set to default.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

note

string

This corresponds to SetDefaultBranchRequest.note field, when this branch was set as default.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.