NuSkooler / cordova-plugin-mparticle

cordova-plugin-mparticle

Cordova plugin for mParticle

Installation

cordova plugin install mparticle

Grab your mParticle key and secret from your app's dashboard and move on to the OS-specific instructions below.

iOS

Start mParticle within application:didFinishLaunchingWithOptions::

[[MParticle sharedInstance] startWithKey:@"APP KEY" secret:@"APP SECRET"];

Android

Add your key and secret as string resources in your app:

<?xml version="1.0" encoding="utf-8" ?>
<!-- ex. src/main/res/values/mparticle.xml -->
<resources>
    <string name="mp_key">APP KEY</string>
    <string name="mp_secret">APP SECRET</string>
</resources>

Start mParticle in your application's onCreate:

MParticle.start(this);

Usage

Events

Logging events:

mparticle.logEvent('Test event', mparticle.EventType.Other, { 'Test key': 'Test value' })

Logging commerce events:

var product = new mparticle.Product('Test product for cart', 1234, 19.99)
var transactionAttributes = new mparticle.TransactionAttributes('Test transaction id')
var event = mparticle.CommerceEvent.createProductActionEvent(mparticle.ProductActionType.AddToCart, [product], transactionAttributes)

mparticle.logCommerceEvent(event)

var promotion = new mparticle.Promotion('Test promotion id', 'Test promotion name', 'Test creative', 'Test position')
var event = mparticle.CommerceEvent.createPromotionEvent(mparticle.PromotionActionType.View, [promotion])

mparticle.logCommerceEvent(event)

var product = new mparticle.Product('Test viewed product', 5678, 29.99)
var impression = new mparticle.Impression('Test impression list name', [product])
var event = mparticle.CommerceEvent.createImpressionEvent([impression])

mparticle.logCommerceEvent(event)

Logging screen events:

mparticle.logScreenEvent('Test screen', { 'Test key': 'Test value' })

User Attributes

Setting user attributes and tags:

mparticle.setUserAttribute('Test key', 'Test value')

mparticle.setUserAttribute(mparticle.UserAttributeType.FirstName, 'Test first name')

mparticle.setUserAttributeArray('Test key', ['Test value 1', 'Test value 2'])

mparticle.setUserTag('Test key')

mparticle.removeUserAttribute('Test key')

User Identities

Setting user identities:

mparticle.setUserIdentity('[e-mail]', mparticle.UserIdentityType.Email)

License

Apache 2.0