Reddit Conversions API
Last updated
Was this helpful?
Last updated
Was this helpful?
is a social news aggregation, content rating, and forum social network. (CAPI) is a server-side solution to share your web conversion data directly with Reddit so you can measure and optimize your performance campaigns.
The Reddit Conversions API destination provides the following key features:
Events structure: our model covers , meaning that your data is properly bridged to the expected fields in an optimized way.
Prebuilt mappings: data mapping for event-based destinations happens automatically, which simplifies user inputs.
Automatic hashing: information is automatically hashed matching partner specifications.
Smart mapping: data mapping can be readjusted using your datalayer defined fields.
Event mapping: change standard mapping between Reddit events and yours or add new mappings.
Support for multi-item data: information included in the array is dispatched to Reddit.
Authentication
Required
Your credentials with Reddit Campaign Manager as set in the Commanders Act interface following: Administration
➜ Connector Credentials
➜ Add connector credentials
➜ RedditAds
Access Token
Event Mapping
Change the standard mapping between Reddit's events and yours or add new mappings.
Test Mode
Enable this only while testing your settings. Disable in production!
add_to_cart
AddToCart
add_to_wishlist
AddToWishlist
generate_lead
Lead
page_view
PageVisit
purchase
Purchase
search
Search
sign_up
SignUp
view_item
ViewContent
[Any Event]
[Any Event]
[1]
At least one of the following Reddit properties is required:
• click_id
*
• uuid
*
• email
*
• ip_address
+ user_agent
+ width
+ height
*
• idfa
or aaid
• external_id
Sending more properties will improve attribution accuracy and performance.
* Recommended properties.
context.event_timestamp
event_at
[1]
Event Mapping
event_type.custom_event_name
partners.reddit.click_id
click_id
[2]
id
conversion_id
[3]
value
value_decimal
[3]
currency
currency
[3]
items
item_count
[3][4]
items.X.id
products.X.id
[3]
items.X.product.name
products.X.name
[3]
items.X.product.category_1
items.X.product.category_2
items.X.product.category_3
items.X.product.category_4
items.X.product.category_5
products.X.category
[3][5]
context.device.advertising_id
idfa
[6][7][8]
aaid
[6][7][8]
user.email
email
[6][8]
user.id
external_id
[6][8]
context.device.ip
ip_address
[6][8]
context.device.user_agent
user_agent
[6]
parters.reddit.uuid
uuid
[6]
context.device.ad_tracking_enabled
opt_out
[6]
user.country
country
[9]
user.region
region
[9]
parters.reddit.data_proc_mode
modes[0]
[9][10]
context.device.screen.width
width
[11]
context.device.screen.height
height
[11]
Test Mode
test_mode
[12]
Required
Your access token identifier as generated by accessing . More details are available by following this .
[1] See Event Mapping
in for more details.
[1] Timestamp is converted to the format.
[2] If a value is not provided, this is retrieved from the page URL by parsing the parameter rdt_cid
.
[3] Set in the event_metadata
field.
[4] Based on the length of the provided "Smart Mapping" field Item List
.
[5] All provided categories are separated by the "greater than" character ( >
).
[6] Set in the user
field.
[7] These properties require a proper value, iOS
or Android
, for the "Smart Mapping" field Device Platform
.
[8] Automatically hashed via SHA256 when provided in clear text.
[9] Set in the user.data_processing_options
field.
[10] Supported value: LDU
.
[11] Set in the user.screen_dimensions
field.
[12] Set in the base path.