Push Token Sync Optimizations

Overview

Starting with release 3.3.3 on Android and 5.6.3 on iOS, the AEPMessaging extension SDK prevents unnecessary network requests from being sent when syncing push tokens. By default, the push token sync optimization will only send a network request if the token has changed since the last succesful sync request. This reduces unnecessary network traffic which can help improve app performance.

Configuration

Tags mobile property

The push identifier sync optimization is configurable from a Tags mobile property using the Adobe Journey Optimizer extension version 1.0.2 or greater. Use the Optimize Push Identifier Updates checkbox to enable or disable the optimization. The configuration is enabled by default.

Mobile SDK Configuration APIs

The push identifier sync optimization may be configured directly from the Mobile SDK using the MobileCore.updateConfiguration API. Use the messaging.optimizePushSync configuration key to control the push token synchronization behavior:

Key

Required

Description

Data Type

Operating System

messaging.optimizePushSync

If false, allows the push identifier to be synced every time the setPushIdentifier API is called. Default value is true.

Boolean

Android/iOS

Push Sync Optimization Behavior

When messaging.optimizePushSync is set to true:

A new push token is synced with Adobe Journey Optimizer when setPushIdentifier is called. If the provided push token is the same as the current push token, the API call is ignored and no network request is made to Adobe Experience Platform.

When messaging.optimizePushSync is set to false:

The push token is synced with Adobe Journey Optimizer every time setPushIdentifier is called.
There is a one second timeout between succesful sync requests. This timeout ensures that multiple sync requests made at the same time, which do not change the push token value, will not result in redundant network requests. The timeout does not apply If the push token value in the request is different than the current token value.

Usage Scenarios

The AEPMessaging extension SDK will always sync new push tokens when the setPushIdentifier API is called. While the usage of the messaging.optimizePushSync configuration key to disable the push sync optimization behavior should not be needed in normal app usage scenarios, it would be useful in some special cases such as:

When datastream overrides are used to send push tokens to multiple datasets or datastreams.
When changing the Edge configuration via the edge.configId configuration key to send push tokens to different datastreams.
When changing the environment file ID passed to MobileCore.configureWithAppID to change the Edge configuration which can be used to send push tokens to different datastreams.

Usage Example

Android

val config = mapOf("messaging.optimizePushSync" to false)
MobileCore.updateConfiguration(config)

iOS

let config = ["messaging.optimizePushSync": false]
MobileCore.updateConfigurationWith(configDict: config)