Retail v2 API - Class CatalogAttribute.Types.FacetConfig (2.11.0)

Version latest

• 2.11.0 (latest)
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class CatalogAttribute.Types.FacetConfig : IMessage<CatalogAttribute.Types.FacetConfig>, IEquatable<CatalogAttribute.Types.FacetConfig>, IDeepCloneable<CatalogAttribute.Types.FacetConfig>, IBufferMessage, IMessage

Reference documentation and code samples for the Retail v2 API class CatalogAttribute.Types.FacetConfig.

Possible options for the facet that corresponds to the current attribute config.

Inheritance

object > CatalogAttribute.Types.FacetConfig

Implements

IMessageCatalogAttributeTypesFacetConfig, IEquatableCatalogAttributeTypesFacetConfig, IDeepCloneableCatalogAttributeTypesFacetConfig, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

FacetConfig()

public FacetConfig()

FacetConfig(FacetConfig)

public FacetConfig(CatalogAttribute.Types.FacetConfig other)

Parameter
Name	Description
other	CatalogAttributeTypesFacetConfig

Properties

FacetIntervals

public RepeatedField<Interval> FacetIntervals { get; }

If you don't set the facet [SearchRequest.FacetSpec.FacetKey.intervals][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.intervals] in the request to a numerical attribute, then we use the computed intervals with rounded bounds obtained from all its product numerical attribute values. The computed intervals might not be ideal for some attributes. Therefore, we give you the option to overwrite them with the facet_intervals field. The maximum of facet intervals per [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] is 40. Each interval must have a lower bound or an upper bound. If both bounds are provided, then the lower bound must be smaller or equal than the upper bound.

Property Value
Type	Description
RepeatedFieldInterval

IgnoredFacetValues

public RepeatedField<CatalogAttribute.Types.FacetConfig.Types.IgnoredFacetValues> IgnoredFacetValues { get; }

Each instance represents a list of attribute values to ignore as facet values for a specific time range. The maximum number of instances per [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] is 25.

Property Value
Type	Description
RepeatedFieldCatalogAttributeTypesFacetConfigTypesIgnoredFacetValues

MergedFacet

public CatalogAttribute.Types.FacetConfig.Types.MergedFacet MergedFacet { get; set; }

Use this field only if you want to merge a facet key into another facet key.

Property Value
Type	Description
CatalogAttributeTypesFacetConfigTypesMergedFacet

MergedFacetValues

public RepeatedField<CatalogAttribute.Types.FacetConfig.Types.MergedFacetValue> MergedFacetValues { get; }

Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] is 100. This feature is available only for textual custom attributes.

Property Value
Type	Description
RepeatedFieldCatalogAttributeTypesFacetConfigTypesMergedFacetValue

RerankConfig

public CatalogAttribute.Types.FacetConfig.Types.RerankConfig RerankConfig { get; set; }

Set this field only if you want to rerank based on facet values engaged by the user for the current key. This option is only possible for custom facetable textual keys.

Property Value
Type	Description
CatalogAttributeTypesFacetConfigTypesRerankConfig