Class CatalogAttribute (1.10.1)

Version 1.10.1

• 1.20.1 (latest)
• 1.20.0
• 1.19.1
• 1.18.0
• 1.17.0
• 1.16.3
• 1.15.1
• 1.14.1
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.2
• 1.9.0
• 1.8.1
• 1.7.0
• 1.6.1
• 1.5.0
• 1.4.1
• 1.3.0
• 1.2.1
• 1.1.0
• 1.0.2
• 0.4.2
• 0.3.1
• 0.2.0
• 0.1.0

CatalogAttribute(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Catalog level attribute config for an attribute. For example, if customers want to enable/disable facet for a specific attribute.

Attributes

Name	Description
key	str 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.
in_use	bool Output only. Indicates whether this attribute has been used by any products. ``True`` if at least one Product is using this attribute in Product.attributes. Otherwise, this field is ``False``. CatalogAttribute can be pre-loaded by using CatalogService.AddCatalogAttribute, CatalogService.ImportCatalogAttributes, or CatalogService.UpdateAttributesConfig APIs. This field is ``False`` for pre-loaded CatalogAttributes. Only pre-loaded CatalogAttributes that are neither in use by products nor predefined can be deleted. CatalogAttributes 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.
type_	google.cloud.retail_v2alpha.types.CatalogAttribute.AttributeType Output only. The type of this attribute. This is derived from the attribute in Product.attributes.
indexable_option	google.cloud.retail_v2alpha.types.CatalogAttribute.IndexableOption When 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.
dynamic_facetable_option	google.cloud.retail_v2alpha.types.CatalogAttribute.DynamicFacetableOption If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if CatalogAttribute.indexable_option is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned.
searchable_option	google.cloud.retail_v2alpha.types.CatalogAttribute.SearchableOption When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but attribute type is numerical, attribute values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical attributes.
recommendations_filtering_option	google.cloud.retail_v2alpha.types.RecommendationsFilteringOption When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if RECOMMENDATIONS_FILTERING_ENABLED, attribute values are filterable for recommendations. This option works for categorical features only, does not work for numerical features, inventory filtering.

Inheritance

builtins.object > proto.message.Message > CatalogAttribute

Classes

AttributeType

AttributeType(value)

The type of an attribute.

DynamicFacetableOption

DynamicFacetableOption(value)

The status of the dynamic facetable option of a catalog attribute.

IndexableOption

IndexableOption(value)

The status of the indexable option of a catalog attribute.

SearchableOption

SearchableOption(value)

The status of the searchable option of a catalog attribute.