Difference between revisions of "GetUserRecommendations"

From Gvp-public
Jump to navigation Jump to search
(Created page with "{{Api_Method_Spec| Description=This is an equivalent call to the ‘classic’ one in UNIAPI, it will be used by GVP when receiving a GetUserRecommendations request from a ‘...")
 
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{Api_Method_Spec|
 
{{Api_Method_Spec|
Description=This is an equivalent call to the ‘classic’ one in UNIAPI, it will be used by GVP when receiving a GetUserRecommendations request from a ‘legacy’ device. 
+
Description=
One important feature for this call is that it works with a reduced overall content set, restricted to the items that are available in all devices calling this backwards-compatible API (because old-style devices forbid showing items that cannot be played on the device).
+
<div style="background-color:red; padding:10px;">
 +
GVP 3.0 - DEPRECATED in next versions: This method will be migrated to GetChannelEditorialContents.
  
'''Workaround / special error code:'''
+
'''Since the GVP 3.0 this method will use the GetChannelEditorialContent to return the desired content against broken old legacy devices.'''
 +
</div>
  
Has been detected that sometimes it’s impossible to provide recommendations using OpenGVP. These situations are:
 
  
• Trying to get recommendations for a only series channel
+
If a user requests Editorial Recommendation and Open GVP is not connected or fails (we have a fallback in UNIAPI for this), we will look into the EditorialContents associated with the Channel that have GVP_MOVIES associated.
• Trying to get recommendations for a just created user, not present yet in opengvp data.
 
  
In these situations this operation will return a status code 3 (method unavailable). When this method is called through UNIAPI proxy call, this error code should be interpreted by LabOne as using old recommendation method logic to provide recommendations to caller. In other words, when status code 3 is returned by this method, UNIAPI getUserRecommendations method should have the same behavior that before (pre OpenGVP).
+
 
 +
Only movies with availability (Except Episodes, episodes are not returned)
 +
 
 +
<span style="text-decoration:line-through">This is an equivalent call to the ‘classic’ one in UNIAPI, it will be used by GVP when receiving a GetUserRecommendations request from a ‘legacy’ device. 
 +
One important feature for this call is that it works with a reduced overall content set, restricted to the items that are available in all devices calling this backwards-compatible API (because old-style devices forbid showing items that cannot be played on the device).</span>
 +
 
 +
 
 +
<span style="text-decoration:line-through">'''Workaround / special error code:'''
 +
 
 +
<span style="text-decoration:line-through">Has been detected that sometimes it’s impossible to provide recommendations using OpenGVP. These situations are:
 +
 
 +
• <span style="text-decoration:line-through">Trying to get recommendations for a only series channel
 +
 
 +
• <span style="text-decoration:line-through">Trying to get recommendations for a just created user, not present yet in opengvp data.
 +
 
 +
<span style="text-decoration:line-through">In these situations this operation will return a status code 3 (method unavailable). When this method is called through UNIAPI proxy call, this error code should be interpreted by LabOne as using old recommendation method logic to provide recommendations to caller. In other words, when status code 3 is returned by this method, UNIAPI getUserRecommendations method should have the same behavior that before (pre OpenGVP).</span>
  
  
Line 38: Line 53:
 
|ParamType= int
 
|ParamType= int
 
|ParamRequired=required
 
|ParamRequired=required
|ParamDescription=
+
|ParamDescription=Quantity of MostView type wants to be returned.
 
}}
 
}}
 
{{Api_Parameter|
 
{{Api_Parameter|
Line 44: Line 59:
 
|ParamType= int
 
|ParamType= int
 
|ParamRequired=required
 
|ParamRequired=required
|ParamDescription=
+
|ParamDescription=Quantity of BestRated type wants to be returned.
 
}}
 
}}
 
{{Api_Parameter|
 
{{Api_Parameter|
Line 50: Line 65:
 
|ParamType= int
 
|ParamType= int
 
|ParamRequired=required
 
|ParamRequired=required
|ParamDescription=
+
|ParamDescription=Quantity of PersonalUser type wants to be returned.
 
}}
 
}}
 
{{Api_Parameter|
 
{{Api_Parameter|
Line 56: Line 71:
 
|ParamType= int
 
|ParamType= int
 
|ParamRequired=required
 
|ParamRequired=required
|ParamDescription=
+
|ParamDescription=Quantity of Editorial type wants to be returned.
 
}}
 
}}
 
{{Api_Parameter|
 
{{Api_Parameter|
Line 68: Line 83:
  
 
|Returns=
 
|Returns=
Returns a JSON object containing a JSON with the personal recommendation as [[SimpleItem]].
+
Returns a JSON object containing a JSON with the personal recommendation.
  
 
'''Example:'''
 
'''Example:'''
Line 76: Line 91:
 
::      <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.
 
:::          }
 
:::          }
 
::      ]
 
::      ]
Line 106: Line 121:
  
 
|SeeAlso=
 
|SeeAlso=
 +
* [[GetChannelEditorialContents]]
 +
* [[EditorialContent]]
 +
 
* [[GetNodeRecommendations]]
 
* [[GetNodeRecommendations]]
 
* [[GetRootRecommendationsByView]]
 
* [[GetRootRecommendationsByView]]
 
* [[GetUserRecommendations]]
 
* [[GetUserRecommendations]]
 
}}
 
}}

Latest revision as of 20:34, 23 March 2015

Description

GVP 3.0 - DEPRECATED in next versions: This method will be migrated to GetChannelEditorialContents.

Since the GVP 3.0 this method will use the GetChannelEditorialContent to return the desired content against broken old legacy devices.


If a user requests Editorial Recommendation and Open GVP is not connected or fails (we have a fallback in UNIAPI for this), we will look into the EditorialContents associated with the Channel that have GVP_MOVIES associated.


Only movies with availability (Except Episodes, episodes are not returned)

This is an equivalent call to the ‘classic’ one in UNIAPI, it will be used by GVP when receiving a GetUserRecommendations request from a ‘legacy’ device. One important feature for this call is that it works with a reduced overall content set, restricted to the items that are available in all devices calling this backwards-compatible API (because old-style devices forbid showing items that cannot be played on the device).


Workaround / special error code:

Has been detected that sometimes it’s impossible to provide recommendations using OpenGVP. These situations are:

Trying to get recommendations for a only series channel

Trying to get recommendations for a just created user, not present yet in opengvp data.

In these situations this operation will return a status code 3 (method unavailable). When this method is called through UNIAPI proxy call, this error code should be interpreted by LabOne as using old recommendation method logic to provide recommendations to caller. In other words, when status code 3 is returned by this method, UNIAPI getUserRecommendations method should have the same behavior that before (pre OpenGVP).

Parameters

  • token (String, required)
A valid token for identifying the API session context. The token can be anonymous or logged.
  • channelId (int, required)
A number of a channel Id that wants to get a recommendation.
  • highlightType (highlightType, required)
  • mostView (int, required)
Quantity of MostView type wants to be returned.
  • bestRated (int, required)
Quantity of BestRated type wants to be returned.
  • personalUser (int, required)
Quantity of PersonalUser type wants to be returned.
  • editorial (int, required)
Quantity of Editorial type wants to be returned.
  • mibRecommendations (int, optional)


Returns

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

Example:

{

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

}


Exceptions


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