Class CatalogAttribute (1.20.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.v2alpha.CatalogAttribute] that are neither in use by products nor predefined can be deleted. [Catalog attributes][google.cloud.retail.v2alpha.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_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. Must be specified, otherwise throws INVALID_FORMAT error.
`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. Must be specified, otherwise throws INVALID_FORMAT error.
`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. Must be specified, otherwise throws INVALID_FORMAT error.
`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.
`exact_searchable_option`	`google.cloud.retail_v2alpha.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_v2alpha.types.CatalogAttribute.RetrievableOption` If RETRIEVABLE_ENABLED, attribute values are retrievable in the search results. If unset, the server behavior defaults to RETRIEVABLE_DISABLED.

Classes

AttributeType

AttributeType(value)

The type of an attribute.

Values: UNKNOWN (0): The type of the attribute is unknown.

    Used when type cannot be derived from attribute that is not
    <xref uid="google.cloud.retail.v2alpha.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.

Values: DYNAMIC_FACETABLE_OPTION_UNSPECIFIED (0): Value used when unset. DYNAMIC_FACETABLE_ENABLED (1): Dynamic facetable option enabled for an attribute. DYNAMIC_FACETABLE_DISABLED (2): Dynamic facetable option disabled for an attribute.

ExactSearchableOption

ExactSearchableOption(value)

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

Values: EXACT_SEARCHABLE_OPTION_UNSPECIFIED (0): Value used when unset. EXACT_SEARCHABLE_ENABLED (1): Exact searchable option enabled for an attribute. EXACT_SEARCHABLE_DISABLED (2): Exact searchable option disabled for an attribute.

IndexableOption

IndexableOption(value)

The status of the indexable option of a catalog attribute.

Values: INDEXABLE_OPTION_UNSPECIFIED (0): Value used when unset. INDEXABLE_ENABLED (1): Indexable option enabled for an attribute. INDEXABLE_DISABLED (2): Indexable option disabled for an attribute.

RetrievableOption

RetrievableOption(value)

The status of the retrievable option of a catalog attribute.

Values: RETRIEVABLE_OPTION_UNSPECIFIED (0): Value used when unset. RETRIEVABLE_ENABLED (1): Retrievable option enabled for an attribute. RETRIEVABLE_DISABLED (2): Retrievable option disabled for an attribute.

SearchableOption

SearchableOption(value)

The status of the searchable option of a catalog attribute.

Values: SEARCHABLE_OPTION_UNSPECIFIED (0): Value used when unset. SEARCHABLE_ENABLED (1): Searchable option enabled for an attribute. SEARCHABLE_DISABLED (2): Searchable option disabled for an attribute.