com.criteo.publisher.bid

Interface BidLifecycleListener

All Known Implementing Classes:

CompositeBidLifecycleListener, CsmBidLifecycleListener, LoggingBidLifecycleListener

public interface BidLifecycleListener

Listener with callbacks invoked at different moment of a bid lifecycle.

There is no strong guarantee on the order of execution, also those callbacks may be invoked on different threads.

Method Summary

Modifier and Type	Method and Description
void	onBidCached(com.criteo.publisher.model.CdbResponseSlot cachedBid) Callback invoked when a bid is cached.
void	onBidConsumed(com.criteo.publisher.model.CacheAdUnit adUnit, com.criteo.publisher.model.CdbResponseSlot consumedBid) Callback invoked when a bid is used and consumed.
void	onCdbCallFailed(CdbRequest request, java.lang.Exception exception) Callback invoked when a CDB call failed.
void	onCdbCallFinished(CdbRequest request, CdbResponse response) Callback invoked when a CDB call finished successfully with a response.
void	onCdbCallStarted(CdbRequest request) Callback invoked when a CDB call is about to start.
void	onSdkInitialized() Callback invoked when the SDK is initialized.

Method Detail

onSdkInitialized

void onSdkInitialized()

Callback invoked when the SDK is initialized.

onCdbCallStarted

void onCdbCallStarted(@NonNull
                      CdbRequest request)

Callback invoked when a CDB call is about to start.

Parameters:

request - Request sent to CDB

onCdbCallFinished

void onCdbCallFinished(@NonNull
                       CdbRequest request,
                       @NonNull
                       CdbResponse response)

Callback invoked when a CDB call finished successfully with a response.

A successful call is a call where:

• Network was successful
• CDB answer a successful HTTP status code
• CDB payload was understood and valid

Parameters:

request - Request that was sent to CDB

response - Response coming from CDB

onCdbCallFailed

void onCdbCallFailed(@NonNull
                     CdbRequest request,
                     @NonNull
                     java.lang.Exception exception)

Callback invoked when a CDB call failed.

Here, the failure means anything that does not make it a success.

Parameters:

request - Request that was sent to CDB

exception - Exception representing the failure of the call

onBidConsumed

void onBidConsumed(@NonNull
                   com.criteo.publisher.model.CacheAdUnit adUnit,
                   @NonNull
                   com.criteo.publisher.model.CdbResponseSlot consumedBid)

Callback invoked when a bid is used and consumed.

Consumption means that the bid was popped out of the bid cache. So, depending on the bid status, this does not mean that it will be used by publishers (for instance no bid or silence).

Parameters:

adUnit - ad unit representing the bid

consumedBid - bid that was consumed

onBidCached

void onBidCached(@NonNull
                 com.criteo.publisher.model.CdbResponseSlot cachedBid)

Callback invoked when a bid is cached.

Parameters:

cachedBid - bid that was cached