Create Ad API
The Create Ad API is used to create an ad in a specific advertiser account. The API will ensure that the ad naming is consistent and the appropriate ad units in the order are created. Once assets are available, a creative designer can then complete the ad build.
Request URL
To retrieve advertisers, make a request to the following URL:
https://<JIVOX_SERVER>/jivox/serverAPIs/rest/createAd.php
The request URL supports the following parameters:
| Paremeter | Description |
|---|---|
| emailAddress | (Required) Email address for the advertiser account |
| adTitle | (Required) Name for the ad |
| adUnits | (Optional) Ad unit type. For multiple ad units, use comma separated values. A list of supported ad units is available in Appendix: Supported Ad Units. |
Example
xxxxxxxxxxcurl –d 'apiId=aaa&apiKey=bbb&apiVersion=1.0&publisherId=xxx&emailAddress=foo@bar.com&adTitle=My first ad&adUnits=Medium Rectangle, Leaderboard, Billboard' https:__<server>_jivox_serverAPIs_rest_createAd.phpServer Success Response
In case of success, the server returns a response with the structure shown below:
xxxxxxxxxx<jivoxServerResponse><result>SUCCESS<_result><adId>adID<_adId><_jivoxServerResponse>Fields in the server response XML are as follows:
- adID: Created Ad ID. This ad ID is required to get the preview links and to create a campaign for this ad. When the creative assets are available, the ad designer can sign into the advertiser's account using the accountLoginURL and upload the assets to complete the ad build.
Was this page helpful?