Skip to main content

Using a Universal File for Multiple Conversions API Programs

With LiveRamp's Partner Conversions API programs, you can often use one universal file for most or all of your conversion programs.

See the sections below for more information on using a universal file for your conversion data files.

Using the Universal File Template

To make things easier for you, we've created a universal file template that you can use.

Note

The template contains formatting instructions in the second row of the file, along with info on whether a column is required and whether values are required, depending on which conversion programs you're using. You can also refer to the information in the "List of All Universal File Columns" section below.

  1. Download the file template by clicking here.

  2. If desired, you can remove any non-required columns that aren't utilized by one of your conversion programs, but you can also leave those columns in the file and not populate them with values.

  3. Transfer your data into the template.

  4. After transferring your data into the file template, delete the second row with the formatting instructions.

  5. Save the file as one of our allowed file types (.csv, .tsv, .psv, or .txt).

  6. Upload the file to LiveRamp.

Situations That Require Additional Files

There are some situations where we recommend creating separate files or a completely new file. This is to ensure that there are no disruptions to your existing conversion feeds.

If you're working with any of the conversion programs listed below, you might need to create additional files or use a different file template:

Note

When you're sending multiple files, make sure to name each file distinctly so that it's easier for us to send the data to the correct programs.

  • The Trade Desk: If you have multiple values for the transaction category field, then you will need to create a separate file for each value. This is to ensure that LiveRamp does not remove any event data.

  • Facebook or Meta Conversions API Program for Offline Conversions:

    • If you're sending RampIDs, AbiliTec IDs, MAIDs, or CIDs, you need to send those in a separate file that does not include the PII columns. For Meta, you can download the non-PII identifier template for that data by clicking here.

    • If you're sending PII to the Facebook or Meta Conversions API Program for Offline Conversions and other programs, you can use the regular universal file template, which does not include the "maid" or "lr_id" columns.

  • Snapchat: If you are sending online conversion data, you will need to create a separate file for that online data, as the other conversion programs only allow offline conversion data.

File Format for the Universal File

See the sections below for information on formatting guidelines, information on using our universal file template, and a table that lists all possible columns you might include in your universal file.

Formatting Guidelines for the Universal File

Before sending your universal file conversion data to LiveRamp, make sure to strictly follow the guidelines listed below:

Note

If any guidelines listed here conflict with the guidelines in our general file formatting instructions, follow these guidelines.

Caution

If an uploaded file does not meet these requirements, you will need to reformat the file until it is formatted correctly.

  • Make sure to include all required columns with the exact column headers as shown.

  • Make sure to keep the columns up to and including the phone number columns in the exact order as shown. After those columns, the remaining columns can be in any order.

  • Provide the recommended values when possible. If you do not have values for a required field, include the column but with no values (do not include “N/A” or “null”).

  • Provide plaintext (raw) PII when possible because this is required for the programs that use a Passthrough Activation integration . For more information, see the "Situations That Require Additional Files" section above.

  • Provide your best email and phone for the user that you are trying to measure in columns “email_1” and “phone_1” (try to keep each column as close to a 100% fill rate as possible).

  • Not all programs utilize every column in the universal file. See the table in the "List of All Universal File Columns" section below to understand which programs use which fields so that you know which columns you can leave out.

  • Meta Conversions API for Offline Conversions: You will need to include only plaintext email addresses and/or plaintext phone numbers in the email and phone columns in the file.

  • Snapchat, OpenAI, or TikTok: These programs use our Passthrough Activation integration to pass through SHA256-hashed PII. You will need to include plaintext email addresses and/or plaintext phone numbers in the "email_1" and "phone_1" columns in the file so we can hash those values. You can also include hashed email addresses and/or phone numbers in the other email or phone columns, but these programs will not utilize them.

  • Google Store Sales: This program uses our Append integration to pass through SHA256-hashed PII and appends additional hashed PII if available within LiveRamp's Identity Graph. The data is then delivered to your Google Ads account. You will need to include plaintext email addresses and/or plaintext phone numbers in the "email_1" and "phone_1" columns in the file so we can hash those values. We recommend that you do not include additional email addresses and/or phone numbers in the other email or phone columns, but if you do include them, they will not be utilized.

  • If you're sending data on EMEA and/or UK consumers to Google Store Sales, you must also include the "ad_user_data" and "ad_personalization" columns listed in the "List of All Universal File Columns" section below. For all other regions, these columns are optional. For more info on Google's consent policy, see this Google article.

  • The file must be rectangular. That is, every row must have the same number of delimiters and columns of data.

List of All Universal File Columns

The table below lists all possible columns you might include in your universal file, along with the following information:

  • The columns that are always required

  • The columns that are required to pass product array or item-level data

  • The columns that are optional, but recommended to improve your conversion data's quality

  • The columns that are required in certain situations, based on the region of the data you're sending or the conversion programs you're using

  • Which columns are utilized by which conversion programs, when applicable

  • Formatting instructions for column values

Column Name

Column Required?

Required for Product Array?

Programs That Utilize This Field

Notes

first_name

Required

Required

  • Must be plaintext

last_name

Required

Required

  • Must be plaintext

address_1

Recommended

Recommended

  • Recommended if Name and Postal are used as an identifier

  • Must be plaintext

address_2

Optional

Optional

  • Include this column if you have additional street address info for a given row.

  • Must be plaintext

city

Recommended

Recommended

  • Recommended if Name and Postal are used as an identifier

  • Must be plaintext

state

Recommended

Recommended

  • Recommended if Name and Postal are used as an identifier

  • Must be a two-character, capitalized abbreviation ("CA", not "California" or "Ca").

  • Must be plaintext

zip

Recommended

Recommended

  • Recommended if Name and Postal are used as an identifier

  • ZIP codes can be in 5-digit format or 9-digit format (ZIP+4).

  • Must be plaintext

email_1

Required

Required

  • Must be plaintext if using this file for Meta Conversions API, Google Store Sales, Snapchat, or TikTok.

  • Can be SHA-256 hashed if not using this file for Meta Conversions API, Google Store Sales, Snapchat, or TikTok.

  • Can be MD5 or SHA-1 hashed if not using this file for Google Store Sales, Snapchat, or TikTok.

  • If you have multiple emails for a consumer, send your best one in the "email_1" column.

email_2

Optional

Optional

  • Must be plaintext if using this file for Meta Conversions API, Google Store Sales, Snapchat, or TikTok.

  • Can be SHA-256 hashed if not using this file for Meta Conversions API, Google Store Sales, Snapchat, or TikTok.

  • Can be MD5 or SHA-1 hashed if not using this file for Google Store Sales, Snapchat, or TikTok.

email_3

Optional

Optional

  • Must be plaintext if using this file for Meta Conversions API, Google Store Sales, Snapchat, or TikTok.

  • Can be SHA-256 hashed if not using this file for Meta Conversions API, Google Store Sales, Snapchat, or TikTok.

  • Can be MD5 or SHA-1 hashed if not using this file for Google Store Sales, Snapchat, or TikTok.

email_4

Optional

Optional

  • Must be plaintext if using this file for Meta Conversions API, Google Store Sales, Snapchat, or TikTok.

  • Can be SHA-256 hashed if not using this file for Meta Conversions API, Google Store Sales, Snapchat, or TikTok.

  • Can be MD5 or SHA-1 hashed if not using this file for Google Store Sales, Snapchat, or TikTok.

Country

Optional

Optional

  • TTD

  • Required for TTD only.

  • The 3-digit ISO 3166 country code where the transaction occurred (for example, "USA").

Region

Optional

Optional

  • TTD

  • Required for TTD only

  • The region where the transaction occurred (for example, "New York").

  • Use full state names (for example, "California" instead of "CA").

phone_1

Recommended

Recommended

  • Recommended if phone is used as an identifier

  • Do not include any hyphens or parentheses.

  • Must be plaintext if using this file for Meta Conversions API, Google Store Sales, Snapchat, or TikTok.

  • Can be SHA-1 hashed if using this file only for Google Campaign Manager 360, TTD, Pinterest, Nextdoor, Yelp, Bing, Criteo, StackAdapt, Spotify, or Yahoo.

  • If you have multiple phone numbers for a consumer, send your best one in the “phone_1” column.

phone_2

Optional

Optional

  • Do not include any hyphens or parentheses.

  • Must be plaintext if using this file for Meta Conversions API, Google Store Sales, Snapchat, or TikTok.

  • Can be SHA-1 hashed if using this file only for Google Campaign Manager 360, TTD, Pinterest, Nextdoor, Yelp, Bing, Criteo, StackAdapt, Spotify, or Yahoo.

transaction_category

Required

Required

  • Enter a “transaction category” value in this field for each transaction row to specify where the conversion occurred, such as "physical store" or "website".

  • Include all possible values in the initial file, and include only those values in subsequent files.

  • Use 1 value in order to support all conversion programs.

transaction_timestamp

Required

Required

  • Corresponds to the date/time of transaction in UTC - (example "2017-02-07T13:25:00Z-0800" should be the time the conversion happened in UTC).

  • Standard formats:

    • yyyy-MM-dd

    • yyyy-MM-dd'T'HH:mm:ss'Z'-0000 (for example, 2021-06-04T10:01:00Z-0000)

transaction_amount

Required

Required

  • The transaction amount

  • Do not include any (currency) symbols.

  • Do not include any negative amounts, such as a return.

  • Format required: XXX.XX

order_id

Required

Required

  • A unique ID (such as a transaction ID) that corresponds to the order that the particular item belongs to (this is often referred to as an “ordinal”). If the value is not unique, a partner may deduplicate some of these events when ingesting your conversion data.

  • Do not include special characters, currency symbols, or commas.

  • We recommend keeping it less than 64 characters.

item_number

Optional

Required

  • Amazon

  • Criteo

  • Google Campaign Manager 360

  • Meta Conversions API

  • Netflix

  • OpenAI

  • Pinterest

  • Reddit

  • Snapchat

  • StackAdapt

  • TikTok

  • TTD

  • Yahoo

  • Yelp

  • A number delineating a unique item in an order. For example, if three socks are purchased in one transaction, you could have three transaction rows with different item numbers for each pair of socks but the same order ID.

  • Do not include special characters, currency symbols, or commas.

quantity

Optional

Required

  • Amazon

  • Criteo

  • Google Campaign Manager 360

  • Meta Conversions API

  • Netflix

  • OpenAI

  • Pinterest

  • Reddit

  • Snapchat

  • StackAdapt

  • TikTok

  • TTD

  • Yahoo

  • Yelp

  • The quantity of the items purchased.

  • If blank or null, this will default to a value of 1.

  • For Google Campaign Manager 360, see Google Campaign Manager's Help Article to understand how this field impacts reporting.

product_id

Optional

Required

  • Amazon

  • Criteo

  • Google Campaign Manager 360

  • Meta Conversions API

  • Netflix

  • OpenAI

  • Pinterest

  • Reddit

  • Snapchat

  • StackAdapt

  • TikTok

  • TTD

  • Yahoo

  • Yelp

  • An alphanumeric value delineating a unique item in an order.

  • Do not include special characters, currency symbols, or commas.

  • Common product identifier types include UPC, ISBN, Brand, and MPN.

store_id

Optional

Optional

  • Criteo

  • Google Store Sales

  • Meta Conversions API

  • StackAdapt

  • A "shop code", which is a unique ID that clients assign to each of their store locations

  • Must not be longer than 64 characters

  • Must not include special characters (i.e., "<" or ">") or contain a URL

product_name

Optional

Required

  • Amazon

  • Criteo

  • Google Campaign Manager 360

  • Meta Conversions API

  • Netflix

  • OpenAI

  • Pinterest

  • Reddit

  • Snapchat

  • StackAdapt

  • TikTok

  • TTD

  • Yahoo

  • Yelp

  • Short name of the product

promo_code

Optional

Optional

  • Pinterest

  • Criteo

  • StackAdapt

  • The promotion code that was used for the purchase

product_category

Optional

Recommended

  • Amazon

  • Criteo

  • Meta Conversions API

  • Netflix

  • OpenAI

  • Pinterest

  • Reddit

  • Snapchat

  • StackAdapt

  • TikTok

  • Top-level category of the product

product_subcategory

Optional

Optional

  • Pinterest

  • Criteo

  • StackAdapt

  • Subcategory of the product.

product_variant

Optional

Optional

  • Pinterest

  • Criteo

  • Can include any product variation identifiers of the product

product_brand

Optional

Recommended

  • Amazon

  • Criteo

  • Meta Conversions API

  • Netflix

  • OpenAI

  • Pinterest

  • Reddit

  • Snapchat

  • StackAdapt

  • TikTok

  • Brand name of the product

event_conversion_type

Optional

Optional

  • Snapchat

Applicable for Snapchat only, and only if sending online data. Use one of the following source types:

  • app_android

  • app_ios

  • web

is_new_customer

Optional

Optional

  • Pinterest

  • "Y" indicates a new customer

  • "N" indicates an existing customer

product_price

Optional

Required

  • Amazon

  • Criteo

  • Google Campaign Manager 360

  • Meta Conversions API

  • Netflix

  • OpenAI

  • Pinterest

  • Reddit

  • Snapchat

  • StackAdapt

  • TikTok

  • TTD

  • Yahoo

  • Yelp

  • The product price.

  • Do not include currency symbols (for example, "XX.XX").

GTIN

Optional

Optional

  • StackAdapt

  • Global Trade Item Number (GTIN) is a unique and internationally recognized identifier for a product.

department

Optional

Optional

  • StackAdapt

  • The department for the product

custom_field

Optional

Optional

  • Meta Conversions API

  • Google Campaign Manager 360

  • Google Store Sales

  • TTD

  • Nextdoor

  • Yelp

  • StackAdapt

  • You can include an unlimited number of custom fields in order to create custom conversions.

  • Custom field column headings must start with "custom_", followed by the field name. For example, "custom_store_ID".

  • Create separate custom fields for each partner due to specific nuances and requirements.

data_processing_options

Recommended

Recommended

  • Amazon

  • Criteo

  • Google Campaign Manager 360

  • Meta Conversions API

  • Netflix

  • OpenAI

  • Pinterest

  • Reddit

  • Snapchat

  • StackAdapt

  • TikTok

  • TTD

  • Yahoo

  • Yelp

  • We recommend including this column to ensure LiveRamp can pass consent flags, allowing each event to be processed according to applicable privacy requirements.

  • Enter a value of "LDU" when an event is tied to a person who is subject to a state Privacy Act and who has opted out of the sale of their data, or when you have opted to have Meta process data as a service provider, as defined by their state-specific terms.

  • Enter the value "non-ldu" to indicate that LiveRamp should upload data to Meta with the LDU mode disabled.

data_processing_options_state

Recommended

Recommended

  • Amazon

  • Criteo

  • Google Campaign Manager 360

  • Meta Conversions API

  • Netflix

  • OpenAI

  • Pinterest

  • Reddit

  • Snapchat

  • StackAdapt

  • TikTok

  • TTD

  • Yahoo

  • Yelp

  • Enter one of the following values if you entered a value of "LDU" for the "data_processing_options" column:

  • Enter "CA" for users located in California

  • Enter "CO" for users located in Colorado

  • Enter "CT" for users located in Connecticut

  • Enter "FL" for users located in Florida

  • Enter "OR" for users located in Oregon

  • Enter "TX" for users located in Texas

  • Enter "MT" for users located in Montana

  • Enter "DE" for users located in Delaware

  • Enter "NE" for users located in Nebraska

  • Enter "NH" for users located in New Hampshire

  • Enter "NJ" for users located in New Jersey

  • Enter "MN" for users located in Minnesota

  • Enter "MD" for users located in Maryland

  • Enter "RI" for users located in Rhode Island

  • Enter "0" to request that Meta perform geolocation

    data_processing_options_country

    Recommended

    Recommended

    • Amazon

    • Criteo

    • Google Campaign Manager 360

    • Meta Conversions API

    • Netflix

    • OpenAI

    • Pinterest

    • Reddit

    • Snapchat

    • StackAdapt

    • TikTok

    • TTD

    • Yahoo

    • Yelp

    • Enter one of the following values if you entered a value of “LDU” for the “data_processing_options” column:

      • Enter "US" for the United States of America

      • Enter "0" to request that Meta perform geolocation

    ad_user_data

    Recommended

    Recommended

    • Amazon

    • Criteo

    • Google Campaign Manager 360

    • Meta Conversions API

    • Netflix

    • OpenAI

    • Pinterest

    • Reddit

    • Snapchat

    • StackAdapt

    • TikTok

    • TTD

    • Yahoo

    • Yelp

    • Required if the file contains UK or EMEA data.

    • Enter "granted" to confirm that the consumer has consented to the use of their data.

    • If no value is entered, LiveRamp will mark the event as "unspecified" on your behalf.

    ad_personalization

    Recommended

    Recommended

    • Amazon

    • Criteo

    • Google Campaign Manager 360

    • Meta Conversions API

    • Netflix

    • OpenAI

    • Pinterest

    • Reddit

    • Snapchat

    • StackAdapt

    • TikTok

    • TTD

    • Yahoo

    • Yelp

    • Required if the file contains UK or EMEA data.

    • Enter "granted" to confirm that the consumer has consented to ad personalization.

    • If no value is entered, LiveRamp will mark the event as "unspecified" on your behalf.

    event_source_URL

    Optional

    Optional

    • Meta Conversions API

    • Source URL for transactions that occurred online.

    event_name

    Required

    Required

    • The type of conversion event that occurred.

    • For conversions other than "purchase" or "store sales", enter a standard conversion event name for online conversions such as "add to wishlist" or "add to cart".

    currency

    Optional

    Required

    • Amazon

    • Criteo

    • Google Campaign Manager 360

    • Meta Conversions API

    • Netflix

    • OpenAI

    • Pinterest

    • Reddit

    • Snapchat

    • StackAdapt

    • TikTok

    • TTD

    • Yahoo

    • Yelp

    • The currency the transaction was paid in (i.e., “USD” or “CAD”).

    • Must follow the three letter ISO 4217 code.

    client_user_agent

    Optional

    Optional

    • Amazon

    • Criteo

    • Google Campaign Manager 360

    • Meta Conversions API

    • Netflix

    • OpenAI

    • Pinterest

    • Reddit

    • Snapchat

    • StackAdapt

    • TikTok

    • TTD

    • Yahoo

    • Yelp

    • The user agent for the browser corresponding to the event.

    • The client_user_agent is required by most platforms for online events shared using Conversions API.

    total_transaction_amount

    Optional

    Optional

    • Amazon

    • Criteo

    • Google Campaign Manager 360

    • Meta Conversions API

    • Netflix

    • OpenAI

    • Pinterest

    • Reddit

    • Snapchat

    • StackAdapt

    • TikTok

    • TTD

    • Yahoo

    • Yelp

    • Product price or the total transaction amount of the corresponding event.

    • Use this field to indicate total amount if you are only sending basket-level data.

    merchant_id

    Optional

    Optional

    • Google Campaign Manager 360

    • Google Store Sales

    • TTD

    • The Merchant Center ID where the items are uploaded. Providing Merchant Center ID reduces ambiguity in identifying the right offer details.

    merchantFeedLabel

    Optional

    Optional

    • Google Campaign Manager 360

    • Google Store Sales

    • TTD

    • The feed labels associated with the feed where your items are uploaded. Providing the feed label reduces ambiguity in identifying the right offer details. For more information on feed labels, see this Google article.

    merchantFeedLanguage

    Optional

    Optional

    • Google Campaign Manager 360

    • Google Store Sales

    • TTD

    • The language associated with the feed where your items are uploaded. Use ISO 639-1 language codes. Providing the feed language reduces ambiguity in identifying the right offer details.