Snapchat Conversions API v3

Snapchat is a multimedia instant messaging app and service. This destination leverages the latest Snapchat Conversions API v3 to push web and app events to Snapchat leading to optimized ad campaigns, improved targeting, and measure the conversions that resulted from your Snapchat campaigns.

Key features

The Snapchat destination provides the following key features:

• Events structure: our Events reference supports Snapchat events, 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.

• Custom events: you can freely push custom events based on your specific needs.

• Support for multi-item data: information included in the item array is dispatched to Snapchat.

Destination setup

Configuration

Settings	Description
Credentials	Required if API Token is not set Your credentials with Snapchat as set in the Commanders Act interface following: Administration ➜ Connector Credentials ➜ Add connector credentials ➜ Snapchat
API Token	Required if Credentials is not set Input your "API Token", also known as "Static long lived token", as generated in Snapchat Business Manager → "Business Details" by following this LINK. This field has priority over Credentials.
Pixel Id (WEB)	Required for WEB events. Your Pixel Id as provided by Snapchat for "Web" type events. For more details, you can check the following LINK.
Snap App Id (APP)	Required for MOBILE APP events. Your Snap App Id as provided by Snapchat for "Mobile App" type events. For more details, you can check the following LINK.
Send IP Address	Flag this option to send the IP address as set in the Smart Mapping field Device IP .
Custom Event Mapping	Snapchat allows up to five (5) custom events to be tracked. In Commanders Act Event Name input an event name, while in Snapchat Event Name set a name as follows: CUSTOM_EVENT_X , where X is a number between 1 and 5 , both included (E.g. CUSTOM_EVENT_1 ).
Custom Event Properties	Map your custom event properties by setting their field names in Snapchat property name and adding the value in Your value event .

Quick reference

Commanders Act Events	Snapchat Events
achievement_unlocked	ACHIEVEMENT_UNLOCKED
ad_click	AD_CLICK
ad_view	AD_VIEW
add_payment_info add_billing	ADD_BILLING
add_to_cart	ADD_CART
add_to_wishlist	ADD_TO_WISHLIST
app_open	APP_OPEN
begin_checkout	START_CHECKOUT
complete_tutorial	COMPLETE_TUTORIAL
generate_lead	SUBSCRIBE
invite	INVITE
level_complete	LEVEL_COMPLETE
login	LOGIN
page_view	PAGE_VIEW
purchase	PURCHASE
rate	RATE
reserve	RESERVE
save	SAVE
search	SEARCH
share	SHARE
sign_up	SIGN_UP
spent_credits	SPENT_CREDITS
start_trial	START_TRIAL
view_item	VIEW_CONTENT
view_item_list	LIST_VIEW
[ANY EVENT]	CUSTOM_EVENT_X [1]

[1] Where X is a number between 1 and 5 , both included. See Custom Event Mapping in Configuration for more details on how you can track custom events with Snapchat.

Field mappings

At least one of the following must be provided:

• user_data.em (User Email)

• user_data.ph (User Phone)

• user_data.madid (Device Mobile Identifier)

• user_data.client_ip_address AND user_data.client_user_agent

Most properties can be remapped using our "Smart Mapping" feature. All Snapchat properties are set in the base path data.0 .

Commanders Act Properties	Snapchat Properties
context.event_timestamp	event_time
(event_name)	event_name [1]
partners.snapchat.event_conversion_type (context.app.name)	action_source [2]
context.page.url	event_source_url
id	event_id [3]
partners.snapchat.dpo	data_processing_options
partners.snapchat.test_code	test_event_code
items.X.id	custom_data.content_ids [4]
items.X.product.category_1	custom_data.content_category [5]
context.page.title	custom_data.content_name
partners.snapchat.content_type	custom_data.content_type [6]
items.X.id	custom_data.contents.X.id
items.X.quantity	custom_data.contents.X.quantity
items.X.product.price	custom_data.contents.X.item_price
items.X.product.delivery_category	custom_data.contents.X.delivery_category
items.length	custom_data.num_items
value	custom_data.value
currency	custom_data.currency
id	custom_data.order_id
partners.snapchat.predicted_ltv	custom_data.predicted_ltv
search_term	custom_data.search_string
partners.snapchat.checkin_date	custom_data.checkin_date [7]
partners.snapchat.travel_end	custom_data.travel_end
partners.snapchat.travel_start	custom_data.travel_start
partners.snapchat.suggest_dest	custom_data.suggested_destinations [8]
partners.snapchat.dest_airport	custom_data.destination_airport [9]
partners.snapchat.dest_country	custom_data.country [10]
partners.snapchat.dest_city	custom_data.city [11]
partners.snapchat.dest_region	custom_data.region [12]
partners.snapchat.dest_neigh	custom_data.neighborhood [13]
method	custom_data.sign_up_method
context.device.user_agent	user_data.client_user_agent
context.app.namespace	app_data.app_id extinfo.1
context.device.advertising_id	user_data.madid
context.device.idfv	user_data.idfv [14]
(context.device.os.name)	extinfo.0 [15]
context.app.version	extinfo.2
context.app.version_long	extinfo.3
context.device.os.version	custom_data.os_version extinfo.4
context.device.model	custom_data.device_model extinfo.5
context.device.language	extinfo.6
context.device.timezone_short	extinfo.7
context.device.network.carrier	extinfo.8
context.device.screen.width	extinfo.9
context.device.screen.height	extinfo.10
context.device.screen.density	extinfo.11
context.device.cpu_core	extinfo.12
context.device.storage	extinfo.13
context.device.ex_storage	extinfo.14
context.device.timezone	extinfo.15
context.device.ad_tracking_enabled	app_data.advertiser_tracking_enabled
user.email	user_data.em [16]
user.phone	user_data.ph [16]
user.firstname	user_data.fn [16]
user.lastname	user_data.ln [16]
user.gender	user_data.ge [16]
user.city	user_data.ct [16]
user.state_short	user_data.st [16]
user.zipcode	user_data.zp [16]
user.country	user_data.country [16]
context.device.ip	user_data.client_ip_address
user.id	user_data.external_id
partners.snapchat.sub_id	user_data.subscription_id
partners.snapchat.lead_id	user_data.lead_id
partners.snapchat.app_install_id	user_data.anon_id
partners.snapchat.download_id	user_data.download_id
partners.snapchat.partner_id	user_data.partner_id
partners.snapchat.uuid_c1 Cookie _scid	user_data.sc_cookie1 [17]
partners.snapchat.click_id	user_data.sc_click_id

[1] See Quick reference for more details. [2] Priority on the left side. If context.app.name is set MOBILE_APP is returned. Allowed values: OFFLINE , MOBILE_APP and WEB . Default value: WEB . [3] If you are reporting events via more than one method (Snap Pixel, App Ads Kit , Conversions API) you should use the same event identifier across all methods. If using Snap Pixel, this must match the client_dedup_id for the matching event. [4] All item identifier are included. [5] All categories are included. [6] Indicates what the keys in content_ids or contents represent. Set with product for individual items or product_group for items that have multiple options in either size, color or any other variation. Default value: product . [7] The desired hotel check-in date in the hotel's time-zone. Accepted formats are: YYYYMMDD , YYYY-MM-DD , YYYY-MM-DDThh:mmTZD and YYYY-MM-DDThh:mm:ssTZD . [8] Suggested Destinations. Comma-separated or list of destinations (E.g. destination1,destination2 or ["destination1", "destination2"] ). [9] IATA code. [10] The country based on the location the user intends to visit. [11] The city based on the location the user intends to visit. [12] This could be the state, district, or region of interest to the user. [13] The neighborhood the user is interested in. [14] iOS IDFV. If it's passed in clear text, it's automatically hashed via SHA256. [15] Set with a2 if context.device.os.name is Android (case insensitive) or i2 if context.device.os.name is iOS (case insensitive). [16] If it's passed in clear text, it's normalized and automatically hashed via SHA256. [17] Priority on the left side.