com.pubmatic.sdk.common

Class OpenWrapSDK

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, 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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY_SELECTED_REWARD Key to define the selected reward among multiple configured rewards

Constructor Summary

Constructors

Constructor and Description
OpenWrapSDK()

Method Summary

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 POBDSAComplianceStatus	getDSAComplianceStatus() Gets the current DSA (Digital Services Act) required flag.
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	initialize(Context context, OpenWrapSDKConfig sdkConfig, OpenWrapSDKInitializer.Listener listener) Initializes the OpenWrap SDK with the provided configuration and context.
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	setCoppa(boolean coppaState) Indicates whether the visitor is COPPA-specific or not.
static void	setDSAComplianceStatus(POBDSAComplianceStatus dsaComplianceStatus) Sets the DSA (Digital Services Act) required flag.
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 the 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

Constructor Detail

OpenWrapSDK

public OpenWrapSDK()

Method Detail

initialize

@AnyThread
public static void initialize(@NonNull
                                         Context context,
                                         @NonNull
                                         OpenWrapSDKConfig sdkConfig,
                                         @NonNull
                                         OpenWrapSDKInitializer.Listener listener)

Initializes the OpenWrap SDK with the provided configuration and context.
This static method serves as a convenient entry point to initialize the OpenWrap SDK using the specified context and SDK configuration. Upon completion of the initialization process, the specified listener is notified of the outcome through its onSuccess or onFailure methods.

Parameters:

context - The context, used for SDK initialization.

sdkConfig - The configuration settings for the OpenWrap SDK, including publisher ID and profile IDs.

listener - An implementation of the OpenWrapSDKInitializer.Listener interface, which will be notified upon the success or failure of the SDK initialization.

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 the internal SDK browser, instead of the default device browser, for opening landing pages when the user clicks on an ad. By default, the use of an internal browser is disabled.

From version 2.7.0, the default behaviour changed to using device's default browser

Parameters:

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

setDSAComplianceStatus

public static void setDSAComplianceStatus(@NonNull
                                          POBDSAComplianceStatus dsaComplianceStatus)

Sets the DSA (Digital Services Act) required flag.

Parameters:

dsaComplianceStatus - DSA required flag. Values -
POBDSAComplianceStatus#NOT_REQUIRED = Not required POBDSAComplianceStatus#OPTIONAL = Supported, bid responses with or without the DSA object will be accepted POBDSAComplianceStatus#REQUIRED = Required, bid responses without a DSA object will not be accepted POBDSAComplianceStatus#REQUIRED_PUB_ONLINE_PLATFORM = Required, bid responses without DSA object will not be accepted, Publisher is an Online Platform Default value is POBDSAComplianceStatus#NOT_REQUIRED

getDSAComplianceStatus

public static POBDSAComplianceStatus getDSAComplianceStatus()

Gets the current DSA (Digital Services Act) required flag.
POBDSAComplianceStatus#NOT_REQUIRED = Not required POBDSAComplianceStatus#OPTIONAL = Supported, bid responses with or without the DSA object will be accepted POBDSAComplianceStatus#REQUIRED = Required, bid responses without a DSA object will not be accepted POBDSAComplianceStatus#REQUIRED_PUB_ONLINE_PLATFORM = Required, bid responses without DSA object will not be accepted, Publisher is an Online Platform

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

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