Get Preview Links API

AI Tools

The Get Preview Links API is used to retrieve the preview links for the ad units that have been created for an ad. The preview links can be used to get the creative approval from the advertiser. These preview links can also be saved in the order entry system as a point of record.

Request URL

To retrieve preview links for an ad, make a request to the following URL:

https://<JIVOX_SERVER>/jivox/serverAPIs/rest/getPreviewLinks.php

The request URL supports the following parameters:

Parameter

Description

adId

(Required) ID of the ad. This ID is available in the response of the createAd call.

Example

curl –d 'apiId=aaa&apiKey=bbb&apiVersion=1.0&publisherId=xxx&adId=12345' https:__<server>_jivox_serverAPIs_rest_getPreviewLinks.php

Server Success Response

In case of success, the server returns a response with the structure shown below:

<_jivoxServerResponse><jivoxServerResponse> <result>SUCCESS<_result> <adUnits> <adUnit> <Name>Medium Rectangle<_Name> <previewURL>http:__previewURL<_previewURL> <_adUnit> <adUnit> <Name>Leaderboard<_Name> <previewURL>http:__previewURL<_previewURL> <_adUnit> <_adUnits> <_jivoxServerResponse>

Fields in the server response XML are as follows:

  • Name: Name of the Ad Unit. A list of supported ad units is available in Appendix: Supported Ad Units.

  • previewURL: URL of preview for the ad


Next to read:
Create Campaign API
null
On This Page
Get Preview Links APIRequest URLExampleServer Success Response