com.criteo.publisher.model

Class RemoteConfigResponse

java.lang.Object

com.criteo.publisher.model.RemoteConfigResponse

public abstract class RemoteConfigResponse
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
RemoteConfigResponse()

Method Summary

Modifier and Type	Method and Description
static RemoteConfigResponse	create(java.lang.Boolean killSwitch, java.lang.String androidDisplayUrlMacro, java.lang.String androidAdTagUrlMode, java.lang.String androidAdTagDataMacro, java.lang.String androidAdTagDataMode, java.lang.Boolean csmEnabled, java.lang.Boolean liveBiddingEnabled, java.lang.Integer liveBiddingTimeBudgetInMillis, java.lang.Boolean prefetchOnInitEnabled)
static RemoteConfigResponse	createEmpty()
abstract java.lang.Boolean	getCsmEnabled() Feature flag for activating/deactivating the CSM feature.
abstract java.lang.Boolean	getKillSwitch() The kill switch applies to both the iOS and Android SDKs, and tells the SDK to stop getting bids from CDB.
abstract java.lang.Boolean	getLiveBiddingEnabled() Feature flag for activating/deactivating the live-bidding feature.
abstract java.lang.Integer	getLiveBiddingTimeBudgetInMillis() Amount of time (in milliseconds) given to the SDK to serve a bid to the publisher.
abstract java.lang.Boolean	getPrefetchOnInitEnabled() Feature flag for activating/deactivating the prefetch during initialization.
static com.google.gson.TypeAdapter<RemoteConfigResponse>	typeAdapter(com.google.gson.Gson gson)
RemoteConfigResponse	withKillSwitch(java.lang.Boolean killSwitch)

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteConfigResponse

public RemoteConfigResponse()

Method Detail

create

@NonNull
public static RemoteConfigResponse create(@Nullable
                                                   java.lang.Boolean killSwitch,
                                                   @Nullable
                                                   java.lang.String androidDisplayUrlMacro,
                                                   @Nullable
                                                   java.lang.String androidAdTagUrlMode,
                                                   @Nullable
                                                   java.lang.String androidAdTagDataMacro,
                                                   @Nullable
                                                   java.lang.String androidAdTagDataMode,
                                                   @Nullable
                                                   java.lang.Boolean csmEnabled,
                                                   @Nullable
                                                   java.lang.Boolean liveBiddingEnabled,
                                                   @Nullable
                                                   java.lang.Integer liveBiddingTimeBudgetInMillis,
                                                   @Nullable
                                                   java.lang.Boolean prefetchOnInitEnabled)

createEmpty

@NonNull
public static RemoteConfigResponse createEmpty()

withKillSwitch

@NonNull
public RemoteConfigResponse withKillSwitch(@Nullable
                                                    java.lang.Boolean killSwitch)

typeAdapter

public static com.google.gson.TypeAdapter<RemoteConfigResponse> typeAdapter(com.google.gson.Gson gson)

getKillSwitch

@Nullable
public abstract java.lang.Boolean getKillSwitch()

The kill switch applies to both the iOS and Android SDKs, and tells the SDK to stop getting bids from CDB. Once the kill switch has been set, you may get up to one bid per slot, since the first call to CDB may be initiated prior to the response from the config endpoint. However, that will happen only the first time the app is started after the kill switch is set, because the switch value is persisted (SharedPreferences for Android, UserDefaults for iOS).

getCsmEnabled

@Nullable
public abstract java.lang.Boolean getCsmEnabled()

Feature flag for activating/deactivating the CSM feature. If set to true, then the feature is activated. If false, then it is deactivated. If the flag is not present (i.e. equals to null), then the previous persisted value of this flag is taken. If there is no previous value, this means that this is a fresh start of a new application, then a default value is taken.

getLiveBiddingEnabled

@Nullable
public abstract java.lang.Boolean getLiveBiddingEnabled()

Feature flag for activating/deactivating the live-bidding feature. If set to true, then the feature is activated. If false, then it is deactivated. If the flag is not present (i.e. equals to null), then the previous persisted value of this flag is taken. If there is no previous value, this means that this is a fresh start of a new application, then a default value is taken.

getLiveBiddingTimeBudgetInMillis

@Nullable
public abstract java.lang.Integer getLiveBiddingTimeBudgetInMillis()

Amount of time (in milliseconds) given to the SDK to serve a bid to the publisher. If the SDK get a CDB response within this time budget, SDK returns it directly. Else, cached bid is used (if present) and CDB response is cached for later.

getPrefetchOnInitEnabled

@Nullable
public abstract java.lang.Boolean getPrefetchOnInitEnabled()

Feature flag for activating/deactivating the prefetch during initialization. If set to true, then the feature is activated. If false, then it is deactivated. If the flag is not present (i.e. equals to null), then the previous persisted value of this flag is taken. If there is no previous value, this means that this is a fresh start of a new application, then a default value is taken.