ProductXYZ Tag Types & Environments
Info/Context
Type: End-user documentation
Audience: Current and prospective CompanyName users
Purpose: A technical reference that compares ProductXYZ's various detection tags and the environments they run in. These detection tags are small snippets of code that collect information for ProductXYZ to analyze.
Note: Some words and phrases are enclosed in [brackets] to represent hyperlinks to other docs not included in this sample library.
ProductXYZ uses [detection tags] to collect post-bid signals and analyze impression quality. Rather than taking a one-size-fits-all approach to detection, we tailor our signal collection to provide coverage in a variety of scenarios. Each tag type offers different strengths and weaknesses, including the number and quality of signals collected, which ad formats are supported, and the environments where the tag can be deployed.
Tag types
There are two main types of detection tags: JavaScript-supported detection tags and non-JavaScript pixel tags.
JavaScript tags
JavaScript tags are ProductXYZ’s primary tag type. In order to function properly, these tags must be deployed in a JavaScript-enabled environment.
JavaScript tags include the following components:
- URL
- The URL of the server that delivers the tag.
- analytics.js
- A script that loads ProductXYZ's main payload.
- parameter list
- The [tag parameters] built into the body of the tag, separated by an ampersand (
&
) character. These parameters should be populated by your ad server. - async
- A Boolean that dictates whether the tag should load asynchronously from other page content. If its value is set to
true
, loading the ProductXYZ script will not slow down overall pageload times.
Pixel tags
Pixel tags offer a “slimmed-down” version of ProductXYZ. Pixel tags collect basic information using a server-side GET request and the parameters passed through the tag. Although these tags offer limited functionality, they are useful in situations where JavaScript tags are not supported.
Pixel tags include the following components:
- URL
- The URL of the server that delivers the tag.
- analytics.gif
- The actual pixel image (in GIF format).
- parameter list
- The [tag parameters] built into the body of the tag, separated by an ampersand (
&
) character. These parameters should be populated by your ad server.
Feature comparison
Although JavaScript tags and pixel tags both collect signals in support of ProductXYZ's traffic analysis, each tag type functions differently and offers unique capabilities.
- Maximum session time
- UTM codes
- Payload size
- Signal strength
- Environments
The maximum time it takes for ProductXYZ’s detection tags to finish collecting signals per impression.
- JavaScript tags: ProductXYZ grants JavaScript tags a maximum of two minutes to fully collect signals for each impression. However, most JavaScript tags will finish collecting signals in far less time. (Also note that JavaScript tags load asynchronously, so the amount of time it takes to collect signals should not impact overall site performance.)
- Pixel tags: Pixel tags finish collecting signals as soon as the tag is loaded.
How ProductXYZ collects data for UTM codes.
- JavaScript tags: JavaScript tags automatically collect UTM data if it is included in the URL of the impression’s referring domain.
- Pixel tags: UTM data must be passed as part of the pixel tag's parameters.
The size of each detection tag’s payload.
- JavaScript tags:
- Initial: ~2 KB (the detection tag)
- main.js: ~33 KB (the JavaScript function)
- Pixel tags: No payload
The quality and number of signals that each tag type collects.
- JavaScript tags: JavaScript tags collect the richest and strongest signals to power CompanyName’s analysis. We recommend using JavaScript tags whenever possible.
- Pixel tags: Pixel tags collect fewer signals than JavaScript tags. As such, we only recommend using pixel tags when Javascript tags aren't supported.
The environments supported by each tag type. (For more information, see Environments and ad formats below.)
- JavaScript tags: You can deploy JavaScript tags in desktop and mobile browsers for most ad types, including VAST 4.0 video ads. You can also deploy JavaScript tags for certain mobile app ads, like banners and rich media; however, native ads in mobile app environments are not rendered in a browser or web view and therefore do not support JavaScript tags.
- Pixel tags: You can deploy pixel tags in any environment, including desktop browsers, mobile browsers, mobile apps, and CTV devices.
Environments and ad formats
To get the most out of ProductXYZ, it's important to choose the right type detection tag to deploy alongside your ad.
- Desktop web
- Mobile web
- Mobile app
- CTV
In desktop web environments, we recommend the following tag types for each ad format:
- Banner ads: JavaScript tag
- Rich media: JavaScript tag
- Video (VAST 4.0): JavaScript tag
- Video (all others): Pixel tag
- Native ads: JavaScript tag
In mobile web environments, we recommend the following tag types for each ad format:
- Banner ads: JavaScript tag
- Rich media: JavaScript tag
- Video (VAST 4.0): JavaScript tag
- Video (all others): Pixel tag
- Native ads: JavaScript tag
In mobile app environments, we recommend the following tag types for each ad format:
- Banner ads: JavaScript tag
- Rich media: JavaScript tag
- Video: Pixel tag
- Native ads: Pixel tag
In CTV environments, we recommend the following tag types for each ad format:
- Banner ads: Pixel tag
- Video: Pixel tag