Units API

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

Description

These APIs allows a partner to create and manage inventory units in the PubMatic system.

Methods

                                 

Method Path
HTTP Method Type
Description
Link to Definition
/inventoryUnits
POST
Create a new Inventory Unit in the PubMatic system.
Creating an Inventory Unit
/inventoryUnitsGET
Retrieve the list of Inventory Units present in the PubMatic system for a specific partner.
Retrieving List of Inventory Units
/inventoryUnits/{id}
GET
Retrieve the details of a specific Inventory Unit from the PubMatic system.
Retrieving Details of an Inventory Unit
/inventoryUnits/{id}
PUT
Update the details of an existing Inventory Unit in the PubMatic system.
Updating an Inventory Unit

 

Reference Data

See Reference Data used for Inventory Units (below).

 

Creating an Inventory Unit

Overview

This API allows you to create a new Inventory Unit in the PubMatic system.

Request

         
URI$URI_PREFIX/inventoryUnits
HTTP MethodPOST

Request Headers

                 

Header Name
Type
Value
Required
Description
Authorization
String
Bearer ${access_token}
Yes
Need to send the access token generating for authentication at the place of ${access_token}.
For more information about access tokens, refer to Getting Started with PubMatic APIs

Request Body

Note: For more details about the reference data, refer the Reference Data section.

                                                                                                                                                                                                                          
Body Parameter
Type
Required
Validations
Description
name
String
Yes
 
Name of the given Inventory Unit.
description
String
No
 
Description of the given Inventory Unit.
type
Integer
Yes
 
Type of the given Inventory Unit.
For example, PubMatic or Cross Exchange.
hashTags
JSON Array of String
No
 
Keywords/tags for the given Inventory Unit which will be used in searching,
platforms
JSON Array of Integer
No
 
Platforms on which the given Inventory Unit can be used.
For example, Web, Mobile Web, etc.
verticals
JSON Array of Integer
No
 
Verticals to which the given Inventory Unit belongs.
For example, Automotive, Education, etc.
publisher
Integer
Yes
 
Publisher associated with the given Inventory Unit.
sites
JSON Array of Integer
At least 1 site or ad tag should be selected (Currently, creating an Inventory Unit for all sites and all ad tags is not supported.)
 
Sites associated with the given Inventory Unit.
adTags
JSON Array of Integer
At least 1 site or ad tag should be selected (Currently, creating an Inventory Unit for all sites and all ad tags is not supported.)
 
Ad tags associated with the given Inventory Unit.
siteSections
JSON Array of Integer
No
 
Site sections associated with the given Inventory Unit.
geos
JSON Array of Integer
No
 
Geos associated with the given Inventory Unit.
For example, US, Canada, New York, etc.
daysOfWeek
JSON Array of Integer
No
 
Days of the week associated with the given Inventory Unit.
startTimeParting
Timestamp
No
HH:MM:SS
Start Time after which the given Inventory Unit is applicable.
endTimeParting
Timestamp
No
HH:MM:SS
End Time till which the given Inventory Unit is applicable.
browsers
JSON Array of Integer
No
 
Browsers that can be targeted using the given Inventory Unit.
For example, IE, Firefox, etc.
connectionTypes
JSON Array of Integer
No
 
Connection types associated with the given Inventory Unit.
For example, Cellular, Dialup, etc.
osTypes
JSON Array of Integer
No
 
Types of mobile devices' OSs associated with the given Inventory Unit.
For example, iOS, Android, etc.
os
JSON Array of Integer
No
 
OS associated with the given Inventory Unit.
deviceTypes
JSON Array of Integer
No
 
Device types associated with the given Inventory Unit.
For example, Smartphone, Tablet, etc.
devices
JSON Array of Integer
No
 
Devices associated with the given Inventory Unit.
carriers
JSON Array of Integer
No
 
Mobile Carriers associated with the given Inventory Unit.
latLong
Boolean
No
 
Indicates whether latitude-longitude targeting is enabled in the given Inventory Unit or not.
deviceIdType
Integer
No
 
Device ID type associated with the given Inventory Unit
isDiscoverable
Boolean
No
 
Indicates whether the given Inventory Unit can be discovered by others or not.
richMediaTechnologies
JSON Array of Integer
No
 
Rich media vendors associated with the given Inventory Unit.
For example, Pointroll, Eyeblaster, etc.
videoAdTypes
JSON Array of Integer
No
 
Video ad types associated with the given Inventory Unit.
For example, Linear, Non-Linear, etc.
videoAdPositions
JSON Array of Integer
No
 
Video ad positions associated with the given Inventory Unit.
For example, Pre-roll, Post-roll, etc.
videoPlaybacks
JSON Array of Integer
No
 
Video playback types associated with the given Inventory Unit.
For example, "Auto-play sound on", "Click-to-play", etc.
companionAds
 
Boolean
No
 
Indicates whether companion ads support is enabled for the given Inventory Unit or not.
This parameter is used as a filter for video ad tags.
minAdDuration
Integer
No
 
Minimum duration of a video ad associated with the given Inventory Unit.
This parameter is used as a filter for video ad tags.
maxAdDuration
Integer
No
 
Maximum duration of a video ad associated with the given Inventory Unit.
This parameter is used as a filter for video ad tags.
vpaidComplianceVersions
JSON Array of Integer
No
 
VPAID versions associated with the given Inventory Unit.
Possible values are:
  • 0 - NO VPAID
  • 1 - VPAID 1.0
  • 2 - VPAID 2.0
This parameter is used as a filter for video ad tags.
vastVersions
JSON Array of Integer
No
 
VAST versions associated with the given Inventory Unit.
Possible values are:
  • 2 - VAST 2.0
  • 3 - VAST 3.0
This parameter is used as a filter for video ad tags.
channels
JSON Array of Integer
No
 
Ad format type associated with the given Inventory Unit.
Possible values are:
  • 0 - IFrame
  • 1 - JavaScript
  • 2 - Mobile AdTag
  • 3 - Video

Sample Request


POST $URI_PREFIX/inventoryUnits

{
  "name" : "test name 24thmay - 1",
  "description" : "test description 26thmay - 1",
  "hashTags":"test123,newhashtag",
  "startTimeParting": "00:00:00",
  "endTimeParting": "08:00:00",
  "isFirstPartyDataAvailable" : false,
  "firstPartyDataDescription" : "test first party data description 26thmay 1",
  "sites" : [1],
  "browsers":[1],
  "platforms":[1,2,3,4,5],
  "siteSections":[1,2],
  "os":[80,81],
  "connectionTypes":[4],
  "devices":[97,552],
  "carriers":[309],
  "adTags" :[2,3,4],
  "geos":[48,349,162823,162803,155852],
  "richMediaTechnologies":[5],
  "videoAdTypes":[1],
  "videoAdPositions":[2],
  "videoPlaybackMethods":[3],
  "osTypes":[3,7],
  "deviceTypes":[2],
  "daysOfWeek":[1,2,3,4,5,6],
  "deviceIdType":[1],
  "latLong":false,
  "isDiscoverable": true,
  "audienceSegments":[436],
  "companionAds":false,
  "minAdDuration":0,
  "maxAdDuration":100,
  "vpaidComplianceVersions":[0,1,2],
  "vastVersions":[2,3],
  "channels":[0,1,2,3]
}

Response

Response Body

             
Response Body Parameter
Type
Description
idIntegerID of the newly-created Inventory Unit.

Sample Response

{
    "id": 203,
    "name" : "test",
     "url" : {URI_PREFIX}/inventory/inventoryUnit/203
}

HTTP Response Status Codes

For the list of HTTP http status codes, refer to the HTTP Status Codes section.

Error Codes

                                                                                                                                               
Error code
Description
IU_001_0001
Invalid inventory unit ID
IU_001_0003
Invalid inventory unit name
IU_001_0005
Invalid Inventory Unit type specified
IU_001_0007
Invalid value for 'first party data availability' flag
IU_001_0008
Invalid inventory unit description
IU_001_0018
Inventory Unit name cannot be null or empty
IU_001_0019
Inventory Unit name cannot exceed 256 characters
IU_001_0020
Invalid value for Hash-tags
IU_001_0021
Hash-tags value cannot exceed 512 characters.
IU_001_0022
Invalid Hash-tags. Hash-tags should be comma separated alphanumeric characters only
IU_001_0024
Selected AdTags are invalid
IU_001_0026
Selected sites are invalid
IU_001_0027
Invalid Audience Segments selected
IU_001_0028
Invalid Geos selected
IU_001_0032
End time parting cannot be before start time parting
IU_001_0034
Invalid Browser ids passed.
IU_001_0035
Invalid Mobile OS ids passed
IU_001_0036
Invalid Platform ids passed
IU_001_0037
Invalid Vertical ids passed
IU_001_0038
Invalid Ad Size ids passed
IU_001_0039
Invalid Fold Placement ids passed
IU_001_0040
Invalid Connection type ids passed
IU_001_0041
Invalid Mobile Device Type ids passed
IU_001_0042
Invalid Mobile Carrier ids passed
IU_001_0043
Invalid Phone Type ids passed
IU_001_0044
Invalid Video Playback Method ids passed
IU_001_0046
Invalid Rich Media Technology ids passed
IU_001_0047
Invalid Mobile OS type ids passed
IU_001_0048
Invalid Geo ids passed
IU_001_0049
Invalid Mobile Device ids passed
IU_001_0050
Invalid Video Type ids passed
IU_001_0051
Invalid Publisher section ids passed
IU_001_0053
Unable to filter adtags
IU_001_0054
No AdTags found for the matching filters

Sample error response


[
    {
        "errorCode": "IU01_0010",
        "errorMessage": "Invalid value for field XYZ"
    },
    {
        "errorCode": "IU01_0012",
        "errorMessage": "Invalid value for field ABC"
    }
]

 

 

Retrieving List of Inventory Units

Overview

This API allows you to retrieve the list of Inventory Units present in the PubMatic system matching supplied filter parameters.

Request

         

URI
$URI_PREFIX/inventoryUnits
HTTP Method
GET

Request Headers

                 

Header Name
Type
Value
Required
Description
Authorization
String
Bearer ${access_token}
Yes
Need to send the access token generating for authentication at the place of ${access_token}.
For more information about access tokens, refer to Getting Started with PubMatic APIs

Request Query Parameters

                                      

Parameter Name
Type
Required
Validations
Description
pageSize
Integer
No
 
Maximum number of rows to be included in the response.
Default value: 25
pageNumber
Integer
No
 
Page number to be fetched in case of multiple pages.
Default value: 1
filters
String
No
Values must be from those mentioned below in the supported Dimensions section.
Filters that restrict the data returned for your request.
For more details, refer the Reporting and Listing API Request Details section.
sort
String
No
Values must be from those mentioned below in the supported Dimensions section.
A list of comma-separated dimensions indicating the sorting order and sorting direction for the returned data.
For more details, refer the Reporting and Listing API Request Details section.

 

Note: For more details on the filter and sort parameters, refer the Reporting and Listing API Request Details section.

Dimension

Note: For more details about the reference data, refer the Reference Data section.                                                                                                                                                                                                                                                                                                                                                                                                                                        

Name
Data Type
Summary
Sample Filter Data
name
String
Name of the Inventory Unit.
name like test
description
String
Description of the Inventory Unit.
description like test
Type.id
Integer
ID of the type of the Inventory Unit.
Type.id eq 1
Type.name
String
Name of the Inventory Unit type.
Type.name like test
OriginatorType.id
Integer
ID of the originator of the Inventory Unit,
OriginatorType.id eq 1
OriginatorType.name
String
Name of the originator of the Inventory Unit.
OriginatorType.name like test
hashTags
String
Hash tags associated with the Inventory Unit.
hashTags like test
platform.id
Integer
ID of the platform associated with the Inventory Unit.
platform.id eq 1
platform.name
String
Name of the platform associated with the Inventory Unit.
platform.name like test
vertical.id
Integer
ID of the vertical associated with the Inventory Unit.
vertical.id eq 1
vertical.name
String
Name of the vertical associated with the Inventory Unit.
vertical.name like test
size.id
Integer
ID of the ad size associated with the Inventory Unit.
size.id eq 1
size.name
String
Name of the ad size associated with the Inventory Unit.
size.name like test
adFoldPlacement.id
Integer
ID of the ad fold placement associated with the Inventory Unit.
adFoldPlacement.id eq 1
adFoldPlacement.name
String
Name of the ad fold placement associated with the Inventory Unit.
adFoldPlacement.name like test
adTagType.id
Integer
ID of the ad tag type associated with the Inventory Unit.
adTagType.id eq 1
adTagType.name
String
Name of the ad tag type associated with the Inventory Unit.
adTagType.name like test
siteGroupInclusion.id
Integer
ID of the site group to be included in the Inventory Unit.
siteGroupInclusion.id eq 1
siteGroupInclusion.name
String
Name of the site group to be included in the Inventory Unit.
siteGroupInclusion.name like test
siteGroupExclusion.id
Integer
ID of the site group to be excluded from the Inventory Unit.
siteGroupExclusion.id eq 1
siteGroupExclusion.name
String
Name of the site group to be excluded from the Inventory Unit.
siteGroupExclusion.name like test
siteURLFreeFormExclusion
String
Free form site URL to be excluded from the Inventory Unit.
siteURLFreeFormExclusion like test
siteURLFreeFormInclusion
String
Free form site URL to be included in the Inventory Unit.
siteURLFreeFormInclusion like test
publisher.id
Integer
ID of the publisher associated with the Inventory Unit.
publisher.id eq 1
publisher.name
String
Name of the publisher associated with the Inventory Unit.
publisher.name like test
site.id
Integer
ID of the site associated with the Inventory Unit.
site.id eq 1
site.name
String
Name of the site associated with the Inventory Unit.
site.name like test
adTag.id
Integer
ID of the ad tag associated with the Inventory Unit.
adTag.id eq 1
adTag.name
String
Name of the ad Tag associated with the Inventory Unit.
adTag.name like test
section.id
Integer
ID of the site section associated with the Inventory Unit.
section.id eq 1
section.name
String
Name of the site section associated with the Inventory Unit.
section.name like test
country.id
Integer
ID of the country associated with the Inventory Unit.
country.id eq 1
country.name
String
Name of the country associated with the Inventory Unit.
country.name like test
region.id
Integer
ID of the region associated with the Inventory Unit.
region.id eq 1
region.name
String
Name of the region associated with the Inventory Unit.
region.name like test
city.id
Integer
ID of the city associated with the Inventory Unit.
city.id eq 1
city.name
String
Name of the city associated with the Inventory Unit.
city.name like test
dma.id
Integer
ID of the DMA associated with the Inventory Unit.
dma.id eq 1
dma.name
String
Name of the DMA associated with the Inventory Unit.
dma.name like test
zip.id
Integer
ID of the zip code associated with the Inventory Unit.
zip.id eq 1
zip.name
String
Zip code associated with the Inventory Unit.
zip.name like test
fpDataAvailability
Boolean
Indicates whether first party data is available in the Inventory Unit or not.
fpDataAvailability eq true
fpDataDescription
String
Description of the first party data associated with the Inventory Unit.
fpDataDescription like test
segment.id
Integer
ID of the audience segment associated with the Inventory Unit.
segment.id eq 1
segment.name
String
Name of the audience segment associated with the Inventory Unit.
segment.name like test
daysOfWeek
Integer
ID of the day of the week on which the Inventory Unit is applicable.
daysOfWeek eq 1
browser.id
Integer
ID of the browser associated with the Inventory Unit.
browser.id eq 1
browser.name
String
Name of the browser associated with the Inventory Unit.
browser.name like test
connectionType.id
Integer
ID of the connection type associated with the Inventory Unit.
connectionType.id eq 1
connectionType.name
String
Name of the connection type associated with the Inventory Unit.
connectionType.name like test
osType.id
Integer
ID of the mobile OS type associated with the Inventory Unit.
osType.id eq 1
osType.name
String
Name of the mobile OS type associated with the Inventory Unit.
osType.name like test
os.id
Integer
ID of the mobile OS associated with the Inventory Unit.
os.id eq 1
os.name
String
Name of the mobile OS associated with the Inventory Unit.
os.name like test
deviceType.id
Integer
ID of the mobile device’s type associated with the Inventory Unit.
deviceType.id eq 1
deviceType.name
String
Name of the mobile device’s type associated with the Inventory Unit.
deviceType.name like test
device.id
Integer
ID of the mobile device associated with the Inventory Unit.
device.id eq 1
device.name
String
Name of the mobile device associated with the Inventory Unit.
device.name like test
carrier.id
Integer
ID of the mobile carrier associated with the Inventory Unit.
carrier.id eq 1
carrier.name
String
Name of the mobile carrier associated with the Inventory Unit.
carrier.name like test
latLong
Boolean
Indicates whether latitude-longitude targeting is enabled in the Inventory Unit or not.
latLong eq true
deviceIdType.id
Integer
ID of the device ID type associated with the Inventory Unit.
deviceIdType.id eq 1
deviceIdType.name
String
Name of the device Id type associated with the Inventory Unit.
deviceIdType.name like test
phoneCapability.id
Integer
ID of the phone capability type associated with the Inventory Unit.
phoneCapability.id eq 1
phoneCapability.name
String
Name of the phone capability type associated with the Inventory Unit.
phoneCapability.name like test
pointingSupport.id
Integer
ID of the pointing support type associated with the Inventory Unit.
pointingSupport.id eq 1
pointingSupport.name
String
Name of the pointing support associated with the Inventory Unit.
pointingSupport.name like test
isDiscoverable
Boolean
Indicates whether the Inventory Unit can be discovered by others or not.
isDiscoverable eq true
videoAdType.id
Integer
ID of the video ad type associated with the Inventory Unit.
videoAdType.id eq 1
videoAdType.name
String
Name of the video ad type associated with the Inventory Unit.
videoAdType.name like test
videoAdPosition.id
Integer
ID of the video ad position associated with the Inventory Unit.
videoAdPosition.id eq 1
videoAdPosition.name
String
Name of the video ad position associated with the Inventory Unit.
videoAdPosition.name like test
videoPlayback.id
Integer
ID of the video ad playback type associated with the Inventory Unit.
videoPlayback.id eq 1
videoPlayback.name
String
Name of the video ad playback type associated with the Inventory Unit.
videoPlayback.name like test
richMediaTechnology.id
Integer
ID of the rich media vendor associated with the Inventory Unit.
richMediaTechnology.id eq 1
richMediaTechnology.name
String
Name of the rich media vendor associated with the Inventory Unit.
richMediaTechnology.name like test

Sample Request

 

GET {uri-prefix}/inventoryUnits?pageSize=25&pageNumber=1&filters=name like test

Response

Response Body

                  

Response Body Parameter
Type
Description
metaData
JSON Object 
Metadata about the response generated.
items
JSON Array of record object
Records generated as per your request.

Sample Response

{
"metaData": {
      "startIndex": 1,
       "totalRecords": 1,
      "endIndex": 1
},
"items": [
{
    "id" : 1,
    "name": "test name",
    "description": "test description",
    "type": {
        "id": 1,
        "name": "PubMatic"
    },
    "originatorType": {
        "id": 1,
        "name": "Publisher"
    },
    "originatorId": 123,
    "logo": "logo-url",
    "createdBy": {
        "id": 1,
        "name": "PubMatic"
    },
    "hashTags": [
        "test hash tag 1",
        "test hash tag 2"
    ],
    "platforms": [
        { "id" : 1,
          "name" : "Web"
        },
        { "id" : 2,
          "name" : "Mobile Web"
        }
    ],
    "verticals": [
        { "id" : 2,
          "name" : "Automotive"
        },
        { "id" : 12,
          "name" : "Gaming"
        }
    ],
    "sizes": [
        { "id" : 68,
          "name" : "Megaboard"
        },
        { "id" : 62,
          "name" : "200x600"
        }
    ],
    "foldPlacements": [
        { "id" : 1,
          "name" : "Above the Fold"
        },
        { "id" : 2,
          "name" : "Below the Fold"
        }
    ],
    "adTagTypes": [
        { "id" : 1,
          "name" : "Video"
        },
        { "id" : 2,
          "name" : "IFrame"
        }
    ],
    "siteGroupInclusions": [
        { "id" : 1,
          "name" : "pub MediaVine pub ID 32299",
          "url", "$URI_PREFIX/siteGroups/1"
        },
        { "id" : 2,
          "name" : "pub JFGames pub id 41032",
          "url", "$URI_PREFIX/siteGroups/2"
        }
    ],
    "siteGroupExclusions": [
        { "id" : 3,
          "name" : "pub Filmon pub id 43568",
          "url", "$URI_PREFIX/siteGroups/3"
        },
        { "id" : 4,
          "name" : "Pub Futbol Interior 43730",
          "url", "$URI_PREFIX/siteGroups/4"
        }
      ],
    "publisher": {
            "id" : 123,
            "name" : "test publisher 123",
            "url" : $URI_PREFIX/publishers/123
   },
    "sites": [
        { "id" : 28747,
          "name" : "www.test.com/28747",
          "url", "$URI_PREFIX/sites/28747"
        },
        { "id" : 28748,
          "name" : "www.test.com/28748",
          "url", "$URI_PREFIX/sites/28748"
        }
    ],
    "adTags": [
        { "id" : 4,
          "name" : "Bottom Banner",
          "url", "$URI_PREFIX/adTags/4"
        },
        { "id" : 5,
          "name" : "Top Leaderboard",
          "url", "$URI_PREFIX/adTags/5"
        }
    ],
    "siteSections": [
        { "id" : 867,
          "name" : "Boats",
          "url", "$URI_PREFIX/sections/867"
        },
        { "id" : 882,
          "name" : "Travel",
          "url", "$URI_PREFIX/sections/882"
        }
    ],
    "countries": [
        { "id" : 867,
          "name" : "US",
        },
        { "id" : 882,
          "name" : "Canada",
        }
    ],
    "cities": [
        { "id" : 867,
          "name" : "NY",
        },
        { "id" : 882,
          "name" : "Bostan",
        }
    ],
    "regions": [
        { "id" : 867,
          "name" : "R1",
        },
        { "id" : 882,
          "name" : "S6",
        }
    ],
    "dmas": [
        { "id" : 867,
          "name" : "602",
        },
        { "id" : 882,
          "name" : "574",
        }
    ],
    "zips": [
        { "id" : 867,
          "name" : "12345",
        },
        { "id" : 882,
          "name" : "12346",
        }
    ],
    "isFirstPartyDataAvailable": true,
    "firstPartyDataDescription": "test first party data description",
    "daysOfWeek": [
        { "id" : 1,
          "name" : "Monday",
        },
        { "id" : 2,
          "name" : "Tuesday",
        }
    ],
    "startTimeParting": "2:00:00",
    "endTimeParting": "19:00:00",
    "browsers": [
        { "id" : 1,
          "name" : "IE",
        },
        { "id" : 2,
          "name" : "Firefox",
        }
    ],
    "connectionTypes": [
        { "id" : 2,
          "name" : "Cellular",
        },
        { "id" : 3,
          "name" : "Corporate",
        }
    ],
    "osTypes": [
        { "id" : 1,
          "name" : "iOS",
        },
        { "id" : 2,
          "name" : "Android",
        }
    ],
    "os": [
        { "id" : 445,
          "name" : "Android 2",
          "url", "$URI_PREFIX/os/445"
        },
        { "id" : 399,
          "name" : "iOS 3",
          "url", "$URI_PREFIX/os/399"
        }
    ],
    "deviceTypes": [
        { "id" : 1,
          "name" : "Feature Phone",
        },
        { "id" : 2,
          "name" : "Smart Phone",
        }
    ],
    "devices": [
        { "id" : 445,
          "name" : "Motorola Droid",
          "url", "$URI_PREFIX/devices/445"
        },
        { "id" : 399,
          "name" : "LG Escape",
          "url", "$URI_PREFIX/devices/399"
        }
    ],
    "carriers": [
        { "id" : 867,
          "name" : "AT&T US",
          "url", "$URI_PREFIX/carriers/867"
        },
        { "id" : 882,
          "name" : "Vodafone",
          "url", "$URI_PREFIX/carriers/882"
        }
    ],
    "latLong": false,
    "deviceIdType": [
        1
    ],
    "phoneCapabilities": [
        { "id" : 1,
          "name" : "Feature Phone",
        },
        { "id" : 2,
          "name" : "Smart Phone",
        }
    ],
    "PointingSupports": [
        { "id" : 1,
          "name" : "test1",
        },
        { "id" : 2,
          "name" : "test2",
        }
    ],
    "isDiscoverable": true,
    "richMediaTechnologyies": [
        { "id" : 1,
          "name" : "Pointroll",
        },
        { "id" : 2,
          "name" : "Eyeblaster",
        }
    ],
    "videoAdTypes": [
       { "id" : 1,
          "name" : "Linear",
        },
        { "id" : 2,
          "name" : "Non-Linear",
        }
    ],
    "videoAdPositions": [
       { "id" : 1,
          "name" : "Pre-roll",
        },
        { "id" : 2,
          "name" : "In-roll",
        }
    ],
    "videoPlaybacks": [
       { "id" : 3,
          "name" : "Click-to-play",
        },
        { "id" : 4,
          "name" : "Mouse-over",
        }
    ]
},
{
    "id" : 2,
    "name": "test name",
    "description": "test description",
    "type": {
        "id": 1,
        "name": "PubMatic"
    },
    "originatorType": {
        "id": 1,
        "name": "Publisher"
    },
    "originatorId": 123,
    "logo": "logo-url",
    "createdBy": {
        "id": 1,
        "name": "PubMatic"
    },
    "hashTags": [
        "test hash tag 1",
        "test hash tag 2"
    ],
    "platforms": [
        { "id" : 1,
          "name" : "Web"
        },
        { "id" : 2,
          "name" : "Mobile Web"
        }
    ],
     "verticals": [
        { "id" : 2,
          "name" : "Automotive"
        },
        { "id" : 12,
          "name" : "Gaming"
        }
    ],
    "sizes": [
        { "id" : 68,
          "name" : "Megaboard"
        },
        { "id" : 62,
          "name" : "200x600"
        }
    ],
    "foldPlacements": [
        { "id" : 1,
          "name" : "Above the Fold"
        },
        { "id" : 2,
          "name" : "Below the Fold"
        }
    ],
    "adTagTypes": [
        { "id" : 1,
          "name" : "Video"
        },
        { "id" : 2,
          "name" : "IFrame"
        }
    ],
    "siteGroupInclusions": [
        { "id" : 1,
          "name" : "pub MediaVine pub ID 32299",
          "url", "$URI_PREFIX/siteGroups/1"
        },
        { "id" : 2,
          "name" : "pub JFGames pub id 41032",
          "url", "$URI_PREFIX/siteGroups/2"
        }
    ],
    "siteGroupExclusions": [
        { "id" : 3,
          "name" : "pub Filmon pub id 43568",
          "url", "$URI_PREFIX/siteGroups/3"
        },
        { "id" : 4,
          "name" : "Pub Futbol Interior 43730",
          "url", "$URI_PREFIX/siteGroups/4"
        }
      ],    "siteURLFreeFormInclusions": [
        "www.test1.com",
        "www.test2.com"
    ],
    "siteURLFreeFormExclusions": [
        "www.test3.com",
        "www.test4.com"
    ],
    "publisher": {
           "id" : 124,
            "name" : "test publisher 124",
            "url" : "$URI_PREFIX/publishers/124"
    },
    "sites": [
        { "id" : 28747,
          "name" : "www.test.com/28747",
          "url", "$URI_PREFIX/sites/28747"
        },
        { "id" : 28748,
          "name" : "www.test.com/28748",
          "url", "$URI_PREFIX/sites/28748"
        }
    ],
    "adTags": [
        { "id" : 4,
          "name" : "Bottom Banner",
          "url", "$URI_PREFIX/adTags/4"
        },
        { "id" : 5,
          "name" : "Top Leaderboard",
          "url", "$URI_PREFIX/adTags/5"
        }
    ],
    "siteSections": [
        { "id" : 867,
          "name" : "Boats",
          "url", "$URI_PREFIX/sections/867"
        },
        { "id" : 882,
          "name" : "Travel",
          "url", "$URI_PREFIX/sections/882"
        }
    ],
    "countries": [
        { "id" : 867,
          "name" : "US",
        },
        { "id" : 882,
          "name" : "Canada",
        }
    ],
    "cities": [
        { "id" : 867,
          "name" : "NY",
        },
        { "id" : 882,
          "name" : "Bostan",
        }
    ],
    "regions": [
        { "id" : 867,
          "name" : "R1",
        },
        { "id" : 882,
          "name" : "S6",
        }
    ],
    "dmas": [
        { "id" : 867,
          "name" : "602",
        },
        { "id" : 882,
          "name" : "574",
        }
    ],
    "zips": [
        { "id" : 867,
          "name" : "12345",
        },
        { "id" : 882,
          "name" : "12346",
        }
    ],
    "isFirstPartyDataAvailable": true,
    "firstPartyDataDescription": "test first party data description",
    "daysOfWeek": [
        { "id" : 1,
          "name" : "Monday",
        },
        { "id" : 2,
          "name" : "Tuesday",
        }
    ],
    "startTimeParting": "2:00:00",
    "endTimeParting": "19:00:00",
    "browsers": [
        { "id" : 1,
          "name" : "IE",
        },
        { "id" : 2,
          "name" : "Firefox",
        }
    ],
    "connectionTypes": [
        { "id" : 2,
          "name" : "Cellular",
        },
        { "id" : 3,
          "name" : "Corporate",
        }
    ],
    "osTypes": [
        { "id" : 1,
          "name" : "iOS",
        },
        { "id" : 2,
          "name" : "Android",
        }
    ],
    "os": [
        { "id" : 445,
          "name" : "Android 2",
          "url", "$URI_PREFIX/os/445"
        },
        { "id" : 399,
          "name" : "iOS 3",
          "url", "$URI_PREFIX/os/399"
        }
    ],
    "deviceTypes": [
        { "id" : 1,
          "name" : "Feature Phone",
        },
        { "id" : 2,
          "name" : "Smart Phone",
        }
    ],
    "devices": [
        { "id" : 445,
          "name" : "Motorola Droid",
          "url", "$URI_PREFIX/devices/445"
        },
        { "id" : 399,
          "name" : "LG Escape",
          "url", "$URI_PREFIX/devices/399"
        }
    ],
    "carriers": [
        { "id" : 867,
          "name" : "AT&T US",
          "url", "$URI_PREFIX/carriers/867"
        },
        { "id" : 882,
          "name" : "Vodafone",
          "url", "$URI_PREFIX/carriers/882"
        }
    ],
    "latLong": false,
    "deviceIdType": [
        1
    ],
    "phoneCapabilities": [
        { "id" : 1,
          "name" : "Feature Phone",
        },
        { "id" : 2,
          "name" : "Smart Phone",
        }
    ],
    "PointingSupports": [
        { "id" : 1,
          "name" : "test1",
        },
        { "id" : 2,
          "name" : "test2",
        }
    ],
    "isDiscoverable": true,
    "richMediaTechnologies": [
       { "id" : 1,
          "name" : "Pointroll",
        },
        { "id" : 2,
          "name" : "Eyeblaster",
        }
    ],
    "videoAdTypes": [
       { "id" : 1,
          "name" : "Linear",
        },
        { "id" : 2,
          "name" : "Non-Linear",
        }
    ],
    "videoAdPositions": [
       { "id" : 1,
          "name" : "Pre-roll",
        },
        { "id" : 2,
          "name" : "In-roll",
        }
    ],
    "videoPlaybacks": [
       { "id" : 3,
          "name" : "Click-to-play",
        },
        { "id" : 4,
          "name" : "Mouse-over",
        }
    ]
}
]
}
HTTP Response Status Codes

 

For the list of HTTP http status codes, refer to the HTTP Status Codes section.

Error Codes

               

Error code
Description
IU_001_0001
Invalid inventory unit ID
IU_001_0003
Invalid inventory unit name

Sample error response

[
    {
        "errorCode": "IU01_0001",
        "errorMessage": "Invalid input XYZ"
    },
    {
        "errorCode": "IU01_0002",
        "errorMessage": "Invalid input ABC"
    }
]

 

 

Retrieving Details of an Inventory Unit

Overview

This API allows you to retrieve the details of a specific Inventory Unit from the PubMatic system using the “id” parameter.

Request

         

URI
$URI_PREFIX/inventoryUnits/{id}
HTTP Method
GET

Request Headers

                 

Header Name
Type
Value
Required
Description
Authorization
String
Bearer ${access_token}
Yes
Need to send the access token generating for authentication at the place of ${access_token}.
For more information about access tokens, refer to Getting Started with PubMatic APIs.

 

Path Parameters

                 

Parameter Name

Type

Required

Description

Sample Data

id

Long

Yes

ID of the Inventory Unit whose details need to be fetched.

 123

Sample Request


GET {uri-prefix}/inventoryUnits/123

Response

Response Body

Note: For more details about the reference data, refer the Reference Data section.

           

Type
Description
JSON for record object
Details of the Inventory Unit.

Sample Response:

 {
  "id": 123,
  "name": "test name",
  "description": "test description",
  "type": {
    "id": 1,
    "name": "PubMatic"
  },
  "originatorType": {
    "id": 1,
    "name": "Publisher"
  },
  "originatorId": 123,

  "publisher" : {

       "id" : 123,

       "name" : "test pub",

       "url": "$URI_PREFIX/publishers/123"

  },
  "logo": "logo-url",
  "createdBy": {
    "id": 1,
    "name": "PubMatic"
  },
  "hashTags": "test hash tag 1,test hash tag 2",
  "platforms": [
    {
      "id": 1,
      "name": "Web"
    },
    {
      "id": 2,
      "name": "Mobile Web"
    }
  ],
  "verticals": [
    {
      "id": 2,
      "name": "Automotive"
    },
    {
      "id": 12,
      "name": "Gaming"
    }
  ],
  "sizes": [
    {
      "id": 68,
      "name": "Megaboard"
    },
    {
      "id": 62,
      "name": "200x600"
    }
  ],
  "foldPlacements": [
    {
      "id": 1,
      "name": "Above the Fold"
    },
    {
      "id": 2,
      "name": "Below the Fold"
    }
  ],
  "adTagTypes": [
    {
      "id": 1,
      "name": "Video"
    },
    {
      "id": 2,
      "name": "IFrame"
    }
  ],
  "siteGroupInclusions": [
    {
      "id": 1,
      "name": "pub MediaVine pub ID 32299",
      "url": "$URI_PREFIX/siteGroups/1"
    },
    {
      "id": 2,
      "name": "pub JFGames pub id 41032",
      "url": "$URI_PREFIX/siteGroups/2"
    }
  ],
  "siteGroupExclusions": [
    {
      "id": 3,
      "name": "pub Filmon pub id 43568",
      "url": "$URI_PREFIX/siteGroups/3"
    },
    {
      "id": 4,
      "name": "Pub Futbol Interior 43730",
      "url": "$URI_PREFIX/siteGroups/4"
    }
  ],
  "publishers": [
    {
      "id": 31445,
      "name": "eBay, Inc.",
      "uri": "$URI_PREFIX/publisher/1"
    }
  ],
  "sites": [
    {
      "id": 28747,
      "name": "www.test.com/28747",
      "url": "$URI_PREFIX/sites/28747"
    },
    {
      "id": 28748,
      "name": "www.test.com/28748",
      "url": "$URI_PREFIX/sites/28748"
    }
  ],
  "adTags": [
    {
      "id": 4,
      "name": "Bottom Banner",
      "url": "$URI_PREFIX/adTags/4"
    },
    {
      "id": 5,
      "name": "Top Leaderboard",
      "url": "$URI_PREFIX/adTags/5"
    }
  ],
  "siteSections": [
    {
      "id": 867,
      "name": "Boats",
      "url": "$URI_PREFIX/sections/867"
    },
    {
      "id": 882,
      "name": "Travel",
      "url": "$URI_PREFIX/sections/882"
    }
  ],
  "geos": [
    {
      "id": 1,
      "name": "United Arab Emirates",
      "uri": "$URI_PREFIX/Geo/1"
    },
    {
      "id": 2,
      "name": "Pretoria",
      "uri": "$URI_PREFIX/Geo/2"
    },
    {
      "id": 3,
      "name": "Boston",
      "uri": "$URI_PREFIX/Geo/3"
    },
    {
      "id": 4,
      "name": "Puerto Rico",
      "uri": "$URI_PREFIX/Geo/4"
    }
  ],
  "isFirstPartyDataAvailable": true,
  "firstPartyDataDescription": "test first party data description",
  "daysOfWeek": [
    {
      "id": 1,
      "name": "Monday"
    },
    {
      "id": 2,
      "name": "Tuesday"
    }
  ],
  "startTimeParting": "2:00:00",
  "endTimeParting": "19:00:00",
  "browsers": [
    {
      "id": 1,
      "name": "IE"
    },
    {
      "id": 2,
      "name": "Firefox"
    }
  ],
  "connectionTypes": [
    {
      "id": 2,
      "name": "Cellular"
    },
    {
      "id": 3,
      "name": "Corporate"
    }
  ],
  "osTypes": [
    {
      "id": 1,
      "name": "iOS"
    },
    {
      "id": 2,
      "name": "Android"
    }
  ],
  "os": [
    {
      "id": 445,
      "name": "Android 2",
      "url": "$URI_PREFIX/os/445"
    },
    {
      "id": 399,
      "name": "iOS 3",
      "url": "$URI_PREFIX/os/399"
    }
  ],
  "deviceTypes": [
    {
      "id": 1,
      "name": "Feature Phone"
    },
    {
      "id": 2,
      "name": "Smart Phone"
    }
  ],
  "devices": [
    {
      "id": 445,
      "name": "Motorola Droid",
      "url": "$URI_PREFIX/devices/445"
    },
    {
      "id": 399,
      "name": "LG Escape",
      "url": "$URI_PREFIX/devices/399"
    }
  ],
  "carriers": [
    {
      "id": 867,
      "name": "AT&T US",
      "url": "$URI_PREFIX/carriers/867"
    },
    {
      "id": 882,
      "name": "Vodafone",
      "url": "$URI_PREFIX/carriers/882"
    }
  ],
  "latLong": false,
  "deviceIdType": [
    1
  ],
  "phoneCapabilities": [
    {
      "id": 1,
      "name": "Feature Phone"
    },
    {
      "id": 2,
      "name": "Smart Phone"
    }
  ],
  "PointingSupports": [
    {
      "id": 1,
      "name": "test1"
    },
    {
      "id": 2,
      "name": "test2"
    }
  ],
  "isDiscoverable": true,
  "richMediaTechnologies": [
    13,
    12
  ],
  "videoAdTypes": [
    {
      "id": 1,
      "name": "Linear"
    },
    {
      "id": 2,
      "name": "Non-Linear"
    }
  ],
  "videoAdPositions": [
    {
      "id": 1,
      "name": "Pre-roll"
    },
    {
      "id": 2,
      "name": "In-roll"
    }
  ],
  "videoPlaybackMethods": [
    {
      "id": 3,
      "name": "Click-to-play"
    },
    {
      "id": 4,
      "name": "Mouse-over"
    }
  ]
}
HTTP Response Status Codes

 

For the list of HTTP http status codes, refer to the HTTP Status Codes section.

Error Codes

           

Error code
Description
IU_001_0001
Invalid inventory unit ID

Sample error response


[
    {
        "errorCode": "IU01_0010",
        "errorMessage": "Invalid value for path parameter id"
    }
]

 

 

Updating an Inventory Unit

Overview

This API allows you to update the details of an existing Inventory Unit in the PubMatic system using the specified "id" parameter.

Request

         
URI$URI_PREFIX/inventoryUnits/{id}
HTTP MethodPUT

Request Headers

                 

Header Name
Type
Value
Required
Description
Authorization
String
Bearer ${access_token}
Yes
Need to send the access token generating for authentication at the place of ${access_token}.
For more information about access tokens, refer to Getting Started with PubMatic APIs

Path Parameters

                 
Parameter Name
Type
Required
Description
Sample Data
idLongYesID of the Inventory Unit whose details need to be modified. 123

Request Body

Note: For more details about the reference data, refer the Reference Data section.

 

Body Parameter
Type
Required
Validations
Description
name
String
Yes
 
Name of the given Inventory Unit.
description
String
No
 
Description of the given Inventory Unit.
type
Integer
Yes
 
Type of the given Inventory Unit.
For example, PubMatic or Cross Exchange.
hashTags
JSON Array of String
No
 
Keywords/tags for the given Inventory Unit which will be used in searching,
platforms
JSON Array of Integer
No
 
Platforms on which the given Inventory Unit can be used.
For example, Web, Mobile Web, etc.
verticals
JSON Array of Integer
No
 
Verticals to which the given Inventory Unit belongs.
For example, Automotive, Education, etc.
publisher
Integer
Yes
 
Publisher associated with the given Inventory Unit.
sites
JSON Array of Integer
At least 1 site or ad tag should be selected (Currently, creating an Inventory Unit for all sites and all ad tags is not supported.)
 
Sites associated with the given Inventory Unit.
adTags
JSON Array of Integer
At least 1 site or ad tag should be selected (Currently, creating an Inventory Unit for all sites and all ad tags is not supported.)
 
Ad tags associated with the given Inventory Unit.
siteSections
JSON Array of Integer
No
 
Site sections associated with the given Inventory Unit.
geos
JSON Array of Integer
No
 
Geos associated with the given Inventory Unit.
For example, US, Canada, New York, etc.
daysOfWeek
JSON Array of Integer
No
 
Days of the week associated with the given Inventory Unit.
startTimeParting
Timestamp
No
HH:MM:SS
Start Time after which the given Inventory Unit is applicable.
endTimeParting
Timestamp
No
HH:MM:SS
End Time till which the given Inventory Unit is applicable.
browsers
JSON Array of Integer
No
 
Browsers that can be targeted using the given Inventory Unit.
For example, IE, Firefox, etc.
connectionTypes
JSON Array of Integer
No
 
Connection types associated with the given Inventory Unit.
For example, Cellular, Dialup, etc.
osTypes
JSON Array of Integer
No
 
Types of mobile devices' OSs associated with the given Inventory Unit.
For example, iOS, Android, etc.
os
JSON Array of Integer
No
 
OS associated with the given Inventory Unit.
deviceTypes
JSON Array of Integer
No
 
Device types associated with the given Inventory Unit.
For example, Smartphone, Tablet, etc.
devices
JSON Array of Integer
No
 
Devices associated with the given Inventory Unit.
carriers
JSON Array of Integer
No
 
Mobile Carriers associated with the given Inventory Unit.
latLong
Boolean
No
 
Indicates whether latitude-longitude targeting is enabled in the given Inventory Unit or not.
deviceIdType
Integer
No
 
Device ID type associated with the given Inventory Unit
isDiscoverable
Boolean
No
 
Indicates whether the given Inventory Unit can be discovered by others or not.
richMediaTechnologies
JSON Array of Integer
No
 
Rich media vendors associated with the given Inventory Unit.
For example, Pointroll, Eyeblaster, etc.
videoAdTypes
JSON Array of Integer
No
 
Video ad types associated with the given Inventory Unit.
For example, Linear, Non-Linear, etc.
videoAdPositions
JSON Array of Integer
No
 
Video ad positions associated with the given Inventory Unit.
For example, Pre-roll, Post-roll, etc.
videoPlaybacks
JSON Array of Integer
No
 
Video playback types associated with the given Inventory Unit.
For example, "Auto-play sound on", "Click-to-play", etc.
companionAds
 
Boolean
No
 
Indicates whether companion ads support is enabled for the given Inventory Unit or not.
This parameter is used as a filter for video ad tags.
minAdDuration
Integer
No
 
Minimum duration of a video ad associated with the given Inventory Unit.
This parameter is used as a filter for video ad tags.
maxAdDuration
Integer
No
 
Maximum duration of a video ad associated with the given Inventory Unit.
This parameter is used as a filter for video ad tags.
vpaidComplianceVersions
JSON Array of Integer
No
 
VPAID versions associated with the given Inventory Unit.
Possible values are:
  • 0 - NO VPAID
  • 1 - VPAID 1.0
  • 2 - VPAID 2.0
This parameter is used as a filter for video ad tags.
vastVersions
JSON Array of Integer
No
 
VAST versions associated with the given Inventory Unit.
Possible values are:
  • 2 - VAST 2.0
  • 3 - VAST 3.0
This parameter is used as a filter for video ad tags.
channels
JSON Array of Integer
No
 
Ad format type associated with the given Inventory Unit.
Possible values are:
  • 0 - IFrame
  • 1 - JavaScript
  • 2 - Mobile AdTag
  • 3 - Video

Sample Request


PUT {uri-prefix}/inventoryUnit/123
{
  "name" : "test name 24thmay - 1",
  "description" : "test description 26thmay - 1",
  "hashTags":"test123,newhashtag",
  "startTimeParting": "00:00:00",
  "endTimeParting": "08:00:00",
  "isFirstPartyDataAvailable" : false,
  "firstPartyDataDescription" : "test first party data description 26thmay 1",
  "sites" : [1],
  "browsers":[1],
  "platforms":[1,2,3,4,5],
  "siteSections":[1,2],
  "os":[80,81],
  "connectionTypes":[4],
  "devices":[97,552],
  "carriers":[309],
  "adTags" :[2,3,4],
  "geos":[48,349,162823,162803,155852],
  "richMediaTechnologies":[5],
  "videoAdTypes":[1],
  "videoAdPositions":[2],
  "videoPlaybackMethods":[3],
  "osTypes":[3,7],
  "deviceTypes":[2],
  "daysOfWeek":[1,2,3,4,5,6],
  "deviceIdType":[1],
  "latLong":false,
  "isDiscoverable": true,
  "audienceSegments":[436],
  "companionAds":false,
  "minAdDuration":0,
  "maxAdDuration":100,
  "vpaidComplianceVersions":[0,1,2],
  "vastVersions":[2,3],
  "channels":[0,1,2,3]
}

Response

Response Body

             
Response Body Parameter
Type
Description
idIntegerID of the updated Inventory Unit.

Sample Response


{
    "id": 203,
    "name" : "test iu",
    "url" : ${URI_PREFIX}/inventory/inventoryUnit/203
}

 

HTTP Response Status Codes

For the list of HTTP http status codes, refer to the HTTP Status Codes section.

Error Codes

                                                                                                                                               
Error code
Description
IU_001_0001
Invalid inventory unit ID
IU_001_0003Invalid inventory unit name
IU_001_0005Invalid Inventory Unit type specified
IU_001_0007Invalid value for 'first party data availability' flag
IU_001_0008Invalid inventory unit description
IU_001_0018Inventory Unit name cannot be null or empty
IU_001_0019Inventory Unit name cannot exceed 256 characters
IU_001_0020Invalid value for Hash-tags
IU_001_0021Hash-tags value cannot exceed 512 characters.
IU_001_0022Invalid Hash-tags. Hash-tags should be comma separated alphanumeric characters only
IU_001_0024Selected AdTags are invalid
IU_001_0026Selected sites are invalid
IU_001_0027Invalid Audience Segments selected
IU_001_0028Invalid Geos selected
IU_001_0032End time parting cannot be before start time parting
IU_001_0034Invalid Browser ids passed.
IU_001_0035Invalid Mobile OS ids passed
IU_001_0036Invalid Platform ids passed
IU_001_0037Invalid Vertical ids passed
IU_001_0038Invalid Ad Size ids passed
IU_001_0039Invalid Fold Placement ids passed
IU_001_0040Invalid Connection type ids passed
IU_001_0041Invalid Mobile Device Type ids passed
IU_001_0042Invalid Mobile Carrier ids passed
IU_001_0043Invalid Phone Type ids passed
IU_001_0044Invalid Video Playback Method ids passed
IU_001_0046Invalid Rich Media Technology ids passed
IU_001_0047Invalid Mobile OS type ids passed
IU_001_0048Invalid Geo ids passed
IU_001_0049Invalid Mobile Device ids passed
IU_001_0050Invalid Video Type ids passed
IU_001_0051Invalid Publisher section ids passed
IU_001_0053Unable to filter adtags
IU_001_0054No AdTags found for the matching filters

 

Sample error response


[
    {
        "errorCode": "IU01_0010",
        "errorMessage": "Invalid value for field XYZ"
    },
   {
        "errorCode": "IU01_0012",
        "errorMessage": "Invalid value for field ABC"
    }
]

Reference Data

This section lists the details of the Reference data used for Inventory Units.

Type

             
ID
     Name
1PubMatic
2CrossExchange

OriginatorType / Owner Type

                   
ID
Name
1Publisher
5DSP
7ATD

Ad Fold Placement

                   
ID
Name
1Above the Fold
2Below the Fold
3Partially Above the Fold

Platform

                           
ID
Name
1Web
2Mobile Web
3NotDefined
4Mobile App IOS
5Mobile App Android

AdTag Type

                       
ID
Name
0Iframe
1JavaScript
2Mobile AdTag
3Video

Video AdType

               
ID
Name
1Linear
2Non-Linear

Video AdPosition

                   
ID
Name
1Pre-roll
2In-roll
3Post-roll

Video Playback

                       
ID
Name
1Auto-play sound on
2Auto-play sound off
3Click-to-play
4Mouse-over

Phone Capability

               
ID
Name
1Feature Phone
2Smart Phone

Device Type

                   
ID
Name
1Feature Phone
2Smart Phone
3Tablet

OS Type

                                                   
ID
Name
1iOS
2Android
3Symbian
4BlackBerry OS
5webOS
6Windows Phone
7Maemo
8MeeGo
9bada
10Palm OS
11Undefined

Connection Type

                       
ID
Name
1Cable/DSL
2Cellular
3Corporate
4Dialup

Day Of Week

                                   
ID
Name
1Monday
2Tuesday
3Wednesday
4Thursday
5Friday
6Saturday
7Sunday

Channel / AdFormat

                       
ID
Name
0Iframe
1JavaScript
2Mobile AdTag
3Video

VAST Version

               
ID
Name
2VAST 2.0
3VAST 3.0

VPAID Compliance

                   
ID
Name
0No VPAID support
1VPAID 1.0
2VPAID 2.0

Device ID Type

               
ID
Name
1IDFA
2Android ID

Package Channel Type

                           
IDName
0
ALL
1PMP
2AdFlex
3RTB
4Spot Buys

Geo Level

                       

ID
GeoLevel
1Country
2Region
3City
4DMA

Attachments

    Outcomes