optimizely/swift-sdk v4.0.0

Release 4.0.0

on GitHub

4.0.0

Jan 18, 2024

New Features

The 4.0.0 release introduces a new primary feature, Advanced Audience Targeting enabled through integration with Optimizely Data Platform (ODP) (#455, #470, #471, #477,#512).

You can use ODP, a high-performance Customer Data Platform (CDP), to easily create complex real-time segments (RTS) using first-party and 50+ third-party data sources out of the box. You can create custom schemas that support the user attributes important for your business, and stitch together user behavior done on different devices to better understand and target your customers for personalized user experiences. ODP can be used as a single source of truth for these segments in any Optimizely or 3rd party tool.

With ODP accounts integrated into Optimizely projects, you can build audiences using segments pre-defined in ODP. The SDK will fetch the segments for given users and make decisions using the segments. For access to ODP audience targeting in your Feature Experimentation account, please contact your Customer Success Manager.

This version includes the following changes:

• New API added to OptimizelyUserContext:

  • fetchQualifiedSegments(): this API will retrieve user segments from the ODP server. The fetched segments will be used for audience evaluation. The fetched data will be stored in the local cache to avoid repeated network delays.

  • When an OptimizelyUserContext is created, the SDK will automatically send an identify request to the ODP server to facilitate observing user activities.

• New APIs added to OptimizelyClient:

  • sendOdpEvent(): customers can build/send arbitrary ODP events that will bind user identifiers and data to user profiles in ODP.

  • createUserContext() with anonymous user IDs: user-contexts can be created without a userId. The SDK will create and use a persistent VUID specific to a device when userId is not provided.

For details, refer to our documentation pages:

• Advanced Audience Targeting

• Client SDK Support

• Initialize Swift SDK

• OptimizelyUserContext Swift SDK

• Advanced Audience Targeting segment qualification methods

• Send Optimizely Data Platform data using Advanced Audience Targeting

Breaking Changes

• ODPManager in the SDK is enabled by default. Unless an ODP account is integrated into the Optimizely projects, most ODPManager functions will be ignored. If needed, ODPManager can be disabled when OptimizelyClient is instantiated.

Bug Fixes

• Adds a check to only save valid datafile in cache. (#514)
• Remove redundant post request body in upload task. (#521).
• Privacy manifest file value for required reason API fixed. (#541)
• Add coccoapods support for privacy manifest. (#542)
• Add SPM support added to process privacy manifest. (#544)

Functionality Enhancement

• Adds support to override sdkName and sdkVersion for events. (#512)
• Swift async-await support. (#513)
• Update Github Issue Templates. (#516)
• Handle duplicate keys in experiment (#523).
• Add privacy manifest file (#522).