Difference between revisions of "GetNodeRecommendations"
| 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. This method was created to analyse all content in the GVP and find the better content to suggest for the user to watch. | ||
| + | |||
The related methods is: | The related methods is: | ||
| Line 32: | Line 33: | ||
|ParamRequired=required | |ParamRequired=required | ||
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged. | |ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged. | ||
| + | }} | ||
| + | {{Api_Parameter| | ||
| + | ParamName=channelId | ||
| + | |ParamType=int | ||
| + | |ParamRequired=required | ||
| + | |ParamDescription= | ||
| + | }} | ||
| + | {{Api_Parameter| | ||
| + | ParamName=contentType | ||
| + | |ParamType=int | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription= | ||
| + | }} | ||
| + | {{Api_Parameter| | ||
| + | ParamName=num | ||
| + | |ParamType=int | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription= | ||
| + | }} | ||
| + | {{Api_Parameter| | ||
| + | ParamName=sources | ||
| + | |ParamType=int | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription= | ||
| + | }} | ||
| + | {{Api_Parameter| | ||
| + | ParamName=catalogType | ||
| + | |ParamType=int | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription= | ||
}} | }} | ||
Revision as of 21:12, 21 August 2014
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.
The related methods is:
- GetNodeRecommendationsByView
- GetNodeRecommendationsCombined
And the legacy method:
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.
The OpenGVP should be active 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 |
