User Sync
Our user sync pixel can be used in all environments to return our user ID to your system. Our pixel has some optional parameters which will improve coverage.
The URL can be included directly in HTML, or called via javascript. See below for examples.
AcceptHeaderOur sync endpoint will return a different response based on the value of the
Acceptheader received. This means that if you paste our URL into the browser address bar, you will by default receive an HTML response, which will appear as a blank page (because the HTML contains only javascript). You can validate this in the developer tools / network panel.
Accept Header Contains Response Type */*Javascript text/htmlHTML image/Image/PNG
Sync Pixel URL
https://sync.a-mo.net/cchain?gdpr={GDPR_APPLIES}&gdpr_consent={TCF_CONSENT_STRING}&us_privacy={US_PRIVACY}&gpp={GPP_STRING}&gpp_sid={GPP_SID}&cb={REDIRECT_URL}Macro | Example | Description |
|---|---|---|
GDPR_APPLIES | 1 | 1 or 0, indicating if GDPR applies to this user |
TCF_CONSENT_STRING | CPAkinoPAkinoAKA... | A full IAB TCFv2 Consent String |
US_PRIVACY | 1YYN | |
GPP_STRING | DBACNMA~CQaT2U... | A full IAB GPP String |
GPP_SID | 2 or 2%2C8 | A URI encoded, comma-separated list of GPP section ids apply to the current transaction. Generally will contain one and only one value, but there are edge cases where more than one may apply |
REDIRECT_URL | https%3A%2F%2Fpublisher-example.com%2Fsetuid%3Fuid%3D | A URI-encoded full URL where we will return our user ID. We'll append our user ID to the end of this url. For example, if you pass: https://publisher-example.com/setuid?uid= We'll call https://publisher-example.com/setuid?uid=affeeb32h33ka Note that this call will be made client-side. |
None of these parameters are required, but either GPP_STRING & GPP_SID or GDPR_APPLIES & TCF_CONSENT_STRING are strongly recommended.
Executing the sync pixel
Our pixel requires a standard GET request. You can easily embed it in HTML by including it as an <img> tag
<img src="https://sync.a-mo.net/cchain?gdpr=0&gdpr_consent=&us_privacy=&cb=https%3A%2F%2Fpublisher-example.com%2Fsetuid%3Fuid%3D" width="0" height="0" />The simplest way to call the pixel in javascript is by requesting it as an Image:
// fire as an Image
new Image().src = 'https://sync.a-mo.net/cchain?gdpr=0&gdpr_consent=&us_privacy=&cb=https%3A%2F%2Fpublisher-example.com%2Fsetuid%3Fuid%3D';Updated about 1 month ago
