GetRootRecommendationsCombined

From Gvp-public
Revision as of 21:24, 26 August 2014 by Rcalvo (talk | contribs)
Jump to navigation Jump to search

Description

Get a Recommendation from the GVP Platform. The GetRootRecommendationsCombined is a ByPass method to use the OpenGVP to get all contents analysed and that is the recommendation for the connected user.

The suggestion is made in the OpenGVP and sent to the UNIAPI in a JSON format.

All kinds of recommendation are combined in the same result with a SOURCE parameter added in the result.

SOURCES available: 1 - MostViewed, 2 - BestRated, 3 - Personal and 4 - Editorial.


The related methods are:

- GetFullView

- GetNodeRecommendations

- GetNodeRecommendationsByView

- GetNodeRecommendationsCombined

And the legacy method:

- GetUserRecommendations


Notes: The OpenGVP can be active/desactive and configured in each Environment and Instance to be used. GetNodeRecommendations can be used in some node of channels, since from RootChannel and others.

Parameters

  • token (String, required)
A valid token for identifying the API session context. The token can be anonymous or logged.
  • num (int, optional)
Quantity of recommendation wants to be returned. Each source will return the quantity specified by num parameter.
  • sources (int, optional)
Number separated by comma that represent a kind of content wants to be filter the result. (1 - MostViewed, 2 - BestRated, 3 - Personal, 4 - Editorial)
  • contentType (int, optional)
  • catalogType (int, optional)


Returns

Returns a JSON object containing a JSON with the personal recommendation as SimpleItem.

Example:

{

"Content": {
"ItemList": [
{
Array of SimpleItem objects + Source properties.
}
]
}

}


Exceptions

  • None


Caching

This method is not cached.


Known issues

  • None


Version history

API Version Number Change description Changes author
2.3 Initial method design Harley Cabral


See also