Creative Asset Type API (UAS)

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

Description

The Creative Asset Type API enables you to retrieve Creative Asset Types - either for a specific Creative Asset Type or all supported types.

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

Supported Operations

Service Name: /creativeassettypes/

                     

Method PathHTTP Method TypeDescriptionLink to Definition
/creativeassettypes/{id}GETRetrieves the details of a specific Creative Asset Type for the requested ID.Retrieve details of a Creative Asset Type
/creativeassettypes/GET

Retrieves all Creative Asset 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 Asset Types

 

Retrieve details of a Creative Asset Type

 

Overview

This API enables you to retrieve the details of a specific Creative Asset Type for the requested 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/creativeassettypes/1 

Response

Response Body Parameters

                       

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

Sample Response JSON

{
    "id": 1,
    "name": "Image"
    "description": "Image Asset"
}

Retrieve a list of Creative Asset Types

Overview

This API enables you to retrieve a list of Creative Asset 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/creativeassettypes?dimensions=id,name&filters=id eq 1

 

Response

Sample Response JSON

    

Response will contain records associated with your account that match the request and filtering criteria.

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

Attachments

    Outcomes