Retail V2 API - Class Google::Cloud::Retail::V2::CustomAttribute (v0.16.0)

Version 0.16.0

• 0.20.0 (latest)
• 0.19.0
• 0.18.2
• 0.17.0
• 0.16.1
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.4

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

Returns

• (::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

Parameter

• 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.

Returns

• (::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>

Returns

• (::Array<::Float>) — The numerical values of this custom attribute. For example, [2.3, 15.4] when the key is "lengths_cm".

  Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned.

#numbers=

def numbers=(value) -> ::Array<::Float>

Parameter

• value (::Array<::Float>) — The numerical values of this custom attribute. For example, [2.3, 15.4] when the key is "lengths_cm".

  Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned.

Returns

• (::Array<::Float>) — The numerical values of this custom attribute. For example, [2.3, 15.4] when the key is "lengths_cm".

  Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned.

#searchable

def searchable() -> ::Boolean

Returns

• (::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

Parameter

• 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.

Returns

• (::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>

Returns

• (::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.

#text=

def text=(value) -> ::Array<::String>

Parameter

• 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.

Returns

• (::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.