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

Package-level declarations

Ecommerce data classes.

Types

Link copied to clipboard
data class CartEntity @JvmOverloads constructor(var totalValue: Number, var currency: String, var cartId: String? = null)

Provided to certain Ecommerce events. The Cart properties will be sent with the event as a Cart entity. Entity schema: iglu:com.snowplowanalytics.snowplow.ecommerce/cart/jsonschema/1-0-0

Link copied to clipboard
data class EcommerceScreenEntity @JvmOverloads constructor(var type: String, var language: String? = null, var locale: String? = null)

Add ecommerce Screen/Page details. It is designed to help with grouping insights by screen/page type, e.g. Product description, Product list, Home.

Link copied to clipboard
data class EcommerceUserEntity @JvmOverloads constructor(var id: String, var isGuest: Boolean? = null, var email: String? = null)

Add ecommerce User details. It is designed to help in modeling guest/non-guest account activity. Entity schema: iglu:com.snowplowanalytics.snowplow.ecommerce/user/jsonschema/1-0-0

Link copied to clipboard
data class ProductEntity @JvmOverloads constructor(var id: String, var category: String, var currency: String, var price: Number, var listPrice: Number? = null, var name: String? = null, var quantity: Int? = null, var size: String? = null, var variant: String? = null, var brand: String? = null, var inventoryStatus: String? = null, var position: Int? = null, var creativeId: String? = null)

Provided to certain Ecommerce events. The Product properties will be sent with the event as a Product entity. Entity schema: iglu:com.snowplowanalytics.snowplow.ecommerce/product/jsonschema/1-0-0

Link copied to clipboard
data class PromotionEntity @JvmOverloads constructor(var id: String, var name: String? = null, var productIds: List<String>? = null, var position: Int? = null, var creativeId: String? = null, var type: String? = null, var slot: String? = null)

Provided to certain Ecommerce events. The Promotion properties will be sent with the event as a Promotion entity. Entity schema: iglu:com.snowplowanalytics.snowplow.ecommerce/promotion/jsonschema/1-0-0

Link copied to clipboard
data class TransactionEntity @JvmOverloads constructor(var transactionId: String, var revenue: Number, var currency: String, var paymentMethod: String, var totalQuantity: Int, var tax: Number? = null, var shipping: Number? = null, var discountCode: String? = null, var discountAmount: Number? = null, var creditOrder: Boolean? = null)

Provided to certain Ecommerce events. The Transaction properties will be sent with the event as a Transaction entity. Entity schema: iglu:com.snowplowanalytics.snowplow.ecommerce/transaction/jsonschema/1-0-0