Difference between revisions of "GetRootRecommendationsCombined"
| (4 intermediate revisions by 2 users not shown) | |||
| Line 6: | Line 6: | ||
All kinds of recommendation are combined in the same result with a SOURCE parameter added in the result. | All kinds of recommendation are combined in the same result with a SOURCE parameter added in the result. | ||
| − | SOURCES available: 1 - MostViewed | + | SOURCES available: |
| + | 1 - MostViewed | ||
| + | 2 - BestRated | ||
| + | 3 - Personal | ||
| + | 4 - Editorial. | ||
This method is similar to GetRootRecommendationsByView but in the same ViewSet. | This method is similar to GetRootRecommendationsByView but in the same ViewSet. | ||
| + | |||
| + | |||
| + | If Editorial recommendations are requested, that is, the value 4 is included in the comma-separated list inside in the sources input parameter at any position, they are the priority recommendations to be processed and to be included in the method response. Other requested recommendation types (sources) different than Editorial are processed and included in the method response in the order than they are included in the sources input parameter. | ||
| Line 18: | Line 25: | ||
- [[GetNodeRecommendations]] | - [[GetNodeRecommendations]] | ||
| − | - [[ | + | - [[GetRootRecommendationsByView]] |
| − | - [[ | + | - [[GetRootRecommendationsCombined]] |
And the legacy method: | And the legacy method: | ||
| Line 55: | Line 62: | ||
|ParamType=int | |ParamType=int | ||
|ParamRequired=optional | |ParamRequired=optional | ||
| − | |ParamDescription= | + | |ParamDescription=Number that indicates the content type of the recommendation |
| + | 0 - Any: It returns both Movie and Series | ||
| + | 1 - Movie: Used for movies | ||
| + | 2 - Series: Used for TV series | ||
| + | |||
| + | |||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| Line 61: | Line 73: | ||
|ParamType=int | |ParamType=int | ||
|ParamRequired=optional | |ParamRequired=optional | ||
| − | |ParamDescription= | + | |ParamDescription=CatalogType: Number that indicates the sub-catalog to retrieve recommendations from (Subscrition or transactional) |
| + | 0 - Any: Transactional or subscription (hired by the user). Default for getNodeRecommendations and GetFullView | ||
| + | 1 - Subscription: Contents from subscriptions rented by the user (and inside the subscription sub-catalog). Default for GetRotRecommendationsCombined and GetRootREcommendationsByView | ||
| + | 2 - Transactional: Contents from transactional sub-catalog | ||
}} | }} | ||
|Returns= | |Returns= | ||
| − | Returns a JSON object containing a JSON with the personal recommendation | + | Returns a JSON object containing a JSON with the personal recommendation. |
'''Example:''' | '''Example:''' | ||
| Line 73: | Line 88: | ||
:: <span style="color: #a11;">"ItemList"</span>: [ | :: <span style="color: #a11;">"ItemList"</span>: [ | ||
::: { | ::: { | ||
| − | :::: Array of [[SimpleItem]] objects + Source properties. | + | :::: Array of [[SimpleItem]] (OpenGVP Type) objects + Source properties. |
::: } | ::: } | ||
:: ] | :: ] | ||
Latest revision as of 09:32, 13 July 2015
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 4 - Editorial.
This method is similar to GetRootRecommendationsByView but in the same ViewSet.
If Editorial recommendations are requested, that is, the value 4 is included in the comma-separated list inside in the sources input parameter at any position, they are the priority recommendations to be processed and to be included in the method response. Other requested recommendation types (sources) different than Editorial are processed and included in the method response in the order than they are included in the sources input parameter.
The related methods are:
- GetRootRecommendationsByView
- GetRootRecommendationsCombined
And the legacy method:
Notes: The OpenGVP can be active/desactive and configured in each Environment and Instance to be used.
GetRootRecommendationsCombined return only contents based on RootChannel.
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)
- Number that indicates the content type of the recommendation
0 - Any: It returns both Movie and Series 1 - Movie: Used for movies 2 - Series: Used for TV series
- catalogType (int, optional)
- CatalogType: Number that indicates the sub-catalog to retrieve recommendations from (Subscrition or transactional)
0 - Any: Transactional or subscription (hired by the user). Default for getNodeRecommendations and GetFullView 1 - Subscription: Contents from subscriptions rented by the user (and inside the subscription sub-catalog). Default for GetRotRecommendationsCombined and GetRootREcommendationsByView 2 - Transactional: Contents from transactional sub-catalog
Returns
Returns a JSON object containing a JSON with the personal recommendation.
Example:
{
- "Content": {
- "ItemList": [
- {
- Array of SimpleItem (OpenGVP Type) objects + Source properties.
- }
- {
- ]
- "ItemList": [
- }
}
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 |
