# Set up Ampush

Ampush is an Adjust module partner. Our integration lets Ampush receive attribution and app event data for the following self-attributing networks:

 - Facebook


Use our basic setup instructions to turn on Adjust’s integration and send callbacks to Ampush. Then, use our advanced setup instructions to customize what information Ampush receives. 

## [Basic setup](basic-setup)


To turn on Adjust’s integration with Ampush, follow these steps.

1. Find your app and select your app options caret (^)
2. Select Partner __Setup__ > __ADD PARTNERS__
3. Select the add (+) icon next to __Ampush__
4. Enter your ADVERTISER NAME (for help finding this, contact your Ampush representative)
5. Optional: see [advanced setup](#advanced-setup) to customize your callbacks
6. Select Save

Well done! Basic setup is complete. Ampush will receive callbacks for these activities:

 - install
 - session
 - reattribution
 - event

## [Advanced setup](advanced-setup)

Choose which data Ampush receives from Adjust by customizing your setup.


### [Forward in-app revenue](forward-in-app-revenue)

In-app revenue forwarding lets Ampush receive revenue amounts along with your revenue event data.

To forward in-app revenue to Ampush, follow these steps.

1. Find your app and select your app options caret (^)
2. Select __Partner Setup__ > __Ampush__
3. Turn on __In-App Revenue Forwarding__

Now Ampush will receive the revenue amount for every tracked transaction.

__Note:__ Link at least one [revenue event](/en/article/revenue-events) to Ampush before turning on In-App Revenue Forwarding.

### [Forward in-app events](forward-in-app-events)

Event linking lets Ampush receive in-app event data. You can link every in-app event in Adjust to a preset Ampush name or a custom event name.

To forward in-app events to Ampush, follow these steps.

1. Find your app and select your app options caret (^)
2. Select __Partner Setup__ > __Ampush__ > __Event Linking__
3. Find the event you want to link and update the field with a Ampush event or your own custom name
4. When you finish linking events, select __OK__
5. Select __Save__

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

## [Partner specific setup instructions](partner-specific-setup-instructions)


Ampush only receives data on filtered Facebook traffic. This is designed so that you can manage your Ampush Facebook traffic separately from other Facebook campaigns that you might be running.

Only Facebook campaigns that are named to include the keyword _ampush_ will be transmitted to Ampush. That is, you must include the keyword in the campaign name of each campaign that you want to manage with Ampush. Campaigns that do not include the keyword will not be transmitted to Ampush.

## [List of all parameters forwarded to Ampush](list-of-all-parameters-forwarded)

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

| Placeholder |	Information |
| ---------- | ---------- |
| `{fb_adgroup_id}` | Facebook ad ID |
| `{fb_adgroup_name}` | Facebook ad name |
| `{fb_campaign_id}` | Facebook ad set ID |
| `{fb_campaign_name}` | Facebook ad set name |
| `{random}` | Random number (unique per callback) |
| `{revenue}` | Revenue, as sent from Adjust SDK in cents |
| `{click_time_hour}` | Attributed click timestamp, rounded to the nearest hour |
| `{impression_time_hour}` | Attributed impression timestamp, rounded to the nearest hour |

Ampush logo

# Set up {DisplayName}

{DisplayName} is a SAN campaign manager that manages campaigns for the following self-attributing networks (SANs):

<list value="selfAttributingNetworks" />

To run a campaign with a SAN campaign manager, you don't need to create a link. Instead, you need to set up both the SAN whose platform your ads will run on, and the SAN campaign manager who is managing your campaign. 

As soon as you start running campaigns with the SAN campaign managers, Adjust shares data for analysis and campaign optimization with both the SAN and SAN campaign manager.

:::{note}

Meta refers to SAN campaign managers as Meta Business Partners. 

:::

In this article, learn how to set up measurement with {DisplayName} for your app. This includes activating the integration and choosing what data Adjust can share with {DisplayName}.

## [Before you begin](before-you-begin)

__Requirements__

- [Admin, Editor, or Custom Editor permissions](/en/article/permission-levels) in Adjust.
- [Enable the SAN](/en/article/self-attributing-network-san-setup) whose platform your ads will run on.
- Adjust SDK v4.0.0 and later to map SDK parameters to {DisplayName} parameters. Follow the guides linked below to use this feature.

[iOS](https://dev.adjust.com/en/sdk/ios/features/events#add-partner-parameters) | [Android](https://dev.adjust.com/en/sdk/android/features/events#add-partner-parameters) | [Windows](https://dev.adjust.com/en/sdk/windows/features/events#add-partner-parameters) | [Unity](https://dev.adjust.com/en/sdk/unity/features/events#add-partner-parameters) | [React Native](https://dev.adjust.com/en/sdk/react-native/features/events#add-partner-parameters) | [Flutter](https://dev.adjust.com/en/sdk/flutter/features/events#add-partner-parameters) | [Adobe Air](https://github.com/adjust/adobe_air_sdk#partner-parameters) | [Cordova](https://dev.adjust.com/en/sdk/cordova/features/events#add-partner-parameters) | [Marmalade](https://github.com/adjust/marmalade_sdk#partner-parameters) | [Xamarin](https://github.com/adjust/xamarin_sdk#partner-parameters) | [Cocos2d-x](https://dev.adjust.com/en/sdk/cocos2dx/features/events#add-partner-parameters) | [Titanium](https://github.com/adjust/titanium_sdk#partner-parameters) | [Corona](https://github.com/adjust/corona_sdk#partner-parameters)

<if value="Tokens">

__Credentials__

<switch length="Tokens">
  <case length="1"> {Tokens}</case>
  <case length="2"> {Tokens} and {Tokens}</case>
  <case length="3"> {Tokens}, {Tokens}, and {Tokens}</case>
</switch> 

   - For help finding your credentials, contact your {DisplayName} representative.
   
</if>

<if value="NeedsActivationInstructions">

<if value="PartnerUiSetup">

  __In your {DisplayName} dashboard:__

<parse html="PartnerUiSetup" />
</if>

</if>

## [Select {DisplayName} and app in Campaign Lab](select-network-in-campaign-lab)

1. Under __Campaign Lab__, select __Partners__.
2. Select __New partner > {DisplayName}__. Select __Next__ to move to the next screen.
3. In the __App selection__ screen, choose the app for which you want to set up {DisplayName}. 
4. Select __Next__.

## [Enable data sharing](enable-data-sharing)

Enable data sharing to activate the integration with {DisplayName}. To enable data sharing:

<switch length="Tokens">
  <case length="0"> 1. Turn on Enabled</case>
  <case length="1"> 1. Enter your {Tokens}.</case>
  <case length="2"> 1. Enter your {Tokens} and {Tokens}.</case>
  <case length="3"> 1. Enter your {Tokens}, {Tokens}, and {Tokens}.</case>
</switch>

<if value="SendClicks">
Adjust does not automatically send click callbacks due to the high volume of clicks. To send clicks to {DisplayName}, enable the __Send clicks__ toggle.
</if>

Once you enable data sharing with {DisplayName}, Adjust automatically sends {DisplayName} the following data, by default:
<list value="Callbacks" />

<if value="NeedsOptionalSetupInstructions">
</if>

## [Set your data sharing options](set-your-data-sharing)

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 {DisplayName} by default:

<list value="Callbacks" />

### Send additional data

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

<if value="IsAttributedOnly">
Under __What sources of data do you want to share?__, choose the attribution source of the data you are sharing with {DisplayName}:

- Data from all attribution sources
- Only data attributed to {DisplayName}
</if>

To send additional data, you can review and customize the following:

<if value="IsOrganicOnly">
  Adjust sends {DisplayName} both organic and paid attribution data.
</if>

<if value="IsAdRevenueForwarding">
#### [Ad revenue (from ad views)](ad-revenue)

Ad revenue sharing lets {DisplayName} receive user ad revenue data. This lets {DisplayName} use ad revenue data to optimize your user targeting and campaigns.

:::{growthSolution}

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

:::

To share ad revenue with {DisplayName}, select one or more __Ad Revenue Sources__.
  - If you leave this field empty, we send ad revenue data from all integrated mediation sources.
</if>

<if value="IsSessionForwarding">
#### [Sessions](sessions)

Adjust does not automatically send session callbacks due to the high volume of sessions. Sharing sessions means {DisplayName} will receive your app’s session activity.
</if>

<if value="IsUninstallForwarding">
#### [Uninstalls or reinstalls](uninstalls-reinstalls)

Sharing uninstalls or reinstalls lets {DisplayName} 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](/en/article/uninstalls-reinstalls).

:::
</if>

<if value="IsRevenueForwarding">
#### [In-app revenue (from in-app purchases)](in-app-revenue)

Sharing in-app revenue lets {DisplayName} receive revenue amounts along with your revenue event data. You need to map events that generate revenue to share this data.
</if>

<if value="EventLinking">
#### [Map events](map-events)

  Map events that you want to share to the values that {DisplayName} can receive. Data for unmapped events is not shared with {DisplayName}.
   
##### Map individual events

If you have a multi-platform app, you can choose to share different events per platform with {DisplayName}. 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 {DisplayName}.

1. Select __Map event__.
2. In the __Adjust event__ list, choose the Adjust event that you want to share with {DisplayName}.
3. Under __Partner event__, you need to select the {DisplayName} 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 {DisplayName} will receive in-app event data for each of your linked events.

##### Map all events

If {DisplayName} supports mapping all events automatically, under __Map events__, select __Map all events__. This saves time in mapping individual events.
   
Now {DisplayName} will receive in-app event data for all your linked events.

</if>

</if>

<if value="IsPartnerParameterForwarding">

  #### [Map parameters](map-parameters)

You usually need to map parameters to share custom data with {DisplayName}. 

Partner parameters (available in Adjust SDK version 4.0+) let Adjust collect custom data points from your app and send them to {DisplayName}. This lets {DisplayName} 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 {DisplayName}, follow these steps.

1. Set up partner parameters within the Adjust SDK.
   - Check [Before you begin](#before-you-begin) for all SDK development platform links.
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.

:::

</if>

## [Enable {DisplayName} for your app](enable-partner) 

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

Select __Enable partner__ to enable {DisplayName} for your app. This also enables data sharing, if you've set it up.

## [Set up your campaign with keyword in the {DisplayName} dashboard](set-up-your-campaign-with-keyword-in-the-partner-dashboard)

Set up your campaign in the {DisplayName} dashboard. While setting up the campaign, you need to enter a keyword to the campaign name. Keywords are not case-sensitive.

If you do not add the keyword to the campaign name, Adjust cannot identify the campaigns that you're managing through {DisplayName}. This means the SAN still receives data for the campaign, but you can't see which campaigns are managed by {DisplayName} in your reporting and {DisplayName} will not receive any callbacks from Adjust.

<if value="PartnerSpecificSetup">
## [Partner specific setup instructions](partner-specific-setup-instructions)

<parse html="PartnerSpecificSetup" />
</if>

<if value="CampaignKeywords">
### [Campaign keyword for {DisplayName}](keywords-list)

The keyword for {DisplayName} is:
   
<list value="CampaignKeywords" />  
</if>

<if value="DataList">
## [List of all parameters forwarded to {DisplayName}](list-of-all-parameters-forwarded)

{DisplayName} requires Adjust to send the following parameters (data points) with your callbacks:

<table value="DataList" />
</if>

Take your growth to the next level with Adjust’s setup guides, best practices, and FAQs.

Marketer

Integrate our APIs and open-source SDKs with your apps and business analytics.


Developer

In-depth advice for our global Technology Partners on how best to work with Adjust.


Placeholder	Information
`{fb_adgroup_id}`	Facebook ad ID
`{fb_adgroup_name}`	Facebook ad name
`{fb_campaign_id}`	Facebook ad set ID
`{fb_campaign_name}`	Facebook ad set name
`{random}`	Random number (unique per callback)
`{revenue}`	Revenue, as sent from Adjust SDK in cents
`{click_time_hour}`	Attributed click timestamp, rounded to the nearest hour
`{impression_time_hour}`	Attributed impression timestamp, rounded to the nearest hour