API Documentation
\

\GravityItemRecommendation

Contains a list of recommended items. This class is here only to describe the result, the actual result will not be an instance of this class because of json deserialization.

Summary

Methods
Properties
Constants
__construct()
$items
$itemIds
$recommendationId
$outputNameValues
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$items

$items : array<mixed,\GravityItem>

Array containing the recommended items.

This is populated only if the scenario specifies to do so, otherwise this is null. itemIds is always populated. The items in this list only have the NameValues specified by the scenario. The list of NameValues specified by the scenario can be overridden by the GravityRecommendationContext resultNameValues on a per request basis.

Type

array<mixed,\GravityItem>

$itemIds

$itemIds : integer

The identifiers of the recommended items. Only if not a NameValue recommendation.

Type

integer

$recommendationId

$recommendationId : string

The unique identifier of the recommendation generated by the recommendation engine.

Strings in the PHP client are always UTF-8 encoded.

Type

string

$outputNameValues

$outputNameValues : array<mixed,\GravityNameValue>

Array containing additional name-value pairs for recommendations.

e.g.: AllItemCount for paging responses.

Type

array<mixed,\GravityNameValue>

Methods

__construct()

__construct()