Implement Snapchat Conversions API Program via ATS for Web
You can integrate your ATS for Web configuration with the Snapchat Conversions API Program for Online Conversions to easily collect event data and send it to Snapchat. Make sure you have fulfilled the requirements for setting up the Conversions API for Snacphat before you get started.
Once you have added the required information, you can now set up the type of events that you want to send to Snapchat.
Set Up ATS for Web to Send Event Data to Snapchat
The procedure below is a direct continuation of the steps from Set Up Snapchat Conversions API Integration in Console.
Note
Make sure to first-party cookies from Snapchat in the same domain where ATS for Web is running.
After providing the Snapchat account ID and authentication token you can now specify the events you want to send to Snapchat. Under ‘Events List’, click .
Enter an Event Name.
Select the Event Type to determine which event you want to send to Snapchat. This list is predefined by Snapchat.
(Optional) If your website is leveraging data layer run by Google Tag Manager or Adobe Analytics, you can enable Data Layer Detection. If you enable this option, all parameters in this event will be obtained through data layer detection by default.
Note
The data layer detection functionality currently supports data layer run Google Tag Manager and Adobe Analytics. To learn more, see Google's article "The data layer" or Adobe's article "Create a data layer".
After enabling this feature, call the
ats.detectDataLayerEvents()function when you know the event data have been stored on data layer. Make sure to call the function on every single page where you want ATS.js to detect the event.In the Event Deduplication section, select how the Event ID should be obtained, and for which identifier. The Event ID is used to eliminate duplicate events by assigning a unique identifier to each event. In the example below, we are using the order number as the Event ID.
Note
CSS selector allows you to obtain the parameter by targeting a specific HTML element in your page. We recommend using only ID selector to limit errors. For example; #product-value, #ItemValue
Alternatively, you can provide a URL parameter which is added at the end of a URL after the ‘?’ symbol. For example; currency, product-currency
If you selected the Purchase event type, you must provide additional parameters under Required Custom Data for the Currency and Price. Select URL or CSS Selector for each parameter and provide the required data to define where the related information could be obtained.
Note
If you want to pass predefined values, you can also select Hardcoded Value and enter a value you want to pass for the parameter. For example, if the transactions on your website are always in US dollars, you may want to set the value to "USD" for the Currency parameter.
You cannot set hardcoded values for Event Deduplication.
(Optional) Enable Add Customer Information to include additional parameters based on the customer's location.
Tip
You can add more parameters by clicking the plus button and remove them by clicking the minus button.
In the Custom Data section, enable 'Add Custom Data Parameters' to add additional custom parameters defined by Snapchat. We recommend you select as many parameters as you already have on your website. The more parameters you add, the more accurate the data Snapchat will receive.
The following parameters are available to select from:
Brands: Brands associated with the item_ids in the conversion event.
Customer Status: Indicates the registration status of the customer.
Delivery Method: Indicates the delivery method of the order.
Description: A string description for additional info.
Event Tag: Custom event to set labels to an event. Note that this event is currently not surfaced in measurement or audience generation, but may become usable in the future.
Item Category: Item or category of the item. For example, “coats”, “shoes”, etc.
Item IDs: International Article Number (EAN) when applicable, or other product or category identifier.
Level: Represents a level in the context of a game.
Number of Items: The number of items.
Search String: The text that was searched for.
Sign-Up Method: A string indicating the sign-up method.
Currency: Currency used in standard ISO 4217 code. For example: USD, AUD, CNY, etc.
Price: Value of the purchase.
Set up the Trigger event to decide when the events should be sent. You can select Automatically to have it sent every time the event happens, or Manually by creating an API call when all event data are available on the page.
Automatically (recommended): Events are automatically sent at the end of each user session. This can be either when the user closes the page or switches tabs.
Manually: You trigger the JavaScript function when you know all information is obtained. This can be done by calling
ats.sendSnapchatEvents(['name_of_event']), where'name_of_event'should be replaced with the event name you provided in step 2.
Note
For non-checkout events such as 'Add To Cart', 'Signup', and others, we recommend setting up a trigger event only on some pages to make sure they are not fired on every page load.
Specify to have the trigger added to all pages by selecting Always, or in specific pages by selecting On some pages. If you choose the latter, you need to provide the page URL and a domain identifier to specify when the module should start detection to obtain all conversion data from the page. Click the plus button to add multiple pages.
Click .
Once you are done with setting up the events, the Snapchat CAPI will collect and send the event data to Snapchat whenever the specified events occur on your website. All the captured conversion events should be visible in Snapchat Ads Manager where you can manage and track your Event Quality Score (EQS).
See Snapchat’s article “How to Access and View Your Event Quality Score” to learn more.