AATKit

object AATKit

Types

Link copied to clipboard

Defines possible positions for AdChoices icon for Google native ads.

Link copied to clipboard
interface Delegate

Notifies about AATKit events.

Link copied to clipboard

Notifies about placement reporting events, like counted adspace, request etc.

Properties

Link copied to clipboard

Used for obtaining debug information (the same that would be presented in dialog after shaking the device if debug screen is enabled)

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard

Adds an ad network to the list of ad networks that receive targeting keywords (if any set). If no ad networks are added, any set keywords will be delivered to all ad networks supporting keyword targeting.

Link copied to clipboard

Used to configure the debug screen presentation

Link copied to clipboard

Creates a new App Open Ad placement. If the App Open Ad placement of given name already exists, it will be returned.

Link copied to clipboard

Creates a new automatically loading banner placement. If the banner placement of given name and size already exists, it will be returned.

Link copied to clipboard

Creates a new automatically loading multisize banner placement. If the banner placement of given name already exists, it will be returned.

Link copied to clipboard

Creates a cache of automatically preloaded banner ads. The cache will always try to have a defined amount of banners available for immediate handout to the app whenever they are needed. The BannerCache needs to be destroyed when no longer needed.

Link copied to clipboard

Creates a new fullscreen placement. If the fullscreen placement of given name already exists, it will be returned.

Link copied to clipboard

Creates a new infeed banner placement. If the banner placement of given name already exists, it will be returned.

Link copied to clipboard

Creates a new native ad placement. If the native ad placement of given name already exists, it will be returned.

Link copied to clipboard

Creates a new rewarded video placement. If the rewarded video ad placement of given name already exists, it will be returned.

Link copied to clipboard
Link copied to clipboard

Disables the debug screen appearing after shaking the device. It is enabled by default.

Link copied to clipboard

Enables debug screen that will show after shaking the device. It is already enabled by default.

Link copied to clipboard

Returns the set of BannerSize that will fit on a given device in landscape screen orientation.

Link copied to clipboard

Returns the set of BannerSize that will fit on a given device in portrait screen orientation.

Link copied to clipboard
fun getDebugInfoObject(): AATKitDebugInfo?

Used for obtaining debug information (the same that would be presented in dialog after shaking the device if debug screen is enabled)

Link copied to clipboard

Returns the log level used by AATKit. Note that the used log level does not have to come from setLogLevel, as it can also be influenced by server configs and adb shell setprop method.

Link copied to clipboard
fun getOption(optionName: String): String?

Get option from AATKit. Options can be obtained from the server or set using the setOption method.

Link copied to clipboard
fun init(configuration: AATKitConfiguration)

Initializes the AATKit library. Should be called once during application initialization before any other calls to AATKit.

Link copied to clipboard

Checks if consent is of opt-in type (like GDPR) or not

Link copied to clipboard

Returns true if ad network is enabled, false otherwise.

Link copied to clipboard

Convenience method for checking if option is enabled in AATKit. Options can be obtained from the server or set using the setOption method.

Link copied to clipboard

Checks if AATKit recognizes given device as tablet.

Link copied to clipboard

Returns the BannerPlacementSize with maximum width that will fit on a given device in landscape screen orientation.

Link copied to clipboard

Returns the BannerPlacementSize with maximum width that will fit on a given device in portrait screen orientation.

Link copied to clipboard

Allows to mute video ads.

Link copied to clipboard

Notifies AATKit about activity pause. Invoke this method in every activity that uses AATKit.

Link copied to clipboard

Notifies AATKit about activity resume. Invoke this method in every activity that uses AATKit.

Link copied to clipboard

Allows to reconfigure the options for GDPR consent.

Link copied to clipboard

Removes an ad network from the list of ad networks that receive targeting keywords (if any set). If no ad networks are added to the list, any set keywords will be delivered to all ad networks supporting keyword targeting.

Link copied to clipboard

Allows to set the desired position of AdChoices icon in Google native ads. Set null to use the ad network's default.

Link copied to clipboard

Sets the content targeting url for the application. This information will be used only if no placement-specific targeting is available.

Link copied to clipboard

Sets custom targeting key used for DFP Bidding.

Link copied to clipboard

Sets custom targeting values used for DFP Bidding.

Link copied to clipboard
fun setIsChildDirected(isChildDirected: Boolean)

Allows to set if app should be treated as child-directed.

Link copied to clipboard
fun setLogLevel(logLevel: Int)

Allows to set log level from code.

Link copied to clipboard

Allows to enable or disable selected ad networks. By default all networks are enabled.

Link copied to clipboard
fun setOption(optionName: String, optionValue: String)

Set option in AATKit. Options can also be obtained from the server.

Link copied to clipboard

Sets the targeting information for the application. This information will be used only if no placement-specific targeting is available.

Link copied to clipboard

Sets the user targeting information for the application.

Link copied to clipboard

Shows AATKit debug screen.