GoogleMobileAds Framework Reference

Protocols

The following protocols are available globally.

  • The DFPCustomRenderedAd banner view delegate protocol for notifying the delegate of changes to custom rendered banners.

    Declaration

    Objective-C

    @protocol DFPCustomRenderedBannerViewDelegate <NSObject>

  • The DFPCustomRenderedAd interstitial delegate protocol for notifying the delegate of changes to custom rendered interstitials.

    Declaration

    Objective-C

    @protocol DFPCustomRenderedInterstitialDelegate <NSObject>

  • Base ad loader delegate protocol. Ad types provide extended protocols that declare methods to handle successful ad loads.

    Declaration

    Objective-C

    @protocol GADAdLoaderDelegate <NSObject>

  • An object implementing this protocol contains information set by the publisher on the client device for a particular ad network.

    Ad networks should create an ‘extras’ object implementing this protocol for their publishers to use.

    Declaration

    Objective-C

    @protocol GADAdNetworkExtras <NSObject>

  • The class implementing this protocol will be notified when the GADBannerView’s ad content changes size. Any views that may be affected by the banner size change will have time to adjust.

    Declaration

    Objective-C

    @protocol GADAdSizeDelegate <NSObject>

  • Implement your app event within these methods. The delegate will be notified when the SDK receives an app event message from the ad.

    Declaration

    Objective-C

    @protocol GADAppEventDelegate <NSObject>

  • A set of methods to inform the delegate of audio video manager events.

    Declaration

    Objective-C

    @protocol GADAudioVideoManagerDelegate <NSObject>

  • Delegate methods for receiving GADBannerView state change messages such as ad request status and ad click lifecycle.

    Declaration

    Objective-C

    @protocol GADBannerViewDelegate <NSObject>

  • The banner custom event protocol. Your banner custom event handler must implement this protocol.

    Declaration

    Objective-C

    @protocol GADCustomEventBanner <NSObject>

  • Call back to this delegate in your custom event. You must call customEventBanner:didReceiveAd: when there is an ad to show, or customEventBanner:didFailAd: when there is no ad to show. Otherwise, if enough time passed (several seconds) after the SDK called the requestBannerAd: method of your custom event, the mediation SDK will consider the request timed out, and move on to the next ad network.

    Declaration

    Objective-C

    @protocol GADCustomEventBannerDelegate <NSObject>

  • The interstitial custom event protocol. Your interstitial custom event handler must implement this protocol.

    Declaration

    Objective-C

    @protocol GADCustomEventInterstitial <NSObject>

  • Call back to this delegate in your custom event. You must call customEventInterstitialDidReceiveAd: when there is an ad to show, or customEventInterstitial:didFailAd: when there is no ad to show. Otherwise, if enough time passed (several seconds) after the SDK called the requestInterstitialAdWithParameter: method of your custom event, the mediation SDK will consider the request timed out, and move on to the next ad network.

    Declaration

    Objective-C

    @protocol GADCustomEventInterstitialDelegate <NSObject>

  • Native ad custom event protocol. Your native ad custom event handler class must conform to this protocol.

    Declaration

    Objective-C

    @protocol GADCustomEventNativeAd <NSObject>

  • The delegate of the GADCustomEventNativeAd object must adopt the GADCustomEventNativeAdDelegate protocol. Methods in this protocol are used for native ad’s custom event communication with the Google Mobile Ads SDK.

    Declaration

    Objective-C

    @protocol GADCustomEventNativeAdDelegate <NSObject>

Default Purchase Flow

  • In-app purchase delegate protocol for default purchase handling. The delegate must deliver the purchased item then call the GADDefaultInAppPurchase object’s finishTransaction method.

    Declaration

    Objective-C

    @protocol GADDefaultInAppPurchaseDelegate <NSObject>

Custom Purchase Flow

  • In-app purchase delegate protocol for custom purchase handling. The delegate must handle the product purchase flow then call the GADInAppPurchase object’s reportPurchaseStatus: method.

    Declaration

    Objective-C

    @protocol GADInAppPurchaseDelegate <NSObject>

  • Delegate for receiving state change messages from a GADInterstitial such as interstitial ad requests succeeding/failing.

    Declaration

    Objective-C

    @protocol GADInterstitialDelegate <NSObject>

  • Identifies native ad assets.

    Declaration

    Objective-C

    @protocol GADNativeAdDelegate <NSObject>

Protocol and constants

Protocol and constants

Loading Protocol

  • Delegate methods for receiving GADNativeExpressAdView state change messages such as ad request status and ad click lifecycle.

    Declaration

    Objective-C

    @protocol GADNativeExpressAdViewDelegate <NSObject>

  • Delegate for receiving state change messages from a GADRewardBasedVideoAd such as ad requests succeeding/failing.

    Declaration

    Objective-C

    @protocol GADRewardBasedVideoAdDelegate <NSObject>

  • Delegate for receiving state change messages from a GADRewardedAd.

    Declaration

    Objective-C

    @protocol GADRewardedAdDelegate <NSObject>

  • Delegate for receiving metadata change messages from a GADRewardedAd.

    Declaration

    Objective-C

    @protocol GADRewardedAdMetadataDelegate <NSObject>

Protocol and constants

  • The GADVideoControllerDelegate protocol defines methods that are called by the video controller object in response to the video events that occurred throughout the lifetime of the video rendered by an ad.

    Declaration

    Objective-C

    @protocol GADVideoControllerDelegate <NSObject>

  • Ad network adapter protocol.

    Declaration

    Objective-C

    @protocol GADMAdNetworkAdapter <NSObject>

  • Ad network adapters interact with the mediation SDK using an object that implements the GADMAdNetworkConnector protocol. The connector object can be used to obtain necessary information for ad requests, and to call back to the mediation SDK on ad request returns and user interactions.

    Declaration

    Objective-C

    @protocol GADMAdNetworkConnector <GADMediationAdRequest>

  • Your adapter must conform to this protocol to provide reward based video ads.

    Declaration

    Objective-C

    @protocol GADMRewardBasedVideoAdNetworkAdapter <NSObject>

  • Reward based video ad network adapters interact with the mediation SDK using an object that conforms to the GADMRewardBasedVideoAdNetworkConnector protocol. The connector object can be used to obtain information for ad requests and to call back to the mediation SDK on ad responses and user interactions.

    Declaration

    Objective-C

    @protocol GADMRewardBasedVideoAdNetworkConnector <GADMediationAdRequest>

  • Base protocol for mediated native ads.

    Declaration

    Objective-C

    @protocol GADMediatedNativeAd <NSObject>

  • GADMediatedNativeAdDelegate objects handle mediated native ad events.

    Declaration

    Objective-C

    @protocol GADMediatedNativeAdDelegate <NSObject>

  • Provides methods used for constructing native app install ads. The adapter must return an object conforming to this protocol for native app install ad requests.

    Declaration

    Objective-C

    @protocol GADMediatedNativeAppInstallAd <GADMediatedNativeAd>

  • Provides methods used for constructing native ads. The adapter must return an object conforming to this protocol for native ad requests.

    Declaration

    Objective-C

    @protocol GADMediatedUnifiedNativeAd <NSObject>

  • Rendered ad. Objects conforming to this protocol are created by the adapter and returned to the Google Mobile Ads SDK via the adapter’s render method completion handler.

    Declaration

    Objective-C

    @protocol GADMediationAd <NSObject>

  • Provides information which can be used for making ad requests during mediation.

    Declaration

    Objective-C

    @protocol GADMediationAdRequest <NSObject>

  • Receives messages and requests from the Google Mobile Ads SDK. Provides GMA to 3P SDK communication.

    Adapters are initialized on a background queue and should avoid using the main queue until load time.

    Declaration

    Objective-C

    @protocol GADMediationAdapter <NSObject>

  • Rendered banner ad. Provides a single subview to add to the banner view’s view hierarchy.

    Declaration

    Objective-C

    @protocol GADMediationBannerAd <GADMediationAd>

  • Adapter that provides signals to the Google Mobile Ads SDK to be included in an OpenRTB auction.

    Declaration

    Objective-C

    @protocol GADRTBAdapter <GADMediationAdapter>