public class OpenBidSDK
extends java.lang.Object
| 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 and Description |
|---|
OpenBidSDK() |
| 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.
|
public static void setLogLevel(OpenBidSDK.LogLevel level)
OpenBidSDK.LogLevellevel - log level to set.public static java.lang.String getVersion()
public static void allowLocationAccess(boolean allow)
allow - enable or disable location access behaviorpublic static void setUseInternalBrowser(boolean internalBrowserState)
internalBrowserState - boolean value that enables/disables the use of internal browser.public static void setLocation(POBLocation location)
location - User's current locationpublic static void setCoppa(boolean coppaState)
coppaState - Visitor state for COPPA compliance.public static void setSSLEnabled(boolean requestSecureCreative)
requestSecureCreative - false for disable secure creative mode. Default is set to true.public static void allowAdvertisingId(boolean allow)
allow - state of advertisement id usagepublic static void setHashTypeForAdvertisingId(OpenBidSDK.HashType advertisingIdHashType)
OpenBidSDK.HashTypeadvertisingIdHashType - hash type for advertisingId.public static void setApplicationInfo(POBApplicationInfo applicationInfo)
applicationInfo - Instance of POBApplicationInfo class with required application detailspublic static void setUserInfo(POBUserInfo userInfo)
userInfo - Instance of POBUserInfo class with required user detailspublic static void setGDPREnabled(boolean gdpr)
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.public static void setGDPRConsent(java.lang.String gdprConsent)
gdprConsent - consent string to convey user consent when GDPR regulations are in effect.