Knowledgebase: E-Planning Exchange
e-planning exchange User Sync Specifications
on 20 April 2016 04:03 PM
Currently, in an OpenRTB 2.3 bid request, two user ids are sent in the user field of the bid request:

id: E-Planning Exchange user id will always be sent.
buyeruid: DPS user id will be sent if the user is synchronized in E-Planning Exchange.

For example:

User":{
          "id":"f58da0059096a2ed",
          "buyeruid":"61538db9-16d7-4e4d-a8c8-f0a443d15f12"
}

To accomplish user synchronization, the DSP partner must provide a URL that redirects to an e-planning exchange endpoint sending the DSP user id replacing a macro in the url arguments.

When a non-synchronized user sees an e-planning ad, e-planning exchange will set a pixel in the user’s browser that points to the DSPs user sync url. Then the DSP partner must replace the user id macro in the url and redirect to the e-planning exchange endpoint. Then, e-planning exchange will save the user id relation and can start to send the buyerid field for that user in future bid requests.

E-planning exchange can provide the user sync endpoint url in two ways:

  1. A static url that the DSP must save in its servers.
  2. A dynamic url that will be sent as url argument in the DSP user sync url.

Example for case 1:

  1. E-Planning exchange provides a static url like: http://sync.e-planning.net/um?uid=USER_ID&dc=9bcc91305985f0db
  2. The DSP must save the previous url on their servers.
  3. The DSP must provide a user sync url.
  4. When a non synchronized user sees an ad, e-planning exchange will send an image pixel pointing to the DSP user sync url.
  5. The user browser will activate the pixel and call the DSP user sync url.
  6. The DPS gets the request, identifies the user, replaces the USER_ID macro in the e-planning user sync url and then returns a redirect to that url.
  7. The user browser will redirect to e-planning exchange user sync url, sending the DSP user id as a url argument and the e-planning user user id in the cookie.
  8. E-Planning exchange saves the user ids relation and can start sending the buyerid for that user.

Example for case 2:

  1. The DSP must provide a user sync url that looks like: http://pixel.dsp.com/pixelSync?rurl=REDIRECT_URL
  2. When a non-synchronized user sees an ad, e-planning exchange will send an image pixel pointing to the DSP user sync url, replacing REDIRECT_URL with e-planning user sync endpoint that looks like: http://pixel.dsp.com/pixelSync?rurl=http://sync.e-planning.net/um?uid=USER_ID&dc=9bcc91305985f0db
  3. The DPS get the request, identifies the user, obtains the e-planning user sync url from the url argument, replaces the USER_ID macro and returns a redirect to that url.
  4. The user browser redirects to e-planning exchange user sync url sending the DSP user id as a url argument and the e-planning user user id in the cookie.
  5. E-Planning exchange saves the user ids relation and can start sending the buyerid for that user.

 

 

Notes:

  • Is recommended that the DSP user sync url support HTTPs.
  • E-Planning exchange support configuring multiples DSP user sync endpoints for differents locations.
  • Users can be resynchronized by configurable intervals.
(0 votes)
This article was helpful
This article was not helpful