iOS SDK Version

FBAdView

Objective-C

@interfaceFBAdView:UIView

Swift

classFBAdView:UIView

A customized UIView to represent a Facebook ad (a.k.a. banner ad).

-initWithPlacementID:

This is a method to initialize an FBAdView matching the given placement id.

Declaration

Objective-C

-(nonnullinstancetype)initWithPlacementID:(nonnullNSString*)placementIDadSize:(FBAdSize)adSizerootViewController:(nullableUIViewController*)rootViewController;

Swift

init(placementID:String,adSize:FBAdSize,rootViewController:UIViewController?)

Parameters

-initWithPlacementID:

This is a method to initialize an FBAdView matching the given placement id with a given bidding payload.

Declaration

Objective-C

-(nullableinstancetype)initWithPlacementID:(nonnullNSString*)placementIDbidPayload:(nonnullNSString*)bidPayloadrootViewController:(nullableUIViewController*)rootViewControllererror:(NSError*_Nullable*_Nullable)error;

Swift

convenienceinit(placementID:String,bidPayload:String,rootViewController:UIViewController?)throws

Parameters

-loadAd
Begins loading the FBAdView content.
You can implement adViewDidLoad: and adView:didFailWithError: methods of FBAdViewDelegate if you would like to be notified as loading succeeds or fails.
Declaration
Objective-C
-(void)loadAd;
Swift
funcloadAd()
-loadAdWithBidPayload:
Begins loading the FBAdView content from a bid payload attained through a server side bid.
You can implement adViewDidLoad: and adView:didFailWithError: methods of FBAdViewDelegate if you would like to be notified as loading succeeds or fails.
Declaration
Objective-C
-(void)loadAdWithBidPayload:(nonnullNSString*)bidPayload;
Swift
funcloadAd(withBidPayloadbidPayload:String)
Parameters
-disableAutoRefresh
Deprecated
There is no reason to call this method anymore. Autorefresh is disabled by default.
Declaration
Objective-C
-(void)disableAutoRefresh;
Swift
funcdisableAutoRefresh()

placementID

Typed access to the id of the ad placement.

Declaration

Objective-C

@property(nonatomic,copy,readonly)NSString*_NonnullplacementID;

Swift

varplacementID:String{get}

rootViewController

Typed access to the app’s root view controller.

Declaration

Objective-C

@property(nonatomic,weak,readonly,nullable)UIViewController*rootViewController;

Swift

weakvarrootViewController:UIViewController?{get}

adValid

Call isAdValid to check whether ad is valid

Declaration

Objective-C

@property(nonatomic,readonly,getter=isAdValid)BOOLadValid;

Swift

varisAdValid:Bool{get}

delegate

the delegate

Declaration

Objective-C

@property(nonatomic,weak,nullable)id<FBAdViewDelegate>delegate;

Swift

weakvardelegate:FBAdViewDelegate?{getset}

extraHint

FBAdExtraHint to provide extra info

Declaration

Objective-C

@property(nonatomic,strong,nullable)FBAdExtraHint*extraHint;

Swift

varextraHint:FBAdExtraHint?{getset}