Single Tag

AI Tools

The various methods for Single Tag are listed below:

Create Single Tag for Rich-Media

Creates a new rich-media tag for the given placementId.

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.
placementId	string	Mandatory	path	ID of the placement associated with media plan to be used for tag generation.

Sample Request

POST http://demo.stub.api.jivox.com/v2/accounts/:accountId/media-plans/:mediaPlanId/placements/:placementId/tags/rich-media

Request Body

{ "campaignId": 42957, "adServerId": "DCM", "includeAdChoices": false, "additionalParams": {}, "privacy": [ { "include": true, "type": "GDPRv2", "consentMacro": "{GDPR_CONSENT_294}" } ], "secureTags": true, "dataSignalMap": { "ap_DataSignal1": "click" }, "adUnitId": 2000, "enableNoScriptTag": false, "enableForMobileApp": true, "thirdPartyTrackingScript": "string", "mobileResponsiveOptions":{ "include":true, "mobileFlexCreativeUnitType":57, "bannerType":"Custom Layout" } }

Sample Response

{ "message": "Tag generated successfully.", "tagMetadataId": 64921, "tagValue": "<script type=\"text/javascript\" src=\"https://qa364.jivox.com/unit/unit_renderer.php?es_pId=19458c4&showAdChoices=0&isDynamic=1&campaignId=42957&gdpr_consent={GDPR_CONSENT_294}&bDim=300x250&mobileResponsiveFullPageFlex=1&ap_DataSignal1=%c_esc&jvxVer=2&gdpr=${GDPR}&bUnitId=2000&r=%n&cMacro=%c_esc&ts_pId=19458c4&siteId=e24c488eec75454&creativeUnitType=20\"></script>" }

Create Single Tag for Instream-Video

Creates a new instream-video tag for a given placement.

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
placementId	string	Mandatory	path	ID of the placement associated with media plan to be used for tag generation.

Sample Request

POST http://demo.stub.api.jivox.com/v2/accounts/:accountId/media-plans/:mediaPlanId/placements/:placementId/tags/video/in-stream

Request Body

{ "campaignId": 2000148, "adServerId": "Appnexus", "includeAdChoices": false, "tagType": "url", "additionalParams": {}, "privacy": [ { "include": true, "type":"GDPRv2", "consentMacro": "{GDPR_CONSENT_294}" } ], "secureTags": true, "playerType": { "name":"VAST", "version":"2.0" }, "dataSignalMap": { "ap_DataSignal1": "Advertiser ID" } }

Sample Response

{ "message": "Tag generated successfully.", "tagMetadataId": 1681, "tagValue": "https://qa3-t.jivox.com/jivox/serverAPIs/getCampaignById.php?es_pId=3D2L68&showAdChoices=0&isDynamic=1&campaignId=2000148&ts_pId=3D2L68&siteId=76125d6a24b911&gdpr_consent={GDPR_CONSENT_294}&api=vast-dynamic&version=2.0&ap_DataSignal1=${ADV_ID}&jvxVer=2&gdpr=${GDPR}" }

Create Single Tag for Inbanner-Video

Creates a new inbanner-video tag for a given placement.

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
placementId	string	Mandatory	path	ID of the placement associated with media plan to be used for tag generation.

Sample Request

POST http://demo.stub.api.jivox.com/v2/accounts/:accountId/media-plans/:mediaPlanId/placements/:placementId/tags/video/in-banner

Request Body

{ "campaignId": 2000253, "adServerId": "Appnexus", "enableNoScriptTag": false, "includeAdChoices": false, "additionalParams": {}, "isDynamicPriVideo": true, "privacy": [ { "include": true, "type": "GDPRv2", "consentMacro": "{GDPR_CONSENT_294}" }, { "include": true, "type": "ccpa" } ], "dataSignalMap": { "ap_DataSignal1": "Advertiser ID" }, "thirdPartyTrackingScript": "string" }

Sample Response

{ "message": "Tag generated successfully.", "tagMetadataId": 1688, "tagValue": "<script type=\"text/javascript\" src=\"https://qa364.jivox.com/player/ibv_renderer.php?es_pId=WTQcIO&showAdChoices=0&isDynamic=1&campaignId=2000253&us_privacy=${US_PRIVACY}&fiBuster=0&ts_pId=WTQcIO&siteId=561260ce0e6957&gdpr_consent={GDPR_CONSENT_294}&ap_DataSignal1=${ADV_ID}&jvxVer=2&gdpr=${GDPR}\"></script>" }

Create Single Tag for Mobile-InWeb

Creates a new mobile-inweb tag for a given placement.

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
placementId	string	Mandatory	path	ID of the placement associated with media plan to be used for tag generation.

Sample Request

POST http://demo.stub.api.jivox.com/v2/accounts/:accountId/media-plans/:mediaPlanId/placements/:placementId/tags/video/mobile/in-web

Request Body

{ "campaignId": 2000253, "adServerId": "Appnexus", "additionalParams": {}, "privacy": [ { "include": true, "type": "GDPRv2", "consentMacro": "{GDPR_CONSENT_294}" }, { "include": true, "type": "ccpa" } ], "dataSignalMap": { "ap_DataSignal1": "Advertiser ID" }, "baseAdUnitId":300, "behaviourAdUnitTypeId": 3, "useCustomLayout": false, "thirdPartyTrackingScript": "string" }

Sample Response

{ "message": "Tag generated successfully.", "tagMetadataId": 1691, "tagValue": "<script type=\"text/javascript\" src=\"https://qa364.jivox.com/unit/unit_renderer.php?es_pId=WTQcIO&showAdChoices=0&isDynamic=1&bannerType=I&campaignId=2000253&gdpr_consent={GDPR_CONSENT_294}&bUnit=1&bDim=300x50&ap_DataSignal1=${ADV_ID}&jvxVer=2&gdpr=${GDPR}&isnonexpanding=Y&unitType=mobile&us_privacy=${US_PRIVACY}&ts_pId=WTQcIO&siteId=561260ce0e6957&creativeUnitType=3\"></script>" }

Create Single Tag for Native Ad

Creates a new Native tag for a given placement.

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
placementId	string	Mandatory	path	ID of the placement associated with media plan to be used for tag generation.

Sample Request

POST http://demo.stub.api.jivox.com/v2/accounts/:accountId/media-plans/:mediaPlanId/placements/:placementId/tags/native

Request Body

{ "adUnitId": 8000, "campaignId": 2001030, "adServerId": "DCM", "additionalParams": { "responseFormat": 2 }, "privacy": [ { "include": true, "type": "GDPRv2", "consentMacro": "{GDPR_CONSENT_294}" }, { "include": true, "type": "ccpa" } ], "dataSignalMap": { "ap_DataSignal1": "Advertiser ID" } }

Sample Response

{ "message": "Tag generated successfully.", "tagMetadataId": 7638, "tagValue": "https://as.dev.jivox.com/native/native_ad.php?es_pId=3a92902&campaignId=2001030&format=jsonp&gdpr_consent={GDPR_CONSENT_294}&responseFormat=2&ap_DataSignal1=%eadv!&jvxVer=2&gdpr=${GDPR}&r=%n&cMacro=%c_esc&us_privacy=${US_PRIVACY}&ts_pId=3a92902&callback=doDco&siteId=0b11bafe1ece44d&partnerId=TL&creativeUnitType=80" }

Last updated on

Was this page helpful?