com.pubmatic.sdk.common

Class POBSDKConfig

java.lang.Object

com.pubmatic.sdk.common.POBSDKConfig

public class POBSDKConfig
extends java.lang.Object

This class is used for setting configuration parameters for OpenWrap SDK level i.e state needs to be applied for all ads supported by SDK

Method Summary

Modifier and Type	Method and Description
void	addExternalUserId(POBExternalUserId userId) Adds the External user id /Data Partner ids which helps publisher in better user targeting
void	allowAdvertisingId(boolean allow) Indicates whether Advertisement ID should be sent in the request.
void	allowLocationAccess(boolean allow) Enables or disable SDK location detection.
POBApplicationInfo	getApplicationInfo()
java.util.Map<java.lang.String,java.util.List<POBExternalUserId>>	getExternalUserIds() Get the map of User defined data partner ids
POBLocation	getLocation()
long	getLocationDetectionDurationInMillis() Returns time interval used to get the two consecutive location
<T> T	getMeasurementProvider(java.lang.String className) Method to get OM measurement provider instance
POBUserInfo	getUserInfo()
boolean	isAllowAdvertisingId()
java.lang.Boolean	isCoppa()
boolean	isLocationAccessAllowed() Determines if location detection is enabled.
boolean	isRequestSecureCreative()
boolean	isUseInternalBrowser() Returns true if landing page for an ad would opened in internal browser else returns false
void	removeAllExternalUserIds() removes all data partner ids
void	removeExternalUserIds(java.lang.String source) removes the Data partner ids of a particular source
void	setApplicationInfo(POBApplicationInfo applicationInfo) Sets the application information.
void	setCoppa(boolean coppaState) Sets COPPA state.
void	setLocation(POBLocation location)
void	setLocationDetectionDurationInMillis(long durationInMillis) Sets the duration for retrieving the location of user.
void	setRequestSecureCreative(boolean requestSecureCreative) Requests secure ads from ad server using https protocol.
void	setUseInternalBrowser(boolean internalBrowserState) Set to true if landing page for an ad should be opened in internal browser else set to false.
void	setUserInfo(POBUserInfo userInfo) Sets the user's information.

Methods inherited from class java.lang.Object

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

Method Detail

isLocationAccessAllowed

public boolean isLocationAccessAllowed()

Determines if location detection is enabled. If enabled, the SDK will use the location services of the device to determine the device's location ad add ad request parameters (lat/long) to the ad request. Location detection can be enabled with allowLocationAccess() or enableLocationDetection().

Returns:

true if location detection is enabled, false if not

allowLocationAccess

public void allowLocationAccess(boolean allow)

Enables or disable SDK location detection. If enabled with this method the most battery optimized settings are used. This method is used to disable location detection for either method of enabling location detection. Default value is true.

Permissions for coarse or fine location detection may be required.

Parameters:

allow - enable or disable auto location detection

getLocationDetectionDurationInMillis

public long getLocationDetectionDurationInMillis()

Returns time interval used to get the two consecutive location

Returns:

time interval in milli second

setLocationDetectionDurationInMillis

public void setLocationDetectionDurationInMillis(long durationInMillis)

Sets the duration for retrieving the location of user. Default value is 10 seconds.

Parameters:

durationInMillis - time in milli second

isUseInternalBrowser

public boolean isUseInternalBrowser()

Returns true if landing page for an ad would opened in internal browser else returns false

Returns:

State of internal browser

setUseInternalBrowser

public void setUseInternalBrowser(boolean internalBrowserState)

Set to true if landing page for an ad should be opened in internal browser else set to false. Starting with SDK v2.7.0, default value is false. Prior, it was true.

Parameters:

internalBrowserState - value of boolean type

getLocation

@Nullable
public POBLocation getLocation()

setLocation

public void setLocation(@Nullable
                        POBLocation location)

isCoppa

@Nullable
public java.lang.Boolean isCoppa()

setCoppa

public void setCoppa(boolean coppaState)

Sets COPPA state. It indicates whether the visitor is COPPA-specific or not. For COPPA (Children's Online Privacy Protection Act) compliance, if the visitor's age is below 13, then such visitors should not be served targeted ads. Possible options are: false - Indicates that the visitor is not COPPA-specific and can be served targeted ads. true - Indicates that the visitor is COPPA-specific and should be served only COPPA-compliant ads.

Parameters:

coppaState - Coppa state

isRequestSecureCreative

public boolean isRequestSecureCreative()

setRequestSecureCreative

public void setRequestSecureCreative(boolean requestSecureCreative)

Requests secure ads from ad server using https protocol.

Parameters:

requestSecureCreative - true for enable secure creative mode. Default is set to false.

isAllowAdvertisingId

public boolean isAllowAdvertisingId()

allowAdvertisingId

public void allowAdvertisingId(boolean allow)

Indicates whether Advertisement ID should be sent in the request. Possible values are: true : Advertisement id will be sent in the request. false : Android ID will be sent in the request instead of the Advertisement id. Default value is true

Parameters:

allow - state of advertisement id usage

getUserInfo

@Nullable
public POBUserInfo getUserInfo()

setUserInfo

public void setUserInfo(@Nullable
                        POBUserInfo userInfo)

Sets the user's information. It would be useful in delivering user relevant ads

Parameters:

userInfo - value of POBUserInfo type

getApplicationInfo

@Nullable
public POBApplicationInfo getApplicationInfo()

setApplicationInfo

public void setApplicationInfo(@Nullable
                               POBApplicationInfo applicationInfo)

Sets the application information. It would be useful in delivering application relevant ads

Parameters:

applicationInfo - value of POBApplicationInfo type

getMeasurementProvider

@Nullable
public <T> T getMeasurementProvider(@NonNull
                                              java.lang.String className)

Method to get OM measurement provider instance

Type Parameters:

T - generic parameter for Measurement Provider

Parameters:

className - name of measurement provider class

Returns:

reference of measurement provider T

addExternalUserId

public void addExternalUserId(@NonNull
                              POBExternalUserId userId)

Adds the External user id /Data Partner ids which helps publisher in better user targeting

Parameters:

userId - instance of POBExternalUserId class

getExternalUserIds

@NonNull
public java.util.Map<java.lang.String,java.util.List<POBExternalUserId>> getExternalUserIds()

Get the map of User defined data partner ids

Returns:

Map of Data partner ids

removeExternalUserIds

public void removeExternalUserIds(@NonNull
                                  java.lang.String source)

removes the Data partner ids of a particular source

Parameters:

source - name of source

removeAllExternalUserIds

public void removeAllExternalUserIds()

removes all data partner ids