Overview

LiveRamp is an identity resolution platform that provides data onboarding and connectivity services. It connects campaign exposure data, offline purchase data, and third-party data at the consumer level to help create a unified view of customer activity.

Integrating Lytics with LiveRamp lets you leverage Lytics insights, behavioral data, and content affinities with LiveRamp's identity resolution to better understand and target your consumers.

๐Ÿ“˜

Before starting a workflow, it's important to understand the terminology differences of โ€œaudiencesโ€ and "segments" between LiveRamp and Lytics:

  • LiveRamp โ€œaudiencesโ€ are a collection of users included for cross-device identity resolution. The corresponding concept in Lytics is the file being exported from Lytics into LiveRamp.

  • Lytics โ€œaudiencesโ€ are sent as attributes (columns) within the file exported to a single LiveRamp audience. Each Lytics audience inside a file will become a โ€œsegmentโ€ in LiveRamp.

Authorization

If you haven't already done so, you will need to setup a LiveRamp account before you begin the process described below. There are additional configuration steps that will need to be done in LiveRamp before the exported file can be fully processed. Reach out to your technical point of contact at LiveRamp to complete this configuration.

If you are new to creating authorizations in Lytics, see the Authorizations documentation for more information.

  1. Select LiveRamp from the list of providers.
  2. Select one of the following methods for authorization:
  3. Enter a Label to identify your authorization.
  4. (Optional) Enter a Description for further context on your authorization.
  5. Complete the configuration steps for your authorization. These steps will vary by method.
  6. Click Save Authorization.

S3 CSV Authorization

Follow the steps below if you want to drop the file in a S3 bucket before importing into LiveRamp.

  1. Select Enter AWS Keys.
  2. In the Access Key box, enter your AWS S3 access key.
  3. In the Secret Key box, enter your AWS S3 secret key.

SFTP CSV Authorization

Follow the steps below if you want to drop the file on an SFTP server before importing into LiveRamp.

  1. Click LiveRamp SFTP Server with Username/Password.
  2. In the Host box, enter the host name or IP address of the SFTP server you want to upload to.
  3. In the Port box, enter the port number for the SFTP server.
  4. In the Username box, enter the username for the SFTP server.
  5. In the Password box, enter the password for the SFTP server.
  6. In the Folder box, enter the relative path to the folder to place the CSV. Contact your technical point of contact at LiveRamp to ensure this directory is in place.

Export Audiences (S3)

Exporting user profiles and audience membership to LiveRamp allows you use behavioral data, content affinities, and insights from Lytics combined with LiveRamp's identity resolution to fine-tune your targeting. Export your audience to S3 in a LiveRamp CSV format. Use S3 to stage your files before importing into LiveRamp.

Integration Details

  • Implementation Type: Server-side Integration.
  • Implementation Technique: File Based Transfer Integration.
  • Frequency: Batch Integration with Backfill, frequency can be configured.
  • Resulting data: User Profiles and audience membership.

Data is exported as a CSV with a header row. The columns are an identifier field in the first column, followed by user profile fields, followed by audience membership. Audience membership is represented by columns containing the digit 1 if the user is a member of that audience and blank if not. Headers for the audience membership columns are the audience slugs.

This integration operates by creating a CSV file in S3 to be imported by LiveRamp. Once started, the integration will:

  1. Create a multipart upload in the selected S3 bucket.
  2. Write CSV headers to the S3 file.
  3. Scan the audience and process users into CSV lines.
  4. Write CSV lines to the S3 file.
  5. Complete a multipart upload after writing all users to the file.
  6. Schedule the next run.
  7. LiveRamp imports the file for processing. See LiveRamp's documentation for details on setting up LiveRamp to import the file.

๐Ÿ“˜

It usually takes 1-2 days for a file to fully process into LiveRamp, another 1-2 days to distribute that audience to ad platforms, then another 1-2 days for statistics on match rates to be available in the LiveRamp UI. So, for a first time setup end-to-end, it can take about a week.

Fields

By default, Lytics will export the full user profile and audience membership to LiveRamp. Note that you can customize the Lytics source fields as part of the job configuration:

Lytics User FieldDescriptionLiveRamp FieldType
emailEmail Addressemailstring
N/Aaudience membershiplytics_audience_slugint

Configuration

Follow these steps to set up and configure an export of LiveRamp in the Lytics platform. If you are new to creating jobs in Lytics, see the Destinations documentation for more information..

  1. Select LiveRamp from the list of providers.
  2. Select the Export Audiences (S3) job type from the list.
  3. Select the Authorization you would like to use or create a new one.
  4. Enter a Label to identify this job you are creating in Lytics.
  5. (Optional) Enter a Description for further context on your job.
  6. From the Audiences input, select the audience(s) that contains the users to export.
  7. From the S3 Bucket Name input, select the bucket to save your file in. If no buckets are listed, enter the bucket name in the field below.
  8. From the S3 Bucket Name (Alt) text input, enter the S3 bucket name here if no buckets are listed above. This may occur if your access token does not have permission to list S3 buckets.
  9. From the Directory input, choose the directory to save your file in. This option can be slow on large S3 buckets.
  10. From the Identifier input, select the field that will be placed in the first column of the file. This field should be a unique identifier and be selected in the Fields to export.liveramp-s3-export-config-1
  11. Click on the Show Advanced Options tab to expand the advanced configuration.
  12. From the Filename text input, enter the name of the file to upload. {TIMESTAMP} will be replaced by the timestamp when the export occurred, in Unix format.
  13. From the Timestamp format input, select the format for the timestamp in the filename.
  14. From the Audience Membership input, select the audiences to include in the audience membership.
  15. From the Compress input, select your compression preference for the exported file.liveramp-s3-config-2.0
  16. Select the Additional Audiences checkbox to add a column containing all the audiences a user is a member of.
  17. From the Fields to Export input, select the user fields to export.
  18. From the Custom Delimiter text input, enter a custom delimiter for your file. The default is a comma, a recommended alternate is a pipe "|".liveramp-s3-config-2.5
  19. From the Custom Join input, enter a custom join character for fields that have multiple values. The default is "&". E.g. [email protected]&[email protected].
  20. Select the Continuous Export checkbox to export the audience repeatedly.
  21. From the File Export Frequency input, select how often a continuous export should create a new file.
  22. From the Time of Day input, select the time of day to start the export each day. This applies to daily, weekly, and monthly frequencies only.
  23. From the Timezone input, select the timezone for time of day.
  24. Click Start Export.
    liveramp-s3-config-3.0

Export Audiences (SFTP)

Exporting user profiles and audience membership to LiveRamp allows you use behavioral data, content affinities, and insights from Lytics combined with LiveRamp's identity resolution to fine-tune your targeting. Export your audience to an SFTP server in a LiveRamp CSV format. Use SFTP to stage your files before importing into LiveRamp.

Integration Details

  • Implementation Type: Server-side Integration.
  • Implementation Technique: File Based Transfer Integration.
  • Frequency: Batch Integration with Backfill, frequency can be configured.
  • Resulting data: User Profiles and audience membership.

Data is exported as a CSV with a header row. The columns are an identifier field in the first column, followed by user profile fields, followed by audience membership. Audience membership is represented by columns containing the digit 1 if the user is a member of that audience and blank if not. Headers for the audience membership columns are the audience slugs.

This integration operates by creating a CSV file formatted for LiveRamp on an SFTP server so it can be imported by LiveRamp. Once the integration is started it will:

  1. Connect to the SFTP server.
  2. Navigate to the configured folder in the SFTP server.
  3. Create a CSV file in the SFTP server.
  4. Write CSV headers to the file.
  5. Scan the audience and process users into CSV lines.
  6. Write CSV lines to the file.
  7. Close the completed file and disconnect from the SFTP server.
  8. Schedule the next run.
  9. LiveRamp imports the file for processing. See LiveRamp's documentation for details on setting up LiveRamp to import the file.

๐Ÿ“˜

It usually takes 1-2 days for a file to fully process into LiveRamp, another 1-2 days to distribute that audience to ad platforms, then another 1-2 days for statistics on match rates to be available in the LiveRamp UI. So, for a first time setup end-to-end, it can take about a week.

Fields

By default, Lytics will export the full user profile and audience membership to LiveRamp. Note that you can customize the Lytics source fields as part of the job configuration:

Lytics User FieldLiveRamp FieldType
emailemailstring
N/Alytics_audience_slugint

Configuration

Follow these steps to set up and configure an export of LiveRamp in the Lytics platform. If you are new to creating jobs in Lytics, see the Destinations documentation for more information.

  1. Select LiveRamp from the list of providers.

  2. Select the Export Audiences (SFTP) job type from the list.

  3. Select the Authorization you would like to use or create a new one.

  4. From the Audiences input, select the audience(s) that contains the users to export.

  5. From the Identifier input, select the field that will be placed in the first column of the file. This field should be a unique identifier and be selected in the Fields to export.
    liveramp-sftp-export-config-1

  6. Click on the Show Advanced Options tab to expand the advanced configuration.

  7. From the Audience membership input, select the audiences to include in the audience membership.

  8. Select the Append Segment Name checkbox to add a field with the audience name.

  9. Select the Additional Segments checkbox to add a column containing all the audiences a user is a member of.
    liveramp-sftp-p1

  10. From the Fields to Export input, select the user fields to export.

  11. From the Custom Join input, enter a custom join character for fields that have multiple values. The default is "&". E.g. [email protected]&[email protected].

  12. Select the Continuous Export checkbox to export the audience repeatedly.

  13. From the File Export Frequency input, select how often a continuous export should create a new file.

  14. From the Time of Day input, select the time of day to start the export each day. This applies to daily, weekly, and monthly frequencies only.

  15. From the Timezone input, select the timezone for time of day.

  16. Click Start Export.
    liverramp-sftp-p2

Export Audiences (EU Format)

Exporting user profiles and audience membership to LiveRamp allows you to use behavioral data, content affinities, and insights from Lytics combined with LiveRamp's identity resolution to fine-tune your targeting.
Export your audience to an SFTP server in a LiveRamp CSV EU format. Use SFTP to stage your files before importing into LiveRamp.

Integration Details

  • Implementation Type: Server-side Integration.
  • Implementation Technique: File Based Transfer Integration.
  • Frequency: Batch Integration with Backfill, frequency can be configured.
  • Resulting data: User Profiles and audience membership.

This job exports the user profiles as a CSV file. The CSV file format is specific and follows the Liveramp EU CSV format. The number of User Fields that will be exported is limited. We also append an audience column which will contain the Lytics audience name or slug the user is part of and can be configured.

This integration once started it will:

  1. Connect to the SFTP server.
  2. Navigate to the configured folder in the SFTP server.
  3. Create a CSV file in the SFTP server.
  4. Write CSV headers to the file.
  5. Scan the audience and process users into CSV lines.
  6. Write CSV lines to the file.
  7. Close the completed file and disconnect from the SFTP server.
  8. Schedule the next run.
  9. LiveRamp imports the file for processing. See LiveRamp's documentation for details on setting up LiveRamp to import the file.

Fields

We follow the Liveramp SFTP file format to create the SFTP file. Following table shows the fields that can be mapped and exported. By default, none of the below fields are mapped except for Customer ID which will be filled by the Unique Identifier. Note that you can customize the Lytics source fields as part of the job configuration.

Lytics User FieldDescriptionLiveRamp FieldType
Any (Unique ID)Field that is unique to each UserCustomerIDstring
AnyLytics FieldFIRSTNAMEstring
AnyLytics FieldLASTNAMEstring
AnyLytics FieldADDRESS1string
AnyLytics FieldADDRESS2string
AnyLytics FieldADDRESS3string
AnyLytics FieldADDRESS4string
AnyLytics FieldTOWNstring
AnyLytics FieldPOSTCODEstring
AnyLytics FieldEMAIL1string
AnyLytics FieldEMAIL2string
AnyLytics FieldEMAIL3string
AnyLytics FieldMOBILE1string
AnyLytics FieldMOBILE2string
AnyLytics FieldLANDLINE1string
AnyLytics FieldMD5EMAIL1string
AnyLytics FieldMD5EMAIL2string
AnyLytics FieldMD5EMAIL3string
AnyLytics FieldSHA1EMAIL1string
AnyLytics FieldSHA1EMAIL2string
AnyLytics FieldSHA1EMAIL3string
AnyLytics FieldSHA256EMAIL1string
AnyLytics FieldSHA256EMAIL2string
AnyLytics FieldSHA256EMAIL3string
Audience Name 1 (slug)Audience NameAudience Name 1 (slug)string
Audience Name 2 (slug)Audience NameAudience Name 2 (slug)string

Configuration

Follow these steps to set up and configure an export of LiveRamp data in EU format in the Lytics platform. If you are new to creating jobs in Lytics, see the Destinations documentation for more information.

  1. Select LiveRamp from the list of providers.
  2. Select the Export Audiences (EU Format) job type from the list.
  3. Select the Authorization you would like to use or create a new one.
  4. From the Audiences input, select the audience(s) that contains the users to export.
  5. From the Identifier input, select the field that will be placed in the first column of the file as CustomerID. This field should be a unique identifier.
  6. Use the Field Mapping input to map Lytics fields to Liveramp fields. Select Lytics data fields from the left drop-down list and Liveramp fields from the right drop-down list.
  7. In the Header For Lytics Audiences textbox, enter the column name for the field that will be populated with Lytics audience slug. By default, the column name is set to lytics_audiences.
  8. Check the Send Audience Name checkbox to send the Lytics audience name instead of Lytics audience slug. Lytics audience slug is the readable form of Lytics Audience. For example: if Engaging Customer for ABC Product is the Lytics audience name then, its slug could be engaging_customer_for_abc_product. You can also edit Lytics audience to set the slug you want.
  9. Check the Continuous Export checkbox to export the audience repeatedly.
  10. In the Custom Delimiter textbox, enter the delimiter for the file to be exported.
  11. In the Filename textbox, provide the desired filename for the CSV file to be exported.
  12. From the Timestamp Format drop-down, select the desired timestamp format that would be appended in the provided filename above.
  13. From the File Export Frequency input, select how often a continuous export should create a new file.
  14. From the Time of Day input, select the time of day to start the export each day. This applies to daily, weekly, and monthly frequencies only.
  15. From the Timezone input, select the timezone for time of day.
  16. Click Start Export.liveramp-eu-export

Export Identifier

Upload user identifier like RampID, Cookie ID or Mobile ID to leverage LiveRamp's Identity Resolution to improve the ads campaign.

Integration Details

  • Implementation Type: Server-side Integration.
  • Implementation Technique: File Based Transfer Integration.
  • Frequency: Batch Integration with Backfill, frequency can be configured.
  • Resulting data: User Identifier and audience membership.

This job exports the identifiers as a CSV file. The CSV file format is specific and follows the LiveRamp's file format. The csv file will have two columns: one for the identifier and the other for the Lytics audience name that the user is part of. In the case of multi audience export, multiple lines (one for each audience) are added for the user if the user is part of multiple audience.

Once the integration is started it will:

  1. Connect to the LiveRamp's SFTP server.
  2. Navigate to the configured folder in the SFTP server.
  3. Create a CSV file in the SFTP server.
  4. Write CSV headers to the file.
  5. Scan the audience and process users into CSV lines.
  6. Write CSV lines to the file.
  7. Close the completed file and disconnect from the SFTP server.
  8. Schedule the next run.

Fields

By default, Lytics will export the user identifier and audience membership to LiveRamp. Note that you can customize the Lytics source fields as part of the job configuration:

Lytics User FieldLiveRamp FieldType
AnyIDENTITYLINK(RampID) | COOKIEID | MOBILEIDstring
N/Alytics_audiencesstring

Configuration

Follow these steps to set up and configure an export of LiveRamp data in EU format in the Lytics platform. If you are new to creating jobs in Lytics, see the Destinations documentation for more information.

  1. Select LiveRamp from the list of providers.
  2. Select the Export Identifier job type from the list.
  3. Select the authorization you would like to use or create a new one.
  4. From the Audiences input, select the Lytics audience(s) that contains the users to export.
  5. From the Identifier Type input, select the type of identifier you would like to export.
  6. From the Identifier Field input, select the Lytics user field that has identifier for above type.
  7. Check the Continuous Export checkbox to export the audience repeatedly.
  8. From the File Export Frequency input, select how often a continuous export should create a new file.
  9. From the Time of Day input, select the time of day to start the export each day. This applies to daily, weekly, and monthly frequencies only.
  10. From the Timezone input, select the timezone for time of day.
  11. Click Start Export.

RampID Enrichment

Enrich Lytics users to add RampID to their user profile. Use this RampID to identify consumers to target with more relevant ad campaigns.

Integration Details

  • Implementation Type: Server-side Integration.
  • Implementation Technique: REST API Integration - Audience Trigger Integration.
  • Frequency: Real-time Integration.
  • Resulting data: User Fields, Raw Event Data.

This integration uses the LiveRamp API to acquire the RampID for the envelope belonging to the user. Please refer to the documentation on Ramp IDs to learn more about it.

Each job run will proceed as follows:

  1. Creates a temporary Lytics Audience with users that have LiveRamp envelope ID configured during job creation.
  2. Sends the envelope ID to LiveRamp's Envelope Decryption endpoint to acquire the user's RampID.
  3. Sends the user's RampID data along with their envelope ID to stream liveramp_id_enrich so that it can be mapped as a user profile field.

Once the ID is enriched, it is refreshed whenever the envelope ID is changed.

Fields

The following fields are included in the default mapping of the liveramp_id_enrich stream:

Source FieldLytics User FieldDescriptionType
rampidramp_idLast LiveRamp IDstring
rampid_tsrampid_tsLiveRamp ID Last Updated Timedate
set(ramp_id)ramp_idsqAll LiveRamp IDs[]string
set(ramp_envelope)ramp_envelopesAll LiveRamp Envelopes[]string

Configuration

Follow these steps to set up and configure an enrich job for Liveramp in the Lytics platform.

  1. Select LiveRamp from the list of providers.
  2. Select the RampID Enrichment job from the list under the Enrich category.
  3. Select the Lytics Managed Key authorization type.
  4. Enter a Label to identify this job you are creating in Lytics.
  5. (Optional) Enter a Description for further context on your job.
  6. From the Envelope ID Field input, select the Lytics user field that contains LiveRamp Envelope ID.
  7. Click Start Enrich.
    liveramp-enrichment

Collect LiveRamp Envelope via ATS

Associate a Lytics profile with a LiveRamp encrypted envelope as a means to power the LiveRamp RampID Enrichment integration. This approach should be leveraged only when a known identifier is present such as email.

Integration Details

  • Implementation Type: Client-side Integrations.
  • Implementation Technique: Client-side Integrations JavaScript Tag Integration
  • Frequency: Real-time Integration.
  • Resulting data: Event

Implementation

๐Ÿšง

Ensure that your website is already configured with the LiveRamp ATS tag. Implementation of this tag is outside of the pervue of Lytics but is a requirement to collect and send the envelope from your customer's browser to Lytics.

Option 1

Option 1 for implementation is recommended. This option leverages an event listener to send ATS envelope information to Lytics as soon as it is received from ATS. Additional information about this approach is available in LiveRamps documentation.

window.addEventListener("fbEnvelopePresent", async () => {
   const envelope = await ats.retrieveEnvelope(undefined, '_lr_fb_env');
   try{
      var parsedEnvelope = JSON.parse(envelope);
      if(parsedEnvelope.envelope !== ''){
         jstag.send('default', {'liveramp_idl': parsedEnvelope.envelope});
      }
   }catch(e){
      console.log("Error parsing and deliverying envelope to Lytics: ", e);
   }
});

Option 2

Option 2 for implementation is focused on sending data to Lytics if you are confident that an ATS-managed envelope will already be in place when the page loads. It is always best to consult with your web development team to ensure that suggested implementation patterns are compatible with your environment(s).

ats.retrieveEnvelope((envelope)=>{
   try{
      var parsedEnvelope = JSON.parse(envelope);
      if(parsedEnvelope.envelope !== ''){
         jstag.send('default', {liveramp_idl: parsedEnvelope.envelope});
      }
   }catch(e){
      console.log("Error parsing and deliverying envelope to Lytics: ", e);
   }
})

Collect LiveRamp Envelope via RTIS

Associate a Lytics profile with a LiveRamp encrypted envelope as a means to power the LiveRamp RampID Enrichment integration. This approach should be leveraged when there is no known identifier present.

Integration Details

  • Implementation Type: Client-side Integrations.
  • Implementation Technique: Client-side Integrations JavaScript Tag Integration
  • Frequency: Real-time Integration.
  • Resulting data: Event

Implementation Steps

  • Configure Endpoint for Receiving Pixel & UID Link
  • Configure Client Side Pixel

Configure Endpoint for Receiving Pixel & UID Link

Upon completion, a tracking pixel will be initialized to a LiveRamp domain (we'll cover this in step 2). LiveRamp will associate the anonymous _uid from Lytics with their Ramp Envelope and return that association to an API endpoint at Lytics. To get started, we must ensure that LiveRamp sends the link data to the proper Lytics endpoint and your account is configured to receive and associate that data with user profiles.

  1. (Required) Provide proper URL to the LiveRamp team for forwarding RTIS pixel call to (Manged in LiveRamp).

    https://c.lytics.io/provider/liveramp
    
  2. (Optional) Stream configuration
    By default, all link data will be delivered to the liveramp_idl data stream. If you would like this data to be delivered to an alternate stream, you can configure the account setting liveramp_idl_stream to point to your desired stream.

  3. (Required) Map link data to your user profiles.
    For each identity that is linked, the configured stream will receive the following key/value pairs:

    1. origin_acct: the full ID of the account for which the initial request was made.
    2. _uid: the user in question anonymous Lytics web cookie.
    3. liveramp_idl: the LiveRamp Envelope associated with the _uid.
      Though you may map this data any way you see fit, we highly recommend following this pattern:
      SELECT
            epochms()               AS lr_idl_timestamp             SHORTDESC "Date of Resolution"          KIND DATE
            , origin_acct           AS lr_origin_acct               SHORTDESC "Account of Origin"
            ,liveramp_idl           AS last_ramp_envelope           SHORTDESC "Last LiveRamp Envelope"           
       
      --BY FIELDS
            , set(_uid)             AS _uids                        SHORTDESC "Web Cookie Ids(all)"                     KIND []string
            ,set(liveramp_idl)      AS ramp_envelopes               SHORTDESC "All LiveRamp Envelopes"        KIND []string
       
      FROM liveramp_idl
      INTO user
      BY _uids OR ramp_envelopes
      ALIAS liveramp_idl
      

Configure Client Side Pixel

RTIS leverages a cookie sync integration between Lytics and LiveRamp. Below is an example implementation. It is always best to consult your web development team to ensure the proper checks and balances are in place to prevent unplanned errors and impacts on site traffic based on your unique environment.

jstag.getid(function(id){
   // ensure a valid _uid is available
   if(id === ''){
      console.warn('Lytics ID is empty');
      return;
   }

   // ensure we haven't recently envoked this integration
   var previouslySent = jstag.getCookie("lyticsLrIdl")
   if(previouslySent !== ''){
      console.log('liveramp idl integration already sent');
      return;
   }

   // add pixel
   var src = '[liveramp_pixel_url]' + '?cparams=' + jstag.config.cid[0] + '-' + id;
   var img = document.createElement("img");
   img.src = src;
   img.style = "display:none;"
   document.body.appendChild(img);

   // set a cookie to prevent envoking pixel again within the next week
   jstag.setCookie("lyticsLrIdl", id, 604800)
});

๐Ÿ“˜

The liveramp_pixel_urlwill be provided by the LiveRamp team and generally will look similar to the following https://id.rlcdn.com/xxxxxxxx.gif.