Nimbus Manual Requesting/Rendering

The manual request/render flow can be implemented if you want to request an ad to be shown at a later time.

We highly recommend the use of our Nimbus Dynamic Unit which simplifies the process of requesting and rendering ads.

Initialize Nimbus SDK

Please follow the integration guide to initialize the SDK and the renderers as necessary.

Requesting

Make a request

Android

val adManager = NimbusAdManager()
adManager.makeRequest(
    context = requireContext(),
    request = NimbusRequest.forBannerAd(item, Format.BANNER_320_50, Position.HEADER),
    listener = object : RequestManager.Listener {
       override fun onAdResponse(nimbusResponse: NimbusResponse) {
          // Request completed with the given `nimbusResponse`                   
       }

       override fun onError(error: NimbusError) {
          // Nimbus request failed due to an error or no bid
       }
   })

iOS

let requestManager = NimbusRequestManager()
requestManager.delegate = self
requestManager.performRequest(
   request: NimbusRequest.forBannerAd(
      position: "position", 
      format: .banner320x50, 
      adPosition: .header
   )
)

extension MyClass: NimbusRequestManagerDelegate {
   func didCompleteNimbusRequest(request: NimbusRequest, ad: NimbusAd) {
      // Request completed with the given ad
   }
   
   func didFailNimbusRequest(request: NimbusRequest, error: NimbusError) {
      // Nimbus request failed due to an error or no bid
   }
}

Rendering

Follow the steps below to render an ad with the given NimbusAd/NimbusResponse.

Android

Renderer.loadAd(
    nimbusResponse,
    adFrame,
    object : Renderer.Listener, NimbusError.Listener {
        override fun onAdRendered(controller: AdController) {
           controller.listeners.add(
                object : AdController.Listener {
                    override fun onAdEvent(adEvent: AdEvent) {
                        TODO("Receive events like `loaded`, `impression`, `clicked`")
                    }
    
                    override fun onError(error: NimbusError) {
                        TODO("Errors thrown after the ad has been rendered")
                    }
                }
            )
        }

        override fun onError(error: NimbusError) {
            Timber.e("Ad rendering failed")
        }
    }
)

iOS

// Create a NimbusAdView
let adView = NimbusAdView(adPresentingViewController: self)
adView.delegate = self

// container: UIView
container.addSubview(adView)

adView.translatesAutoresizingMaskIntoConstraints = false
NSLayoutConstraint.activate([
  adView.leadingAnchor.constraint(equalTo: container.leadingAnchor),
  adView.trailingAnchor.constraint(equalTo: container.trailingAnchor),
  adView.topAnchor.constraint(equalTo: container.topAnchor),
  adView.bottomAnchor.constraint(equalTo: container.bottomAnchor)
])

// Render an ad
adView.delegate = self
adView.render(ad: ad)

// When ready to start the ad
adView.start()

// To stop / pause the ad
adView.stop()

// To destroy the ad when don
adView.destroy()

// Listen for events
extension MyClass: AdControllerDelegate {
    func didReceiveNimbusEvent(controller: AdController, event: NimbusEvent) {
    	// Receive events like `loaded`, `impression`, `clicked`
    }

    /// Received an error for the ad
    func didReceiveNimbusError(controller: AdController, error: NimbusError) {
    	// Errors thrown related to ad rendering
    }
}

SKOverlay

To enable SKOverlay for ad units integrated this way, you can set NimbusAdView.showsSKOverlay. This allows more control over if the overlay shows up for each ad unit.

let adView: NimbusAdView
adView.showsSKOverlay = true

To enable SKOverlay for all units globally, set Nimbus.shared.isSKOverlayEnabledForAllUnits.

Nimbus.shared.isSKOverlayEnabledForAllUnits = true

Caution: Please note that the setting these fields will show the overlay regardless of whether the ad is a banner or interstitial.