Customer Data Platform Mobile SDK

Prerequisites

In order to use the Customer Data Platform Mobile SDK, create a Salesforce data source connector and auto-generated endpoints. Log into your Customer Data Platform application and navigate to the left side panel of the Websites and Mobile Apps screen. Set up your data sources by creating an app connector within the user interface. For additional information, see the Customer Data Platform Implementation Guide.

Use the appSourceId and generated endpoints from your web data connector to initialize the Customer Data Platform Mobile SDK.

Download the SDK

Install the SDK

You can add the Customer Data Platform Mobile SDK to your mobile application using CocoaPods or by building the calls into your source code.

CocoaPods

1use_frameworks!
2          
3          target '<Your Target>' do
4             pod 'SALESFORCE-CDP-SDK-IOS-SDK', '~> 1.0'
5          end

Manual Installation

A manual installation requires that you manage all of the dependencies with your own code. Given that multiple libraries are sharing a dependency, but all can specify a different version of it, it’s the mobile app developer’s responsibility to provide the best version of the library that satisfies all dependencies.

Configuring the SDK

1let config = CdpConfigBuilder(appId: {REPLACE WITH APP ID}, endpoint: {REPLACE WITH ENDPOINT})
2       .trackScreens({True|False})
3       .trackLifecycle({True|False})
4       .sessionTimeout({Int})
5       .build()

Configure the SDK

Configuration Parameters

The following table describes Customer Data Platform Mobile SDK configurable settings.

1https://{tenant specific 
2              endpoint id}.c360a.salesforce.com. [description here of allowed domains]

Logging Levels

Logging is an optional, yet critical, SDK feature that allows the mobile application developer to select the verbosity of the Customer Data Platform Mobile SDK’s output. By default, logging is disabled and must be enabled using the setLogLevel method on the CdpSdk shared instance to define the desired Log Level and the Log Outputter. This results in log capture using the native unified logging system.

Logging Parameters

1CdpSdk.setLogLevel(MCLogLevel.debug, logOutputter: LogOutputter())

Log Level Definitions

SDK State

1CdpSdk.shared.state

1{
2      "name":"cdp",
3      "config": {
4          "screenTrackingEnabled":false,
5          "lifecycleEventTrackingEnabled":false,
6          "appId":"YOUR APP ID",
7          "endpoint":"YOUR ENDPOINT"
8          "sessionDuration":600
9      },
10      "sessionManager": {
11          "sessionId":"SESSION ID"
12      },
13      "eventManager": {
14          "queueSize":2
15      },
16      "consentManager": {
17          "deviceId":"YOUR DEVICE ID",
18          "consent":"opt_in"
19      }
20   }

Consent Management

To help Salesforce customers manage consent and privacy obligations such as the European Union’s General Data Protection Regulation (GDPR), the California Consumer Privacy Act (CCPA), or any internal corporate privacy policy, the Customer Data Platform Mobile SDK offers a managed solution for allowing and restricting collection of event data.

Your mobile application is responsible for presenting the device owner with the choice to opt in or opt out of data collection and for setting the Customer Data Platform Mobile SDK consent property accordingly.

Grant Consent

1CdpSdk.shared.consent = Consent.optIn

Consent Parameters

The following table describes Customer Data Platform Mobile SDK configurable settings.

Location Tracking

1// prepare the coordinates
2          let coordinates = Coordinates(latitude: 54.187738, longitude: 15.554440)
3          
4          // set the location coordinates and expiration time
5          CdpSdk.shared.setLocation(coordinates: coordinates, expiresIn: 60)

Given that the SDK has non-expired location coordinates, the location attributes are automatically appended to the event attributes key/value pairs with key names latitude and longitude.

When the expiration interval has been exceeded, the SDK location coordinates are cleared and are no longer attached to events. If you want to prevent location from being attached to events before the coordinates expire, call setLocation and pass nil values as the coordinates.

NOTE: As the application developer, you’re responsible for handling location tracking permission from the end user. You’re responsible for requesting location permission, fetching the location, and ensuring the desired accuracy range.

Event Tracking

The Customer Data Platform Mobile SDK enables collection of granular data about end users’ mobile app interactions through event tracking. An event consists of the event type, and event attributes (optional). The Customer Data Platform Mobile SDK currently supports two event objects, engagement and profile.

Track Events

1let event = Event.engagement(eventType: "CartAbandonment", attributes: 
2          ["sku": "COFFEE-NTR-06", "tag price": 19.99])

1CdpSdk.shared.track(event: event)

You can verify which events are being tracked by checking the queueSize under the eventManager section in the Customer Data Platform Mobile SDK state (CdpSdk.shared.state).

Now you’ve successfully configured and initialized the Customer Data Platform Mobile SDK, create an event, and submit that event to the Customer Data Platform application for tracking.

Within the Customer Data Platform Mobile SDK-managed solution, Consent is an enumerated type consisting of three named values: pending, optIn, and optOut. Consent is internally set to “pending” when the SDK is initialized. The mobile application consuming the SDK can update Consent to either optIn or optOut, but can’t revert to pending.

See the following table for details about Customer Data Platform Mobile SDK consent management for customer data collection.

Event Parameters

1// create engagement event
2          let event = Event.engagement(eventType: "CartAbandonment", attributes: ["sku": "COFFEE-NTR-06", "tag price": 19.99])
3          
4          // track engagement event
5          CdpSdk.shared.track(event: event)
6          
7          // create engagement event (no attributes)
8          let simpleEvent = Event.engagement(eventType: "SortPriceLowToHigh")
9          CdpSdk.shared.track(event: simpleEvent)
10          
11          // create profile event
12          let profileEvent = Event.profile(eventType: "UserUpdate", attributes: ["name": "John"])
13          
14          // track profile event
15          CdpSdk.shared.track(event: profileEvent)