com.recombee.api_client.api_requests

Class AddPurchase

java.lang.Object

com.recombee.api_client.api_requests.Request

com.recombee.api_client.api_requests.AddPurchase

public class AddPurchase
extends Request

Adds a purchase of a given item made by a given user.

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.Double	amount Amount (number) of purchased items.
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 Purchased item
protected java.lang.Double	price Price paid by the user for the item.
protected java.lang.Double	profit Your profit from the purchased item.
protected java.lang.String	recommId If this purchase is based on a recommendation request, `recommId` is the id of the clicked recommendation.
protected java.util.Date	timestamp UTC timestamp of the purchase as ISO8601-1 pattern or UTC epoch time.
protected java.lang.String	userId User who purchased the item

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

timeout

Constructor Summary

Constructors

Constructor and Description
AddPurchase(java.lang.String userId, java.lang.String itemId) Construct the request

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalData()
double	getAmount()
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	getPrice()
double	getProfit()
java.util.Map<java.lang.String,java.lang.Object>	getQueryParameters() Get query parameters
java.lang.String	getRecommId()
java.util.Date	getTimestamp()
java.lang.String	getUserId()
AddPurchase	setAdditionalData(java.util.Map<java.lang.String,java.lang.Object> additionalData)
AddPurchase	setAmount(double amount)
AddPurchase	setCascadeCreate(boolean cascadeCreate)
AddPurchase	setPrice(double price)
AddPurchase	setProfit(double profit)
AddPurchase	setRecommId(java.lang.String recommId)
AddPurchase	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 purchased the item

itemId

protected java.lang.String itemId

Purchased item

timestamp

protected java.util.Date timestamp

UTC timestamp of the purchase 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.

amount

protected java.lang.Double amount

Amount (number) of purchased items. The default is 1. For example if `user-x` purchases two `item-y` during a single order (session...), the `amount` should equal to 2.

price

protected java.lang.Double price

Price paid by the user for the item. If `amount` is greater than 1, sum of prices of all the items should be given.

profit

protected java.lang.Double profit

Your profit from the purchased item. The profit is natural in e-commerce domain (for example if `user-x` purchases `item-y` for $100 and the gross margin is 30 %, then the profit is $30), but is applicable also in other domains (for example at a news company it may be income from displayed advertisement on article page). If `amount` is greater than 1, sum of profit of all the items should be given.

recommId

protected java.lang.String recommId

If this purchase 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

AddPurchase

public AddPurchase(java.lang.String userId,
                   java.lang.String itemId)

Construct the request

Parameters:

userId - User who purchased the item

itemId - Purchased item

Method Detail

setTimestamp

public AddPurchase setTimestamp(java.util.Date timestamp)

Parameters:

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

setCascadeCreate

public AddPurchase setCascadeCreate(boolean cascadeCreate)

Parameters:

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

setAmount

public AddPurchase setAmount(double amount)

Parameters:

amount - Amount (number) of purchased items. The default is 1. For example if `user-x` purchases two `item-y` during a single order (session...), the `amount` should equal to 2.

setPrice

public AddPurchase setPrice(double price)

Parameters:

price - Price paid by the user for the item. If `amount` is greater than 1, sum of prices of all the items should be given.

setProfit

public AddPurchase setProfit(double profit)

Parameters:

profit - Your profit from the purchased item. The profit is natural in e-commerce domain (for example if `user-x` purchases `item-y` for $100 and the gross margin is 30 %, then the profit is $30), but is applicable also in other domains (for example at a news company it may be income from displayed advertisement on article page). If `amount` is greater than 1, sum of profit of all the items should be given.

setRecommId

public AddPurchase setRecommId(java.lang.String recommId)

Parameters:

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

setAdditionalData

public AddPurchase 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()

getTimestamp

public java.util.Date getTimestamp()

getCascadeCreate

public boolean getCascadeCreate()

getAmount

public double getAmount()

getPrice

public double getPrice()

getProfit

public double getProfit()

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)