com.pubmatic.sdk.common

Class OpenBidSDK

java.lang.Object

com.pubmatic.sdk.common.OpenBidSDK

public class OpenBidSDK
extends java.lang.Object

Provides global configurations for the OpenBid SDK, e.g. enabling logging, location access, GDPR, etc. These configurations are globally applicable for OpenBid SDK; you don't have to set these for every ad request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OpenBidSDK.HashType Hashing applicable for Android Advertising id
static class	OpenBidSDK.LogLevel Log levels to filter logs

Constructor Summary

Constructors

Constructor and Description
OpenBidSDK()

Method Summary

Modifier and Type	Method and Description
static void	allowAdvertisingId(boolean allow) Indicates whether Android advertisement ID should be sent in the request or not.
static void	allowLocationAccess(boolean allow) Used to enable/disable location access.
static java.lang.String	getVersion() Returns the OpenBid SDK's version.
static void	setApplicationInfo(POBApplicationInfo applicationInfo) Sets Application information, which contains various attributes about app, such as application category, store URL, domain, etc for more relevant ads.
static void	setCoppa(boolean coppaState) Indicates whether the visitor is COPPA-specific or not.
static void	setGDPRConsent(java.lang.String gdprConsent) Sets GDPR consent string, A valid Base64 encoded consent string as per https://github.com/InteractiveAdvertisingBureau/GDPR-Transparency-and-Consent-Framework.
static void	setGDPREnabled(boolean gdpr) Sets GDPR compliance, it indicates whether or not the ad request is GDPR(General Data Protection Regulation) compliant.
static void	setHashTypeForAdvertisingId(OpenBidSDK.HashType advertisingIdHashType) Applies given hashing technique to Android advertisement ID, before sending it to the ad server.
static void	setLocation(POBLocation location) Sets user's location and its source.
static void	setLogLevel(OpenBidSDK.LogLevel level) Sets log level across all ad formats.
static void	setSSLEnabled(boolean requestSecureCreative) Enable/disable secure ad calls.
static void	setUseInternalBrowser(boolean internalBrowserState) Tells OpenBid SDK to use internal SDK browser, instead of the default device browser, for opening landing pages when the user clicks on an ad.
static void	setUserInfo(POBUserInfo userInfo) Sets user information, such as birth year, gender, region, etc for more relevant ads.

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenBidSDK

public OpenBidSDK()

Method Detail

setLogLevel

public static void setLogLevel(OpenBidSDK.LogLevel level)

Sets log level across all ad formats. Default log level is LogLevel.Warn. For more details refer OpenBidSDK.LogLevel

Parameters:

level - log level to set.

getVersion

public static java.lang.String getVersion()

Returns the OpenBid SDK's version.

Returns:

sdk version

allowLocationAccess

public static void allowLocationAccess(boolean allow)

Used to enable/disable location access. This value decides whether the OpenBid SDK should access device location using Core Location APIs to serve location-based ads. When set to false, the SDK will not attempt to access device location. When set to true, the SDK will periodically try to fetch location efficiently. Note that, this only occurs if location services are enabled and the user has already authorized the use of location services for the application. The OpenBid SDK never asks permission to use location services by itself. The default value is true.

Parameters:

allow - enable or disable location access behavior

setUseInternalBrowser

public static void setUseInternalBrowser(boolean internalBrowserState)

Tells OpenBid SDK to use internal SDK browser, instead of the default device browser, for opening landing pages when the user clicks on an ad. By default, use of internal browser is enabled. If disabled by setting it to false, the landing page will gets opened in the default browser set by the user in device.

Parameters:

internalBrowserState - boolean value that enables/disables the use of internal browser.

setLocation

public static void setLocation(POBLocation location)

Sets user's location and its source. It is useful in delivering geographically relevant ads. If your application is already accessing the device location, it is highly recommended to set the location coordinates inferred from the device GPS. If you are inferring location from any other source, make sure you set the appropriate location source.

Parameters:

location - User's current location

setCoppa

public static void setCoppa(boolean coppaState)

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 - Visitor state for COPPA compliance.

setSSLEnabled

public static void setSSLEnabled(boolean requestSecureCreative)

Enable/disable secure ad calls. By default, OpenBid SDK initiates secure ad calls from an application to the ad server and delivers only secure ads. You can allow non secure ads by passing false to this method.

Parameters:

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

allowAdvertisingId

public static void allowAdvertisingId(boolean allow)

Indicates whether Android advertisement ID should be sent in the request or not. By default advertisement ID will be used. Possible values are: true : Advertisement id will be sent in the request. false : Advertisement id will not be sent in the request.

Parameters:

allow - state of advertisement id usage

setHashTypeForAdvertisingId

public static void setHashTypeForAdvertisingId(OpenBidSDK.HashType advertisingIdHashType)

Applies given hashing technique to Android advertisement ID, before sending it to the ad server. By default, no hashing is applied. For more details refer OpenBidSDK.HashType

Parameters:

advertisingIdHashType - hash type for advertisingId.

setApplicationInfo

public static void setApplicationInfo(POBApplicationInfo applicationInfo)

Sets Application information, which contains various attributes about app, such as application category, store URL, domain, etc for more relevant ads.

Parameters:

applicationInfo - Instance of POBApplicationInfo class with required application details

setUserInfo

public static void setUserInfo(POBUserInfo userInfo)

Sets user information, such as birth year, gender, region, etc for more relevant ads.

Parameters:

userInfo - Instance of POBUserInfo class with required user details

setGDPREnabled

public static void setGDPREnabled(boolean gdpr)

Sets GDPR compliance, it indicates whether or not the ad request is GDPR(General Data Protection Regulation) compliant.

Parameters:

gdpr - boolean value - true : indicates GDPR compliant requests - false : indicates that the request is not GDPR compliant By default, this parameter is omitted in the ad request, indicating Unknown.

setGDPRConsent

public static void setGDPRConsent(java.lang.String gdprConsent)

Sets GDPR consent string, A valid Base64 encoded consent string as per https://github.com/InteractiveAdvertisingBureau/GDPR-Transparency-and-Consent-Framework. The user consent string is optional, but highly recommended if the request is subject to GDPR regulations (i.e. gdpr = true). The default sense of consent under GDPR is "opt-out" and as such, an omitted consent string in a request subject to GDPR would be interpreted as equivalent to the user fully opting out of all defined purposes for data use by all parties.

Parameters:

gdprConsent - consent string to convey user consent when GDPR regulations are in effect.