Difference between revisions of "GetRootRecommendationsByView"

From Gvp-public
Jump to navigation Jump to search
(Created page with "{{Api_Method_Spec| Description=Get a Recommendation from the GVP Platform. The GetRootRecommendationsByView is a ByPass method to use the OpenGVP to get all contents analysed ...")
 
 
(6 intermediate revisions by 2 users not shown)
Line 3: Line 3:
  
 
The suggestion is made in the OpenGVP and sent to the UNIAPI in a JSON format.
 
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.
+
All kinds of recommendation are separated by Sources. Each source represent a kind of content are recommended.
  
 
1 - MostViewed
 
1 - MostViewed
Line 13: Line 13:
 
4 - Editorial
 
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 content recommended, 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.
+
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.
 +
 
  
 
This method is really similar to GetNodeRecommendation, the big diference is that in the method you don't need to send an specific node (ChannelId) to get a content.
 
This method is really similar to GetNodeRecommendation, the big diference is that in the method you don't need to send an specific node (ChannelId) to get a content.
  
−
The related methods is:
+
 
 +
The related methods are:
  
 
- [[GetFullView]]
 
- [[GetFullView]]
Line 23: Line 25:
 
- [[GetNodeRecommendations]] (Similar to this)
 
- [[GetNodeRecommendations]] (Similar to this)
  
−
- [[GetNodeRecommendationsByView]]
+
- [[GetRootRecommendationsByView]]
  
−
- [[GetNodeRecommendationsCombined]]
+
- [[GetRootRecommendationsCombined]]
  
 
And the legacy method:
 
And the legacy method:
Line 34: Line 36:
 
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.
 
GetNodeRecommendations can be used in some node of channels, since from RootChannel and others.
−
 
−
This method only can be used by logged user.
 
  
  
Line 46: Line 46:
 
|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|
 
{{Api_Parameter|
 
ParamName=num
 
ParamName=num
Line 63: 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 69: 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 as [[SimpleItem]].
+
Returns a JSON object containing a JSON with the personal recommendation.
  
 
'''Example:'''
 
'''Example:'''
Line 82: Line 89:
 
::      <span style="color: #a11;">"ViewSet"</span>: {
 
::      <span style="color: #a11;">"ViewSet"</span>: {
 
:::          <span style="color: #a11;">"1"</span>: [
 
:::          <span style="color: #a11;">"1"</span>: [
−
::::              Array of [[SimpleItem]] objects
+
::::              Array of [[SimpleItem]] (OpenGVP Type) objects
 
:::          ]
 
:::          ]
 
:::          <span style="color: #a11;">"2"</span>: [
 
:::          <span style="color: #a11;">"2"</span>: [
−
::::              Array of [[SimpleItem]] objects
+
::::              Array of [[SimpleItem]] (OpenGVP Type) objects
 
:::          ]
 
:::          ]
 
:::          <span style="color: #a11;">"3"</span>: [
 
:::          <span style="color: #a11;">"3"</span>: [
−
::::              Array of [[SimpleItem]] objects
+
::::              Array of [[SimpleItem]] (OpenGVP Type) objects
 
:::          ]
 
:::          ]
 
:::          <span style="color: #a11;">"4"</span>: [
 
:::          <span style="color: #a11;">"4"</span>: [
−
::::              Array of [[SimpleItem]] objects
+
::::              Array of [[SimpleItem]] (OpenGVP Type) objects
 
:::          ]
 
:::          ]
 
::      }
 
::      }

Latest revision as of 09:33, 13 July 2015

Description

Get a Recommendation from the GVP Platform. The GetRootRecommendationsByView 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.


This method is really similar to GetNodeRecommendation, the big diference is that in the method you don't need to send an specific node (ChannelId) to get a content.


The related methods are:

- GetFullView

- GetNodeRecommendations (Similar to this)

- GetRootRecommendationsByView

- GetRootRecommendationsCombined

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.

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": {
"ViewSet": {
"1": [
Array of SimpleItem (OpenGVP Type) objects
]
"2": [
Array of SimpleItem (OpenGVP Type) objects
]
"3": [
Array of SimpleItem (OpenGVP Type) objects
]
"4": [
Array of SimpleItem (OpenGVP Type) objects
]
}
}

}


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


See also

Retrieved from "https://wikis.tid.es/gvp-public/index.php?title=GetRootRecommendationsByView&oldid=1217"