com.mparticle.kits

Interface KitIntegration.CommerceListener

Enclosing class:

KitIntegration

public static interface KitIntegration.CommerceListener

Kits should implement this interface in order to listen for eCommerce events

Method Summary

Modifier and Type	Method and Description
java.util.List<ReportingMessage>	logEvent(CommerceEvent event) The mParticle SDK exposes a rich eCommerce API, allowing developers to keep track of purchases and many other product-related interactions.
java.util.List<ReportingMessage>	logLtvIncrease(java.math.BigDecimal valueIncreased, java.math.BigDecimal valueTotal, java.lang.String eventName, java.util.Map<java.lang.String,java.lang.String> contextInfo) The mParticle SDK exposes a basic lifetime-value-increase API.

Method Detail

logLtvIncrease

java.util.List<ReportingMessage> logLtvIncrease(java.math.BigDecimal valueIncreased,
                                                java.math.BigDecimal valueTotal,
                                                java.lang.String eventName,
                                                java.util.Map<java.lang.String,java.lang.String> contextInfo)

The mParticle SDK exposes a basic lifetime-value-increase API. This allows developers to increase the value associated with a user in the case where no particular event is appropriate.

Parameters:

valueIncreased - the amount that the LTV should be increased by.

valueTotal - the total value that mParticle now associates with the user after this increase

eventName - an optional name to associate with the LTV increase

contextInfo - an optional Map of attributes to associate with the LTV increase

Returns:

Kits should return a List of ReportingMessages indicating that the LTV increase was processed one or more times, or null if it was not processed

logEvent

java.util.List<ReportingMessage> logEvent(CommerceEvent event)

The mParticle SDK exposes a rich eCommerce API, allowing developers to keep track of purchases and many other product-related interactions.

CommerceEvents may contain several Products, Impressions, and/or Promotions. Depending on the nature of your SDK's API, you should iterate over the items within a CommerceEvent and forward several discrete events, returning a ReportingMessage for each API call.

Parameters:

event - the CommerceEvent that was logged

Returns:

Kits should return a List of ReportingMessages indicating that the CommerceEvent was processed one or more times, or null if it was not processed