Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::CustomAttribute.
A custom attribute that is not explicitly modeled in Product.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#indexable
def indexable() -> ::Boolean-
(::Boolean) — This field is normally ignored unless
AttributesConfig.attribute_config_level
of the Catalog is set to the deprecated
'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level
attribute configuration, see Configuration
modes.
If true, custom attribute values are indexed, so that they can be filtered,
faceted or boosted in
SearchService.Search.
This field is ignored in a UserEvent.
See SearchRequest.filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more details.
#indexable=
def indexable=(value) -> ::Boolean-
value (::Boolean) — This field is normally ignored unless
AttributesConfig.attribute_config_level
of the Catalog is set to the deprecated
'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level
attribute configuration, see Configuration
modes.
If true, custom attribute values are indexed, so that they can be filtered,
faceted or boosted in
SearchService.Search.
This field is ignored in a UserEvent.
See SearchRequest.filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more details.
-
(::Boolean) — This field is normally ignored unless
AttributesConfig.attribute_config_level
of the Catalog is set to the deprecated
'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level
attribute configuration, see Configuration
modes.
If true, custom attribute values are indexed, so that they can be filtered,
faceted or boosted in
SearchService.Search.
This field is ignored in a UserEvent.
See SearchRequest.filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more details.
#numbers
def numbers() -> ::Array<::Float>#numbers=
def numbers=(value) -> ::Array<::Float>#searchable
def searchable() -> ::Boolean-
(::Boolean) — This field is normally ignored unless
AttributesConfig.attribute_config_level
of the Catalog is set to the deprecated
'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level
attribute configuration, see Configuration
modes.
If true, custom attribute values are searchable by text queries in
SearchService.Search.
This field is ignored in a UserEvent.
Only set if type text is set. Otherwise, a INVALID_ARGUMENT error is returned.
#searchable=
def searchable=(value) -> ::Boolean-
value (::Boolean) — This field is normally ignored unless
AttributesConfig.attribute_config_level
of the Catalog is set to the deprecated
'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level
attribute configuration, see Configuration
modes.
If true, custom attribute values are searchable by text queries in
SearchService.Search.
This field is ignored in a UserEvent.
Only set if type text is set. Otherwise, a INVALID_ARGUMENT error is returned.
-
(::Boolean) — This field is normally ignored unless
AttributesConfig.attribute_config_level
of the Catalog is set to the deprecated
'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level
attribute configuration, see Configuration
modes.
If true, custom attribute values are searchable by text queries in
SearchService.Search.
This field is ignored in a UserEvent.
Only set if type text is set. Otherwise, a INVALID_ARGUMENT error is returned.
#text
def text() -> ::Array<::String>#text=
def text=(value) -> ::Array<::String>-
value (::Array<::String>) — The textual values of this custom attribute. For example,
["yellow", "green"]when the key is "color".Empty string is not allowed. Otherwise, an INVALID_ARGUMENT error is returned.
Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned.