Click Through URL API (UAS)

Document created by pubmatic-archivist on Mar 27, 2017Last modified by david.simerly on Jul 31, 2018
Version 9Show Document
  • View in full screen mode
Before using PubMatic APIs, first generate the API Token. For more information, see Getting Started with PubMatic APIs.

The API lets you retrieve a list of supported protocols for click-through to Creative landing page.

For more information about UAS Creative Management Services, see Creative Management Services (UAS)

Supported Operations

Method PathHTTP Method TypeDescriptionLink to Definition
/clickthroughurlprotocol/{id}GETRetrieves the details of a specific protocol meta data details.Retrieve details of Click Through Protocol
/clickthroughurlprotocol/GET

Retrieves a list of supported standard click-through URL protocols. The following are supported by the Unified Ad Server:

Protocol IDNameDescription
1http://For Creative Click through URL that supports HTTP protocol.
2https://For Creative Click through URL that supports HTTPS protocol.
3Phone NumberTo provide the telephone number to initiate "Click to Call" action when user performs click on creative.
500CustomFor other protocols you wish to support; for example, Android market:// for downloading the mobile application.

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 Click Through Protocols

 

Retrieve details of Click Through Protocol

Retrieves specific protocol metadata details for click through protocol.

 

Request

 

Request Headers

Header nameType ValueRequiredDescription
Content-TypeStringapplication/jsonYesMedia type for request.
AuthorizationStringBearer ${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/clickthroughurlprotocol/1

 

Response

Response Body

Parameter NameTypeDescription
idNumericProtocol Identifier
nameStringProtocol Name
descriptionStringProtocol Description

 

Sample Response JSON

{
    "id": 1,
    "name": "http://",
    "description": "http protocol"
}

 

Retrieve a list of Click Through Protocols

Retrieves a list of supported standard click-through URL protocols. 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.

See 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.
AuthorizationStringBearer ${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/clickthroughurlprotocol/

 

Response

Sample Response JSON

Response will contain all supported click through URL protocols.

 

Error Codes for Protocol

Sr. No.Error CodesDescription
1.MISSING_OR_INVALID_PARAMETERIf you requested details for Protocol with id, which does not exist or is invalid.

 

Unified Ad Server References

 

Version 0.1

 

⇧ Top

Attachments

    Outcomes