com.criteo.publisher.headerbidding

Interface HeaderBiddingHandler

All Known Implementing Classes:

DfpHeaderBidding, MoPubHeaderBidding, OtherAdServersHeaderBidding

public interface HeaderBiddingHandler

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.

Method Detail

canHandle

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

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.

Parameters:

object - object to test

Returns:

true if the object is supported

getIntegration

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

Indicate which kind of integration is this handler doing.

cleanPreviousBid

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

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

This cancels any modification done by a 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.

Parameters:

object - bid object to clean

enrichBid

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

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

This method is only called on handled objects.

Parameters:

object - bid object to fill

adUnitType - ad unit representing the requested bid

slot - bid to use