Native Asset Type API (UAS)

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

Description

The Native Asset Type API enables you to retrieve the supported Native Assets types and the details for specific Native Asset Types.

For more information about UAS Native Template Services APIs, refer to Native Template Services (UAS)

Supported Operations

Service Name: /common/nativeassettype/

                     

Method PathHTTP Method TypeDescriptionLink to Definition
/common/nativeassettype/{id}GET

Retrieve Native Asset Type details using Asset Type id. The following Native Asset types are supported:

1 = Title 
2 = Image
3 = Data
4 = Video (Not currently supported)

Retrieve the Details of Native Asset Type
/common/nativeassettype/GETRetrieve a list of supported Native Asset TypesRetrieve a List of Native Asset Types

 

Retrieve the Details of Native Asset Type

 

Overview

This API enables you to retrieve the details of a Native Asset Type.

Request

           

URIHTTP Method
https://$URI_/PREFIX/{apiVersion}/api/common/nativeassettype{id}GET

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.

Sample Request URL

https://$URI_PREFIX/{apiVersion}/api/common/nativeassettype/1

Response

Response Body Parameters

                       

Parameter NameTypeDescription
idNumericNative Asset Identifier
nameStringNative Asset Name
descriptionStringNative Asset Description

Sample Response JSON

    

{
    "id": 1,
    "name": "Media Buyer"
}

 

Retrieve a List of Native Asset Types

 

Overview

This API enables you to retrieve a list of Native Asset Types.

Request

           

URIHTTP Method
https://$URI_/PREFIX/{apiVersion}/api/common/nativeassettypeGET

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.

Sample Request URL

https://$URI_PREFIX/{apiVersion}/api/common/nativeassettype

Response

Sample Response 

    

This will return a list of supported Native Asset Types.

 

Error Codes for Native Asset Type

Sr. NoError CodesDescription
1.MISSING_OR_INVALID_PARAMETERRequested details for Native Asset 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