Jivox Programmable Personalization API exposes the lists and details of Ad-Server used by the platform, that is required to generate tags for a given campaign.
Methods
| Action | Method Type | Description |
|---|---|---|
| List All Ad-Servers | GET | Returns list of all ad-servers for given ad-server ID. |
| Get Ad-Server Details | GET | Returns details of ad-server for given ad-server ID. |
List All Ad-Servers
Parameters
The List All Ad-Servers method does not require any path or query parameters.
Sample Request
GET http://demo.stub.api.jivox.com/v2/ad-servers/Sample Response
{"adServers": [{"id": "aol","name": "AOL"},{"id": "Appnexus","name": "AppNexus"},. . .],"previous": "","next": ""}Get Ad-Server Details
Parameters
| Name | Data Type | Requirement | Parameter Type | Description |
|---|---|---|---|---|
| adServerId | string | Mandatory | path | ID of the Ad Server for which the details are being fetched. |
Sample Request
GET http://demo.stub.api.jivox.com/v2/ad- servers/AppnexusSample Response
{"id": "Appnexus","name": "AppNexus","macros": [{"name": "Advertiser Coder","value": "${ADV_CODE}"},{"name": "User Age","value": "${AGE}"},. . .],"options": [{"id":"adUnit","name": "Ad Unit"},{"id": "adUnitDimension","name": "Ad Unit Dimension"},. . .]}Sample Workflow
A sample workflow using Programmable Personalization API methods:
Was this page helpful?