Recombee API Client
Public Member Functions | Properties | List of all members
Recombee.ApiClient.Bindings.Purchase Class Reference

Purchase Binding More...

Inheritance diagram for Recombee.ApiClient.Bindings.Purchase:
Inheritance graph
[legend]
Collaboration diagram for Recombee.ApiClient.Bindings.Purchase:
Collaboration graph
[legend]

Public Member Functions

 Purchase (string userId, string itemId, DateTime? timestamp=null, double? amount=null, double? price=null, double? profit=null, string recommId=null, Dictionary< string, object > additionalData=null)
 
override bool Equals (Object obj)
 Determines whether the specified object is equal to the current object More...
 
override int GetHashCode ()
 Hash function More...
 

Properties

string UserId [get]
 User who purchased the item More...
 
string ItemId [get]
 Purchased item More...
 
DateTime? Timestamp [get]
 UTC timestamp of the purchase as ISO8601-1 pattern or UTC epoch time. The default value is the current time. More...
 
double? Amount [get]
 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. More...
 
double? Price [get]
 Price paid by the user for the item. If amount is greater than 1, sum of prices of all the items should be given. More...
 
double? Profit [get]
 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. More...
 
string RecommId [get]
 If this purchase is based on a recommendation request, recommId is the id of the clicked recommendation. More...
 
Dictionary< string, object > AdditionalData [get]
 A dictionary of additional data for the interaction. More...
 

Detailed Description

Purchase Binding

Constructor & Destructor Documentation

◆ Purchase()

Recombee.ApiClient.Bindings.Purchase.Purchase ( string  userId,
string  itemId,
DateTime?  timestamp = null,
double?  amount = null,
double?  price = null,
double?  profit = null,
string  recommId = null,
Dictionary< string, object >  additionalData = null 
)
inline

Member Function Documentation

◆ Equals()

override bool Recombee.ApiClient.Bindings.Purchase.Equals ( Object  obj)
inline

Determines whether the specified object is equal to the current object

Parameters
objThe object to compare with the current object
Returns
true if the specified object is equal to the current object; otherwise, false

◆ GetHashCode()

override int Recombee.ApiClient.Bindings.Purchase.GetHashCode ( )
inline

Hash function

Returns
A hash code for the current object

Property Documentation

◆ AdditionalData

Dictionary<string, object> Recombee.ApiClient.Bindings.Purchase.AdditionalData
get

A dictionary of additional data for the interaction.

◆ Amount

double? Recombee.ApiClient.Bindings.Purchase.Amount
get

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.

◆ ItemId

string Recombee.ApiClient.Bindings.Purchase.ItemId
get

Purchased item

◆ Price

double? Recombee.ApiClient.Bindings.Purchase.Price
get

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

double? Recombee.ApiClient.Bindings.Purchase.Profit
get

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

string Recombee.ApiClient.Bindings.Purchase.RecommId
get

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

◆ Timestamp

DateTime? Recombee.ApiClient.Bindings.Purchase.Timestamp
get

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

◆ UserId

string Recombee.ApiClient.Bindings.Purchase.UserId
get

User who purchased the item


The documentation for this class was generated from the following file: