Innovid Destination
Destination Info
- Accepts Page, and Track calls
- In Device-mode, refer to it as TV Squared in the Integrations object
Components
Innovid’s XP platform enables you to pull same-day TV performance analytics so you can manage TV spend and create data-driven TV media plans based on network, days, programs, and genres.
Getting Started
-
From the Segment web app, click Catalog.
-
Search for “Innovid” in the Catalog, select it, and choose which of your JavaScript sources to connect the destination to.
-
Add your InnovidXP Brand ID and Client ID to your Segment Settings UI. You can find this within your Innovid dashboard.
-
Segment automatically loads InnovidXP’s JavaScript tracking snippet onto the page once analytics.js loads. Make sure you remove Innovid’s snippet from your code.
-
InnovidXP automatically starts recording events after approximately 45 minutes, once the CDN is updated.
Page
If you’re not familiar with the Segment Specs, take a look to understand what the Page method does. An example call would look like:
analytics.page();
When you call page
in Analytics.js, Segment calls InnovidXP’s Basic Hit Tracker
. Analytics.js library sends a page
call on every page on which it is loaded, so unless you want to call Basic Hit Tracker
more than once, you shouldn’t need to do anything additional here.
Track
If you’re not familiar with the Segment Specs, take a look to understand what the Track method does. An example call would look like:
analytics.track('Completed Purchase', {
revenue: 42.99,
promo: 'COUPON1',
orderId: '12345',
productType: 'Clothing'
});
When you call track
in Analytics.js, Segment calls InnovidXP’s Action Tracker
- where in addition to the event name
, you can specify a dictionary of properties that will get sent to Innovid.
As per the example above, InnovidXP requires that you pass in a revenue
, productType
, orderId
, and promo
property into each of your calls. If you cannot provide a value for one or more of the aforementioned properties, don’t worry, you can simply pass in an empty string to send the event.
Event Allow-listing
For each event that you want to track (for example, using analytics.track(your_event_name, …)
), you must allow-list the event in your destination settings (under “Event Allow-list”). For example, if you want analytics.track('Order Completed')
and analytics.track('Sale')
events to be sent, then you must add Order Completed and Sale to this list.
Custom Track Properties
In addition, you can set up your destination to pass in any number of custom properties with your call. For instance, you could expand the example above to include listViewed
and browswer
:
analytics.track('Completed Purchase', {
revenue: 42.99,
promo: 'COUPON1',
orderId: '12345',
productType: 'Clothing',
listViewed: 'Fashion',
browser: 'Chrome'
});
In order to take advantage of this feature, similar to Event Allow-listing, you must add “Custom Metrics” to your destination settings. This will let you put in the specific additional metrics you want to send (the required properties are already sent automatically). In this case, you’d add listViewed
and browser
.
Settings
Segment lets you change these destination settings from the Segment app without having to touch any code.
Setting | Description |
---|---|
Brand Id (required) |
string . Enter your TV Squared brand id |
Client ID (required) |
string , defaults to 0 . Your TV-Squared client ID. This is used to load the TVSquared script onto your page. |
Custom Metrics | array , defaults to . Add any additional custom properties you’d like to check, separated by a line break. |
Event Whitelist | array , defaults to . This is where you will define which specific events, when sent via analytics.track(your_event_name, …) will be sent to TVSquared. For example, if you want analytics.track(‘Order Completed’) and analytics.track(‘Sale’) events to be sent, then add Order Completed and Sale to this list. |
This page was last modified: 20 Jun 2023
Need support?
Questions? Problems? Need more info? Contact Segment Support for assistance!