Sojern campaign configuration

Introduction

Sojern, one of AppsFlyer's integrated partners, is an ad network that specializes in programmatic buying for the travel market.

To configure your campaigns with Sojern, follow the steps below.

Setting up sojern

Go to the dashboard of your app and click Integrated Partners on the left bar.

Enter "Sojern" in the search field and click on its logo to open Sojern's configuration window.

Select Sojern for Advertisers to run In-App Advertising campaigns using Sojern Travel Data.
Select Sojern to collect and monetize your App Data through an Advertising Campaign.

Sojern's configuration window includes 2 active tabs: Integration and Attribution link. Click on the items below to read about the tabs setup.

For a detailed description of the Partner Configuration Window Header, click here.

Tip

The General Settings step in the Integration tab is mandatory for all partners
All the rest of the steps are either descriptive or optional

Integration tab

The Integration Tab is divided into different sections as described below.

Activate partner

On the first visit here, you will need to toggle below. ON the Activate Partner button to enable setup of the integration tab's parameters. The toggle MUST be ON for as long as you work with the partner.
For more details about partner activation please click here.

Note

As an ALL-Installs network, Sojern prefers to receive postbacks for all new installs of your app from ANY source, including organic. It is recommended to select Events attributed to any partner to send all install postbacks to Sojern.

General settings

Partner ID

Sojern connects with AppsFlyer via a unique Partner ID. If you don't already have the Partner ID , you must obtain it from Sojern to continue with the integration.

Default postbacks

AppsFlyer can send automatic postbacks to Sojern following user installs and re-engagements. Use this section to define the source of the users that allow sending these postbacks.

Select Only events attributed to this partner for events coming only from users attributed to Sojern.
Select Events attributed to any partner or organic to have your entire user base available to be reported to Sojern.

In-app events settings

In this section you can map your AppsFlyer events with Sojern via postbacks.

Enter the Sojern Partner ID again.
Toggle In-App Event Postbacks to ON.
Select the Sending Option for all SDK defined events.
- Only events attributed to this partner for events coming only from users attributed to this partner
- Events attributed to any partner or organic to have your entire user base available to be reported to the partner
Click Add Event to add an SDK Event to the list.
For more details regarding Sojern In-App Events, click here.
Complete the following parameters:

Parameter Name	Description
SDK Event Name	The name of the event, as received by AppsFlyer either from the SDK integrated in your app, or from server to server events. Tip - If you don't see the event you want in the list, make sure to activate the event on a device with a non-organic installation and recheck.
Partner Event Identifier	The unique name or ID of each event as defined on Sojern's side. Obtain the corresponding Event ID from Sojern and set in the text field.
Send Revenue	When unchecked - AppsFlyer sends all the parameters of the rich in-app event to the partner, except for the revenue parameter, which is contained in the af_revenue parameter. When checked - AppsFlyer sends all the parameters including the revenue value (if it exists in the event).

Event types

Sojern requires the implementation of the following events:

Hotel

Type of Event	Sojern Events	SDK Event	Description
Homepage	HOME_PAGE	af_app_opened	App open/brought to the foreground
Search Result	HOTEL_SEARCH	af_list_view	Search result page showing a list of options
Product	HOTEL_PRODUCT	af_content_view	View of a specific product/option from the search results
Confirmation	HOTEL_CONFIRMATION	af_purchase	Purchase of the item(s)

Flight

Type of Event	Sojern Events	SDK Event	Description
Homepage	HOME_PAGE	af_app_opened	App open/brought to the foreground
Search Result	FLIGHT_SEARCH	af_list_view	Search result page showing a list of options
Product	FLIGHT_PRODUCT	af_content_view	View of a specific product/option from the search results
Confirmation	FLIGHT_CONFIRMATION	af_purchase	Purchase of the item(s)

Cruise

Type of Event	Sojern Events	SDK Event	Description
Homepage	HOME_PAGE	af_app_opened	App open/brought to the foreground
Search Result	CRUISE_SEARCH	af_list_view	Search result page showing a list of options
Product	CRUISE_PRODUCT	af_content_view	View of a specific product/option from the search results
Confirmation	CRUISE_CONFIRMATION	af_purchase	Purchase of the item(s)

Car

Type of Event	Sojern Events	SDK Event	Description
Homepage	HOME_PAGE	af_app_opened	App open/brought to the foreground
Search Result	CAR_SEARCH	af_list_view	Search result page showing a list of options
Product	CAR_PRODUCT	af_content_view	View of a specific product/option from the search results
Confirmation	CAR_CONFIRMATION	af_purchase	Purchase of the item(s)

Entertainment

Type of Event	Sojern Events	SDK Event	Description
Homepage	HOME_PAGE	af_app_opened	App open/brought to the foreground
Search Result	ENTERTAINMENT_SEARCH	af_list_view	Search result page showing a list of options
Product	ENTERTAINMENT_PRODUCT	af_content_view	View of a specific product/option from the search results
Confirmation	ENTERTAINMENT_CONFIRMATION	af_purchase	Purchase of the item(s)

Train

Type of Event	Sojern Events	SDK Event	Description
Homepage	HOME_PAGE	af_app_opened	App open/brought to the foreground
Search Result	RAIL_SEARCH	af_list_view	Search result page showing a list of options
Product	RAIL_PRODUCT	af_content_view	View of a specific product/option from the search results
Confirmation	RAIL_CONFIRMATION	af_purchase	Purchase of the item(s)

Vacation

Type of Event	Sojern Events	SDK Event	Description
Homepage	HOME_PAGE	af_app_opened	App open/brought to the foreground
Search Result	VACATION_SEARCH	af_list_view	Search result page showing a list of options
Product	VACATION_PRODUCT	af_content_view	View of a specific product/option from the search results
Confirmation	VACATION_CONFIRMATION	af_purchase	Purchase of the item(s)

Attribution link tab

In this tab, you can create the attribution links you want to send to Sojern for attributing Sojern's campaigns, ad sets or even single ads. Note that AppsFlyer DOES NOT save your generated partner's attribution links.

This tab is divided into different sections:

Attribution link parameters

In this section, select which parameters you want to add to the attribution link.

Adding parameters to the attribution link here enables you to later perform thorough drill-down analyses. Parameters that are already defined on the attribution link can be edited by adding them and their new values here.

Campaign - add it to compare different campaigns running with Sojern.
Attribution link parameter: c
Adset - set ad set names to compare different ad sets within specific Sojern campaigns.
Attribution link parameter: af_adset
Ad Name - set ad set names to compare different creatives within specific ad sets within specific campaigns Sojern.
Attribution link parameter: af_ad
Site ID and Sub Site ID - set Site ID parameter to attribute installs to specific publishers. If many publishers exist, we advise on limiting the number of used site IDs and using the sub site ID parameter, to avoid exceeding the site ID limitations.
Attribution link parameters: af_siteid and af_sub_siteid
Subscriber Parameters - use any of the 5 subscriber parameters to insert useful values. Note that these parameters get parsed and appear in the raw data report, which makes them very handy for performing data aggregation or filtering.
Attribution link parameters: af_sub1, af_sub2, af_sub3, af_sub4, af_sub5

Add any other parameter to the attribution link simply by typing it in a new parameter box. For more information about AppsFlyer's Attribution Link Structure and Parameters.

Click-through attribution

This slider allows you to set the maximum time from click to install. Only installs (first launches) that take place within the lookback window may be attributed to Sojern.

Attribution link parameter: af_click_lookback

More details about the click lookback window here.

Click attribution link

This is the attribution link that contains all the setup information you have set for it. Send it to Sojern to be activated when leads click on a corresponding ad.

Cost tab

Cost integration is not available for Sojern.

Ad revenue tab

Ad Revenue Tab integration is not available for Sojern.

Permissions tab

No configuration of permissions is available for Sojern.

Sojern in-app events

It is important when configuring a campaign with Sojern that specific in-app events are set up.

When the AppsFlyer naming convention is not available, use the Sojern Param key.

Sojern has four types of in-app events:

Confirmation
Product
Search
Cart

Set out below is an example of the Search and Confirmation for the hotel and flight sector:

	Name	Param Key	AppsFlyer Rich In-App Event Name
Flight Search	Event Type	et	value 'fs'
	Number of Travelers	t	af_num_adults + af_num_children + af_num_infants
	Number of adults	tad	af_num_adults
	Numbers of children	tch	af_num_children
	Service Class	fc	af_class
	One Way	fow	N/A
	Multi-city	fmc	N/A
	Website County Domain	dctry	N/A
	Site Domain	domain	N/A
	Origin Airport	fa1	af_destination_a
	Destination Airport	fa2	af_destination_b
	Destination City	fc1	af_city
	Origination City	fc2	N/A
	Departure Date	fd1	af_departing_departure_date
	Return Date	fd2	af_returning_departure_date
Flight Confirmation	Name	Param key
	Event Type	et	value 'fc'
	Number of Travelers	t	af_num_adults + af_num_children + af_num_infants
	Number of adults	tad	af_num_adults
	Numbers of children	tch	af_num_children + af_num_infants
	Service Class	fc	af_class
	Website County Domain	dctry	N/A
	Site Domain	domain	N/A
	Origin Airport	fa1	af_destination_a
	Destination Airport	fa2	af_destination_b
	Destination City	fc1	af_city
	Origination City	fc2	N/A
	Departure Date	fd1	af_departing_departure_date
	Return Date	fd2	af_returning_departure_date
	Purchase Currency	fcu	af_currency
	Purchase Price	fp	af_revenue
Hotel Search	Name	Param key
	Event Type	et	value 'hs'
	Website County Domain	dctry	af_country
	Destination City	hc1	af_city
	Check-In Date	hd1	af_date_a
	Check-Out Date	hd2	af_date_b
	Number of Travelers	t	af_num_adults + af_num_children + af_num_infants
	Number of adults	tad	af_num_adults
	Numbers of children	tch	af_num_children + af_num_infants
	Site Domain	domain	N/A
Hotel Confirmation	Name	Param key
	Event Type	et	value 'hc'
	Website County Domain	dctry	N/A
	Destination City	hc1	af_city
	Check-In Date	hd1	af_date_a
	Check-Out Date	hd2	af_date_b
	Number of Travelers	t	af_num_adults + af_num_children + af_num_infants
	Number of adults	tad	af_num_adults
	Numbers of children	tch	af_num_children + af_num_infants
	Site Domain	domain	N/A
	Destination Country	hn1	af_country
	Purchase Price	hp	af_revenue
	Purchase Currency	hcu	af_currency

Example

Flight Search event values:

In-app event: af_list_view in-app event values: et=‘fs’&af_num_adults={number of adults}&af_num_children={number of children}&af_class={service class}&fow={one way}&fmc={multi city}&dctry={website country domian}&af_destination_a={departure airport code}&af_destination_b={arrival airport code}&af_city={destination city}&fc2={origin city}&af_departing_departure_date={YYYY-MM-DD}&af_returning_departure_date{YYYY-MM-DD}

Introduction

Setting up sojern

Tip