public sealed class CatalogAttribute : IMessage<CatalogAttribute>, IEquatable<CatalogAttribute>, IDeepCloneable<CatalogAttribute>, IBufferMessage, IMessageCatalog level attribute config for an attribute. For example, if customers want to enable/disable facet for a specific attribute.
Implements
IMessage<CatalogAttribute>, IEquatable<CatalogAttribute>, IDeepCloneable<CatalogAttribute>, IBufferMessage, IMessageNamespace
Google.Cloud.Retail.V2Assembly
Google.Cloud.Retail.V2.dll
Constructors
CatalogAttribute()
public CatalogAttribute()CatalogAttribute(CatalogAttribute)
public CatalogAttribute(CatalogAttribute other)| Parameter | |
|---|---|
| Name | Description |
other | CatalogAttribute |
Properties
DynamicFacetableOption
public CatalogAttribute.Types.DynamicFacetableOption DynamicFacetableOption { get; set; }If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if [CatalogAttribute.indexable_option][google.cloud.retail.v2.CatalogAttribute.indexable_option] is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned.
| Property Value | |
|---|---|
| Type | Description |
CatalogAttribute.Types.DynamicFacetableOption | |
IndexableOption
public CatalogAttribute.Types.IndexableOption IndexableOption { get; set; }When [AttributesConfig.attribute_config_level][google.cloud.retail.v2.AttributesConfig.attribute_config_level] is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered, faceted, or boosted in [SearchService.Search][google.cloud.retail.v2.SearchService.Search].
| Property Value | |
|---|---|
| Type | Description |
CatalogAttribute.Types.IndexableOption | |
InUse
public bool InUse { get; set; }Output only. Indicates whether this attribute has been used by any
products. True if at least one [Product][google.cloud.retail.v2.Product]
is using this attribute in
[Product.attributes][google.cloud.retail.v2.Product.attributes]. Otherwise,
this field is False.
[CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] can be
pre-loaded by using
[CatalogService.AddCatalogAttribute][google.cloud.retail.v2.CatalogService.AddCatalogAttribute],
[CatalogService.ImportCatalogAttributes][], or
[CatalogService.UpdateAttributesConfig][google.cloud.retail.v2.CatalogService.UpdateAttributesConfig]
APIs. This field is False for pre-loaded
[CatalogAttribute][google.cloud.retail.v2.CatalogAttribute]s.
Only pre-loaded [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute]s that are neither in use by products nor predefined can be deleted. [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute]s that are either in use by products or are predefined cannot be deleted; however, their configuration properties will reset to default values upon removal request.
After catalog changes, it takes about 10 minutes for this field to update.
| Property Value | |
|---|---|
| Type | Description |
Boolean | |
Key
public string Key { get; set; }Required. Attribute name.
For example: color, brands, attributes.custom_attribute, such as
attributes.xyz.
To be indexable, the attribute name can contain only alpha-numeric
characters and underscores. For example, an attribute named
attributes.abc_xyz can be indexed, but an attribute named
attributes.abc-xyz cannot be indexed.
| Property Value | |
|---|---|
| Type | Description |
String | |
SearchableOption
public CatalogAttribute.Types.SearchableOption SearchableOption { get; set; }When [AttributesConfig.attribute_config_level][google.cloud.retail.v2.AttributesConfig.attribute_config_level] is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values are searchable by text queries in [SearchService.Search][google.cloud.retail.v2.SearchService.Search].
If SEARCHABLE_ENABLED but attribute type is numerical, attribute values will not be searchable by text queries in [SearchService.Search][google.cloud.retail.v2.SearchService.Search], as there are no text values associated to numerical attributes.
| Property Value | |
|---|---|
| Type | Description |
CatalogAttribute.Types.SearchableOption | |
Type
public CatalogAttribute.Types.AttributeType Type { get; set; }Output only. The type of this attribute. This is derived from the attribute in [Product.attributes][google.cloud.retail.v2.Product.attributes].
| Property Value | |
|---|---|
| Type | Description |
CatalogAttribute.Types.AttributeType | |