GetRootRecommendationsCombined - Revision history

Id02660 at 09:32, 13 July 2015

2015-07-13T09:32:48Z

Rcalvo at 18:27, 18 September 2014

2014-09-18T18:27:41Z

Rcalvo at 18:26, 18 September 2014

2014-09-18T18:26:53Z

Id02224: ContentType and catalogType info

2014-09-03T12:54:34Z

ContentType and catalogType info

Rcalvo at 14:01, 27 August 2014

2014-08-27T14:01:14Z

Rcalvo at 13:57, 27 August 2014

2014-08-27T13:57:39Z

Rcalvo at 21:27, 26 August 2014

2014-08-26T21:27:12Z

Rcalvo at 21:24, 26 August 2014

2014-08-26T21:24:37Z

Rcalvo: Created page with "{{Api_Method_Spec| Description=Get a Recommendation from the GVP Platform. The GetNodeRecommendations is a ByPass method to use the OpenGVP to get all contents analysed and th..."

2014-08-26T20:13:34Z

Created page with "{{Api_Method_Spec| Description=Get a Recommendation from the GVP Platform. The GetNodeRecommendations is a ByPass method to use the OpenGVP to get all contents analysed and th..."

New page

{{Api_Method_Spec|
Description=Get a Recommendation from the GVP Platform. The GetNodeRecommendations 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 separated by Sources. Each source represent a kind of content are recommended.

1 - MostViewed

2 - BestRated

3 - Personal

4 - Editorial

Results are presented in groups inside a ViewSet. Each group of ViewSet represent each source. In the request, a parameter SOURCE can be defined to filter the recommended content, for exemple, if the request wants only the MostViewed Recommendation, send 1 in the source parameter. This filed accept all values (1,2,3,4) separated by comma.

The related methods are:

- [[GetFullView]]

- [[GetNodeRecommendations]]

- [[GetNodeRecommendationsByView]]

- [[GetNodeRecommendationsCombined]]

And the legacy method:

- [[GetUserRecommendations]]

Notes: The OpenGVP can be active/desactive and configured in each Environment and Instance to be used.
GetNodeRecommendations can be used in some node of channels, since from RootChannel and others.

This method only can be used by logged user.

|Parameters=

{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{Api_Parameter|
ParamName=num
|ParamType=int
|ParamRequired=optional
|ParamDescription=Quantity of recommendation wants to be returned. Each source will return the quantity specified by num parameter.
}}
{{Api_Parameter|
ParamName=sources
|ParamType=int
|ParamRequired=optional
|ParamDescription=Number separated by comma that represent a kind of content wants to be filter the result. (1 - MostViewed, 2 - BestRated, 3 - Personal, 4 - Editorial)
}}
{{Api_Parameter|
ParamName=contentType
|ParamType=int
|ParamRequired=optional
|ParamDescription=
}}
{{Api_Parameter|
ParamName=catalogType
|ParamType=int
|ParamRequired=optional
|ParamDescription=
}}

|Returns=
Returns a JSON object containing a JSON with the personal recommendation as [[SimpleItem]].

'''Example:'''

{
: <span style="color: #a11;">"Content"</span>: {
:: <span style="color: #a11;">"ItemList"</span>: [
::: {
:::: Array of [[SimpleItem]] objects + Source properties.
::: }
:: ]
: }
}

|Exceptions=
* None

|Cache=
This method is not cached.

|KnownIssues=
* None

|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 2.3
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}

|SeeAlso=
* [[GetNodeRecommendations]]
* [[GetRootRecommendationsByView]]
* [[GetUserRecommendations]]
}}

@@ Line 6: / Line 6: @@
 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 and 4 - Editorial.
+SOURCES available:
 This method is similar to GetRootRecommendationsByView but in the same ViewSet.
@@ Line 76: / Line 80: @@
 |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:'''
@@ Line 84: / Line 88: @@
 ::       <span style="color: #a11;">"ItemList"</span>: [
 :::           {
-::::               Array of [[SimpleItem]] objects + Source properties.
+::::               Array of SimpleItem (OpenGVP Type) objects + Source properties.
 :::           }
 ::       ]

← Older revision		Revision as of 14:01, 27 August 2014
Line 10:		Line 10:
	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.

← Older revision		Revision as of 13:57, 27 August 2014
Line 28:		Line 28:

	Notes: The OpenGVP can be active/desactive and configured in each Environment and Instance to be used.		Notes: The OpenGVP can be active/desactive and configured in each Environment and Instance to be used.
−	~~GetNodeRecommendations can be used in some node of channels, since from~~ RootChannel ~~and others~~.	+	GetRootRecommendationsCombined return only contents based on RootChannel.

← Older revision		Revision as of 21:27, 26 August 2014
Line 7:		Line 7:

	SOURCES available: 1 - MostViewed, 2 - BestRated, 3 - Personal and 4 - Editorial.		SOURCES available: 1 - MostViewed, 2 - BestRated, 3 - Personal and 4 - Editorial.
		+
		+	This method is similar to GetRootRecommendationsByView but in the same ViewSet.

@@ Line 21: / Line 21: @@
 - [[GetNodeRecommendations]]
-- [[GetNodeRecommendationsByView]]
+- [[GetRootRecommendationsByView]]
-- [[GetNodeRecommendationsCombined]]
+- [[GetRootRecommendationsCombined]]
 And the legacy method:

@@ Line 58: / Line 58: @@
 |ParamType=int
 |ParamRequired=optional
-|ParamDescription=
+|ParamDescription=Number that indicates the content type of the recommendation
 }}
 {{Api_Parameter|
@@ Line 64: / Line 69: @@
 |ParamType=int
 |ParamRequired=optional
-|ParamDescription=
+|ParamDescription=CatalogType: Number that indicates the sub-catalog to retrieve recommendations from (Subscrition or transactional)
 }}

@@ Line 1: / Line 1: @@
 {{Api_Method_Spec|
-Description=Get a Recommendation from the GVP Platform. The GetNodeRecommendations is a ByPass method to use the OpenGVP to get all contents analysed and that is the recommendation for the connected user.
+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.
-- MostViewed
+All kinds of recommendation are combined in the same result with a SOURCE parameter added in the result.
-- BestRated
+SOURCES available: 1 - MostViewed, 2 - BestRated, 3 - Personal and 4 - Editorial.
 The related methods are:
@@ Line 32: / Line 27: @@
 Notes: The OpenGVP can be active/desactive and configured in each Environment and Instance to be used.
 GetNodeRecommendations can be used in some node of channels, since from RootChannel and others.