com.pubmatic.sdk.common.models

Class POBUserInfo

java.lang.Object

com.pubmatic.sdk.common.models.POBUserInfo

public class POBUserInfo
extends java.lang.Object

Provides setters to pass user information

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	POBUserInfo.Gender Defines gender of user

Constructor Summary

Constructors

Constructor and Description
POBUserInfo()

Method Summary

Modifier and Type	Method and Description
void	addDataProvider(POBDataProvider dataProvider) Method to add segment data of a data provider to OW SDK
int	getBirthYear() (Internal for OpenWrap SDK)
java.lang.String	getCity() (Internal for OpenWrap SDK)
POBDataProvider	getDataProvider(java.lang.String name) Method to get segment data set at OW SDK for a data provider with given name
java.util.List<POBDataProvider>	getDataProviders() Method to get segment data set at OW SDK from all data providers
POBUserInfo.Gender	getGender() (Internal for OpenWrap SDK)
java.lang.String	getKeywords() (Internal for OpenWrap SDK) Returns the comma separated list of keywords, interests, or intent, set by the application developer.
java.lang.String	getMetro() (Internal for OpenWrap SDK)
java.lang.String	getRegion() (Internal for OpenWrap SDK)
java.lang.String	getZip() (Internal for OpenWrap SDK)
void	removeAllDataProviders() Method to remove All data providers from a user object
POBDataProvider	removeDataProvider(java.lang.String name) Method to remove data provider with specific name from a user object
void	setBirthYear(int birthYear) The year of birth in YYYY format.
void	setCity(java.lang.String city) Sets city of user For example: setCity("London");
void	setGender(POBUserInfo.Gender gender) Set the user gender, Possible options are: OTHER MALE, FEMALE
void	setKeywords(java.lang.String keywords) Sets the comma separated list of keywords, interests, or intent.
void	setMetro(java.lang.String metro) Sets metro / DMA.
void	setRegion(java.lang.String region) Sets the user's region.
void	setZip(java.lang.String zip) Sets the user's zip or postal code.

Methods inherited from class java.lang.Object

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

Constructor Detail

POBUserInfo

public POBUserInfo()

Method Detail

getKeywords

@Nullable
public java.lang.String getKeywords()

(Internal for OpenWrap SDK) Returns the comma separated list of keywords, interests, or intent, set by the application developer.

Returns:

Comma separated list of keywords, interests, or intent.

setKeywords

public void setKeywords(java.lang.String keywords)

Sets the comma separated list of keywords, interests, or intent.

Parameters:

keywords - Comma separated list of keywords, interests, or intent.

getBirthYear

public int getBirthYear()

(Internal for OpenWrap SDK)

Returns:

Birth Year

setBirthYear

public void setBirthYear(int birthYear)

The year of birth in YYYY format. Example : setBirthYear(1988);

Parameters:

birthYear - birth year of user

getGender

@Nullable
public POBUserInfo.Gender getGender()

(Internal for OpenWrap SDK)

Returns:

User's gender

setGender

public void setGender(@NonNull
                      POBUserInfo.Gender gender)

Set the user gender, Possible options are: OTHER MALE, FEMALE

Parameters:

gender - User's gender

getCity

@Nullable
public java.lang.String getCity()

(Internal for OpenWrap SDK)

Returns:

User's city

setCity

public void setCity(@NonNull
                    java.lang.String city)

Sets city of user For example: setCity("London");

Parameters:

city - City of user

getMetro

@Nullable
public java.lang.String getMetro()

(Internal for OpenWrap SDK)

Returns:

User's metro

setMetro

public void setMetro(@NonNull
                     java.lang.String metro)

Sets metro / DMA. For example, New York, NY is also known as 501. Los Angeles, CA, on the other hand has been assigned the number 803.

Parameters:

metro - Metro / DMA code of the user.

getZip

@Nullable
public java.lang.String getZip()

(Internal for OpenWrap SDK)

Returns:

User's zip code

setZip

public void setZip(@NonNull
                   java.lang.String zip)

Sets the user's zip or postal code. This may be useful in delivering geographically relevant ads For example: for Redwood city, CA use setZip("94063");

Parameters:

zip - user's zip code

getRegion

@Nullable
public java.lang.String getRegion()

(Internal for OpenWrap SDK)

Returns:

user's region

setRegion

public void setRegion(@NonNull
                      java.lang.String region)

Sets the user's region. Region code using ISO-3166-2; 2-letter state code if USA. For example: for France you can use "FR"

Parameters:

region - user's region.

addDataProvider

public void addDataProvider(@NonNull
                            POBDataProvider dataProvider)

Method to add segment data of a data provider to OW SDK

Parameters:

dataProvider - instance of data provider class

getDataProvider

@Nullable
public POBDataProvider getDataProvider(@NonNull
                                                 java.lang.String name)

Method to get segment data set at OW SDK for a data provider with given name

Parameters:

name - name of the data provider

Returns:

returns instance of data provider with name or null if not available

getDataProviders

@NonNull
public java.util.List<POBDataProvider> getDataProviders()

Method to get segment data set at OW SDK from all data providers

Returns:

list of POBDataProvider Objects

removeDataProvider

@Nullable
public POBDataProvider removeDataProvider(@NonNull
                                                    java.lang.String name)

Method to remove data provider with specific name from a user object

Parameters:

name - name of data provider

removeAllDataProviders

public void removeAllDataProviders()

Method to remove All data providers from a user object