Ad Size API (UAS)

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

Description

Ad Size API allows you to retrieve the various sizes supported by the PubMatic platform.

For more information about UAS Inventory Management Services APIs, refer to Inventory Management Services (UAS) 

Supported Operations

Service Name: /adsizes/

                     

Method PathHTTP Method TypeDescriptionLink to Definition
/adsizes/{id}GETRetrieves the Ad Size details for a requested Id.Retrieve Details of an Ad Size
/adsizes/GET

Retrieves a list of Ad Sizes.

You can apply supported dimensions, filters and sorting options to fetch a list of Ad Sizes with a specific set of details as required.

Retrieve List of Ad Sizes

 

Retrieve Details of an Ad Size

 

Overview

This API will retrieve the details of a specific Ad Size.

Request

           

Request Headers

                        

Header nameType ValueRequiredDescription
Content-TypeStringapplication/jsonYesMedia type for request.
pubTokenString${access_token}Yes

Publisher Token to authenticate and authorize the user calling the Unified Ad Server API. Send the access token generated for authentication at the place of ${access_token} in the request.

 

For more information about access tokens, refer to Getting Started with PubMatic APIs.

Request Sample URL

https://api.pubmatic.com/v1/uas/adsizes/1

 

Response

    

{
    "id": 1,
    "adUnitFormat": {
        "id": 3,
        "name": "Banner/Rich Media",
        "url": "https://api.pubmatic.com/v1/uas/adunitformats/1"
    },
    "name": "Billboard - 970x250",
    "description": "970x250",
    "height": 250,
    "width": 970
}

Retireve a List of Ad Sizes

 

Overview

Retrieve the list of supported Ad Sizes. In the query, you can also apply supported dimensions, filters and sorting options to retrieve a list of Ad Sizes with a specific set of details according to your requirements.

 

Refer to Common Request Query Parameters to learn more about using dimensions, sort and filter options.

Request

           

Request Headers

                        

Header nameType ValueRequiredDescription
Content-TypeStringapplication/jsonYesMedia type for request.
pubTokenString${access_token}Yes

Publisher Token to authenticate and authorize the user calling the Unified Ad Server API. Send the access token generated for authentication at the place of ${access_token} in the request.

 

For more information about access tokens, refer to Getting Started with PubMatic APIs.

Request Sample URL

https://api.pubmatic.com/v1/uas/adsizes/ 

Response

    

This will return a list of supported Ad Sizes.

 

 

Unified Ad Server References

Common Request Query Parameters for Web Services

Supported Operations for Filters

HTTP Status Codes

Unified Ad Server Specific Error Codes

 

 

 

Version 0.1

Attachments

    Outcomes