Capture Profile Data (Version 3.x)

The Data 360 Module for the Engagement Mobile SDK enables collection of profile data through the SDK's Identity APIs.

Prerequisites

Before engagement data can be sent to Data 360:

• The Data 360 Module for the Engagement Mobile SDK must be configured and initialized.
• Consent to track profile data must be granted.

Required Imports

All iOS code examples on this page require the following imports:

import Cdp
import SFMCSDK

Set Profile Attributes

Profile attributes are set through the SFMCSDK identity module using the identity.edit API. The Data 360 Module subscribes to identity events via the SFMCSDK EventBus and automatically converts them into profile events.

Individual Identity Attributes

Maps to the identity schema.

import Cdp
import SFMCSDK

...

SFMCSdk.identity.edit { identity in
    identity.addAttributes(attributes: [
        "firstName": "Guy",
        "lastName": "Smiley"
    ])
    return identity
}

import com.salesforce.marketingcloud.sfmcsdk.SFMCSdk

...

SFMCSdk.requestSdk { sdk ->
    sdk.identity.edit {
        attributes.putAll(mapOf(
            "firstName" to "First",
            "lastName" to "Last"
        ))
    }
}

Contact Point — Email

Maps to the contactPointEmail schema.

SFMCSdk.identity.edit { identity in
    identity.addAttributes(attributes: [
        "email": "guy.smiley@example.com"
    ])
    return identity
}

SFMCSdk.requestSdk { sdk ->
    sdk.identity.edit {
        attributes.put("email", "user@example.com")
    }
}

Contact Point — Phone

Maps to the contactPointPhone schema.

SFMCSdk.identity.edit { identity in
    identity.addAttributes(attributes: [
        "phoneNumber": "555-9999"
    ])
    return identity
}

SFMCSdk.requestSdk { sdk ->
    sdk.identity.edit {
        attributes.put("phoneNumber", "5551234567")
    }
}

Contact Point — Address

Maps to the contactPointAddress schema.

SFMCSdk.identity.edit { identity in
    identity.addAttributes(attributes: [
        "addressLine1": "123 Main Street",
        "addressLine2": "Apt 3",
        "city": "Saint John",
        "stateProvince": "New Brunswick",
        "country": "Canada",
        "postalCode": "E2K2K2"
    ])
    return identity
}

SFMCSdk.requestSdk { sdk ->
    sdk.identity.edit {
        attributes.putAll(mapOf(
            "addressLine1" to "123 Main St",
            "city" to "Springfield",
            "stateProvince" to "IL",
            "postalCode" to "62701",
            "country" to "US"
        ))
    }
}

note: The Data 360 Module only emits a contact point event if the required fields for that type are present in the accumulated attributes and have changed since the last emission (diff-based). The identity modifier closure for iOS must return the modifier object.

When a profile attribute changes, the Data 360 Module triggers an identity profile event containing all set attributes. You can set any name-value pair for profile attributes.

Supported Customer 360 Data Model

The Identity Schema provided by the recommended Mobile Connector schema for Data 360 contains profile attributes that support identity resolution features when mapped to the appropriate Customer 360 Data Model.

Each identity event contains mappable fields.

• Individual
  • firstName
  • lastName
• Software Application
  • registrationId
  • softwareApplicationName
• Device
  • advertiserId
  • deviceType
  • osName
• Contact Point App
  • registrationId

Device advertiserId

Starting with Android 13 (API level 33), permission is required to request the device's advertiserId. In Data 360 2.0.2, this permission is included by default. To prevent this permission from getting merged into your app, add this element to your AndroidManifest.xml:

<uses-permission android:name="com.google.android.gms.permission.AD_ID" tools:node="remove"/>

Contact Points

Each supported contact point has required attributes that must be provided to the SDK's Identity API. After all attributes are provided, the Data 360 Module triggers a profile event with contact points and an identity event.

The contact points and required attributes that trigger them are:

• Contact Point Email Schema
  • email
• Contact Point Phone Schema
  • phoneNumber
• Contact Point Address Schema
  • addressLine1
  • city
  • stateProvince
  • country

Anonymous and Known Users

In the Data 360 Module, all customers are considered known by default. To mark a customer as anonymous, set the isAnonymous profile attribute to "1". Setting isAnonymous to "0" ensures customers are considered known.

// Mark profile as anonymous
CdpModule.shared.setProfileToAnonymous()
// Mark profile as known
CdpModule.shared.setProfileToKnown()

// Read the current anonymous state
let isAnonymousValue = SFMCSdk.cdp.getIdentity()?.customProperties?["isAnonymous"] as? String
let isAnonymous = isAnonymousValue == "1"

SFMCSdk.cdp is the accessor for the CDP module on the unified SDK object. CdpModule.shared and SFMCSdk.cdp refer to the same module instance.

SFMCSdk.requestSdk { sdk ->
    sdk.identity.edit {
        attributes.putAll(mapOf(
            "firstName" to "First",
            "lastName" to "Last",
            "isAnonymous" to "1" // "0" for known customer
        ))
    }
}

Shared Party Identifiers

The Engagement Mobile SDK supports sharing identifiers between modules for integration with other Salesforce systems. For example, match an individual using a mobile application with both Data 360 and MobilePush modules to send push notifications to specific anonymous mobile users.

Anonymous MobilePush User

The identity event contains fields that can be mapped to the Party Identification model.

• registrationId: Identification Number

Known MobilePush User

When the MobilePush module obtains a resolved identity for a mobile customer, it sets a profileId using the SDK's Identity API. The Data 360 Module is notified and sends a partyIdentification event with these fields:

• userId: Identification Number
• IDName: Party Identification Name
• IDType: Party Identification Type

On Android, you can set the profileId directly to link the device to a known subscriber or profile:

SFMCSdk.requestSdk { sdk ->
    sdk.identity.edit {
        profileId = "subscriber-key-123"
    }
}