Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 6 Next »

Prerequisites

Step Summary

  1. Add the Initialization code for the SDK

  2. Register all the app UIViewControllers to the SDK

  3. Add the Tagged Wrappers, Tagged Buttons using the accessabilityLabel

  4. Note the Transitions

  5. Add the testing Single Data

  6. Test everything is working

  7. Change everything to production code

  8. Your app is now prepared for monetization with us.

Initialize the SDK

We require the SDK to be initialized only once and as early as possible,

The recommended place to initialize the SDK is the Initial UIViewController on viewDidLoad()

class ViewController: UIViewController {

    override func viewDidLoad() {
        super.viewDidLoad()
        
        R89SDK.shared.setLogLevel(level: LogLevels.debug)
        R89SDK.shared.setDebug()
        R89SDK.shared.initialize(publisherId: "TestRefinery89ID", 
                                appId: "TestConfigDemoApp", 
                                singleLine: true, 
                                publisherInitializationEvents: nil)
        
        R89SDK.shared.registerLifecycle(uiViewController: self)
    }
  }
}

Register all UIViewController’s

Then on every UIViewController viewDidLoad() add the following line.

class ViewController: UIViewController {
    override func viewDidLoad() {
        super.viewDidLoad()
        R89SDK.shared.registerLifecycle(uiViewController: self)
    }
  }
}

Tagged Wrappers

 Details for Tagged Wrapper

Tagged Wrappers

What are they?

The tagged wrapper is an iOS UIView with a requirement to have accessibilityLabel specified, either from the XCode UI builder or programmatically. This is used to find the views in the Single tag where you want us to add the monetization inventory. You need to add as many as you can, remember that placing a tagged wrapper does not mean we need to use it.

Example

As mentioned tag values can be specified via UIView’s accessibilityLabel parameter either from the XCode’s UI Builder or programmatically.

Set tag from UI builder (recommended)

Here is what it looks like in the UI Builder. Here we have a blue wrapper on top and a green one on the bottom. Accordingly, the top wrapper has specified to have a tag named top_wrapper_tag and the one in the bottom bottom_wrapper_tag.

Screenshot 2024-06-19 at 06.20.19-20240619-022050.pngScreenshot 2024-06-19 at 06.21.04-20240619-022124.png

That’s it! Ads will load automatically as soon as the view controller is displayed.

Do the step below only if the UIViewController’s lifecycle events automatic tracking is disabled.

In case, you have disabled the automatic lifecycle events tracking, you have to manually register the UIViewController’s lifecycle inside the viewDidLoad() method.

import UIKit
import R89SDK
class MainViewController: UIViewController {
    ...
    override func viewDidLoad() {
        super.viewDidLoad()
        ...
        // This line is necessary to inform R89SDK about app navigation.
        R89SDK.shared.trackUIViewControllerLifecycleEvents(uiViewController: self)
    }
    ...
}

Find more details about automatic lifecycle tracking in the iOS Screen Lifecycle Tracking section.

Set tag programmatically (alternative)

As an alternative approach, we can specify the accessibilityLabel using code, here is the equivalent setup but from the UIViewController.

import UIKit
import R89SDK

class MainViewController: UIViewController {
    
    @IBOutlet var topWrapperUIView:UIView!
    @IBOutlet var bottomWrapperUIView:UIView!
    ...
    override func viewDidLoad() {
        super.viewDidLoad()
        ...
        // Setting tags programmatically 
        topWrapperUIView.accessibilityLabel = "top_wrapper_tag"
        bottomWrapperUIView.accessibilityLabel = "bottom_wrapper_tag"
        // Uncommnet step below only if the UIViewController’s lifecycle events automatic tracking is disabled.
        // R89SDK.shared.trackUIViewControllerLifecycleEvents(uiViewController: self)
    }
    ...
}

Where to add the wrappers?

Everywhere you have a white space. Tagged wrappers don’t need to contain ads, it's just for flexibility and future-proofing. Indeed, overloading your app with ads is not the best user experience, but the wrappers don’t need to be filled with ads, that’s why we recommend you add the wrappers everywhere where there is a blank space on the screen. Even if you do not want to fill them in.

We can manage which ones are and are not filled from the web interface.

Best practices when adding a wrapper

For Creating the wrappers you need to ensure the wrapper view:

  • Do not overlap other wrappers on the app content, no matter the size it takes. if it is a space that you have a max Size to it, put it in the tag name.

  • Every blank space is a good space for a wrapper (even if you do not plan to use it).

  • Do not use only one tag for all of your wrappers, it will be hard to configure your monetization and change it according to your needs. So use as many different tags as possible (like id’s but you can have some of them repeated when it makes sense).

  • Use a blank (no subviews) UIView as the wrapper view.

Limitations

We can fill either all of the wrappers with a tag or just the first one we find with that tag: if you want to differentiate any wrappers you need to assign a different tag to those. E.g.: if you want us to fill a wrapper at the bottom of the screen that has the tag ads_wrapper we can fill that. However, if you have multiple wrappers with the same tag, and you want to fill all of them and exclude some while having the same tag, it’s not possible. We encourage you to ask for advice to our technical support on how to group wrappers.

  • No labels