com.recombee.api_client.bindings

Class Purchase

java.lang.Object

com.recombee.api_client.bindings.RecombeeBinding

com.recombee.api_client.bindings.Purchase

public class Purchase
extends RecombeeBinding

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

Constructor Summary

Constructors

Constructor and Description
Purchase()
Purchase(java.util.Map<java.lang.String,java.lang.Object> jsonObject)
Purchase(java.lang.String userId, java.lang.String itemId)
Purchase(java.lang.String userId, java.lang.String itemId, java.util.Date timestamp, double amount, double price, double profit, java.lang.String recommId, java.util.Map<java.lang.String,java.lang.Object> additionalData)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalData()
double	getAmount()
java.lang.String	getItemId()
double	getPrice()
double	getProfit()
java.lang.String	getRecommId()
java.util.Date	getTimestamp()
java.lang.String	getUserId()
int	hashCode()
void	setTimestamp(double epoch)

Methods inherited from class java.lang.Object

clone, finalize, getClass, 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.

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

Purchase

public Purchase()

Purchase

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

Purchase

public Purchase(java.lang.String userId,
                java.lang.String itemId,
                java.util.Date timestamp,
                double amount,
                double price,
                double profit,
                java.lang.String recommId,
                java.util.Map<java.lang.String,java.lang.Object> additionalData)

Purchase

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

Method Detail

setTimestamp

public void setTimestamp(double epoch)

getUserId

public java.lang.String getUserId()

getItemId

public java.lang.String getItemId()

getTimestamp

public java.util.Date getTimestamp()

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

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object