com.adcolony.sdk

Class AdColonyUserMetadata

java.lang.Object

com.adcolony.sdk.AdColonyUserMetadata

public class AdColonyUserMetadata
extends java.lang.Object

An optional object to be passed via app or ad options.

See Also:

AdColonyAppOptions.setUserMetadata(AdColonyUserMetadata), AdColonyAdOptions.setUserMetadata(AdColonyUserMetadata)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	USER_EDUCATION_ASSOCIATES_DEGREE
static java.lang.String	USER_EDUCATION_BACHELORS_DEGREE
static java.lang.String	USER_EDUCATION_GRADE_SCHOOL
static java.lang.String	USER_EDUCATION_GRADUATE_DEGREE
static java.lang.String	USER_EDUCATION_HIGH_SCHOOL_DIPLOMA
static java.lang.String	USER_EDUCATION_SOME_COLLEGE
static java.lang.String	USER_EDUCATION_SOME_HIGH_SCHOOL
static java.lang.String	USER_FEMALE
static java.lang.String	USER_MALE
static java.lang.String	USER_MARRIED
static java.lang.String	USER_SINGLE

Constructor Summary

Constructors

Constructor and Description
AdColonyUserMetadata()

Method Summary

Modifier and Type	Method and Description
AdColonyUserMetadata	addUserInterest(java.lang.String interest) Used to add an arbitrary user interest.
AdColonyUserMetadata	clearUserInterests() Used to clear the current user's interests tied to this user metadata object.
java.lang.Object	getMetadata(java.lang.String key) Used to retrieve an arbitrary option with the given key.
int	getUserAge() Used to retrieve the user age as set in the user metadata.
int	getUserAnnualHouseholdIncome() Used to retrieve the user's annual household income as set in the user metadata.
java.lang.String	getUserEducation() Used to retrieve the user's education as set in the user metadata.
java.lang.String	getUserGender() Used to retrieve the user gender set in the user metadata.
java.lang.String[]	getUserInterests() Used to retrieve the user's interests as set in the user metadata.
android.location.Location	getUserLocation() Used to retrieve the current user's location as set in the user metadata.
java.lang.String	getUserMaritalStatus() Used to retrieve the user's marital status as set in the user metadata.
java.lang.String	getUserZipCode() Used to retrieve the user's ZIP code as set in the user metadata.
AdColonyUserMetadata	setMetadata(java.lang.String key, boolean value) Optionally set an arbitrary key/value definition
AdColonyUserMetadata	setMetadata(java.lang.String key, double value) Optionally set an arbitrary key/value definition
AdColonyUserMetadata	setMetadata(java.lang.String key, java.lang.String value) Optionally set an arbitrary key/value definition
AdColonyUserMetadata	setUserAge(int age) Used to set the current user's age.
AdColonyUserMetadata	setUserAnnualHouseholdIncome(int income) Used to set the user's annual household income.
AdColonyUserMetadata	setUserEducation(java.lang.String education) Used to set the user's education level.
AdColonyUserMetadata	setUserGender(java.lang.String gender) Used to set the current user's gender.
AdColonyUserMetadata	setUserLocation(android.location.Location location) Used to set the current user's location.
AdColonyUserMetadata	setUserMaritalStatus(java.lang.String status) Used to set the current user's marital status.
AdColonyUserMetadata	setUserZipCode(java.lang.String zip) Used to set the current user's ZIP code.

Methods inherited from class java.lang.Object

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

Field Detail

USER_MALE

public static final java.lang.String USER_MALE

See Also:

Constant Field Values

USER_FEMALE

public static final java.lang.String USER_FEMALE

See Also:

Constant Field Values

USER_SINGLE

public static final java.lang.String USER_SINGLE

See Also:

Constant Field Values

USER_MARRIED

public static final java.lang.String USER_MARRIED

See Also:

Constant Field Values

USER_EDUCATION_GRADE_SCHOOL

public static final java.lang.String USER_EDUCATION_GRADE_SCHOOL

See Also:

Constant Field Values

USER_EDUCATION_SOME_HIGH_SCHOOL

public static final java.lang.String USER_EDUCATION_SOME_HIGH_SCHOOL

See Also:

Constant Field Values

USER_EDUCATION_HIGH_SCHOOL_DIPLOMA

public static final java.lang.String USER_EDUCATION_HIGH_SCHOOL_DIPLOMA

See Also:

Constant Field Values

USER_EDUCATION_SOME_COLLEGE

public static final java.lang.String USER_EDUCATION_SOME_COLLEGE

See Also:

Constant Field Values

USER_EDUCATION_ASSOCIATES_DEGREE

public static final java.lang.String USER_EDUCATION_ASSOCIATES_DEGREE

See Also:

Constant Field Values

USER_EDUCATION_BACHELORS_DEGREE

public static final java.lang.String USER_EDUCATION_BACHELORS_DEGREE

See Also:

Constant Field Values

USER_EDUCATION_GRADUATE_DEGREE

public static final java.lang.String USER_EDUCATION_GRADUATE_DEGREE

See Also:

Constant Field Values

Constructor Detail

AdColonyUserMetadata

public AdColonyUserMetadata()

Method Detail

setUserGender

public AdColonyUserMetadata setUserGender(@NonNull
                                          java.lang.String gender)

Used to set the current user's gender.

Parameters:

gender - a constant representing the user's gender. Should be one of AdColonyUserMetadata.USER_MALE or AdColonyUserMetadata.USER_FEMALE.

Returns:

'this' for chaining calls.

getUserGender

public java.lang.String getUserGender()

Used to retrieve the user gender set in the user metadata.

Returns:

one of AdColonyUserMetadata.USER_MALE or AdColonyUserMetadata.USER_FEMALE. Will return an empty String if the user's gender has not been set.

setUserAge

public AdColonyUserMetadata setUserAge(int age)

Used to set the current user's age.

Parameters:

age - the age of the current user.

Returns:

'this' for chaining calls.

getUserAge

public int getUserAge()

Used to retrieve the user age as set in the user metadata.

Returns:

the user's age, or 0 if it has not been set.

setUserMaritalStatus

public AdColonyUserMetadata setUserMaritalStatus(@NonNull
                                                 java.lang.String status)

Used to set the current user's marital status.

Parameters:

status - the marital status of the current user. Should be one of AdColonyUserMetadata.USER_SINGLE or AdColonyUserMetadata.USER_MARRIED.

Returns:

'this' for chaining calls.

getUserMaritalStatus

public java.lang.String getUserMaritalStatus()

Used to retrieve the user's marital status as set in the user metadata.

Returns:

one of the String constants representing the user's marital status, or an empty String if it has not yet been set.

setUserAnnualHouseholdIncome

public AdColonyUserMetadata setUserAnnualHouseholdIncome(int income)

Used to set the user's annual household income.

Parameters:

income - the current user's annual household income.

Returns:

'this' for chaining calls.

getUserAnnualHouseholdIncome

public int getUserAnnualHouseholdIncome()

Used to retrieve the user's annual household income as set in the user metadata.

Returns:

the current user's annual household income, or 0 if it has not been set.

setUserEducation

public AdColonyUserMetadata setUserEducation(@NonNull
                                             java.lang.String education)

Used to set the user's education level.

Parameters:

education - one of the String constants from AdColonyUserMetadata representing education level.

Returns:

'this' for chaining calls.

getUserEducation

public java.lang.String getUserEducation()

Used to retrieve the user's education as set in the user metadata.

Returns:

a String constant representing the user's education level, or an empty String if it has not been set.

setUserZipCode

public AdColonyUserMetadata setUserZipCode(@NonNull
                                           java.lang.String zip)

Used to set the current user's ZIP code.

Parameters:

zip - the current user's ZIP code.

Returns:

'this' for chaining calls.

getUserZipCode

public java.lang.String getUserZipCode()

Used to retrieve the user's ZIP code as set in the user metadata.

Returns:

the user's zip code, or an empty String if it has not been set.

setUserLocation

public AdColonyUserMetadata setUserLocation(@NonNull
                                            android.location.Location location)

Used to set the current user's location.

Parameters:

location - the location object usually generated by LocationManager.

Returns:

'this' for chaining calls.

getUserLocation

public android.location.Location getUserLocation()

Used to retrieve the current user's location as set in the user metadata.

Returns:

the Location object representing the user's location, or null if it has not been set.

addUserInterest

public AdColonyUserMetadata addUserInterest(@NonNull
                                            java.lang.String interest)

Used to add an arbitrary user interest.

Parameters:

interest - a String representing the user interest.

Returns:

'this' for chaining calls.

clearUserInterests

public AdColonyUserMetadata clearUserInterests()

Used to clear the current user's interests tied to this user metadata object.

Returns:

'this' for chaining calls.

getUserInterests

public java.lang.String[] getUserInterests()

Used to retrieve the user's interests as set in the user metadata.

Returns:

a String array of the user's interests.

setMetadata

public AdColonyUserMetadata setMetadata(@NonNull
                                        java.lang.String key,
                                        boolean value)

Optionally set an arbitrary key/value definition

Parameters:

key - the key for this option mapping.

value - the value for this option mapping.

Returns:

'this' for chaining calls.

getMetadata

public java.lang.Object getMetadata(@NonNull
                                    java.lang.String key)

Used to retrieve an arbitrary option with the given key.

Parameters:

key - the key of the option you wish to retrieve.

Returns:

the value mapped to the provided key, or false if the mapping does not exist.

setMetadata

public AdColonyUserMetadata setMetadata(@NonNull
                                        java.lang.String key,
                                        double value)

Optionally set an arbitrary key/value definition

Parameters:

key - the key for this option mapping.

value - the value for this option mapping.

Returns:

'this' for chaining calls.

setMetadata

public AdColonyUserMetadata setMetadata(@NonNull
                                        java.lang.String key,
                                        @NonNull
                                        java.lang.String value)

Optionally set an arbitrary key/value definition

Parameters:

key - the key for ths option mapping.

value - the value for this option mapping.

Returns:

'this' for chaining calls.