org.prebid.mobile.core

Class TargetingParams

java.lang.Object

org.prebid.mobile.core.TargetingParams

public class TargetingParams
extends java.lang.Object

TargetingParams class sets the Targeting parameters like age, gender, location and other custom parameters for the adUnits to be made available in the auction.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TargetingParams.GENDER

Method Summary

Modifier and Type	Method and Description
static void	clearCustomKeywords() Clear all custom keywords.
static int	getAge() Get the age for targeting
static java.util.HashMap<java.lang.String,java.util.ArrayList<java.lang.String>>	getCustomKeywords() Retrieve the array of custom keywords that will passed to demand sources.
static TargetingParams.GENDER	getGender() Get the current user's gender, if it's available.
static Location	getLocation() Retrieve the location that's set by setLocation()
static int	getLocationDecimalDigits() Get the digits after the decimal of the latitude and longitude.
static boolean	getLocationEnabled() Returns true if the Prebid sdk is allowed to use location information or false otherwise.
static void	removeCustomKeyword(java.lang.String key) Remove a custom keyword from the targeting params.
static void	setAge(int age) Set the age for targeting
static void	setCustomTargeting(java.lang.String key, java.util.ArrayList<java.lang.String> values) Set a custom key/values pair for customized targeting.
static void	setCustomTargeting(java.lang.String key, java.lang.String value) Set a custom key/value pair for customized targeting.
static void	setGender(TargetingParams.GENDER gender) Set the user's gender.
static void	setLocation(Location locationData) Set the location for demand sources to target
static void	setLocationDecimalDigits(int digitsAfterDecimal) Sets the number of digits after the decimal of the latitude and longitude.
static void	setLocationEnabled(boolean enabled) Sets whether or not location (latitude, longitude) is retrieved through provider and shared with 3rd party networks.

Methods inherited from class java.lang.Object

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

Method Detail

getAge

public static int getAge()

Get the age for targeting

Returns:

age

setAge

public static void setAge(int age)

Set the age for targeting

Parameters:

age - age of the user

getGender

public static TargetingParams.GENDER getGender()

Get the current user's gender, if it's available. The default value is UNKNOWN.

Returns:

The user's gender.

setGender

public static void setGender(TargetingParams.GENDER gender)

Set the user's gender. This should be set if the user's gender is known, as it can help make buying the ad space more attractive to advertisers. The default value is UNKNOWN.

Parameters:

gender - The user's gender.

setLocationEnabled

public static void setLocationEnabled(boolean enabled)

Sets whether or not location (latitude, longitude) is retrieved through provider and shared with 3rd party networks. True means Prebid SDK will try to get the latest location data from either developer or location provider and pass it to demand sources.

Parameters:

enabled - default is false.

getLocationEnabled

public static boolean getLocationEnabled()

Returns true if the Prebid sdk is allowed to use location information or false otherwise.

getLocation

public static Location getLocation()

Retrieve the location that's set by setLocation()

Returns:

null if location was not set

setLocation

public static void setLocation(Location locationData)

Set the location for demand sources to target

Parameters:

locationData - location of the user

getLocationDecimalDigits

public static int getLocationDecimalDigits()

Get the digits after the decimal of the latitude and longitude.

Returns:

the current value of the digits

setLocationDecimalDigits

public static void setLocationDecimalDigits(int digitsAfterDecimal)

Sets the number of digits after the decimal of the latitude and longitude. It will only be applied if getLocationEnabled(). Maximum of precision is 6, which means less than a foot.

Parameters:

digitsAfterDecimal - The digits

getCustomKeywords

public static java.util.HashMap<java.lang.String,java.util.ArrayList<java.lang.String>> getCustomKeywords()

Retrieve the array of custom keywords that will passed to demand sources.

Returns:

The current list of key-value pairs of custom keywords.

removeCustomKeyword

public static void removeCustomKeyword(java.lang.String key)

Remove a custom keyword from the targeting params. Use this to remove a keyword previously set using addCustomKeywords.

Parameters:

key - The key to remove; this should not be null or empty.

setCustomTargeting

public static void setCustomTargeting(java.lang.String key,
                                      java.lang.String value)

Set a custom key/value pair for customized targeting. Note this will override existing values for the same key.

Parameters:

key - The key to add; this should not be null or empty.

value - The value to add; this should not be null or empty.

setCustomTargeting

public static void setCustomTargeting(java.lang.String key,
                                      java.util.ArrayList<java.lang.String> values)

Set a custom key/values pair for customized targeting. Note this will override existing values for the same key.

Parameters:

key - The key to add; this should not be null or empty.

values - The values to add; this should not be null or empty.

clearCustomKeywords

public static void clearCustomKeywords()

Clear all custom keywords.