The various methods for Bulk Tag Generation are listed below:
Create Bulk Tag
Bulk Tag Generation Status
Get Tags for DSP
Get Tags for Placement
Download Tags
Mail Tags
Create Bulk Tag
Initiate bulk tag generation for a single/list of DSP for a given media plan and campaign.
Parameters
Name | Data Type | Requirement | Parameter Type | Description |
|---|
accountId | string | Mandatory | path | ID of the advertiser account created on the platform. |
mediaPlanId | string | Mandatory | path | ID of the media plan associated with a given user account. |
Sample Request
POST http://demo.stub.api.jivox.com/v2/accounts/:accountId/media-plans/:mediaPlanId/bulktags
Request Body
{
"campaignIdx": 154545,
"dsp": [
"appNexus",
"AOL One"
]
}
Sample Response
{
"executionId": 7,
"msg": "Bulk tag creation has been started"
}
Bulk Tag Generation Status
Gets the current tag generation count and total count for a given tag generation Id.
Parameters
Name | Data Type | Requirement | Parameter Type | Description |
|---|
accountId | string | Mandatory | path | ID of the advertiser account created on the platform. |
campaignId | string | Mandatory | path | ID of the Campaign for which Tags need to be generated |
mediaPlanId | string | Mandatory | path | ID of the media plan associated with a given user account. |
executionId | string | Mandatory | path | ID of the execution returned when bulk tag generation is initiated |
Sample Request
GET http://demo.stub.api.jivox.com/v2/accounts/:accountId/campaigns/:campaignId/media-plans/:mediaPlanId/execution/:executionId/status
Sample Response
{
"currentCount": 10, //Current Tag generation count
"executionId": 7,
"mediaPlanId": 56362,
"status": "finished",
"totalCount": 10 //Total Tag generation count
}
Gets list of tags created for a given DSP for the given media plan and campaign.
Parameters
Name | Data Type | Requirement | Parameter Type | Description |
|---|
accountId | string | Mandatory | path | ID of the advertiser account created on the platform. |
mediaPlanId | string | Mandatory | path | ID of the media plan associated with a given user account. |
campaignId | string | Mandatory | path | ID of the Campaign for which Tags need to be generated |
Sample Request
GET http://demo.stub.api.jivox.com/v2/accounts/:accountId/media-plans/:mediaPlanId/campaigns/:campaignId/tags
Query Parameters
adServer - DSP name
limit*_: *_The limit of number of rows to be returned in the response per page from the offset.
Sample Response
{
"next": "",
"previous": "",
"tags": [
{
"adServerId": "DFP",
"adTagType": "JavaScript",
"adType": "video.in-banner",
"adUnitId": null,
"adUnitTypeId": 0,
"adUnitTypeName": null,
"baseDimension": "",
"campaignId": 44342,
"createdOn": "Sat Feb 19 12:49:14 IST 2022",
"dataSignalMap": {
"DataSignal1": "%c"
},
"expansionDimension": "",
"lastUpdatedOn": "Sat Feb 19 12:49:14 IST 2022",
"placementName": "pn5",
"siteName": "Site3",
"tag": "<script type=\"text/javascript\" src=\"https://null?es_pId=bf7e0ac&showAdChoices=1&r=%n&isDynamic=1&cMacro=%c&campaignId=44342&fiBuster=0&ts_pId=bf7e0ac&siteId=be989cad24d04c4&ap_DataSignal1=%c&jvxVer=2\"></script><noscript><img src=\"https://evs.jivox.com/jivox/serverAPIs/externalReporting/tracker.php?campaignId=44342&siteId=be989cad24d04c4&adUnitType=1&es_pId=bf7e0ac\" alt=\"\" title=\"\" width=\"1\" height=\"1\" style=\"display:none;\" /><a href=\"%chttps%3A%2F%2Fevs.jivox.com%2Fjivox%2FserverAPIs%2FexternalReporting%2Fproxy.php%3FcampaignId%3D44342%26siteId%3Dbe989cad24d04c4%26adUnitType%3D1%26es_pId%3Dbf7e0ac\" target=\"_blank\"><img src=\"//playercdn.jivox.com/flash_player_required.png\" border=\"0\" width=\"300\" height=\"250\"/></a></noscript>",
"tagId": 146418, //Jivox tag Id
"tagMetadataId": 64903
},
{
"adServerId": "DFP",
"adTagType": "JavaScript",
"adType": "video.in-banner",
"adUnitId": null,
"adUnitTypeId": 0,
"adUnitTypeName": null,
"baseDimension": "300X100",
"campaignId": 44342,
"createdOn": "Sat Feb 19 12:49:15 IST 2022",
"dataSignalMap": {
"DataSignal1": "%c"
},
"expansionDimension": "",
"lastUpdatedOn": "Sat Feb 19 12:49:15 IST 2022",
"placementName": "pnupdated4",
"siteName": "Site3",
"tag": "<script type=\"text/javascript\" src=\"https://null?es_pId=cabe735&showAdChoices=1&r=%n&isDynamic=1&cMacro=%c&campaignId=44342&fiBuster=0&ts_pId=cabe735&siteId=be989cad24d04c4&ap_DataSignal1=%c&jvxVer=2\"></script><noscript><img src=\"https://evs.jivox.com/jivox/serverAPIs/externalReporting/tracker.php?campaignId=44342&siteId=be989cad24d04c4&adUnitType=1&es_pId=cabe735\" alt=\"\" title=\"\" width=\"1\" height=\"1\" style=\"display:none;\" /><a href=\"%chttps%3A%2F%2Fevs.jivox.com%2Fjivox%2FserverAPIs%2FexternalReporting%2Fproxy.php%3FcampaignId%3D44342%26siteId%3Dbe989cad24d04c4%26adUnitType%3D1%26es_pId%3Dcabe735\" target=\"_blank\"><img src=\"//playercdn.jivox.com/flash_player_required.png\" border=\"0\" width=\"300\" height=\"250\"/></a></noscript>",
"tagId": 146419,
"tagMetadataId": 64904
}
]
}
Gets list of tags created for a given placementId for the given media plan and campaign.
Parameters
Name | Data Type | Requirement | Parameter Type | Description |
|---|
accountId | string | Mandatory | path | ID of the advertiser account created on the platform. |
mediaPlanId | string | Mandatory | path | ID of the media plan associated with a given user account. |
campaignId | string | Mandatory | path | ID of the Campaign for which Tags need to be generated |
placementId | string | Mandatory | path | ID of the placement associated with media plan to be used for generated tags. |
Sample Request
GET http://demo.stub.api.jivox.com/v2/accounts/:accountId/media-plans/:mediaPlanId/campaigns/:campaignId/placements/:placementId/tags
Query Parameters
limit - The limit of number of rows to be returned in the response per page from the offset.
offset - This is the offset.
Sample Response
{
"next": "https://localhost:9000/v2/accounts/6832/media-plans/41397/placements/cabe735/tags?limit=1&offset=0&next=SREU",
"previous": "",
"tags": [
{
"adServerId": "DFP",
"adTagType": "JavaScript",
"adType": "video.in-banner",
"adUnitId": null,
"adUnitTypeId": 0,
"adUnitTypeName": "Unknown",
"campaignId": 44342,
"createdOn": "Sat Feb 19 12:49:15 IST 2022",
"dataSignalMap": {
"DataSignal1": "%c"
},
"lastUpdatedOn": "Sat Feb 19 12:49:15 IST 2022",
"placementName": "pnupdated4",
"siteName": "Site3",
"tag": "<script type=\"text/javascript\" src=\"https://as.dev.jivox.com?es_pId=cabe735&showAdChoices=1&r=%n&isDynamic=1&cMacro=%c&campaignId=44342&fiBuster=0&ts_pId=cabe735&siteId=be989cad24d04c4&ap_DataSignal1=%c&jvxVer=2\"></script><noscript><img src=\"https://evs.jivox.com/jivox/serverAPIs/externalReporting/tracker.php?campaignId=44342&siteId=be989cad24d04c4&adUnitType=1&es_pId=cabe735\" alt=\"\" title=\"\" width=\"1\" height=\"1\" style=\"display:none;\" /><a href=\"%chttps%3A%2F%2Fevs.jivox.com%2Fjivox%2FserverAPIs%2FexternalReporting%2Fproxy.php%3FcampaignId%3D44342%26siteId%3Dbe989cad24d04c4%26adUnitType%3D1%26es_pId%3Dcabe735\" target=\"_blank\"><img src=\"//playercdn.jivox.com/flash_player_required.png\" border=\"0\" width=\"300\" height=\"250\"/></a></noscript>",
"tagId": 146419,
"tagMetadataId": 64904
}
]
}
Downloads in csv format, the list of generated tags for a given DSP/Placement for the given media plan and campaign.
Parameters
Name | Data Type | Requirement | Parameter Type | Description |
|---|
accountId | string | Mandatory | path | ID of the advertiser account created on the platform. |
mediaPlanId | string | Mandatory | path | ID of the media plan associated with a given user account. |
campaignId | string | Mandatory | path | ID of the Campaign for which Tags need to be generated |
Sample Request
GET http://demo.stub.api.jivox.com/v2/accounts/:accountId/media-plans/:mediaPlanId/campaigns/:campaignId/downloadTags
Query Parameters
adServers(optional) - This is jsArray String of adServers for which you need to export tags, eg: ["DFP", "AOL"]** **
placement(optional) - This is the placementId
service(mandatory)- It can either be exportForDSP or exportForPlacement. If it is exportForDSP, then adServers field is mandatory, if it is exportForPlacement then placement is mandatory.
Sample Response
Download CSV File
Mails the list of generated tags for a given DSP/Placement for the given media plan and campaign
Parameters
Name | Data Type | Requirement | Parameter Type | Description |
|---|
accountId | string | Mandatory | path | ID of the advertiser account created on the platform. |
mediaPlanId | string | Mandatory | path | ID of the media plan associated with a given user account. |
campaignId | string | Mandatory | path | ID of the Campaign for which Tags need to be generated |
Sample Request
GET http://demo.stub.api.jivox.com/v2/accounts/:accountId/media-plans/:mediaPlanId/campaigns/:campaignId/mailTags
Query Parameters
adServers(optional)**: **This is jsArray String of adServers for which you need to export tags, eg: ["DFP", "AOL"]
placement(optional) - This is the placementId
service(mandatory) - It can either be exportForDSP or exportForPlacement. If it is exportForDSP, then adServers field is mandatory, if it is exportForPlacement, then placement is mandatory.
mailIDs - Comma separated values of emailIDs eg: test1.jivox.com, test2.jivox.com, test3.jivox.com
Sample Response
{
"message": "Please check your mail, Tags will be sent shortly"
}
