Ad

All Superinterfaces:

KVKeysValues, Lot49Constants, Lot49Plugin, RtbConstants

All Known Implementing Classes:

AdImpl, AdImplTest.Ad_1111_fake, AdITTest.Ad_181818_fake, AdTest.Ad_1234_segments, AdTest.Ad_181818_fake, BidCandidateManagerSpec.Ad_1001001_fake2, IntegralTest.Ad_1010_integral_fake, SharedSetUp.Ad_1001001_fake, SharedSetUp.Ad_1001001_mock
```
public interface Ad
extends Lot49Plugin
```
Specifies ad configuration. Most functionality is implemented in AdImpl. An Ad may have one or more Tags.

It is intended that simple Groovy (but not necessarily) scripts extend those classes class, filling in tag information (e.g., Dimension, etc.) and the actual tag text.
1. The naming convention is such that it's named Ad_<AdId>_<AdName>.
2. Ad config is the one that can be returned from getId().
3. init() method sets up the necessary fields which will be checked in canBid1(OpenRtbRequest).
Author:

Gregory Golberg (grisha@alum.mit.edu) Copyright © Enremmeta LLC 2014-2015. All Rights Reserved. This code is licensed under Affero GPL 3.0

See Also:

Tag

Field Summary
- Fields inherited from interface com.enremmeta.rtb.constants.Lot49Constants
  AD_FILENAME_PREFIX, AUCTION_RESULTS_PATH_ADX, AUCTION_RESULTS_PATH_OPENX, AUCTION_RESULTS_PATH_PUBMATIC, BID_OUTCOME_CONTROL, BID_OUTCOME_INTERNAL_AUCTION_LOSS, BID_OUTCOME_SUBMITTED, BID_PRICE_CALCULATOR_FILENAME_PREFIX, COOKIE_PREFIX_A, DECISION_BIDS_MADE, DECISION_BIDS_NEEDED, DECISION_BIDS_POSSIBLE, DECISION_BRANDSAFETY, DECISION_BROWSER, DECISION_BUDGET, DECISION_CATEGORY, DECISION_DATE, DECISION_DAY, DECISION_DEVICE, DECISION_DOMAIN_REQUIRED, DECISION_DOMAIN_UNMATCHED, DECISION_EVALUATION_ERROR, DECISION_EXCHANGE, DECISION_EXPERIMENT_CONTROL_SET, DECISION_FLOOR, DECISION_FREQ_CAP, DECISION_GEO, DECISION_HOST, DECISION_HOUR, DECISION_INTEGRAL, DECISION_INTEGRAL_URL, DECISION_INTERNAL_AUCTION, DECISION_IP_BLACKLISTED, DECISION_LANGUAGE, DECISION_LOADING_ERROR, DECISION_NO_IMPRESSIONS, DECISION_NO_USER, DECISION_OS, DECISION_PACING, DECISION_PRIVATE_DEAL, DECISION_PROBABILITY, DECISION_PROVIDER, DECISION_SSP, DECISION_TAG, DECISION_TIMEOUT_EXPERIMENT_STATUS, DECISION_TIMEOUT_FC, DECISION_TIMEOUT_INTEGRAL, DECISION_TIMEOUT_UNKNOWN, DECISION_TIMEOUT_USERDATA, DECISION_TRAQ, DECISION_URL, DECISION_USER_UNKNOWN, DECISION_VALIDATION, DECISION_VIEWABILITY, DECISION_WRONG_USER, DEFAULT_CLICK_PATH_ABSOLUTE, DEFAULT_CLICK_PATH_RELATIVE, DEFAULT_IMPRESSION_PATH_ABSOLUTE, DEFAULT_IMPRESSION_PATH_RELATIVE, DEFAULT_NURL_PATH_ABSOLUTE, DEFAULT_NURL_PATH_RELATIVE, DEFAULT_PIXEL_PATH_ABSOLUTE, DEFAULT_PIXEL_PATH_RELATIVE, DEFAULT_PROUST_PATH_ABSOLUTE, DEFAULT_PROUST_PATH_RELATIVE, DEFAULT_REDIR_PATH_ABSOLUTE, DEFAULT_REDIR_PATH_RELATIVE, DEFAULT_TEST_PATH_RELATIVE, EXCHANGE_ADAPTV, EXCHANGE_ADX, EXCHANGE_BIDSWITCH, EXCHANGE_BRX, EXCHANGE_LIVERAIL, EXCHANGE_LOT49_INTERNAL_AUCTION, EXCHANGE_OPENX, EXCHANGE_PUBMATIC, EXCHANGE_SMAATO, EXCHANGE_SPOTXCHANGE, EXCHANGE_TEST1, EXCHANGE_TEST2, LOT49_VERSION_KEY, LOT49_VERSION_VALUE, MEDIA_TYPE_APPLICATION_JAVASCRIPT, MEDIA_TYPE_APPLICATION_SHOCKWAVE_FLASH, MEDIA_TYPE_VIDEO_FLV, MEDIA_TYPE_VIDEO_MP4, MOD_UID_COOKIE_LENGTH_MAX, MOD_UID_COOKIE_LENGTH_MIN, MOD_UID_LOG_LENGTH, NAME, NURL_ONLY_TAG, NURL_ONLY_WIN_NOTIFICATION, NURL_STANDART, QUERY_STRING_EXCHANGE_CLICK_THROUGH_ENCODED_MACRO, QUERY_STRING_EXCHANGE_CLICK_THROUGH_MACRO, QUERY_STRING_LOT49_CLICK_THROUGH_MACRO, REL_PATH_DEBUG_NURL, ROOT_PATH_ADMIN, ROOT_PATH_AUCTIONS, ROOT_PATH_STATS, TAG_DECISION_API, TAG_DECISION_DIMENSIONS, TAG_DECISION_DURATION, TAG_DECISION_MIME, TAG_DECISION_NOT_BANNER, TAG_DECISION_NOT_VIDEO, TAG_DECISION_PROTOCOL, TAG_DECISION_REQUEST_DISALLOWS_MARKUP, TAG_DECISION_SSL_REQUIRED, TAG_DECISION_VIDEO_LINEARITY, TAG_FILENAME_PREFIX, TEST_MOD_UID_COOKIE_1, TEST_MOD_UID_COOKIE_2, TEST_MOD_UID_COOKIE_3, TEST_MOD_UID_COOKIE_4, TEST_MOD_UID_LOG_1, TEST_MOD_UID_LOG_2, TEST_MOD_UID_LOG_3, TEST_MOD_UID_LOG_4
- Fields inherited from interface com.enremmeta.rtb.api.KVKeysValues
  B_TOOK_CARE_OF_IT_ERROR, B_TOOK_CARE_OF_IT_LOSS, B_TOOK_CARE_OF_IT_WIN, BID_AMOUNT_DISPLAY_PREFIX, BID_AMOUNT_PREFIX, BID_COUNT_DISPLAY_PREFIX, BID_COUNT_PREFIX, BID_PREFIX, BID_PRICE_PREFIX, BID_REQUEST_PREFIX, BIDDER_COUNT_KEY, BUDGET_CHUNK_SIZE_PREFIX, BUDGET_MAP_KEY, BUDGET_PREFIX, BUDGET_UNLIMITED, COOKIE_TS_CLICK, COOKIE_TS_IMPRESSION, DEBUG_NURL_PREFIX, DECISION_DISPLAY_PREFIX, ENDS_ON_PREFIX, ENV_AWS_REGION, ENV_DYNAMO_ENDPOINT, ENV_EC2_ENDPOINT, ENV_ELB_ENDPOINT, ENV_LOT49_CONFIG_FILE, ENV_LOT49_HOME, ENV_LOT49_MAGIC, ENV_STS_ENDPOINT, LOWER_BID_PROBABILITY, NURL_PREFIX, OWNER_KEY_PREFIX, PACING_ASAP, PACING_LOG_PREFIX, PREFIX_VERSION, PREVIOUS_SPEND_AMOUNT_PREFIX, SEGMENT_PREFIX, SPEND_AMOUNT_DISPLAY_PREFIX, SPEND_AMOUNT_PREFIX, STARTS_ON_PREFIX, USER_DATA_SCORE_KEY, USER_PREFIX_V1, WIN_COUNT_DISPLAY_PREFIX, WIN_COUNT_PREFIX, WIN_RATE_STARTED_TS
- Fields inherited from interface com.enremmeta.rtb.constants.RtbConstants
  API_MRAID, API_ORMMA, API_VPAID_1, API_VPAID_2, AUCTION_TYPE_FIRST_PRICE, AUCTION_TYPE_FIXED_PRICE, AUCTION_TYPE_SECOND_PRICE_PLUS, AUCTION_TYPE_UNKNOWN, BR_HTML5_1_0_VALUE, BR_HTML5_2_0_VALUE, CONNECTION_TYPE_CELL_2G, CONNECTION_TYPE_CELL_3G, CONNECTION_TYPE_CELL_4G, CONNECTION_TYPE_CELL_UNKNOWN, CONNECTION_TYPE_ETHERNET, CONNECTION_TYPE_UNKNOWN, CONNECTION_TYPE_WIFI, CONTENT_CONTEXT_APP, CONTENT_CONTEXT_GAME, CONTENT_CONTEXT_MUSIC, CONTENT_CONTEXT_OTHER, CONTENT_CONTEXT_TEXT, CONTENT_CONTEXT_UNKNOWN, CONTENT_CONTEXT_VIDEO, DEVICE_TYPE_CONNECTED_DEVICE, DEVICE_TYPE_CONNECTED_TV, DEVICE_TYPE_MOBILE_TABLET, DEVICE_TYPE_PC, DEVICE_TYPE_PHONE, DEVICE_TYPE_STB, DEVICE_TYPE_TABLET, ETHNICITY_AFRICAN_AMERICAN, ETHNICITY_ASIAN, ETHNICITY_HISPANIC, ETHNICITY_OTHER, ETHNICITY_WHITE, LINEARITY_LINEAR, LINEARITY_NON_LINEAR, MARITAL_DIVORCED, MARITAL_MARRIED, MARITAL_SINGLE, VIDEO_PLAYBACK_AUTO_SOUND_OFF, VIDEO_PLAYBACK_AUTO_SOUND_ON, VIDEO_PLAYBACK_CLICK_TO_PLAY, VIDEO_PLAYBACK_MOUSEOVER, VIDEO_PROTOCOL_VAST_1, VIDEO_PROTOCOL_VAST_2, VIDEO_PROTOCOL_VAST_3, VIDEO_PROTOCOL_VAST_WRAPPER_1, VIDEO_PROTOCOL_VAST_WRAPPER_2, VIDEO_PROTOCOL_VAST_WRAPPER_3

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addProviderTargeting(String providerName, String json)`
`boolean`	`canBid1(OpenRtbRequest bidRequest)` Whether this can target this particular bid request.
`boolean`	`checkFrequencyCap(OpenRtbRequest br, UserFrequencyCapAttributes userFrequencyCap)`
`boolean`	`checkIntegralTargeting(OpenRtbRequest req, Site site, IntegralInfoReceived integralInfoReceived)`
`boolean`	`checkMeasurementSegments(UserSegments userSegments)`
`boolean`	`checkSegments(OpenRtbRequest br, UserSegments userSegments)` Whether this can target this particular bid request (but different from `canBid1(OpenRtbRequest)`.
`boolean`	`doAbTesting()`
`boolean`	`doCampaignAbTesting()`
`boolean`	`doTargetingStrategyAbTesting()`
`Tag`	`findTagById(String id)` Searched tag by id
`double`	`getAbTestingControlShare()`
`List<String>`	`getAdomain()`
`String`	`getAdVersion()`
`String`	`getAdvertiser()`
`String`	`getAdvertiserId()`
`long`	`getBidAmount()`
`long`	`getBidFrequency()` Bid frequency, in seconds.
`long`	`getBidPrice(OpenRtbRequest req)` Price we can bid on this targeting configuration in micro-dollars.
`BidPriceCalculator`	`getBidPriceCalculator()`
`double`	`getBidPriceCpm(OpenRtbRequest req)` Same as `getBidAmount()` but as $ CPM.
`int`	`getBidProbability()` Between 0 and 100.
`long`	`getBids()`
`long`	`getBids(String exchange)`
`SortedMap<String,AtomicLong>`	`getBidsByExchange()`
`Set<String>`	`getBrowsers()`
`double`	`getCampaignAbTestingControlShare()`
`double`	`getCampaignAbTestingShare()`
`String`	`getCampaignId()` A Campaign is something that can unify together several Ads.
`String`	`getClientId()` Client ID.
`String`	`getDesc()` Human-readable description
`Set<String>`	`getDeviceMakes()`
`Set<String>`	`getDeviceModels()`
`Set<Integer>`	`getDeviceTypes()`
`Set<String>`	`getDomainBlacklist()`
`Set<String>`	`getDomainWhitelist()` Domain white list.
`Set<String>`	`getExchanges()`
`Map<String,Map<String,Object>>`	`getExchangeSpecificInstructions()` This is a Map from `exchange name`, for those exchanges that return non-null in `ExchangeAdapter.makeExchangeSpecificInstructionsMap()`, to that Map.
`FrequencyCap`	`getFrequencyCap()`
`FrequencyCap`	`getFrequencyCapCampaign()`
`List<TargetingGeo>`	`getGeos()`
`String`	`getId()` ID (gleaned from script name by convention).
`String`	`getIurl()` See OpenRTB specification.
`List<String>`	`getLandingPageUrls()`
`Set<String>`	`getLanguages()`
`long`	`getLastBidTime()`
`long`	`getLoadedOn()`
`String`	`getName()` Human-readable name.
`List<TargetingGeo>`	`getNegativeGeos()`
`String`	`getNodeId()`
`SortedMap<String,SortedMap<String,AtomicLong>>`	`getOptoutsByExchange()`
`Set<Pattern>`	`getOrganizations()`
`long`	`getOriginalBidsToMake()`
`Set<String>`	`getOses()` OS as "name version" or just "name"
`Expression<String>`	`getParsedTargetingSegments()`
`long`	`getProjectedSpend()`
`Map<Provider,ProviderInfoRequired>`	`getProviderTargeting()`
`long`	`getRealBidAmount()`
`long`	`getRealBids()`
`SortedMap<String,AtomicLong>`	`getRealBidsByExchange()`
`long`	`getRealSpendAmount()`
`long`	`getRealWins()`
`long`	`getRemainingBidsToMake()`
`long`	`getRequestCount()`
`long`	`getRequestCount(String exchange)`
`SortedMap<String,AtomicLong>`	`getRequestsByExchange()`
`long`	`getSpendAmount()`
`Set<String>`	`getSsps()`
`List<Tag>`	`getTags()`
`Set<String>`	`getTargetingCategories()` Categories of `Site.getCat()` to target.
`Map<String,Set<String>>`	`getTargetingDeals()`
`TargetingDOW`	`getTargetingDOW()`
`TargetingHour`	`getTargetingHour()` Not to be confused with `getBidProbability()`, which is used for pacing purposes, this probability is for A/B testing.
`TargetingIntegral`	`getTargetingIntegral()`
`double`	`getTargetingStrategyAbTestingShare()`
`Map<String,Set<String>>`	`getTargetingUrls()` URLs to target.
`Set<String>`	`getUserSegments()` Deprecated.
`double`	`getWinRate()` Win rate on which previous allocation was based;
`long`	`getWins()`
`boolean`	`haveBidsToMake()` Whether we still have bids to make.
`void`	`incrBids(String exchange, long amount)`
`void`	`incrOptout(OpenRtbRequest req, String name)`
`void`	`incrOptout(OpenRtbRequest req, String name, long n)`
`void`	`incrRequestCount(String exchange)`
`void`	`incrRequestCount(String exchange, long n)`
`void`	`incrSpendAmount(long spendAmount)`
`void`	`incrWins()`
`void`	`incrWins(long val)`
`void`	`init()`
`boolean`	`isCampaignFrequencyCap()`
`boolean`	`isDomainRequired()` Whether it is required that `domain` be not `null` null in order to bid.
`boolean`	`isDynamicPricing()`
`boolean`	`isSegmentLogicAnd()` Deprecated.
`boolean`	`isStrategyFrequencyCap()`
`boolean`	`isTargetingDeals()`
`String`	`matchDeals(OpenRtbRequest br, Impression imp)`
`boolean`	`needCanBid2()`
`boolean`	`needExperimentInfo()`
`boolean`	`needFrequencyCap()`
`boolean`	`needIntegralInfo()`
`boolean`	`needUserInfo()`
`void`	`setBidFrequency(long bidFrequency)`
`void`	`setBidPrice(long amount)`
`void`	`setBidPriceCalculator(BidPriceCalculator bpc)` Deprecated.
`void`	`setBidProbability(int bidProbability)`
`void`	`setBidsToMake(long n)`
`void`	`setDomainBlacklistFromUrl(String urlStr)`
`void`	`setDomainWhitelistFromUrl(String urlStr)`
`void`	`setFrequencyCap(FrequencyCap fc)`
`void`	`setFrequencyCapCampaign(FrequencyCap fc)`
`void`	`setLastBidTime(long msec)`
`void`	`setProjectedSpend(long n)`
`void`	`setTargetingDeals(Map<String,List<String>> deals)` Map from `exchange name` to list of targeted Deal IDs
`void`	`setTargetingUrlsFromUrl(String url)`
`void`	`setWinRate(double winRate)`
`void`	`storeAdState()`
`List<String>`	`validate()` Return list of validation errors, or `null` if validated correctly.

- Method Detail
  - getLoadedOn
```
long getLoadedOn()
```
  - setBidPriceCalculator
```
@Deprecated
void setBidPriceCalculator(BidPriceCalculator bpc)
```
    Deprecated.
  - getExchangeSpecificInstructions
```
Map<String,Map<String,Object>> getExchangeSpecificInstructions()
```
    This is a Map from exchange name, for those exchanges that return non-null in ExchangeAdapter.makeExchangeSpecificInstructionsMap(), to that Map. It is returned with keys only for ever Ad object, and is checked by the Exchange during response conversion phase.
  - isTargetingDeals
```
boolean isTargetingDeals()
```
  - setDomainBlacklistFromUrl
```
void setDomainBlacklistFromUrl(String urlStr)
```
  - setDomainWhitelistFromUrl
```
void setDomainWhitelistFromUrl(String urlStr)
```
  - getNodeId
```
String getNodeId()
```
  - matchDeals
```
String matchDeals(OpenRtbRequest br,
                  Impression imp)
```
    Parameters:
    
    br - request
    
    imp - impression
  - setFrequencyCap
```
void setFrequencyCap(FrequencyCap fc)
```
  - getFrequencyCap
```
FrequencyCap getFrequencyCap()
```
  - setFrequencyCapCampaign
```
void setFrequencyCapCampaign(FrequencyCap fc)
```
  - getFrequencyCapCampaign
```
FrequencyCap getFrequencyCapCampaign()
```
  - getOrganizations
```
Set<Pattern> getOrganizations()
```
  - isDomainRequired
```
boolean isDomainRequired()
```
    Whether it is required that domain be not null null in order to bid.
  - getProjectedSpend
```
long getProjectedSpend()
```
  - setProjectedSpend
```
void setProjectedSpend(long n)
```
  - getOptoutsByExchange
```
SortedMap<String,SortedMap<String,AtomicLong>> getOptoutsByExchange()
```
  - incrRequestCount
```
void incrRequestCount(String exchange)
```
  - incrRequestCount
```
void incrRequestCount(String exchange,
                      long n)
```
  - getBidsByExchange
```
SortedMap<String,AtomicLong> getBidsByExchange()
```
  - getRequestsByExchange
```
SortedMap<String,AtomicLong> getRequestsByExchange()
```
  - getRequestCount
```
long getRequestCount()
```
  - getRequestCount
```
long getRequestCount(String exchange)
```
  - isSegmentLogicAnd
```
@Deprecated
boolean isSegmentLogicAnd()
```
    Deprecated.
  - getAdVersion
```
String getAdVersion()
```
  - incrOptout
```
void incrOptout(OpenRtbRequest req,
                String name)
```
  - incrOptout
```
void incrOptout(OpenRtbRequest req,
                String name,
                long n)
```
  - addProviderTargeting
```
void addProviderTargeting(String providerName,
                          String json)
                   throws Lot49Exception
```
    Throws:
    
    Lot49Exception
  - getProviderTargeting
```
Map<Provider,ProviderInfoRequired> getProviderTargeting()
```
  - getCampaignId
```
String getCampaignId()
```
    A Campaign is something that can unify together several Ads. This is useful for things such as frequency caps and reports, but not much else.
    
    Returns:
  - getBids
```
long getBids()
```
  - getBids
```
long getBids(String exchange)
```
  - incrBids
```
void incrBids(String exchange,
              long amount)
```
  - getWins
```
long getWins()
```
  - incrWins
```
void incrWins()
```
  - incrWins
```
void incrWins(long val)
```
  - getSpendAmount
```
long getSpendAmount()
```
  - incrSpendAmount
```
void incrSpendAmount(long spendAmount)
```
  - getBidAmount
```
long getBidAmount()
```
  - getRealBids
```
long getRealBids()
```
  - getRealWins
```
long getRealWins()
```
  - getRealSpendAmount
```
long getRealSpendAmount()
```
  - getRealBidAmount
```
long getRealBidAmount()
```
  - getRealBidsByExchange
```
SortedMap<String,AtomicLong> getRealBidsByExchange()
```
  - storeAdState
```
void storeAdState()
```
  - getClientId
```
String getClientId()
```
    Client ID. Not necessarily meaningful, only useful in multi-tenant situation.
    
    See Also:
    
    ClientConfig
  - getWinRate
```
double getWinRate()
```
    Win rate on which previous allocation was based;
  - setWinRate
```
void setWinRate(double winRate)
```
  - getDeviceTypes
```
Set<Integer> getDeviceTypes()
```
  - getDeviceMakes
```
Set<String> getDeviceMakes()
```
  - getDeviceModels
```
Set<String> getDeviceModels()
```
  - getBrowsers
```
Set<String> getBrowsers()
```
  - getOses
```
Set<String> getOses()
```
    OS as "name version" or just "name"
  - getLanguages
```
Set<String> getLanguages()
```
  - setBidsToMake
```
void setBidsToMake(long n)
```
  - getRemainingBidsToMake
```
long getRemainingBidsToMake()
```
  - getOriginalBidsToMake
```
long getOriginalBidsToMake()
```
  - haveBidsToMake
```
boolean haveBidsToMake()
```
    Whether we still have bids to make. This is set per current pacing period by AdCache, and every time we make a bid, we decrement the allowed amount.
  - getAdvertiserId
```
String getAdvertiserId()
```
  - getAdvertiser
```
String getAdvertiser()
```
  - canBid1
```
boolean canBid1(OpenRtbRequest bidRequest)
```
    Whether this can target this particular bid request. Important notes:
    1. This MUST NOT check all of the constituent config 's canBid() methods. This only qualifies the bid request's attributes (including user) in absence of a particular ad tag configuration. Thus, on a test bid, all of these methods can be assumed to be true, but not all canBid()s.
    2. This only checks that information that can be checked without external lookup; in other words, it should not presume that Lot49Ext.getLot49ExtRemote() is populated.
    3. If either this method returns false, this targeting configuration is not eligible to bid.
    This will always return true if bidRequest is a test request.
  - checkSegments
```
boolean checkSegments(OpenRtbRequest br,
                      UserSegments userSegments)
```
    Whether this can target this particular bid request (but different from canBid1(OpenRtbRequest). Important notes:
    1. This MUST NOT check all of the constituent config 's canBid() methods. This only qualifies the bid request's attributes (including user) in absence of a particular ad tag configuration. Thus, on a test bid, all of these methods can be assumed to be true, but not all canBid()s.
    2. This will not be called if needCanBid2() is false.
    3. If either this method or canBid1(OpenRtbRequest) returns false, this ad is not eligible to bid.
    This will always return true if bidRequest is a test request.
    See Also:
    
    canBid1(com.enremmeta.rtb.api.proto.openrtb.OpenRtbRequest)
  - checkIntegralTargeting
```
boolean checkIntegralTargeting(OpenRtbRequest req,
                               Site site,
                               IntegralInfoReceived integralInfoReceived)
```
  - checkFrequencyCap
```
boolean checkFrequencyCap(OpenRtbRequest br,
                          UserFrequencyCapAttributes userFrequencyCap)
```
  - getLastBidTime
```
long getLastBidTime()
```
  - setLastBidTime
```
void setLastBidTime(long msec)
```
  - doAbTesting
```
boolean doAbTesting()
```
  - doCampaignAbTesting
```
boolean doCampaignAbTesting()
```
  - doTargetingStrategyAbTesting
```
boolean doTargetingStrategyAbTesting()
```
  - getTargetingStrategyAbTestingShare
```
double getTargetingStrategyAbTestingShare()
```
  - getCampaignAbTestingShare
```
double getCampaignAbTestingShare()
```
  - getAbTestingControlShare
```
double getAbTestingControlShare()
```
  - getCampaignAbTestingControlShare
```
double getCampaignAbTestingControlShare()
```
  - getDomainWhitelist
```
Set<String> getDomainWhitelist()
```
    Domain white list. For cases where this is reasonably small. A limit will be enforced, specified by a configuration option.
  - getDomainBlacklist
```
Set<String> getDomainBlacklist()
```
  - getTargetingUrls
```
Map<String,Set<String>> getTargetingUrls()
```
    URLs to target. A limit will be enforced, specified by a configuration option. Currently exact match is required.
  - getTargetingDeals
```
Map<String,Set<String>> getTargetingDeals()
```
    See Also:
    
    getTargetingDeals()
  - setTargetingDeals
```
void setTargetingDeals(Map<String,List<String>> deals)
```
    Map from exchange name to list of targeted Deal IDs
    
    See Also:
    
    PMP, Deal
  - setTargetingUrlsFromUrl
```
void setTargetingUrlsFromUrl(String url)
```
  - getTargetingCategories
```
Set<String> getTargetingCategories()
```
    Categories of Site.getCat() to target. Assumed to be normalized to upper case, with colon separator for hierarchy. Targeting categories for page, section, content are not supported yet.
  - getBidPrice
```
long getBidPrice(OpenRtbRequest req)
```
    Price we can bid on this targeting configuration in micro-dollars.
  - getBidPriceCalculator
```
BidPriceCalculator getBidPriceCalculator()
```
  - isDynamicPricing
```
boolean isDynamicPricing()
```
  - setBidPrice
```
void setBidPrice(long amount)
```
  - getBidPriceCpm
```
double getBidPriceCpm(OpenRtbRequest req)
```
    Same as getBidAmount() but as $ CPM.
  - getBidProbability
```
int getBidProbability()
```
    Between 0 and 100. Probability of bidding for pacing purposes. Set to 0 to never bid, and to 100 to bid always (subject to getBidFrequency(). Values below 0 and above 100 work the same as 0 and 100 respectively.
    
    See Also:
    
    getBidFrequency()
  - setBidProbability
```
void setBidProbability(int bidProbability)
```
    See Also:
    
    getBidProbability()
  - getBidFrequency
```
long getBidFrequency()
```
    Bid frequency, in seconds. That is, bid no more often than once per this number of seconds. If 0, this is not in play and will bid every time.
    
    See Also:
    
    getBidProbability()
  - setBidFrequency
```
void setBidFrequency(long bidFrequency)
```
    See Also:
    
    getBidFrequency()
  - getDesc
```
String getDesc()
```
    Human-readable description
  - getLandingPageUrls
```
List<String> getLandingPageUrls()
```
  - getIurl
```
String getIurl()
```
    See OpenRTB specification.
  - getGeos
```
List<TargetingGeo> getGeos()
```
  - getNegativeGeos
```
List<TargetingGeo> getNegativeGeos()
```
  - validate
```
List<String> validate()
```
    Return list of validation errors, or null if validated correctly.
  - getAdomain
```
List<String> getAdomain()
```
    See Also:
    
    Bid.getAdomain()
  - getId
```
String getId()
```
    ID (gleaned from script name by convention).
    
    Specified by:
    
    getId in interface Lot49Plugin
  - getName
```
String getName()
```
    Human-readable name.
    
    Specified by:
    
    getName in interface Lot49Plugin
  - getTags
```
List<Tag> getTags()
```
  - getUserSegments
```
Set<String> getUserSegments()
```
    Deprecated.
  - checkMeasurementSegments
```
boolean checkMeasurementSegments(UserSegments userSegments)
```
  - getParsedTargetingSegments
```
Expression<String> getParsedTargetingSegments()
```
  - init
```
void init()
```
  - getExchanges
```
Set<String> getExchanges()
```
  - getSsps
```
Set<String> getSsps()
```
  - needCanBid2
```
boolean needCanBid2()
```
  - needUserInfo
```
boolean needUserInfo()
```
  - needFrequencyCap
```
boolean needFrequencyCap()
```
  - needIntegralInfo
```
boolean needIntegralInfo()
```
  - needExperimentInfo
```
boolean needExperimentInfo()
```
  - isCampaignFrequencyCap
```
boolean isCampaignFrequencyCap()
```
  - isStrategyFrequencyCap
```
boolean isStrategyFrequencyCap()
```
  - getTargetingHour
```
TargetingHour getTargetingHour()
```
    Not to be confused with getBidProbability(), which is used for pacing purposes, this probability is for A/B testing.
  - getTargetingDOW
```
TargetingDOW getTargetingDOW()
```
  - getTargetingIntegral
```
TargetingIntegral getTargetingIntegral()
```
  - findTagById
```
Tag findTagById(String id)
```
    Searched tag by id
    
    Parameters:
    
    id - tag identifier we interested in
    
    Returns:
    
    tag if found, null in other case

Interface Ad

Field Summary

Fields inherited from interface com.enremmeta.rtb.constants.Lot49Constants

Fields inherited from interface com.enremmeta.rtb.api.KVKeysValues

Fields inherited from interface com.enremmeta.rtb.constants.RtbConstants

Method Summary

Method Detail

getLoadedOn

setBidPriceCalculator

getExchangeSpecificInstructions

isTargetingDeals

setDomainBlacklistFromUrl

setDomainWhitelistFromUrl

getNodeId

matchDeals

setFrequencyCap

getFrequencyCap

setFrequencyCapCampaign

getFrequencyCapCampaign

getOrganizations

isDomainRequired

getProjectedSpend

setProjectedSpend

getOptoutsByExchange

incrRequestCount

incrRequestCount

getBidsByExchange

getRequestsByExchange

getRequestCount

getRequestCount

isSegmentLogicAnd

getAdVersion

incrOptout

incrOptout

addProviderTargeting

getProviderTargeting

getCampaignId

getBids

getBids

incrBids

getWins

incrWins

incrWins

getSpendAmount

incrSpendAmount

getBidAmount

getRealBids

getRealWins

getRealSpendAmount

getRealBidAmount

getRealBidsByExchange

storeAdState

getClientId

getWinRate

setWinRate

getDeviceTypes

getDeviceMakes

getDeviceModels

getBrowsers

getOses

getLanguages

setBidsToMake

getRemainingBidsToMake

getOriginalBidsToMake

haveBidsToMake

getAdvertiserId

getAdvertiser

canBid1

checkSegments

checkIntegralTargeting

checkFrequencyCap

getLastBidTime

setLastBidTime

doAbTesting

doCampaignAbTesting

doTargetingStrategyAbTesting

getTargetingStrategyAbTestingShare

getCampaignAbTestingShare

getAbTestingControlShare

getCampaignAbTestingControlShare