Supported Dimensions/Metrics/Operators

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

The following are supported in the Forecast API.

Supported Dimensions

                                                                                                                                                                                                                                                                                                                                        

Name

Data Type

Description

date

String

Indicates the date of impression

The value would be in Date ISO 8601 format depicted in the table below.

             

Field

Format

Example

date

YYYY-MM-DD

2014-07-08

Only one of these dimensions can be present in single query and the fromDate and toDate should be in the same format.

If none of these dimensions are present then the date format would be assumed as of date and the data would be aggregated by date.

hourIntegerIndicates the hour of the day. Expected values for this field in response is between 0 - 23.

inventorySourceId

Numeric

Indicate the source of inventory from where impression is coming.Possible values are as follows

                       
Id

Inventory source

1PubMatic yield server
2Guaranteed ad server
3Mocean ad sever
4Publisher Ad Server
dataCenterIdNumeric

Indicates PubMatic identifier which represents PubMatic Data Center with respective to Location.

                           
Id
Location
1San Francisco
2New York
3Amsterdam
4Singapore
6Tokyo

pubId

Numeric

Indicates an identifier of the publisher in the PubMatic system.

siteId

Numeric

Indicate an identifier for site created for the publisher.

adTagId

Numeric

Indicates placement identifier for given site.

sectionId

String

Section ID associated with adTagId.

adSizeId

Numeric

Indicates an Identifier for an ad size.

foldPlacementId

Numeric

Indicates fold placement

                       

Id

Placement

0

Unknown

1

Above the Fold   

2

Below the Fold 

3

Partially Above the Fold

platformId

Numeric

Indicates Platform on which impression was served.

                       

Id

Name

1

Web

2

Mobile Web

4

Mobile App IOS

5

Mobile App Android

countryId

Numeric

PubMatic system stores the country information. Country ID is the PubMatic generated ID which indicate the country from where impression came.

Possible values: Referred to PubMatic API call which will returned the Countries details http://developer.pubmatic.com/documentation/retrieving-list-geos. You have to pass received geoid value in response as countryId.

regionIdNumeric

Indicates the PubMatic identifier for region code.

Possible values: Referred to PubMatic API call which returns the Region code details http://developer.pubmatic.com/documentation/retrieving-list-geos. You have to pass received id value in response as regionId.

cityIdNumeric

Indicates the PubMatic identifier for city name.

Possible values: Referred to PubMatic API call which returns the City name details http://developer.pubmatic.com/documentation/retrieving-list-geos. You have to pass received id value in response as cityId.

dmaIdNumeric

Indicates the PubMatic identifier for dma Code.

Possible values: Referred to PubMatic API call which returns the dmaCode details http://developer.pubmatic.com/documentation/retrieving-list-geos. You have to pass received id value in response as dmaId.

zipCodeStringIndicate the Home zip code if USA, else postal code.

channelId

Numeric

Indicates the channel through which impression was served.

                       

Id

Channel

1

PMP

2

Ad Flex Standard

3

RTB

4

Ad Network

verticalId

Numeric

Unique identifier of the vertical for the site.

dealId

Numeric

Indicates the numeric deal id that uniquely represents the deal.

locSourceId

Numeric

Source of user's mobile device's location as provided by publisher. Possible values are as follows

                       

Id

Description

0

Unknown

1

GPS / Location Services

2

IP Address

3

User provided (for example, registration data)

udidTypeId

Numeric

Type of device identifier received in impression. Possible values are as follows

                                                   

Id

Type

0

Other

1

IDFA                  

2

IDFV                 

3

Android_ID

4

UDID                

5

OpenUDID             

6

SecureUDID           

7

MAC Address          

8

ODIN–1               

9

Android Advertising Id

10

AdTruth ID

videoTypeId

Numeric

PubMatic identifier for Video Ad Type.

               

Id

Description

1

Linear    

2

Non-Linear

videoPosId

Numeric

PubMatic identifier for Video ad position

                   

Id

Description

1

Pre-roll   

2

In-roll    

3

Post-roll  

osId

Numeric

Indicate PubMatic System Id of operating system from which impression received.

                                                   
Id
Operating System
1iOS
2Android
3Symbian
4

BlackBerry OS

5Web OS
6Windows Phone
7Maemo
8MeeGo
9Bada
10Palm OS
11Undefined

The mentioned osId are the standered osIds in PubMatic system. Each Osid may have a subtype which is again considered as osId in itself

browserId

Numeric

Indicate the PubMatic System Browser Id from which impression recieved.

                               
Id
Browser
1Internet Explorer
2Mozilla Firefox
3Safari
4Opera
5Chrome
6IE Mobile
languageIdNumericIndicates the PubMatic unique identifier for browser language.

connectionTypeId

Numeric

Unique identifier of the connection type.

               

Id

Description

1

Cellular   

2

WiFi 

deviceTypeId

Numeric

Unique identifier of the phone type.

                       

Id

Description

1

Feature Phone

2

Smart Phone  

3

Undefined  

4

Tablet       

carrierId

Numeric

Unique identifier of the mobile carrier represented in PubMatic System.

You can get the list of carrier using http://developer.pubmatic.com/documentation/retrieving-list-mobile-carriers API

pageURLStringPage URL
refURLStringDomain name from given reference URL.
accountIdNumericIndicates an identifier of the publisher in the PubMatic system. Its will be same as pubId.
adFormatIdNumericIndicates the AdUnit Format.
adUnitIdNumericIndicates the unique AdUnit identifier.
minWidthNumericIndicates Minimum Width of Creative.
minHeightNumericIndicates Minimum Height of Creative.
maxWidthNumericIndicates Maximum Width of Creative.
maxHeightNumericIndicates Maximum Height of Creative.
adWidthNumericIndicates Width of Ad slot.
adHeightNumericIndicates Height of Ad slot.
neighbourhoodIdNumericIndicates unique identifier of Neighborhood in context of geography. 
screenWidthNumericIndicates Width of Screen.
screenHeightNumericIndicates Height of Screen.
videoProtocolIdNumericIndicates unique identifier of Video Protocol.
vpaidSupportProtocolIdNumericIndicates unique identifier for VPAID Support Protocol.
videoDurationNumericIndicates duration of video.
videoMimeTypeStringIndicates Mime Type in Video.
videoPlayerWidthNumericIndicates Player Width.
videoPlayerHeightNumericIndicates Player Height.
isCompanionManadatoryNumericIndicates whether companion ad is mandatory.
companionCreativeTypeIdNumericIndicates unique identifier for creative type.
ispIdNumericIndicates unique identifier for Internet Service Provider.
deviceCapIdNumericIndicates unique identifier for Device Capability.
ipAddressStringIndicates IP Address.
domainStringIndicates domain name.
requestedSizesStringIndicates requested AdSize.
lineItemTypeIdNumericIndicates unique identifier for LineItem Type.
eligiblelineItemIdNumericIndicates list of eligible LineItems.
eligibletargetIdNumericIndicates eligible Targeting associated with LineItem.
wRtbCampIdNumericindicates winning RTB Campaign.
primaryIabCatIdNumericIndicates unique identifier for Primary IAB Category.
secondaryIabCatIdNumericIndicates unique identifier for Secondary IAB Category.
wAdSizeStringIndicates wining AdSize.
clickedbooleanIndicates if the Click action is performed.

 

 

Attachments

    Outcomes