Android SDK Version
A B C D E F G H I K L M N O P R S T U V W 
A
AbstractAdListener implements AdListener and InterstitialAdListener.
AbstractAdListener() - Constructor for class com.facebook.ads.AbstractAdListener
 
Ad - Interface in com.facebook.ads
Ad interface is a common interface implemented by all Facebook ad controls.
AD_ASSETS_UNSUPPORTED_TYPE_ERROR - Static variable in class com.facebook.ads.AdError
 
AD_ASSETS_UNSUPPORTED_TYPE_ERROR_CODE - Static variable in class com.facebook.ads.AdError
 
Deprecated.
since 5.1
AdChoicesView(Context, NativeAdBase) - Constructor for class com.facebook.ads.AdChoicesView
Deprecated.
Deprecated.
AdChoicesView(Context, NativeAdBase, boolean) - Constructor for class com.facebook.ads.AdChoicesView
Deprecated.
Deprecated.
addTestDevice(String) - Static method in class com.facebook.ads.AdSettings
Adds a test device.
addTestDevices(Collection<String>) - Static method in class com.facebook.ads.AdSettings
Adds a collection of test devices.
addView(View) - Method in class com.facebook.ads.MediaView
 
addView(View, int) - Method in class com.facebook.ads.MediaView
 
addView(View, ViewGroup.LayoutParams) - Method in class com.facebook.ads.MediaView
 
addView(View, int, int) - Method in class com.facebook.ads.MediaView
 
addView(View, int, ViewGroup.LayoutParams) - Method in class com.facebook.ads.MediaView
 
addView(View) - Method in class com.facebook.ads.MediaViewVideoRenderer
 
addView(View, int) - Method in class com.facebook.ads.MediaViewVideoRenderer
 
 
addView(View, int, int) - Method in class com.facebook.ads.MediaViewVideoRenderer
 
 
AdError contains the error information returned by Facebook.
AdError(int, String) - Constructor for class com.facebook.ads.AdError
Constructs an AdError using the given error code and error message
Deprecated.
since 5.1, use MediaView instead.
AdIconView(Context) - Constructor for class com.facebook.ads.AdIconView
Deprecated.
 
AdIconView(Context, AttributeSet) - Constructor for class com.facebook.ads.AdIconView
Deprecated.
 
AdIconView(Context, AttributeSet, int) - Constructor for class com.facebook.ads.AdIconView
Deprecated.
 
AdIconView(Context, AttributeSet, int, int) - Constructor for class com.facebook.ads.AdIconView
Deprecated.
 
AdListener interface is notified of events in ad control lifecycle.
A clickable Ad Options icon, which presents the user with options to report and hide an ad.
Initializes the AdOptionsView with default Horizontal orientation and minimum possible size for the icons.
Initializes the AdOptionsView with custom orientation and icon size.
 
AdSettings contains global settings for all ad controls.
AdSettings() - Constructor for class com.facebook.ads.AdSettings
 
 
 
Ad Type to be returned when test mode is on.
AdSize is the dimension of the ad control.
AdSize(int, int) - Constructor for class com.facebook.ads.AdSize
 
AdView displays advertisements by Facebook.
AdView(Context, String, AdSize) - Constructor for class com.facebook.ads.AdView
Constructs an AdView using the given context, placement_id and size.
AdView(Context, String, String) - Constructor for class com.facebook.ads.AdView
Constructs an AdView using the given context, placement_id and bid payload.
ALL - Static variable in enum com.facebook.ads.CacheFlag
 
AudienceNetworkActivity is the Android activity for displaying and handling ads.
AudienceNetworkActivity() - Constructor for class com.facebook.ads.AudienceNetworkActivity
 
The class contains methods that are used across whole Audience Network SDK during lifetime of the application.
Constants that represent Audience Network SDK Ad Formats.
The interface that allows receive callback when initialization of the SDK is done.
Result of initialization.
A builder class that allows to pass additional setting during initialization.
B
BANNER - Static variable in annotation type com.facebook.ads.AudienceNetworkAds.AdFormat
 
BANNER_320_50 - Static variable in class com.facebook.ads.AdSize
Deprecated.
BANNER_HEIGHT_50 - Static variable in class com.facebook.ads.AdSize
Represents a flexible banner ad size, where banner width depends on its container width, and banner height is fixed as 50dp.
BANNER_HEIGHT_90 - Static variable in class com.facebook.ads.AdSize
Represents a flexible banner ad size, where banner width depends on its container width, and banner height is fixed as 90dp.
Provides tokens for use with the Audience Network server-side bidder
BidderTokenProvider() - Constructor for class com.facebook.ads.BidderTokenProvider
 
bringChildToFront(View) - Method in class com.facebook.ads.MediaView
 
BROKEN_MEDIA_ERROR - Static variable in class com.facebook.ads.AdError
 
BROKEN_MEDIA_ERROR_CODE - Static variable in class com.facebook.ads.AdError
 
build() - Method in class com.facebook.ads.ExtraHints.Builder
 
Builder() - Constructor for class com.facebook.ads.ExtraHints.Builder
 
buildInitSettings(Context) - Static method in class com.facebook.ads.AudienceNetworkAds
Allows initialize the Audience Network SDK with additional settings.
C
CACHE_ERROR - Static variable in class com.facebook.ads.AdError
 
CACHE_ERROR_CODE - Static variable in class com.facebook.ads.AdError
 
 
CLEAR_TEXT_SUPPORT_NOT_ALLOWED - Static variable in class com.facebook.ads.AdError
 
clearTestDevices() - Static method in class com.facebook.ads.AdSettings
Clears the collection of test devices.
com.facebook.ads - package com.facebook.ads
 
contentUrl(String) - Method in class com.facebook.ads.ExtraHints.Builder
 
createView(NativeAd, int) - Method in interface com.facebook.ads.NativeAdScrollView.AdViewProvider
 
D
DEBUG - Static variable in class com.facebook.ads.AdSettings
Deprecated.
DEFAULT_INSET - Static variable in class com.facebook.ads.NativeAdScrollView
 
DEFAULT_MAX_ADS - Static variable in class com.facebook.ads.NativeAdScrollView
 
This is a Default VideoViewRenderer used within MediaView.
 
 
 
 
destroy() - Method in interface com.facebook.ads.Ad
Destroys the ad control.
destroy() - Method in class com.facebook.ads.AdView
 
destroy() - Method in class com.facebook.ads.InstreamVideoAdView
 
destroy() - Method in class com.facebook.ads.InterstitialAd
 
destroy() - Method in class com.facebook.ads.MediaView
 
destroy() - Method in class com.facebook.ads.MediaViewVideoRenderer
Deprecated.
destroy() - Method in class com.facebook.ads.NativeAdBase
 
destroy() - Method in class com.facebook.ads.RewardedVideoAd
 
destroyView(NativeAd, View) - Method in interface com.facebook.ads.NativeAdScrollView.AdViewProvider
 
disableAutoRefresh() - Method in class com.facebook.ads.AdView
Deprecated.
auto refresh is no longer supported and therefore this method is now deprecated.
disableAutoRefresh() - Method in class com.facebook.ads.NativeAdsManager
 
disengageSeek(VideoStartReason) - Method in class com.facebook.ads.MediaViewVideoRenderer
Take the video out of seek mode.
downloadMedia() - Method in class com.facebook.ads.NativeAdBase
Manually pre-cache media contents such as Image, Icon, video, etc.
E
engageSeek() - Method in class com.facebook.ads.MediaViewVideoRenderer
Used to put the video into seek mode.
equals(Object) - Method in class com.facebook.ads.AdSize
 
extraData(String) - Method in class com.facebook.ads.ExtraHints.Builder
 
 
 
 
 
F
finish() - Method in class com.facebook.ads.AudienceNetworkActivity
 
fromBidPayload(Context, String, String) - Static method in class com.facebook.ads.NativeAdBase
 
fromJSONObject(JSONObject) - Static method in class com.facebook.ads.NativeAdBase.Image
Parses an Image from the given JSON object.
fromJSONObject(JSONObject) - Static method in class com.facebook.ads.NativeAdBase.Rating
Parses a Rating from the given JSON object.
fromWidthAndHeight(int, int) - Static method in class com.facebook.ads.AdSize
 
G
getAdBodyText() - Method in class com.facebook.ads.NativeAdBase
Gets the body, usually a longer description of the ad.
getAdCallToAction() - Method in class com.facebook.ads.NativeAdBase
Gets the call to action phrase.
getAdChoicesIcon() - Method in class com.facebook.ads.NativeAdBase
 
getAdChoicesImageUrl() - Method in class com.facebook.ads.NativeAdBase
 
getAdChoicesLinkUrl() - Method in class com.facebook.ads.NativeAdBase
 
getAdChoicesText() - Method in class com.facebook.ads.NativeAdBase
 
getAdContentsView() - Method in class com.facebook.ads.MediaView
 
getAdCoverImage() - Method in class com.facebook.ads.NativeAdBase
Gets the cover image creative.
getAdCreativeType() - Method in class com.facebook.ads.NativeAd
Gets the Ad Creative Type, which can be IMAGE, VIDEO, CAROUSEL or UNKNOWN.
getAdFormatForPlacement(Context, String) - Static method in class com.facebook.ads.AudienceNetworkAds
Returns AudienceNetworkAds.AdFormat for the placement.
getAdHeadline() - Method in class com.facebook.ads.NativeAdBase
Shows the headline that the advertiser entered when they created an ad; main title of an ad.
getAdIcon() - Method in class com.facebook.ads.NativeAdBase
Gets the icon creative.
getAdLinkDescription() - Method in class com.facebook.ads.NativeAdBase
Shows additional information that the advertiser may have entered.
getAdSocialContext() - Method in class com.facebook.ads.NativeAdBase
Gets the social context.
getAdsProcessName(Context) - Static method in class com.facebook.ads.AudienceNetworkAds
Returns name of Ads Process in format ":PROCESS_NAME".
getAdStarRating() - Method in class com.facebook.ads.NativeAdBase
Deprecated.
Star rating is deprecated.
getAdTranslation() - Method in class com.facebook.ads.NativeAdBase
Shows the word 'ad', translated into the regional language
getAdTypeString() - Method in enum com.facebook.ads.AdSettings.TestAdType
 
getAdUntrimmedBodyText() - Method in class com.facebook.ads.NativeAdBase
Gets the untrimmed ad body
getAdvertiserName() - Method in class com.facebook.ads.NativeAdBase
Shows the name of Facebook Page or mobile app that represents the ad.
getAdViewAttributes() - Method in class com.facebook.ads.NativeAdBase
Deprecated.
getAutoplay() - Method in class com.facebook.ads.NativeAdViewAttributes
Deprecated.
getAutoplayOnMobile() - Method in class com.facebook.ads.NativeAdViewAttributes
Deprecated.
getBackgroundColor() - Method in class com.facebook.ads.NativeAdViewAttributes
Deprecated.
getBidderToken(Context) - Static method in class com.facebook.ads.BidderTokenProvider
Get the Audience Network Identity Token for ORTB bidding (user.buyeruid).
getButtonBorderColor() - Method in class com.facebook.ads.NativeAdViewAttributes
Deprecated.
getButtonColor() - Method in class com.facebook.ads.NativeAdViewAttributes
Deprecated.
getButtonTextColor() - Method in class com.facebook.ads.NativeAdViewAttributes
Deprecated.
getCurrency() - Method in class com.facebook.ads.RewardData
 
getCurrentTimeMs() - Method in class com.facebook.ads.MediaViewVideoRenderer
Get the current playback position in milliseconds.
getDescriptionTextColor() - Method in class com.facebook.ads.NativeAdViewAttributes
Deprecated.
getDescriptionTextSize() - Method in class com.facebook.ads.NativeAdViewAttributes
Deprecated.
getDuration() - Method in class com.facebook.ads.MediaViewVideoRenderer
Get the duration of the video in milliseconds.
getEnumCode() - Method in enum com.facebook.ads.NativeAdView.Type
Deprecated.
 
getEnumCode() - Method in enum com.facebook.ads.NativeBannerAdView.Type
 
getErrorCode() - Method in class com.facebook.ads.AdError
Gets the error code
getErrorMessage() - Method in class com.facebook.ads.AdError
Gets the error message
getHeight() - Method in class com.facebook.ads.AdSize
Gets the height of the ad control.
getHeight() - Method in class com.facebook.ads.NativeAdBase.Image
Gets the height of the image.
getHeight() - Method in enum com.facebook.ads.NativeAdView.Type
Deprecated.
getHeight() - Method in enum com.facebook.ads.NativeBannerAdView.Type
Gets the height of the ad control.
getHints() - Method in class com.facebook.ads.ExtraHints
 
getHumanReadable() - Method in enum com.facebook.ads.AdSettings.TestAdType
 
getId() - Method in class com.facebook.ads.NativeAdBase
Gets a unique ID for the NativeAd.
getInternalAttributes() - Method in class com.facebook.ads.NativeAdViewAttributes
Used by other SDK classes and subject to change.
getInternalNativeAd() - Method in class com.facebook.ads.NativeAdBase
Used by other SDK classes and subject to change.
getMediaHeight() - Method in class com.facebook.ads.MediaView
 
getMediationData() - Method in class com.facebook.ads.ExtraHints
 
getMediationService() - Static method in class com.facebook.ads.AdSettings
Returns the name of the mediation service that is mediating Audience Network
getMediaViewApi() - Method in class com.facebook.ads.MediaView
Used by other SDK classes and subject to change.
getMediaViewVideoRendererApi() - Method in class com.facebook.ads.MediaViewVideoRenderer
Used by other SDK classes and subject to change.
getMediaWidth() - Method in class com.facebook.ads.MediaView
 
getMessage() - Method in interface com.facebook.ads.AudienceNetworkAds.InitResult
A message that contains details about initialization result.
getNativeAdApi() - Method in class com.facebook.ads.NativeAd
Used by other SDK classes and subject to change.
getNativeAdLayoutApi() - Method in class com.facebook.ads.NativeAdLayout
Used by other SDK classes and subject to change.
getPlacementId() - Method in interface com.facebook.ads.Ad
Get the placementId for this ad.
getPlacementId() - Method in class com.facebook.ads.AdView
 
getPlacementId() - Method in class com.facebook.ads.InstreamVideoAdView
 
getPlacementId() - Method in class com.facebook.ads.InterstitialAd
 
getPlacementId() - Method in class com.facebook.ads.NativeAdBase
 
getPlacementId() - Method in class com.facebook.ads.RewardedVideoAd
 
getPromotedTranslation() - Method in class com.facebook.ads.NativeAdBase
Shows the word 'promoted', translated into the regional language
getSaveInstanceState() - Method in class com.facebook.ads.InstreamVideoAdView
 
getScale() - Method in class com.facebook.ads.NativeAdBase.Rating
Gets the rating scale.
getSponsoredTranslation() - Method in class com.facebook.ads.NativeAdBase
Shows the word 'Sponsored', translated into the regional language.
getTestAdType() - Static method in class com.facebook.ads.AdSettings
 
getTitleTextColor() - Method in class com.facebook.ads.NativeAdViewAttributes
Deprecated.
getTitleTextSize() - Method in class com.facebook.ads.NativeAdViewAttributes
Deprecated.
getTypeface() - Method in class com.facebook.ads.NativeAdViewAttributes
Deprecated.
getUniqueNativeAdCount() - Method in class com.facebook.ads.NativeAdsManager
 
getUrlPrefix() - Static method in class com.facebook.ads.AdSettings
Gets the url prefix.
getUserID() - Method in class com.facebook.ads.RewardData
 
getValue() - Method in class com.facebook.ads.NativeAdBase.Rating
Gets the rating value.
getValue() - Method in enum com.facebook.ads.NativeAdView.Type
Deprecated.
getValue() - Method in enum com.facebook.ads.NativeBannerAdView.Type
 
getVideoDuration() - Method in class com.facebook.ads.RewardedVideoAd
 
getVolume() - Method in class com.facebook.ads.MediaViewVideoRenderer
Get the volume of the video player.
getWidth() - Method in class com.facebook.ads.AdSize
Gets the width of the ad control.
getWidth() - Method in class com.facebook.ads.NativeAdBase.Image
Gets the width of the image.
getWidth() - Method in enum com.facebook.ads.NativeAdView.Type
Deprecated.
getWidth() - Method in enum com.facebook.ads.NativeBannerAdView.Type
Gets the width of the ad control.
H
hasCallToAction() - Method in class com.facebook.ads.NativeAdBase
Gets whether an action or command is present in an ad
hashCode() - Method in class com.facebook.ads.AdSize
 
I
ICONVIEW_MISSING_ERROR_CODE - Static variable in class com.facebook.ads.AdError
 
INCORRECT_STATE_ERROR - Static variable in class com.facebook.ads.AdError
 
initialize(Context) - Static method in class com.facebook.ads.AudienceNetworkAds
Initialize the Audience Network SDK.
initialize() - Method in interface com.facebook.ads.AudienceNetworkAds.InitSettingsBuilder
Triggers asynchronous initialization.
INSTREAM_VIDEO_MOBILE - Static variable in annotation type com.facebook.ads.AudienceNetworkAds.AdFormat
 
InstreamVideoAdListener interface is notified of events in InstreamVideoAdView lifecycle.
InstreamVideoAd displays a Instream video advertisement by Facebook
To use the Instream video, do the following:
InstreamVideoAdView(Context, Bundle) - Constructor for class com.facebook.ads.InstreamVideoAdView
 
InstreamVideoAdView(Context, String, AdSize) - Constructor for class com.facebook.ads.InstreamVideoAdView
Constructs a InstreamVideoAdView given the context and the placement id
INTERNAL_ERROR - Static variable in class com.facebook.ads.AdError
 
INTERNAL_ERROR_2003 - Static variable in class com.facebook.ads.AdError
 
INTERNAL_ERROR_2004 - Static variable in class com.facebook.ads.AdError
 
INTERNAL_ERROR_2006 - Static variable in class com.facebook.ads.AdError
 
INTERNAL_ERROR_CODE - Static variable in class com.facebook.ads.AdError
 
internalError(int) - Static method in class com.facebook.ads.AdError
 
INTERSTITIAL - Static variable in class com.facebook.ads.AdSize
A full screen interstitial size.
INTERSTITIAL - Static variable in annotation type com.facebook.ads.AudienceNetworkAds.AdFormat
 
INTERSTITIAL_AD_TIMEOUT - Static variable in class com.facebook.ads.AdError
 
InterstitialAd displays an advertisement by Facebook in an interstitial.
InterstitialAd(Context, String) - Constructor for class com.facebook.ads.InterstitialAd
Constructs an InterstitialAd using the given context and placement id.
InterstitialAdExtendedListener interface is notified of events in InterstitialAd lifecycle.
InterstitialAdListener interface is notified of events in InterstitialAd lifecycle.
isAdInvalidated() - Method in interface com.facebook.ads.Ad
Indicate whether the ad is still valid.
isAdInvalidated() - Method in class com.facebook.ads.AdView
 
isAdInvalidated() - Method in class com.facebook.ads.InstreamVideoAdView
 
isAdInvalidated() - Method in class com.facebook.ads.InterstitialAd
 
isAdInvalidated() - Method in class com.facebook.ads.NativeAdBase
 
isAdInvalidated() - Method in class com.facebook.ads.RewardedVideoAd
 
isAdLoaded() - Method in class com.facebook.ads.InstreamVideoAdView
Tells whether an ad is loaded and ready to show
isAdLoaded() - Method in class com.facebook.ads.InterstitialAd
Gets whether an ad is loaded and ready to show.
isAdLoaded() - Method in class com.facebook.ads.NativeAdBase
Gets whether an ad is loaded and ready to show.
isAdLoaded() - Method in class com.facebook.ads.RewardedVideoAd
Tells whether an ad is loaded and ready to show
isChildDirected() - Static method in class com.facebook.ads.AdSettings
Gets whether the ad control is targeting a child.
isInAdsProcess(Context) - Static method in class com.facebook.ads.AudienceNetworkAds
Verifies if current process is process created by Audience Network SDK.
isInitialized(Context) - Static method in class com.facebook.ads.AudienceNetworkAds
Returns true if Audience Network SDK has been already initialized.
isLoaded() - Method in class com.facebook.ads.NativeAdsManager
 
isNativeConfigEnabled() - Method in class com.facebook.ads.NativeAdBase
Deprecated.
isSuccess() - Method in interface com.facebook.ads.AudienceNetworkAds.InitResult
A boolean value that shows if the SDK was successfully initialized.
isTestMode(Context) - Static method in class com.facebook.ads.AdSettings
Gets whether ad controls are working in test mode.
isVideoAutoplay() - Static method in class com.facebook.ads.AdSettings
Gets whether video autoplay is enabled
isVideoAutoplayOnMobile() - Static method in class com.facebook.ads.AdSettings
Gets whether video autoplay is only enabled on Wifi or not
K
keywords(List<ExtraHints.Keyword>) - Method in class com.facebook.ads.ExtraHints.Builder
 
L
LOAD_CALLED_WHILE_SHOWING_AD - Static variable in class com.facebook.ads.AdError
 
LOAD_TOO_FREQUENTLY - Static variable in class com.facebook.ads.AdError
 
LOAD_TOO_FREQUENTLY_ERROR_CODE - Static variable in class com.facebook.ads.AdError
 
loadAd() - Method in interface com.facebook.ads.Ad
Loads an ad.
loadAd() - Method in class com.facebook.ads.AdView
Loads an ad.
loadAd() - Method in class com.facebook.ads.InstreamVideoAdView
 
loadAd() - Method in class com.facebook.ads.InterstitialAd
 
loadAd(EnumSet<CacheFlag>) - Method in class com.facebook.ads.InterstitialAd
 
loadAd() - Method in class com.facebook.ads.NativeAdBase
 
loadAd(NativeAdBase.MediaCacheFlag) - Method in class com.facebook.ads.NativeAdBase
This method allows to disable pre-caching for the ads while NativeAdBase.loadAd() pre-cache ad assets by default.
loadAd() - Method in class com.facebook.ads.RewardedVideoAd
 
loadAd(boolean) - Method in class com.facebook.ads.RewardedVideoAd
 
loadAdFromBid(String) - Method in interface com.facebook.ads.Ad
Loads an ad from the payload supplied with a bid.
loadAdFromBid(String) - Method in class com.facebook.ads.AdView
Loads an ad from the payload supplied with a bid.
loadAdFromBid(String) - Method in class com.facebook.ads.InstreamVideoAdView
 
loadAdFromBid(String) - Method in class com.facebook.ads.InterstitialAd
 
 
loadAdFromBid(String) - Method in class com.facebook.ads.NativeAdBase
 
 
loadAdFromBid(String) - Method in class com.facebook.ads.RewardedVideoAd
 
loadAdFromBid(String, boolean) - Method in class com.facebook.ads.RewardedVideoAd
 
loadAds() - Method in class com.facebook.ads.NativeAdsManager
 
loadAds(NativeAdBase.MediaCacheFlag) - Method in class com.facebook.ads.NativeAdsManager
 
M
MEDIATION_ERROR - Static variable in class com.facebook.ads.AdError
 
MEDIATION_ERROR_CODE - Static variable in class com.facebook.ads.AdError
 
mediationData(String) - Method in class com.facebook.ads.ExtraHints.Builder
 
MediaView displays native ad media content.
MediaView(Context) - Constructor for class com.facebook.ads.MediaView
 
MediaView(Context, AttributeSet) - Constructor for class com.facebook.ads.MediaView
 
MediaView(Context, AttributeSet, int) - Constructor for class com.facebook.ads.MediaView
 
MediaView(Context, AttributeSet, int, int) - Constructor for class com.facebook.ads.MediaView
 
MEDIAVIEW_MISSING_ERROR_CODE - Static variable in class com.facebook.ads.AdError
 
MediaViewListener interface is notified of events in MediaView lifecycle.
Abstract video renderer class that developers can extend to implement very customized video UI within the MediaView.
MediaViewVideoRenderer(Context) - Constructor for class com.facebook.ads.MediaViewVideoRenderer
 
 
 
 
This is a Default VideoViewRenderer used within MediaView.
 
 
 
 
MISSING_DEPENDENCIES_ERROR - Static variable in class com.facebook.ads.AdError
 
MISSING_PROPERTIES - Static variable in class com.facebook.ads.AdError
Deprecated.
N
NATIVE - Static variable in annotation type com.facebook.ads.AudienceNetworkAds.AdFormat
 
NATIVE_BANNER - Static variable in annotation type com.facebook.ads.AudienceNetworkAds.AdFormat
 
nativeAd - Variable in class com.facebook.ads.MediaViewVideoRenderer
Deprecated.
NativeAd provides ad creative for apps to rendered in custom layout.
NativeAd(Context, String) - Constructor for class com.facebook.ads.NativeAd
Constructs an NativeAd using the given context and placement id.
NativeAd(Context, NativeAdBaseApi) - Constructor for class com.facebook.ads.NativeAd
Used by other SDK classes and subject to change.
NativeAd(Context, NativeAdBase) - Constructor for class com.facebook.ads.NativeAd
Used by other SDK classes and subject to change.
 
 
NativeAdBase(Context, String) - Constructor for class com.facebook.ads.NativeAdBase
Constructs an NativeAdBase using the given context and placement id.
NativeAdBase(NativeAdBaseApi) - Constructor for class com.facebook.ads.NativeAdBase
Used by other SDK classes and subject to change.
Image creative.
Media Cache flag
Optional tags for native ad view components.
Rating info.
NativeAdLayout is a wrapper for FrameLayout that is required to show the inline ad reporting menu for Native Ads.
NativeAdLayout(Context) - Constructor for class com.facebook.ads.NativeAdLayout
 
NativeAdLayout(Context, AttributeSet) - Constructor for class com.facebook.ads.NativeAdLayout
 
NativeAdLayout(Context, AttributeSet, int) - Constructor for class com.facebook.ads.NativeAdLayout
 
NativeAdLayout(Context, NativeAdLayoutApi) - Constructor for class com.facebook.ads.NativeAdLayout
Used by other SDK classes and subject to change.
 
NativeAdScrollView provides a horizontal scrolling experience hosting either NativeAdViews or custom views.
 
 
 
 
 
Deprecated.
Deprecated.
Deprecated.
 
The NativeAdsManager provides a mechanism to fetch a set of NativeAds and then use them within your application.
NativeAdsManager(Context, String, int) - Constructor for class com.facebook.ads.NativeAdsManager
 
 
NativeAdView provides a templated View for a NativeAd with flexible width and height determined by the container View.
NativeAdView() - Constructor for class com.facebook.ads.NativeAdView
 
Deprecated.
NativeAdViewAttributes controls layout and display elements of the NativeAdView.
NativeAdViewAttributes(Context) - Constructor for class com.facebook.ads.NativeAdViewAttributes
Create NativeAdViewAttributes.
NativeAdViewAttributes() - Constructor for class com.facebook.ads.NativeAdViewAttributes
NativeBannerAd provides an ad creative for apps to render on a custom layout.
NativeBannerAd(Context, String) - Constructor for class com.facebook.ads.NativeBannerAd
 
NativeBannerAdView provides a templated View for a NativeBannerAd with flexible width and height determined by NativeBannerAdView.Type.
NativeBannerAdView() - Constructor for class com.facebook.ads.NativeBannerAdView
 
 
NETWORK_ERROR - Static variable in class com.facebook.ads.AdError
 
NETWORK_ERROR_CODE - Static variable in class com.facebook.ads.AdError
 
nextNativeAd() - Method in class com.facebook.ads.NativeAdsManager
 
NO_FILL - Static variable in class com.facebook.ads.AdError
 
NO_FILL_ERROR_CODE - Static variable in class com.facebook.ads.AdError
 
O
onAdClicked(Ad) - Method in class com.facebook.ads.AbstractAdListener
Called when the ad control is clicked and user is redirected to the link in the ad.
onAdClicked(Ad) - Method in interface com.facebook.ads.AdListener
Called when the ad control is clicked and user is redirected to the link in the ad.
onAdError(AdError) - Method in interface com.facebook.ads.NativeAdsManager.Listener
 
onAdLoaded(Ad) - Method in class com.facebook.ads.AbstractAdListener
Called when the ad control has loaded an ad.
onAdLoaded(Ad) - Method in interface com.facebook.ads.AdListener
Called when the ad control has loaded an ad.
onAdsLoaded() - Method in interface com.facebook.ads.NativeAdsManager.Listener
 
onAdVideoComplete(Ad) - Method in interface com.facebook.ads.InstreamVideoAdListener
 
onBackPressed() - Method in class com.facebook.ads.AudienceNetworkActivity
 
onComplete(MediaView) - Method in interface com.facebook.ads.MediaViewListener
 
onCompleted() - Method in class com.facebook.ads.MediaViewVideoRenderer
Callback when the video has completed playing.
onConfigurationChanged(Configuration) - Method in class com.facebook.ads.AdView
 
 
onCreate(Bundle) - Method in class com.facebook.ads.AudienceNetworkActivity
 
onCtaBroadcast() - Method in class com.facebook.ads.NativeAdBase
 
onDestroy() - Method in class com.facebook.ads.AudienceNetworkActivity
 
onEnterFullscreen(MediaView) - Method in interface com.facebook.ads.MediaViewListener
 
onError(Ad, AdError) - Method in class com.facebook.ads.AbstractAdListener
Called when an error happened while the ad control is attempting to load an ad.
onError(Ad, AdError) - Method in interface com.facebook.ads.AdListener
Called when an error happened while the ad control is attempting to load an ad.
onError() - Method in class com.facebook.ads.MediaViewVideoRenderer
Callback when the video had an error during initialization or playback.
onExitFullscreen(MediaView) - Method in interface com.facebook.ads.MediaViewListener
 
onFullscreenBackground(MediaView) - Method in interface com.facebook.ads.MediaViewListener
 
onFullscreenForeground(MediaView) - Method in interface com.facebook.ads.MediaViewListener
 
 
Called when the Interstitial activity is destroyed.
onInterstitialDismissed(Ad) - Method in class com.facebook.ads.AbstractAdListener
Called when the interstitial ad control is dismissed.
onInterstitialDismissed(Ad) - Method in interface com.facebook.ads.InterstitialAdListener
Called when the interstitial ad control is dismissed.
onInterstitialDisplayed(Ad) - Method in class com.facebook.ads.AbstractAdListener
Called when the interstitial ad control is displayed.
onInterstitialDisplayed(Ad) - Method in interface com.facebook.ads.InterstitialAdListener
Called when the interstitial ad control is displayed.
onLoggingImpression(Ad) - Method in class com.facebook.ads.AbstractAdListener
Called immediately before an impression is logged.
onLoggingImpression(Ad) - Method in interface com.facebook.ads.AdListener
Called immediately before an impression is logged.
onLoggingImpression(Ad) - Method in interface com.facebook.ads.RewardedVideoAdListener
 
onMediaDownloaded(Ad) - Method in interface com.facebook.ads.NativeAdListener
 
onPause() - Method in class com.facebook.ads.AudienceNetworkActivity
 
onPause(MediaView) - Method in interface com.facebook.ads.MediaViewListener
 
onPaused() - Method in class com.facebook.ads.MediaViewVideoRenderer
Callback when the video has been paused.
onPlay(MediaView) - Method in interface com.facebook.ads.MediaViewListener
 
onPlayed() - Method in class com.facebook.ads.MediaViewVideoRenderer
Callback when the video has started playing.
onPrepared() - Method in class com.facebook.ads.DefaultMediaViewVideoRenderer
 
onPrepared() - Method in class com.facebook.ads.MediaViewVideoRenderer
Callback when the video is prepared and ready to play.
 
onResume() - Method in class com.facebook.ads.AudienceNetworkActivity
 
Called when the Rewarded Video activity is destroyed.
onRewardedVideoClosed() - Method in interface com.facebook.ads.RewardedVideoAdListener
 
onRewardedVideoCompleted() - Method in interface com.facebook.ads.RewardedVideoAdListener
 
onRewardServerFailed() - Method in interface com.facebook.ads.S2SRewardedVideoAdListener
 
onRewardServerSuccess() - Method in interface com.facebook.ads.S2SRewardedVideoAdListener
 
onSaveInstanceState(Bundle) - Method in class com.facebook.ads.AudienceNetworkActivity
 
onSeek() - Method in class com.facebook.ads.MediaViewVideoRenderer
Callback when the video is seeked.
onSeekDisengaged() - Method in class com.facebook.ads.MediaViewVideoRenderer
Callback when seek mode is disengaged.
onSeekEngaged() - Method in class com.facebook.ads.MediaViewVideoRenderer
Callback when seek mode is engaged.
onStart() - Method in class com.facebook.ads.AudienceNetworkActivity
 
onVolumeChange(MediaView, float) - Method in interface com.facebook.ads.MediaViewListener
 
onVolumeChanged() - Method in class com.facebook.ads.MediaViewVideoRenderer
Callback when the volume of the video has changed.
P
pause(boolean) - Method in class com.facebook.ads.MediaViewVideoRenderer
Stop video playback.
play(VideoStartReason) - Method in class com.facebook.ads.MediaViewVideoRenderer
Start video playback.
R
RECTANGLE_HEIGHT_250 - Static variable in class com.facebook.ads.AdSize
Represents a flexible rectangle ad size, where width depends on its container width, and height is fixed as 250dp.
registerViewForInteraction(View, MediaView) - Method in class com.facebook.ads.NativeAd
Registers the given view as the container and the required MediaView as the contents display for this NativeAd to handle impressions and clicks.
Registers the given view as the container and the required MediaView as the contents display for this NativeAd to handle impressions and clicks.
Registers the given view as the container and the required MediaView as the contents display for this NativeAd to handle impressions and clicks.
Registers the given view as the container and the required MediaView as the contents display for this NativeAd to handle impressions and clicks.
Registers the given view as the container and the required MediaView as the contents display for this NativeAd to handle impressions and clicks.
Registers the given view as the container and the required MediaView as the contents display for this NativeAd to handle impressions and clicks.
Registers the given view as the container and the required IconView as the Icon display for this NativeBannerAd to handle impressions and clicks.
Registers the given view as the container and the required IconView as the Icon display for this NativeBannerAd to handle impressions and clicks.
REMOTE_ADS_SERVICE_ERROR - Static variable in class com.facebook.ads.AdError
 
render(Context, NativeAd) - Static method in class com.facebook.ads.NativeAdView
Creates a View for the given NativeAd.
render(Context, NativeAd, NativeAdViewAttributes) - Static method in class com.facebook.ads.NativeAdView
Creates a View for the given NativeAd.
render(Context, NativeAd, NativeAdView.Type) - Static method in class com.facebook.ads.NativeAdView
Deprecated.
Deprecated.
Allows to create View for specified NativeBannerAdView.Type.
Allows to create View for specified NativeAdView.Type and NativeAdViewAttributes.
RewardData represents the data used to reward the user in RewardedVideoAd
RewardData(String, String) - Constructor for class com.facebook.ads.RewardData
 
REWARDED_VIDEO - Static variable in annotation type com.facebook.ads.AudienceNetworkAds.AdFormat
 
RewardedVideoAd displays a rewarded video advertisement by Facebook
To use the rewarded video, do the following:
RewardedVideoAd(Context, String) - Constructor for class com.facebook.ads.RewardedVideoAd
Constructs a RewardedVideoAd given the context and the placement id
RewardedVideoAdExtendedListener interface is notified of events in RewardedVideoAd lifecycle.
RewardedVideoAdListener interface is notified of events in RewardedVideoAd lifecycle.
S
S2SRewardedVideoAdExtendedListener interface is notified of events in RewardedVideoAd lifecycle using severside validation
S2SRewardedVideoAdListener interface is notified of events in RewardedVideoAd lifecycle using severside validation
seekTo(int) - Method in class com.facebook.ads.MediaViewVideoRenderer
Set the seek position in milliseconds.
serialVersionUID - Static variable in enum com.facebook.ads.AdSettings.IntegrationErrorMode
 
serialVersionUID - Static variable in enum com.facebook.ads.AdSettings.MultiprocessSupportMode
 
serialVersionUID - Static variable in enum com.facebook.ads.AdSettings.TestAdType
 
serialVersionUID - Static variable in class com.facebook.ads.RewardData
 
SERVER_ERROR - Static variable in class com.facebook.ads.AdError
 
SERVER_ERROR_CODE - Static variable in class com.facebook.ads.AdError
 
setAdListener(AdListener) - Method in class com.facebook.ads.AdView
Sets an AdListener to be notified on events in control lifecycle.
Sets an InstreamVideoAdListener to be notified on events in control lifecycle.
setAdListener(InterstitialAdListener) - Method in class com.facebook.ads.InterstitialAd
Sets an InterstitialAdListener to be notified on events in control lifecycle.
setAdListener(NativeAdListener) - Method in class com.facebook.ads.NativeAdBase
 
setAdListener(RewardedVideoAdListener) - Method in class com.facebook.ads.RewardedVideoAd
Sets an RewardedVideoAdListener to be notified on events in control lifecycle.
setAutoplay(boolean) - Method in class com.facebook.ads.NativeAdViewAttributes
Deprecated.
setAutoplayOnMobile(boolean) - Method in class com.facebook.ads.NativeAdViewAttributes
Deprecated.
setBackgroundColor(int) - Method in class com.facebook.ads.NativeAdViewAttributes
The color that will be used as background for the whole Ad View.
setButtonBorderColor(int) - Method in class com.facebook.ads.NativeAdViewAttributes
The color for the border of the CTA button.
setButtonColor(int) - Method in class com.facebook.ads.NativeAdViewAttributes
The background color of the CTA button.
setButtonTextColor(int) - Method in class com.facebook.ads.NativeAdViewAttributes
The text color of the CTA button.
setDebugBuild(boolean) - Static method in class com.facebook.ads.AdSettings
Puts the SDK in debug mode
setDescriptionTextColor(int) - Method in class com.facebook.ads.NativeAdViewAttributes
The color that will be used for all text fields except the title and the CTA button.
setExtraHints(ExtraHints) - Method in interface com.facebook.ads.Ad
 
setExtraHints(ExtraHints) - Method in class com.facebook.ads.AdView
 
setExtraHints(ExtraHints) - Method in class com.facebook.ads.InstreamVideoAdView
 
setExtraHints(ExtraHints) - Method in class com.facebook.ads.InterstitialAd
 
setExtraHints(ExtraHints) - Method in class com.facebook.ads.NativeAdBase
 
setExtraHints(String) - Method in class com.facebook.ads.NativeAdsManager
 
setExtraHints(ExtraHints) - Method in class com.facebook.ads.RewardedVideoAd
 
setIconColor(int) - Method in class com.facebook.ads.AdOptionsView
Sets the color of the icons.
setIconSizeDp(int) - Method in class com.facebook.ads.AdOptionsView
Sets the size of the icons in dp.
setInset(int) - Method in class com.facebook.ads.NativeAdScrollView
 
Specify behaviour of the SDK when client code has an integration error.
setIsChildDirected(boolean) - Static method in class com.facebook.ads.AdSettings
Sets whether the ad control is targeting a child.
setListener(MediaViewListener) - Method in class com.facebook.ads.MediaView
 
setListener(NativeAdsManager.Listener) - Method in class com.facebook.ads.NativeAdsManager
 
setMaxWidth(int) - Method in class com.facebook.ads.NativeAdLayout
 
setMediationService(String) - Static method in class com.facebook.ads.AdSettings
Sets the name of the mediation service that is mediating Audience Network.
setMinWidth(int) - Method in class com.facebook.ads.NativeAdLayout
 
Specify if the SDK can load and show ads in the separate process.
setNativeAd(NativeAd) - Method in class com.facebook.ads.MediaViewVideoRenderer
Deprecated.
since 5.2
setOnTouchListener(View.OnTouchListener) - Method in class com.facebook.ads.NativeAdBase
Sets an OnTouchListener to be notified of touch events on the ad unit.
setRewardData(RewardData) - Method in class com.facebook.ads.RewardedVideoAd
 
setSingleIcon(boolean) - Method in class com.facebook.ads.AdOptionsView
This view displays the ad choices and ad reporting icons by default.
setTestAdType(AdSettings.TestAdType) - Static method in class com.facebook.ads.AdSettings
 
setTestMode(boolean) - Static method in class com.facebook.ads.AdSettings
Sets whether ad controls are working in test mode.
setTitleTextColor(int) - Method in class com.facebook.ads.NativeAdViewAttributes
The color that will be used for the Ad Title and AdOptionsView.
setTypeface(Typeface) - Method in class com.facebook.ads.NativeAdViewAttributes
Sets the Typeface for all text in the Ad View.
setUrlPrefix(String) - Static method in class com.facebook.ads.AdSettings
Sets the url prefix to use when making requests.
setVideoAutoplay(boolean) - Static method in class com.facebook.ads.AdSettings
Sets the setting for video autoplay
setVideoAutoplayOnMobile(boolean) - Static method in class com.facebook.ads.AdSettings
Sets the setting for video autoplay on mobile networks
setVideoRenderer(MediaViewVideoRenderer) - Method in class com.facebook.ads.MediaView
After creating the MediaView you can change the video renderer implementation to a custom extension of MediaViewVideoRenderer.
setVisibleAnimation(boolean) - Static method in class com.facebook.ads.AdSettings
 
setVolume(float) - Method in class com.facebook.ads.MediaViewVideoRenderer
Set the volume of the video player.
shouldAllowBackgroundPlayback() - Method in class com.facebook.ads.MediaViewVideoRenderer
Whether background video playback should be enabled or not.
 
shouldAutoplay() - Method in class com.facebook.ads.MediaViewVideoRenderer
Returns if the video should autoplay or not.
show() - Method in class com.facebook.ads.InstreamVideoAdView
Shows the Instream video ad
This method should only be called after InstreamVideoAdView.loadAd() is called and the ad listener has been notified ad has loaded
show() - Method in class com.facebook.ads.InterstitialAd
Shows the interstitial ad.
show() - Method in class com.facebook.ads.RewardedVideoAd
Shows the rewarded video ad
This method should only be called after RewardedVideoAd.loadAd() is called and the ad listener has been notified ad has loaded
show(int) - Method in class com.facebook.ads.RewardedVideoAd
Shows the rewarded video ad
This method should only be called after RewardedVideoAd.loadAd() is called and the ad listener has been notified ad has loaded
SHOW_CALLED_BEFORE_LOAD_ERROR - Static variable in class com.facebook.ads.AdError
 
SHOW_CALLED_BEFORE_LOAD_ERROR_CODE - Static variable in class com.facebook.ads.AdError
 
T
TAG - Static variable in class com.facebook.ads.AudienceNetworkAds
 
 
turnOnSDKDebugger(Context) - Static method in class com.facebook.ads.AdSettings
This is a feature in testing not currently supported
U
UNKNOWN - Static variable in annotation type com.facebook.ads.AudienceNetworkAds.AdFormat
 
unregisterView() - Method in class com.facebook.ads.NativeAdBase
 
UNSET_VIDEO_DURATION - Static variable in class com.facebook.ads.RewardedVideoAd
 
unsetNativeAd() - Method in class com.facebook.ads.MediaViewVideoRenderer
Deprecated.
since 5.2
V
valueOf(String) - Static method in enum com.facebook.ads.AdOptionsView.Orientation
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.facebook.ads.AdSettings.IntegrationErrorMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.facebook.ads.AdSettings.MultiprocessSupportMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.facebook.ads.AdSettings.TestAdType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.facebook.ads.CacheFlag
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.facebook.ads.ExtraHints.HintType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.facebook.ads.ExtraHints.Keyword
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.facebook.ads.NativeAd.AdCreativeType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.facebook.ads.NativeAdBase.MediaCacheFlag
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.facebook.ads.NativeAdBase.NativeComponentTag
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.facebook.ads.NativeAdView.Type
Deprecated.
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.facebook.ads.NativeBannerAdView.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.facebook.ads.VideoAutoplayBehavior
Deprecated.
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.facebook.ads.VideoStartReason
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.facebook.ads.AdOptionsView.Orientation
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.facebook.ads.AdSettings.IntegrationErrorMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.facebook.ads.AdSettings.MultiprocessSupportMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.facebook.ads.AdSettings.TestAdType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.facebook.ads.CacheFlag
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.facebook.ads.ExtraHints.HintType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.facebook.ads.ExtraHints.Keyword
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.facebook.ads.NativeAd.AdCreativeType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.facebook.ads.NativeAdBase.MediaCacheFlag
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.facebook.ads.NativeAdBase.NativeComponentTag
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.facebook.ads.NativeAdView.Type
Deprecated.
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.facebook.ads.NativeBannerAdView.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.facebook.ads.VideoAutoplayBehavior
Deprecated.
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.facebook.ads.VideoStartReason
Returns an array containing the constants of this enum type, in the order they are declared.
videoAutoplayBehavior - Variable in class com.facebook.ads.MediaViewVideoRenderer
Deprecated.
Deprecated.
since 5.2
This enum indicates why the video playback was started.
W
An optional listener that will be called as soon as initialization is finished.
Sets the name of the mediation service that is mediating Audience Network.
An optional list of placement ids that are used in this application.
A B C D E F G H I K L M N O P R S T U V W