OpenRTB 2.1 Reference

Document created by pubmatic-archivist on Mar 27, 2017Last modified by catherine.racette on Jun 6, 2017
Version 2Show Document
  • View in full screen mode

Win/Loss Notification Status

                                                               

Status-ID
Description
0
Bid has won the auction
1
Timeout on bid response
2
Incomplete bid response
3
An invalid bid price was quoted (for example less than $0.0000 or greater than $999)
4
Outbid by competitor
5
Advertiser domain blocked by publisher
6
Advertiser domain is missing in the response or not found in the publisher’s white List
7
Creative ID not provided in the bid response
8
Creative blocked by publisher
9
Bid price decryption failed
10
The bid price did not clear either publisher’s floor price or has less priority (set by the publisher) than other bids
11
The requestId in bid-response is not matching with the requestId that was sent in bid-request
12
Publisher is expecting a secured creative url (HTTPS) but the url in the response is not secure
13
Currency code passed in response parameter ‘bidCurrency’ was invalid or not supported by PubMatic.

 

Rich Media Technologies

                                                                       

Short code
Iframe Busting Technology Package
pr
Pointroll
eb
Eyeblaster
dc
DoubleClick
ew
EyeWonder
mp
Mediaplex
vp
Viewpoint
ui
Unicast
sa
Smart Adserver
km
Klipmart
er
EyeReturn
at
Atlas
ad
Adinterax
ac
Adcentric
ft
Flashtalking
mm
MediaMind
pt
Pictela

 

Deal - No Bid Reason

                                               

Status ID
Description
1
Unknown Error
2
Technical Error
3
Invalid/Malformed Request
4
Known Web spider
5
Suspected Non-Human Traffic
6
Cloud,Data center, or Proxy IP
7
Unsupported Device
8
Blocked Publisher or Site
9
Unmatched user
10
Capping/Spending limit

 

IAB Categories List

                                                                                                                                              

Value
Description
IAB1
Arts & Entertainment
IAB1-1
Books & Literature
IAB1-2
Celebrity Fan/Gossip
IAB1-3
Fine Art
IAB1-4
Humor
IAB1-5
Movies
IAB1-6
Music
IAB1-7
Television
IAB2
Automotive
IAB2-1
Auto Parts
IAB2-2
Auto Repair
IAB2-3
Buying/Selling Cars
IAB2-4
Car Culture
IAB2-5
Certified Pre-Owned
IAB2-6
Convertible
IAB2-7
Coupe
IAB2-8
Crossover
IAB2-9
Diesel
IAB2-10
Electric Vehicle
IAB2-11
Hatchback
IAB2-12
Hybrid
IAB2-13
Luxury
IAB2-14
MiniVan
IAB2-15
Motorcycles
IAB2-16
Off-Road Vehicles
IAB2-17
Performance Vehicles
IAB2-18
Pickup
IAB2-19
Road-Side Assistance
IAB2-20
Sedan
IAB2-21
Trucks & Accessories
IAB2-22
Vintage Cars
IAB2-23
Wagon
IAB3
Business
IAB3-1
Advertising
IAB3-2
Agriculture
IAB3-3
Biotech/Biomedical
IAB3-4
Business Software
IAB3-5
Construction
IAB3-6
Forestry
IAB3-7
Government
IAB3-8
Green Solutions
IAB3-9
Human Resources
IAB3-10
Logistics
IAB3-11
Marketing
IAB3-12
Metals
IAB4
Careers
IAB4-1
Career Planning
IAB4-2
College
IAB4-3
Financial Aid
IAB4-4
Job Fairs
IAB4-5
Job Search
IAB4-6
Resume Writing/Advice
IAB4-7
Nursing
IAB4-8
Scholarships
IAB4-9
Telecommuting
IAB4-10
U.S. Military
IAB4-11
Career Advice
IAB5
Education
IAB5-1
7-12 Education
IAB5-2
Adult Education
IAB5-3
Art History
IAB5-4
College Administration
IAB5-5
College Life
IAB5-6
Distance Learning
IAB5-7
English as a 2nd Language
IAB5-8
Language Learning
IAB5-9
Graduate School
IAB5-10
Homeschooling
IAB5-11
Homework/Study Tips
IAB5-12
K-6 Educators
IAB5-13
Private School
IAB5-14
Special Education
IAB5-15
Studying Business
IAB6
Family & Parenting
IAB6-1
Adoption
IAB6-2
Babies & Toddlers
IAB6-3
Daycare/Pre School
IAB6-4
Family Internet
IAB6-5
Parenting - K-6 Kids
IAB6-6
Parenting teens
IAB6-7
Pregnancy
IAB6-8
Special Needs Kids
IAB6-9
Eldercare
IAB7
Health & Fitness
IAB7-1
Exercise
IAB7-2
A.D.D.
IAB7-3
AIDS/HIV
IAB7-4
Allergies
IAB7-5
Alternative Medicine
IAB7-6
Arthritis
IAB7-7
Asthma
IAB7-8
Autism/PDD
IAB7-9
Bipolar Disorder
IAB7-10
Brain Tumor
IAB7-11
Cancer
IAB7-12
Cholesterol
IAB7-13
Chronic Fatigue Syndrome
IAB7-14
Chronic Pain
IAB7-15
Cold & Flu
IAB7-16
Deafness
IAB7-17
Dental Care
IAB7-18
Depression
IAB7-19
Dermatology
IAB7-20
Diabetes
IAB7-21
Epilepsy
IAB7-22
GERD/Acid Reflux
IAB7-23
Headaches/Migraines
IAB7-24
Heart Disease
IAB7-25
Herbs for Health
IAB7-26
Holistic Healing
IAB7-27
IBS/Crohn's Disease
IAB7-28
Incest/Abuse Support
IAB7-29
Incontinence
IAB7-30
Infertility
IAB7-31
Men's Health
IAB7-32
Nutrition
IAB7-33
Orthopedics
IAB7-34
Panic/Anxiety Disorders
IAB7-35
Pediatrics
IAB7-36
Physical Therapy
IAB7-37
Psychology/Psychiatry
IAB7-38
Senor Health
IAB7-39
Sexuality
IAB7-40
Sleep Disorders
IAB7-41
Smoking Cessation
IAB7-42
Substance Abuse
IAB7-43
Thyroid Disease
IAB7-44
Weight Loss
IAB7-45
Women's Health
IAB8
Food & Drink
IAB8-1
American Cuisine
IAB8-2
Barbecues & Grilling
IAB8-3
Cajun/Creole
IAB8-4
Chinese Cuisine
IAB8-5
Cocktails/Beer
IAB8-6
Coffee/Tea
IAB8-7
Cuisine-Specific
IAB8-8
Desserts & Baking
IAB8-9
Dining Out
IAB8-10
Food Allergies
IAB8-11
French Cuisine
IAB8-12
Health/Low fat Cooking
IAB8-13
Italian Cuisine
IAB8-14
Japanese Cuisine
IAB8-15
Mexican Cuisine
IAB8-16
Vegan
IAB8-17
Vegetarian
IAB8-18
Wine
IAB9
Hobbies & Interests
IAB9-1
Art/Technology
IAB9-2
Arts & Crafts
IAB9-3
Beadwork
IAB9-4
Bird watching
IAB9-5
Board Games/Puzzles
IAB9-6
Candle & Soap Making
IAB9-7
Card Games
IAB9-8
Chess
IAB9-9
Cigars
IAB9-10
Collecting
IAB9-11
Comic Books
IAB9-12
Drawing/Sketching
IAB9-13
Freelance Writing
IAB9-14
Genealogy
IAB9-15
Getting Published
IAB9-16
Guitar
IAB9-17
Home Recording
IAB9-18
Investors & Patents
IAB9-19
Jewelry Making
IAB9-20
Magic & Illusion
IAB9-21
Needlework
IAB9-22
Painting
IAB9-23
Photography
IAB9-24
Radio
IAB9-25
Roleplaying Games
IAB9-26
Sci-Fi & Fantasy
IAB9-27
Scrapbooking
IAB9-28
Screenwriting
IAB9-29
Stamps & Coins
IAB9-30
Video & Computer Games
IAB9-31
Woodworking
IAB10
Home & Garden
IAB10-1
Appliances
IAB10-2
Entertaining
IAB10-3
Environmental Safety
IAB10-4
Gardening
IAB10-5
Home Repair
IAB10-6
Home Theater
IAB10-7
Interior Decorating
IAB10-8
Landscaping
IAB10-9
Remodeling & Construction
IAB11
Law, Gov't & Politics
IAB11-1
Immigration
IAB11-2
Legal Issues
IAB11-3
U.S. Government Resources
IAB11-4
Politics
IAB11-5
Commentary
IAB12
News
IAB12-1
International News
IAB12-2
National News
IAB12-3
Local News
IAB13
Personal Finance
IAB13-1
Beginning Investing
IAB13-2
Credit/Debt & Loans
IAB13-3
Financial News
IAB13-4
Financial Planning
IAB13-5
Hedge Fund
IAB13-6
Insurance
IAB13-7
Investing
IAB13-8
Mutual Funds
IAB13-9
Options
IAB13-10
Retirement Planning
IAB13-11
Stocks
IAB13-12
Tax Planning
IAB14
Society
IAB14-1
Dating
IAB14-2
Divorce Support
IAB14-3
Gay Life
IAB14-4
Marriage
IAB14-5
Senior Living
IAB14-6
Teens
IAB14-7
Weddings
IAB14-8
Ethnic Specific
IAB15
Science
IAB15-1
Astrology
IAB15-2
Biology
IAB15-3
Chemistry
IAB15-4
Geology
IAB15-5
Paranormal Phenomena
IAB15-6
Physics
IAB15-7
Space/Astronomy
IAB15-8
Geography
IAB15-9
Botany
IAB15-10
Weather
IAB16
Pets
IAB16-1
Aquariums
IAB16-2
Birds
IAB16-3
Cats
IAB16-4
Dogs
IAB16-5
Large Animals
IAB16-6
Reptiles
IAB16-7
Veterinary Medicine
IAB17
Sports
IAB17-1
Auto Racing
IAB17-2
Baseball
IAB17-3
Bicycling
IAB17-4
Bodybuilding
IAB17-5
Boxing
IAB17-6
Canoeing/Kayaking
IAB17-7
Cheerleading
IAB17-8
Climbing
IAB17-9
Cricket
IAB17-10
Figure Skating
IAB17-11
Fly Fishing
IAB17-12
Football
IAB17-13
Freshwater Fishing
IAB17-14
Game & Fish
IAB17-15
Golf
IAB17-16
Horse Racing
IAB17-17
Horses
IAB17-18
Hunting/Shooting
IAB17-19
Inline Skating
IAB17-20
Martial Arts
IAB17-21
Mountain Biking
IAB17-22
NASCAR Racing
IAB17-23
Olympics
IAB17-24
Paintball
IAB17-25
Power & Motorcycles
IAB17-26
Pro Basketball
IAB17-27
Pro Ice Hockey
IAB17-28
Rodeo
IAB17-29
Rugby
IAB17-30
Running/Jogging
IAB17-31
Sailing
IAB17-32
Saltwater Fishing
IAB17-33
Scuba Diving
IAB17-34
Skateboarding
IAB17-35
Skiing
IAB17-36
Snowboarding
IAB17-37
Surfing/Body boarding
IAB17-38
Swimming
IAB17-39
Table Tennis/Ping-Pong
IAB17-40
Tennis
IAB17-41
Volleyball
IAB17-42
Walking
IAB17-43
Waterski/Wakeboard
IAB17-44
World Soccer
IAB18
Style & Fashion
IAB18-1
Beauty
IAB18-2
Body Art
IAB18-3
Fashion
IAB18-4
Jewelry
IAB18-5
Clothing
IAB18-6
Accessories
IAB19
Technology & Computing
IAB19-1
3-D Graphics
IAB19-2
Animation
IAB19-3
Antivirus Software
IAB19-4
C/C++
IAB19-5
Cameras & Camcorders
IAB19-6
Cell Phones
IAB19-7
Computer Certification
IAB19-8
Computer Networking
IAB19-9
Computer Peripherals
IAB19-10
Computer Reviews
IAB19-11
Data Centers
IAB19-12
Databases
IAB19-13
Desktop Publishing
IAB19-14
Desktop Video
IAB19-15
Email
IAB19-16
Graphics Software
IAB19-17
Home Video/DVD
IAB19-18
Internet Technology
IAB19-19
Java
IAB19-20
JavaScript
IAB19-21
Mac Support
IAB19-22
MP3/MIDI
IAB19-23
Net Conferencing
IAB19-24
Net for Beginners
IAB19-25
Network Security
IAB19-26
Palmtops/PDAs
IAB19-27
PC Support
IAB19-28
Portable
IAB19-29
Entertainment
IAB19-30
Shareware/Freeware
IAB19-31
Unix
IAB19-32
Visual Basic
IAB19-33
Web Clip Art
IAB19-34
Web Design/HTML
IAB19-35
Web Search
IAB19-36
Windows
IAB20
Travel
IAB20-1
Adventure Travel
IAB20-2
Africa
IAB20-3
Air Travel
IAB20-4
Australia & New Zealand
IAB20-5
Bed & Breakfasts
IAB20-6
Budget Travel
IAB20-7
Business Travel
IAB20-8
By US Locale
IAB20-9
Camping
IAB20-10
Canada
IAB20-11
Caribbean
IAB20-12
Cruises
IAB20-13
Eastern Europe
IAB20-14
Europe
IAB20-15
France
IAB20-16
Greece
IAB20-17
Honeymoons/Getaways
IAB20-18
Hotels
IAB20-19
Italy
IAB20-20
Japan
IAB20-21
Mexico & Central America
IAB20-22
National Parks
IAB20-23
South America
IAB20-24
Spas
IAB20-25
Theme Parks
IAB20-26
Traveling with Kids
IAB20-27
United Kingdom
IAB21
Real Estate
IAB21-1
Apartments
IAB21-2
Architects
IAB21-3
Buying/Selling Homes
IAB22
Shopping
IAB22-1
Contests & Freebies
IAB22-2
Couponing
IAB22-3
Comparison
IAB22-4
Engines
IAB23
Religion & Spirituality
IAB23-1
Alternative Religions
IAB23-2
Atheism/Agnosticism
IAB23-3
Buddhism
IAB23-4
Catholicism
IAB23-5
Christianity
IAB23-6
Hinduism
IAB23-7
Islam
IAB23-8
Judaism
IAB23-9
Latter-Day Saints
IAB23-10
Pagan/Wiccan
IAB24
Uncategorized
IAB25
Non-Standard Content
IAB25-1
Un-moderated UGC
IAB25-2
Extreme Graphic/Explicit Violence
IAB25-3
Pornography
IAB25-4
Profane Content
IAB25-5
Hate Content
IAB25-6
Under Construction
IAB25-7
Incentivized
IAB26
Illegal Content
IAB26-1
Illegal Content
IAB26-2
Warez
IAB26-3
Spyware/Malware
IAB26-4
Copyright Infringement

 

API Frameworks

                           

Value
Description
1
VPAID 1.0
2
VPAID 2.0
3
MRAID 1.0
4
ORMMA
5
MRAID 2.0

 

Creative Attributes

                                                                                   

ID
Creative Attribute
1
Audio Ad (Auto Play)
2
Audio Ad (User Initiated)
3
Expandable (Automatic)
4
Expandable (User Initiated - Click)
5
Expandable (User Initiated - Rollover)
6
in Banner Video Ad (Auto Play)
7
in Banner Video Ad (User Initiated)
8
Pop (such as Over, Under, or upon Exit)
9
Provocative or Suggestive Image Ads
10
Shaky/Flashing/Flickering Ad, Extreme Animation, or Smileys
11
Survey Ads (such as Dynamic Logic, Insight Express, Vizu, and so on.)
12
Text Only Ads
13
User Interactive (such as embedded games)
14
Windows Dialog Ad or Alert Style Ad
44
Auto Refresh Ad. This ID will be deprecated in future.
45Flash Ad. This ID has been deprecated.
51Auto Refresh Ad
52Flash Ad
53Image Ad

Native Layout IDs

                                       

Layout ID
Description
1
Content Wall
2
App Wall
3
News Feed
4
Chat List
5
Carousel
6
Content Stream
7
Grid adjoining the content
500+
Reserved for Exchange
specific layouts

Native Ad Unit IDs

                             

AD Unit ID
Description
1
Paid Search Units
2
Recommendation Widgets
3
Promoted Listings
4
In-Ad (IAB Standard) with Native Element Units
5
Custom /”Can’t Be Contained”
500+
Reserved for Exchange specific formats

Data Asset Types

                                                                                       

AD Unit ID
Name
Description
Format
1
sponsored
Sponsored By message where response should contain the brand name of the sponsor
text
2
desc
Descriptive text associated with the product or
service being advertised
text
3
rating
Rating of the product being offered to the user.
For example an app’s rating in an app store from
0-5
Number formatted as string
4
likes
Number of social ratings or “likes” of the product being offered to the user
number
formatted as
string
 
5
downloads
Number downloads/installs of this product
number
formatted as
string
 
6
price
Price for product / app / in-app purchase. Value
should include currency symbol in localized format
 
number
formatted as
string
 
7
saleprice
Sale price that can be used together with price to
indicate a discounted price compared to a regular
price. Value should include currency symbol in
localised format
 
number
formatted as
string
 
8
phone
Phone number
formatted
string
 
9
address
Address
text
10
desc2
Additional descriptive text associated with the
product or service being advertised
 
text
11
displayurl
Display URL for the text ad
 
text
12
ctatext
CTA description - descriptive text describing a ‘call to action’ button for the destination URL.
text
500+
XXX
Reserved for Exchange specific usage numbered above 500
Unknown

Image Asset Types

                          

AD Unit ID
Name
Description
1
Icon
Icon image
2
Logo
Logo image for the brand/app
3
Main
Large image preview for the ad
500+
XXX
Reserved for Exchange specific usage numbered
above 500

Attachments

    Outcomes