OpenWrapSDK (common API)

java.lang.Object
- com.pubmatic.sdk.common.OpenWrapSDK

```
public class OpenWrapSDK
extends java.lang.Object
```
Provides global configurations for the OpenWrap SDK, e.g. enabling logging, location access, GDPR, etc. These configurations are globally applicable for OpenWrap 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 OpenWrapSDK.LogLevel
Log levels to filter logs

Nested Classes
Modifier and Type	Class and Description
`static class`	`OpenWrapSDK.LogLevel` Log levels to filter logs

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`KEY_AD_SERVER_CUSTOM_DATA` Key to define the custom data to be forwarded to primary ad server SDK
`static java.lang.String`	`KEY_SELECTED_REWARD` Key to define the selected reward among multiple configured rewards

Constructor Summary

Constructors
Constructor and Description

OpenWrapSDK()

Constructors
Constructor and Description
`OpenWrapSDK()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addExternalUserId(POBExternalUserId userId)` API to Add the External user id /Data Partner ids which helps publisher in better user targeting
`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 POBApplicationInfo`	`getApplicationInfo()` Gets Application info set by publisher to OpenWrap SDK
`static java.util.List<POBExternalUserId>`	`getExternalUserIds()` API to get all set external user ids
`static POBUserInfo`	`getUserInfo()` Gets user info set by publisher to OpenWrap SDK
`static java.lang.String`	`getVersion()` Returns the OpenWrap SDK's version.
`static void`	`removeAllExternalUserIds()` API to remove all external user ids
`static void`	`removeExternalUserIds(java.lang.String source)` API to remove the external user ids of a particular source
`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`	`setCCPA(java.lang.String ccpaString)` Set the CCPA compliant string, it helps publisher toward compliance with the California Consumer Privacy Act (CCPA).
`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`	`setLocation(POBLocation location)` Sets user's location and its source.
`static void`	`setLogLevel(OpenWrapSDK.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 OpenWrap 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

- Field Detail
  - KEY_SELECTED_REWARD
```
public static final java.lang.String KEY_SELECTED_REWARD
```
    Key to define the selected reward among multiple configured rewards
    
    See Also:
    
    Constant Field Values
  - KEY_AD_SERVER_CUSTOM_DATA
```
public static final java.lang.String KEY_AD_SERVER_CUSTOM_DATA
```
    Key to define the custom data to be forwarded to primary ad server SDK
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - OpenWrapSDK
```
public OpenWrapSDK()
```
- Method Detail
  - setLogLevel
```
public static void setLogLevel(OpenWrapSDK.LogLevel level)
```
    Sets log level across all ad formats. Default log level is LogLevel.Warn. For more details refer OpenWrapSDK.LogLevel
    
    Parameters:
    
    level - log level to set.
  - getVersion
```
public static java.lang.String getVersion()
```
    Returns the OpenWrap SDK's version.
    
    Returns:
    
    sdk version
  - allowLocationAccess
```
public static void allowLocationAccess(boolean allow)
```
    Used to enable/disable location access. This value decides whether the OpenWrap 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 OpenWrap 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 OpenWrap 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, OpenWrap 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
  - 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
  - getApplicationInfo
```
@Nullable
public static POBApplicationInfo getApplicationInfo()
```
    Gets Application info set by publisher to OpenWrap SDK
    
    Returns:
    
    instance of POBApplicationInfo class
  - 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
  - getUserInfo
```
@Nullable
public static POBUserInfo getUserInfo()
```
    Gets user info set by publisher to OpenWrap SDK
    
    Returns:
    
    instance of POBUSerInfo class
  - 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.
  - setCCPA
```
public static void setCCPA(java.lang.String ccpaString)
```
    Set the CCPA compliant string, it helps publisher toward compliance with the California Consumer Privacy Act (CCPA). For more details refer https://www.iab.com/guidelines/ccpa-framework/ Make sure that the string value you use is compliant with the IAB Specification, refer https://iabtechlab.com/wp-content/uploads/2019/11/U.S.-Privacy-String-v1.0-IAB-Tech-Lab.pdf
    If this is not set, SDK looks for app's default SharedPreference with key 'IABUSPrivacy_String' If CCPA is applied through both options, the SDK will honour only API property. If both are not set then CCPA parameter is omitted from an ad request.
    
    Parameters:
    
    ccpaString - is the CCPA compliant string
  - addExternalUserId
```
public static void addExternalUserId(@NonNull
                                     POBExternalUserId userId)
```
    API to Add the External user id /Data Partner ids which helps publisher in better user targeting
    
    Parameters:
    
    userId - instance of POBExternalUserId class
  - getExternalUserIds
```
@NonNull
public static java.util.List<POBExternalUserId> getExternalUserIds()
```
    API to get all set external user ids
  - removeExternalUserIds
```
public static void removeExternalUserIds(@NonNull
                                         java.lang.String source)
```
    API to remove the external user ids of a particular source
    
    Parameters:
    
    source - name of source
  - removeAllExternalUserIds
```
public static void removeAllExternalUserIds()
```
    API to remove all external user ids

Class OpenWrapSDK

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

KEY_SELECTED_REWARD

KEY_AD_SERVER_CUSTOM_DATA

Constructor Detail

OpenWrapSDK

Method Detail

setLogLevel

getVersion

allowLocationAccess

setUseInternalBrowser

setLocation

setCoppa

setSSLEnabled

allowAdvertisingId

setApplicationInfo

getApplicationInfo

setUserInfo

getUserInfo

setGDPREnabled

setGDPRConsent

setCCPA

addExternalUserId

getExternalUserIds

removeExternalUserIds

removeAllExternalUserIds