com.amazon.device.ads

Class AdTargetingOptions

java.lang.Object

com.amazon.device.ads.AdTargetingOptions

public class AdTargetingOptions
extends java.lang.Object

The configurable ad targeting options for each ad request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AdTargetingOptions.Gender If your app collects gender information from the user, then you can pass that information to the Amazon Mobile Ad Network.

Constructor Summary

Constructors

Constructor and Description
AdTargetingOptions() Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsAdvancedOption(java.lang.String key) Returns whether an advanced option has been set.
AdTargetingOptions	enableGeoLocation(boolean enable) If your app or the device is enabled to provide the latitude and longitude coordinates, you can allow the Amazon Mobile Ads API to send these values to the Amazon Mobile Ad Network.
java.lang.String	getAdvancedOption(java.lang.String key) Gets the value of an advanced option.
int	getAge() Gets the current value of the age option.
AdTargetingOptions.Gender	getGender() Gets the current value of the gender option.
boolean	isGeoLocationEnabled() Returns the current value of the use geo-location option.
AdTargetingOptions	setAdvancedOption(java.lang.String key, java.lang.String value) Sets advanced options using String key/value pairs.
AdTargetingOptions	setAge(int age) If your app collects age information from the user, then you can pass that information to the Amazon Mobile Ad Network.
AdTargetingOptions	setGender(AdTargetingOptions.Gender gender) If your app collects gender information from the user, then you can pass that information to the Amazon Mobile Ad Network.

Methods inherited from class java.lang.Object

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

Constructor Detail

AdTargetingOptions

public AdTargetingOptions()

Creates a new instance.

Method Detail

enableGeoLocation

public AdTargetingOptions enableGeoLocation(boolean enable)

If your app or the device is enabled to provide the latitude and longitude coordinates, you can allow the Amazon Mobile Ads API to send these values to the Amazon Mobile Ad Network. Requests that contain geographic location may earn higher CPMs.

Your app must include permissions for ACCESS_FINE_LOCATION and ACCESS_COARSE_LOCATION to utilize latitude and longitude coordinates.

Parameters:

enable - Whether to use latitude and longitude information when requesting ads.

Returns:

The current instance of AdTargetingOptions.

isGeoLocationEnabled

public boolean isGeoLocationEnabled()

Returns the current value of the use geo-location option.

Returns:

The current value of the use geo-location option.

setGender

public AdTargetingOptions setGender(AdTargetingOptions.Gender gender)

If your app collects gender information from the user, then you can pass that information to the Amazon Mobile Ad Network. Requests that contain gender information may earn higher CPMs.

Parameters:

gender - The user's gender.

Returns:

The current instance of AdTargetingOptions.

getGender

public AdTargetingOptions.Gender getGender()

Gets the current value of the gender option.

Returns:

The current value of the gender option.

setAge

public AdTargetingOptions setAge(int age)

If your app collects age information from the user, then you can pass that information to the Amazon Mobile Ad Network. Requests that contain age information may earn higher CPMs. The age option contains an exact number for the age. If you have age ranges, we recommend using the average age of each range.

Parameters:

age - The user's age.

Returns:

The current instance of AdTargetingOptions.

getAge

public int getAge()

Gets the current value of the age option.

Returns:

The current value of the age option.

setAdvancedOption

public AdTargetingOptions setAdvancedOption(java.lang.String key,
                                   java.lang.String value)

Sets advanced options using String key/value pairs. The advanced options currently are:

'ec' - When making AdLayout.loadAd(AdTargetingOptions) requests you can specify a floor price in micro-dollars. For example, if you wanted to earn a minimum of $0.85 per thousand ads returned, then you would specify '850000' as the value in micro-dollars

Parameters:

key - The advanced option key.

value - The advanced option value. Passing null will remove the advanced option specified by the key.

Returns:

The current instance of the AdTargetingOptions.

Throws:

java.lang.IllegalArgumentException - if the key is null or empty string

containsAdvancedOption

public boolean containsAdvancedOption(java.lang.String key)

Returns whether an advanced option has been set.

Parameters:

key - The key of the advanced option to check for.

Returns:

Whether an advanced option has been set.

getAdvancedOption

public java.lang.String getAdvancedOption(java.lang.String key)

Gets the value of an advanced option.

Parameters:

key - The key of the advanced option.

Returns:

The value of the advanced option. Returns null if the key isn't found.