Create Campaign API
The Create Campaign API is used to create a campaign. You will typically create a campaign once the ad preview has been approved. You will need a campaign to generate tags.
Request URL
https://<JIVOX_SERVER>/jivox/serverAPIs/rest/createCampaign.php
The request URL supports the following parameters:
| Parameter | Description |
|---|---|
| adId | (Required) ID of the ad to be used in the campaign. This ID is available in the response of the createAd call. |
| clickThroughURL | (Optional) The click through URL. If not provided, the ad click through URL will be used. |
| campaignName | (Optional) Name of the campaign. If not provided, the ad name will be used as the campaign name. |
Example
xxxxxxxxxxcurl –d 'apiId=aaa&apiKey=bbb&apiVersion=1.0&publisherId=xxx&adId=12345&clickThroughURL=http:__xyz.com' https:__<server>_jivox_serverAPIs_rest_createCampaign.phpServer Success Response
In case of success, the server returns xml structure as shown below:
x
Fields in the server response XML are as follows:
- campaignId: Id of the created campaign.
Was this page helpful?