com.recombee.api_client.api_requests

Class SetViewPortion

java.lang.Object

com.recombee.api_client.api_requests.Request

com.recombee.api_client.api_requests.SetViewPortion

public class SetViewPortion
extends Request

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.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.Object>	additionalData A dictionary of additional data for the interaction.
protected java.lang.Boolean	cascadeCreate Sets whether the given user/item should be created if not present in the database.
protected java.lang.String	itemId Viewed item
protected java.lang.Double	portion Viewed portion of the item (number between 0.0 (viewed nothing) and 1.0 (viewed full item) ).
protected java.lang.String	recommId If this view portion is based on a recommendation request, `recommId` is the id of the clicked recommendation.
protected java.lang.String	sessionId ID of session in which the user viewed the item.
protected java.util.Date	timestamp UTC timestamp of the rating as ISO8601-1 pattern or UTC epoch time.
protected java.lang.String	userId User who viewed a portion of the item

Fields inherited from class com.recombee.api_client.api_requests.Request

timeout

Constructor Summary

Constructors

Constructor and Description
SetViewPortion(java.lang.String userId, java.lang.String itemId, double portion) Construct the request

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalData()
java.util.Map<java.lang.String,java.lang.Object>	getBodyParameters() Get body parameters
boolean	getCascadeCreate()
HTTPMethod	getHTTPMethod()
java.lang.String	getItemId()
java.lang.String	getPath()
double	getPortion()
java.util.Map<java.lang.String,java.lang.Object>	getQueryParameters() Get query parameters
java.lang.String	getRecommId()
java.lang.String	getSessionId()
java.util.Date	getTimestamp()
java.lang.String	getUserId()
SetViewPortion	setAdditionalData(java.util.Map<java.lang.String,java.lang.Object> additionalData)
SetViewPortion	setCascadeCreate(boolean cascadeCreate)
SetViewPortion	setRecommId(java.lang.String recommId)
SetViewPortion	setSessionId(java.lang.String sessionId)
SetViewPortion	setTimestamp(java.util.Date timestamp)

Methods inherited from class com.recombee.api_client.api_requests.Request

getEnsureHttps, getTimeout, setTimeout

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

userId

protected java.lang.String userId

User who viewed a portion of the item

itemId

protected java.lang.String itemId

Viewed item

portion

protected java.lang.Double 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`.

sessionId

protected java.lang.String sessionId

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

timestamp

protected java.util.Date timestamp

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

cascadeCreate

protected java.lang.Boolean cascadeCreate

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

recommId

protected java.lang.String recommId

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

additionalData

protected java.util.Map<java.lang.String,java.lang.Object> additionalData

A dictionary of additional data for the interaction.

Constructor Detail

SetViewPortion

public SetViewPortion(java.lang.String userId,
                      java.lang.String itemId,
                      double portion)

Construct the request

Parameters:

userId - User who viewed a portion of the item

itemId - 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`.

Method Detail

setSessionId

public SetViewPortion setSessionId(java.lang.String sessionId)

Parameters:

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

setTimestamp

public SetViewPortion setTimestamp(java.util.Date timestamp)

Parameters:

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

setCascadeCreate

public SetViewPortion setCascadeCreate(boolean cascadeCreate)

Parameters:

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

setRecommId

public SetViewPortion setRecommId(java.lang.String recommId)

Parameters:

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

setAdditionalData

public SetViewPortion setAdditionalData(java.util.Map<java.lang.String,java.lang.Object> additionalData)

Parameters:

additionalData - A dictionary of additional data for the interaction.

getUserId

public java.lang.String getUserId()

getItemId

public java.lang.String getItemId()

getPortion

public double getPortion()

getSessionId

public java.lang.String getSessionId()

getTimestamp

public java.util.Date getTimestamp()

getCascadeCreate

public boolean getCascadeCreate()

getRecommId

public java.lang.String getRecommId()

getAdditionalData

public java.util.Map<java.lang.String,java.lang.Object> getAdditionalData()

getHTTPMethod

public HTTPMethod getHTTPMethod()

Specified by:

getHTTPMethod in class Request

Returns:

Used HTTP method

getPath

public java.lang.String getPath()

Specified by:

getPath in class Request

Returns:

URI to the endpoint including path parameters

getQueryParameters

public java.util.Map<java.lang.String,java.lang.Object> getQueryParameters()

Get query parameters

Specified by:

getQueryParameters in class Request

Returns:

Values of query parameters (name of parameter: value of the parameter)

getBodyParameters

public java.util.Map<java.lang.String,java.lang.Object> getBodyParameters()

Get body parameters

Specified by:

getBodyParameters in class Request

Returns:

Values of body parameters (name of parameter: value of the parameter)