Snapchat Conversions Connector Setup Guide

This article describes how to set up the Snapchat Conversions connector.

How it works

The Snapchat Conversions connector uses the Snap Conversions API. Snap’s Conversions API is a structured, privacy-centric interface that allows you to directly pass web, app, and offline events to Snap via a Server-to-Server (S2S) integration. This API supports similar event tracking as the Snap Pixel and broken out into the Device Type used to make the conversion as well. This trigger allows for the Snap App ID to be used (in the case of a mobile conversion) and the Pixel ID (web and offline conversion events).

Snap Conversions API can be deployed standalone or in-conjunction with the client side Snap Pixel.

For more information about Snap’s Conversions API, see the Conversion API article in the Snapchat documentation.

API Information

This connector uses the following vendor API:

  • API Name: Snapchat Marketing API - Conversion API
  • API Version: v2
  • API Endpoint: https://tr.snapchat.com/v2/conversion

Prerequisites

  • After adding the connector, you must invite asintegrations@tealium.com to your Snapchat Business manager with the Member role and assign to applicable Ad Account with the Data Manager role.

This step may take up to three (3) working days for approval. You can confirm whether the invitation has been accepted by viewing the users in your Snapchat Ads account.

For additional information, see: Manage Members and Roles.

Considerations

  • To unlock campaign optimization, Tealium recommends that you send events as soon as they occur, ideally within an hour of the event occurring.
  • We strongly recommend passing data in real-time. By doing so, you will see your campaign-driven results more quickly and ensure your bids are staying competitive with current marketplace demand.
  • Conversions API requests are tied to unique identifiers that link server events back to your Snapchat ad account. We use your Pixel ID for web and offline events and your Snapchat App ID for app events.

Batch Limits

This connector uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following three (3) thresholds is met:

  • Max number of requests: 2000
  • Max time since oldest request: 10 minutes
  • Max size of requests: 2 MB

Deduplication

The Snap Conversions API can be used as a standalone API or alongside other Snapchat solutions. To minimize signal loss and create more efficient results, Tealium recommends passing the same events through the Snap Conversion API that you have configured in your Snap Pixel.

Snap Conversions API shows only Event Deduplication if the following conditions are met:

  • Snap App ID and/or Pixel ID has multiple sources (API, SDK, etc.)

  • Events are for the same conversion type (Web, App, or Offline)

  • The selected event is added on 2 or more sources

Connector Actions

Action Name AudienceStream EventStream
Send Conversion

Configure Settings

Go to the Connector Marketplace and add a new connector. See the Connector Overview for general instructions on how to add a connector.

Action Settings - Parameters and Options

Click Next or go to the Actions tab. This is where you configure connector actions.

This section describes how to set up parameters and options for each action.

Action - Send Conversion

Parameters

Parameter Description
Event Type
  • Select event type from drop-down list.
Event Conversion Type
  • Select event conversion type from drop-down list.
Pixel ID
  • The Pixel ID associated with your Ad Account.
App ID
  • The unique ID assigned for a given application.
  • Numeric for iOS.
  • Google Advertising ID (GAID) for Android.
Snap App ID
  • The Snap App ID associated with your app (a unique code generated in Ads Manager and included in your MMP dashboard).
Event Tag
  • Custom event set label.
  • Example: in-store, weekend sales, back-to-school campaign
  • May be used for future tagging and audience targeting.
Timestamp
  • The Epoch timestamp for the conversion happening.
  • If this field is not mapped, it will be initialized with the current timestamp.
Description
  • A string description for additional information.
Number Items
  • Number of items (integer, singular value).
  • If this field is mapped to array, it will be converted to the sum of array elements.
Currency
  • Standard ISO 4217 code.
  • Example: EUR, USD, JPY.
Transaction ID
  • Transaction ID or order ID tied to the conversion event.
Level
  • Represents a level in the context of a game.
Client Dedup ID
  • ID that is used to identify this single request.
  • Used to differentiate this request from other requests in the same batch.

    This is an advanced feature; first ensure that you are confident with your approach if using this as a deduplication key.

| | Data Use |
  • For iOS 14.5 and above users, indicate if we should treat the event as opt-in or opt-out.
  • For `OPT_OUT` user events, value is a list with only the value of `lmu`.
| | Search String |
  • The text that was searched for.
| | Page Url |
  • The URL of the web page where the event took place.
  • Must include protocol.
| | Sign Up Method |
  • A string indicating the sign up method, such as `Facebook`, `Email`, or `Twitter`.
| | Item Category |
  • Category of item(s).
| | Item ID |
  • International Article Number (EAN), when applicable, or other product or category identifier.
  • Map array and list values to keys to be passed to Snapchat.
  • All arrays and lists should be of equal length.
  • Single value attribute will be converted to array containing single value.
| | Price |
  • Price of the item.
| | Email Address (apply SHA256 hashed) |
  • Provide a plain text email address and the connector will hash this value in the format Snapchat expects.
  • Empty or null hashed values are ignored.
| | Email Address (already SHA256 hash) |
  • Provide an email address that has been SHA256 hashed.
| | Mobile Ad ID (already SHA256 hashed) |
  • Provide a mobile ad ID.
  • Example: `iOS`, `IDFA`, or `GAID`, that has been SHA256 hashed.
  • Empty or null hashed values are ignored.
| | Mobile Ad ID (apply SHA256 hash) |
  • Provide a plain text mobile ad ID.
  • Example: `iOS`, `IDFA`, or `GAID` and the connector will hash this value in the format Snapchat expects.
| | Phone Number (already SHA256 hashed) |
  • Provide a phone number that has been SHA256 hashed.
  • Empty or null hashed values are ignored.
| | Phone Number (apply SHA256 hash) |
  • Provide a plain text phone number and the connector will hash this value in the format Snapchat expects.
| | IP Address (already SHA256 hashed) |
  • Provide a IP address that has been SHA256 hashed.
  • Empty or null hashed values are ignored.
| | IP Address (apply SHA256 hash) |
  • Provide a plain text IP address and the connector will hash this value in the format Snapchat expects.
  • Use the Client IP attribute (recommended).
| | Vendor Identifier (already SHA256 hashed) |
  • Provide a vendor identifier that has been SHA256 hashed.
  • Empty or null hashed values are ignored.
| | Vendor Identifier (apply SHA256 hash) |
  • Provide a plain text vendor identifier and the connector will hash this value in the format Snapchat expects.
| | User Agent |
  • Use the User Agent attribute.
  • If this field is not mapped in EventStream, it will be auto-mapped to the attribute User Agent.
  • If this field is not mapped in AudienceStream, it will be auto-mapped to the visitor's last User Agent.
|

Was this page helpful?

This page was last updated: November 9, 2022