Native Asset Type Properties API (UAS)

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

Description

The Native Asset Type Properties API enables you to retrieve details of properties supported by Native Asset. You need to set valid propety sets while adding the asset object during template creation and it will be validated against the Native Creative creation.

Note: PubMatic validates the asset properties only for the Image Asset Type during Native Creative creation.

For more detail, please refer to Native Ad Specification Documentation.

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

Supported Operations

Service Name: /common/nativeassettype/properties

                     

Method PathHTTP Method TypeDescriptionLink to Definition
/common/nativeassettype/propertiesGET

Retrieve a list of supported Native Asset Type Properties

Retrieve a List of Supported Native Asset Types
/common/nativeassettype/properties?GETRetrieve a list of properties associated with a specific Asset TypeRetrieve a List of Specific Native Asset Types

 

 

Retrieve a List of Supported Native Asset Types

 

Overview

This API enables you to retrieve a list of properties associated with a specific Asset Type.

Request

           

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

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/properties

Response

Sample Response JSON

    

{
    "metaData": {
        "startIndex": 1,
        "totalRecords": 12,
        "endIndex": 12
    },
    "items": [{
        "id": 1,
        "name": "len",
        "typeId": 1,
        "type": "title",
        "required": 1,
        "defaultValue": "100",
        "displayName": "Length"
    }, {
        "id": 2,
        "name": "w",
        "typeId": 2,
        "type": "image",
        "required": 0,
        "defaultValue": "640",
        "displayName": "Width"
    }, {
        "id": 3,
        "name": "wmin",
        "typeId": 2,
        "type": "image",
        "required": 0,
        "defaultValue": "0",
        "displayName": "Min Width"
    }, {
        "id": 4,
        "name": "h",
        "typeId": 2,
        "type": "image",
        "required": 0,
        "defaultValue": "480",
        "displayName": "Height"
    }, {
        "id": 5,
        "name": "hmin",
        "typeId": 2,
        "type": "image",
        "required": 0,
        "defaultValue": "0",
        "displayName": "Min Height"
    }, {
        "id": 6,
        "name": "mime",
        "typeId": 2,
        "type": "image",
        "required": 0,
        "defaultValue": "image/png",
        "displayName": "MIME Type"
    }, {
        "id": 7,
        "name": "len",
        "typeId": 3,
        "type": "data",
        "required": 0,
        "defaultValue": "200",
        "displayName": "Length"
    }, {
        "id": 8,
        "name": "mime",
        "typeId": 4,
        "type": "video",
        "required": 1,
        "defaultValue": "video/xwf",
        "displayName": "MIME Type"
    }, {
        "id": 9,
        "name": "minduration",
        "typeId": 4,
        "type": "video",
        "required": 1,
        "defaultValue": "15",
        "displayName": "Min Duration"
    }, {
        "id": 10,
        "name": "maduration",
        "typeId": 4,
        "type": "video",
        "required": 1,
        "defaultValue": "15",
        "displayName": "Max Duration"
    }, {
        "id": 11,
        "name": "protocols",
        "typeId": 4,
        "type": "video",
        "required": 1,
        "defaultValue": "VAST 3.0",
        "displayName": "Protocols"
    }, {
        "id": 12,
        "name": "vpaidsupport",
        "typeId": 4,
        "type": "video",
        "required": 0,
        "defaultValue": "2",
        "displayName": "VPAID Support"
    }]
}
 

 

Retrieve a List of Specific Native Asset Types

Overview

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

Request

           

URIHTTP Method
https://$URI_/PREFIX/{apiVersion}/api/common/nativeassettype/properties?filters=typeId eq {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\properties?filters=typeId eq 2

Response

Sample Response JSON

    

{
    "metaData": {
        "startIndex": 1,
        "totalRecords": 5,
        "endIndex": 5
    },
    "items": [{
        "id": 2,
        "name": "w",
        "typeId": 2,
        "type": "image",
        "required": 0,
        "defaultValue": "640",
        "displayName": "Width"
    }, {
        "id": 3,
        "name": "wmin",
        "typeId": 2,
        "type": "image",
        "required": 0,
        "defaultValue": "0",
        "displayName": "Min Width"
    }, {
        "id": 4,
        "name": "h",
        "typeId": 2,
        "type": "image",
        "required": 0,
        "defaultValue": "480",
        "displayName": "Height"
    }, {
        "id": 5,
        "name": "hmin",
        "typeId": 2,
        "type": "image",
        "required": 0,
        "defaultValue": "0",
        "displayName": "Min Height"
    }, {
        "id": 6,
        "name": "mime",
        "typeId": 2,
        "type": "image",
        "required": 0,
        "defaultValue": "image/png",
        "displayName": "MIME Type"
    }]
}

 

Error Codes for Native Asset Properties Type 

Sr. NoError CodesDescription
1.N01_002Requested property 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