com.criteo.publisher.headerbidding

Class DfpHeaderBidding

java.lang.Object

com.criteo.publisher.headerbidding.DfpHeaderBidding

All Implemented Interfaces:

HeaderBiddingHandler

public class DfpHeaderBidding
extends java.lang.Object
implements HeaderBiddingHandler

Constructor Summary

Constructors

Constructor and Description
DfpHeaderBidding(AndroidUtil androidUtil, DeviceUtil deviceUtil)

Method Summary

Modifier and Type	Method and Description
boolean	canHandle(java.lang.Object object) Indicate if this handler can handle the given object.
void	cleanPreviousBid(java.lang.Object object) Remove previous state that may have been stored in the object.
void	enrichBid(java.lang.Object object, AdUnitType adUnitType, com.criteo.publisher.model.CdbResponseSlot slot) Enrich the given bid object with a bid for the given ad unit.
com.criteo.publisher.integration.Integration	getIntegration() Indicate which kind of integration is this handler doing.

Methods inherited from class java.lang.Object

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

Constructor Detail

DfpHeaderBidding

public DfpHeaderBidding(@NonNull
                        AndroidUtil androidUtil,
                        @NonNull
                        DeviceUtil deviceUtil)

Method Detail

canHandle

public boolean canHandle(@NonNull
                         java.lang.Object object)

Description copied from interface: HeaderBiddingHandler

Indicate if this handler can handle the given object.

This means that this handler is ready to accept this object for all other methods in this interface.

Specified by:

canHandle in interface HeaderBiddingHandler

Parameters:

object - object to test

Returns:

true if the object is supported

getIntegration

@NonNull
public com.criteo.publisher.integration.Integration getIntegration()

Description copied from interface: HeaderBiddingHandler

Indicate which kind of integration is this handler doing.

Specified by:

getIntegration in interface HeaderBiddingHandler

cleanPreviousBid

public void cleanPreviousBid(@NonNull
                             java.lang.Object object)

Description copied from interface: HeaderBiddingHandler

Remove previous state that may have been stored in the object.

This cancels any modification done by a HeaderBiddingHandler.enrichBid(Object, AdUnitType, CdbResponseSlot) call.

This method is only called on handled objects. If there is a bid, but also if there is no bid to avoid having a third-party considering that Criteo bids again.

Specified by:

cleanPreviousBid in interface HeaderBiddingHandler

Parameters:

object - bid object to clean

enrichBid

public void enrichBid(@NonNull
                      java.lang.Object object,
                      @NonNull
                      AdUnitType adUnitType,
                      @NonNull
                      com.criteo.publisher.model.CdbResponseSlot slot)

Description copied from interface: HeaderBiddingHandler

Enrich the given bid object with a bid for the given ad unit.

This method is only called on handled objects.

Specified by:

enrichBid in interface HeaderBiddingHandler

Parameters:

object - bid object to fill

adUnitType - ad unit representing the requested bid

slot - bid to use