Load Ads

Creating Fullscreen Ads 🔗

The new Fullscreen APIs combine the existing Rewarded and Interstitial ad formats with the new Rewarded Interstitial ad format into a single integration experience. The older APIs have been marked deprecated, but are still functional until the 5.0.0 SDK release.

To show a Fullscreen ad, create a Fullscreen ad load request using the Placement Name you set up on your Chartboost platform.

• swift
• objective-c

• let request = ChartboostMediationAdLoadRequest(placement: "<placement>", keywords: <keywords>)
  Helium.shared().loadFullscreenAd(with: request) { result in
      if let ad = result.ad {
          // The ad is ready to show
      } else if let error = result.error {
          // Handle the error
      }
  }
  
  

• ChartboostMediationAdLoadRequest *request = [[ChartboostMediationAdLoadRequest alloc] initWithPlacement:@"<placement" keywords:<keywords>];
  [[Helium sharedHelium] loadFullscreenAdWithRequest:request completion:^(ChartboostMediationFullscreenAdLoadResult *result) {
      if (result.ad != nil) {
          // The ad is ready to show
      } else if (result.error != nil) {
          // Handle the error
      }
  }];
  

Banner Ads for SDK 4.6.0+ 🔗

Mediation SDK 4.6.0 introduces a new Adaptive Banner ad format, capable of serving flexible and fixed sized ads in the placement. The new Adaptive Banner ad format has the following features:

• Publishers can choose whether to use Adaptive Ads or Fixed Ads in a given placement.
• Fixed Ads are supported in Adaptive Ad placements (backwards compatible).
• Publishers should know whether an ad is fixed or flexible and receive the dimensions of fixed ads.
• Publishers can align the ad horizontally and/or vertically.
• Publishers can resize the ad container to fit the ad or optionally discard oversized ads that are rendered in the container.
• The ad container can be in-line or on top of publisher content.

To use this new ad format, Publishers will need to create a new Adaptive Banner placement in their platform and integrate with the new Adaptive Banner APIs.

Loading Banner ads 🔗

The API class ChartboostMediationBannerSize will support both fixed and adaptive banners:

• SWIFT

• let banner = ChartboostMediationBannerView()
  banner.delegate = self
  
  
  // Determine the max size of ad to load.
  let size = ChartboostMediationBannerSize.adaptive(width: <MAX_WIDTH>, maxHeight: <MAX_HEIGHT>)
  
  // Create a request with the size and your placement name.
  let request = ChartboostMediationBannerLoadRequest(
  placement: "<PLACEMENT_NAME>",
  size: size
  )
  
  // Load the banner ad.        
  banner.load(with: request, viewController: self) { [weak self] result in
  // Handle result
  }
  

Resizing Adaptive Banner Container 🔗

• SWIFT

• func willAppear(bannerView: ChartboostMediationBannerView) {
  // Manual layout
  bannerView.frame.size = bannerView.size?.size ?? .zero
  
  // The alignment of the ad can be changed if the frame of the bannerView is larger than the ad.
  bannerView.horizontalAlignment = .left
  bannerView.verticalAlignment = .top
  
      // Auto-layout will automatically resize the bannerView based on the set constraints.
  }
  

Banner Ads for SDK 4.5.x and prior 🔗

Creating Banner Ads 🔗

To show a banner ad, declare a variable to hold a reference to the Banner Mediation Ad and supply the corresponding Placement Name and Banner Size.

• swift
• objective-c

• var bannerAd: HeliumBannerView?
  

• @property (nonatomic) MediationBannerView *bannerAd;
  

• swift
• objective-c

• /*
       The following Banner enum Sizes can be passed down:
        .standard
        .medium
        .leaderboard
  */
  
  /// Mediation banner ad instance must be retained for the lifetime of the ad.
  var bannerAd: HeliumBannerView?
  
  if bannerAd == nil {
      let bannerSize = CHBHBannerSize.standard
      self.bannerAd = Helium.shared().bannerProvider(with: self, andPlacementName: "MY_BANNER_PLACEMENT", andSize: bannerSize)
  }
  

• /*
       The following Banner enum Sizes can be passed down:
        CHBHBannerSize_Standard
        CHBHBannerSize_Medium
        CHBHBannerSize_Leaderboard
  */
  
  /// Helium banner ad instance must be retained for the lifetime of the ad.
  @property (nonatomic, strong) HeliumBannerView *bannerAd;
  
  if (self.bannerAd == nil) {
    CHBHBannerSize bannerSize = CHBHBannerSize_Standard;
    self.bannerAd = [HeliumSdk.sharedHelium bannerProviderWithDelegate:self andPlacementName:@"MY_BANNER_PLACEMENT" andSize:bannerSize];
  }
  
  

Loading Banner Ads 🔗

To create an instance for each Placement Name you want to use make the following call to load the ad:

• swift
• objective-c

• if let bannerAd = bannerAd {
      bannerAd.load(with: viewControllerForModalContent)
  }
  
  

• if (self.bannerAd != nil) {
    [self.bannerAd loadAdWithViewController:viewControllerForModalContent];
  }
  

Clearing Loaded Ads 🔗

Clearing loaded ads may be necessary on existing placements to request another ad (i.e. for an in-house programmatic auction).

Clearing Interstitial and Rewarded Ads 🔗

• swift
• objective-c

• interstitialAd?.clearLoadedAd()
  rewardedAd?.clearLoadedAd()
  

• [self.interstitialAd clearLoadedAd];
  [self.rewardedAd clearLoadedAd];
  

Clearing Banner Ads 🔗

This will clear the currently displayed ad and any cached ad loaded for an auto refresh.

• swift
• objective-c

• bannerAd?.clear()
  

• [self.bannerAd clearAd];