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.
Attributes
Name
Description
requirement_key
str
The key that represents a quality requirement rule.
Supported keys:
- "has-valid-uri": product has a valid and accessible
uri.
- "available-expire-time-conformance":
Product.available_time
is early than "now", and
Product.expire_time
is greater than "now".
- "has-searchable-attributes": product has at least one
attribute
set to searchable.
- "has-description": product has non-empty
description.
- "has-at-least-bigram-title": Product
title has at
least two words. A comprehensive title helps to improve
search quality.
- "variant-has-image": the
variant
products has at least one
image. You
may ignore this metric if all your products are at
primary
level.
- "variant-has-price-info": the
variant
products has
price_info
set. You may ignore this metric if all your products are
at
primary
level.
- "has-publish-time": product has non-empty
publish_time.
qualified_product_count
int
Number of products passing the quality
requirement check. We only check searchable
products.
unqualified_product_count
int
Number of products failing the quality
requirement check. We only check searchable
products.
suggested_quality_percent_threshold
float
Value from 0 to 100 representing the suggested percentage of
products that meet the quality requirements to get good
search and recommendation performance. 100 \*
(qualified_product_count) / (qualified_product_count +
unqualified_product_count) should be greater or equal to
this suggestion.
unqualified_sample_products
MutableSequence[google.cloud.retail_v2alpha.types.Product]
A list of a maximum of 100 sample products that do not
qualify for this requirement.
This field is only populated in the response to
BranchService.GetBranch
API, and is always empty for
BranchService.ListBranches.
Only the following fields are set in the
Product.
- Product.name
- Product.id
- Product.title
[[["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 QualityMetric (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.QualityMetric)\n- [2.4.0](/python/docs/reference/retail/2.4.0/google.cloud.retail_v2alpha.types.Branch.QualityMetric)\n- [2.3.0](/python/docs/reference/retail/2.3.0/google.cloud.retail_v2alpha.types.Branch.QualityMetric)\n- [2.2.0](/python/docs/reference/retail/2.2.0/google.cloud.retail_v2alpha.types.Branch.QualityMetric)\n- [2.1.0](/python/docs/reference/retail/2.1.0/google.cloud.retail_v2alpha.types.Branch.QualityMetric)\n- [2.0.0](/python/docs/reference/retail/2.0.0/google.cloud.retail_v2alpha.types.Branch.QualityMetric)\n- [1.25.0](/python/docs/reference/retail/1.25.0/google.cloud.retail_v2alpha.types.Branch.QualityMetric)\n- [1.24.0](/python/docs/reference/retail/1.24.0/google.cloud.retail_v2alpha.types.Branch.QualityMetric)\n- [1.23.1](/python/docs/reference/retail/1.23.1/google.cloud.retail_v2alpha.types.Branch.QualityMetric)\n- [1.22.0](/python/docs/reference/retail/1.22.0/google.cloud.retail_v2alpha.types.Branch.QualityMetric)\n- [1.21.2](/python/docs/reference/retail/1.21.2/google.cloud.retail_v2alpha.types.Branch.QualityMetric)\n- [1.20.1](/python/docs/reference/retail/1.20.1/google.cloud.retail_v2alpha.types.Branch.QualityMetric)\n- [1.19.1](/python/docs/reference/retail/1.19.1/google.cloud.retail_v2alpha.types.Branch.QualityMetric)\n- [1.18.0](/python/docs/reference/retail/1.18.0/google.cloud.retail_v2alpha.types.Branch.QualityMetric)\n- [1.17.0](/python/docs/reference/retail/1.17.0/google.cloud.retail_v2alpha.types.Branch.QualityMetric)\n- [1.16.3](/python/docs/reference/retail/1.16.3/google.cloud.retail_v2alpha.types.Branch.QualityMetric)\n- [1.15.1](/python/docs/reference/retail/1.15.1/google.cloud.retail_v2alpha.types.Branch.QualityMetric)\n- [1.14.1](/python/docs/reference/retail/1.14.1/google.cloud.retail_v2alpha.types.Branch.QualityMetric)\n- [1.13.0](/python/docs/reference/retail/1.13.0/google.cloud.retail_v2alpha.types.Branch.QualityMetric)\n- [1.12.0](/python/docs/reference/retail/1.12.0/google.cloud.retail_v2alpha.types.Branch.QualityMetric)\n- [1.11.0](/python/docs/reference/retail/1.11.0/google.cloud.retail_v2alpha.types.Branch.QualityMetric)\n- [1.10.2](/python/docs/reference/retail/1.10.2/google.cloud.retail_v2alpha.types.Branch.QualityMetric)\n- [1.9.0](/python/docs/reference/retail/1.9.0/google.cloud.retail_v2alpha.types.Branch.QualityMetric)\n- [1.8.1](/python/docs/reference/retail/1.8.1/google.cloud.retail_v2alpha.types.Branch.QualityMetric)\n- [1.7.0](/python/docs/reference/retail/1.7.0/google.cloud.retail_v2alpha.types.Branch.QualityMetric)\n- [1.6.1](/python/docs/reference/retail/1.6.1/google.cloud.retail_v2alpha.types.Branch.QualityMetric)\n- [1.5.0](/python/docs/reference/retail/1.5.0/google.cloud.retail_v2alpha.types.Branch.QualityMetric)\n- [1.4.1](/python/docs/reference/retail/1.4.1/google.cloud.retail_v2alpha.types.Branch.QualityMetric)\n- [1.3.0](/python/docs/reference/retail/1.3.0/google.cloud.retail_v2alpha.types.Branch.QualityMetric)\n- [1.2.1](/python/docs/reference/retail/1.2.1/google.cloud.retail_v2alpha.types.Branch.QualityMetric)\n- [1.1.0](/python/docs/reference/retail/1.1.0/google.cloud.retail_v2alpha.types.Branch.QualityMetric)\n- [1.0.2](/python/docs/reference/retail/1.0.2/google.cloud.retail_v2alpha.types.Branch.QualityMetric)\n- [0.4.2](/python/docs/reference/retail/0.4.2/google.cloud.retail_v2alpha.types.Branch.QualityMetric)\n- [0.3.1](/python/docs/reference/retail/0.3.1/google.cloud.retail_v2alpha.types.Branch.QualityMetric)\n- [0.2.0](/python/docs/reference/retail/0.2.0/google.cloud.retail_v2alpha.types.Branch.QualityMetric)\n- [0.1.0](/python/docs/reference/retail/0.1.0/google.cloud.retail_v2alpha.types.Branch.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."]]