Class CatalogAttribute (1.22.0)

Version latest

• 1.22.0 (latest)
• 1.21.2
• 1.20.1
• 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. 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.
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 [catalog attributes][google.cloud.retail.v2beta.CatalogAttribute] that are neither in use by products nor predefined can be deleted. [Catalog attributes][google.cloud.retail.v2beta.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.
type_	google.cloud.retail_v2beta.types.CatalogAttribute.AttributeType Output only. The type of this attribute. This is derived from the attribute in Product.attributes.
indexable_option	google.cloud.retail_v2beta.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. Must be specified when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.
dynamic_facetable_option	google.cloud.retail_v2beta.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. Must be specified, otherwise throws INVALID_FORMAT error.
searchable_option	google.cloud.retail_v2beta.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. Must be specified, when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.
recommendations_filtering_option	google.cloud.retail_v2beta.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.
exact_searchable_option	google.cloud.retail_v2beta.types.CatalogAttribute.ExactSearchableOption 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.
retrievable_option	google.cloud.retail_v2beta.types.CatalogAttribute.RetrievableOption If RETRIEVABLE_ENABLED, attribute values are retrievable in the search results. If unset, the server behavior defaults to RETRIEVABLE_DISABLED.
facet_config	google.cloud.retail_v2beta.types.CatalogAttribute.FacetConfig Contains facet options.

Classes

AttributeType

AttributeType(value)

The type of an attribute.

    Used when type cannot be derived from attribute that is not
    <xref uid="google.cloud.retail.v2beta.CatalogAttribute.in_use">in_use</xref>.
TEXTUAL (1):
    Textual attribute.
NUMERICAL (2):
    Numerical attribute.

DynamicFacetableOption

DynamicFacetableOption(value)

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

ExactSearchableOption

ExactSearchableOption(value)

The status of the exact-searchable option of a catalog attribute.

FacetConfig

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

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

IndexableOption

IndexableOption(value)

The status of the indexable option of a catalog attribute.

RetrievableOption

RetrievableOption(value)

The status of the retrievable option of a catalog attribute.

SearchableOption

SearchableOption(value)

The status of the searchable option of a catalog attribute.