com.pubmatic.sdk.common

Class PMSDKConfig

java.lang.Object

com.pubmatic.sdk.common.PMSDKConfig

public class PMSDKConfig
extends java.lang.Object

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

Constructor Summary

Constructors

Constructor and Description
PMSDKConfig()

Method Summary

Modifier and Type	Method and Description
void	allowAdvertisingId(boolean allow) Indicates whether Advertisement ID should be sent in the request.
void	allowLocationAccess(boolean allow) Enables or disable SDK location detection.
OpenBidSDK.HashType	getAdvertisingIdHashType()
POBApplicationInfo	getApplicationInfo()
java.lang.String	getGdprConsent() Method to get GDPR consent string if publisher is granted GDPR consent
POBLocation	getLocation()
long	getLocationDetectionDurationInMillis() Returns time interval used to get the two consecutive location
POBUserInfo	getUserInfo()
boolean	isAllowAdvertisingId()
java.lang.Boolean	isCoppa()
java.lang.Boolean	isGdprEnabled() Method to check whether publisher is GDPR regulated or not
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	setApplicationInfo(POBApplicationInfo applicationInfo) Sets the application information.
void	setCoppa(boolean coppaState) Sets COPPA state.
void	setGdprConsent(java.lang.String gdprConsent) Method to set GDPR consent string if publisher is granted GDPR consent
void	setGdprEnabled(java.lang.Boolean gdprEnabled) Method to set GDPR regulation value By default GDPR value is set to false
void	setHashTypeForAdvertisingId(OpenBidSDK.HashType advertisingIdHashType) Apply following hashing on udid before sending to server, Possible values are: RAW, SHA1, MD5 Default is Raw
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

Constructor Detail

PMSDKConfig

public PMSDKConfig()

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. Default value is true.

Parameters:

internalBrowserState - value of boolean type

getLocation

public POBLocation getLocation()

setLocation

public void setLocation(POBLocation location)

isCoppa

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

getAdvertisingIdHashType

public OpenBidSDK.HashType getAdvertisingIdHashType()

setHashTypeForAdvertisingId

public void setHashTypeForAdvertisingId(OpenBidSDK.HashType advertisingIdHashType)

Apply following hashing on udid before sending to server, Possible values are: RAW, SHA1, MD5 Default is Raw

Parameters:

advertisingIdHashType - hash type for udid.

getUserInfo

public POBUserInfo getUserInfo()

setUserInfo

public void setUserInfo(POBUserInfo userInfo)

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

Parameters:

userInfo - value of POBUserInfo type

getApplicationInfo

public POBApplicationInfo getApplicationInfo()

setApplicationInfo

public void setApplicationInfo(POBApplicationInfo applicationInfo)

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

Parameters:

applicationInfo - value of POBApplicationInfo type

isGdprEnabled

public java.lang.Boolean isGdprEnabled()

Method to check whether publisher is GDPR regulated or not

Returns:

true if publisher is GDPR regulated else return false

setGdprEnabled

public void setGdprEnabled(java.lang.Boolean gdprEnabled)

Method to set GDPR regulation value By default GDPR value is set to false

Parameters:

gdprEnabled - provide true, if publisher want to grant GDPR regulations else provide false

getGdprConsent

public java.lang.String getGdprConsent()

Method to get GDPR consent string if publisher is granted GDPR consent

Returns:

GDPR consent string

setGdprConsent

public void setGdprConsent(java.lang.String gdprConsent)

Method to set GDPR consent string if publisher is granted GDPR consent

Parameters:

gdprConsent - provide GDPR consent string