com.snowplowanalytics.snowplow.tracker.events

Class EcommerceTransaction.Builder<T extends EcommerceTransaction.Builder<T>>

java.lang.Object

com.snowplowanalytics.snowplow.tracker.events.AbstractEvent.Builder<T>

com.snowplowanalytics.snowplow.tracker.events.EcommerceTransaction.Builder<T>

Enclosing class:

EcommerceTransaction

public abstract static class EcommerceTransaction.Builder<T extends EcommerceTransaction.Builder<T>>
extends AbstractEvent.Builder<T>

Field Summary

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

trueTimestamp

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
T	affiliation(java.lang.String affiliation) Optional.
EcommerceTransaction	build()
T	city(java.lang.String city) Optional.
T	country(java.lang.String country) Optional.
T	currency(java.lang.String currency) Optional.
T	items(EcommerceTransactionItem... itemArgs) Provide EcommerceTransactionItems directly, without explicitly adding them to a list beforehand.
T	items(java.util.List<EcommerceTransactionItem> items) Provide a list of EcommerceTransactionItems.
T	orderId(java.lang.String orderId) Required.
T	shipping(java.lang.Double shipping) Optional.
T	state(java.lang.String state) Optional.
T	taxValue(java.lang.Double taxValue) Optional.
T	totalValue(java.lang.Double totalValue) Required.

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

customContext, self, subject, trueTimestamp

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

orderId

public T orderId(java.lang.String orderId)

Required.

Parameters:

orderId - ID of the eCommerce transaction

Returns:

itself

totalValue

public T totalValue(java.lang.Double totalValue)

Required.

Parameters:

totalValue - Total transaction value

Returns:

itself

affiliation

public T affiliation(java.lang.String affiliation)

Optional.

Parameters:

affiliation - Transaction affiliation

Returns:

itself

taxValue

public T taxValue(java.lang.Double taxValue)

Optional.

Parameters:

taxValue - Transaction tax value

Returns:

itself

shipping

public T shipping(java.lang.Double shipping)

Optional.

Parameters:

shipping - Delivery cost charged

Returns:

itself

city

public T city(java.lang.String city)

Optional.

Parameters:

city - Delivery address city

Returns:

itself

state

public T state(java.lang.String state)

Optional.

Parameters:

state - Delivery address state

Returns:

itself

country

public T country(java.lang.String country)

Optional.

Parameters:

country - Delivery address country

Returns:

itself

currency

public T currency(java.lang.String currency)

Optional.

Parameters:

currency - The currency the price is expressed in

Returns:

itself

items

public T items(java.util.List<EcommerceTransactionItem> items)

Provide a list of EcommerceTransactionItems. An empty list is valid, but probably not very useful.

Parameters:

items - The items in the transaction

Returns:

itself

items

public T items(EcommerceTransactionItem... itemArgs)

Provide EcommerceTransactionItems directly, without explicitly adding them to a list beforehand.

Parameters:

itemArgs - The items as a varargs argument

Returns:

itself

build

public EcommerceTransaction build()