SFMCSdk Runtime Toggles
The Runtime Toggle feature, also known as “feature toggles”, allows you to dynamically enable or disable specific functionalities within the SDK without the need to re-initialize it. With Runtime Toggles, you have control over the following features:
- Analytics: Enables or disables Salesforce MarketingCloud Analytics services.
- PI (Predictive Intelligence) Analytics: Enables or disables Salesforce Predictive Intelligence Analytics services.
- Inbox: Enables or disables Inbox messaging services.
- Geofence: Enables or disables geolocation-based notification and messaging services.
- Proximity: Enables or disables proximity-based (aka Beacon) notification and messaging services.
By utilizing the Runtime Toggles feature, you can fine-tune your application’s behavior, adapt to changing requirements, and ensure compliance with GDPR regulations effortlessly.
API Usage
To interact with the Runtime Toggles, the SDK provides APIs for each feature to set and get status of toggled feature.
Toggle APIs
SFMCSdk.requestSdk {
it.mp { push ->
// Analytics
push.analyticsManager.enableAnalytics() // or disableAnalytics()
push.analyticsManager.enablePiAnalytics() // or disablePiAnalytics()
// Messaging
push.inboxMessageManager.enableInbox() // or disableInbox()
push.regionMessageManager.enableGeofenceMessaging() // or disableGeofenceMessaging()
push.regionMessageManager.enableProximityMessaging() // or disableProximityMessaging()
}
}
Explaining Analytic Runtime Toggle
The functionality of analytic runtime toggles entails several actions when disabling it. Firstly, it involves the removal of all non-billable analytics, and secondly, it ensures that the SDK does not record any non-billable analytics.
Non-billable analytics encompass data that appears in reports and relates to how marketers monitor the performance of their messaging. For example, tracking of push notifications and inbox opens. See Analytics documentation for more details on this. On the other hand, billable analytics serve the purpose of informing Marketing Cloud whether a billable action occurred, without tracking any user-specific information. Therefore, although certain “analytics” will still be transmitted to Marketing Cloud when the toggle is disabled, they exclusively pertain to billable events and do not involve any user-related data from the device.