Identity Envelopes

In order to provide IdentityLinks against impressions, you will need to obtain Identity Envelopes for any source of inventory you plan to enable.

If you'd simply like to test out the sidecar in dry-run mode, you may use the dummy envelopes below:

AnZGl_biYwUNkglgfKZiXMLv1YEYkzTFzkgTIQ17F_i3l4ruMEzWNJDDm1Ofv7c0ynB51uFQO9ytmMGuDX8N8I89s2s
AvxPba3hYg8fhI5mDwqteHbbM8dIPKcFQEJFgM6eHNrhdainPEp9W7tlp0FmcpvYrazjlj3eFmXCDRC5jZkERSya_9Q
AloA4v5Rt5V9SvLlyuAvyH7PMpVx0T88DPIMYSGQnb7UvHbKwd2C23GPix6YGzP5HtpFs0AwyxFHd1fkgpv1BW27v2U
ArFqU3dlcynID8gpmNExhtpVtzplJXmBCa3YB5IXnXqyWI-SYiTGoVP3gW8VOWuXHXP312pLHkQgix7ySNFKFLmgk-0
AutVJed5qoEQ6hvuS9OharoNa8tyk1Hoa2nz8hv-50SASJb7TkzxhgeHnknLDVXvs5GGv-8V_CUdtNztqQmLvwUxIlA
AqhOB339rXv6WLsadzSb31HruZOjJsrJ5gj3v4sY7tikwnL0mqunQaNt8PNuC6g2PIcuW4gXoPYERCxPvmEmOpdydm0
AlwdyzKblRFwXIYs91l7kjBPmQgQhUko-Cm_Inqg6dfh6RfDsie7i77UL6zxWRkSMpKQWNzzeAwVVfmZgBcCEh4CDcs
ArBw1SiZg4xcgah8pAFWVyTPHa0ck7oxUK2U5Uxr7AQP4JZUEZt-OM9vB4nrLE02yJ8gr3EcfkEzj4G9kEHik1BDdU0
AkaZOPaHwC_REZVXYSR7T3s4BAPRUvdWauDAz0119warRDeLkaSAWyR2fF9Frcd5Jsh1oOaXMxvt7shbxUdJabEcUjI
Aiu_4-PXUzOk125YbNmCVAS-TbAiFEBSApPeuvcRxon54sY05WEKNrxxkkKq_IGrDESuxhlgfLxBd3Xx7jvz5I0fdw8

These are created with a non-production envelope key.

Prebid

If you integrate with Prebid, you can obtain envelopes directly from publishers. You will need to publish and updated Prebid adapter and ask publishers to compile their version of Prebid (if self-hosted) with your new adapter. "Listening" for envelopes can be as simple as:

function getIdentityLinkEids(bidRequests) {
  return getEids(bidRequests, 'idl_env', 'liveramp.com', 'idl');
}

Code courtesy of Triplelift.

Web Traffic

For web traffic, there are three primary methods to map cookieable traffic to envelopes.

ID Sync Endpoint
LiveRamp can create a traditional cookie sync endpoint for you to call with traffic (e.g. https://id.rlcdn.com/12345.gif'), which will then redirect the traffic back with an identity envelope --if available-- to an endpoint you control.

CORS API
LiveRamp can provide a CORS API endpoint that can be called client-side to retrieve an envelope, if available.

You will call this endpoint (e.g. http://api.rlcdn.com/api/identity) and receive an envelope in a JSON response.

{"envelope":"AoRQflZhrdQi4HY9wnRa1sLX_ha1NHnQspz_7yygCKLBHtz1_nDtoIciCc2tiJDcmmT8MA"}

It's safe to cache the envelope response for up to 24 hours.

Mapping Files
We also offer mapping files to relate Identity Envelopes to one of the common cookie spaces: The Trade Desk (adsvr.org/Unified ID) and AppNexus.

These files are simple, batch flat files. We are flexible on file naming and formatting. These files are typically fully refreshed on a monthly basis with incremental deliveries sent daily. A sample of a cookie mapping file can be viewed below.

TDID\tEnvelope

See more information about IDL mapping files here.

Mobile Traffic

For native mobile inventory (IDFA, AAID and hashed derivatives) we offer mapping files to obtain identity envelopes.

These mapping files following the same pattern laid out for web traffic above, with the important distinction that mobile mapping files are smaller and more static than web files.

CTV Inventory

If you wish to provide IdentityLinks against CTV inventory, we will need to obtain device UUIDs (where applicable), IP addresses and timestamps to feed our matching algorithm.

You can either provide this over an API endpoint, or by sending us batch files with the necessary information.

Pixel/API

Your request should look like the following:

http(s)://tv.rlcdn.com/api/ctvid?pid=<PID>&ctvid=<CTVID>

<PID> is the pixel ID provided by your LiveRamp Account Manager and <CTVID> is the Connected TV device ID of the calling device.

If the pixel is not being called within a VAST Wrapper: Include an X-Forwarded-For header with each request so that we receive the IP address of the device making the request.

If there is no Connected TV device ID present then do not include the &ctvid parameter.

Batch Files
Please view documentation here.

Envelope Expiration

Beginning in November 2019, envelopes are created with a 30-day time-to-live (TTL). This built-in expiration ensures that the Sidecar will take at most 30 days to enforce user opt-outs. Envelopes created within the last 30 days will not differ whatsoever in their behavior compared to pre-v1.0.3 processing. Envelopes created more than 30 days previously, when submitted to the Sidecar, will produce a 410, HTTP Gone response code.

As a result of this release, care should be taken to avoid excessively caching envelopes. As a general rule of thumb, cache envelopes for no more than one week to err on the side of caution.