Reddit Ads Reference
Send advertising events to Reddit Ads via Freshpaint.
Destination Info
Supports Track calls
Supports HIPAA mode
Refer to this destination as reddit-ads in the Integrations object
If you've configured multiple Account IDs, you can choose a specific one by suffixing the Account ID, such as:
reddit-ads::0123456789012345. You can retrieve this value from the Reddit Ads configuration page for the Account ID of interest.
Connection Modes:
Web
Mobile
Server
This is a reference document for the Reddit Ads destination. For information on how to set up this integration, see the Reddit Ads Quick Start Guide.
Events
When you send an event to the Reddit Ads destination from Freshpaint, Freshpaint will create an event in the Reddit event manager by hitting Reddit Ad's conversions API.
Track Events
When you send an event to the Reddit Ads destination, you can track conversions from your ads based on those events. Please refer to Reddit Ads API Conversions documentation for further details on which properties are relevant.
Below are the Required, Recommended, and Optional properties which are mapped to the Reddit Ads request:
Freshpaint property
Reddit Ads parameter
Type
Requirement
Description
$rdt_cid
click_id
string
Required
A query parameter that connects a page view or conversion event to a specific ad, which Freshpaint captures as $rdt_cid
<event_name>
tracking_type
string
Required (either tracking_type or custom_event_name is always sent)
If event name is one of:
- PageVisit
- ViewContent
- Search
- AddToCart
- AddToWishlist
- Purchase
- Lead
- SignUp
- Custom
we will use the event name as the tracking_type. We normalize the value before sending to Reddit (for example, page_visit maps to PageVisit)
<event_name>
custom_event_name
string
Required (either tracking_type or custom_event_name is always sent)
If event name is not one of the standard event names described above, we will set tracking_type to Custom and send the <event_name> as custom_event_name
$time
event_at_ms
number(float)
Required ( always sent)
This uses a built in prop to send the event time.
test_mode
test_mode
boolean
Optional
This test flag is processed by Reddit. It is a flag indicating whether the conversion events should be processed. This can be set to "true" when testing out the API integration and no data will be posted to the account.
item_count
event_metadata[item_count]
number(int)
Optional
The number of items in the event.
value
event_metadata[value_decimal]
number(float)
Optional
Value of the transaction in the base unit of the currency (eg. 30.12)
currency
event_metadata[currency]
string
Optional
Currency for the value provided. Three character ISO 4217 currency code (eg. USD)
products
event_metadata[products]
array
Optional
Array of products associated with the event. Each product must contain at least an id and a category. A name can optionally be included.
Example:
[{
"id": "someId",
"category": "someCategory",
"name": "someName"
}]
Any product that doesn't contain at least id and category will be dropped.
conversion_id
event_metadata[conversion_id]
string
Optional
A unique conversion ID corresponds to a distinct conversion event. This field is used for deduplication and should only be used if the Reddit client side Pixel is also running on the website.
reddit_uuid
user[uuid]
string
Optional
The value from the first-party Pixel '_rdt_uuid' cookie on your domain. Note that it is in the '{timestamp}.{uuid}' format. You may use the full value or just the UUID portion. This field may not be relevant if you are not running the Reddit client side Pixel on your website.
email
user[email]
string
Optional
The email address of the user. This value will be cleaned and sha256 hashed before being sent to Reddit. For example, A.b+c@domain -> ab@domain -> sha256(ab@domain)
external_id
user[external_id]
string
Optional
An advertiser-assigned persistent identifier for the user. This value will be whitespace trimmed, lowercased and sha256 hashed before being sent to Reddit.
$screen_height
user[screen_dimensions][height]
number(int)
Optional
The height of the user's screen in pixels. This must be positive and less than 32768.
$screen_width
user[screen_dimensions][width]
number(int)
Optional
The width of the user's screen in pixels. This must be positive and less than 32768.
aaid
user[aaid]
string
Optional
The AAID of the user's device. This value will be sha256 hashed before being sent to Reddit.
idfa
user[idfa]
string
Optional
The IDFA of the user's device. This value will be sha256 hashed before being sent to Reddit.
$ip / ip_address
user[ip_address]
string
Optional
The IP address of the user. This value will be sha256 hashed before being sent to Reddit.
You can either allow the Freshpaint collected value or send your own using the ip_address prop.
opt_out
user[opt_out]
boolean
Optional
A flag indicating whether the user has opted out of tracking. This defaults to false unless otherwise specified
$user_agent /user_agent
user[user_agent]
string
Optional
The user agent of the user's browser.
You can either allow the Freshpaint collected value or send your own using the user_agent prop.
Last updated