July 06, 2023 11:17

Delegate Protocols

Global Ad Delegate Protocol

Implement the IAGlobalAdDelegate methods to receive the global SDK callback(s).

Assigning the Delegate Implementor

To assign the delegate implementor use the following:

IASDKCore.sharedInstance.globalAdDelegate = <implementor>;

IASDKCore.sharedInstance.globalAdDelegate = self;

Impression Level Data

Implementing the Unit Delegate Methods

Important

IAParentViewControllerForUnitController:unitController is a required delegate method.
When an ad transits to full-sreen, IASDK will need to get a "parent" view controller, and this method will be invoked. If it is not implemented, the app will crash with an exception, intentionally, to show that there is a required method implementation is missing.

This delegate method is required to get a client-side view controller to present modal views, such as in-app browser, storekit controller, MRAID expand, etc. In this method, a desired view controller should be returned by the client side. In most cases it will be the same view controller that presents an ad.

Parent View Controller

IAParentViewControllerForUnitController:
Parent view controller evaluation from a publisher, in order to render ads in full-screen / modal mode.
Example:

- (UIViewController * _Nonnull)IAParentViewControllerForUnitController:(IAUnitController * _Nullable)unitController {
  return self; // in case 'self' is a UIViewController subclass;
}

All other delegate methods of this protocol (interface) are optional.

User Click

IAAdDidReceiveClick:
This method will be invoked when user clicks an ad:

- (void)IAAdDidReceiveClick:(IAUnitController * _Nullable)unitController {
  NSLog(@"ad did click");
}

Ad Impression

IAAdWillLogImpression:
This method will be invoked when ad is rendered and visible:

- (void)IAAdWillLogImpression:(IAUnitController * _Nullable)unitController {
  NSLog(@"ad impression");
}

Future Fullscreen Transition Notification

IAUnitControllerWillPresentFullscreen:
This means that the transition to fullscreen mode will be performed.

- (void)IAUnitControllerWillPresentFullscreen:(IAUnitController * _Nullable)unitController {
  NSLog(@"ad will present fullscreen");
}

Notification of Performed Fullscreen Transition

IAUnitControllerDidPresentFullscreen:
This means the transition to fullscreen already performed.

- (void)IAUnitControllerDidPresentFullscreen:(IAUnitController * _Nullable)unitController {
  NSLog(@"ad did present fullscreen");
}

Future Transition from Fullscreen Notification

IAUnitControllerWillDismissFullscreen:
This means that the transition from fullscreen mode will happen.

(void)IAUnitControllerWillDismissFullscreen:(IAUnitController * _Nullable)unitController {
  NSLog(@"ad will dismiss fullscreen");
}

Notification of Performed Transition from Fullscreen Mode

IAUnitControllerDidDismissFullscreen:
This means that the transition from fullscreen mode already performed.

(void)IAUnitControllerDidDismissFullscreen:(IAUnitController *_Nullable)unitController {
  NSLog(@"ad did dismiss fullscreen");
}

Opening an External App Notification

IAUnitControllerWillOpenExternalApp:
This is a notification that your app will move to the background, and an external app such as Safari, the App Store, or a Universal link-supported app will open.

(void)IAUnitControllerWillOpenExternalApp:(IAUnitController *_Nullable)unitController {
  NSLog(@"ad will open external app");
}

Implementing Video Content Delegate Methods

All video delegate methods are optional.

Video Completion Event

IAVideoCompleted:
This is invoked on video completion.

- (void)IAVideoCompleted:(IAVideoContentController * _Nullable)contentController {
  NSLog(@"video completed");
}

Interruption Event

videoInterruptedWithError:
If a video started to play (which means the ad was already received), but the buffer became empty for some reason, and it didn't refill.

- (void)IAVideoContentController:(IAVideoContentController * _Nullable)contentController videoInterruptedWithError:(NSError * _Nonnull)error {
  NSLog(@"video interrupted");
}

Video Duration Received

videoDurationUpdated:

(void)IAVideoContentController:(IAVideoContentController * _Nullable)contentController videoDurationUpdated:(NSTimeInterval)videoDuration {
  NSLog(@"video duration updated");
}

Progress Tracking

videoProgressUpdatedWithCurrentTime:totalTime:
The delegate method is invoked each time the video has played after a certain amount of milliseconds of the video.

(void)IAVideoContentController:(IAVideoContentController *_Nullable)contentController videoProgressUpdatedWithCurrentTime:(NSTimeInterval)currentTime totalTime:(NSTimeInterval)totalTime {
  NSLog(@"video progress updated");
}

Implementing the MRAID Content Delegate Methods

All HTML / MRAID delegate methods are optional.

MRAID Resize Event (Future)

MRAIDAdWillResizeToFrame:
This will be in invoked on MRAID Resize command, before the ad transformation.

- (void)IAMRAIDContentController:(IAMRAIDContentController * _Nullable)contentController MRAIDAdWillResizeToFrame:(CGRect)frame {
    NSLog(@"MRAIDAdWillResizeToFrame");
    self.isMRAIDResize = YES; // a way to distinct in 'collapse', whether was resize or expand;
    
    if (!self.adView.translatesAutoresizingMaskIntoConstraints) { // a way to distinct the work with constraints;
        // ok, we are working with constraints, if so -> it is publisher responsibility to treat MRAID:RESIZE:
        //
        // 1. remove existing constraints from adView (in this method);
        // 2. set new constraints, satisfying the received frame ('MRAIDAdDidResizeToFrame' method);
        //
        // note: that if you are not working with constraints, the adView will treat all the needed sizes, but you will need to setup other UI in current view controller, according to adView's new frame;
        // note: MRAID:EXPAND is MODAL, so no need to implement the same work;
        [self.adView removeFromSuperview]; // remove self.view <--> adView constraints;
    }
  
  // the rest of work is implemented inside the 'MRAIDAdDidResizeToFrame:' method;
}

MRAID Resize Event (Happened)

MRAIDAdDidResizeToFrame:
This will be in invoked on MRAID Resize completion.

- (void)IAMRAIDContentController:(IAMRAIDContentController * _Nullable)contentController MRAIDAdDidResizeToFrame:(CGRect)frame {
    NSLog(@"MRAIDAdDidResizeToFrame");
    
    // means we are working with constraints;
    if (!self.adView.translatesAutoresizingMaskIntoConstraints) {
        [self.viewUnitController showAdInParentView:self.view]; // add once again to view, because was removed previously in order to remove constraints;
        
        // if so, it is on publisher responsibility to set up a new consrtraints:
        [self.view addConstraint:
         [NSLayoutConstraint constraintWithItem:self.adView
                                      attribute:NSLayoutAttributeLeading
                                      relatedBy:NSLayoutRelationEqual
                                         toItem:self.view
                                      attribute:NSLayoutAttributeLeading
                                     multiplier:1
                                       constant:frame.origin.x]];
        
        [self.view addConstraint:
         [NSLayoutConstraint constraintWithItem:self.adView
                                      attribute:NSLayoutAttributeTop
                                      relatedBy:NSLayoutRelationEqual
                                         toItem:self.view
                                      attribute:NSLayoutAttributeTop
                                     multiplier:1
                                       constant:frame.origin.y]];
        
        [self.view addConstraint:
         [NSLayoutConstraint constraintWithItem:self.adView
                                      attribute:NSLayoutAttributeWidth
                                      relatedBy:NSLayoutRelationEqual
                                         toItem:nil
                                      attribute:NSLayoutAttributeWidth
                                     multiplier:1
                                       constant:frame.size.width]];
        
        [self.view addConstraint:
         [NSLayoutConstraint constraintWithItem:self.adView
                                      attribute:NSLayoutAttributeHeight
                                      relatedBy:NSLayoutRelationEqual
                                         toItem:nil
                                      attribute:NSLayoutAttributeHeight
                                     multiplier:1
                                       constant:frame.size.height]];
    } else {
        // working with 'frame',
        // set up your UI according to adView's new frame;
    }
}

MRAID Expand Event (Future)

MRAIDAdWillExpandToFrame:
This will be in invoked on MRAID Expand command, before the ad transformation.

- (void)IAMRAIDContentController:(IAMRAIDContentController * _Nullable)contentController MRAIDAdWillExpandToFrame:(CGRect)frame {
    NSLog(@"MRAIDAdWillExpandToFrame");
    
    self.isMRAIDResize = NO; // add this boolean flag to properties, in order to distinct whether 'collapse' event (when it will be invoked) is after 'resize' or after 'expand';
}

MRAID Expand Event (Happened)

MRAIDAdDidExpandToFrame:
This will be in invoked on MRAID Expand completion event.

- (void)IAMRAIDContentController:(IAMRAIDContentController * _Nullable)contentController MRAIDAdDidExpandToFrame:(CGRect)frame {
    NSLog(@"MRAIDAdDidExpandToFrame");
}

MRAID Collapse Event (Future)

IAMRAIDContentControllerMRAIDAdWillCollapse:
This will be in invoked on MRAID Collapse command, before the ad transformation.

NSLog(@"IAMRAIDContentControllerMRAIDAdWillCollapse");
    
    // if we are working with constraints AND there was resize before (not expand):
    if (!self.adView.translatesAutoresizingMaskIntoConstraints && self.isMRAIDResize) {
        // the same as in 'MRAIDAdWillResizeToFrame';
        [self.adView removeFromSuperview];
    }

MRAID Collapse Event (Happened)

IAMRAIDContentControllerMRAIDAdDidCollapse:
This will be in invoked on MRAID Collapse completion.

- (void)IAMRAIDContentControllerMRAIDAdDidCollapse:(IAMRAIDContentController * _Nullable)contentController {
    NSLog(@"IAMRAIDContentControllerMRAIDAdDidCollapse");
    
    // if we are working with constraints AND there was resize before (not expand):
    if (!self.adView.translatesAutoresizingMaskIntoConstraints && self.isMRAIDResize) {
        // restore everything as it was before resize (in case it is resize):
        [self.viewUnitController showAdInParentView:self.view];
        
        // adding centerX constraint
        [self.view addConstraint:
         [NSLayoutConstraint constraintWithItem:self.adView
                                      attribute:NSLayoutAttributeCenterX
                                      relatedBy:NSLayoutRelationEqual
                                         toItem:self.view
                                      attribute:NSLayoutAttributeCenterX
                                     multiplier:1
                                       constant:0]];
        
        // adding top constraint
        [self.view addConstraint:
         [NSLayoutConstraint constraintWithItem:self.adView
                                      attribute:NSLayoutAttributeTop
                                      relatedBy:NSLayoutRelationEqual
                                         toItem:self.view
                                      attribute:NSLayoutAttributeTop
                                     multiplier:1
                                       constant:0]];
    }
}

Back to Top ⇧