A data branch that stores all instances of
Products.
Attributes
Name
Description
name
str
Immutable. Full resource name of the branch, such as
projects/*/locations/global/catalogs/default_catalog/branches/branch_id.
display_name
str
Output only. Human readable name of the
branch to display in the UI.
is_default
bool
Output only. Indicates whether this branch is
set as the default branch of its parent catalog.
last_product_import_time
google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp of last import through
ProductService.ImportProducts.
Empty value means no import has been made to this branch.
MutableSequence[google.cloud.retail_v2alpha.types.Branch.QualityMetric]
Output only. The quality metrics measured among products of
this branch.
See
QualityMetric.requirement_key
for supported metrics. Metrics could be missing if failed to
retrieve.
This field is not populated in [BranchView.BASIC][] view.
Metric measured on a group of
Products against a certain
quality requirement. Contains the number of products that pass the
check and the number of products that don't.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Class Branch (2.5.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.5.0 (latest)](/python/docs/reference/retail/latest/google.cloud.retail_v2alpha.types.Branch)\n- [2.4.0](/python/docs/reference/retail/2.4.0/google.cloud.retail_v2alpha.types.Branch)\n- [2.3.0](/python/docs/reference/retail/2.3.0/google.cloud.retail_v2alpha.types.Branch)\n- [2.2.0](/python/docs/reference/retail/2.2.0/google.cloud.retail_v2alpha.types.Branch)\n- [2.1.0](/python/docs/reference/retail/2.1.0/google.cloud.retail_v2alpha.types.Branch)\n- [2.0.0](/python/docs/reference/retail/2.0.0/google.cloud.retail_v2alpha.types.Branch)\n- [1.25.0](/python/docs/reference/retail/1.25.0/google.cloud.retail_v2alpha.types.Branch)\n- [1.24.0](/python/docs/reference/retail/1.24.0/google.cloud.retail_v2alpha.types.Branch)\n- [1.23.1](/python/docs/reference/retail/1.23.1/google.cloud.retail_v2alpha.types.Branch)\n- [1.22.0](/python/docs/reference/retail/1.22.0/google.cloud.retail_v2alpha.types.Branch)\n- [1.21.2](/python/docs/reference/retail/1.21.2/google.cloud.retail_v2alpha.types.Branch)\n- [1.20.1](/python/docs/reference/retail/1.20.1/google.cloud.retail_v2alpha.types.Branch)\n- [1.19.1](/python/docs/reference/retail/1.19.1/google.cloud.retail_v2alpha.types.Branch)\n- [1.18.0](/python/docs/reference/retail/1.18.0/google.cloud.retail_v2alpha.types.Branch)\n- [1.17.0](/python/docs/reference/retail/1.17.0/google.cloud.retail_v2alpha.types.Branch)\n- [1.16.3](/python/docs/reference/retail/1.16.3/google.cloud.retail_v2alpha.types.Branch)\n- [1.15.1](/python/docs/reference/retail/1.15.1/google.cloud.retail_v2alpha.types.Branch)\n- [1.14.1](/python/docs/reference/retail/1.14.1/google.cloud.retail_v2alpha.types.Branch)\n- [1.13.0](/python/docs/reference/retail/1.13.0/google.cloud.retail_v2alpha.types.Branch)\n- [1.12.0](/python/docs/reference/retail/1.12.0/google.cloud.retail_v2alpha.types.Branch)\n- [1.11.0](/python/docs/reference/retail/1.11.0/google.cloud.retail_v2alpha.types.Branch)\n- [1.10.2](/python/docs/reference/retail/1.10.2/google.cloud.retail_v2alpha.types.Branch)\n- [1.9.0](/python/docs/reference/retail/1.9.0/google.cloud.retail_v2alpha.types.Branch)\n- [1.8.1](/python/docs/reference/retail/1.8.1/google.cloud.retail_v2alpha.types.Branch)\n- [1.7.0](/python/docs/reference/retail/1.7.0/google.cloud.retail_v2alpha.types.Branch)\n- [1.6.1](/python/docs/reference/retail/1.6.1/google.cloud.retail_v2alpha.types.Branch)\n- [1.5.0](/python/docs/reference/retail/1.5.0/google.cloud.retail_v2alpha.types.Branch)\n- [1.4.1](/python/docs/reference/retail/1.4.1/google.cloud.retail_v2alpha.types.Branch)\n- [1.3.0](/python/docs/reference/retail/1.3.0/google.cloud.retail_v2alpha.types.Branch)\n- [1.2.1](/python/docs/reference/retail/1.2.1/google.cloud.retail_v2alpha.types.Branch)\n- [1.1.0](/python/docs/reference/retail/1.1.0/google.cloud.retail_v2alpha.types.Branch)\n- [1.0.2](/python/docs/reference/retail/1.0.2/google.cloud.retail_v2alpha.types.Branch)\n- [0.4.2](/python/docs/reference/retail/0.4.2/google.cloud.retail_v2alpha.types.Branch)\n- [0.3.1](/python/docs/reference/retail/0.3.1/google.cloud.retail_v2alpha.types.Branch)\n- [0.2.0](/python/docs/reference/retail/0.2.0/google.cloud.retail_v2alpha.types.Branch)\n- [0.1.0](/python/docs/reference/retail/0.1.0/google.cloud.retail_v2alpha.types.Branch) \n\n Branch(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nA data branch that stores all instances of\nProducts.\n\nClasses\n-------\n\n### ProductCountStatistic\n\n ProductCountStatistic(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nA statistic about the number of products in a branch.\n\n### QualityMetric\n\n QualityMetric(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nMetric measured on a group of\nProducts against a certain\nquality requirement. Contains the number of products that pass the\ncheck and the number of products that don't."]]
