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 yob, 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	addAppKeywords(java.lang.String keyword) Deprecated.
static void	addUserKeyword(java.lang.String keyword) Deprecated. use setUserTargeting(String, String) instead
static void	clearAppKeywords() Deprecated.
static void	clearUserKeywords() Clear the keywords for user
static java.util.ArrayList<java.lang.String>	getAppKeywords() Deprecated.
static java.lang.String	getBundleName() Get the platform-specific identifier, should be bundle/package name
static java.lang.String	getDomain() Get the domain of your app
static java.lang.String	getGDPRConsentString(Context context)
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 int	getPrivacyPolicy() Get whether the app has a privacy policy
static java.lang.String	getStoreUrl() Get the store url of your app
static java.util.ArrayList<java.lang.String>	getUserKeywords() Get the keywords for user
static int	getYearOfBirth() Get the year of birth for targeting
static java.lang.Boolean	isSubjectToGDPR(Context context)
static void	removeAppKeyword(java.lang.String keyword) Deprecated.
static void	removeUserKeyword(java.lang.String keyword) Remove one keyword to user related keywords
static void	setAppKeywords(java.util.ArrayList<java.lang.String> appKeywords) Deprecated.
static void	setBundleName(java.lang.String bundleName) Set the platform-specific identifier for targeting purpose Should be bundle/package name
static void	setDomain(java.lang.String domain) Set the domain of your app for targeting purpose
static void	setGDPRConsentString(Context context, java.lang.String string)
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.
static void	setPrivacyPolicy(int privacyPolicy) Set whether the app has a privacy policy, where 0 = no, 1 = yes
static void	setStoreUrl(java.lang.String storeUrl) Set the store url of your app
static void	setSubjectToGDPR(Context context, boolean consent)
static void	setUserKeywords(java.util.ArrayList<java.lang.String> userKeywords) Deprecated. use setUserTargeting(String, String) instead
static void	setUserTargeting(java.lang.String key, java.lang.String value) Set a key-value pair as a keyword, this will be sent in the user object in the ORTB request An exmpale, if you call setUserTargeting("key1", "value1") and setUserTargeting("key2", null), values that will be sent are "key1=value1,key2,"
static void	setYearOfBirth(int yob) Set the year of birth for targeting

Methods inherited from class java.lang.Object

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

Method Detail

setGDPRConsentString

public static void setGDPRConsentString(Context context,
                                        java.lang.String string)

getGDPRConsentString

public static java.lang.String getGDPRConsentString(Context context)

setSubjectToGDPR

public static void setSubjectToGDPR(Context context,
                                    boolean consent)

isSubjectToGDPR

public static java.lang.Boolean isSubjectToGDPR(Context context)

getYearOfBirth

public static int getYearOfBirth()

Get the year of birth for targeting

Returns:

yob

setYearOfBirth

public static void setYearOfBirth(int yob)

Set the year of birth for targeting

Parameters:

yob - yob 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

setAppKeywords

@Deprecated
public static void setAppKeywords(java.util.ArrayList<java.lang.String> appKeywords)

Deprecated.

Set the keywords that're related to the app

Parameters:

appKeywords - list of keywords

getAppKeywords

@Deprecated
public static java.util.ArrayList<java.lang.String> getAppKeywords()

Deprecated.

clearAppKeywords

@Deprecated
public static void clearAppKeywords()

Deprecated.

Clear all the keywords that're related to the app

addAppKeywords

@Deprecated
public static void addAppKeywords(java.lang.String keyword)

Deprecated.

Add one keyword to app related keywords

Parameters:

keyword - keyword to be added

removeAppKeyword

@Deprecated
public static void removeAppKeyword(java.lang.String keyword)

Deprecated.

Remove one keyword to app related keywords

Parameters:

keyword - keyword to be added

setUserKeywords

@Deprecated
public static void setUserKeywords(java.util.ArrayList<java.lang.String> userKeywords)

Deprecated. use setUserTargeting(String, String) instead

Set the keywords that're related to the

Parameters:

userKeywords -

addUserKeyword

@Deprecated
public static void addUserKeyword(java.lang.String keyword)

Deprecated. use setUserTargeting(String, String) instead

Add one keyword to user related keywords

Parameters:

keyword - keyword to be added

setUserTargeting

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

Set a key-value pair as a keyword, this will be sent in the user object in the ORTB request An exmpale, if you call setUserTargeting("key1", "value1") and setUserTargeting("key2", null), values that will be sent are "key1=value1,key2,"

Parameters:

key - key in the key-value pair, should not be null

value - value in the key-value pair, can be null

getUserKeywords

public static java.util.ArrayList<java.lang.String> getUserKeywords()

Get the keywords for user

Returns:

a list of keywords

clearUserKeywords

public static void clearUserKeywords()

Clear the keywords for user

removeUserKeyword

public static void removeUserKeyword(java.lang.String keyword)

Remove one keyword to user related keywords

Parameters:

keyword - keyword to be removed

getBundleName

public static java.lang.String getBundleName()

Get the platform-specific identifier, should be bundle/package name

setBundleName

public static void setBundleName(java.lang.String bundleName)

Set the platform-specific identifier for targeting purpose Should be bundle/package name

setDomain

public static void setDomain(java.lang.String domain)

Set the domain of your app for targeting purpose

Parameters:

domain - domain of your app

getDomain

public static java.lang.String getDomain()

Get the domain of your app

Returns:

domain of your app

setStoreUrl

public static void setStoreUrl(java.lang.String storeUrl)

Set the store url of your app

Parameters:

storeUrl - store url

getStoreUrl

public static java.lang.String getStoreUrl()

Get the store url of your app

Returns:

store url

setPrivacyPolicy

public static void setPrivacyPolicy(int privacyPolicy)

Set whether the app has a privacy policy, where 0 = no, 1 = yes

Parameters:

privacyPolicy - default value is 0

getPrivacyPolicy

public static int getPrivacyPolicy()

Get whether the app has a privacy policy

Returns:

1 if it has one