Upgrading Your Conversions API Integrations for Web Conversions and Events
If you are running LiveRamp’s one Conversions API connector for web conversion data activation, you can upgrade your integrations to take advantage of the more streamlined and efficient method of implementation, where you can run multiple CAPI programs on a single integration and workflow.
Benefits of Upgrading
On top of having simplified setup and workflows, which reduce initial setup time and eliminate repetitive work, some benefits of upgrading to the enhanced program are:
Build payloads and configure data layer or event settings once: For each new CAPI platform, you only need to provide the account ID and authentication token from your platform partners in Console's CAPI Hub — no code updates required.
Better data layer detection: For ATS for Web implementation, the enhanced data layer detection feature works with any website's data layer (not just Google or Adobe).
Single API call for ATS API and server-side users: API users only need to call a single endpoint, which automatically translates event data to all subscribed CAPI programs. This reduces complexity and page weight, as well as simplifying maintenance.
Overall Steps
The overall steps of upgrading your CAPI integration are as follows:
Create a new ATS configuration and copy any relevant settings from your existing ATS configuration.
Obtain account IDs and authentication tokens for each of the desired CAPI programs. See "Platform-Specific Requirements" for more information.
Create an Online CAPI integration and provide the account IDs and authentication tokens obtained in the previous step.
From the navigation pane, select ATS → Web.
Select the Integration tab and click New.
Select "Conversions API".
Select your ATS implementation method and provide the credentials for each CAPI program you want to activate.
Configure the events based on your implementation method.
For ATS for Web (ATS.js) implementation: Configure the type of events you want to send (e.g., AddToCart, Purchase) and how they should be detected. View the Universal Events and Parameters table to view all available event types and the platforms that support them.
Click .
Select the event type. You can refer to the Universal Events and Parameter table to view what's available for each CAPI program and to understand how the event translates to each platform's schema.
Define how events should be detected. You can select from Data Layer or Page Element (e.g. CSS selector, URL parameter).
Set the required parameters for each field (such as Event ID) by configuring CSS selectors, extracting values from URL parameters, or using your tag manager to fill fields with existing variables detected from the data layer.
Click .
For API-based implementations: Construct the event payload based on LiveRamp's unified event schema using the keys from the Universal Events and Parameters table. You don't need to make separate API calls, as the payload will be translated into each platform's format automatically.
Note
Make sure to include all required parameters in your payload.
See the payload example of a purchase event below:
{ "events": [ { "event_id": "evt_67897", "event_name": "Purchase", "event_source": "Web", "event_source_url": "https://example.com/confirmation", "event_time": 1752505804, "user_data": { "envelope": "id_env", "fb_envelope": "id_fb_envelope", "ip_address": "192.0.2.100", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64)" }, "provider_data": { "fb_click": "id_fb_click", "fb_view": "id_fb_view", "pin_click": "id_pin_click", "sc_click": "id_sc_click", "sc_view": "id_sc_view", "tt_click": "id_tt_click", "tt_view": "id_tt_view" }, "custom_data": { "content_ids": ["item_123", "item_456"], "content_name": ["Example Shoe", "Example Hoodie"], "content_type": ["product"], "content_category": ["Apparel"], "content_brand": ["ExampleBrand"], "order_id": ["order_789"], "currency": ["USD"], "value": ["105.00"], "num_items": ["2"], "limited_data_use": false, "contents": [ { "item_id": ["item_123"], "item_price": ["55.00"], "item_quantity": ["1"], "item_name": ["Example Shoe"], "item_brand": ["ExampleBrand"], "item_category": ["Footwear"] }, { "item_id": ["item_456"], "item_price": ["50.00"], "item_quantity": ["1"], "item_name": ["Example Hoodie"], "item_brand": ["ExampleBrand"], "item_category": ["Clothing"] } ] } } ] }
For additional payload examples of the most common use cases, refer to the developers' documentation.
FAQ's
No, the enhanced Online Conversions API is only available as an integration option in new ATS configurations. If needed, a LiveRamp representative can help you with moving your current Online Conversions API setup to a new ATS configuration to simplify the migration process for you.
You can run both versions if they are in different ATS configurations. You cannot, however, run both existing and enhanced CAPI versions in the same ATS configurations. The existing CAPI integration will no longer be available for new ATS configurations and will be replaced with the enhanced Online CAPI integration.
No, any new Conversions API platform will only be available in the enhanced Online Conversions API.
Not at this time. For now, mobile app events are only supported for Meta and TikTok on the existing Online CAPI. Support for app events in the enhanced version (including Snapchat and Pinterest) is in development. We will provide an update when this feature is ready.
You can continue using your existing setup for now. If you don’t need to add any new Conversions API platforms that are not already on the existing framework, you can continue using the existing setup.
If you are unsure which version of Conversions API you are currently using, from the navigation pane, select ATS → Web and select the ATS Configuration you integrated CAPI with. If the CAPI integration is displayed as platform-specific under the "Type" column (for example, Meta CAPI, TikTok CAPI, or Snapchat CAPI), this means the integration is running on the legacy version.
Currently, you can activate web conversion and event data to the following platforms:
Meta
Pinterest
Snapchat
TikTok
LiveRamp is continuously expanding its partnership with other platforms. Check the "Release Notes and System Information" page periodically to stay updated when a new CAPI platform becomes available.