iab-adcom

/** * The following lists define consterations referenced by attributes in AdCOM objects. * @see https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/main/AdCOM%20v1.0%20FINAL.md#consterations- */ /** * Identifies the type of user agent a user identifier is from */ export declare const AgentType: { /** An ID which is tied to a specific web browser or device (cookie-based, probabilistic, or other) */ readonly BROWSER_OR_DEVICE: 1; /** In-app impressions, which will typically contain a type of device ID */ readonly IN_APP: 2; /** A person-based ID that is the same across devices */ readonly PERSON_BASED: 3; }; export type AgentType = (typeof AgentType)[keyof typeof AgentType]; /** * API frameworks either supported by a placement or required by an ad */ export declare const APIFramework: { readonly VPAID_1_0: 1; readonly VPAID_2_0: 2; readonly MRAID_1_0: 3; readonly ORMMA: 4; readonly MRAID_2_0: 5; readonly MRAID_3_0: 6; readonly OMID_1_0: 7; readonly SIMID_1_0: 8; readonly SIMID_1_1: 9; }; export type APIFramework = (typeof APIFramework)[keyof typeof APIFramework]; /** * Status codes used in Audit objects to reflect status or workflow state */ export declare const AuditStatusCode: { /** An audit has not yet been completed on this ad */ readonly PENDING_AUDIT: 1; /** Pre-approved before audit completion */ readonly PRE_APPROVED: 2; /** Audit complete and ad approved for use */ readonly APPROVED: 3; /** Audit complete but ad found unacceptable */ readonly DENIED: 4; /** Material changes detected, requiring resubmission */ readonly CHANGED_RESUBMISSION_REQUESTED: 5; /** Ad marked as expired by vendor */ readonly EXPIRED: 6; }; export type AuditStatusCode = (typeof AuditStatusCode)[keyof typeof AuditStatusCode]; /** * Triggers that result in an ad slot refreshing */ export declare const AutoRefreshTrigger: { /** Unknown refresh trigger */ readonly UNKNOWN: 0; /** Refresh triggered by user-initiated action such as scrolling */ readonly USER_ACTION: 1; /** Event-driven content change */ readonly EVENT: 2; /** Time-based refresh on predefined interval */ readonly TIME: 3; }; export type AutoRefreshTrigger = (typeof AutoRefreshTrigger)[keyof typeof AutoRefreshTrigger]; /** * Options for taxonomies used to describe content, audience, and ad creative categories */ export declare const CategoryTaxonomy: { /** @deprecated IAB Tech Lab Content Category Taxonomy 1.0 */ readonly CONTENT_TAXONOMY_1_0: 1; /** @deprecated IAB Tech Lab Content Category Taxonomy 2.0 */ readonly CONTENT_TAXONOMY_2_0: 2; /** IAB Tech Lab Ad Product Taxonomy 1.0 */ readonly AD_PRODUCT_TAXONOMY_1_0: 3; /** IAB Tech Lab Audience Taxonomy 1.1 */ readonly AUDIENCE_TAXONOMY_1_1: 4; /** IAB Tech Lab Content Taxonomy 2.1 */ readonly CONTENT_TAXONOMY_2_1: 5; /** IAB Tech Lab Content Taxonomy 2.2 */ readonly CONTENT_TAXONOMY_2_2: 6; /** IAB Tech Lab Content Taxonomy 3.0 */ readonly CONTENT_TAXONOMY_3_0: 7; /** IAB Tech Lab Ad Product Taxonomy 2.0 */ readonly AD_PRODUCT_TAXONOMY_2_0: 8; }; export type CategoryTaxonomy = (typeof CategoryTaxonomy)[keyof typeof CategoryTaxonomy]; /** * Types of creative activation (click) behavior types */ export declare const ClickType: { /** Non-clickable creative */ readonly NON_CLICKABLE: 0; /** Clickable but details unknown */ readonly CLICKABLE_UNKNOWN: 1; /** Clickable with embedded browser/webview */ readonly CLICKABLE_EMBEDDED_BROWSER: 2; /** Clickable with native browser */ readonly CLICKABLE_NATIVE_BROWSER: 3; }; export type ClickType = (typeof ClickType)[keyof typeof ClickType]; /** * Markup types allowed for companion ads that apply to video and audio ads */ export declare const CompanionType: { /** Static resource companion */ readonly STATIC_RESOURCE: 1; /** HTML resource companion */ readonly HTML_RESOURCE: 2; /** iframe resource companion */ readonly IFRAME_RESOURCE: 3; }; export type CompanionType = (typeof CompanionType)[keyof typeof CompanionType]; /** * Types of device connectivity */ export declare const ConnectionType: { /** Ethernet/wired connection */ readonly ETHERNET: 1; /** WiFi connection */ readonly WIFI: 2; /** Cellular network - unknown generation */ readonly CELLULAR_UNKNOWN: 3; /** 2G cellular network */ readonly CELLULAR_2G: 4; /** 3G cellular network */ readonly CELLULAR_3G: 5; /** 4G cellular network */ readonly CELLULAR_4G: 6; /** 5G cellular network */ readonly CELLULAR_5G: 7; }; export type ConnectionType = (typeof ConnectionType)[keyof typeof ConnectionType]; /** * Types of content contexts in which ads may appear */ export declare const ContentContext: { /** Video (i.e., video file or stream such as Internet TV broadcasts) */ readonly VIDEO: 1; /** Game (i.e., an interactive software game) */ readonly GAME: 2; /** Music (i.e., audio file or stream such as Internet radio broadcasts) */ readonly MUSIC: 3; /** Application (i.e., an interactive software application) */ readonly APPLICATION: 4; /** Text (i.e., primarily textual document such as a web page, eBook, or news article) */ readonly TEXT: 5; /** Other (i.e., none of the other categories applies) */ readonly OTHER: 6; /** Unknown content context */ readonly UNKNOWN: 7; }; export type ContentContext = (typeof ContentContext)[keyof typeof ContentContext]; /** * Standard list of creative attributes for ads or placement restrictions */ export declare const CreativeAttribute: { /** Audio Ad (Autoplay) */ readonly AUDIO_AD_AUTOPLAY: 1; /** Audio Ad (User Initiated) */ readonly AUDIO_AD_USER_INITIATED: 2; /** Expandable (Automatic) */ readonly EXPANDABLE_AUTOMATIC: 3; /** Expandable (User Initiated - Click) */ readonly EXPANDABLE_CLICK: 4; /** Expandable (User Initiated - Rollover) */ readonly EXPANDABLE_ROLLOVER: 5; /** In-Banner Video Ad (Autoplay) */ readonly IN_BANNER_VIDEO_AUTOPLAY: 6; /** In-Banner Video Ad (User Initiated) */ readonly IN_BANNER_VIDEO_USER_INITIATED: 7; /** Pop (e.g., Over, Under, or Upon Exit) */ readonly POP: 8; /** Provocative or Suggestive Imagery */ readonly PROVOCATIVE_IMAGERY: 9; /** Shaky, Flashing, Flickering, Extreme Animation, Smileys */ readonly DISRUPTIVE_ANIMATION: 10; /** Surveys */ readonly SURVEYS: 11; /** Text Only */ readonly TEXT_ONLY: 12; /** User Interactive (e.g., Embedded Games) */ readonly USER_INTERACTIVE: 13; /** Windows Dialog or Alert Style */ readonly DIALOG_STYLE: 14; /** Has Audio On/Off Button */ readonly AUDIO_BUTTON: 15; /** Ad Provides Skip Button */ readonly SKIP_BUTTON: 16; /** Adobe Flash */ readonly FLASH: 17; /** Responsive; Sizeless; Fluid */ readonly RESPONSIVE: 18; }; export type CreativeAttribute = (typeof CreativeAttribute)[keyof typeof CreativeAttribute]; /** * Subtypes of audio and video ad creatives */ export declare const AudioVideoCreativeSubtype: { /** VAST 1.0 */ readonly VAST_1_0: 1; /** VAST 2.0 */ readonly VAST_2_0: 2; /** VAST 3.0 */ readonly VAST_3_0: 3; /** VAST 1.0 Wrapper */ readonly VAST_1_0_WRAPPER: 4; /** VAST 2.0 Wrapper */ readonly VAST_2_0_WRAPPER: 5; /** VAST 3.0 Wrapper */ readonly VAST_3_0_WRAPPER: 6; /** VAST 4.0 */ readonly VAST_4_0: 7; /** VAST 4.0 Wrapper */ readonly VAST_4_0_WRAPPER: 8; /** DAAST 1.0 */ readonly DAAST_1_0: 9; /** DAAST 1.0 Wrapper */ readonly DAAST_1_0_WRAPPER: 10; /** VAST 4.1 */ readonly VAST_4_1: 11; /** VAST 4.1 Wrapper */ readonly VAST_4_1_WRAPPER: 12; /** VAST 4.2 */ readonly VAST_4_2: 13; /** VAST 4.2 Wrapper */ readonly VAST_4_2_WRAPPER: 14; /** VAST 4.3 */ readonly VAST_4_3: 15; /** VAST 4.3 Wrapper */ readonly VAST_4_3_WRAPPER: 16; }; export type AudioVideoCreativeSubtype = (typeof AudioVideoCreativeSubtype)[keyof typeof AudioVideoCreativeSubtype]; /** * Subtypes of display ad creatives */ export declare const DisplayCreativeSubtype: { /** HTML */ readonly HTML: 1; /** AMPHTML */ readonly AMPHTML: 2; /** Structured Image Object */ readonly STRUCTURED_IMAGE: 3; /** Structured Native Object */ readonly STRUCTURED_NATIVE: 4; }; export type DisplayCreativeSubtype = (typeof DisplayCreativeSubtype)[keyof typeof DisplayCreativeSubtype]; /** * Options for the delivery of video or audio content */ export declare const DeliveryMethod: { /** Streaming delivery */ STREAMING: number; /** Progressive delivery */ PROGRESSIVE: number; /** Download delivery */ DOWNLOAD: number; }; export type DeliveryMethod = (typeof DeliveryMethod)[keyof typeof DeliveryMethod]; /** * Types of devices */ export declare const DeviceType: { /** Mobile/Tablet - General */ readonly MOBILE_TABLET: 1; /** Personal Computer */ readonly PERSONAL_COMPUTER: 2; /** Connected TV */ readonly CONNECTED_TV: 3; /** Phone */ readonly PHONE: 4; /** Tablet */ readonly TABLET: 5; /** Connected Device */ readonly CONNECTED_DEVICE: 6; /** Set Top Box */ readonly SET_TOP_BOX: 7; /** OOH Device */ readonly OOH_DEVICE: 8; }; export type DeviceType = (typeof DeviceType)[keyof typeof DeviceType]; /** * Types of context in which a native ad may appear */ export declare const DisplayContextType: { /** Content-centric context */ readonly CONTENT: 10; /** Article content */ readonly ARTICLE: 11; /** Video content */ readonly VIDEO: 12; /** Audio content */ readonly AUDIO: 13; /** Image content */ readonly IMAGE: 14; /** User-generated content */ readonly USER_GENERATED: 15; /** Social-centric context */ readonly SOCIAL: 20; /** Email content */ readonly EMAIL: 21; /** Chat/IM content */ readonly CHAT: 22; /** Product context */ readonly PRODUCT: 30; /** App store/marketplace */ readonly APP_STORE: 31; /** Product reviews site */ readonly PRODUCT_REVIEWS: 32; }; export type DisplayContextType = (typeof DisplayContextType)[keyof typeof DisplayContextType]; /** * General types of display placements */ export declare const DisplayPlacementType: { /** In the feed of content */ readonly IN_FEED: 1; /** In the atomic unit of the content */ readonly IN_CONTENT: 2; /** Outside the core content */ readonly OUTSIDE_CONTENT: 3; /** Recommendation widget */ readonly RECOMMENDATION: 4; }; export type DisplayPlacementType = (typeof DisplayPlacementType)[keyof typeof DisplayPlacementType]; /** * Types of entities providing quantity measurement for impression multipliers */ export declare const DOOHMultiplierMeasurementSourceType: { /** Unknown source */ readonly UNKNOWN: 0; /** Measurement Vendor Provided */ readonly MEASUREMENT_VENDOR: 1; /** Publisher Provided */ readonly PUBLISHER: 2; /** Exchange Provided */ readonly EXCHANGE: 3; }; export type DOOHMultiplierMeasurementSourceType = (typeof DOOHMultiplierMeasurementSourceType)[keyof typeof DOOHMultiplierMeasurementSourceType]; /** * Supported taxonomies for DOOH venue types */ export declare const DOOHVenueTaxonomy: { /** AdCom DOOH Venue Types (deprecated) */ readonly ADCOM: 0; /** OpenOOH Venue Taxonomy 1.0 */ readonly OPENOOH_1_0: 1; /** DPAA Device Venue Types */ readonly DPAA: 2; /** DMI Categorization of Venues 1.1 */ readonly DMI_1_1: 3; /** OMA taxonomy Jan 2022 */ readonly OMA_2022: 4; /** OpenOOH Venue Taxonomy 1.1 */ readonly OPENOOH_1_1: 5; }; export type DOOHVenueTaxonomy = (typeof DOOHVenueTaxonomy)[keyof typeof DOOHVenueTaxonomy]; /** * Digital out-of-home venue types (derived from DPAA Programmatic Standards) * @deprecated */ export declare const DOOHVenueType: { /** Airborne */ readonly AIRBORNE: 1; /** Airports - General */ readonly AIRPORTS_GENERAL: 2; /** Airports - Baggage Claim */ readonly AIRPORTS_BAGGAGE_CLAIM: 3; /** Airports - Terminal */ readonly AIRPORTS_TERMINAL: 4; /** Airports - Lounges */ readonly AIRPORTS_LOUNGES: 5; /** ATMs */ readonly ATMS: 6; /** Backlights */ readonly BACKLIGHTS: 7; /** Bars */ readonly BARS: 8; /** Benches */ readonly BENCHES: 9; /** Bike Racks */ readonly BIKE_RACKS: 10; /** Bulletins */ readonly BULLETINS: 11; /** Buses */ readonly BUSES: 12; /** Cafes */ readonly CAFES: 13; /** Casual Dining Restaurants */ readonly CASUAL_DINING: 14; /** Child Care */ readonly CHILD_CARE: 15; /** Cinema */ readonly CINEMA: 16; /** City Information Panels */ readonly CITY_INFO_PANELS: 17; /** Convenience Stores */ readonly CONVENIENCE_STORES: 18; /** Dedicated Wild Posting */ readonly WILD_POSTING: 19; /** Doctors Offices - General */ readonly DOCTORS_GENERAL: 20; /** Doctors Offices - Obstetrics */ readonly DOCTORS_OBSTETRICS: 21; /** Doctors Offices - Pediatrics */ readonly DOCTORS_PEDIATRICS: 22; /** Family entertainment */ readonly FAMILY_ENTERTAINMENT: 23; /** Ferries */ readonly FERRIES: 24; /** Financial Services */ readonly FINANCIAL_SERVICES: 25; /** Gas Stations */ readonly GAS_STATIONS: 26; /** Golf Courses */ readonly GOLF_COURSES: 27; /** Gyms */ readonly GYMS: 28; /** Hospitals */ readonly HOSPITALS: 29; /** Hotels */ readonly HOTELS: 30; /** Junior Posters */ readonly JUNIOR_POSTERS: 31; /** Kiosks */ readonly KIOSKS: 32; /** Malls - General */ readonly MALLS_GENERAL: 33; /** Malls - Food Courts */ readonly MALLS_FOOD_COURTS: 34; /** Marine */ readonly MARINE: 35; /** Mobile Billboards */ readonly MOBILE_BILLBOARDS: 36; /** Movie Theater Lobbies */ readonly MOVIE_LOBBIES: 37; /** Newsstands */ readonly NEWSSTANDS: 38; /** Office Buildings */ readonly OFFICE_BUILDINGS: 39; /** Phone Kiosks */ readonly PHONE_KIOSKS: 40; /** Posters */ readonly POSTERS: 41; /** QSR */ readonly QSR: 42; /** Rail */ readonly RAIL: 43; /** Receptacles */ readonly RECEPTACLES: 44; /** Resorts / Leisure */ readonly RESORTS: 45; /** Retail */ readonly RETAIL: 46; /** Salons */ readonly SALONS: 47; /** Shelters */ readonly SHELTERS: 48; /** Sports Arenas */ readonly SPORTS_ARENAS: 49; /** Subway */ readonly SUBWAY: 50; /** Taxis / Wrapped vehicles */ readonly TAXIS: 51; /** Truckside */ readonly TRUCKSIDE: 52; /** Universities */ readonly UNIVERSITIES: 53; /** Urban Panels */ readonly URBAN_PANELS: 54; /** Veterinarian Offices */ readonly VETERINARIAN: 55; /** Walls / Spectaculars */ readonly WALLS: 56; /** Other */ readonly OTHER: 57; }; export type DOOHVenueType = (typeof DOOHVenueType)[keyof typeof DOOHVenueType]; /** * Methods of tracking ad events */ export declare const EventTrackingMethod: { /** Image-Pixel: URL provided will be inserted as a 1x1 pixel */ readonly IMAGE_PIXEL: 1; /** JavaScript: URL provided will be inserted as a JavaScript tag */ readonly JAVASCRIPT: 2; }; export type EventTrackingMethod = (typeof EventTrackingMethod)[keyof typeof EventTrackingMethod]; /** * Types of ad events available for tracking */ export declare const EventType: { /** Delivered as part of creative markup */ readonly LOADED: 1; /** Ad impression per IAB/MRC Guidelines */ readonly IMPRESSION: 2; /** MRC definition of 50% in view for 1 second */ readonly VIEWABLE_MRC_50: 3; /** 100% in view for 1 second (GroupM standard) */ readonly VIEWABLE_MRC_100: 4; /** Video 50% in view for 2 seconds */ readonly VIEWABLE_VIDEO_50: 5; }; export type EventType = (typeof EventType)[keyof typeof EventType]; /** * Directions in which an expandable ad may expand */ export declare const ExpandableDirection: { /** Expand to the left */ readonly LEFT: 1; /** Expand to the right */ readonly RIGHT: 2; /** Expand upward */ readonly UP: 3; /** Expand downward */ readonly DOWN: 4; /** Expand to full screen */ readonly FULL_SCREEN: 5; /** Resize/Minimize */ readonly RESIZE: 6; }; export type ExpandableDirection = (typeof ExpandableDirection)[keyof typeof ExpandableDirection]; /** * Types of audio feeds */ export declare const FeedType: { /** Music streaming service */ readonly MUSIC_STREAMING: 1; /** FM/AM broadcast */ readonly BROADCAST: 2; /** Podcast */ readonly PODCAST: 3; /** Catch-up radio */ readonly CATCHUP_RADIO: 4; /** Web radio */ readonly WEB_RADIO: 5; /** Video game audio */ readonly VIDEO_GAME: 6; /** Text to speech */ readonly TEXT_TO_SPEECH: 7; }; export type FeedType = (typeof FeedType)[keyof typeof FeedType]; /** * Methods for ID matching */ export declare const IDMatchMethod: { /** Unknown */ readonly UNKNOWN: 0; /** No matching occurred */ readonly NO_MATCH: 1; /** Browser Cookie Sync */ readonly COOKIE_SYNC: 2; /** Authenticated match */ readonly AUTHENTICATED: 3; /** Observed match */ readonly OBSERVED: 4; /** Inferred match */ readonly INFERENCE: 5; }; export type IDMatchMethod = (typeof IDMatchMethod)[keyof typeof IDMatchMethod]; /** * Services for IP geolocation */ export declare const IPLocationService: { /** ip2location */ readonly IP2LOCATION: 1; /** Neustar (Quova) */ readonly NEUSTAR: 2; /** MaxMind */ readonly MAXMIND: 3; /** NetAcuity (Digital Element) */ readonly NETACUITY: 4; }; export type IPLocationService = (typeof IPLocationService)[keyof typeof IPLocationService]; /** * Media linearity options */ export declare const LinearityMode: { /** Linear */ readonly LINEAR: 1; /** Non-Linear (Overlay) */ readonly NON_LINEAR: 2; }; export type LinearityMode = (typeof LinearityMode)[keyof typeof LinearityMode]; /** * Types of location determination */ export declare const LocationType: { /** GPS/Location Services */ readonly GPS: 1; /** IP Address */ readonly IP: 2; /** User Provided */ readonly USER_PROVIDED: 3; }; export type LocationType = (typeof LocationType)[keyof typeof LocationType]; /** * Media ratings based on TAG Inventory Quality Guidelines */ export declare const MediaRating: { /** All Audiences */ readonly ALL_AUDIENCES: 1; /** Everyone Over Age 12 */ readonly OVER_12: 2; /** Mature Audiences */ readonly MATURE: 3; }; export type MediaRating = (typeof MediaRating)[keyof typeof MediaRating]; /** * Native data asset types */ export declare const NativeDataAssetType: { /** Sponsored By message */ readonly SPONSORED: 1; /** Descriptive text */ readonly DESCRIPTION: 2; /** Numeric rating */ readonly RATING: 3; /** Number of likes */ readonly LIKES: 4; /** Number of downloads */ readonly DOWNLOADS: 5; /** Product price */ readonly PRICE: 6; /** Sale price */ readonly SALE_PRICE: 7; /** Phone number */ readonly PHONE: 8; /** Address */ readonly ADDRESS: 9; /** Additional description */ readonly DESCRIPTION_2: 10; /** Display URL */ readonly DISPLAY_URL: 11; /** CTA button text */ readonly CTA_TEXT: 12; }; export type NativeDataAssetType = (typeof NativeDataAssetType)[keyof typeof NativeDataAssetType]; /** * Native image asset types */ export declare const NativeImageAssetType: { /** Icon image (1:1 aspect ratio) */ readonly ICON: 1; /** Main image preview */ readonly MAIN: 3; }; export type NativeImageAssetType = (typeof NativeImageAssetType)[keyof typeof NativeImageAssetType]; /** * Device operating system options */ export declare const OperatingSystem: { /** Other Not Listed */ readonly OTHER: 0; /** 3DS System Software */ readonly THREE_DS: 1; /** Android */ readonly ANDROID: 2; /** Apple TV Software */ readonly APPLE_TV: 3; /** Asha */ readonly ASHA: 4; /** Bada */ readonly BADA: 5; /** BlackBerry */ readonly BLACKBERRY: 6; /** BREW */ readonly BREW: 7; /** ChromeOS */ readonly CHROME_OS: 8; /** Darwin */ readonly DARWIN: 9; /** FireOS */ readonly FIRE_OS: 10; /** FirefoxOS */ readonly FIREFOX_OS: 11; /** HelenOS */ readonly HELEN_OS: 12; /** iOS */ readonly IOS: 13; /** Linux */ readonly LINUX: 14; /** MacOS */ readonly MAC_OS: 15; /** MeeGo */ readonly MEEGO: 16; /** MorphOS */ readonly MORPH_OS: 17; /** NetBSD */ readonly NET_BSD: 18; /** NucleusPLUS */ readonly NUCLEUS_PLUS: 19; /** PS Vita System Software */ readonly PS_VITA: 20; /** PS3 System Software */ readonly PS3: 21; /** PS4 Software */ readonly PS4: 22; /** PSP System Software */ readonly PSP: 23; /** Symbian */ readonly SYMBIAN: 24; /** Tizen */ readonly TIZEN: 25; /** WatchOS */ readonly WATCH_OS: 26; /** WebOS */ readonly WEB_OS: 27; /** Windows */ readonly WINDOWS: 28; }; export type OperatingSystem = (typeof OperatingSystem)[keyof typeof OperatingSystem]; /** * Placement positions as a relative measure of visibility */ export declare const PlacementPosition: { /** Unknown */ readonly UNKNOWN: 0; /** Above The Fold */ readonly ABOVE_FOLD: 1; /** Locked (fixed position) */ readonly LOCKED: 2; /** Below The Fold */ readonly BELOW_FOLD: 3; /** Header */ readonly HEADER: 4; /** Footer */ readonly FOOTER: 5; /** Sidebar */ readonly SIDEBAR: 6; /** Fullscreen */ readonly FULLSCREEN: 7; }; export type PlacementPosition = (typeof PlacementPosition)[keyof typeof PlacementPosition]; /** * Video placement subtypes from IAB Digital Video Guidelines * @deprecated as of 2.6-202303 release */ export declare const VideoPlacementSubtype: { /** In-Stream: Played before, during or after streaming video content */ readonly IN_STREAM: 1; /** In-Banner: Exists within a web banner */ readonly IN_BANNER: 2; /** In-Article: Loads between paragraphs of editorial content */ readonly IN_ARTICLE: 3; /** In-Feed: Found in content, social, or product feeds */ readonly IN_FEED: 4; /** Interstitial/Slider/Floating: Covers entire or portion of screen */ readonly INTERSTITIAL: 5; }; export type VideoPlacementSubtype = (typeof VideoPlacementSubtype)[keyof typeof VideoPlacementSubtype]; /** * Updated video placement subtypes in accordance with IAB Digital Video Guidelines */ export declare const VideoPlacementType: { /** Instream: Pre-roll, mid-roll, and post-roll ads */ readonly INSTREAM: 1; /** Accompanying Content: Ads played with streaming video content */ readonly ACCOMPANYING: 2; /** Interstitial: Video ads played without video content */ readonly INTERSTITIAL: 3; /** No Content/Standalone: Video ads played without streaming video content */ readonly STANDALONE: 4; }; export type VideoPlacementType = (typeof VideoPlacementType)[keyof typeof VideoPlacementType]; /** * Media playback termination modes */ export declare const PlaybackCessationMode: { /** On Video Completion or when Terminated by User */ readonly ON_COMPLETION: 1; /** On Leaving Viewport or when Terminated by User */ readonly ON_VIEWPORT_EXIT: 2; /** Continues as Floating/Slider Unit until Completion or Termination */ readonly FLOATING_UNTIL_COMPLETE: 3; }; export type PlaybackCessationMode = (typeof PlaybackCessationMode)[keyof typeof PlaybackCessationMode]; /** * Media playback methods */ export declare const PlaybackMethod: { /** Initiates on Page Load with Sound On */ readonly AUTO_PLAY_SOUND_ON: 1; /** Initiates on Page Load with Sound Off by Default */ readonly AUTO_PLAY_SOUND_OFF: 2; /** Initiates on Click with Sound On */ readonly CLICK_TO_PLAY: 3; /** Initiates on Mouse-Over with Sound On */ readonly MOUSE_OVER: 4; /** Initiates on Entering Viewport with Sound On */ readonly VIEWPORT_SOUND_ON: 5; /** Initiates on Entering Viewport with Sound Off by Default */ readonly VIEWPORT_SOUND_OFF: 6; /** Continuous Playback */ readonly CONTINUOUS: 7; }; export type PlaybackMethod = (typeof PlaybackMethod)[keyof typeof PlaybackMethod]; /** * Pod deduplication settings */ export declare const PodDeduplicationSetting: { /** Deduplicated on adomain */ readonly BY_DOMAIN: 1; /** Deduplicated on IAB category */ readonly BY_CATEGORY: 2; /** Deduplicated on creative ID */ readonly BY_CREATIVE_ID: 3; /** Deduplicated on mediafile URL */ readonly BY_MEDIAFILE_URL: 4; }; export type PodDeduplicationSetting = (typeof PodDeduplicationSetting)[keyof typeof PodDeduplicationSetting]; /** * Pod sequence values for audio and video content streams */ export declare const PodSequence: { /** Last pod in the content stream */ readonly LAST: -1; /** Any pod in the content stream */ readonly ANY: 0; /** First pod in the content stream */ readonly FIRST: 1; }; export type PodSequence = (typeof PodSequence)[keyof typeof PodSequence]; /** * Content production quality options */ export declare const ProductionQuality: { /** Unknown */ readonly UNKNOWN: 0; /** Professionally Produced */ readonly PROFESSIONAL: 1; /** Prosumer */ readonly PROSUMER: 2; /** User Generated Content (UGC) */ readonly USER_GENERATED: 3; }; export type ProductionQuality = (typeof ProductionQuality)[keyof typeof ProductionQuality]; /** * Units of height and width for creatives and assets */ export declare const SizeUnit: { /** Device Independent Pixels (DIPS) */ readonly DIPS: 1; /** Inches */ readonly INCHES: 2; /** Centimeters */ readonly CENTIMETERS: 3; }; export type SizeUnit = (typeof SizeUnit)[keyof typeof SizeUnit]; /** * Slot position values for audio and video ad pods */ export declare const SlotPosition: { /** Last ad in the pod */ readonly LAST: -1; /** Any ad in the pod */ readonly ANY: 0; /** First ad in the pod */ readonly FIRST: 1; /** First or Last ad in the pod */ readonly FIRST_OR_LAST: 2; }; export type SlotPosition = (typeof SlotPosition)[keyof typeof SlotPosition]; /** * Video or audio start delay options */ export declare const StartDelayMode: { /** Generic Post-Roll */ readonly POST_ROLL: -2; /** Generic Mid-Roll */ readonly MID_ROLL: -1; /** Pre-Roll */ readonly PRE_ROLL: 0; }; export type StartDelayMode = (typeof StartDelayMode)[keyof typeof StartDelayMode]; /** * Sources for User-Agent metadata */ export declare const UserAgentSource: { /** Unspecified/unknown */ readonly UNKNOWN: 0; /** User-Agent Client Hints (low-entropy headers only) */ readonly CLIENT_HINTS_LOW: 1; /** User-Agent Client Hints (with high-entropy headers) */ readonly CLIENT_HINTS_HIGH: 2; /** Parsed from User-Agent header */ readonly PARSED_UA: 3; }; export type UserAgentSource = (typeof UserAgentSource)[keyof typeof UserAgentSource]; /** * Volume normalization modes for audio */ export declare const VolumeNormalizationMode: { /** None */ readonly NONE: 0; /** Ad Volume Average Normalized to Content */ readonly AVERAGE: 1; /** Ad Volume Peak Normalized to Content */ readonly PEAK: 2; /** Ad Loudness Normalized to Content */ readonly LOUDNESS: 3; /** Custom Volume Normalization */ readonly CUSTOM: 4; }; export type VolumeNormalizationMode = (typeof VolumeNormalizationMode)[keyof typeof VolumeNormalizationMode];