Enable Tapjoy (New)

Overview

Tapjoy is a mobile advertising and app monetization platform that connects advertisers with users through value-exchange advertising. Connect Tapjoy to Branch to attribute clicks and installs, forward conversion events via postbacks, and deep link users into your app.

For more information about integrating ad partners in general, visit our Ad Partner Integration Guide.

Note: this guide is for new Branch

Please note that this guide is about integrating Tapjoy in the new Branch experience. For information on Tapjoy in legacy Branch, visit our legacy guide.

Partner capabilities

Before you begin

To set up the Tapjoy integration, you need:

• Branch's Performance product enabled for your Branch account. Contact your Branch account manager or visit https://branch.io/pricing.

• A Branch account with access to Configuration > Ad Partners and admin permissions to enable and configure integrations.

• The Branch SDK implemented in your app (iOS | Android) with event tracking configured.

• Active campaigns running in Tapjoy.

Enable Tapjoy

To begin, navigate to Configuration > Ad Partners > Tapjoy.

Tapjoy doesn't require credentials to activate. The integration is enabled automatically when you select Enable Tapjoy on the Tapjoy page, and postbacks for the standard event set will activate immediately.

(Recommended) To configure the optional PAM for Publishers privacy setting, select Partner settings to open the Manage account dialog and enable the toggle. When enabled, PAM for Publishers removes advertiser-specific user identifiers from postbacks for users who haven't opted in via Apple's App Tracking Transparency (ATT) framework, prioritizing identifiers provided directly by Tapjoy.

Configure attribution

By default, Tapjoy uses your global app attribution settings. To set attribution windows specific to Tapjoy, enable the Override global app settings toggle on the Attribution windows tab.

For more information, follow Configure attribution in the general Ad Partner Integration Guide.

Configure postbacks

Enabling Tapjoy automatically activates postbacks for INSTALL, OPEN, and PURCHASE. The default postback URL template is:

https://api.tapjoy.com/v3/tpat_app_events?tracker_partner_id=branch&app_id=${(ad_network.goal_ids["${(name)!}"])!}&advertising_id=<#if (user_data.os)! == "IOS" && (user_data.idfa)! != "">${(user_data.idfa)!}<#elseif (user_data.os)! == "IOS">${(user_data.idfv)!}<#elseif (user_data.os)! == "ANDROID">${(user_data.aaid)!}&tjcid=${ (last_attributed_touch_data.~click_id)! }&event_time=${ (timestamp/1000)?long }&event_name=${ (name)! }&tapjoy_attributed=<#if (install_activity.touch_data.dollar_3p)?? && ad_network.machine_name?? && (install_activity.touch_data.dollar_3p)! == (ad_network.machine_name)!>1<#else>0&bundle_id=<@loop data=app.app_bundles val="bundle"><#if user_data.os == bundle.os><#if bundle.os=="ANDROID">${(bundle.android.package_name)!}<#elseif bundle.os == "IOS">${(bundle.ios.bundle_id)!}<@break/>&app_version=${ (user_data.app_version)! }&platform=${ (user_data.os)! }&device_type=${ (user_data.model)! }&os_version=${ (user_data.os_version)! }&country_code=${ (user_data.geo_country_code)! }&user_agent=${ (user_data.user_agent)! }&event_value=${(custom_data.event_value)!}

To add postbacks for additional events or to customize postback behavior, follow Configure postbacks in the general Ad Partner Integration Guide.

Create a Branch Ad Link

Create a Branch Ad Link to use in your Tapjoy campaigns. Branch uses the link to attribute clicks and deep link users into your app.

Follow Create a Branch Ad Link in the general Ad Partner Integration Guide.

Verify your data

After your integration is connected and events are flowing, you can verify data is reaching Branch and Tapjoy:

• In Branch Liveview: confirm that events from your app appear in real time. This is the fastest way to confirm SDK events are firing.

• In Branch Analysis dashboards: review attributed installs and events where Ad Partner Name = Tapjoy.

• In Tapjoy: confirm that forwarded events are appearing in your Tapjoy attribution reporting.

Data mappings

Campaign data

Branch populates the following fields from Tapjoy campaign data.