Class AppBrainUserData

java.lang.Object

com.appbrain.AppBrainUserData

public class AppBrainUserData
extends Object

Class to hold data about a user. It has a builder-like pattern so you can chain calls like:

AppBrain.getAds().setUserData(AppBrainUserData.create().setGender(gender).setLocation(location));

All fields are optional, so you can set any combination of them.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AppBrainUserData.Gender	For use in setGender(Gender).

Method Summary

Modifier and Type	Method	Description
AppBrainUserData	addKeyword(String keyword)	Add a keyword.
AppBrainUserData	addKeywords(Collection<String> keywords)	Add a collection of keywords relevant to the context of the user.
static AppBrainUserData	create()
Date	getBirthDate()
AppBrainUserData.Gender	getGender()
Set<String>	getKeywords()
Location	getLocation()
AppBrainUserData	setBirthDate(Date date)	Allows you to set the user's age.
AppBrainUserData	setGender(AppBrainUserData.Gender gender)	Allows you to set the user's gender.
AppBrainUserData	setLocation(Location location)	Set a recently retrieved location of the user (acquired from the android LocationManager or Google Play Service's LocationClient).

Methods inherited from class Object

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

Method Details

create

public static AppBrainUserData create()

Returns:

a new AppBrainUserData instance.

setBirthDate

public AppBrainUserData setBirthDate(Date date)

Allows you to set the user's age. For young users COPPA compliance will be enabled automatically.

setGender

public AppBrainUserData setGender(AppBrainUserData.Gender gender)

Allows you to set the user's gender. AppBrainUserData.Gender.UNKNOWN is the default.

addKeyword

public AppBrainUserData addKeyword(String keyword)

Add a keyword. This can be anything relevant to the context of the user.

One example could be a word game with multiple categories "animals", "sports", "countries" and the keyword is then the last category the user played. Another example could be an app in which the user can type search queries, and the keyword can be the last search query of the user.

addKeywords

public AppBrainUserData addKeywords(Collection<String> keywords)

Add a collection of keywords relevant to the context of the user. See addKeyword(String).

setLocation

public AppBrainUserData setLocation(Location location)

Set a recently retrieved location of the user (acquired from the android LocationManager or Google Play Service's LocationClient).

getBirthDate

public Date getBirthDate()

Returns:

the value set by setBirthDate(Date).

getKeywords

public Set<String> getKeywords()

Returns:

all keywords added by addKeyword(String) or addKeywords(Collection).

getGender

public AppBrainUserData.Gender getGender()

Returns:

the value set by setGender(Gender).

getLocation

public Location getLocation()

Returns:

the value set by setLocation(Location).