com.amazon.device.ads

Class AdRegistration

java.lang.Object

com.amazon.device.ads.AdRegistration

public final class AdRegistration
extends java.lang.Object

This class provides access to global settings and variables. This class cannot be instantiated.

Method Summary

Methods

Modifier and Type	Method and Description
static void	enableLogging(boolean enable) Enable writing LogCat messages during integration and testing of the Amazon Mobile Ads API.
static void	enableTesting(boolean enable) During integration and testing of the Amazon Mobile Ads API, you should indicate all ad requests are for testing.
static java.lang.String	getVersion() Gets the current version of the Amazon Mobile Ads API.
static void	registerApp(android.content.Context context) Register your app to track app downloads from mobile ad campaigns.
static void	setAppKey(java.lang.String appKey) Sets the Application Key to identify your application in a AdLayout.loadAd(AdTargetingOptions) call.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setAppKey

public static final void setAppKey(java.lang.String appKey)
                            throws java.lang.IllegalArgumentException

Sets the Application Key to identify your application in a AdLayout.loadAd(AdTargetingOptions) call.

You must set your app's App Key in order to receive ads. This allows Amazon to track your impressions and clicks, and associate them with your account. Your app must set this value prior to calling AdLayout.loadAd(AdTargetingOptions). You could add this call to your Activity's onCreate function, or some other app initialization code.

Parameters:

appKey - The Amazon Appstore Application Key.

Throws:

java.lang.IllegalArgumentException - Thrown if the App Key is empty or null.

enableLogging

public static final void enableLogging(boolean enable)

Enable writing LogCat messages during integration and testing of the Amazon Mobile Ads API.

Parameters:

enable - Whether to enable logging.

enableTesting

public static final void enableTesting(boolean enable)

During integration and testing of the Amazon Mobile Ads API, you should indicate all ad requests are for testing. Test requests will not show up in your metrics. Test requests that aren't flagged as tests can result in blocked requests, fraud investigation and potential account termination.

Parameters:

enable - Set to true to flag all requests as test requests, and set to false to flag all requests as production requests.

getVersion

public static final java.lang.String getVersion()

Gets the current version of the Amazon Mobile Ads API.

Returns:

The current version of the Amazon Mobile Ads API.

registerApp

public static final void registerApp(android.content.Context context)

Register your app to track app downloads from mobile ad campaigns. To add app download conversion tracking to your app, add the setAppKey(String) and the com.amazon.device.ads.AdRegistration#registerApp(Activity) to your app's initialization code, e.g. your Activity's onCreate method.

Note: Calling AdLayout.loadAd(AdTargetingOptions) automatically registers your app. Only call this method if you are not using the Amazon Mobile Ads API to display ads, but to track app downloads from mobile ad campaigns. The com.amazon.device.ads.AdRegistration#registerApp(Activity) method creates an AsyncTask to send your App Key and hashed device IDs to the Amazon Mobile Ad Network. Calling this method will not block any UI process or affect user interaction with your app.

Parameters:

context - The Context for retrieving context-sensitive data.