com.applovin.sdk

Interface AppLovinAdService

public interface AppLovinAdService

This class is responsible for loading and displaying advertisements.

An instance of this class can be obtained from an AppLovinSdk instance via getAdService().

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBidToken() Generates a token used for advanced header bidding.
boolean	hasPreloadedAd(AppLovinAdSize adSize) Deprecated. Manually preloading ads in the background has been deprecated and will be removed in a future SDK version. Please use loadNextAd(AppLovinAdSize, AppLovinAdLoadListener) to load ads to display.
boolean	hasPreloadedAdForZoneId(java.lang.String zoneId) Deprecated. Manually preloading ads in the background has been deprecated and will be removed in a future SDK version. Please use loadNextAdForZoneId(String, AppLovinAdLoadListener) to load ads to display.
void	loadNextAd(AppLovinAdSize adSize, AppLovinAdLoadListener callback) Fetch a new ad, of a given size, notifying a supplied listener on completion.
void	loadNextAdForAdToken(java.lang.String adToken, AppLovinAdLoadListener callback) Fetch a new ad for the given ad token.
void	loadNextAdForZoneId(java.lang.String zoneId, AppLovinAdLoadListener callback) Fetch a new ad, for a given zone, notifying a supplied listener on completion.
void	loadNextAdForZoneIds(java.util.List<java.lang.String> zoneIds, AppLovinAdLoadListener callback) Fetch a new ad for any of the provided zone ids.
void	preloadAd(AppLovinAdSize adSize) Deprecated. Manually preloading ads in the background has been deprecated and will be removed in a future SDK version. Please use loadNextAd(AppLovinAdSize, AppLovinAdLoadListener) to load ads to display.
void	preloadAdForZoneId(java.lang.String zoneId) Deprecated. Manually preloading ads in the background has been deprecated and will be removed in a future SDK version. Please use loadNextAdForZoneId(String, AppLovinAdLoadListener) to load ads to display.

Method Detail

loadNextAd

void loadNextAd(AppLovinAdSize adSize,
                AppLovinAdLoadListener callback)

Fetch a new ad, of a given size, notifying a supplied listener on completion.

Parameters:

adSize - Size of an ad to load. Must not be null.

callback - A callback to notify of the fact that the ad is loaded. Must not be null. A reference to the callback will be persisted until the ad is loaded.

loadNextAdForZoneId

void loadNextAdForZoneId(java.lang.String zoneId,
                         AppLovinAdLoadListener callback)

Fetch a new ad, for a given zone, notifying a supplied listener on completion.

Parameters:

zoneId - The zone to load an ad for. Must not be null.

callback - A callback to notify of the fact that the ad is loaded.

getBidToken

java.lang.String getBidToken()

Generates a token used for advanced header bidding.

loadNextAdForAdToken

void loadNextAdForAdToken(java.lang.String adToken,
                          AppLovinAdLoadListener callback)

Fetch a new ad for the given ad token. Provided ad token must be received from AppLovin S2S API.

Please note: this method is designed to be called by SDK mediation providers. Please use loadNextAdForZoneId(String, AppLovinAdLoadListener) for regular integrations.

Parameters:

adToken - Ad token returned from AppLovin S2S API. Must not be null.

callback - A callback to notify that the ad has been loaded. Must not be null.

loadNextAdForZoneIds

void loadNextAdForZoneIds(java.util.List<java.lang.String> zoneIds,
                          AppLovinAdLoadListener callback)

Fetch a new ad for any of the provided zone ids.

Please note: this method is designed to be called by SDK mediation providers. Please use loadNextAdForZoneId(String, AppLovinAdLoadListener) for regular integrations.

Parameters:

zoneIds - A list of zone identifiers for which an ad should be loaded. Must not be null.

callback - A callback to notify that the ad has been loaded. Must not be null.

preloadAd

@Deprecated
void preloadAd(AppLovinAdSize adSize)

Deprecated. Manually preloading ads in the background has been deprecated and will be removed in a future SDK version. Please use loadNextAd(AppLovinAdSize, AppLovinAdLoadListener) to load ads to display.

preloadAdForZoneId

@Deprecated
void preloadAdForZoneId(java.lang.String zoneId)

Deprecated. Manually preloading ads in the background has been deprecated and will be removed in a future SDK version. Please use loadNextAdForZoneId(String, AppLovinAdLoadListener) to load ads to display.

hasPreloadedAd

@Deprecated
boolean hasPreloadedAd(AppLovinAdSize adSize)

Deprecated. Manually preloading ads in the background has been deprecated and will be removed in a future SDK version. Please use loadNextAd(AppLovinAdSize, AppLovinAdLoadListener) to load ads to display.

hasPreloadedAdForZoneId

@Deprecated
boolean hasPreloadedAdForZoneId(java.lang.String zoneId)

Deprecated. Manually preloading ads in the background has been deprecated and will be removed in a future SDK version. Please use loadNextAdForZoneId(String, AppLovinAdLoadListener) to load ads to display.