Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::CatalogAttribute.
Catalog level attribute config for an attribute. For example, if customers want to enable/disable facet for a specific attribute.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#dynamic_facetable_option
def dynamic_facetable_option() -> ::Google::Cloud::Retail::V2::CatalogAttribute::DynamicFacetableOption- (::Google::Cloud::Retail::V2::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.
#dynamic_facetable_option=
def dynamic_facetable_option=(value) -> ::Google::Cloud::Retail::V2::CatalogAttribute::DynamicFacetableOption- value (::Google::Cloud::Retail::V2::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.
- (::Google::Cloud::Retail::V2::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.
#in_use
def in_use() -> ::Boolean-
(::Boolean) — Output only. Indicates whether this attribute has been used by any
products.
Trueif at least one Product is using this attribute in Product.attributes. Otherwise, this field isFalse.CatalogAttribute can be pre-loaded by using CatalogService.AddCatalogAttribute, [CatalogService.ImportCatalogAttributes][], or CatalogService.UpdateAttributesConfig APIs. This field is
Falsefor 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.
#indexable_option
def indexable_option() -> ::Google::Cloud::Retail::V2::CatalogAttribute::IndexableOption- (::Google::Cloud::Retail::V2::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.
#indexable_option=
def indexable_option=(value) -> ::Google::Cloud::Retail::V2::CatalogAttribute::IndexableOption- value (::Google::Cloud::Retail::V2::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.
- (::Google::Cloud::Retail::V2::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.
#key
def key() -> ::String-
(::String) — Required. Attribute name.
For example:
color,brands,attributes.custom_attribute, such asattributes.xyz. To be indexable, the attribute name can contain only alpha-numeric characters and underscores. For example, an attribute namedattributes.abc_xyzcan be indexed, but an attribute namedattributes.abc-xyzcannot be indexed.
#key=
def key=(value) -> ::String-
value (::String) — Required. Attribute name.
For example:
color,brands,attributes.custom_attribute, such asattributes.xyz. To be indexable, the attribute name can contain only alpha-numeric characters and underscores. For example, an attribute namedattributes.abc_xyzcan be indexed, but an attribute namedattributes.abc-xyzcannot be indexed.
-
(::String) — Required. Attribute name.
For example:
color,brands,attributes.custom_attribute, such asattributes.xyz. To be indexable, the attribute name can contain only alpha-numeric characters and underscores. For example, an attribute namedattributes.abc_xyzcan be indexed, but an attribute namedattributes.abc-xyzcannot be indexed.
#searchable_option
def searchable_option() -> ::Google::Cloud::Retail::V2::CatalogAttribute::SearchableOption-
(::Google::Cloud::Retail::V2::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.
#searchable_option=
def searchable_option=(value) -> ::Google::Cloud::Retail::V2::CatalogAttribute::SearchableOption-
value (::Google::Cloud::Retail::V2::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.
-
(::Google::Cloud::Retail::V2::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.
#type
def type() -> ::Google::Cloud::Retail::V2::CatalogAttribute::AttributeType- (::Google::Cloud::Retail::V2::CatalogAttribute::AttributeType) — Output only. The type of this attribute. This is derived from the attribute in Product.attributes.