MPBannerCustomEvent

@interface MPBannerCustomEvent : NSObject

The MoPub iOS SDK mediates third-party ad networks using custom events. The custom events are responsible for instantiating and manipulating objects in the third-party SDK and translating and communicating events from those objects back to the MoPub SDK by notifying a delegate.

MPBannerCustomEvent is a base class for custom events that support banners. By implementing subclasses of MPBannerCustomEvent you can enable the MoPub SDK to natively support a wide variety of third-party ad networks.

At runtime, the MoPub SDK will find and instantiate an MPBannerCustomEvent subclass as needed and invoke its -requestAdWithSize:customEventInfo: method.

Public Properties

Communicating with the MoPub SDK

/delegate

  • Description: The MPBannerCustomEventDelegate to send messages to as events occur. The delegate object defines several methods that you should call in order to inform both MoPub and your MPAdView‘s delegate of the progress of your custom event.

  • Declaration:

    @property (readwrite, nonatomic) id<MPBannerCustomEventDelegate> delegate;`
    
  • Parameters: None.

/localExtras

  • Description: An optional dictionary containing extra local data.

  • Declaration:

    @property (readwrite, copy, nonatomic) NSDictionary *localExtras;`
    
  • Parameters: None.

Public Methods

Requesting a Banner Ad

-/requestAdWithSize:customEventInfo:

  • Description: Called when the MoPub SDK requires a new banner ad. When the MoPub SDK receives a response indicating it should load a custom event, it will send this message to your custom event class. Your implementation of this method can either load a banner ad from a third-party ad network, or execute any application code. It must also notify the MPBannerCustomEventDelegate of certain lifecycle events.

  • Declaration:

    - (void)requestAdWithSize:(CGSize)size
            customEventInfo:(NSDictionary *)info;
    
  • Parameters:

    • size: The current size of the parent MPAdView. You should use this information to create and request a banner of the appropriate size.
    • info: A dictionary containing additional custom data associated with a given custom event request. This data is configurable on the MoPub website, and may be used to pass dynamic information, such as publisher IDs.

Callbacks

-/rotateToOrientation:

  • Description: Called when a banner rotation should occur. If you call -rotateToOrientation on an MPAdView, it will forward the message to its custom event. You can implement this method for third-party ad networks that have special behavior when orientation changes happen.

  • Declaration:

    - (void)rotateToOrientation:(UIInterfaceOrientation)newOrientation;`
    
  • Parameters:

-/didDisplayAd

Impression and Click Tracking

-/enableAutomaticImpressionAndClickTracking

  • Description: Override to opt out of automatic impression and click tracking. By default, the MPBannerCustomEventDelegate will automatically record impressions and clicks in response to the appropriate callbacks. You may override this behavior by implementing this method to return NO. Important: If you do this, you are responsible for calling the -trackImpression and -trackClick methods on the custom event delegate. Additionally, you should make sure that these methods are only called once per ad.

  • Declaration:

    - (BOOL)enableAutomaticImpressionAndClickTracking;`
    
  • Parameters: None.

Last updated February 11, 2020

TWITTER, MOPUB, and the Bird logo are trademarks of Twitter, Inc. or its affiliates. All third party logos and trademarks included are the property of their respective owners.

© 2020 MoPub (a division of Twitter, Inc.)