reco

Type Members

1. case class RecoArticle(articleId: ArticleKey, title: String, clickUrl: String, displayUrl: String, author: Option[String], imageUrl: String, publishTimestamp: DateTime, articleImpressionSlug: String) extends Product with Serializable

   

   An article recommendation.

   An article recommendation.

   title

   Article title (headline, etc.).

   clickUrl

   URL that lets Gravity track the article's click.

   displayUrl

   "Clean" URL that is suitable for displaying to users.

   author

   Author full name, if available.

   imageUrl

   URL to article image. This will be a thumbnail URL if you specify image widths and/or heights when using com.gravity.gdk.placement.Placement.getRecos.

   publishTimestamp

   When the article was published.

   articleImpressionSlug

   This is Gravity internal use only.

2. case class RecoArticleInImpression(key: ArticleKey, displayIndex: Int, articleImpressionSlug: String) extends Product with Serializable

   

   A RecoArticle that appeared in an impression (namely, has an index in an ordered set of recommended articles).

   A RecoArticle that appeared in an impression (namely, has an index in an ordered set of recommended articles). This is generally internal use only.

3. case class RecoContext(user: GravityUser, currentUrl: String, imageWidth: Int = 0, imageHeight: Int = 0, pageViewGuid: PageViewGuid = PageViewGuid.random) extends Product with Serializable

   
   currentUrl

   URL being served by your server. This is used as the basis for "contextual" recommendations; that is, recommendations may be weighted based on the contents of this URL for some contextual relevance to what this URL topically represents.

   imageWidth

   If provided, images provided in resultant RecoArticle image URLs will be sized accordingly.

   imageHeight

   If provided, images provided in resultant RecoArticle image URLs will be sized accordingly.

   pageViewGuid

   If you are rendering multiple distinct placements on a single Web page in the browser, you should pass this param using a single memoized com.gravity.gdk.impression.PageViewGuid.random; this will allow the various placements' impressions for the given page view to be joined to each other for deduping across placements in the same page, additional downstream analysis, etc.

4. case class RecoResult(articles: List[RecoArticle], impressionViewed: ImpressionViewedSpec, impressionSlug: String, meta: Map[String, JsValue]) extends Product with Serializable

   

   A set of article recommendations as received when using com.gravity.gdk.placement.Placement.getRecos.

   A set of article recommendations as received when using com.gravity.gdk.placement.Placement.getRecos.

   articles

   The recommended articles.

   impressionViewed

   Information to assist in tracking impression viewed. Generally internal use only.

   impressionSlug

   This is Gravity internal use only.

   meta

   This contains internal fields and possibly custom fields specified in your RSS. If you desire metadata to be included, you should speak with your account manager.