必要條件
完成自訂事件設定。
請求橫幅廣告
當自訂事件委刊項在刊登序列中介服務鏈內時,系統會使用您在建立自訂事件時提供的類別名稱呼叫the loadBanner:adConfiguration:completionHandler:
method 。在這種情況下,該方法位於 SampleCustomEvent
中,然後會在 SampleCustomEventBanner
中呼叫the loadBanner:adConfiguration:completionHandler:
method 。
若要請求橫幅廣告,請建立或修改導入 GADMediationAdapter
和 loadBanner:adConfiguration:completionHandler:
的類別。如果已有擴充 GADMediationAdapter
的類別,請在該類別中實作 loadBanner:adConfiguration:completionHandler:
。此外,請建立新類別來實作 GADMediationBannerAd
。
在自訂事件範例中,SampleCustomEvent
會實作the GADMediationAdapter
interface ,然後委派給SampleCustomEventBanner
。
Swift
import GoogleMobileAds class SampleCustomEvent: NSObject, GADMediationAdapter { fileprivate var bannerAd: SampleCustomEventBanner? ... func loadBanner( for adConfiguration: GADMediationBannerAdConfiguration, completionHandler: @escaping GADMediationBannerLoadCompletionHandler ) { self.bannerAd = SampleCustomEventBanner() self.bannerAd?.loadBanner( for: adConfiguration, completionHandler: completionHandler) } }
Objective-C
#import "SampleCustomEvent.h" @implementation SampleCustomEvent ... SampleCustomEventBanner *sampleBanner; - (void)loadBannerForAdConfiguration: (GADMediationBannerAdConfiguration *)adConfiguration completionHandler:(GADMediationBannerLoadCompletionHandler) completionHandler { sampleBanner = [[SampleCustomEventBanner alloc] init]; [sampleBanner loadBannerForAdConfiguration:adConfiguration completionHandler:completionHandler]; }
SampleCustomEventBanner
負責執行下列工作:
載入橫幅廣告及叫用
GADMediationBannerLoadCompletionHandler
method 後導入
GADMediationBannerAd
protocol接收 Google Mobile Ads SDK 並回報廣告事件回呼
AdMob UI 中定義的選用參數會做為 the loadBanner:adConfiguration:completionHandler:
method的一部分傳遞至自訂事件。您可以透過 adConfiguration.credentials.settings[@"parameter"]
存取這個參數。這個參數通常是廣告聯播網 SDK 在執行個體化物件時所需的廣告單元 ID。
Swift
class SampleCustomEventBanner: NSObject, GADMediationBannerAd { /// The Sample Ad Network banner ad. var bannerAd: SampleBanner? /// The ad event delegate to forward ad rendering events to the Google Mobile Ads SDK. var delegate: GADMediationBannerAdEventDelegate? /// Completion handler called after ad load var completionHandler: GADMediationBannerLoadCompletionHandler? func loadBanner( for adConfiguration: GADMediationBannerAdConfiguration, completionHandler: @escaping GADMediationBannerLoadCompletionHandler ) { // Create the bannerView with the appropriate size. let adSize = adConfiguration.adSize bannerAd = SampleBanner( frame: CGRect(x: 0, y: 0, width: adSize.size.width, height: adSize.size.height)) bannerAd?.delegate = self bannerAd?.adUnit = adConfiguration.credentials.settings["parameter"] as? String let adRequest = SampleAdRequest() adRequest.testMode = adConfiguration.isTestRequest self.completionHandler = completionHandler bannerAd?.fetchAd(adRequest) } }
Objective-C
#import "SampleCustomEventBanner.h" @interface SampleCustomEventBanner () <SampleBannerAdDelegate, GADMediationBannerAd> { /// The sample banner ad. SampleBanner *_bannerAd; /// The completion handler to call when the ad loading succeeds or fails. GADMediationBannerLoadCompletionHandler _loadCompletionHandler; /// The ad event delegate to forward ad rendering events to the Google Mobile /// Ads SDK. id <GADMediationBannerAdEventDelegate> _adEventDelegate; } @end @implementation SampleCustomEventBanner - (void)loadBannerForAdConfiguration: (GADMediationBannerAdConfiguration *)adConfiguration completionHandler:(GADMediationBannerLoadCompletionHandler) completionHandler { __block atomic_flag completionHandlerCalled = ATOMIC_FLAG_INIT; __block GADMediationBannerLoadCompletionHandler originalCompletionHandler = [completionHandler copy]; _loadCompletionHandler = ^id<GADMediationBannerAdEventDelegate>( _Nullable id<GADMediationBannerAd> ad, NSError *_Nullable error) { // Only allow completion handler to be called once. if (atomic_flag_test_and_set(&completionHandlerCalled)) { return nil; } id<GADMediationBannerAdEventDelegate> delegate = nil; if (originalCompletionHandler) { // Call original handler and hold on to its return value. delegate = originalCompletionHandler(ad, error); } // Release reference to handler. Objects retained by the handler will also // be released. originalCompletionHandler = nil; return delegate; }; NSString *adUnit = adConfiguration.credentials.settings[@"parameter"]; _bannerAd = [[SampleBanner alloc] initWithFrame:CGRectMake(0, 0, adConfiguration.adSize.size.width, adConfiguration.adSize.size.height)]; _bannerAd.adUnit = adUnit; _bannerAd.delegate = self; SampleAdRequest *adRequest = [[SampleAdRequest alloc] init]; adRequest.testMode = adConfiguration.isTestRequest; [_bannerAd fetchAd:adRequest]; }
無論廣告成功擷取或發生錯誤,都會呼叫 GADMediationBannerLoadCompletionHandler
。如果成功發生,請傳遞實作 GADMediationBannerAd
(且為錯誤參數的 nil
值) 的類別;如果發生失敗,請傳遞遇到的錯誤。
一般而言,這些方法會在轉接程式實作的第三方 SDK 回呼內實作。在這個範例中,範例 SDK 的 SampleBannerAdDelegate
具有相關回呼:
Swift
func bannerDidLoad(_ banner: SampleBanner) { if let handler = completionHandler { delegate = handler(self, nil) } } func banner( _ banner: SampleBanner, didFailToLoadAdWith errorCode: SampleErrorCode ) { let error = SampleCustomEventUtilsSwift.SampleCustomEventErrorWithCodeAndDescription( code: SampleCustomEventErrorCodeSwift .SampleCustomEventErrorAdLoadFailureCallback, description: "Sample SDK returned an ad load failure callback with error code: \(errorCode)" ) if let handler = completionHandler { delegate = handler(nil, error) } }
Objective-C
- (void)bannerDidLoad:(SampleBanner *)banner { _adEventDelegate = _loadCompletionHandler(self, nil); } - (void)banner:(SampleBanner *)banner didFailToLoadAdWithErrorCode:(SampleErrorCode)errorCode { NSError *error = SampleCustomEventErrorWithCodeAndDescription( SampleCustomEventErrorAdLoadFailureCallback, [NSString stringWithFormat:@"Sample SDK returned an ad load failure " @"callback with error code: %@", errorCode]); _adEventDelegate = _loadCompletionHandler(nil, error); }
GADMediationBannerAd
要求實作 UIView
屬性:
Swift
var view: UIView { return bannerAd ?? UIView() }
Objective-C
- (nonnull UIView *)view { return _bannerAd; }
將中介服務事件轉送至 Google Mobile Ads SDK
透過已載入的廣告呼叫 GADMediationBannerLoadCompletionHandler
後,轉接程式就能使用傳回的 GADMediationBannerAdEventDelegate
委派物件,將第三方 SDK 的呈現事件轉送至 Google Mobile Ads SDK。SampleCustomEventBanner
類別會導入 SampleBannerAdDelegate
通訊協定,將廣告聯播網範例的回呼轉送至 Google Mobile Ads SDK。
您必須讓自訂事件盡可能轉送這些回呼,這樣才能從 Google Mobile Ads SDK 接收這些對等的事件。以下是使用回呼的範例:
Swift
func bannerWillLeaveApplication(_ banner: SampleBanner) { delegate?.reportClick() }
Objective-C
- (void)bannerWillLeaveApplication:(SampleBanner *)banner { [_adEventDelegate reportClick]; }
這樣就能完成橫幅廣告的自訂事件導入作業。完整範例請前往 GitHub。您可以將其搭配系統支援的廣告聯播網使用,也可以改為顯示自訂事件橫幅廣告。