Method: projects.locations.catalogs.branches.get

• HTTP request
• Path parameters
• Query parameters
• Request body
• Response body
• Authorization scopes
• IAM Permissions
• Try it!

Retrieves a Branch.

HTTP request

GET https://retail.googleapis.com/v2alpha/{name=projects/*/locations/*/catalogs/*/branches/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name	string 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 branchId, it returns the default branch that has been set for the catalog.

Query parameters

Parameters
view	enum (BranchView) 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.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Branch.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

• retail.branches.get

For more information, see the IAM documentation.