Skip to content

Facet.md

Latest commit

 

History

History
26 lines (20 loc) · 1.53 KB

Facet.md

File metadata and controls

26 lines (20 loc) · 1.53 KB

GbRetailapiClient::Facet

Properties

Name Type Description Notes
prefix String Only get facet values that start with the given string prefix. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "prefixes" to "Women", the "categories" facet will give only "Women > Shoe" and "Women > Dress". Only supported on textual fields. Maximum is 10. This field is case-sensitive [optional]
contains String Only get facet values that contains the given strings. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "contains" to "Shoe", the "categories" facet will give only "Women > Shoe" and "Men > Shoe". Only supported on textual fields. Maximum is 10. This field is case-sensitive [optional]
display_name String Display name of facet [optional]
type NavigationType [optional]
navigation_name String Represents the name of navigation. [optional]

Example

require 'gb_retailapi_client'

instance = GbRetailapiClient::Facet.new(
  prefix: Women,
  contains: Shoe,
  display_name: anyName,
  type: null,
  navigation_name: anyName
)