The verification_pixel
(aka 3rd Party Pixel) can be set at the campaign or item level.
For a description of the object schema, see below.
Overview
Taboola supports the sending of live campaign data (clicks, impressions and/or viewable impressions) to a 3rd party tracking platform.
To do so, update the verification_pixel
property of the campaign or item.
If the
verification_pixel
is set at both the campaign and item level, then the item level settings are applied.
Examples
The code samples below illustrate how to set the verification_pixel
at the campaign level. Similar operations can be performed at the item level.
Apply a verification pixel:
POST /backstage/api/1.0/demo-account/campaigns/1234/
{
"verification_pixel": {
"verification_pixel_items": [
{
"url": "https://www.example.com/",
"verification_pixel_type": "CLICK"
},
{
"url": "https://www.example.com/",
"verification_pixel_type": "VIEWABLE_IMPRESSION"
},
{
"url": "https://www.example.com/",
"verification_pixel_type": "IMPRESSION"
}
]
}
}
{
"id": "1234",
"advertiser_id": "demo-account",
//...
"verification_pixel": {
"verification_pixel_items": [
{
"url": "https://www.example.com/",
"verification_pixel_type": "CLICK"
},
{
"url": "https://www.example.com/",
"verification_pixel_type": "VIEWABLE_IMPRESSION"
},
{
"url": "https://www.example.com/",
"verification_pixel_type": "IMPRESSION"
}
]
},
//...
}
The
url
property must contain a valid URL that points to an HTTP resource. (Supported resources are image or text - not JS.)
The Verification Pixel does not support a PATCH operation - the newly submitted collection overwrites any existing values.
Remove ALL:
POST /backstage/api/1.0/demo-account/campaigns/1234/
{
"verification_pixel" : {
"verification_pixel_items": []
}
}
{
"id": "1234",
"advertiser_id": "demo-account",
//...
"verification_pixel": null,
//...
}
Dictionary
Get possible values for verification_pixel_type
:
POST /backstage/api/1.0/resources/campaigns_properties/verification-pixel-type
{
"results": [
{
"name": "CLICK",
"value": "Click"
},
{
"name": "VIEWABLE_IMPRESSION",
"value": "Viewable Impression"
},
{
"name": "IMPRESSION",
"value": "Impression"
}
],
"metadata": {
//...
}
}