com.feedad.android

Class FeedAd

java.lang.Object

com.feedad.android.FeedAd

public final class FeedAd
extends java.lang.Object

This class initializes and configures the FeedAd SDK.
It can be used to request ads and to observe SDK behaviour.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TAG
static java.lang.String	VERSION The FeedAd SDK version

Method Summary

Modifier and Type	Method and Description
static void	addListener(FeedAdListener listener) Add a new listener that gets notified about Feedclip-SDK Events.
static boolean	canRequestAd(java.lang.String placementId) This method is only useful for standalone ads or interstitials.
static CustomParameters	customParameters() Returns an object to set custom parameters for all ad requests or for requests of specific placements.
static void	init(android.content.Context context, java.lang.String clientToken) Deprecated. Please use the init(Context, String, boolean, boolean) method.
static void	init(android.content.Context context, java.lang.String clientToken, boolean enableLogging) Deprecated. Please use the init(Context, String, boolean, boolean) method.
static void	init(android.content.Context context, java.lang.String clientToken, boolean enableLogging, boolean waitForConsent) Initializes the SDK.
static boolean	isActive(java.lang.String placementId) Checks if the SDK is currently playing an ad of a given placement's group.
static boolean	isRequesting(java.lang.String placementId) Checks if the SDK is currently loading an ad of a placement group of a given placement id.
static boolean	isSupported() Checks if the FeedAd ads are supported on the current device
static void	removeListener(FeedAdListener listener) Remove a previously registered FeedAdListener from the SDK
static void	requestAd(java.lang.String placementId) Manually requests an advertisement for a given placement ID.
static void	requestAd(java.lang.String placementId, RequestOptions requestOptions) Manually requests an advertisement for a given placement ID.
static InterstitialAd	requestInterstitialAd(android.content.Context context, java.lang.String placementId, InterstitialAdListener adListener) Request an interstitial ad.
static InterstitialAd	requestInterstitialAd(android.content.Context context, java.lang.String placementId, InterstitialAdListener adListener, RequestOptions requestOptions) Request an interstitial ad.
static StandaloneAd	requestStandaloneAd(android.content.Context context, java.lang.String placementId, StandaloneAdListener adListener) Request an ad that is displayed inside a single view.
static StandaloneAd	requestStandaloneAd(android.content.Context context, java.lang.String placementId, StandaloneAdListener adListener, RequestOptions requestOptions) Request an ad that is displayed inside a single view.
static void	sendCustomEvent(CustomEvent event) Sends a custom event to the FeedAd Server.
static void	setConfig(FeedAdConfig config) Configure the SDK with custom options like user id, age and gender.
static void	stop() Stops all current ad playback.
static boolean	validatePlacementId(java.lang.String placementId) Validate if the the placement ID is of a correct format.

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final java.lang.String VERSION

The FeedAd SDK version

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

Method Detail

validatePlacementId

public static boolean validatePlacementId(@Nullable
                                          java.lang.String placementId)

Validate if the the placement ID is of a correct format.
Valid IDs are words of lowercase letters from a to z and numbers from 0 to 9.
The words can be separated by hyphens or underscores.
Multiple separators must not follow each other.

Parameters:

placementId - the placement id to validate

Returns:

true if the format is valid

isSupported

public static boolean isSupported()

Checks if the FeedAd ads are supported on the current device

Returns:

true if ads are supported

init

@Deprecated
public static void init(android.content.Context context,
                                    java.lang.String clientToken)

Deprecated. Please use the init(Context, String, boolean, boolean) method.

Initializes the SDK. This method must be called before ad requests are executed. This method should only be called once. If it is called multiple times, all calls after the first one will be ignored.

Parameters:

context - any context instance

clientToken - the client token that can be obtained via the SDK admin website.

init

@Deprecated
public static void init(android.content.Context context,
                                    java.lang.String clientToken,
                                    boolean enableLogging)

Deprecated. Please use the init(Context, String, boolean, boolean) method.

Initializes the SDK. This method must be called before ad requests are executed. This method should only be called once. If it is called multiple times, all calls after the first one will be ignored.

Parameters:

context - any context instance

clientToken - the client token that can be obtained via the SDK admin website.

enableLogging - if the SDK should send log messages to logcat. All SDK log messages are prefixed by 'FeedAd:'

init

public static void init(android.content.Context context,
                        java.lang.String clientToken,
                        boolean enableLogging,
                        boolean waitForConsent)

Initializes the SDK. This method must be called before ad requests are executed. This method should only be called once. If it is called multiple times, all calls after the first one will be ignored.

Parameters:

context - any context instance

clientToken - the client token that can be obtained via the SDK admin website.

enableLogging - if the SDK should send log messages to logcat. All SDK log messages are prefixed by 'FeedAd:'

waitForConsent - if the SDK should wait for the initialization of a TCF 2.0 CMP

requestAd

public static void requestAd(@NonNull
                             java.lang.String placementId)

Manually requests an advertisement for a given placement ID.
If the SDK is currently playing an ad this ad will be stopped when calling this method.

Parameters:

placementId - the placement ID of the ad

requestAd

public static void requestAd(@NonNull
                             java.lang.String placementId,
                             @Nullable
                             RequestOptions requestOptions)

Manually requests an advertisement for a given placement ID.
If the SDK is currently playing an ad this ad will be stopped when calling this method.

Parameters:

placementId - the placement ID of the ad

requestOptions - Additional ad request options. Use AdRequestOptions.Builder to create them.

isActive

public static boolean isActive(java.lang.String placementId)

Checks if the SDK is currently playing an ad of a given placement's group.

Parameters:

placementId - the placement id to check for

Returns:

true if the SDK did finish loading the placement and is playing the placement or is waiting for a player view.

isRequesting

public static boolean isRequesting(java.lang.String placementId)

Checks if the SDK is currently loading an ad of a placement group of a given placement id.

Parameters:

placementId - the placement id to check for

Returns:

true if the SDK is currently requesting a placement

stop

public static void stop()

Stops all current ad playback.

requestStandaloneAd

@NonNull
public static StandaloneAd requestStandaloneAd(@NonNull
                                                        android.content.Context context,
                                                        @NonNull
                                                        java.lang.String placementId,
                                                        @NonNull
                                                        StandaloneAdListener adListener)

Request an ad that is displayed inside a single view.
The view itself is created by the SDK when the ad is ready and sent via the listener.

Parameters:

context - The context to request the ad for.

placementId - the placement to display

adListener - a listener with several callbacks for ad events. Use the StandaloneAdListener.onAdLoaded(StandaloneAdViewFactory) method to wait for the ad to be ready and include the ad view into your layout.

Returns:

a reference to the requested standalone ad. You can use this reference to cancel the ad request or playback at any time.

requestStandaloneAd

@NonNull
public static StandaloneAd requestStandaloneAd(@NonNull
                                                        android.content.Context context,
                                                        @NonNull
                                                        java.lang.String placementId,
                                                        @NonNull
                                                        StandaloneAdListener adListener,
                                                        @Nullable
                                                        RequestOptions requestOptions)

Request an ad that is displayed inside a single view.
The view itself is created by the SDK when the ad is ready and sent via the listener.

Parameters:

context - The context to request the ad for.

placementId - the placement to display

adListener - a listener with several callbacks for ad events. Use the StandaloneAdListener.onAdLoaded(StandaloneAdViewFactory) method to wait for the ad to be ready and include the ad view into your layout.

requestOptions - Additional ad request options. Use AdRequestOptions.Builder to create them.

Returns:

a reference to the requested standalone ad. You can use this reference to cancel the ad request or playback at any time.

requestInterstitialAd

@NonNull
public static InterstitialAd requestInterstitialAd(@NonNull
                                                            android.content.Context context,
                                                            @NonNull
                                                            java.lang.String placementId,
                                                            @NonNull
                                                            InterstitialAdListener adListener)

Request an interstitial ad. This will not automatically open an interstitial.
You can use the listener parameter to receive a callback once the ad is ready to open the interstitial.

Parameters:

context - Any context instance. The app context will be used internally. No strong activity reference will be held by the Interstitial Ad.

placementId - The placement to display

adListener - a listener with interstitial ad callbacks.
Once the ad is ready it will call the InterstitialAdListener.onAdLoaded(InterstitialAdPresenter) method. You can then display the interstitial using InterstitialAdPresenter.show(Activity, boolean).

Returns:

a reference to the requested interstitial ad. You can use this reference to cancel the ad request or close the interstitial at any time.

requestInterstitialAd

@NonNull
public static InterstitialAd requestInterstitialAd(@NonNull
                                                            android.content.Context context,
                                                            @NonNull
                                                            java.lang.String placementId,
                                                            @NonNull
                                                            InterstitialAdListener adListener,
                                                            @Nullable
                                                            RequestOptions requestOptions)

Request an interstitial ad. This will not automatically open an interstitial.
You can use the listener parameter to receive a callback once the ad is ready to open the interstitial.

Parameters:

context - Any context instance. The app context will be used internally. No strong activity reference will be held by the Interstitial Ad.

placementId - The placement to display

adListener - a listener with interstitial ad callbacks.
Once the ad is ready it will call the InterstitialAdListener.onAdLoaded(InterstitialAdPresenter) method. You can then display the interstitial using InterstitialAdPresenter.show(Activity, boolean).

requestOptions - Additional ad request options. Use AdRequestOptions.Builder to create them.

Returns:

a reference to the requested interstitial ad. You can use this reference to cancel the ad request or close the interstitial at any time.

canRequestAd

public static boolean canRequestAd(@NonNull
                                   java.lang.String placementId)

This method is only useful for standalone ads or interstitials.

Checks if an ad can be requested for the given placement. It is not required to call this method prior to requesting standalones or interstitials but checking it can save some time and prevent unnecessary network requests.

The value returned from this method is volatile and should only be used to check if an immediately following ad request would be sensible.

Parameters:

placementId - the placement to check

Returns:

true if an ad can be requested, false if an immediately following ad request is expected to fail.

sendCustomEvent

public static void sendCustomEvent(@NonNull
                                   CustomEvent event)

Sends a custom event to the FeedAd Server.
This can be used to track specific user actions. Custom events accept a revenue value which allows tracking for in-app-purchases or any other actions that generate revenue.

Parameters:

event - the event to send

Throws:

java.lang.NullPointerException - if the event is null

setConfig

public static void setConfig(@Nullable
                             FeedAdConfig config)

Configure the SDK with custom options like user id, age and gender.

Parameters:

config - the sdk config or null to revert remove all custom options. Use FeedAdConfig.newBuilder() to create the config.

customParameters

@NonNull
public static CustomParameters customParameters()

Returns an object to set custom parameters for all ad requests or for requests of specific placements.

Returns:

an object providing setters for the custom parameters.

See Also:

CustomParameters - for more info on how to set params

addListener

public static void addListener(FeedAdListener listener)

Add a new listener that gets notified about Feedclip-SDK Events.
CAREFUL!: Since Feedclip can play ads across activity changes the listeners are kept at application level. This can cause memory leaks if a FeedAdListener implementation keeps a reference to an activity-level Context. To prevent this, always call removeListener(FeedAdListener) at the appropriate lifecycle state.

Parameters:

listener - the listener to add to the SDK

removeListener

public static void removeListener(FeedAdListener listener)

Remove a previously registered FeedAdListener from the SDK

Parameters:

listener - the listener to remove.