# Set up Spotad

Spotad is a network and Adjust module partner. Our integration lets Spotad receive attribution and in-app event data through automated callbacks. 

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

## [Basic setup](basic-setup)

  
To turn on Adjust’s integration with Spotad, 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 __Spotad__
4. Enter your ACCOUNT ID and BRAND ID (for help finding these, contact your Spotad representative)
5. Optional: see [advanced setup](#advanced-setup) to customize your callbacks
6. Select Save

Well done! Basic setup is complete. Now you can create an [Adjust tracker URL](https://help.adjust.com/en/article/basic-tracker-setup) and submit it to Spotad to launch your campaign.
  
Spotad will receive callbacks for these activities:

 - click
 - install
 - session
 - reattribution
 - event
 - rejectedInstall

## [Advanced setup](advanced-setup)

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


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

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

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

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

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

__Note:__ Link at least one [revenue event] to Spotad before turning on In-App Revenue Forwarding.

### [Forward sessions](forward-sessions)

Adjust does not automatically send session callbacks due to the high volume of sessions.

To forward in-app sessions to Spotad, follow these steps.

1. Find your app and select your app options caret (^)
2. Select __Partner Setup__ > __Spotad__
3. Turn on __Session Forwarding__

Now Spotad will receive your app’s session activity.

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

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

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

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

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

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

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

| Placeholder |	Information |
| ---------- | ---------- |
| `{gps_adid}` | Google Play Store advertising ID |
| `{idfa}` | ID for advertisers (iOS only) |
| `{match_type}` | Attribution method |
| `{os_version}` | Operating system version number |
| `{revenue_usd}` | Revenue, in US dollars |
| `{app_version}` | App version number (Android), build-version-number for the bundle (iOS) |
| `{created_at}` | Activity timestamp |
| `{impression_based}` | 1 if impression-based engagement, 0 if not |
| `{rejection_reason}` | Reason for a rejected attribution |
| `{is_s2s}` |  1 if server to server engagement, 0 if not |

Spotad logo

# Set up {DisplayName}

{DisplayName} is a network and Adjust module partner. Our integration lets {DisplayName} receive attribution and in-app event data through automated callbacks. 

Use our basic setup instructions to turn on Adjust’s integration and send callbacks to {DisplayName}. Then, use our advanced setup instructions to customize what information {DisplayName} receives. 
<if value="NeedsActivationInstructions">
## [Basic setup](basic-setup)
<if value="PartnerUiSetup">
In your {DisplayName} dashboard:

<parse html="PartnerUiSetup" />
</if>
  
To turn on Adjust’s integration with {DisplayName}, 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 __{DisplayName}__
<switch length="Tokens">
  <case length="0"> 4. Turn on __Enabled__</case>
  <case length="1"> 4. Enter your {Tokens} (for help finding this, contact your {DisplayName} representative)</case>
  <case length="2"> 4. Enter your {Tokens} and {Tokens} (for help finding these, contact your {DisplayName} representative)</case>
  <case length="3"> 4. Enter your {Tokens}, {Tokens}, and {Tokens} (for help finding these, contact your {DisplayName} representative)</case>
</switch>
5. Optional: see [advanced setup](#advanced-setup) to customize your callbacks
6. Select Save

Well done! Basic setup is complete. Now you can create an [Adjust tracker URL](https://help.adjust.com/en/article/basic-tracker-setup) and submit it to {DisplayName} to launch your campaign.
  
{DisplayName} will receive callbacks for these activities:

<list value="Callbacks" />

<if value="BasicSetupNotes">
<parse html="BasicSetupNotes" />
</if>
</if>
<if value="NeedsOptionalSetupInstructions">
## [Advanced setup](advanced-setup)

Choose which data {DisplayName} receives from Adjust by customizing your setup.

<if value="IsAttributedOnly">
### [Only forward data attributed to {DisplayName}](only-forward-data-attributed)

Adjust sends {DisplayName} your installs and reattributions across all ad platforms.

To stop {DisplayName} from receiving data attributed to other ad platforms, follow these steps.

1. Find your app and select your app options caret (^)
2. Select __Partner Setup__ > __{DisplayName}__
3. Turn on __Attributed Only__

Now {DisplayName} will only receive data attributed to their own platform.
</if>
<if value="IsOrganicOnly">
### [Only forward organic data](only-forward-organic-data)

Adjust sends {DisplayName} both organic and paid attribution data. 

To stop {DisplayName} from receiving paid data, follow these steps.

1. Find your app and select your app options caret (^)
2. Select __Partner Setup__ > __{DisplayName}__
3. Turn on __Organic Only__

Now {DisplayName} will only receive organic data.
</if>
<if value="SendClicks">
### [Forward clicks](forward-clicks)

Adjust does not automatically send click callbacks due to the high volume of clicks.

To forward click data to {DisplayName}, follow these steps.

1. Find your app and select your app options caret (^)
2. Select __Partner Setup__ > __{DisplayName}__
3. Turn on __Send Clicks__

Now {DisplayName} will receive all of your app’s click data.
</if>
<if value="IsRevenueForwarding">
### [Forward in-app revenue](forward-in-app-revenue)

In-app revenue forwarding lets {DisplayName} receive revenue amounts along with your revenue event data.

To forward in-app revenue to {DisplayName}, follow these steps.

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

Now {DisplayName} will receive the revenue amount for every tracked transaction.

__Note:__ Link at least one [revenue event] to {DisplayName} before turning on In-App Revenue Forwarding.
</if>
<if value="IsAdRevenueForwarding">
### [Forward ad revenue](forward-ad-revenue)

Ad revenue forwarding lets {DisplayName} receive user ad revenue data. This feature is available with Adjust’s Ad Revenue package. To purchase our Ad Revenue package, contact your sales representative.

To forward ad revenue to {DisplayName}, follow these steps.

1. Find your app and select your app options caret (^)
2. Select __Partner Setup__ > __{DisplayName}__
3. Turn on __Ad Revenue Forwarding__

Now {DisplayName} can use ad revenue data to optimize your user targeting and campaigns.
</if>
<if value="IsUninstallForwarding">
### [Forward uninstalls / reinstalls](forward-uninstalls--reinstalls)

To forward uninstalls and/or reinstalls to {DisplayName}, follow these steps.

1. Find your app and select your app options caret (^)
2. Select __Partner Setup__ > __{DisplayName}__
3. Turn on __Uninstall / Reinstall Forwarding__

Now {DisplayName} will receive all of your app’s uninstall and/or reinstall data.
</if>
<if value="IsSessionForwarding">
### [Forward sessions](forward-sessions)

Adjust does not automatically send session callbacks due to the high volume of sessions.

To forward in-app sessions to {DisplayName}, follow these steps.

1. Find your app and select your app options caret (^)
2. Select __Partner Setup__ > __{DisplayName}__
3. Turn on __Session Forwarding__

Now {DisplayName} will receive your app’s session activity.
</if>
<if value="IsPartnerParameterForwarding">
### [Forward custom data](forward-custom-data)

Partner parameters (available in Adjust SDK version 4.0+) let Adjust collect custom data points from your app and send them to {DisplayName}.

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

To forward partner parameters to {DisplayName}, follow these steps.

1. Set up partner parameters within the Adjust SDK (instructions for [iOS](https://github.com/adjust/ios_sdk#partner-parameters) and [Android](https://github.com/adjust/android_sdk#partner-parameters))
2. In the Adjust dashboard, find your app and select your app options caret (^)
3. Select __Partner Setup__ > __{DisplayName}__
4. Turn on __Parameter Forwarding__
5. Select __Partner Parameter Mapping__
6. In the __FROM APP__ field, enter the name of your Adjust parameter (as written into the Adjust SDK). In the __TO PARTNER__ field, enter your corresponding {DisplayName} name.
7. Select __Save__

Now {DisplayName} will receive custom event details for each of your linked events.

__Note:__ If you set up partner parameters within the Adjust SDK without turning on Partner Parameter Mapping, Adjust forwards the parameters as named in the Adjust SDK.
</if>
<if value="EventLinking">
### [Forward in-app events](forward-in-app-events)

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

To forward in-app events to {DisplayName}, follow these steps.

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

Now {DisplayName} will receive in-app event data for each of your linked events.
</if>
</if>
<if value="PartnerSpecificSetup">
## [Partner specific setup instructions](partner-specific-setup-instructions)

<parse html="PartnerSpecificSetup" />
</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>


Placeholder	Information
`{gps_adid}`	Google Play Store advertising ID
`{idfa}`	ID for advertisers (iOS only)
`{match_type}`	Attribution method
`{os_version}`	Operating system version number
`{revenue_usd}`	Revenue, in US dollars
`{app_version}`	App version number (Android), build-version-number for the bundle (iOS)
`{created_at}`	Activity timestamp
`{impression_based}`	1 if impression-based engagement, 0 if not
`{rejection_reason}`	Reason for a rejected attribution
`{is_s2s}`	1 if server to server engagement, 0 if not