iab-openrtb
Version:
TypeScript definitions for IAB Tech Lab's OpenRTB (Open Real Time Bidding)
70 lines (68 loc) • 2.63 kB
TypeScript
/**
* OpenRTB 2.5 Banner Ad Types
* Defines the types of banner ad units
*/
declare const BannerAdType: {
readonly XHTML_TEXT_AD: 1;
readonly XHTML_BANNER_AD: 2;
readonly JAVASCRIPT_AD: 3;
readonly IFRAME: 4;
};
type BannerAdType = (typeof BannerAdType)[keyof typeof BannerAdType];
/**
* OpenRTB 2.5 No-Bid Reason Codes
* Signals why a bidder did not offer a bid for the impression
*/
declare const NoBidReasonCode: {
readonly UNKNOWN_ERROR: 0;
readonly TECHNICAL_ERROR: 1;
readonly INVALID_REQUEST: 2;
readonly KNOWN_WEB_SPIDER: 3;
readonly SUSPECTED_NON_HUMAN_TRAFFIC: 4;
readonly CLOUD_DATA_CENTER_OR_PROXY_IP: 5;
readonly UNSUPPORTED_DEVICE: 6;
readonly BLOCKED_PUBLISHER_OR_SITE: 7;
readonly UNMATCHED_USER: 8;
readonly DAILY_READER_CAP_MET: 9;
readonly DAILY_DOMAIN_CAP_MET: 10;
};
type NoBidReasonCode = (typeof NoBidReasonCode)[keyof typeof NoBidReasonCode];
/**
* OpenRTB 2.5 Loss Reason Codes
* Informs a bidder why they did not win an impression
*/
declare const LossReasonCode: {
readonly BID_WON: 0;
readonly INTERNAL_ERROR: 1;
readonly IMPRESSION_OPPORTUNITY_EXPIRED: 2;
readonly INVALID_BID_RESPONSE: 3;
readonly INVALID_DEAL_ID: 4;
readonly INVALID_AUCTION_ID: 5;
readonly INVALID_ADVERTISER_DOMAIN: 6;
readonly MISSING_MARKUP: 7;
readonly MISSING_CREATIVE_ID: 8;
readonly MISSING_BID_PRICE: 9;
readonly MISSING_MINIMUM_CREATIVE_APPROVAL_DATA: 10;
readonly BID_BELOW_AUCTION_FLOOR: 100;
readonly BID_BELOW_DEAL_FLOOR: 101;
readonly LOST_TO_HIGHER_BID: 102;
readonly LOST_TO_PMP_DEAL: 103;
readonly BUYER_SEAT_BLOCKED: 104;
readonly CREATIVE_FILTERED_GENERAL: 200;
readonly CREATIVE_FILTERED_PENDING_PROCESSING: 201;
readonly CREATIVE_FILTERED_DISAPPROVED: 202;
readonly CREATIVE_FILTERED_SIZE_NOT_ALLOWED: 203;
readonly CREATIVE_FILTERED_INCORRECT_FORMAT: 204;
readonly CREATIVE_FILTERED_ADVERTISER_EXCLUSIONS: 205;
readonly CREATIVE_FILTERED_APP_BUNDLE_EXCLUSIONS: 206;
readonly CREATIVE_FILTERED_NOT_SECURE: 207;
readonly CREATIVE_FILTERED_LANGUAGE_EXCLUSIONS: 208;
readonly CREATIVE_FILTERED_CATEGORY_EXCLUSIONS: 209;
readonly CREATIVE_FILTERED_ATTRIBUTE_EXCLUSIONS: 210;
readonly CREATIVE_FILTERED_AD_TYPE_EXCLUSIONS: 211;
readonly CREATIVE_FILTERED_ANIMATION_TOO_LONG: 212;
readonly CREATIVE_FILTERED_NOT_ALLOWED_IN_PMP_DEAL: 213;
readonly EXCHANGE_SPECIFIC: 1000;
};
type LossReasonCode = (typeof LossReasonCode)[keyof typeof LossReasonCode];
export { BannerAdType as B, LossReasonCode as L, NoBidReasonCode as N };