public sealed class CatalogAttribute : IMessage<CatalogAttribute>, IEquatable<CatalogAttribute>, IDeepCloneable<CatalogAttribute>, IBufferMessage, IMessageReference documentation and code samples for the Retail v2 API class CatalogAttribute.
Catalog level attribute config for an attribute. For example, if customers want to enable/disable facet for a specific attribute.
Implements
IMessageCatalogAttribute, IEquatableCatalogAttribute, IDeepCloneableCatalogAttribute, IBufferMessage, IMessageNamespace
GoogleCloudGoogle.Cloud.RetailV2Assembly
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.
Must be specified, otherwise throws INVALID_FORMAT error.
| Property Value | |
|---|---|
| Type | Description |
CatalogAttributeTypesDynamicFacetableOption | |
ExactSearchableOption
public CatalogAttribute.Types.ExactSearchableOption ExactSearchableOption { get; set; }If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable. This property only applies to textual custom attributes and requires indexable set to enabled to enable exact-searchable. If unset, the server behavior defaults to [EXACT_SEARCHABLE_DISABLED][google.cloud.retail.v2.CatalogAttribute.ExactSearchableOption.EXACT_SEARCHABLE_DISABLED].
| Property Value | |
|---|---|
| Type | Description |
CatalogAttributeTypesExactSearchableOption | |
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].
Must be specified, otherwise throws INVALID_FORMAT error.
| Property Value | |
|---|---|
| Type | Description |
CatalogAttributeTypesIndexableOption | |
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 [catalog attributes][google.cloud.retail.v2.CatalogAttribute] that are neither in use by products nor predefined can be deleted. [Catalog attributes][google.cloud.retail.v2.CatalogAttribute] that are either in use by products or are predefined attributes 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 |
bool | |
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.
If the attribute key starts with attributes., then the attribute is a
custom attribute. Attributes such as brands, patterns, and title are
built-in and called system attributes.
| Property Value | |
|---|---|
| Type | Description |
string | |
RetrievableOption
public CatalogAttribute.Types.RetrievableOption RetrievableOption { get; set; }If RETRIEVABLE_ENABLED, attribute values are retrievable in the search results. If unset, the server behavior defaults to [RETRIEVABLE_DISABLED][google.cloud.retail.v2.CatalogAttribute.RetrievableOption.RETRIEVABLE_DISABLED].
| Property Value | |
|---|---|
| Type | Description |
CatalogAttributeTypesRetrievableOption | |
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.
Must be specified, otherwise throws INVALID_FORMAT error.
| Property Value | |
|---|---|
| Type | Description |
CatalogAttributeTypesSearchableOption | |
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 |
CatalogAttributeTypesAttributeType | |