$itemId : string
The itemId is a unique identifier of the item.
Strings in the PHP client are always UTF-8 encoded.
An item is something that can be recommended to users.
$hidden : boolean
The value of hidden. A hidden item will be never recommended.
$nameValues : array<mixed,\GravityNameValue>
The NameValues for the item.
NameValues provide additional description of the item.
There can multiple NameValues with the same name.
The order of NameValues among different names will not be preserved, but the order of the values for the same name will be preserved.
The recommendation engine can be configured to use some properties to create a relation between items.
A possible list of names:
|Title||Yes||The title of the item.|
|Description||Yes||The description of item.|
|CategoryPath||No||The full path of the item's category. For example, CategoryPath might be "books/computers/databases" for a book about databases. CategoryPath can be repeated if an item belongs to multiple categories. Use "/" only for separating levels. Later it is possible to use the recommendation engine to filter the list of items based on category, so it can provide recommendations for "Computer Books" category or only for "Computer Books > Database" category.|
|Tags||No||Tags for the item. Specify a separate namevalue for each tag.|
|State||No||The state of the item, for example 'available', 'out of stock' etc.|
|Price||No||The price of the item.|
The recommendation engine can accept arbitrary namevalues, the list above is just an example of basic properties that are used almost everywhere. The NameValues which are relevant to business rules and possible content based filtering should be provided to the recommendation engine.
You can use localization by appending a language identifier to the Name of the NameValue. For example, Title_EN, Title_HU. It is possible to use both non-localized and localized version.