Identity Envelopes
How to obtain and use identity envelopes with the Sidecar.
In order to provide RampIDs and other identifiers 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 sample envelopes below:
Aj2olh5U_e77amPKcpHIFGcI1z3DUNE6eWeSDHGf_vLNroufB7bZFqUtG38yxkStRtV0P8DgBKQbMuOfuRqZvPh0-xECC-CZctZkITTQaqC3ByYJv9zZfmOuAB2nolnxclPznkQ7060u49q_2FMz2eOgGzHfJ3geNjj36hz9wm_aAH2f-BYJTyPrmYNvOiOXQwiZ-voLC84o6oRCqRs4RzuI7NtDBYpTKg6BIglaf-AqbsDCuan5_bTNgpIgOw5Ia1HGxsz10nNrzVKiBfzpgbLJsPt4mc-ZQMwaPW25CAV13pHHn8Ux4Ly6Foirry9f8qckQDgQzrcYBlz87h2xFsQFAIpXibApf8o_gDpWO4tpbOf5-tExKdQYjgT-mbX--Wu200UzHGX_foeWGwdBBofNokkNJeRaP8KaolOW-Tr9Hq5EaAvcWoow1gnUwkIKFA
ArCgQtEoXGmR7paqvG4tNcWlm-rxun6S1d5GDW7Ftem3howSUkXDM_kxQJEu8p3-2vVAoJvuOEIik57eeck-Mun0N7KCJ0fCc3we5QCN6DpbA3hMo3yhkgzAyZWwX4Wml0_L_z8LZ3_avqwofIs_FGOsvhNPOuJmIM7JNTDJr7ae2F5D93vAAKcL4csL3EchEV6cI0tUhyF6
AjSPT-fvhzDcD1Qmy8Wp3qCfgc4N1Es8Y0Kb2Co1SKa9lTicOyobhQOV6II1PGjY0XmZMN1GiO7sxrJ7osdhU_LkCEAu8iUKYA40topj6a2_s8_n86y5UilmP06dgF-_qQxzvIYs1RDtI2TsJOjvnp-zdB2Ifamvoyu4q5MOueGTpXOoxyI-N52qElXmG7aCqU8Kdda4Yn495xQppDRt004vzBfqY0US45AisJebcVrC0UdCflOeltEYHffp43VZvYnhc_BBC-smXCckS6heoB7cxvBY9TWRaGUiHNIzlpGbXo5voAH2XUY_0sMds_TnV-Y7Q6OLEHeA3aSs_vCmdaH10sAaqU0RIQ
AnMGBXG-ooVWikdVjFTV4Oirx53xHsBYb1a5W-HLmETJpH7A74N2e3QxzavzgnsbhibTXsfnagBoN_HFF5x6S7nQj5Ytvd3nExhr_UDjs3DPhZro71T0SlCjpCmqHMORCh3V_I9hiEHCgZrbAhi-ILPh7aTGIY7CtJhp44RKKB3TxA3xttfL24IKuyy3NqcyUX07iZCsO2TFK09nXKagVSI4XlSxzX0Tz7Sc-GyLBOdYo9F7J5ypTA0L-oc7umBgWpcarucKj_-OtDoKgWZ6UhcMKA
AgHxVkY0i5Lr2jSLYzwofhtJURKBCh0g3xv1UbSWQaN-zlGsR-pCDpqeAcliMGk5CFQiIsWyuLWaukrkjMF9xrPBXAWxyvGsKPJmQCyFtx2RnV_cAQs4MgAA4I0LdOpBT1aRSGRoDTmh5mmAdytC5r5C77IR_DLQducECSO2rwrtesp1KB9U0zBNgG0u7q05yCGK7ja4PDckzitOM59d7n6zclMQAOkzbbX-teLIlQ
AhYdWjnl6CMlauToSR3UQxTRPqgGV0OvbyjuqcMK-dLS0fEhr55fljMD9WcDt3vbiuWofpfpZWHEEBH2K9kJjrJ6f6aMg0DswGIt1C783azYeIyJdFbfqiQAxjQRc-1yFll0pQQ9WBZYcbkYy5V5_ZGNso9SYMMjWvjCrj8xWgucITDd4uOkUrHkaFS34Uit0V8FpBNgbW01qHUOU3Ubuz-BbcwKYb6HR-9n8ci_DlOQ5OKI_BlL_kNQqIxJunK_gBorokn1Ity-Y9GH1vOlhyMvdkJ63SzjSXNoiZ0I9JeuoQl2HM4lbK-cj4xbZ0dAT8kfFp1PTAO09z__kFmrrQ
AoEfKc_molisyUS6yzQay__ANFGQO6lW6HJv5uyUEOff79zHNrxEPCeaW7QW_rj_X-gJmtlYA4IlSZFsTgwIaXO-A3G0R94HKwatLp2H8e9273nNUiNLFlaSYFU9X6YlMXwK-Ra9b_fW0UWKsXGvL9f4KYD2OwMnLeK_06kZCoXEykJVosQLFopqNEqOvQiRtnU6RkqRmput4Eevxub7CzHedP73O-NMkLs_BiizYgpqMwGH2f0UFpEW8amxsWVvigsBGrC5AWdhwcklMxZJSEA47wi8CoQ8nVph3FjapAj4qqG2e8pHB7zr9e7YNLtMD30imKxEz3Pb9_NBsz2mmSDXoXpZfN81mg
These are created with a non-production Envelope key and will not work with a Sidecar synced to production services.
Prebid
If you integrate with Prebid, you can obtain envelopes directly from publishers. You will need to publish and update the 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 getLiveRampEids(bidRequests) {
return getEids(bidRequests, 'idl_env', 'liveramp.com', 'idl');
}
Code courtesy of Triplelift.
Many other popular header bidders (such as Pubmatic's OpenWrap, Washington Post's Zeus, and the Index Exchange wrapper) also support envelopes.
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 a cookie space.
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.
Cookie\tEnvelope
See more information about mapping files here.
Mobile Traffic
For native mobile inventory (IDFA, AAID, and hashed derivatives), LiveRamp offers mapping files to obtain identity envelopes.
These mapping files follow 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.
Connected TV Inventory
If you want to provide addressability against connected TV (CTV) inventory, LiveRamp needs to obtain device UUIDs (where applicable), IP addresses, and timestamps to feed its matching algorithm.
You can either provide this over an API endpoint or send batch files to LiveRamp 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 CTV device ID, don't include the &ctvid parameter.
Envelope Expiration
Envelopes are created with a 30-day time-to-live (TTL), or 15 days in California. This built-in expiration ensures that the Sidecar will take at most 15/30 days to enforce user opt-outs. Envelopes created within the TTL will not differ in their behavior. Envelopes created outside their TTL, when submitted to the Sidecar, will produce a 410, HTTP Gone response code.
Important
Care should be taken to avoid excessively caching envelopes. As a general rule of thumb, cache envelopes for no more than 24 hours.
Updated about 2 months ago