Common APIs

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

Overview

The Common APIs contains the master data APIs that are required to work with all other PubMatic-specific APIs. Typically, these APIs are "GET" calls which return the PubMatic master data which is fixed and pre-defined or managed by PubMatic. Partners can pull this data once and update it at a defined regular interval, say, once a day and keep it in their system which will be used later in other API calls.

 

View Common APIs for:

For Publishers

Methods

                                                         

Method Path
HTTP Method Type
Description
Link to Definition
/common/adCategory
GET
Retrieve the list of all the ad categories present in the PubMatic system.
/common/adCategory/{id}
GET
Retrieve the details of a specific ad category from the PubMatic system.
/common/adSize
GET
Retrieve the list of all the ad sizes present in the PubMatic system.
/common/adSize/{id}
GET
Retrieve the details of a specific ad size from the PubMatic system.
/common/geo
GET
Retrieve the list of all the Geos present in the PubMatic system.
/common/geo/{id}
GET
Retrieve the details of a specific Geo from the PubMatic system.
/common/microVertical
GET
Retrieve the list of all the micro-verticals present in the PubMatic system.
/common/microVertical/{id}
GET
Retrieve the details of a specific micro-vertical from the PubMatic system.
/common/platform/
GET
Retrieve the list of all the platforms present in the PubMatic system.
/common/platform/{id}
GET
Retrieve the details of a specific platform from the PubMatic system.
/common/browser
GET
Retrieve the list of all the browsers present in the PubMatic system.
/common/browser/{id}
GET
Retrieve the details of a specific browser from the PubMatic system.
/common/browserlanguageGETRetrieve the list of browser languages present in the PubMatic system.Retrieving List of Browser Languages
/common/browserlanguage{id}GETRetrieve the details of a browser language for a specified Id.Retrieving Details of a Browser Language
/common/connectionType
GET
Retrieve the list of all the connection types present in the PubMatic system.
/common/pmconnectiontypeGETRetrieve the list of connection types supported in the PubMatic system.Retrieving List of Connection Types (New)
/common/connectionType/{id}
GET
Retrieve the details of a specific connection type from the PubMatic system.
/common/pmconnectiontype/{id}GETRetrieve the details of a connection type for the specified IdRetrieving Details of a Connection Type (New)
/common/mobileOS
GET
Retrieve the list of all the mobile Operating Systems present in the PubMatic system.
/common/mobileOS/{id}
GET
Retrieve the details of a specific mobile Operating System from the PubMatic system.
/common/mobileDeviceType
GET
Retrieve the list of all the mobile device types present in the PubMatic system.
/common/mobileDeviceType/{id}
GET
Retrieve the details of a specific mobile device type from the PubMatic system.
/common/devicecapabilityGETRetrieve all device capabilities supported by the PubMatic system for targetingRetrieving a List of Device Capabilities
/common/devicecapability/{id}GETRetrieve the device capability details of a specific id in the PubMatic systemRetrieving Device Capability Details 
/common/mobileDeviceGETRetrieve the list of all device manufacturers/makesRetrieving List of Device Manufacturers/Makes
/common/mobileDeviceGETRetrieve the list of device models for a selected makeRetrieving List of Device Models for a Selected Make

/common/mobileDevice/{id}

GETRetrieve the details of manufacturer/make or model supported in the PubMatic system.Retrieving Details of Device Manufacturer/Make or Model
/common/mobileCarrier
GET
Retrieve the list of all the mobile carriers present in the PubMatic system.
/common/mobileCarrier/{id}
GET
Retrieve the details of a specific mobile carrier from the PubMatic system.
/common/phoneType
GET
Retrieve the list of all the phone types present in the PubMatic system.
Retrieving List of Phone Types
/common/phoneType/{id}
GET
Retrieve the details of a specific phone type from the PubMatic system.

 

For Buyers

Methods

                                                                                                                                                                                                                                                                           

Method Path
HTTP Method Type
Description
Link to Definition
/common/adCategory/{id}
GET
Retrieve the details of a specific ad category from the PubMatic system.
/common/adNetwork/{id}
GET
Retrieve the details of a specific ad network from the PubMatic system.
/common/foldPlacement
GET
Retrieve the list of all the fold placements present in the PubMatic system.
/common/foldPlacement/{id}
GET
Retrieve the details of a specific fold placement from the PubMatic system.
/common/vertical?pageSize=20&pageNumber=1
GET
Retrieve the list of all the verticals present in the PubMatic system
Retrieving List of Verticals
/common/vertical/{id}
GET
Retrieve the details of a specific vertical from the PubMatic system.
Retrieving Details of a Vertical
/common/videoType
GET
Retrieve the list of all the video ad types present in the PubMatic system.
/common/videoType/{id}
GET
Retrieve the details of a specific video ad type from the PubMatic system.
/common/videoPosition
GET
Retrieve the list of all the video ad positions present in the PubMatic system.
/common/videoPosition/{id}
GET
Retrieve the details of a specific video ad position from the PubMatic system.
/common/videoPlayback
GET
Retrieve the list of all the video ad playback methods present in the PubMatic system.
/common/videoPlayback/{id}
GET
Retrieve the details of a specific video ad playback method from the PubMatic system.
/common/richMediaTechnology
GET
Retrieve the list of all the rich media vendors present in the PubMatic system.
/common/richMediaTechnology/{id}
GET
Retrieve the details of a specific rich media vendor from the PubMatic system.
/common/pixel?pageSize=20&pageNumber=1
GET
Retrieve the list of all the pixels present in the PubMatic system.
Retrieving a list of all pixels present in PubMatic
/common/pixel/{id}GETRetrieve the details of a pixel by using the pixel ID present in the PubMatic system.Retrieving Details of a Pixel by ID

PMP Deal Transaction Common API links

                                       

Method Path
HTTP Method
Type
Description
Link to Definition
/common/advertiserCategory
GET
Retrieving the details of all the advertiser's categories present in the PubMatic system.
/common/advertiser
GET
Retrieving the details of all the advertisers present in the PubMatic system.
/common/advertiserDomain
GET
Retrieving the details of all the advertiser's domains present in the PubMatic system.
/common/advertisingEntity
GET
Retrieving the details of all the PMP enabled DSPs.
/common/buyer
GET
Retrieving the details of all the PMP enabled buyers.
Retrieving List of PMP-enabled Buyers

Attachments

    Outcomes