IDX Data Manager Provider for iOS

This guide provides detailed instructions for integrating and using the IDX Data Manager Provider SDK in your iOS applications.

This SDK is designed to automatically add user audiences (targeting parameters) to ad requests. There are two approaches for audience calculation - native and via WebView connector.

1. The native approach is suitable when you display your content directly in the mobile application and know the required targeting parameters such as title, description, author, and others.

2. The WebView connector helps when you display your content inside a WebView and your content resides on a web page. In this case, the content data will be automatically processed by the Web SDK (which must be installed on the page you want to display in the WebView) and passed to the DMPWebViewConnector. This way, you can use this data on the native side of your application.

Table of Contents

• Requirements
• Installation
• App configuration
• Integration with DataManagerProvider
• Integration with DMPWebViewConnector
• Author
• Support
• License

Requirements

To integrate this SDK into your project, you need:

• Swift 5.7+
• iOS 12.0+
• Valid ProviderId from IDX

Installation

Idx Data Manager Provider is available through CocoaPods. Add the following line to your Podfile:

pod 'IdxDmp'

App configuration

Add these keys to your Info.plist file:

<key>NSUserTrackingUsageDescription</key>
<string>It makes our adwords more compatibility with your interests</string>

<key>NSLocationWhenInUseUsageDescription</key>
<string>It makes our adwords more compatibility with your location</string>

Integration with DataManagerProvider

To use the SDK in your native app, create a DataManagerProvider instance with your ProviderId (obtained from IDX). You must also specify your app name and version.

The SDK initializes asynchronously. While you can wait for the completion callback, you can immediately use other SDK methods. In this case, audience calculations will be based on previous data.

Audiences are calculated based on Page View events, which you can send when needed (e.g., when a user opens a new article). You control what data to include in each event.

The SDK returns an object containing the generated userId and collected audiences. To get targeted ads based on this data, set these parameters in your Google ad request.

For integration testing:

• Handle errors in SDK initialization and event callbacks
• The object returned by getCustomAdTargeting should always contain data
• The dxseg key may be empty if no audiences matched, but userId will always be populated

class ViewController: UIViewController {
    var dmp: DataManagerProvider?

    ...

    override func viewDidLoad() {
        super.viewDidLoad()

        self.dmp = DataManagerProvider(providerId: "Your Provider ID goes here", appName: "My app name", appVersion: "1.0.0") {error in
          // Complete callback
        }
    }

    ...

    override func viewWillAppear(_ animated: Bool) {
        super.viewWillAppear(animated)

        let requestProps = EventRequestPropertiesStruct(
            url: ("/examplePage"); // Replace with the specific page URL or identifier
            title: ("Example Page Title"); // Replace with the specific page title
            domain: ("your-domain.com"); // Replace with your domain
            author: ("author"); // Replace with the author of the page
            category: ("category"); // Replace with the category of the page
            description: ("This is an example page."); // Replace with the description of the page
            tags: ["tag1", "tag2", "tag3"] // Replace with the tags related to the page
        )

        self.dmp?.sendEvent(properties: requestProps) { error in
            // Complete callback
        }
    }

    ...

    @IBAction func handleShowAd() {
        guard let dmp = self.dmp else {
            return
        }

        let adRequest: GAMRequest = GAMRequest()
        adRequest.customTargeting = dmp.getCustomAdTargeting()
    }

    ...
}

Integration with DMPWebViewConnector

If your app uses WebView to display content but you want to request ads natively, use DMPWebViewConnector. Initialize it with:

• The userContentController from your WKWebView (which must have our web SDK installed)
• Your app name and version

The connector automatically listens to events from the web page and provides access to audiences calculated by the web SDK. Subsequent integration is identical to DataManagerProvider.

If you have multiple webviews, you need to create a separate DMPWebViewConnector for each of them. DMPWebViewConnector is just a small bridge, so it has practically no overhead.

class ViewController: UIViewController {
    var dmpWebViewConnector1: DMPWebViewConnector?
    var dmpWebViewConnector2: DMPWebViewConnector?

    ...

    override func viewDidLoad() {
        super.viewDidLoad()
        // You have to set your WKWebView instance
        dmpWebViewConnector1 = DMPWebViewConnector(yourWebView1.configuration.userContentController, "My app name", "1.0.0")
        dmpWebViewConnector2 = DMPWebViewConnector(yourWebView2.configuration.userContentController, "My app name", "1.0.0")
    }

    ...

    @IBAction func handleShowAd() {
        guard let connector1 = self.dmpWebViewConnector1 else {
            return
        }

        let adRequest: GAMRequest = GAMRequest()
        adRequest.customTargeting = connector1.getCustomAdTargeting()

        guard let connector2 = self.dmpWebViewConnector2 else {
            return
        }

        let adRequest: GAMRequest = GAMRequest()
        adRequest.customTargeting = connector2.getCustomAdTargeting()
    }

    ...
}

Author

IDX LTD, https://www.id-x.co.il/

Support

For support, report issues in the issue tracker or reach out through our designated support channels

License

IdxDmp is available under the MIT license. See the LICENSE file for more info.