class RecombeeApiClient::SetViewPortion

Sets viewed portion of an item (for example a video or article) by a user (at a session). If you send new request with the same (`userId`, `itemId`, `sessionId`), the portion gets updated.

Attributes

cascade_create[R]
ensure_https[RW]
item_id[R]
portion[R]
recomm_id[R]
session_id[R]
timeout[RW]
timestamp[R]
user_id[R]

Public Class Methods

new(user_id, item_id, portion, optional = {}) click to toggle source
  • *Required arguments*

    • user_id -> User who viewed a portion of the item

    • item_id -> Viewed item

    • portion -> Viewed portion of the item (number between 0.0 (viewed nothing) and 1.0 (viewed full item) ). It should be the really viewed part of the item, no matter seeking, so for example if the user seeked immediately to half of the item and then viewed 10% of the item, the `portion` should still be `0.1`.

  • *Optional arguments (given as hash optional)*

    • sessionId -> ID of session in which the user viewed the item. Default is `null` (`None`, `nil`, `NULL` etc. depending on language).

    • timestamp -> UTC timestamp of the rating as ISO8601-1 pattern or UTC epoch time. The default value is the current time.

    • cascadeCreate -> Sets whether the given user/item should be created if not present in the database.

    • recommId -> If this view portion is based on a recommendation request, `recommId` is the id of the clicked recommendation.

# File lib/recombee_api_client/api/set_view_portion.rb, line 30
def initialize(user_id, item_id, portion, optional = {})
  @user_id = user_id
  @item_id = item_id
  @portion = portion
  optional = normalize_optional(optional)
  @session_id = optional['sessionId']
  @timestamp = optional['timestamp']
  @cascade_create = optional['cascadeCreate']
  @recomm_id = optional['recommId']
  @optional = optional
  @timeout = 1000
  @ensure_https = false
  @optional.each do |par, _|
    fail UnknownOptionalParameter.new(par) unless ["sessionId","timestamp","cascadeCreate","recommId"].include? par
  end
end

Public Instance Methods

body_parameters() click to toggle source

Values of body parameters as a Hash

# File lib/recombee_api_client/api/set_view_portion.rb, line 53
def body_parameters
  p = Hash.new
  p['userId'] = @user_id
  p['itemId'] = @item_id
  p['portion'] = @portion
  p['sessionId'] = @optional['sessionId'] if @optional.include? 'sessionId'
  p['timestamp'] = @optional['timestamp'] if @optional.include? 'timestamp'
  p['cascadeCreate'] = @optional['cascadeCreate'] if @optional.include? 'cascadeCreate'
  p['recommId'] = @optional['recommId'] if @optional.include? 'recommId'
  p
end
method() click to toggle source

HTTP method

# File lib/recombee_api_client/api/set_view_portion.rb, line 48
def method
  :post
end
path() click to toggle source

Relative path to the endpoint

# File lib/recombee_api_client/api/set_view_portion.rb, line 73
def path
  "/{databaseId}/viewportions/"
end
query_parameters() click to toggle source

Values of query parameters as a Hash. name of parameter => value of the parameter

# File lib/recombee_api_client/api/set_view_portion.rb, line 67
def query_parameters
  params = {}
  params
end