mParticle iOS

Deeplinking Support

Verify that the AASA file's contents are correct. This should be at https://mi.example.com/.well-known/apple-app-site-association. Make sure to replace the domain with your company's Movable Ink subdomain. It should look similar to the example below. If it doesn't, check with your Movable Ink client experience team to ensure Deeplinking support has been enabled for your company. If you haven't already, you'll need to provide Movable Ink with your Apple's Team ID and Bundle Identifier.

{
  "applinks": {
    "details": [
      {
        "appIDs": [
          "TEAMID.com.example.app",
        ],
        "defaults": {
          "caseSensitive": false
        },
        "components": [
          {
            "/": "/p/rpm/*",
            "comment": "Matches any path that starts with /p/rpm/"
          },
          {
            "/": "/p/cpm/*",
            "comment": "Matches any path that starts with /p/cpm/"
          }
        ]
      }
    ]
  }
}

Setup Universal Links

Under the Signing & Capabilities tab in Xcode, add the Associated Domains Capability, then add the applinks that you can support. One of these should be your Movable Ink domain, such as mi.example.com. If you're unaware of what your Movable Ink domain is, you can check with your Movable Ink client experience team.

To learn more about Universal Links, check out the Apple documentation.

The domain must be exact and does not support wildcards. Don't use *.example.com or example.*.com.

Setup Plist

In your Info.plist, add the movable_ink_universal_link_domains key as an array containing all the domains that you'd like the Movable Ink SDK to handle. Note: These should only be domains that are shown in your Creative Tags, such as mi.example.com.

You also need to add the movable_ink_api_key key as a string and add your Movable Ink API Key there. Your Movable Ink Client Experience team will provide this API key to you.

Lastly, add your company region under the movable_ink_region key. Valid values are either us or eu. If you're not sure what region your company was set up under in the Movable Ink platform, ask your Movable Ink client experience team.

<key>movable_ink_universal_link_domains</key>
<array>
  <string>mi.example.com</string>
</array>
<key>movable_ink_api_key</key>
<string>YOUR_API_KEY</string>
<key>movable_ink_region</key>
<string>eu</string>

mParticle Setup

Install the mParticle Movable Ink Kit

SPM

1. In Xcode, open your project, select the project under the PROJECT header, then select Package Dependencies
2. Search for https://github.com/movableink/mparticle-apple-integration-movableink
3. Tap Add Package

Carthage

Cartfile

github "movableink/mparticle-apple-integration-movableink"

In the root of your project, run

$ carthage update --use-xcframeworks

Integrate Kit

Where you set up mParticle, most likely in your AppDelegate, add the Movable Ink Kit as a sideloaded kit.

let options = MParticleOptions(key: key, secret: secret)
options.sideloadedKits = [MPSideloadedKit(kitInstance: MPKitMovable Ink())]

// For deeplinking
options.onAttributionComplete = { result, error in
  guard let result else { print(error); return }

  print(result.kitName)
  print(result.linkInfo)
}

MParticle.sharedInstance().start(with: options)

Events

Movable Ink supports specific events. If you need to track any custom events, please reach out to your Movable Ink client experience team. Listed below are examples for the out of the box events:

Category Viewed

if let event = MPEvent(name: "category viewed", type: .other) {
  event.category = category.rawValue
  MParticle.sharedInstance().logEvent(event)
}

Product Searched

if let event = MPEvent(name: "product searched", type: .other) {
  event.customAttributes = ["query": query]
  MParticle.sharedInstance().logEvent(event)
}

Product Viewed | View Detail

let mpProduct = MPProduct(name: product.name, sku: product.id, quantity: 0, price: 1.00)
mpProduct.category = product.category.rawValue

let event = MPCommerceEvent(action: .viewDetail, product: mpProduct)
event.currency = "USD"

MParticle.sharedInstance().logEvent(event)

Product Added | Add To Cart

let mpProduct = MPProduct(name: product.name, sku: product.id, quantity: 0, price: 1.00)
mpProduct.category = product.category.rawValue

let event = MPCommerceEvent(action: .addToCart, product: mpProduct)
event.currency = "USD"

MParticle.sharedInstance().logEvent(event)

Product Removed | Remove From Cart

let mpProduct = MPProduct(name: product.name, sku: product.id, quantity: 0, price: 1.00)
mpProduct.category = product.category.rawValue

let event = MPCommerceEvent(action: .removeFromCart, product: mpProduct)
event.currency = "USD"

MParticle.sharedInstance().logEvent(event)

Order Complete | Purchase

let mpProduct = MPProduct(name: product.name, sku: product.id, quantity: 1, price: 1.00)
mpProduct.category = product.category.rawValue

let attributes = MPTransactionAttributes()
attributes.transactionId = UUID().uuidString
attributes.revenue = 1.00

let event = MPCommerceEvent(eventType: .purchase)!
event.addProduct(mpProduct)
event.currency = "USD"
event.transactionAttributes = attributes

MParticle.sharedInstance().logEvent(event)