AATKit (AATKit AATKitAnd

java.lang.Object
- com.intentsoftware.addapptr.AATKit

```
public class AATKit
extends Object
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AATKit.Consent` Used for passing of detailed GDPR consent.
`static interface`	`AATKit.Delegate` Notifies about AATKit events.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BANNER_DEFAULT_RELOAD_INTERVAL_IN_SECONDS`
`static int`	`BANNER_MAX_RELOAD_INTERVAL_IN_SECONDS`
`static int`	`BANNER_MIN_RELOAD_INTERVAL_IN_SECONDS`

Constructor Summary

Constructors
Constructor and Description

AATKit()

Constructors
Constructor and Description
`AATKit()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static void`	`addAdNetworkForKeywordTargeting(AdNetwork network)` Adds an ad network to the list of ad networks that receive targeting keywords (if any set).
`static void`	`attachNativeAdToLayout(NativeAdData nativeAd, ViewGroup layout)` Deprecated. This method is deprecated and will be removed in the future. Please use `attachNativeAdToLayout(NativeAdData, ViewGroup, View, View, View)` instead.
`static void`	`attachNativeAdToLayout(NativeAdData nativeAd, ViewGroup layout, View mainImageView, View iconView)` Deprecated. This method is deprecated and will be removed in the future. Please use `attachNativeAdToLayout(NativeAdData, ViewGroup, View, View, View)` instead.
`static void`	`attachNativeAdToLayout(NativeAdData nativeAd, ViewGroup layout, View mainImageView, View iconView, View CTAView)` Binds the native ad instance with given ViewGroup.
`static BannerPlacement`	`createBannerPlacement(String name, BannerConfiguration configuration)` Creates a new banner placement.
`static int`	`createNativeAdPlacement(String name, boolean supportsMainImage)` Creates a new native ad placement.
`static int`	`createPlacement(String name, PlacementSize size)` Creates placement with given name and size.
`static int`	`createRewardedVideoPlacement(String name)` Creates a new rewarded video placement.
`static int`	`currentlyLoadingNativeAdsOnPlacement(int placementId)` Returns how many ads are currently loading for given native ad placement.
`static void`	`detachNativeAdFromLayout(NativeAdData nativeAd)` Removes the binding between native ad and ViewGroup.
`static void`	`disableDebugScreen()` Disables the debug screen appearing after shaking the device.
`static void`	`enableDebugScreen()` Enables debug screen that will show after shaking the device.
`static void`	`enableTestMode(int testAppId)` Deprecated. use `init(AATKitConfiguration)` with setting the test mode in configuration object instead.
`static Set<BannerSize>`	`fittingBannerSizesLandscape(Context context)` Returns the set of `BannerSize` that will fit on a given device in landscape screen orientation.
`static Set<BannerSize>`	`fittingBannerSizesPortrait(Context context)` Returns the set of `BannerSize` that will fit on a given device in portrait screen orientation.
`static String`	`getDebugInfo()` Used for obtaining debug information (the same that would be presented in dialog after shaking the device if debug screen is enabled)
`static String`	`getFullVersion()`
`static NativeAdData`	`getNativeAd(int placementId)` Returns the instance of native ad for given native ad placement.
`static String`	`getNativeAdAdvertiser(NativeAdData nativeAd)` Returns the advertiser asset of native ad (not the same as ad network providing it).
`static View`	`getNativeAdBrandingLogo(NativeAdData nativeAd)` Returns the view with branding logo or ad information related to the ad network providing the native ad.
`static String`	`getNativeAdCallToAction(NativeAdData nativeAd)` Returns the call to action of native ad.
`static String`	`getNativeAdDescription(NativeAdData nativeAd)` Returns the description of native ad.
`static String`	`getNativeAdIconUrl(NativeAdData nativeAd)` Returns the URL of the icon asset of native ad.
`static String`	`getNativeAdImageUrl(NativeAdData nativeAd)` Returns the URL of the image asset of native ad.
`static AdNetwork`	`getNativeAdNetwork(NativeAdData nativeAd)` Returns the ad network providing given native ad
`static NativeAd.NativeAdRating`	`getNativeAdRating(NativeAdData nativeAd)` Returns the rating asset of native ad.
`static String`	`getNativeAdTitle(NativeAdData nativeAd)` Returns the title of native ad.
`static NativeAd.Type`	`getNativeAdType(NativeAdData nativeAd)` Deprecated. For Google Native Ads, it is now recommended to use the Unified ad type. See our documentation on native ads integration to learn more.
`static String`	`getOption(String optionName)` Get option from AATKit.
`static int`	`getPlacementIdForName(String placementName)` Returns identifier of placement with given name, or -1 if placement with given name does not exist.
`static View`	`getPlacementView(int placementId)` Returns placement view.
`static int`	`getPlacmentIdForName(String placementName)` Deprecated. This method is deprecated and will be removed in the future. Please use `getPlacementIdForName(String)` method instead.
`static String`	`getVersion()`
`static boolean`	`hasAdForPlacement(int placementId)` Returns true if there is an ad loaded for given placementId.
`static void`	`init(AATKitConfiguration configuration)` Initializes the AATKit library.
`static void`	`init(Application application, AATKit.Delegate delegate)` Deprecated. use `init(AATKitConfiguration)` instead.
`static void`	`init(Application application, AATKit.Delegate delegate, boolean enableRuleCaching, String initialRules)` Deprecated. use `init(AATKitConfiguration)` instead.
`static void`	`init(Application application, AATKit.Delegate delegate, int testId)` Deprecated. use `init(AATKitConfiguration)` instead.
`static void`	`initWithoutDebugScreen(Application application, AATKit.Delegate delegate)` Deprecated. use `init(AATKitConfiguration)` instead.
`static boolean`	`isFrequencyCapReachedForNativePlacement(int placementId)` Deprecated. This method is deprecated and will be removed in the future. Please use `isFrequencyCapReachedForPlacement(int)` method instead.
`static boolean`	`isFrequencyCapReachedForPlacement(int placementId)` Checks if desired impression cap (set on AddApptr Dashboard) is reached for given native ad, fullscreen, rewarded video or VAST placement.
`static boolean`	`isNativeAdExpired(NativeAdData nativeAd)` Returns if the native ad has expired and shall no longer be used.
`static boolean`	`isNativeAdReady(NativeAdData nativeAd)` Returns if the native ad is ready to be displayed.
`static boolean`	`isNetworkEnabled(AdNetwork network)` Returns true if ad network is enabled, false otherwise.
`static boolean`	`isOptionEnabled(String optionName)` Convenience method for checking if option is enabled in AATKit.
`static boolean`	`isTablet(Context context)` Checks if AATKit recognizes given device as tablet.
`static PlacementSize`	`maximumBannerSizeLandscape(Context context)` Returns the `PlacementSize` with maximum width that will fit on a given device in landscape screen orientation.
`static PlacementSize`	`maximumBannerSizePortrait(Context context)` Returns the `PlacementSize` with maximum width that will fit on a given device in portrait screen orientation.
`static void`	`onActivityPause(Activity activity)` Notifies AATKit about activity pause.
`static void`	`onActivityResume(Activity activity)` Notifies AATKit about activity resume.
`static void`	`reconfigure(AATKitRuntimeConfiguration configuration)` Allows to reconfigure the options for GDPR consent.
`static boolean`	`reloadPlacement(int placementId)` Requests placement reload.
`static boolean`	`reloadPlacement(int placementId, boolean forceLoad)` Requests placement reload.
`static void`	`removeAdNetworkForKeywordTargeting(AdNetwork network)` Removes an ad network from the list of ad networks that receive targeting keywords (if any set).
`static void`	`reportAdSpaceForNativePlacement(int placementId)` Deprecated. Please use `reportAdSpaceForPlacement(int)` instead.
`static void`	`reportAdSpaceForPlacement(int placementId)` Indicates that the application wants to display a native or VAST ad for given placement.
`static void`	`reportVASTClick(VASTAdData data)` Reports the VAST ad click.
`static void`	`reportVASTImpression(VASTAdData data)` Reports the VAST ad impression.
`static void`	`reportVASTViewableImpression(VASTAdData data)` Reports the VAST ad viewable impression.
`static void`	`setContentTargetingUrl(int placementId, String targetingUrl)` Sets the content targeting url for the given placement.
`static void`	`setContentTargetingUrl(String targetingUrl)` Sets the content targeting url for the application.
`static void`	`setInitialRules(String rules)` Allows setting of ad rules that will be used before real rules from the server are downloaded.
`static void`	`setLogLevel(int logLevel)` Allows to set log level from code.
`static void`	`setNetworkEnabled(AdNetwork network, boolean enabled)` Allows to enable or disable selected ad networks.
`static void`	`setOption(String optionName, String optionValue)` Set option in AATKit.
`static void`	`setPlacementAutoreloadInterval(int placementId, int seconds)` Sets reload time that will be used instead of time configured on addapptr.com account.
`static void`	`setPlacementContentGravity(int placementId, int gravity)` Sets gravity for ads that don't fill entire placement area.
`static void`	`setPlacementDefaultImageBitmap(int placementId, Bitmap image)` Sets placement default image.
`static void`	`setPlacementDefaultImageResource(int placementId, int resId)` Sets placement default image.
`static void`	`setRuleCachingEnabled(boolean enabled)` Allows the AATKit to preserve last downloaded ad rules when the application is closed.
`static void`	`setTargetingInfo(int placementId, Map<String,List<String>> info)` Sets the targeting information for the given placement.
`static void`	`setTargetingInfo(Map<String,List<String>> info)` Sets the targeting information for the application.
`static void`	`setVASTRequestParameters(int placementId, VASTRequestParameters parameters)` Sets VAST ad request parameters.
`static boolean`	`showPlacement(int placementId)` Shows interstitial ad if ad is ready.
`static void`	`startPlacementAutoReload(int placementId)` Enables automatic reloading of placement.
`static void`	`startPlacementAutoReload(int placementId, int seconds)` Enables automatic reloading of placement and sets custom reload time.
`static void`	`stopPlacementAutoReload(int placementId)` Disables automatic reloading of placement.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - BANNER_DEFAULT_RELOAD_INTERVAL_IN_SECONDS
```
public static final int BANNER_DEFAULT_RELOAD_INTERVAL_IN_SECONDS
```
    See Also:
    
    Constant Field Values
  - BANNER_MIN_RELOAD_INTERVAL_IN_SECONDS
```
public static final int BANNER_MIN_RELOAD_INTERVAL_IN_SECONDS
```
    See Also:
    
    Constant Field Values
  - BANNER_MAX_RELOAD_INTERVAL_IN_SECONDS
```
public static final int BANNER_MAX_RELOAD_INTERVAL_IN_SECONDS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AATKit
```
public AATKit()
```
- Method Detail
  - getVersion
```
public static String getVersion()
```
    Returns:
    
    AATKit version.
  - getFullVersion
```
public static String getFullVersion()
```
    Returns:
    
    AATKit detailed build version.
  - init
```
public static void init(AATKitConfiguration configuration)
```
    Initializes the AATKit library. Should be called once during application initialization before any other calls to AATKit.
    
    Parameters:
    
    configuration - Configuration for AATKit.
    
    See Also:
    
    AATKitConfiguration
  - init
```
@Deprecated
public static void init(Application application,
                                    AATKit.Delegate delegate)
```
    Deprecated. use init(AATKitConfiguration) instead.
    
    Initializes the AATKit library. Should be called once during application initialization before any other calls to AATKit.
    
    Parameters:
    
    application - Reference to Application.
    
    delegate - Optional delegate allowing to listen for AATKit events.
    
    See Also:
    
    AATKit.Delegate
  - init
```
@Deprecated
public static void init(Application application,
                                    AATKit.Delegate delegate,
                                    boolean enableRuleCaching,
                                    String initialRules)
```
    Deprecated. use init(AATKitConfiguration) instead.
    
    Initializes the AATKit library. Should be called once during application initialization before any other calls to AATKit.
    
    Parameters:
    
    application - Reference to Application.
    
    delegate - Optional delegate allowing to listen for AATKit events.
    
    enableRuleCaching - Sets if AATKit should preserve last downloaded ad rules when the application is closed.
    
    initialRules - Optional parameter (can be null). Allows to set initial rules that will be used before real config is downloaded from the server.
    
    See Also:
    
    AATKit.Delegate
  - init
```
@Deprecated
public static void init(Application application,
                                    AATKit.Delegate delegate,
                                    int testId)
```
    Deprecated. use init(AATKitConfiguration) instead.
    
    Initializes the AATKit library. Should be called once during application initialization before any other calls to AATKit. It also enables the test ads, and should only be used during development.
    
    Parameters:
    
    application - Reference to Application.
    
    delegate - Optional delegate allowing to listen for AATKit events.
    
    testId - Test application id obtained from addapptr.com account.
  - initWithoutDebugScreen
```
@Deprecated
public static void initWithoutDebugScreen(Application application,
                                                      AATKit.Delegate delegate)
```
    Deprecated. use init(AATKitConfiguration) instead.
    
    Initializes the AATKit library without debug screen appearing after shaking the device (it is enabled by default). It is advised to use the init(Application, Delegate) method instead. Should be called once during application initialization before any other calls to AATKit.
    
    Parameters:
    
    application - Reference to Application.
    
    delegate - Optional delegate allowing to listen for AATKit events.
    
    See Also:
    
    AATKit.Delegate
  - enableTestMode
```
@Deprecated
public static void enableTestMode(int testAppId)
```
    Deprecated. use init(AATKitConfiguration) with setting the test mode in configuration object instead.
    
    Enables AATKit test ads that should be for testing only during development.
    
    Parameters:
    
    testAppId - Test application id obtained from addapptr.com account.
  - enableDebugScreen
```
public static void enableDebugScreen()
```
    Enables debug screen that will show after shaking the device. It is already enabled by default.
  - disableDebugScreen
```
public static void disableDebugScreen()
```
    Disables the debug screen appearing after shaking the device. It is enabled by default.
  - getDebugInfo
```
public static String getDebugInfo()
```
    Used for obtaining debug information (the same that would be presented in dialog after shaking the device if debug screen is enabled)
    
    Returns:
    
    String with debug information
  - reconfigure
```
public static void reconfigure(AATKitRuntimeConfiguration configuration)
```
    Allows to reconfigure the options for GDPR consent.
    
    Parameters:
    
    configuration - New configuration.
  - isTablet
```
public static boolean isTablet(Context context)
```
    Checks if AATKit recognizes given device as tablet.
    
    Parameters:
    
    context - The Context of your application.
    
    Returns:
    
    True if device is recognized as tablet, false otherwise.
  - maximumBannerSizePortrait
```
public static PlacementSize maximumBannerSizePortrait(Context context)
```
    Returns the PlacementSize with maximum width that will fit on a given device in portrait screen orientation.
    
    Parameters:
    
    context - The Context of your application.
    
    Returns:
    
    PlacementSize best fitting current device
  - maximumBannerSizeLandscape
```
public static PlacementSize maximumBannerSizeLandscape(Context context)
```
    Returns the PlacementSize with maximum width that will fit on a given device in landscape screen orientation.
    
    Parameters:
    
    context - The Context of your application.
    
    Returns:
    
    PlacementSize best fitting current device
  - fittingBannerSizesPortrait
```
public static Set<BannerSize> fittingBannerSizesPortrait(Context context)
```
    Returns the set of BannerSize that will fit on a given device in portrait screen orientation.
    
    Parameters:
    
    context - The Context of your application.
    
    Returns:
    
    Set of BannerSize fitting current device
  - fittingBannerSizesLandscape
```
public static Set<BannerSize> fittingBannerSizesLandscape(Context context)
```
    Returns the set of BannerSize that will fit on a given device in landscape screen orientation.
    
    Parameters:
    
    context - The Context of your application.
    
    Returns:
    
    Set of BannerSize fitting current device
  - onActivityResume
```
public static void onActivityResume(Activity activity)
```
    Notifies AATKit about activity resume. Invoke this method in every activity that uses AATKit.
    
    Parameters:
    
    activity - Reference to Activity.
  - onActivityPause
```
public static void onActivityPause(Activity activity)
```
    Notifies AATKit about activity pause. Invoke this method in every activity that uses AATKit.
    
    Parameters:
    
    activity - Reference to Activity.
  - createPlacement
```
public static int createPlacement(String name,
                                  PlacementSize size)
```
    Creates placement with given name and size. If the placement of given name and size already exists, it will be returned.
    
    Parameters:
    
    name - Unique name of placement. The same name will be used in addapptr.com account.
    
    size - Size of placement. Use PlacementSize.Fullscreen for interstitials, PlacementSize.Native for native ads and other sizes for banner ads.
    
    Returns:
    
    Placement identifier, or -1 if placement cannot be created.
  - createNativeAdPlacement
```
public static int createNativeAdPlacement(String name,
                                          boolean supportsMainImage)
```
    Creates a new native ad placement. If the native ad placement of given name already exists, it will be returned.
    
    Parameters:
    
    name - Unique name of placement. The same name will be used in addapptr.com account.
    
    supportsMainImage - True if the native ads returned should have main image asset. Keep in mind that if main image is used, it has to be displayed.
    
    Returns:
    
    Placement identifier, or -1 if placement cannot be created.
  - createBannerPlacement
```
public static BannerPlacement createBannerPlacement(String name,
                                                    BannerConfiguration configuration)
```
    Creates a new banner placement. If the banner placement of given name already exists, it will be returned.
    The placement will create a copy of the configuration. Any changes made to the configuration after placement is created will be ignored.
    
    Parameters:
    
    name - Unique name of placement. The same name will be used in addapptr.com account.
    
    configuration - The configuration for this placement. The placement will ignore any changes made to configuration after it was created.
    
    Returns:
    
    Banner placement instance, or null if the placement cannot be created.
  - createRewardedVideoPlacement
```
public static int createRewardedVideoPlacement(String name)
```
    Creates a new rewarded video placement. If the rewarded video ad placement of given name already exists, it will be returned. Only one Rewarded Video placement can be used within the app.
    
    Parameters:
    
    name - Unique name of placement. The same name will be used in addapptr.com account.
    
    Returns:
    
    Placement identifier, or -1 if placement cannot be created.
  - startPlacementAutoReload
```
public static void startPlacementAutoReload(int placementId)
```
    Enables automatic reloading of placement. Autoreloader will use reload time configured on addapptr.com account or fallback to default 30 seconds.
    
    Parameters:
    
    placementId - Placement identifier obtained from createPlacement(String, PlacementSize).
  - startPlacementAutoReload
```
public static void startPlacementAutoReload(int placementId,
                                            int seconds)
```
    Enables automatic reloading of placement and sets custom reload time. This reload time will be used instead of time configured on addapptr.com account.
    
    Parameters:
    
    placementId - Placement identifier obtained from createPlacement(String, PlacementSize).
    
    seconds - Interval between ad reloads. Should be a value from 30 to 600 seconds.
  - stopPlacementAutoReload
```
public static void stopPlacementAutoReload(int placementId)
```
    Disables automatic reloading of placement.
    
    Parameters:
    
    placementId - Placement identifier obtained from createPlacement(String, PlacementSize).
  - setPlacementAutoreloadInterval
```
public static void setPlacementAutoreloadInterval(int placementId,
                                                  int seconds)
```
    Sets reload time that will be used instead of time configured on addapptr.com account.
    
    Parameters:
    
    placementId - Placement identifier obtained from createPlacement(String, PlacementSize).
    
    seconds - Interval between ad reloads. Should be a value from 30 to 600 seconds.
  - reloadPlacement
```
public static boolean reloadPlacement(int placementId)
```
    Requests placement reload. Works only if automatic reloading is disabled. For native ads, it might return false if current limit for native ads loading in parallel is reached.
    For banners it will not cause new banner to show more often than set banner refresh interval (default: 30s) - instead, it will set a timer to reload and show next ad when the refresh interval passes. To force ad reload and display before this delay, use the method reloadPlacement(int, boolean) instead.
    
    Parameters:
    
    placementId - Placement identifier obtained from createPlacement(String, PlacementSize).
    
    Returns:
    
    True if call ends in causing a placement to reload, false otherwise.
    
    See Also:
    
    reloadPlacement(int, boolean)
  - reloadPlacement
```
public static boolean reloadPlacement(int placementId,
                                      boolean forceLoad)
```
    Requests placement reload. Works only if automatic reloading is disabled. For native ads, it might return false if current limit for native ads loading in parallel is reached.
    
    Parameters:
    
    placementId - Placement identifier obtained from createPlacement(String, PlacementSize).
    
    forceLoad - True if you want to be able to reload and show new banner before set banner reload interval (default: 30s) between reloads, false otherwise.
    
    Returns:
    
    True if call ends in causing a placement to reload, false otherwise.
    
    See Also:
    
    reloadPlacement(int)
  - getPlacementView
```
public static View getPlacementView(int placementId)
```
    Returns placement view. Works only for banner placements.
    
    Parameters:
    
    placementId - Placement identifier obtained from createPlacement(String, PlacementSize).
    
    Returns:
    
    Placement view or null if placementId is not valid.
  - attachNativeAdToLayout
```
@Deprecated
public static void attachNativeAdToLayout(NativeAdData nativeAd,
                                                      ViewGroup layout)
```
    Deprecated. This method is deprecated and will be removed in the future. Please use attachNativeAdToLayout(NativeAdData, ViewGroup, View, View, View) instead.
    
    Binds the native ad instance with given ViewGroup. Needed for click handling and tracking. Please note that this method will not work correctly with Facebook Audience Network ads.
    
    Parameters:
    
    nativeAd - Native ad instance.
    
    layout - ViewGroup used to render the native ad.
  - attachNativeAdToLayout
```
@Deprecated
public static void attachNativeAdToLayout(NativeAdData nativeAd,
                                                      ViewGroup layout,
                                                      View mainImageView,
                                                      View iconView)
```
    Deprecated. This method is deprecated and will be removed in the future. Please use attachNativeAdToLayout(NativeAdData, ViewGroup, View, View, View) instead.
    
    Binds the native ad instance with given ViewGroup. Needed for click handling and tracking.
    
    Parameters:
    
    nativeAd - Native ad instance.
    
    layout - ViewGroup used to render the native ad.
    
    mainImageView - View used to show the main image of the ad. Can be null.
    
    iconView - View used to show the icon of the native ad.
  - attachNativeAdToLayout
```
public static void attachNativeAdToLayout(NativeAdData nativeAd,
                                          ViewGroup layout,
                                          View mainImageView,
                                          View iconView,
                                          View CTAView)
```
    Binds the native ad instance with given ViewGroup. Needed for click handling and tracking.
    
    Parameters:
    
    nativeAd - Native ad instance.
    
    layout - ViewGroup used to render the native ad.
    
    mainImageView - View used to show the main image of the ad. Can be null.
    
    iconView - View used to show the icon of the native ad.
    
    CTAView - View used to show the Call To Action of the native ad. Can be null.
  - detachNativeAdFromLayout
```
public static void detachNativeAdFromLayout(NativeAdData nativeAd)
```
    Removes the binding between native ad and ViewGroup. Should be called when the native ad will no longer be presented and should be destroyed.
    
    Parameters:
    
    nativeAd - Native ad instance.
  - getNativeAdTitle
```
public static String getNativeAdTitle(NativeAdData nativeAd)
```
    Returns the title of native ad.
    
    Parameters:
    
    nativeAd - Native ad instance.
    
    Returns:
    
    String with title asset of the ad, or null if it is not available.
  - getNativeAdDescription
```
public static String getNativeAdDescription(NativeAdData nativeAd)
```
    Returns the description of native ad.
    
    Parameters:
    
    nativeAd - Native ad instance.
    
    Returns:
    
    String with description asset of the ad, or null if it is not available.
  - getNativeAdCallToAction
```
public static String getNativeAdCallToAction(NativeAdData nativeAd)
```
    Returns the call to action of native ad.
    
    Parameters:
    
    nativeAd - Native ad instance.
    
    Returns:
    
    String with call to action asset of the ad, or null if it is not available.
  - getNativeAdImageUrl
```
public static String getNativeAdImageUrl(NativeAdData nativeAd)
```
    Returns the URL of the image asset of native ad.
    
    Parameters:
    
    nativeAd - Native ad instance.
    
    Returns:
    
    String with URL of the image asset of the ad, or null if it is not available.
  - getNativeAdIconUrl
```
public static String getNativeAdIconUrl(NativeAdData nativeAd)
```
    Returns the URL of the icon asset of native ad.
    
    Parameters:
    
    nativeAd - Native ad instance.
    
    Returns:
    
    String with URL of the icon asset of the ad, or null if it is not available.
  - getNativeAdRating
```
public static NativeAd.NativeAdRating getNativeAdRating(NativeAdData nativeAd)
```
    Returns the rating asset of native ad.
    
    Parameters:
    
    nativeAd - Native ad instance.
    
    Returns:
    
    NativeAdRating instance containing both value and scale of rating, or null if it is not available.
  - getNativeAdBrandingLogo
```
public static View getNativeAdBrandingLogo(NativeAdData nativeAd)
```
    Returns the view with branding logo or ad information related to the ad network providing the native ad. Some networks like Facebook Audience Network require this special view to be visible on native ads.
    
    Parameters:
    
    nativeAd - Native ad insance.
    
    Returns:
    
    View that should be added to native ad layout, or null if it is not available.
  - getNativeAdAdvertiser
```
public static String getNativeAdAdvertiser(NativeAdData nativeAd)
```
    Returns the advertiser asset of native ad (not the same as ad network providing it).
    
    Parameters:
    
    nativeAd - Native ad instance.
    
    Returns:
    
    String with advertiser asset of the ad, or null if it is not available.
  - getNativeAdType
```
@Deprecated
public static NativeAd.Type getNativeAdType(NativeAdData nativeAd)
```
    Deprecated. For Google Native Ads, it is now recommended to use the Unified ad type. See our documentation on native ads integration to learn more.
    
    Returns the type of native ad. Only some networks support this, default value is NativeAd.Type.UNKNOWN
    
    Parameters:
    
    nativeAd - Native ad instance.
    
    Returns:
    
    Enum value representing the type of given native ad.
  - getNativeAdNetwork
```
public static AdNetwork getNativeAdNetwork(NativeAdData nativeAd)
```
    Returns the ad network providing given native ad
    
    Parameters:
    
    nativeAd - Native ad instance.
    
    Returns:
    
    Enum value representing the ad network providing the ad.
  - isNativeAdExpired
```
public static boolean isNativeAdExpired(NativeAdData nativeAd)
```
    Returns if the native ad has expired and shall no longer be used.
    
    Parameters:
    
    nativeAd - Native ad instance.
    
    Returns:
    
    True if native ad has expired, false otherwise.
  - isNativeAdReady
```
public static boolean isNativeAdReady(NativeAdData nativeAd)
```
    Returns if the native ad is ready to be displayed.
    
    Parameters:
    
    nativeAd - Native ad instance.
    
    Returns:
    
    True if native ad is ready, false otherwise.
  - reportAdSpaceForNativePlacement
```
@Deprecated
public static void reportAdSpaceForNativePlacement(int placementId)
```
    Deprecated. Please use reportAdSpaceForPlacement(int) instead.
    
    Indicates that the application wants to display a native ad for given native ad placement. Used in reporting.
    
    Parameters:
    
    placementId - Placement identifier obtained from createPlacement(String, PlacementSize).
  - reportAdSpaceForPlacement
```
public static void reportAdSpaceForPlacement(int placementId)
```
    Indicates that the application wants to display a native or VAST ad for given placement. Used in reporting.
    
    Parameters:
    
    placementId - Placement identifier obtained from createPlacement(String, PlacementSize).
  - currentlyLoadingNativeAdsOnPlacement
```
public static int currentlyLoadingNativeAdsOnPlacement(int placementId)
```
    Returns how many ads are currently loading for given native ad placement.
    
    Parameters:
    
    placementId - Placement identifier obtained from createPlacement(String, PlacementSize).
    
    Returns:
    
    Number of ads that are currently loading for given placement.
  - isFrequencyCapReachedForNativePlacement
```
@Deprecated
public static boolean isFrequencyCapReachedForNativePlacement(int placementId)
```
    Deprecated. This method is deprecated and will be removed in the future. Please use isFrequencyCapReachedForPlacement(int) method instead.
    
    Checks if desired impression cap (set on AddApptr Dashboard) is reached for given native ad placement.
    
    Parameters:
    
    placementId - Placement identifier obtained from createPlacement(String, PlacementSize).
    
    Returns:
    
    True if impression cap is reached for this placement, false otherwise.
  - isFrequencyCapReachedForPlacement
```
public static boolean isFrequencyCapReachedForPlacement(int placementId)
```
    Checks if desired impression cap (set on AddApptr Dashboard) is reached for given native ad, fullscreen, rewarded video or VAST placement. Note: this method will ALWAYS return "false" for other placement types.
    
    Parameters:
    
    placementId - Placement identifier obtained from createPlacement(String, PlacementSize).
    
    Returns:
    
    True if impression cap is reached for given placement, false otherwise.
  - getNativeAd
```
public static NativeAdData getNativeAd(int placementId)
```
    Returns the instance of native ad for given native ad placement.
    
    Parameters:
    
    placementId - Placement identifier obtained from createPlacement(String, PlacementSize).
    
    Returns:
    
    Native ad instance if it is loaded for given placement, null otherwise.
  - getPlacmentIdForName
```
@Deprecated
public static int getPlacmentIdForName(String placementName)
```
    Deprecated. This method is deprecated and will be removed in the future. Please use getPlacementIdForName(String) method instead.
    
    Returns identifier of placement with given name, or -1 if placement with given name does not exist.
    
    Parameters:
    
    placementName - Placent name, used when creating placement with createPlacement(String, PlacementSize) method.
    
    Returns:
    
    Placement identifier, or -1 if placement does not exist.
  - getPlacementIdForName
```
public static int getPlacementIdForName(String placementName)
```
    Returns identifier of placement with given name, or -1 if placement with given name does not exist.
    
    Parameters:
    
    placementName - Placent name, used when creating placement with createPlacement(String, PlacementSize) method.
    
    Returns:
    
    Placement identifier, or -1 if placement does not exist.
  - hasAdForPlacement
```
public static boolean hasAdForPlacement(int placementId)
```
    Returns true if there is an ad loaded for given placementId.
    
    Parameters:
    
    placementId - Placement identifier obtained from createPlacement(String, PlacementSize).
    
    Returns:
    
    True if there is an ad loaded for given placementId.
  - showPlacement
```
public static boolean showPlacement(int placementId)
```
    Shows interstitial ad if ad is ready.
    
    Parameters:
    
    placementId - Placement identifier obtained from createPlacement(String, PlacementSize).
    
    Returns:
    
    True if showing interstitial was successful, false otherwise.
  - setNetworkEnabled
```
public static void setNetworkEnabled(AdNetwork network,
                                     boolean enabled)
```
    Allows to enable or disable selected ad networks. By default all networks are enabled.
    
    Parameters:
    
    network - Ad network.
    
    enabled - True to enable, false to disable.
  - isNetworkEnabled
```
public static boolean isNetworkEnabled(AdNetwork network)
```
    Returns true if ad network is enabled, false otherwise.
    
    Parameters:
    
    network - Ad network.
    
    Returns:
    
    True if ad network is enabled, false otherwise.
  - setPlacementDefaultImageBitmap
```
public static void setPlacementDefaultImageBitmap(int placementId,
                                                  Bitmap image)
```
    Sets placement default image. This image will be shown in placement when no ad is available.
    
    Parameters:
    
    placementId - Placement identifier obtained from createPlacement(String, PlacementSize).
    
    image - The bitmap to set.
  - setPlacementDefaultImageResource
```
public static void setPlacementDefaultImageResource(int placementId,
                                                    int resId)
```
    Sets placement default image. This image will be shown in placement when no ad is available.
    
    Parameters:
    
    placementId - Placement identifier obtained from createPlacement(String, PlacementSize).
    
    resId - The identifier of the resource.
  - getOption
```
public static String getOption(String optionName)
```
    Get option from AATKit. Options can be obtained from the server or set using the setOption(String, String) method.
    
    Parameters:
    
    optionName - The name of the option to be checked.
    
    Returns:
    
    Value of the option or null if it is not set.
  - isOptionEnabled
```
public static boolean isOptionEnabled(String optionName)
```
    Convenience method for checking if option is enabled in AATKit. Options can be obtained from the server or set using the setOption(String, String) method.
    
    Parameters:
    
    optionName - The name of the option to be checked.
    
    Returns:
    
    True if option value is "Yes", false otherwise.
  - setOption
```
public static void setOption(String optionName,
                             String optionValue)
```
    Set option in AATKit. Options can also be obtained from the server.
    
    Parameters:
    
    optionName - The name of the option to be set.
    
    optionValue - The value of the option to be set.
  - setTargetingInfo
```
public static void setTargetingInfo(Map<String,List<String>> info)
```
    Sets the targeting information for the application. This information will be used only if no placement-specific targeting is available.
    
    Parameters:
    
    info - Map with targeting information
    
    See Also:
    
    setTargetingInfo(int, Map)
  - setTargetingInfo
```
public static void setTargetingInfo(int placementId,
                                    Map<String,List<String>> info)
```
    Sets the targeting information for the given placement. Information provided for placement overrides targeting information for application set by the setTargetingInfo(Map).
    
    Parameters:
    
    placementId - Placement identifier obtained from createPlacement(String, PlacementSize).
    
    info - Map with targeting information
  - setContentTargetingUrl
```
public static void setContentTargetingUrl(String targetingUrl)
```
    Sets the content targeting url for the application. This information will be used only if no placement-specific targeting is available.
    
    Parameters:
    
    targetingUrl - The targeting url
    
    See Also:
    
    setContentTargetingUrl(int, String)
  - setContentTargetingUrl
```
public static void setContentTargetingUrl(int placementId,
                                          String targetingUrl)
```
    Sets the content targeting url for the given placement. Information provided for placement overrides targeting information for application set by the setContentTargetingUrl(String).
    
    Parameters:
    
    placementId - Placement identifier obtained from createPlacement(String, PlacementSize).
    
    targetingUrl - The targeting url
  - addAdNetworkForKeywordTargeting
```
public static void addAdNetworkForKeywordTargeting(AdNetwork network)
```
    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.
    
    Parameters:
    
    network - Chosen ad network.
  - removeAdNetworkForKeywordTargeting
```
public static void removeAdNetworkForKeywordTargeting(AdNetwork network)
```
    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.
    
    Parameters:
    
    network - Chosen ad network.
  - setPlacementContentGravity
```
public static void setPlacementContentGravity(int placementId,
                                              int gravity)
```
    Sets gravity for ads that don't fill entire placement area. Works only for banner placements.
    
    Parameters:
    
    placementId - Placement identifier obtained from createPlacement(String, PlacementSize).
    
    gravity - The Gravity to set.
  - setInitialRules
```
public static void setInitialRules(String rules)
```
    Allows setting of ad rules that will be used before real rules from the server are downloaded.
    
    Parameters:
    
    rules - String containing the rules to be used.
  - setRuleCachingEnabled
```
public static void setRuleCachingEnabled(boolean enabled)
```
    Allows the AATKit to preserve last downloaded ad rules when the application is closed. Such rules will be re-used next time the application is started, before new ones get downloaded.
    
    Parameters:
    
    enabled - True to enable, false to disable.
  - setLogLevel
```
public static void setLogLevel(int logLevel)
```
    Allows to set log level from code.
    
    Parameters:
    
    logLevel - Desired log level, as in Log class.
  - reportVASTImpression
```
public static void reportVASTImpression(VASTAdData data)
```
    Reports the VAST ad impression.
    
    Parameters:
    
    data - The data for a VAST ad which has been impressed.
  - reportVASTViewableImpression
```
public static void reportVASTViewableImpression(VASTAdData data)
```
    Reports the VAST ad viewable impression.
    
    Parameters:
    
    data - The VAST ad data for which the viewable impression should be counted.
  - reportVASTClick
```
public static void reportVASTClick(VASTAdData data)
```
    Reports the VAST ad click.
    
    Parameters:
    
    data - The data for a VAST ad which has been clicked.
  - setVASTRequestParameters
```
public static void setVASTRequestParameters(int placementId,
                                            VASTRequestParameters parameters)
```
    Sets VAST ad request parameters.
    
    Parameters:
    
    placementId - Placement identifier obtained from createPlacement(String, PlacementSize).
    
    parameters - Parameters to set for a given placement identifier.

Class AATKit

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BANNER_DEFAULT_RELOAD_INTERVAL_IN_SECONDS

BANNER_MIN_RELOAD_INTERVAL_IN_SECONDS

BANNER_MAX_RELOAD_INTERVAL_IN_SECONDS

Constructor Detail

AATKit

Method Detail

getVersion

getFullVersion

init

init

init

init

initWithoutDebugScreen

enableTestMode

enableDebugScreen

disableDebugScreen

getDebugInfo

reconfigure

isTablet

maximumBannerSizePortrait

maximumBannerSizeLandscape

fittingBannerSizesPortrait

fittingBannerSizesLandscape

onActivityResume

onActivityPause

createPlacement

createNativeAdPlacement

createBannerPlacement

createRewardedVideoPlacement

startPlacementAutoReload

startPlacementAutoReload

stopPlacementAutoReload

setPlacementAutoreloadInterval

reloadPlacement

reloadPlacement

getPlacementView

attachNativeAdToLayout

attachNativeAdToLayout

attachNativeAdToLayout

detachNativeAdFromLayout

getNativeAdTitle

getNativeAdDescription

getNativeAdCallToAction

getNativeAdImageUrl

getNativeAdIconUrl

getNativeAdRating

getNativeAdBrandingLogo

getNativeAdAdvertiser

getNativeAdType

getNativeAdNetwork

isNativeAdExpired

isNativeAdReady

reportAdSpaceForNativePlacement

reportAdSpaceForPlacement

currentlyLoadingNativeAdsOnPlacement

isFrequencyCapReachedForNativePlacement

isFrequencyCapReachedForPlacement

getNativeAd

getPlacmentIdForName

getPlacementIdForName

hasAdForPlacement

showPlacement

setNetworkEnabled

isNetworkEnabled

setPlacementDefaultImageBitmap

setPlacementDefaultImageResource

getOption

isOptionEnabled

setOption

setTargetingInfo

setTargetingInfo

setContentTargetingUrl

setContentTargetingUrl