> For the complete documentation index, see [llms.txt](https://help.branch.io/llms.txt).

# Enable Tapjoy (New)

> Integrate Tapjoy with Branch for seamless mobile advertising and app monetization, enabling deep linking, attribution, and real-time event logging.

## Overview

[Tapjoy](https://unity.com/products/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](https://help.branch.io/marketer-hub/ad-partner-integration-guide-new.md).

> **Note: this guide is for new Branch**
>
> Please note that this guide is about integrating Tapjoy in the [new Branch experience](https://help.branch.io/marketer-hub/new-branch-overview.md). For information on Tapjoy in legacy Branch, visit our [legacy guide](https://help.branch.io/marketer-hub/tapjoy.md).

### Partner capabilities

| Capability | Details |
| --- | --- |
| Company type | Non-SAN ad network |
| Deep linking | Supported |
| Attribution | Click-through attribution, View-through attribution |
| Ad campaign types | Contact Tapjoy for details |
| Ad formats | Contact Tapjoy for details |
| Click types | Server-side click |
| Supported platforms | iOS, Android |
| Cost ingestion support | Not supported |
| Pricing models | CPI, CPC, CPA, CPV, CPE |

## Before you begin

To set up the Tapjoy integration, you need:

- Ad partner integrations enabled for your Branch account. Availability varies by Branch plan. See [Branch pricing](https://www.branch.io/pricing/) or contact your Branch representative.
- 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](https://help.branch.io/developer-hub/ios-sdk-overview.md) | [Android](https://help.branch.io/developer-hub/android-sdk-overview.md)) with [event tracking](https://help.branch.io/developer-hub/track-branch-events.md) configured.
- Active campaigns running in Tapjoy.
- [PAM](https://help.branch.io/marketer-hub/predictive-aggregate-measurement.md) enabled (recommended).

> **Note: PAM uses two separate toggles**
>
> The **PAM for Publishers** toggle for this partner, found under **Partner settings** > **Manage account**, is separate from the account-level **PAM switch**. **PAM for Publishers** must be enabled to reconcile conversion events with your partner. To attribute events with PAM, you also need PAM enabled on the [Attribution page](https://help.branch.io/account-hub/attribution-page-new.md) under **Configuration** > **Attribution**. Learn more in our [PAM Overview](https://help.branch.io/marketer-hub/predictive-aggregate-measurement.md#pam-for-publishers).

## 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](https://help.branch.io/marketer-hub/predictive-aggregate-measurement.md#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](https://help.branch.io/marketer-hub/ad-partner-integration-guide-new.md#configure-attribution) in the general [Ad Partner Integration Guide](https://help.branch.io/marketer-hub/ad-partner-integration-guide-new.md).

## 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](https://help.branch.io/marketer-hub/ad-partner-integration-guide-new.md#configure-postbacks) in the general [Ad Partner Integration Guide](https://help.branch.io/marketer-hub/ad-partner-integration-guide-new.md).

## 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 Ad Links](https://help.branch.io/marketer-hub/ad-links-new.md).

## Verify your data

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

- **In Branch** [**Liveview**](https://app.branch.io/testing-and-monitoring/events): 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**](https://help.branch.io/marketer-hub/analysis-dashboards-overview-new.md): 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.

| Branch field | Partner data |
| --- | --- |
| `~advertising_partner_name` | `"Tapjoy"` (static) |