Reference (Old Docs)
AdSettings
A more recent version of this class is available. Check out the latest version.

AdSettings contains global settings for all ad controls.

Extends:Object
Package:ads
Constructors
AdSettings()
public AdSettings()
Class Methods
addTestDevice(String)

Adds a test device.

Copy the current device Id from debug log and add it as a test device to get test ads. Apps running on emulator will automatically get test ads. Test devices should be added before Ad.loadAd() is called.

public static void addTestDevice(String deviceIdHash)
ParameterDescription
deviceIdHashId of the device to use test mode, can be obtained from debug log
addTestDevices(Collection)

Adds a collection of test devices.

Copy the current device Id from debug log and add it as a test device to get test ads. Apps running on emulator will automatically get test ads. Test devices should be added before Ad.loadAd() is called.

public static void addTestDevices(Collection deviceIdHashes)
ParameterDescription
deviceIdHashesIds of the device to use test mode, can be obtained from debug log
clearTestDevices()

Clears the collection of test devices.

public static void clearTestDevices()
isTestMode(Context)

Gets whether ad controls are working in test mode.

public static boolean isTestMode(Context context)
ParameterDescription
contextAndroid context
Returns
Whether in test mode
setUrlPrefix(String)

Sets the url prefix to use when making requests. This should never be used in production.

public static void setUrlPrefix(String urlPrefix)
ParameterDescription
urlPrefixUrl prefix
getUrlPrefix()

Gets the url prefix.

public static String getUrlPrefix()
Returns
Url prefix
isVideoAutoplay()

Gets whether video autoplay is enabled

public static boolean isVideoAutoplay()
Returns
True if video autoplay is enabled
setVideoAutoplay(boolean)

Sets whether video autoplay is enabled

public static void setVideoAutoplay(boolean enabled)
ParameterDescription
enabledWhether video autoplay should be enabled
setMediationService(String)

Sets the name of the mediation service that is mediating Audience Network.

If an ad provider service is mediating Audience Network in their sdk, it is required to set the name of the mediation service.

public static void setMediationService(String mediationService)
ParameterDescription
mediationServiceString representing the name of the mediation service that is mediating Audience Network
getMediationService()

Returns the name of the mediation service that is mediating Audience Network

public static String getMediationService()
Returns
String representing the name of the mediation service if there is any
setIsChildDirected(boolean)

Sets whether the ad control is targeting a child.

public static void setIsChildDirected(boolean childDirected)
ParameterDescription
childDirectedWhether the ad control is targeting a child
isChildDirected()

Gets whether the ad control is targeting a child.

public static boolean isChildDirected()
Returns
Whether the ad control is targeting a child
Constants
DEBUG
public static final boolean DEBUG