com.criteo.publisher

Class BidManager

java.lang.Object

com.criteo.publisher.BidManager

All Implemented Interfaces:

ApplicationStoppedListener

public class BidManager
extends java.lang.Object
implements ApplicationStoppedListener

Method Summary

Modifier and Type	Method and Description
Slot	getBidForAdUnitAndPrefetch(AdUnit adUnit) Returns the last fetched bid a fetch a new one for the next invocation.
void	onApplicationStopped()
void	prefetch(java.util.List<AdUnit> adUnits) This method is called back after the "useragent" is fetched

Methods inherited from class java.lang.Object

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

Method Detail

getBidForAdUnitAndPrefetch

@Nullable
public Slot getBidForAdUnitAndPrefetch(@Nullable
                                                 AdUnit adUnit)

Returns the last fetched bid a fetch a new one for the next invocation.

A null value could be returned. This means that there is no valid bid for the given AdUnit. And caller should not try to display anything. null may be returned in case of

• The kill switch is engaged. See Config.isKillSwitchEnabled()
• The given AdUnit is not valid. See AdUnitMapper for validity definition
• There is no last fetch bid or last is consumed
• Last fetch bid correspond to a no-bid (CPM = 0 and TTL = 0)
• Last fetch bid is a not-expired silence (CPM = 0 and TTL > 0)
• Last fetch bid is expired

Asynchronously, a new bid is fetch to CDB to get a new proposition. Hence if this method returns a bid, it is consumed, and you have to wait for the new proposition to get a result again. Meanwhile, you'll only get a null value. There may be some case when a new bid is not fetch:

• The kill switch is engaged
• The given AdUnit is not valid
• Last fetch bid is a not-expired silence
• There is already an async call to CDB for the given AdUnit

Parameters:

adUnit - Declaration of ad unit to get a bid from

Returns:

a valid bid that may be displayed or null that should be ignored

onApplicationStopped

public void onApplicationStopped()

Specified by:

onApplicationStopped in interface ApplicationStoppedListener

prefetch

public void prefetch(@NonNull
                     java.util.List<AdUnit> adUnits)

This method is called back after the "useragent" is fetched

Parameters:

adUnits - list of ad units to prefetch