The Trade Desk Real-Time Conversions API extension overview

Last update: 2024-10-07
  • Topics:
  • Tags
    View more on this topic
  • Created for:
  • Developer

You can use the The Trade Desk Real-Time Conversions API extension to send data from the Adobe Experience Platform Edge Network to The Trade Desk by utilizing the API’s capabilities in your event forwarding rules.

Using The Trade Desk Real-Time Conversions API extension, you can leverage the API’s capabilities in your event forwarding rules to send data to The Trade Desk from the Adobe Experience Platform Edge Network.

Read this document to learn how to install the extension and use its capabilities in an event forwarding rule.

NOTE

This extension and documentation page are maintained by The Trade Desk team. For any inquiries or update requests, please contact them directly.

Prerequisites

You must have a relevant Advertiser ID, UPixel ID, and Tracker ID are required from within your The Trade Desk account in order to configure the The Trade Desk Real-Time Conversions API.

INFO

If you are a merchant, you will also need to obtain your Merchant ID.

Install and configure the The Trade Desk Real-Time Conversions API

To install the extension, create an event forwarding property or select an existing property to edit instead.

Select Extensions in the left navigation. In the Catalog tab, select the The Trade Desk Real-Time Conversions API card, then select Install.

The extension catalog showing the The Trade Desk extension card highlighting install.

On the next screen, enter the Advertiser ID, and optionally a Merchant ID. You can paste the ID’s directly into these inputs, or you can use a data element instead. These will serve as the default values used when making an event call to The Trade Desk Real-Time Conversions API. Select Save when finished.

To learn how you can create data elements and make them available to extensions in your tag property, follow the Create data elements tutorial.

The The Trade Desk extension configuration page with the Advertiser ID and Merchant ID fields highlighted.

The extension is installed and you can now employ its capabilities in your event forwarding rules.

Configure an event forwarding rule

Once you have installed and configured the extension, you can start creating event forwarding rules that determine how and when you events will be sent to The Trade Desk.

You should consider configuring several rules in order to send all accepted request properties via The Trade Desk and The Trade Desk Real-Time Conversions API.

NOTE

Events should be sent out in real-time or as close to real-time as possible.

Create a new event forwarding rule in your event forwarding property. Under Actions, add a new action and set the extension to The Trade Desk. Next, select Real Time Conversion for the Action Type.

The Event Forwarding Property Rules view, with the fields required to add an event forwarding rule action configuration highlighted.

After selection, additional controls appear to further configure the event data that will be sent to The Trade Desk. Select Keep Changes to save the rule.

The configuration options are divided into three main sections as outlined below:

Basic Request Properties

Input Description
Tracker ID The platform ID of the event tracker.
UPixel ID The universal pixel ID for the event.
Referrer URL The website URL from where the event occurred, if any.
Event Name The type of event defined by the partner platform.
Value The revenue-tracking value in decimal string (for example, “19.98”).
Currency Currency code in ISO format.
Client IP The client IPv4 or IPv6 IP address.
Ad ID The unique advertising ID for the event.
Ad ID Type The type of the advertising ID, specified in the AD ID property: TDID, IDFA, AAID, DAID, NAID, IDL, EUID, or UID2.
Impression A 36-character string (including dashes) that serves as the unique ID for the impression to which the event is attributed.
Order ID The associated order identifier of the event.
td1-td10 Ten sequentially numbered custom dynamic properties that can be used to provide additional conversion metadata.

The Basic Request Properties section showing example data input into the fields.

Refer to the The Trade Desk developer documentation for more information on the request properties accepted by The Trade Desk Real-Time Conversions API.

Object Request Parameters

A JSON object containing more information. You have the option to use a reduced set of key-value inputs or to supply raw JSON. Additionally, you can retrieve dynamic data from a data element by selecting the disks (Disk Icon) on the right.

The Object Request Parameters section showing available fields.

Refer to the Real-Time Conversions Event documentation for more information on the Object Request Parameters and their properties.

Configuration Overrides

NOTE

The Configuration Overrides fields allow you to set a different Advertiser ID and/or Merchant ID on every rule.

Input Description
Advertiser ID Unique identifier for the advertiser which this event is associated. A different Advertiser ID can be provided to override the ID you supplied in the extension configuration.
Merchant ID The unique identifier that each merchant is given by The Trade Desk throughout the onboarding procedure. A different Merchant ID can be provided to override the ID you supplied in the extension configuration.

The Configuration Overrides section showing available fields.

When you are satisfied with the rule, select Save to Library. Finally, publish a new event forwarding build to enable the changes made to the library.

Next steps

This guide covered how to send server-side event data to The Trade Desk using the The Trade Desk Real-Time Conversions API extension. From here, it is recommended to expand your integration by creating distinct rules that send specific conversion events as applicable per campaign. For more information on event forwarding capabilities in Adobe Experience Platform, read the event forwarding overview.

See the The Trade Desk documentation on best practices for the The Trade Desk Real-Time Conversions API for more guidance on how to effectively implement your integration.

For details on how to debug your implementation using the Experience Platform Debugger and Event Forwarding Monitoring tool, read the Adobe Experience Platform Debugger overview and Monitor activities in event forwarding.

On this page