com.gravityrd.receng.web.webshop.jsondto

Class GravityEvent

java.lang.Object

com.gravityrd.receng.web.webshop.jsondto.GravityEvent

public class GravityEvent
extends java.lang.Object

An event object describes a user action with an item.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	cookieId A cookieId should be a permanent identifier for the end users computer, preserving its value across browser sessions.
java.lang.String	eventType The event type determines the namevalues which can be passed.
java.lang.String	itemId The identifier of the item which was viewed/etc.
GravityNameValue[]	nameValues NameValues provide additional description of the event.
java.lang.String	recommendationId It should be an id of a previous recommendation, if this event is a consequence of a recommendation.
int	time The UNIX timestamp of the event, in seconds.
java.lang.String	userId The identifier of the user who generated the event.

Constructor Summary

Constructors

Constructor and Description
GravityEvent()

Method Summary

Modifier and Type	Method and Description
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

itemId

public java.lang.String itemId

The identifier of the item which was viewed/etc. by the user.

userId

public java.lang.String userId

The identifier of the user who generated the event.

cookieId

public java.lang.String cookieId

A cookieId should be a permanent identifier for the end users computer, preserving its value across browser sessions. This way not logged in users can be recognized, if they have logged in previously from the same computer. The cookieId should be always specified.

time

public int time

The UNIX timestamp of the event, in seconds. The default value is the current timestamp.

eventType

public java.lang.String eventType

The event type determines the namevalues which can be passed.

Possible list event types, which can be expanded based on what can the external system support:

Event Type	Category	Description	NameValues for the event
VIEW	GENERAL	The user viewed the info page of an item.
BUY	GENERAL	The user bought an item.	OrderId UnitPrice Formatted as a decimal number, for example 1234 or 12345.67 Currency Quantity Formatted as a decimal number.
RATING	GENERAL	The user rated an item.	Value The value of the rating.
ADD_TO_CART	GENERAL	The user added an item to the shopping cart.	Quantity
REMOVE_FROM_CART	GENERAL	The user removed an item from the shopping cart.	Quantity
ADD_TO_FAVORITES	GENERAL	The user added the item to his favorites.	ListId Use if the webshop supports multiple favorites lists.
REMOVE_FROM_FAVORITES	GENERAL	The user removed an item from his favorites.	ListId Use if the webshop supports multiple favorites lists.
REC_CLICK	GENERAL	The user clicked on a recommended item.	Position The position of the clicked item in the recommendation list. The position of the first item is 1.
LOGIN	GENERAL	The user logged in to the site. For this event the cookieId and also the userId must be specified.
ADD_TO_WISHLIST	ADDITIONAL	The user added the item to his wishlist.	ListId Use if the webshop supports multiple wishlists.
REMOVE_FROM_WISHLIST	ADDITIONAL	The user removed an item from his wishlist.	ListId Use if the webshop supports multiple wishlists.
HIDE_PRODUCT	ADDITIONAL	The user hides a product that should not be recommended to him.
UNHIDE_PRODUCT	ADDITIONAL	The user unhides a product that he marked as hidden previously.
PRODUCT_SEARCH	ADDITIONAL	A list of products was displayed to the user, for example by browsing a category or by free text search.	SearchString The search string, if the list is based on a free text search. Filter.* If the listing is based on comparing an item namevalue to a filter value, you can provide the actual filter here. For example, if the user was browsing a specific category, name='Filter.CategoryId' and value='CategoryA' can be specified.
NEXT_RECOMMENDATION	ADDITIONAL	The user asked for more recommendation.
COMMENT	ADDITIONAL	The user wrote a comment for the item.
NOT_INTERESTED	ADDITIONAL	The user would not like this item and similar items to be recommended to him, but he also does not want to give a negative rating for this item.
LETTER_READ	ADDITIONAL	T The user read a letter which sent for him by the system (eg. a newsletter).
CLICK_OUT	PRICE COMPARISON	The user jumps to an external webshop to buy the product. Used by price comparison sites.
LANCE	AUCTION	The user place a bid on the item.	ValueThe value of the bid as a decimal number.
LETTER_SEND	AUCTION, ADVERTISING	The user sent a message to the advertiser.
ADD_ITEM	AUCTION, ADVERTISING	The user added an item to the site.
FREE_VIEW	MEDIA	The user wached/listened an item for free.	DurationHow long the user wached the item in seconds as a decimal number.
PAID_VIEW	MEDIA	The user payed for waching/listening an item.	Duration How long the user wached the item in seconds. A decimal number. Value How much the user payed for waching the item. A decimal number.
SUBSCRIPTION_VIEW	MEDIA	The user watched an item that was available for him by a subscription.	Duration How long the user wached the item in seconds. A decimal number.
FOLLOW_USER	SOCIAL	The user follows an other user.	OtherUserIdThe identifier of the followed user.
SHARE	SOCIAL	The user share the item on a social site (eg. Facebook, Twitter,...).
REDEEM	COUPON	The user redeem the item (eg. a coupon).

nameValues

public GravityNameValue[] nameValues

NameValues provide additional description of the event. There can multiple NameValues with the same name. The order of NameValues will not be preserved, but the order of the values for the same name will be preserved.

recommendationId

public java.lang.String recommendationId

It should be an id of a previous recommendation, if this event is a consequence of a recommendation. See GravityItemRecommendation.recommendationId.

Constructor Detail

GravityEvent

public GravityEvent()

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object