This preview of pull request 1639 is meant for internal use only.

TrafficGuard Destination

TrafficGuard quick info

TrafficGuard is in beta, and accepts Track, Page, Identify, Group, and Alias calls. If you reference it in the Integrations object, call it “TrafficGuard”.

TrafficGuard accepts cloud-mode data from all Segment source types. It does not offer device-mode connections.

TrafficGuard detects, mitigates, and reports on ad fraud before it hits digital advertising budgets. Three formidable layers of protection block both general invalid traffic (GIVT) and sophisticated invalid traffic (SIVT) to ensure that digital advertising results in legitimate advertising engagement.

This destination is maintained by TrafficGuard.

This document is about a destination which is in beta

This means that the TrafficGuard Destination is in active development, and some functionality may change before it becomes generally available.

Getting Started

Before you start, make sure TrafficGuard supports the source type and connection mode you’ve chosen to implement. You can learn more about connection modes here.

Web Mobile Server
📱 Device-mode ⬜️ ⬜️ ⬜️
☁️ Cloud-mode
  1. From the Segment web app, click Catalog.
  2. Search for “TrafficGuard” in the Catalog, select it, and choose which of your sources to connect the destination to.
  3. Enter the “API Key” into your Segment Settings UI which you can find in your property in the TrafficGuard dashboard.

  1. Calls will now be visible in TrafficGuard dashboards in real-time.

NOTE: For TrafficGuard to successfully validate calls, context.ip and context.userAgent values as well as either context.campaign.source, context.app.name or properties.url will need to be sent. Calls without those values will return an error.

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()

Page calls will be sent to TrafficGuard as a pageview event.

Screen

If you’re not familiar with the Segment Specs, take a look to understand what the Screen method does. An example call would look like:

[[SEGAnalytics sharedAnalytics] screen:@"Home"];

Screen calls will be sent to TrafficGuard as a pageview event.

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('Clicked Login Button')

The following track calls will be sent to TrafficGuard as events.

Segment Call TrafficGuard event
Application Installed install
Application Opened, Email Opened open
Products Searched search
Product Viewed, Product Reviewed, Promotion Viewed viewcontent
Product Added Add
Checkout Started checkout
Product Shared, Cart Shared share

All other calls will be recorded as pageview events until TrafficGuard supports ad hoc event types.


Personas

You can send computed traits and audiences generated using Segment Personas to this destination as a user property. To learn more about Personas, contact us for a demo.

For user-property destinations, an identify call is sent to the destination for each user being added and removed. The property name is the snake_cased version of the audience name, with a true/false value to indicate membership. For example, when a user first completes an order in the last 30 days, Personas sends an Identify call with the property order_completed_last_30days: true. When the user no longer satisfies this condition (for example, it’s been more than 30 days since their last order), Personas sets that value to false.

When you first create an audience, Personas sends an Identify call for every user in that audience. Later audience syncs only send updates for users whose membership has changed since the last sync.

Settings

Segment lets you change these destination settings from the Segment app without having to touch any code.

API Key

Your API Key can be found in your TrafficGuard property when the INPUT value is set to ‘Segment’

This page was last modified: 20 Oct 2020



Get started with Segment

Segment is the easiest way to integrate your websites & mobile apps data to over 300 analytics and growth tools.
or
Create free account