GADCustomEventBanner.h 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. //
  2. // GADCustomEventBanner.h
  3. // Google Mobile Ads SDK
  4. //
  5. // Copyright 2012 Google Inc. All rights reserved.
  6. //
  7. #import <UIKit/UIKit.h>
  8. #import "GADAdSize.h"
  9. #import "GADCustomEventBannerDelegate.h"
  10. #import "GADCustomEventRequest.h"
  11. /// The protocol for a Custom Event of the banner type. Your Custom Event handler object for banners
  12. /// must implement this protocol. The requestBannerAd method will be called when mediation schedules
  13. /// your Custom Event to be executed.
  14. @protocol GADCustomEventBanner<NSObject>
  15. /// This method is called by mediation when your Custom Event is scheduled to be executed. Results
  16. /// of the execution should be reported back via the delegate. |adSize| is the size of the ad as
  17. /// configured in the mediation UI for the mediation placement. |serverParameter| and |serverLabel|
  18. /// are the parameter and label configured in the mediation UI for the Custom Event. |request|
  19. /// contains information about the ad request, some of those are from GADRequest.
  20. - (void)requestBannerAd:(GADAdSize)adSize
  21. parameter:(NSString *)serverParameter
  22. label:(NSString *)serverLabel
  23. request:(GADCustomEventRequest *)request;
  24. /// You should call back to the |delegate| with the results of the execution to ensure mediation
  25. /// behaves correctly. The delegate is weakly referenced to prevent memory leaks caused by circular
  26. /// retention.
  27. ///
  28. /// Define the -delegate and -setDelegate: methods in your class.
  29. ///
  30. /// In your class's -dealloc method, remember to nil out the delegate.
  31. @property(nonatomic, weak) id<GADCustomEventBannerDelegate> delegate;
  32. @end