Resource: Branch
A data branch that stores all instances of Product
s.
JSON representation |
---|
{ "name": string, "displayName": string, "isDefault": boolean, "lastProductImportTime": string, "productCountStats": [ { object ( |
Fields | |
---|---|
name |
Immutable. Full resource name of the branch, such as |
displayName |
Output only. Human readable name of the branch to display in the UI. |
isDefault |
Output only. Indicates whether this branch is set as the default branch of its parent catalog. |
lastProductImportTime |
Output only. Timestamp of last import through A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
productCountStats[] |
Output only. Statistics for number of products in the branch, provided for different This field is not populated in [BranchView.BASIC][] view. |
qualityMetrics[] |
Output only. The quality metrics measured among products of this branch. See This field is not populated in [BranchView.BASIC][] view. |
ProductCountStatistic
A statistic about the number of products in a branch.
JSON representation |
---|
{
"scope": enum ( |
Fields | |
---|---|
scope |
[ProductCountScope] of the [counts]. |
counts |
The number of products in The key is a group representing a set of products, and the value is the number of products in that group. Note: keys in this map may change over time. Possible keys: * "primary-in-stock", products have
|
ProductCountScope
Scope of what products are included for this count.
Enums | |
---|---|
PRODUCT_COUNT_SCOPE_UNSPECIFIED |
Default value for enum. This value is not used in the API response. |
ALL_PRODUCTS |
Scope for all existing products in the branch. Useful for understanding how many products there are in a branch. |
LAST_24_HOUR_UPDATE |
Scope for products created or updated in the last 24 hours. |
QualityMetric
Metric measured on a group of Product
s against a certain quality requirement. Contains the number of products that pass the check and the number of products that don't.
JSON representation |
---|
{
"requirementKey": string,
"qualifiedProductCount": integer,
"unqualifiedProductCount": integer,
"suggestedQualityPercentThreshold": number,
"unqualifiedSampleProducts": [
{
object ( |
Fields | |
---|---|
requirementKey |
The key that represents a quality requirement rule. Supported keys: * "has-valid-uri": product has a valid and accessible
|
qualifiedProductCount |
Number of products passing the quality requirement check. We only check searchable products. |
unqualifiedProductCount |
Number of products failing the quality requirement check. We only check searchable products. |
suggestedQualityPercentThreshold |
Value from 0 to 100 representing the suggested percentage of products that meet the quality requirements to get good search and recommendation performance. 100 * (qualifiedProductCount) / (qualifiedProductCount + unqualifiedProductCount) should be greater or equal to this suggestion. |
unqualifiedSampleProducts[] |
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 Only the following fields are set in the |
Methods |
|
---|---|
|
Retrieves a Branch . |
|
Lists all instances of Branch under the specified parent Catalog . |