snowplow-android-tracker/com.snowplowanalytics.snowplow.ecommerce.events

Package-level declarations

Snowplow Ecommerce event types.

Types

class AddToCartEvent(var products: List<ProductEntity>, var cart: CartEntity) : AbstractSelfDescribing

Track a product or products being added to cart.

class CheckoutStepEvent @JvmOverloads constructor(var step: Int, var shippingPostcode: String? = null, var billingPostcode: String? = null, var shippingFullAddress: String? = null, var billingFullAddress: String? = null, var deliveryProvider: String? = null, var deliveryMethod: String? = null, var couponCode: String? = null, var accountType: String? = null, var paymentMethod: String? = null, var proofOfPayment: String? = null, var marketingOptIn: Boolean? = null) : AbstractSelfDescribing

Track a checkout step. Entity schema: iglu:com.snowplowanalytics.snowplow.ecommerce/checkout_step/jsonschema/1-0-0

ProductListClickEvent

class ProductListClickEvent @JvmOverloads constructor(var product: ProductEntity, var name: String? = null) : AbstractSelfDescribing

Track a product list click or selection event.

ProductListViewEvent

class ProductListViewEvent @JvmOverloads constructor(var products: List<ProductEntity>, var name: String? = null) : AbstractSelfDescribing

Track a product list view.

ProductViewEvent

class ProductViewEvent(var product: ProductEntity) : AbstractSelfDescribing

Track a product view/detail.

PromotionClickEvent

class PromotionClickEvent(var promotion: PromotionEntity) : AbstractSelfDescribing

Track a promotion click or selection.

PromotionViewEvent

class PromotionViewEvent(var promotion: PromotionEntity) : AbstractSelfDescribing

Track a promotion view.

RefundEvent

class RefundEvent @JvmOverloads constructor(var transactionId: String, var refundAmount: Number, var currency: String, var refundReason: String? = null, var products: List<ProductEntity>? = null) : AbstractSelfDescribing

Track a refund event. Use the same transaction ID as for the original Transaction event. Provide a list of products to specify certain products to be refunded, otherwise the whole transaction will be marked as refunded. Entity schema: iglu:com.snowplowanalytics.snowplow.ecommerce/refund/jsonschema/1-0-0

RemoveFromCartEvent

class RemoveFromCartEvent @JvmOverloads constructor(var products: List<ProductEntity>, var cart: CartEntity) : AbstractSelfDescribing

Track a product or products being removed from cart.

TransactionErrorEvent

class TransactionErrorEvent @JvmOverloads constructor(var transaction: TransactionEntity, var errorCode: String? = null, var errorShortcode: String? = null, var errorDescription: String? = null, var errorType: ErrorType? = null, var resolution: String? = null) : AbstractSelfDescribing

Track a transaction error event. Entity schema: iglu:com.snowplowanalytics.snowplow.ecommerce/transaction_error/jsonschema/1-0-0

TransactionEvent

class TransactionEvent @JvmOverloads constructor(var transaction: TransactionEntity, var products: List<ProductEntity>? = null) : AbstractSelfDescribing

Track a transaction event. Entity schema: iglu:com.snowplowanalytics.snowplow.ecommerce/transaction/jsonschema/1-0-0