Set up App Samurai

App Samurai is an ad network integrated with Adjust. Our integration lets App Samurai receive attribution and in-app event data through automated callbacks.

In this article, learn how to set up measurement with App Samurai for your app. This includes activating the integration, creating a campaign link, and choosing what data Adjust can share with App Samurai.

Before you begin

Requirements

iOS | Android | Windows | Unity | React Native | Flutter | Adobe Air | Cordova | Marmalade | Xamarin | Cocos2d-x | Titanium | Corona

Select App Samurai and your app in Campaign Lab

  1. Under Campaign Lab, select Partners.
  2. Select New partner > App Samurai. Select Next to move to the next screen.
  3. In the App selection screen, choose the app for which you want to create the link, and enable the integration to share data with App Samurai.
  4. Select Next.

Enable data sharing

Enable data sharing to activate the integration with App Samurai. To enable data sharing:

  1. Turn on Enabled

Once you enable data sharing with App Samurai, Adjust automatically sends App Samurai the following data, by default:

  • install
  • reinstall
  • reattribution

Set your data sharing options

If you’re working with a multi-platform app with data sharing enabled for multiple platforms, you can:

  1. Separate data sharing options at the platform-level by selecting Use platform-specific settings.
  2. Set the same data sharing settings for multiple platforms by selecting Use global settings.

Now, under What will be shared by default?, review the activities that Adjust shares with App Samurai by default.

  • install
  • reinstall
  • reattribution

Send additional data

Choose the amount and type of data that you want to share with App Samurai through callbacks. App Samurai may use this information to optimize performance.

  1. Under What sources of data do you want to share?, choose the attribution source of the data you are sharing with App Samurai:
  • Data from all attribution sources
  • Only data attributed to App Samurai

Ad revenue (from ad views)

Ad revenue sharing lets App Samurai receive user ad revenue data. This lets App Samurai use ad revenue data to optimize your user targeting and campaigns.

Growth solution:

This feature is available with Adjust’s Ad Revenue package. To purchase our Ad Revenue package, contact your sales representative.

To share ad revenue to App Samurai, select one or more Ad Revenue Sources.

  • If you leave this field empty, we send ad revenue data from all integrated mediation sources.

Sessions

Adjust does not automatically send session callbacks due to the high volume of sessions. Sharing sessions means App Samurai will receive your app’s session activity.

Uninstalls or reinstalls

Sharing uninstalls or reinstalls lets App Samurai receive your app’s uninstall and/or reinstall data measured by Adjust.

Note:

For iOS apps, you might expect a low record of uninstalls and/or reinstalls. For more information, visit Uninstall and reinstall measurement.

In-app revenue (from in-app purchases)

Sharing in-app revenue lets App Samurai receive revenue amounts along with your revenue event data. You need to map events that generate revenue to share this data.

Map events

Map events that you want to share to the values that App Samurai can receive. Data for unmapped events is not shared with App Samurai.

Map individual events

If you have a multi-platform app, you can choose to share different events per platform with App Samurai. This lets you:

  • Set individual events to manage campaign strategies for each platform.
  • Customize data sharing per platform.

Under Map events, follow these steps to choose the in-app events you want to directly send to App Samurai.

  1. Select Map event.
  2. In the Adjust event list, choose the Adjust event that you want to share with App Samurai.
  3. Under Partner event, you need to select the App Samurai event that corresponds to the Adjust event.
    1. For single platform apps and multi-platform apps with data sharing enabled for a single platform only, you map events for that platform only. For multi-platform apps with data sharing enabled for multiple platforms, you can:
      • Select Use platform-specific mapping to map separate events at the platform-level or to not map events for certain platforms.
      • Select Use global mapping to map the same events for all platforms.
    2. In the Partner event list, choose or enter a custom event name, that you want to map the Adjust event to.
  4. Select Apply.

Now App Samurai will receive in-app event data for each of your linked events.

Map all events

If App Samurai supports mapping all events automatically, under Map events, select Map all events. This saves time in mapping individual events.

Now App Samurai will receive in-app event data for all your linked events.

Map parameters

You usually need to map parameters to share custom data with App Samurai.

Partner parameters (available in Adjust SDK version 4.0+) let Adjust collect custom data points from your app and send them to App Samurai. This lets App Samurai receive custom event details for each of your linked events.

Before adding new partner parameters to the Adjust SDK, make sure no pre-existing partner parameters already fit your requirements.

To share partner parameters to App Samurai, follow these steps.

  1. Set up partner parameters within the Adjust SDK.
  2. Under Set your data sharing options, select Parameters.
  3. Under Map parameters, you can specify how you want to send partner parameters defined in the SDK to the network:
    1. Select Map parameter.
    2. In the SDK parameter field, enter the name of the SDK parameter you want to share with the network.
    3. In the Partner parameter field, enter the network parameter that corresponds to the SDK parameter.
Note:

If you set up partner parameters within the Adjust SDK without setting up parameter sharing in the dashboard, Adjust forwards the parameters as named in the Adjust SDK.

Configure your link and settings

You have the option to set your:

Create your link and share it with App Samurai

In the Setup review screen, you can review your choices. You can also go back and make changes to:

  • Your selected app
  • Data sharing options
  • Link structure parameters
  • User destinations
  • Attribution settings

Select Create link to create your click URL, impression URL, QR code and link token. Creating a link also enables data sharing and the integration with App Samurai.

Once you’ve created your link, share it with App Samurai for placement in campaigns.

List of all parameters forwarded to App Samurai

App Samurai requires Adjust to send the following parameters (data points) with your callbacks:

PlaceholderInformation
{android_id}Android ID (Android only)
{city}Device city
{click_attribution_window}Attribution window settings for device matching (hours)
{country}Device two-character country code
{currency}Original ISO 4217 currency code sent from Adjust SDK
{device_name}Device model number
{device_type}Device type
{event_name}Event name, as set in the Dashboard
{idfa||gps_adid}IDFA, or GPS ADID if IDFA is empty
{ip_address}Device IP address
{is_reattributed}1 if user was reattributed at least once from an earlier source. 0 if user has never been reattributed
{isp}Device internet service provider
{language}Device two-character language code
{match_type}Attribution method
{mcc}Mobile country code: three-digit code identifying a device's country. Use with the mobile network code to identify a device's carrier.
{mnc}Mobile network code: two-digit code. Use with the mobile country code to identify a device's carrier.
{os_version}Operating system version number
{partner_parameters}Custom partner parameters collected by the Adjust SDK or S2S request and transmitted to third party providers via postbacks
{revenue_float}Revenue, as sent from Adjust SDK, in whole currency units
{sdk_version}Adjust SDK version (per app)
{tracking_limited}1 if tracking is limited, 0 if not
{user_agent}Incoming raw user agent
{app_version_short}App version number (Android), release-version-number for the bundle (iOS)
{connection_type}Internet connection type
{created_at}Activity timestamp
{install_begin_time}App download began timestamp (Android and Google Play Store only)
{install_finish_time}App download completion timestamp
{installed_at}Install (i.e., first app open) timestamp
{reattributed_at}Reattribution timestamp
{referral_time}User landed on app Play Store page timestamp (Android and Google Play Store only)
{reinstalled_at}Reinstall timestamp
{uninstalled_at}Uninstall timestamp (estimation based on last session time)
{ad_impressions_count}Number of mobile ads served to end users
{ad_revenue_network}Ad network that displayed the ad
{ad_revenue_unit}Ad unit that generated the revenue
{ad_revenue_placement}User placement, as defined on the platform
{ad_mediation_platform}Mediation platform name