Creative Type API (UAS)

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

Description

The Creative Type API enables you to retrieve details for different types of creatives supported by the Unified Ad Server.

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

Supported Operations

                     

Method PathHTTP Method TypeDescriptionLink to Definition
/creativetypes/{id}GET

Retrieves the details of a specific creative type for the requested ID.

The Unified Ad Server supports the following Creative Types:

                                       
IDCreative Type
1Reserved (not in use)
2Image
3Native
4Text
5Reserved (not in use)
6Video
7Rich Media
8HTML5
Retrieve Details of a Creative Type
/creativetypes/GET

Retrieves all Creative Type details.

You can apply supported dimensions, filters and sorting options to fetch a list of Tracking Events with a specific set of details.

Retrieve a List of Creative Types
https://api.pubmatic.com/v1/uas/creativetypes?dimensions=name,description&filters=id eq <Creative Type Id>GET

Retrieves details for all Creative Types that match supported dimensions, filters and sorting options in the query.

Creative Types Generic Search

 

Retrieve Details of a Creative Type

 

Overview

Retrieves the details of a specific Creative Type based on Creative Type ID.

 

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 URL

https://api.pubmatic.com/v1/uas/creativetypes/2 

Response

Response Body Parameters

                       

ParameterTypeDescription
idNumericCreative Type Identifier
nameStringName of the Creative Type
descriptionStringCreative Type description

Sample Response JSON

{
    "id": 2,
    "name": "Image",
    "description": "Image Creative Type"
}

Retrieve a List of Creative Types

 

Overview

Retrieves details for all supported Creative Types. 

 

In the query, you can also apply supported dimensions, filters and sorting options to fetch a list of Tracking Events 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 URL

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

Response

Sample Response JSON

    

Response will contain all supported creative types.

Creative Types Generic Search

 

Overview

Retrieves details for all Creative Types that match supported dimensions, filters and sorting options in the query to fetch a list of Tracking Events 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 URL

https://api.pubmatic.com/v1/uas/creativetypes?dimensions=name,description&filters=id eq 1

Response

Sample Response JSON

    

Response will contain all supported creative types.

 

Error Codes

             

Sr. No.Error CodeDescription
1.MISSING_OR_INVALID_PARAMETERIf you requested details for creative type with an ID that does not exist or is invalid.

 

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.2

Attachments

    Outcomes