ID5 will provide you with a pixel that you can drop alongside other code you may deliver to publisher pages, such as a creative or other pixels. The ID5 pixel will call us with your UID included in the querystring and then initiate a synchronization process with other platforms that you have allowed.
Parameter | Type | Description |
---|---|---|
id5AccountNum | Integer | Your ID account number, provided by ID5 |
numCascadesAllowed | Integer | Number of additional platform calls allowed on the back of the initial synchronisation call to ID5 (step (4) above). We recommend setting this value to 9. |
Parameter | Type | Description |
---|---|---|
puid | String | Your unique ID for the user, encoded as a url parameter |
gdpr | Integer (optional) | Whether or not GDPR applies to this request. Accepted values are 0 or 1. |
gdpr_consent | String (optional) | A valid IAB TCF consent string. If the string is missing, misconstructed, or otherwise invalid, we will treat the request as if it has no consent string and process accordingly. |
gpp | String (optional) | A valid IAB Global Privacy Platform consent string. If the string is missing, misconstructed, or otherwise invalid, we will treat the request as if it has no consent string and process accordingly. |
gpp_sid | String (optional) | The GPP section ID(s) (integers) in force for the current transaction. In most cases, this field should have a single section ID. In rare occasions where such a single section ID can not be determined, the field may contain up to 2 values, separated by a comma. More information in GPP documentation |
us_privacy | String (optional) | A valid IAB US Privacy string. If the string is missing, misconstructed, or otherwise invalid, we will treat the request as if it has no US Privacy string and process accordingly. |
callback | String (optional) | A URL-encoded url that we will return back to at the end of the cascade chain. If you would like to receive the ID5 ID in this callback, include the macro {ID5UID} (properly encoded as %7BID5UID%7D ) in your url where you’d like to receive it).Please speak with your ID5 Account Manager or contact support@id5.io to enable this feature |
If you would like to use the callback
feature or if you would like to retrieve the ID5 ID, please let your ID5 representative know so we can configure your account accordingly. When executing usersync with a callback URL, ID5 will first cascade to available partners like usual, before issuing a 302 redirect back to the URL you provided. However, there are a few cases when ID5 will NOT redirect back to the URL provided, and instead, issue a 204 response.
In all examples below, we use AABBC12345
as the user ID that you would like to send to ID5.
Callback URL: https://dummyimage.com/600x250&text=HelloWorld
Callback URL: https://dummyimage.com/600x250&text=%7BID5UID%7D