com.adcolony.sdk

Class AdColonyAppOptions

java.lang.Object

com.adcolony.sdk.AdColonyAppOptions

public class AdColonyAppOptions
extends java.lang.Object

App specific options to be created, set, and passed when configuring AdColony. Includes data used for server side reward validation, such as the user ID, and user metadata that may improve our ad targeting.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADMARVEL
static java.lang.String	ADMOB
static java.lang.String	ADOBEAIR
static java.lang.String	AERSERVE
static int	ALL
static java.lang.String	APPODEAL
static java.lang.String	COCOS2DX
static java.lang.String	CORONA
static java.lang.String	FUSEPOWERED
static java.lang.String	FYBER
static java.lang.String	IRONSOURCE
static int	LANDSCAPE
static java.lang.String	MOPUB
static int	PORTRAIT
static int	SENSOR Deprecated.
static java.lang.String	UNITY

Constructor Summary

Constructors

Constructor and Description
AdColonyAppOptions()

Method Summary

Modifier and Type	Method and Description
int	getAppOrientation() Used to retrieve the app orientation set in the app options.
java.lang.String	getAppVersion() Used to retrieve the app version set in the app options.
boolean	getKeepScreenOn() Used to retrieve the current setting for keepScreenOn.
org.json.JSONObject	getMediationInfo() Used to retrieve the currently set mediation info.
static AdColonyAppOptions	getMoPubAppOptions(java.lang.String clientOptions) Used to return app options when configuring the origin store and app version via MoPub's dashboard
boolean	getMultiWindowEnabled() Used to retrieve the multi-window enabled flag
java.lang.Object	getOption(java.lang.String key) Used to retrieve an arbitrary option with the given key.
java.lang.String	getOriginStore() Used to retrieve the origin store set in the app options.
org.json.JSONObject	getPluginInfo() Used to retrieve the currently set plugin info.
int	getRequestedAdOrientation() Used to retrieve the orientation set in the app options.
boolean	getTestModeEnabled() Used to retrieve the test mode enabled flag
java.lang.String	getUserID() Used to retrieve the unique user id set in the app options.
AdColonyUserMetadata	getUserMetadata() Used to retrieve the currently set user metadata.
AdColonyAppOptions	setAppOrientation(int orientation) Optionally send a constant representing the orientation of your app.
AdColonyAppOptions	setAppVersion(java.lang.String app_version) Optionally set an app version to be reported to AdColony.
AdColonyAppOptions	setKeepScreenOn(boolean keepScreenOn) Used to programmatically set a flag on our Activity's window to keep the display from going to sleep.
AdColonyAppOptions	setMediationNetwork(java.lang.String name, java.lang.String version) Used to send information about the mediation network that has implemented AdColony
AdColonyAppOptions	setMultiWindowEnabled(boolean enabled) Used to alert AdColony that multi-window is enabled for your app, allowing us to adjust our interstitial layout as necessary.
AdColonyAppOptions	setOption(java.lang.String key, boolean value) Optionally set an arbitrary key/value definition
AdColonyAppOptions	setOption(java.lang.String key, double value) Optionally set an arbitrary key/value definition
AdColonyAppOptions	setOption(java.lang.String key, java.lang.String value) Optionally set an arbitrary key/value definition
AdColonyAppOptions	setOriginStore(java.lang.String origin_store) Optionally set the origin store for this app (default: 'google').
AdColonyAppOptions	setPlugin(java.lang.String name, java.lang.String version) Used to send information about the plugin AdColony wrapper.
AdColonyAppOptions	setRequestedAdOrientation(int orientation) Optionally send a requested orientation for interstitials to be displayed in.
AdColonyAppOptions	setTestModeEnabled(boolean enabled) Used to enable test ads for your application without changing dashboard settings.
AdColonyAppOptions	setUserID(java.lang.String user_id) Optionally set a unique id for this specific app session to be reported to AdColony.
AdColonyAppOptions	setUserMetadata(AdColonyUserMetadata metadata) Used to send AdColony extra information about this user.

Methods inherited from class java.lang.Object

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

Field Detail

PORTRAIT

public static final int PORTRAIT

See Also:

Constant Field Values

LANDSCAPE

public static final int LANDSCAPE

See Also:

Constant Field Values

ALL

public static final int ALL

See Also:

Constant Field Values

ADMOB

public static final java.lang.String ADMOB

See Also:

Constant Field Values

MOPUB

public static final java.lang.String MOPUB

See Also:

Constant Field Values

IRONSOURCE

public static final java.lang.String IRONSOURCE

See Also:

Constant Field Values

APPODEAL

public static final java.lang.String APPODEAL

See Also:

Constant Field Values

FUSEPOWERED

public static final java.lang.String FUSEPOWERED

See Also:

Constant Field Values

AERSERVE

public static final java.lang.String AERSERVE

See Also:

Constant Field Values

ADMARVEL

public static final java.lang.String ADMARVEL

See Also:

Constant Field Values

FYBER

public static final java.lang.String FYBER

See Also:

Constant Field Values

UNITY

public static final java.lang.String UNITY

See Also:

Constant Field Values

ADOBEAIR

public static final java.lang.String ADOBEAIR

See Also:

Constant Field Values

COCOS2DX

public static final java.lang.String COCOS2DX

See Also:

Constant Field Values

CORONA

public static final java.lang.String CORONA

See Also:

Constant Field Values

SENSOR

@Deprecated
public static final int SENSOR

Deprecated.

See Also:

Constant Field Values

Constructor Detail

AdColonyAppOptions

public AdColonyAppOptions()

Method Detail

setAppVersion

public AdColonyAppOptions setAppVersion(@NonNull
                                        java.lang.String app_version)

Optionally set an app version to be reported to AdColony.

Parameters:

app_version - the version of your app.

Returns:

'this' for chaining calls.

getAppVersion

public java.lang.String getAppVersion()

Used to retrieve the app version set in the app options.

Returns:

the app version that has been set, or an empty String if no app version has been set.

setUserID

public AdColonyAppOptions setUserID(@NonNull
                                    java.lang.String user_id)

Optionally set a unique id for this specific app session to be reported to AdColony.

Parameters:

user_id - the unique id for this user.

Returns:

'this' for chaining calls.

getUserID

public java.lang.String getUserID()

Used to retrieve the unique user id set in the app options.

Returns:

the user id, or an empty String if it has not been set.

setOption

public AdColonyAppOptions setOption(@NonNull
                                    java.lang.String key,
                                    boolean value)

Optionally set an arbitrary key/value definition

Parameters:

key - the key for this option mapping.

value - the value for this option mapping.

Returns:

'this' for chaining calls.

getOption

public java.lang.Object getOption(@NonNull
                                  java.lang.String key)

Used to retrieve an arbitrary option with the given key.

Parameters:

key - the key of the option you wish to retrieve.

Returns:

the value mapped to the provided key, or false if the mapping does not exist.

setOption

public AdColonyAppOptions setOption(@NonNull
                                    java.lang.String key,
                                    double value)

Optionally set an arbitrary key/value definition

Parameters:

key - the key for this option mapping.

value - the value for this option mapping.

Returns:

'this' for chaining calls.

setOption

public AdColonyAppOptions setOption(@NonNull
                                    java.lang.String key,
                                    @NonNull
                                    java.lang.String value)

Optionally set an arbitrary key/value definition

Parameters:

key - the key for ths option mapping.

value - the value for this option mapping.

Returns:

'this' for chaining calls.

setOriginStore

public AdColonyAppOptions setOriginStore(@NonNull
                                         java.lang.String origin_store)

Optionally set the origin store for this app (default: 'google').

Parameters:

origin_store - the origin store for this device.

Returns:

'this' for chaining calls.

getOriginStore

public java.lang.String getOriginStore()

Used to retrieve the origin store set in the app options.

Returns:

the origin store, "google" by default.

setRequestedAdOrientation

public AdColonyAppOptions setRequestedAdOrientation(int orientation)

Optionally send a requested orientation for interstitials to be displayed in.

Parameters:

orientation - one of the orientation constants defined in this class.

Returns:

'this' for chaining calls.

getRequestedAdOrientation

public int getRequestedAdOrientation()

Used to retrieve the orientation set in the app options.

Returns:

the orientation that has been set, or -1 if it has not been set.

setAppOrientation

public AdColonyAppOptions setAppOrientation(int orientation)

Optionally send a constant representing the orientation of your app.

Parameters:

orientation - one of the orientation constants defined in this class.

Returns:

'this' for chaining calls.

getAppOrientation

public int getAppOrientation()

Used to retrieve the app orientation set in the app options.

Returns:

the orientation that has been set, or -1 if it has not been set.

setUserMetadata

public AdColonyAppOptions setUserMetadata(@NonNull
                                          AdColonyUserMetadata metadata)

Used to send AdColony extra information about this user.

Parameters:

metadata - the AdColonyUserMetadata object to send.

Returns:

'this' for chaining calls.

See Also:

AdColonyUserMetadata

setTestModeEnabled

public AdColonyAppOptions setTestModeEnabled(boolean enabled)

Used to enable test ads for your application without changing dashboard settings.

Parameters:

enabled - represents whether or not to enable test ads for your application.

Returns:

'this' for chaining calls.

getTestModeEnabled

public boolean getTestModeEnabled()

Used to retrieve the test mode enabled flag

Returns:

whether or not test mode has been enabled in the app options.

setMultiWindowEnabled

public AdColonyAppOptions setMultiWindowEnabled(boolean enabled)

Used to alert AdColony that multi-window is enabled for your app, allowing us to adjust our interstitial layout as necessary.

Parameters:

enabled - represents whether or not multi window is enabled for your app.

Returns:

'this' for chaining calls.

getMultiWindowEnabled

public boolean getMultiWindowEnabled()

Used to retrieve the multi-window enabled flag

Returns:

whether or not multi-window has been enabled in the app options.

getUserMetadata

public AdColonyUserMetadata getUserMetadata()

Used to retrieve the currently set user metadata.

Returns:

the currently set AdColonyUserMetadata object. Will return null if it has not been set.

See Also:

AdColonyUserMetadata

setMediationNetwork

public AdColonyAppOptions setMediationNetwork(@NonNull
                                              java.lang.String name,
                                              @NonNull
                                              java.lang.String version)

Used to send information about the mediation network that has implemented AdColony

Parameters:

name - the name of the network

version - the version of the adapter

Returns:

'this' for chaining calls.

getMediationInfo

public org.json.JSONObject getMediationInfo()

Used to retrieve the currently set mediation info.

Returns:

a JSON object with keys 'name' and 'version' representing what was set via setMediationNetwork(String, String). Will be mapped to empty Strings if this option has not been set.

setPlugin

public AdColonyAppOptions setPlugin(@NonNull
                                    java.lang.String name,
                                    @NonNull
                                    java.lang.String version)

Used to send information about the plugin AdColony wrapper.

Parameters:

name - the name of the plugin

version - the version of the plugin wrapper

Returns:

'this' for chaining calls.

getPluginInfo

public org.json.JSONObject getPluginInfo()

Used to retrieve the currently set plugin info.

Returns:

a JSON object with keys 'name' and 'version' representing what was set via setPlugin(String, String). Will be mapped to empty Strings if this option has not been set.

setKeepScreenOn

public AdColonyAppOptions setKeepScreenOn(boolean keepScreenOn)

Used to programmatically set a flag on our Activity's window to keep the display from going to sleep.

Parameters:

keepScreenOn - whether or not to keep the screen on

Returns:

'this' for chaining calls.

getKeepScreenOn

public boolean getKeepScreenOn()

Used to retrieve the current setting for keepScreenOn.

Returns:

the current setting for keepScreenOn.

getMoPubAppOptions

public static AdColonyAppOptions getMoPubAppOptions(@NonNull
                                                    java.lang.String clientOptions)

Used to return app options when configuring the origin store and app version via MoPub's dashboard

Returns:

AdColonyAppOptions that were configured with the parameters on MoPub's dashboard or null if the options are invalid

See Also:

AdColonyAppOptions