Difference between revisions of "GetNodeRecommendations"

From Gvp-public
Jump to navigation Jump to search
Line 1: Line 1:
 
{{Api_Method_Spec|
 
{{Api_Method_Spec|
Description=Get a Recommendation from the GVP Platform using many data information to get a personal content to present for the user. This method was created to analyse all content in the GVP and find the better content to suggest for the user to watch.
+
Description=Get a Recommendation from the GVP Platform using many data information to get a personal content to present for the user. The content showed is analysed to find the better content and make some predict of content the user would like to watch.
  
  
Line 18: Line 18:
  
  
All these methods are from OpenGVP, and they use that BackendAPI to get all contents and analyse that to return some recommendation. So, the UNIAPI is like a proxy between the client device and the OpenGVP by these four methods.
+
All these methods are in the UNIAPI, on the GVP. So, they work as a proxy between the devices and BackendAPI. This flow is the way to get the complete information from OpenGVP but allowing the authentication stay in the UNIAPI side. In other words, to use the OpenGVP data, the device should make a passthrough by the UNIAPI to authentication and then get the JSON result from the OpenGVP by these four methods.
  
The OpenGVP should be active and configured in each Environment and Instance to be used.
+
The OpenGVP can be active/desactive and configured in each Environment and Instance to be used.
 
GetNodeRecommendations only can be used in some node of channels, so it can't be used by RootChannel.
 
GetNodeRecommendations only can be used in some node of channels, so it can't be used by RootChannel.
  

Revision as of 12:37, 22 August 2014

Description

Get a Recommendation from the GVP Platform using many data information to get a personal content to present for the user. The content showed is analysed to find the better content and make some predict of content the user would like to watch.


The related methods is:

- GetFullView

- GetNodeRecommendations

- GetNodeRecommendationsByView

- GetNodeRecommendationsCombined

And the legacy method:

- GetUserRecommendations


All these methods are in the UNIAPI, on the GVP. So, they work as a proxy between the devices and BackendAPI. This flow is the way to get the complete information from OpenGVP but allowing the authentication stay in the UNIAPI side. In other words, to use the OpenGVP data, the device should make a passthrough by the UNIAPI to authentication and then get the JSON result from the OpenGVP by these four methods.

The OpenGVP can be active/desactive and configured in each Environment and Instance to be used. GetNodeRecommendations only can be used in some node of channels, so it can't be used by RootChannel.

This method only can be used by logged user.

Parameters

  • token (String, required)
A valid token for identifying the API session context. The token can be anonymous or logged.
  • channelId (int, required)
  • contentType (int, optional)
  • num (int, optional)
  • sources (int, optional)
  • catalogType (int, optional)


Returns

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

Example:

{

"StatusCode": 0,
"Severity": 1,
"StatusMessage": "OK",
"Content": {
Array of SimpleItem objects
}

}


Exceptions

  • None


Caching

This method is not cached.


Known issues

  • None


Version history

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


See also