Changes

Jump to navigation Jump to search
1,618 bytes added ,  14:49, 2 October 2015
no edit summary
{{Api_Method_Spec|
Description=This method returns maps the recommendations Recom API method introduced in OpenGVP 3.0 for the userintegration with GVP through iTaas (named GetRecoms too). As per GVP3.2, it manages and returns exclusively movies and TV series. Unify openGVP recommendations It means that Banners (Editorial Recommendations non-related to a content) are not returned by this method. 
|Parameters=
}}
{{Api_Parameter|
ParamName=chennelIdchannelId
|ParamType=int
|ParamRequired=requiredoptional|ParamDescription=Id of the channel that wants to return the object information. If not passed or it takes the zero value, that is, the Root channel is used. This parameter only applies to VoD recommendations, that is, when the catalogType contains TVoD+SVOD User, SVoD User, SVoD or TVoD.
}}
{{Api_Parameter|
ParamName=num
|ParamType=int
|ParamRequired=requiredoptional|ParamDescription=Quantity of recommendation that wants to be returned. Each Number of items desired per source will return /view (when groupBySource=True) or overall number of items desired (when groupBySource=False). If not passed, the quantity specified by num parameterdefault value is: 5, when groupBySource=True; 50, when groupBySource=False.
}}
{{Api_Parameter|
ParamName=sources
|ParamType=intlist of source type enums|ParamRequired=requiredoptional|ParamDescription=Number A comma-separated by comma that represent a kind list of content wants desired source types to get recommendations from. In this case the engine will try its best to provide recommendations for all the requested views (though it might be filter possible that some views return fewer items than the resultrequested number). If this input param is not passed, a default value is used, according to the next criteria: If the instance is associated to a VoD catalog, VoD recommendations are requested (the catalogType is different than 8) and the channelId to use is the Root channel, the default value used is 4,3,1 - MostViewed, 2 - BestRated.Otherwise, the default value used is 3 - Personal, 1,2.If the list of sources include the 4 - Editorialvalue (editorial recommendation), this source is processed firstly.
}}
{{Api_Parameter|
ParamName=contentType
|ParamType=intContent Type enum
|ParamRequired=optional
|ParamDescription=Number that indicates Code for the content type of the recommendation to filter. Default is 0 - Any: It returns both Movie and Series 1 - Movie: Used for movies. 2 - Series: Used for TV series
}}
{{Api_Parameter|
ParamName=catalogType
|ParamType=intList of Catalog Type enums
|ParamRequired=optional
|ParamDescription=CatalogType: Number that indicates the subA comma-separated list of desired catalog types to retrieve get recommendations from (Subscrition or transactional). Some combination of catalog types are not allowed: 0 - Any: Transactional or subscription (hired by =TVoD+SVoD User and 3=SVoD cannot be given at the user)same time. Default for getNodeRecommendations and GetFullView 1 - Subscription: Contents from subscriptions rented by the user (=SVoD User and inside 3=SVoD cannot be given at the subscription sub-catalog)same time. Default for GetRotRecommendationsCombined and GetRootREcommendationsByView 2 - Transactional: Contents from transactional sub-catalog
}}
{{Api_Parameter|
|ParamType=boolean
|ParamRequired=optional
|ParamDescription=If the groupBySource=True, the internal OpenGVP result will contain a ViewSet If the groupBySource=False, the internal OpenGVP result will contain a ItemList. This has no effect in UNI API response, as a List of CatalogItems is always returned.Defaults in server to: falseTrue.
}}
{{Api_Parameter|
ParamName=filterType
|ParamType=arrayList of Filter Type enums
|ParamRequired=optional
|ParamDescription=A comma-separated list of desired filter types to apply to VoD and LinearTV recommendations. This is a new parameter added in OpenGVP 3.2. Default is 0.
}}
{{Api_Parameter|
ParamName=timeFilterType
|ParamType=arrayList of Time Filter Type enums
|ParamRequired=optional
|ParamDescription=A comma-separated list of desired time filter types to apply to LinearTV recommendations.This parameter is ignored unless the catalogType parameter does include the value 8=LinearTV (anyway, although it is ignored, it must contain a correct value). Take into account that when this type of filtering is requested, the recommendations will be ordered by relevance as usually, they will not ordered by time.This is a new parameter added in OpenGVP 3.2. Default is 0.
}}
|Exceptions=
<span style="color: #a11;">TO BE COMPLETED</span>

Navigation menu