com.snowplowanalytics.snowplow.event

Class EcommerceTransaction

java.lang.Object

com.snowplowanalytics.snowplow.event.AbstractEvent

com.snowplowanalytics.snowplow.event.AbstractPrimitive

com.snowplowanalytics.snowplow.event.EcommerceTransaction

All Implemented Interfaces:

Event

public class EcommerceTransaction
extends AbstractPrimitive

An ecommerce event.

Field Summary

Fields

Modifier and Type	Field and Description
String	affiliation Identifies an affiliation.
String	city City for shipping.
String	country Country for shipping.
String	currency Currency used for totalValue and taxValue.
List<EcommerceTransactionItem>	items Items purchased.
String	orderId Identifier of the order.
Double	shipping Total amount for shipping.
String	state State for shipping.
Double	taxValue Taxes applied to the purchase.
Double	totalValue Total amount of the order.

Fields inherited from class com.snowplowanalytics.snowplow.event.AbstractEvent

customContexts, trueTimestamp

Constructor Summary

Constructors

Constructor and Description
EcommerceTransaction(String orderId, Double totalValue, List<EcommerceTransactionItem> items) Creates an ecommerce event.

Method Summary

Modifier and Type	Method and Description
EcommerceTransaction	affiliation(String affiliation) Identifies an affiliation.
EcommerceTransaction	city(String city) City for shipping.
EcommerceTransaction	country(String country) Country for shipping.
EcommerceTransaction	currency(String currency) Currency used for totalValue and taxValue.
void	endProcessing(com.snowplowanalytics.snowplow.internal.tracker.Tracker tracker) Hook method called just after the event processing in order to execute special operations.
Map<String,Object>	getDataPayload()
List<EcommerceTransactionItem>	getItems() The list of Transaction Items passed with the event.
String	getName()
EcommerceTransaction	shipping(Double shipping) Total amount for shipping.
EcommerceTransaction	state(String state) State for shipping.
EcommerceTransaction	taxValue(Double taxValue) Taxes applied to the purchase.

Methods inherited from class com.snowplowanalytics.snowplow.event.AbstractEvent

beginProcessing, contexts, getContexts, getTrueTimestamp, trueTimestamp

Methods inherited from class java.lang.Object

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

Field Detail

orderId

@NonNull
public final String orderId

Identifier of the order.

totalValue

@NonNull
public final Double totalValue

Total amount of the order.

items

@NonNull
public final List<EcommerceTransactionItem> items

Items purchased.

affiliation

@Nullable
public String affiliation

Identifies an affiliation.

taxValue

@Nullable
public Double taxValue

Taxes applied to the purchase.

shipping

@Nullable
public Double shipping

Total amount for shipping.

city

@Nullable
public String city

City for shipping.

state

@Nullable
public String state

State for shipping.

country

@Nullable
public String country

Country for shipping.

currency

@Nullable
public String currency

Currency used for totalValue and taxValue.

Constructor Detail

EcommerceTransaction

public EcommerceTransaction(@NonNull
                            String orderId,
                            @NonNull
                            Double totalValue,
                            @NonNull
                            List<EcommerceTransactionItem> items)

Creates an ecommerce event.

Parameters:

orderId - Identifier of the order.

totalValue - Total amount of the order.

items - Items purchased.

Method Detail

affiliation

@NonNull
public EcommerceTransaction affiliation(@Nullable
                                                 String affiliation)

Identifies an affiliation.

taxValue

@NonNull
public EcommerceTransaction taxValue(@Nullable
                                              Double taxValue)

Taxes applied to the purchase.

shipping

@NonNull
public EcommerceTransaction shipping(@Nullable
                                              Double shipping)

Total amount for shipping.

city

@NonNull
public EcommerceTransaction city(@Nullable
                                          String city)

City for shipping.

state

@NonNull
public EcommerceTransaction state(@Nullable
                                           String state)

State for shipping.

country

@NonNull
public EcommerceTransaction country(@Nullable
                                             String country)

Country for shipping.

currency

@NonNull
public EcommerceTransaction currency(@Nullable
                                              String currency)

Currency used for totalValue and taxValue.

getDataPayload

@NonNull
public Map<String,Object> getDataPayload()

Returns:

the event data payload

getName

@NonNull
public String getName()

Specified by:

getName in class AbstractPrimitive

Returns:

The name of the event.

getItems

@NonNull
public List<EcommerceTransactionItem> getItems()

The list of Transaction Items passed with the event.

endProcessing

public void endProcessing(@NonNull
                          com.snowplowanalytics.snowplow.internal.tracker.Tracker tracker)

Description copied from interface: Event

Hook method called just after the event processing in order to execute special operations.

Specified by:

endProcessing in interface Event

Overrides:

endProcessing in class AbstractEvent