com.flurry.android

Class FlurryAds

java.lang.Object

com.flurry.android.FlurryAds

Deprecated.

We recommend using the new object-based APIs in #com.flurry.android.ads unless you are creating an interface to third party network mediation using #ICustomAdNetworkHandler.

@Deprecated
public class FlurryAds
extends Object

The Flurry Android Advertising SDK. Flurry For Publishers is the data-powered monetization platform that delivers targeted audience segments to your advertisers and networks. Powered by Flurry's enormous dataset with audience insights gathered from 700M devices, FFP enables you to maximize CPMs and fill rates across your iOS and Android applications.

Author:

2009-2015 Flurry, Inc. All Rights Reserved

See Also:

Flurry Publisher Support Site

Method Summary

Methods

Modifier and Type	Method and Description
static void	clearLocation() Deprecated. We recommend using the new object-based APIs in the com.flurry.android.ads package.
static void	clearTargetingKeywords() Deprecated. We recommend using the new object-based APIs in the com.flurry.android.ads package.
static void	clearUserCookies() Deprecated. We recommend using the new object-based APIs in the com.flurry.android.ads package.
static void	displayAd(Context context, String adSpace, ViewGroup viewGroup) Deprecated. We recommend using the new object-based APIs in the com.flurry.android.ads package.
static void	enableTestAds(boolean test) Deprecated. We recommend using the new object-based APIs in the com.flurry.android.ads package.
static void	fetchAd(Context context, String adSpace, ViewGroup viewGroup, FlurryAdSize size) Deprecated. We recommend using the new object-based APIs in the com.flurry.android.ads package.
static boolean	getAd(Context context, String adSpace, ViewGroup viewGroup, FlurryAdSize size, long timeout) Deprecated. We recommend using the asynchronous ad serving flow with fetchAd(android.content.Context, java.lang.String, android.view.ViewGroup, com.flurry.android.FlurryAdSize), displayAd(android.content.Context, java.lang.String, android.view.ViewGroup)
static void	initializeAds(Context context) Deprecated. initializeAds is now handled automatically.
static boolean	isAdAvailable(Context context, String adSpace, FlurryAdSize size, long timeout) Deprecated. We recommend using the asynchronous ad serving flow with fetchAd(android.content.Context, java.lang.String, android.view.ViewGroup, com.flurry.android.FlurryAdSize), displayAd(android.content.Context, java.lang.String, android.view.ViewGroup)
static boolean	isAdReady(String adSpace) Deprecated. We recommend using the new object-based APIs in the com.flurry.android.ads package.
static void	removeAd(Context context, String adSpace, ViewGroup viewGroup) Deprecated. We recommend using the new object-based APIs in the com.flurry.android.ads package.
static void	setAdListener(FlurryAdListener listener) Deprecated. We recommend using the new object-based APIs in the com.flurry.android.ads package.
static void	setCustomAdNetworkHandler(ICustomAdNetworkHandler handler) Deprecated. Sets the class which handles custom ad networking.
static void	setLocation(float lat, float lon) Deprecated. We recommend using the new object-based APIs in the com.flurry.android.ads package.
static void	setTargetingKeywords(Map<String,String> targetingKeywords) Deprecated. We recommend using the new object-based APIs in the com.flurry.android.ads package.
static void	setUserCookies(Map<String,String> userCookies) Deprecated. We recommend using the new object-based APIs in the com.flurry.android.ads package.

Methods inherited from class java.lang.Object

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

Method Detail

getAd

@Deprecated
public static boolean getAd(Context context,
                       String adSpace,
                       ViewGroup viewGroup,
                       FlurryAdSize size,
                       long timeout)

Deprecated. We recommend using the asynchronous ad serving flow with fetchAd(android.content.Context, java.lang.String, android.view.ViewGroup, com.flurry.android.FlurryAdSize), displayAd(android.content.Context, java.lang.String, android.view.ViewGroup)

FlurryAdListener, instead of using this method. Request an ad from the Flurry ad server then render it. MUST be called from the main thread.

Parameters:

context - A reference to a Context object such as an Activity or an Service.

adSpace - The placement of the ad within your app. For example, for a splash screen ad, it might be named "SPLASH_SCREEN"

viewGroup - The ViewGroup into which the ad will be placed if the returned ad is a banner. In the case that the ad returned is a full screen ad, a Flurry built Activity will be launched which contains the ad, and the viewGroup that is passed in will be ignored. In most cases this should be an instance of RelativeLayout. If it's another subclass of ViewGroup, the alignment will be ignored, and the ad will be added to the ViewGroup with basic layout settings only.

size - The default size of the adSpace. This can be overridden on the server. See FlurryAdSize for more details.

timeout - The maximum amount of time to wait for the server to return a result. Set this to 0 to conduct this operation in the background.

Returns:

true if an ad was shown, or false otherwise

Since:

3.0.0

initializeAds

@Deprecated
public static void initializeAds(Context context)

Deprecated. initializeAds is now handled automatically.

Request ads from the Flurry ad server for ad spaces with pre-caching enabled.

Parameters:

context - A reference to a Context object such as an Activity or an Service.

Since:

3.0.0 Makes an asynchronous ad request to the Flurry ad server, which will respond with ads for ad spaces that have pre-caching enabled (in the ad space set up screen for your app). If you do not enable pre-caching for any ad spaces, there's no need to call this method.

See Also:

Getting Started

isAdAvailable

@Deprecated
public static boolean isAdAvailable(Context context,
                               String adSpace,
                               FlurryAdSize size,
                               long timeout)

Deprecated. We recommend using the asynchronous ad serving flow with fetchAd(android.content.Context, java.lang.String, android.view.ViewGroup, com.flurry.android.FlurryAdSize), displayAd(android.content.Context, java.lang.String, android.view.ViewGroup)

FlurryAdListener, instead of using this method. Returns true if an ad is available from the Flurry ad server for the specified ad space.

Parameters:

context - A reference to a Context object such as an Activity or an Service.

adSpace - The placement of the ad within your app. For example, for a splash screen ad, it might be named "SPLASH_SCREEN"

size - The default size of the adSpace. This can be overridden on the server. See FlurryAdSize for more details.

timeout - The maximum amount of time to wait for the server to return a result. Set this to 0 to check the cache and return immediately.

Returns:

true if ads are available to show, or false otherwise

Since:

3.0.0

isAdReady

@Deprecated
public static boolean isAdReady(String adSpace)

Deprecated. We recommend using the new object-based APIs in the com.flurry.android.ads package.

Returns true if an ad has been fetched and prepared by a previous call to #fetchAd.

Parameters:

adSpace - The placement of the ad within your app. For example, for a splash screen ad, it might be named "SPLASH_SCREEN"

Returns:

true if an ad has been prepared and calling #displayAd would render an ad for this ad space.

Since:

3.2.1

fetchAd

@Deprecated
public static void fetchAd(Context context,
                      String adSpace,
                      ViewGroup viewGroup,
                      FlurryAdSize size)

Deprecated. We recommend using the new object-based APIs in the com.flurry.android.ads package.

Makes zero or one asynchronous ad requests and prepares an ad for display. In order to use this method correctly, you should implement FlurryAdListener. After an ad is successfully fetched and prepared, the SDK will call FlurryAdListener.spaceDidReceiveAd. Your implementation of this method should call FlurryAds.displayAd. public class Example extends Activity implements FlurryAdListener { FrameLayout mBanner; public void onCreate(Bundle bundle) { super.onCreate(bundle); setContentView(R.layout.example); mBanner = (FrameLayout)findViewById(R.id.banner); FlurryAds.setAdListener(this); } public void onStart() { super.onStart(); FlurryAgent.onStartSession(this, mApiKey); FlurryAds.fetchAd(this, mAdSpaceName, mBanner, FlurryAdSize.BANNER_BOTTOM); } public void spaceDidReceiveAd(String adSpace) { FlurryAds.displayAd(this, mAdSpaceName, mBanner); } }

Parameters:

context - A reference to a Context object such as an Activity or an Service.

adSpace - The placement of the ad within your app. For example, for a splash screen ad, it might be named "SPLASH_SCREEN"

size - The default size of the adSpace. This can be overridden on the server. See FlurryAdSize for more details.

Since:

3.0.9

displayAd

@Deprecated
public static void displayAd(Context context,
                        String adSpace,
                        ViewGroup viewGroup)

Deprecated. We recommend using the new object-based APIs in the com.flurry.android.ads package.

Displays an ad that was previously fetched and prepared This method should be used in conjunction with #fetchAd.

Parameters:

context - A reference to a Context object such as an Activity or an Service.

adSpace - The placement of the ad within your app. For example, for a splash screen ad, it might be named "SPLASH_SCREEN"

viewGroup -

Since:

3.0.9

removeAd

@Deprecated
public static void removeAd(Context context,
                       String adSpace,
                       ViewGroup viewGroup)

Deprecated. We recommend using the new object-based APIs in the com.flurry.android.ads package.

Remove the adSpace ad from the specified viewGroup If it is necessary to remove an ad from the view of the user, calling removeAd(context, adSpace, viewGroup) will remove the ad for the specified adSpace. The adSpace simply represents the placement of the ad in your app and should be unique for each placement. Only one ad will show at a time for any given ad space.

Parameters:

context - A reference to a Context object such as an Activity or an Service.

adSpace - The adSpace of the ad

viewGroup - The ViewGroup which holds the ad

setAdListener

@Deprecated
public static void setAdListener(FlurryAdListener listener)

Deprecated. We recommend using the new object-based APIs in the com.flurry.android.ads package.

Set the FlurryAdListener for asynchronous ad serving. The FlurryAdListener is an interface which can be implemented to receive notification of various events associated with ads. If this method is called more than once, the previously set listener will be overridden, i.e. there can only be one listener.

Parameters:

listener - Your implementation of FlurryAdListener

See Also:

fetchAd(Context, String, ViewGroup, FlurryAdSize)

setLocation

@Deprecated
public static void setLocation(float lat,
                          float lon)

Deprecated. We recommend using the new object-based APIs in the com.flurry.android.ads package.

Set the default location. Useful when it is necessary to test ads from other countries or places, or if your app is location-aware and you do not wish the Flurry SDK to determine the user location via GPS.

Parameters:

lat - The latitude

lon - The longitude

clearLocation

@Deprecated
public static void clearLocation()

Deprecated. We recommend using the new object-based APIs in the com.flurry.android.ads package.

Clear the default location.

setCustomAdNetworkHandler

public static void setCustomAdNetworkHandler(ICustomAdNetworkHandler handler)

Deprecated.

Sets the class which handles custom ad networking. Useful when creating an interface to third party network mediation.

setUserCookies

@Deprecated
public static void setUserCookies(Map<String,String> userCookies)

Deprecated. We recommend using the new object-based APIs in the com.flurry.android.ads package.

Set a Map<String,String> of key/value pairs that will be transmitted to the Flurry servers when an ad is clicked. UserCookies allow the developer to specify information on a user executing an ad action. There is one UserCookie object, and on each ad click that UserCookie is transmitted to the Flurry servers. The UserCookie key/value pairs will be transmitted back to the developer via the app callback if one is set.

 //From the main Activity of the app
 public void onStart() {
  FlurryAgent.onStartSession(this, myApiKey);

  //Create a Map<String,String> to hold the user cookies
  Map<String, String> uCookies = new HashMap<String, String>();
  uCookies.put("userId", getUserId());
  FlurryAgent.setUserCookies(uCookies);
 }
 
 

Parameters:

userCookies -

Since:

3.0.0

See Also:

for clearing the user cookies

clearUserCookies

@Deprecated
public static void clearUserCookies()

Deprecated. We recommend using the new object-based APIs in the com.flurry.android.ads package.

Clear the UserCookies object such that no UserCookies information will be transmitted with an ad click.

Since:

3.0.0

See Also:

setUserCookies(Map)

setTargetingKeywords

@Deprecated
public static void setTargetingKeywords(Map<String,String> targetingKeywords)

Deprecated. We recommend using the new object-based APIs in the com.flurry.android.ads package.

Set a Map<String,String> of key/value pairs to send to the Flurry servers when an ad is requested. Keywords allow the developer to specify information on a user executing an ad action for the purposes of targeting. There is one keywords object that is transmitted to the Flurry servers on each ad request. If corresponding keywords are matched on the ad server, a subset of targeted ads will be delivered. This allows partners to supply information they track internally, which is not available to Flurry's targeting system.

 //From the main Activity of the app
 public void onStart() {
  FlurryAgent.onStartSession(this, myApiKey);
 //Create a Map of keywords
 Map<String, String> keywords = new HashMap<String, String>();
 keywords.put("favoriteColor", getFavoriteColor());
 FlurryAgent.setTargetingKeywords(keywords);
 }
 
 

Parameters:

targetingKeywords - A Map<String,String> of key/value keywords

Since:

3.0.0

See Also:

clearTargetingKeywords()

clearTargetingKeywords

@Deprecated
public static void clearTargetingKeywords()

Deprecated. We recommend using the new object-based APIs in the com.flurry.android.ads package.

Clear the targeting keywords of so that no keywords are transmitted when ads are requested.

Since:

3.0.0

See Also:

setTargetingKeywords(Map)

enableTestAds

@Deprecated
public static void enableTestAds(boolean test)

Deprecated. We recommend using the new object-based APIs in the com.flurry.android.ads package.

Call to receive test ads from the Flurry server to ensure proper implementation. Test ads do not generate revenue and therefore MUST be disabled before submitting to the Market.

Parameters:

test -