Class: Google::Cloud::Retail::V2::CustomAttribute

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/retail/v2/common.rb

Overview

A custom attribute that is not explicitly modeled in Product.

Instance Attribute Summary collapse

Instance Attribute Details

#indexable ⇒ ::Boolean

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns 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:



516
517
518
519
 
# File 'proto_docs/google/cloud/retail/v2/common.rb', line 516

class CustomAttribute
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#numbers ⇒ ::Array<::Float>

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



516
517
518
519
 
# File 'proto_docs/google/cloud/retail/v2/common.rb', line 516

class CustomAttribute
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#searchable ⇒ ::Boolean

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns 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:



516
517
518
519
 
# File 'proto_docs/google/cloud/retail/v2/common.rb', line 516

class CustomAttribute
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#text ⇒ ::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.



516
517
518
519
 
# File 'proto_docs/google/cloud/retail/v2/common.rb', line 516

class CustomAttribute
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end