snowplow-android-tracker/com.snowplowanalytics.snowplow.event/EcommerceTransaction

EcommerceTransaction

class EcommerceTransaction(orderId: String, totalValue: Double, items: List<EcommerceTransactionItem>) : AbstractPrimitive

An ecommerce event.

Parameters

orderId

Identifier of the order.

totalValue

Total amount of the order.

items

Items purchased.

Constructors

Link copied to clipboard
fun EcommerceTransaction(orderId: String, totalValue: Double, items: List<EcommerceTransactionItem>)

Functions

Link copied to clipboard
fun affiliation(affiliation: String?): EcommerceTransaction

Identifies an affiliation.

Link copied to clipboard
open override fun beginProcessing(tracker: Tracker)

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

Link copied to clipboard
fun city(city: String?): EcommerceTransaction

City for shipping.

Link copied to clipboard
fun contexts(contexts: List<SelfDescribingJson>?): AbstractEvent

Adds a list of contexts.

Link copied to clipboard
fun country(country: String?): EcommerceTransaction

Country for shipping.

Link copied to clipboard
fun currency(currency: String?): EcommerceTransaction

Currency used for totalValue and taxValue.

Link copied to clipboard
open override fun endProcessing(tracker: Tracker)

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

Link copied to clipboard
fun entities(entities: List<SelfDescribingJson>?): AbstractEvent

Adds a list of contexts.

Link copied to clipboard
fun shipping(shipping: Double?): EcommerceTransaction

Total amount for shipping.

Link copied to clipboard
fun state(state: String?): EcommerceTransaction

State for shipping.

Link copied to clipboard
fun taxValue(taxValue: Double?): EcommerceTransaction

Taxes applied to the purchase.

Link copied to clipboard
fun trueTimestamp(trueTimestamp: Long?): AbstractEvent

Set the custom timestamp of the event.

Properties

Link copied to clipboard
var affiliation: String? = null

Identifies an affiliation.

Link copied to clipboard
var city: String? = null

City for shipping.

Link copied to clipboard
open override val contexts: List<SelfDescribingJson>
Link copied to clipboard
var country: String? = null

Country for shipping.

Link copied to clipboard
var currency: String? = null

Currency used for totalValue and taxValue.

Link copied to clipboard
val customContexts: MutableList<SelfDescribingJson>

List of custom contexts associated with the event.

Link copied to clipboard
open override val dataPayload: Map<String, Any?>
Link copied to clipboard
open override val entities: List<SelfDescribingJson>
Link copied to clipboard
val items: List<EcommerceTransactionItem>

The list of Transaction Items passed with the event.

Link copied to clipboard
open override val name: String
Link copied to clipboard
val orderId: String

Identifier of the order.

Link copied to clipboard
var shipping: Double? = null

Total amount for shipping.

Link copied to clipboard
var state: String? = null

State for shipping.

Link copied to clipboard
var taxValue: Double? = null

Taxes applied to the purchase.

Link copied to clipboard
val totalValue: Double

Total amount of the order.

Link copied to clipboard
open override var trueTimestamp: Long? = null