Overview
Audience data providers can integrate with Equativ to allow for audience targeting, as explained in the
Audience data — batch file integration /
Audience data — API integration articles. For these integrations, data providers must synchronize their user identifiers with Equativ. The synchronization is initiated by
- the data provider, as explained in this article - or
- by Equativ – available upon request; reach out to Equativ's partner integration team for further guidance if you are interested in this mode
In both cases, the data provider must host a matching table which contains the data provider's user IDs and the matching Equativ user IDs.
User synchronization initiated by data provider
Setup and workflow
To get the Equativ user IDs, the data provider must call the following endpoint:
https://<base_url>/<endpoint>?url=<callback>
Make sure you replace <base_url>/<endpoint> by the actual base URL and endpoint - you will receive these from your contact at Equativ.
The <callback> parameter is specific to each data provider. It must be encoded and must contain the keyword [sas_uid], e. g.:
https://<base_url>/<endpoint>?url=https%3A%2F%2Fwww.thirdparty.com%2Fusersync%3Fuid%3D[sas_uid]
When the URL is called, Equativ will respond with a 302 redirection to the specified <callback> URL. Equativ will not redirect to the <callback> URL if the given end user does not have any Equativ user ID (user unknown to Equativ).
In the <callback> URL, Equativ will replace the keyword [sas_uid] by the actual Equativ user ID, e. g. 123456789. The data provider can retrieve this Equativ user ID and store it in the matching table along with the data provider's user ID.
GDPR compliance
The privacy framework GDPR of the European Union requires appropriate legal basis granted by the end user for the processing of personal data (more details here).
To comply with the GDPR, the user ID synchronization call must contain information if the GDPR applies or not (end user located in the EU or not) as well as the TCF transparency & consent string (as specified by the IAB Europe).
Non-EU users
In case of end users located outside of the EU (GDPR does not apply), the call must contain gdpr=0, e. g.:
https://<base_url>/<endpoint>?gdpr=0&url=https%3A%2F%2Fwww.thirdparty.com%2Fusersync%3Fuid%3D[sas_uid]
<base_url>/<endpoint> must be replaced by the actual base URL and the endpoint (provided by Equativ upon request).
EU users
In case of end users located inside the EU (GDPR applies), the call must contain gdpr=1, as well as the TCF transparency & consent string itself (gdpr_consent=) e. g.:
https://<base_url>/<endpoint>?gdpr=1&gdpr_consent=CO5YU61O5YU7OBcABBENA1CoAP_AAH_AAAqIGSQJwABAALAAeABUADIAIIAUgBUAC2AGgAagBEAC3AGEAYgA5ACEAE6ALgAY4A9AB-gEDAIQAR0AngBVwC6gGBAMIAaIA2gCPQEvAJiAT-AowBcwC8wGLgMZAZIBkkBcAAQACwAHgAVAAyACAAFQANAAiABiAEIAP0AgYBCACrgF1AMCAYQA2gCPQExALzAZIAAA&url=https%3A%2F%2Fwww.thirdparty.com%2Fusersync%3Fuid%3D[sas_uid]
User synchronization initiated by Equativ
The user synchronization process can also be initiated by Equativ, instead of the data provider. If you are interested in this mode, reach out to Equativ's partner integration team for further instructions. Note that you will still have to host a matching table that contains the data provider's user IDs and the matching Equativ user IDs.
