Snapchat Conversions API

Snapchat is a multimedia instant messaging app and service. This destination leverages the Snapchat Conversions API to push web and app events to Snapchat.

Key features

The Snapchat destination provides the following key features:

  • Events structure: our Events reference fits Snapchat event types, 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.

  • 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

Before you get started with this destination, make sure you can access the Snapchat Ads Manager.

Configuration

SettingsDescription

Credentials

Required if API Token is not set Your credentials with Snapchat as set in the Commanders Act interface following: AdministrationConnector CredentialsAdd connector credentialsSnapchat

API Token

Pixel Id (WEB)

Snap App Id (APP)

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 Event property name and adding the field name holding the value in Commanders Act event property . E.g. if you input size in the Event property name and items.0.product.size [1] in Commanders Act event property , you will have a custom event property in Snapchat called size with a value based on the content of the field items.0.product.size .

[1] Using "dots" (".") you can navigate deeper to the specific field you want to get the value of. See Events reference for more details on the standard field names by event. You can also freely set custom fields: there are no boundaries.

Quick reference

Commanders Act EventsSnapchat Events

add_payment_info

ADD_BILLING

add_to_cart

ADD_CART

add_to_wishlist

ADD_TO_WISHLIST

begin_checkout

START_CHECKOUT

generate_lead

SUBSCRIBE

login

LOGIN

page_view

PAGE_VIEW

purchase

PURCHASE

search

SEARCH

sign_up

SIGN_UP

view_item

VIEW_CONTENT

view_item_list

LIST_VIEW

Commanders Act Event Name

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

This destination will set the unique visitor identifier, which you can provide if you're using Snapchat Pixel SDK, as value for the Snapchat uuid_c1 property by looking for partners.snapchat.uuid_c1 property. If it's not present, the cookie _scid is used.

Commanders Act PropertiesSnapchat Properties

context.event_timestamp

timestamp [1]

Pixel Id (WEB)

pixel_id

Snap App Id (APP)

snap_app_id

partners.snapchat.event_conversion_type

(context.app.name)

event_conversion_type [2]

context.page.url

page_url

context.app.namespace

app_id

id

client_dedup_id [3]

items.X.id

item_ids.X

items.length

number_items

items.X.id

item_ids [4]

items.X.product.category_1

item_category [4]

value

price

currency

currency

id

transaction_id

method

sign_up_method

search_term

search_string

user.email

hashed_email [5]

user.phone

hashed_phone_number [6]

context.device.ip

hashed_ip_address [5]

context.device.user_agent

user_agent

context.device.advertising_id

hashed_mobile_ad_id

context.device.idfv

hashed_idfv

context.device.model

device_model

context.device.os.version

os_version

partners.snapchat.uuid_c1

uuid_c1 [7]

partners.snapchat.click_id

click_id

partners.snapchat.att_status

att_status

[1] Field automatically generated when it's not set. [2] Priority order is listed in the left column. If context.app.name is defined then this field is set with MOBILE_APP , otherwise, WEB . [3] If you are reporting events using multiple methods (E.g. Snap Pixel and Conversions API) you should use the same client_dedup_id across all of them. This will be used within a 48 hour scope of the first occurrence. [4] Each item information is pushed in the related array. [5] Field automatically hashed if provided in clear text. [6] Field automatically hashed and normalized. [7] partners.snapchat.uuid_c1 has priority over cookie _scid.

Last updated