This table provides a list of custom parameters that can be used to send additional data points to TrafficGuard.
Basic Parameters
ID | API parameter | Description |
1 | agency_id | ID of the agency |
2 | app_id | App package name as it appears in the store |
3 | campaign_id | Campaign name or ID |
4 | creative_id | Identifier of the ad creative |
5 | creative_set_id | Identifier of the ad creative set |
6 | creative_type | Type of ad creative (display, video) |
7 | gdpr | GDPR Consent passing |
8 | gdpr_consent | GDPR Consent passing - Encodes the consented-to purposes and vendor consent string, as obtained from the CMP JS API or OpenRTB. |
9 | gdpr_pd | GDPR Consent passing - for generic URL parameters, gdpr_pd=0 indicates none of them contain personal data (from the perspective of the callee). For "defined" URL parameters, their definition should define whether they include personal data. |
10 | placement_id | Identifier of the ad placement |
11 | section_id | Identifier of section of the ad placement |
12 | site_id | ID of the site or mobile app where the user was engaged |
13 | source_id | Source id is integrated partner id on trafficguard platform |
14 | sub_param_1 | Custom Parameter 1 |
15 | sub_param_2 | Custom Parameter 2 |
16 | sub_param_3 | Custom Parameter 3 |
17 | sub_param_4 | Custom Parameter 4 |
18 | sub_param_5 | Custom Parameter 5 |
19 | sub_source_id | Identifier of the sub-source or sub-publisher |
Example - sending custom parameters
<!-- TrafficGuard Start -->
<script>
window.dataTrafficGuard = window.dataTrafficGuard || [];
window.dataTrafficGuard.push(['property', '{property-id}']);
window.dataTrafficGuard.push(['event','pageview','{"campaign_id":"123555", "creative_id":"creative_example_id", "site_id":"default_site_id"}']);
(function() {
var tg = document.createElement('script'); tg.type = 'text/javascript'; tg.async = true;tg.src = 'https://tgtag.io/tg.js?pid={property-id}';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(tg, s);
})();
</script>
<noscript><img src="https://p.tgtag.io/event?property_id={property-id}&event_name=pageview&no_script=1" width="1" height="1" border="0"/></noscript>
<!-- TrafficGuard End-->