com.snowplowanalytics.snowplow.tracker.events

Class EcommerceTransaction

java.lang.Object

com.snowplowanalytics.snowplow.tracker.events.AbstractEvent

com.snowplowanalytics.snowplow.tracker.events.EcommerceTransaction

All Implemented Interfaces:

Event

public class EcommerceTransaction
extends AbstractEvent

Constructs an EcommerceTransaction event object.

Implementation note: EcommerceTransaction/EcommerceTransactionItem uses a legacy design. We aim to deprecate it eventually. We advise using SelfDescribing events instead, and attaching the items as entities. The specific items purchased in the transaction must be added as EcommerceTransactionItem objects. This event type is different from the others in that it will generate more than one tracked event. There will be one "transaction" ("tr") event, and one "transaction item" ("ti") event for every EcommerceTransactionItem included in the EcommerceTransaction. To link the "transaction" and "transaction item" events, we recommend using the same orderId for the EcommerceTransaction and all attached EcommerceTransactionItems. To use the Currency Conversion pipeline enrichment, the currency string must be a valid Open Exchange Rates value.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EcommerceTransaction.Builder<T extends EcommerceTransaction.Builder<T>>

Field Summary

Fields inherited from class com.snowplowanalytics.snowplow.tracker.events.AbstractEvent

context, subject, trueTimestamp

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EcommerceTransaction(EcommerceTransaction.Builder<?> builder)

Method Summary

Modifier and Type	Method and Description
static EcommerceTransaction.Builder<?>	builder()
java.util.List<EcommerceTransactionItem>	getItems() The list of EcommerceTransactionItems passed with the event.
TrackerPayload	getPayload() Returns a TrackerPayload which can be passed to an Emitter.

Methods inherited from class com.snowplowanalytics.snowplow.tracker.events.AbstractEvent

getContext, getSubject, getTrueTimestamp, putTrueTimestamp

Methods inherited from class java.lang.Object

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

Constructor Detail

EcommerceTransaction

protected EcommerceTransaction(EcommerceTransaction.Builder<?> builder)

Method Detail

builder

public static EcommerceTransaction.Builder<?> builder()

getPayload

public TrackerPayload getPayload()

Returns a TrackerPayload which can be passed to an Emitter.

Specified by:

getPayload in interface Event

Specified by:

getPayload in class AbstractEvent

Returns:

the payload to be sent.

getItems

public java.util.List<EcommerceTransactionItem> getItems()

The list of EcommerceTransactionItems passed with the event.

Returns:

the items.