Class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/retail_v2alpha/classes.rb,
lib/google/apis/retail_v2alpha/representations.rb,
lib/google/apis/retail_v2alpha/representations.rb

Overview

A custom attribute that is not explicitly modeled in Product.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2alphaCustomAttribute

Returns a new instance of GoogleCloudRetailV2alphaCustomAttribute.



1457
1458
1459
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1457

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#indexable ⇒ Boolean Also known as: indexable?

This field will only be used when AttributesConfig.attribute_config_level of the Catalog is 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG', if true, custom attribute values are indexed, so that it 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. Corresponds to the JSON property indexable

Returns:

  • (Boolean) 


1429
1430
1431
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1429

def indexable
  @indexable
end

#numbers ⇒ 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. Corresponds to the JSON property numbers

Returns:

  • (Array<Float>) 


1437
1438
1439
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1437

def numbers
  @numbers
end

#searchable ⇒ Boolean Also known as: searchable?

This field will only be used when AttributesConfig.attribute_config_level of the Catalog is 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG', 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. Corresponds to the JSON property searchable

Returns:

  • (Boolean) 


1446
1447
1448
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1446

def searchable
  @searchable
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. Corresponds to the JSON property text

Returns:

  • (Array<String>) 


1455
1456
1457
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1455

def text
  @text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1462
1463
1464
1465
1466
1467
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1462

def update!(**args)
  @indexable = args[:indexable] if args.key?(:indexable)
  @numbers = args[:numbers] if args.key?(:numbers)
  @searchable = args[:searchable] if args.key?(:searchable)
  @text = args[:text] if args.key?(:text)
end