com.vungle.warren

Class Vungle

java.lang.Object

com.vungle.warren.Vungle

public class Vungle
extends java.lang.Object

Main interface with the Vungle ad network.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Vungle.Consent GDPR Consent Status

Method Summary

Modifier and Type	Method and Description
static boolean	canPlayAd(java.lang.String id) Check if we can play an advertisement for the given placement.
static boolean	closeFlexViewAd(java.lang.String placementReferenceId) Closes currently playing Ad (only for Native FlexView , not supported for the Interstitial Ad formats) Currently ability to close already Playing ad is supported only for Placements that show FlexView ads.
static java.lang.String	getConsentMessageVersion()
static Vungle.Consent	getConsentStatus()
static VungleNativeAd	getNativeAd(java.lang.String placementId, AdConfig adConfig, PlayAdCallback playAdCallback) VungleNativeAd can be used inside any Android view container.
static VungleNativeAd	getNativeAd(java.lang.String placementId, PlayAdCallback playAdCallback) Deprecated.
static java.util.Collection<java.lang.String>	getValidPlacements()
static void	init(java.util.Collection<java.lang.String> placements, java.lang.String appId, android.content.Context context, InitCallback callback) Deprecated.
static void	init(java.lang.String appId, android.content.Context context, InitCallback callback) Initialize the Vungle SDK
static void	init(java.lang.String appId, android.content.Context context, InitCallback callback, VungleSettings settings) Initialize the Vungle SDK
static boolean	isInitialized() Checks if Vungle's SDK is already in initialized state
static void	loadAd(java.lang.String id, LoadAdCallback callback) Request the Vungle SDK to load the assets for an advertisement by the placement identifier.
static void	playAd(java.lang.String id, AdConfig settings, PlayAdCallback callback) Play an ad for the given placement ID.
static void	setHeaderBiddingCallback(com.vungle.warren.HeaderBiddingCallback headerBiddingCallback) Method to register Header bidding callback.
static void	setIncentivizedFields(java.lang.String userID, java.lang.String title, java.lang.String body, java.lang.String keepWatching, java.lang.String close) Overrides the previously-set incentivized fields which are used when warning the user if they are attempting to exit an incentivized advertisement prematurely.
static void	setUserLegacyID(java.lang.String legacyId) Set the user's legacy ID to pass through to Third Party Trackers for Attribution This would be effective only if this feature is enabled.
static void	updateConsentStatus(Vungle.Consent status, java.lang.String consentMessageVersion) If handling GDPR Consent dialog with own implementation, use this dialog to update Vungle on user consent status.

Methods inherited from class java.lang.Object

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

Method Detail

init

@Deprecated
public static void init(@NonNull
                                    java.util.Collection<java.lang.String> placements,
                                    @NonNull
                                    java.lang.String appId,
                                    @NonNull
                                    android.content.Context context,
                                    @NonNull
                                    InitCallback callback)
                             throws java.lang.IllegalArgumentException

Deprecated.

Initialize the Vungle SDK Please use init(String, Context, InitCallback) This method exists for backward compatibility. Placements pass in this method are ignored by the SDK. Placements will be filled in from the dashboard to get a list of Valid Placements, call getValidPlacements() after Vungle is initialized successfully

Parameters:

placements - Placements pass here will no longer be passed into SDK. Placements will be passed in from the dashboard.

appId - The identifier for the publisher application. This can be found in the vungle dashboard.

context - Application context.

callback - Callback that will be triggered once initialization has completed, or if any errors occur.

Throws:

java.lang.IllegalArgumentException - if InitCallback is null

init

public static void init(@NonNull
                        java.lang.String appId,
                        @NonNull
                        android.content.Context context,
                        @NonNull
                        InitCallback callback)
                 throws java.lang.IllegalArgumentException

Initialize the Vungle SDK

Parameters:

appId - The identifier for the publisher application. This can be found in the vungle dashboard.

context - Application context.

callback - Callback that will be triggered once initialization has completed, or if any errors occur.

Throws:

java.lang.IllegalArgumentException - if InitCallback is null

init

public static void init(@NonNull
                        java.lang.String appId,
                        @NonNull
                        android.content.Context context,
                        @NonNull
                        InitCallback callback,
                        @NonNull
                        VungleSettings settings)
                 throws java.lang.IllegalArgumentException

Initialize the Vungle SDK

Parameters:

appId - The identifier for the publisher application. This can be found in the vungle dashboard.

context - Application context.

callback - Callback that will be triggered once initialization has completed, or if any errors occur.

settings - Vungle's settings

Throws:

java.lang.IllegalArgumentException - if InitCallback is null

isInitialized

public static boolean isInitialized()

Checks if Vungle's SDK is already in initialized state

Returns:

true if Vungle SDK is initialized, false otherwise.

setIncentivizedFields

public static void setIncentivizedFields(@Nullable
                                         java.lang.String userID,
                                         @Nullable
                                         java.lang.String title,
                                         @Nullable
                                         java.lang.String body,
                                         @Nullable
                                         java.lang.String keepWatching,
                                         @Nullable
                                         java.lang.String close)

Overrides the previously-set incentivized fields which are used when warning the user if they are attempting to exit an incentivized advertisement prematurely. If there are no local values set, the SDK will use the values set in the Vungle Dashboard as the defaults. This method must be called **before** playAd(String, AdConfig, PlayAdCallback) is called.

Parameters:

title - The dialog box title

body - The dialog box body text. Values longer than the space allows for will be ellipsised at the end.

keepWatching - Continue button text

close - Close button text.

canPlayAd

public static boolean canPlayAd(@NonNull
                                java.lang.String id)

Check if we can play an advertisement for the given placement. This method checks out file system to see if there are asset files for the given placement and returns true if we have assets stored which have not expired.

Parameters:

id - The placement identifier.

Returns:

true if an advertisement can be played immediately, false otherwise.

playAd

public static void playAd(@NonNull
                          java.lang.String id,
                          AdConfig settings,
                          @Nullable
                          PlayAdCallback callback)

Play an ad for the given placement ID. If this placement ID is valid and an advertisement is ready to be played, this will cause the VungleActivity to start and the advertisement will be rendered.

Parameters:

id - The placement identifier.

settings - Optional settings for playing the advertisement. The full list can be found at AdConfig documentation.

callback - Optional, though strongly encouraged, event listener. This object will be notified of the advertisement starting, ending, and any errors that occur during rendering.

loadAd

public static void loadAd(@NonNull
                          java.lang.String id,
                          @Nullable
                          LoadAdCallback callback)

Request the Vungle SDK to load the assets for an advertisement by the placement identifier. This will cause us to request an ad from the Ad Server, and if the bid is filled, the assets will be downloaded. It is possible for the bid to get no responses and therefore no assets will be loaded. In this case, the SDK will automatically retry at a later time, specified by the Vungle Server. The callback will be notified that the assets are pending download.

Parameters:

id - The placement identifier for which assets should be loaded.

callback - The optional callback which will be notified when the assets are loaded, or if they are deferred. Errors will also be sent through this callback.

getNativeAd

@Deprecated
 @Nullable
public static VungleNativeAd getNativeAd(java.lang.String placementId,
                                                                PlayAdCallback playAdCallback)

Deprecated.

VungleNativeAd can be used inside any Android view container.

Parameters:

placementId - - placementId for Native ad Placement configured for the right AdSize

playAdCallback - - Callback to receive onAdStart, onAdEnd, onAdError Callbacks

Returns:

VungleNativeAd

getNativeAd

@Nullable
public static VungleNativeAd getNativeAd(java.lang.String placementId,
                                                   AdConfig adConfig,
                                                   PlayAdCallback playAdCallback)

VungleNativeAd can be used inside any Android view container.

Parameters:

placementId - - placementId for Native ad Placement configured for the right AdSize

adConfig - - Set the AdConfig.AdSize for Native Ad view corresponding to the Placement configuration

playAdCallback - - Callback to receive onAdStart, onAdEnd, onAdError Callbacks

Returns:

VungleNativeAd

getValidPlacements

public static java.util.Collection<java.lang.String> getValidPlacements()

updateConsentStatus

public static void updateConsentStatus(@NonNull
                                       Vungle.Consent status,
                                       @NonNull
                                       java.lang.String consentMessageVersion)

If handling GDPR Consent dialog with own implementation, use this dialog to update Vungle on user consent status.

Updates the data-gathering consent status of the user. This is gathered by the publisher and provided to Vungle. It is then stored on disk and used whenever we are sending information to the ad server.

Parameters:

status - If true, the user has consented to us gathering data about their device.

consentMessageVersion - Optional version string that can be passed indicating the version of your shown consent message users acted on

getConsentStatus

public static Vungle.Consent getConsentStatus()

Returns:

Whether a user for Vungle has Accepted GDPR Consent. Returns null if user has had the opportunity yet to make opt in or out.

getConsentMessageVersion

public static java.lang.String getConsentMessageVersion()

closeFlexViewAd

public static boolean closeFlexViewAd(@NonNull
                                      java.lang.String placementReferenceId)

Closes currently playing Ad (only for Native FlexView , not supported for the Interstitial Ad formats) Currently ability to close already Playing ad is supported only for Placements that show FlexView ads.

Parameters:

placementReferenceId - placement id.

Returns:

True if Vungle will attempt to close this ad. False if placement is invalid or app has state issue. For other errors you will receive an error message, check debug logs for additional detail.

setUserLegacyID

public static void setUserLegacyID(java.lang.String legacyId)

Set the user's legacy ID to pass through to Third Party Trackers for Attribution This would be effective only if this feature is enabled. We do not store this legacy ID, so this has to be set in every session before or after calling init(String, Context, InitCallback).

Parameters:

legacyId - any legacyID that can use used to uniquely identify user for attribution

setHeaderBiddingCallback

public static void setHeaderBiddingCallback(com.vungle.warren.HeaderBiddingCallback headerBiddingCallback)

Method to register Header bidding callback. It also enable SDK to participate in Header bidding.

Parameters:

headerBiddingCallback - HeaderBiddingCallback instance to get notified about bidding token and ad availability.