Skip to content

Latest commit

 

History

History
182 lines (144 loc) · 8.02 KB

MigrationGuide.md

File metadata and controls

182 lines (144 loc) · 8.02 KB
Raw

Migrating from 7.x to 7.5.0

With version 7.5.0 you are now able to support USNat campaigns on your app.

Provided your property on Sourcepoint portal contains a U.S. MultiState Privacy Compliance campaign (also sometimes referred to USNat or GPP), adding support to it in your app should be effortless:

  1. Replace ccpa campaign with usnat
// constructor
SPConsentManager(
    accountId: 123,
    propertyId: 123
    propertyName: try! SPPropertyName("myPropertyName"),
    campaigns: SPCampaigns(
-        ccpa: SPCampaign(),
+        usnat: SPCampaign()
    ),
    delegate: self
)
  1. Replace the call to loadCCPAPrivacyManager with loadUSNatPrivacyManager.

The SDK will automatically detect local data and, if the user has opted-out on CCPA, it'll transition that opt-out signal to the new usnat legislation. If you're migrating from an older version of the SDK (i.e. <7.5) and you make use of authenticated consent with CCPA, you'll need to perform one extra step:

  1. (Optional) make sure to set the following flag usnat: SPCampaign(transitionCCPAAuth: true). This ensures the SDK transitions CCPA opted-out consent to the new usnat legislation, even on a new app install.

For more information regarding USNat and how to setup it, make sure to check our help articles.

Migrating from v6 to v7

We worked hard to keep the public API as close as possible to the previous version in order to keep your migration effort to a minimum.

// constructor
SPConsentManager(
    accountId: 123,
+   propertyId: 123
    propertyName: try! SPPropertyName("myPropertyName"),
-   campaignsEnv: .Public, // optional - Public by default
    campaigns: SPCampaigns(
        gdpr: SPCampaign(),   // optional
        ccpa: SPCampaign(),   // optional
        ios14: SPCampaign(),  // optional
+       environment: .Public  // optional - .Public by default
    ),
    delegate: self
)

And that's it!

Notice: the internal data structure kept by the SDK in the UserDefaults has changed. If your app relied on data that was not publicly available through the SPDelegate protocol, you might face some issues. That does not impact the data described by the TCF spec (ie. data keyed and prefixed by IABTCF_).

Passing consent between webview and native

Historically, when using Sourcepoint's iOS SDK v6, passing consent between native and webview portions of an app was handled by implementing authenticated consent.

In iOS SDK v7, the authenticated consent workflow for passing consent between native and webview portions of an app is deprecated and replaced by the following WKWebView implementation.

Sharing consent with a WKWebView

After going through the message and consent flow (ie. after onConsentReady) the SDK will store the consent data in the UserDefaults. That data can then be injected into WKWebViews so the web portion of your app doesn't show a consent dialog and it'll contain the same consent data as the native part.

Example:

// somewhere earlier in your app's lifecycle
var userConsents: SPUserData?

func onSPFinished(userData: SPUserData) {
    userConsents = userData
}

let webview = WKWebView()
if let userConsents = userConsents {
    webview.load(URLRequest(URL(string: "https://my-url.com/?_sp_pass_consent=true")!))
    webview.preloadConsent(from: userConsents)
} else {
    webview.load(URLRequest(URL(string: "https://my-url.com/")!)) // load url without _sp_pass_consent=true
}

A few remarks:

  1. The web content being loaded (web property) needs to share the same vendor list as the app.
  2. The vendor list's consent scope needs to be set to Shared Site instead of Single Site
  3. Your web content needs to be loaded (or loading) on the webview and our web SDK should be included in it. Furthermore, you need to add the query param _sp_pass_consent=true to your URL, this will signal to Sourcepoint's web SDK it needs to wait for the consent data to be injected from the native code, instead of immediately querying it from our servers.

Migrating from v5 to v6 (Unified SDK)

In this guide we will cover how to migrate your app to the latest version of Sourcepoint's SDK (v6). While this migration means more work for you, it also allows for multiple improvements. Below are some reasons to migrate to the latest version of our SDK:

  1. Your organization no longer needs to integrate with multiple SDKs! The latest version of our SDK supports CCPA, GDPR and ATT pre-prompt message.
  2. No longer instantiate a UIViewController if there is no message being displayed.
  3. End-users will see a message faster by removing one network call (down from 3 to 2).

Note: In addition to the technical migration below, you will also need to enable the Multi-Campaign toggle for the app property within the Sourcepoint portal.

Initialisation:

Previous version:

lazy var consentViewController: GDPRConsentViewController = { return GDPRConsentViewController(
    accountId: 22,
    propertyId: 7639,
    propertyName: try! GDPRPropertyName("tcfv2.mobile.webview"),
    PMId: "122058",
    campaignEnv: .Public,
    consentDelegate: self
)}()

v6 (Unified SDK):

lazy var consentManager: SPConsentManager = { SPConsentManager(
    accountId: 22,
    propertyName: try! SPPropertyName("mobile.multicampaign.demo"),
    campaigns: SPCampaigns(
        gdpr: SPCampaign()
    ),
    delegate: self
)}()
  • GDPRConsentViewController has been renamed to SPConsentManager. We no longer instantiate a UIViewController unless there is a message to be displayed.
  • SPCampaigns will accept up to 3 campaigns: gdpr, ccpa, and ios14 (ATT pre-prompt). They are all of the type SPCampaign and are all optional.
  • propertyId is no longer required.
  • PMId has been moved to .loadGDPRPrivacyManager or .loadCCPAPrivacyManager. See below.

Load Privacy Manager:

Previous version:

.loadPrivacyManager()

v6 (Unified SDK):

.loadGDPRPrivacyManager(withId: String, tab: SPPrivacyManagerTab)
// or
.loadCCPAPrivacyManager(withId: String, tab: SPPrivacyManagerTab)

Delegate methods

gdprConsentUIWillShow()

Changed to:

onSPUIReady(_ controller: UIViewController)

The onSPUIReady might be called multiple times, one for each message returned by the scenario.

onAction(_ action: GDPRAction)

v6 (Unified SDK):

onAction(_ action: SPAction, from controller: UIViewController)

The onAction method hasn't changed much apart from having on extra parameter indicating the ViewController in which the user took that action.

consentUIDidDisappear()

v6 (Unified SDK):

onSPUIFinished(_ controller: UIViewController)

The onSPUIFinished might be called multiple times, one for each message that needs to be removed from View stack.

onConsentReady(gdprUUID: GDPRUUID, userConsent: GDPRUserConsent)

v6 (Unified SDK):

onConsentReady(consents: SPUserData) {
  • The SDK might call the method onConsentReady multiple times (if there are multiple messages being displayed one after the other) however this is not very likely to happen since a real world scenario should not return a CCPA and a GDPR message in the same end-user journey.
  • We have incorporated all consent data into SPUserData, composed of gdpr: SPGDPRConsent? and ccpa: SPCCPAConsent? attributes. Note those attributes are optional since an end-user might only have consent on a single legislation or even none (depending on which campaigns are set up).

onError(error: GDPRConsentViewControllerError)

v6 (Unified SDK):

onError(error: SPError)