AppLovin MAX S2S Impression Revenue API

Last updated 10/03/2026

tip

Note that data generated by third-party data integration counts toward the cluster's data consumption

Summary

Interface overview

Interface	Type	Granularity	Attribution	Cost	Revenue	Impressions	Clicks	Conversions
MAX S2S Impression Revenue API	Callback	User level			✅	✅

AppLovin provides a way to send back data through the MAX S2S Impression Revenue API. Whenever a monetization ad is displayed, AppLovin sends impression-level revenue data back to the configured callback link.

Integration process

1. Integrate the AppLovin SDK and the AE SDK, and set the AE user identification IDs in the AppLovin SDK
2. Log in to the AE backend, go to the Third-party Integration module, add an AppLovin MAX S2S Impression Revenue API plan, and complete the related configuration
3. Log in to the AppLovin dashboard and configure the callback URL
4. Check whether the AE system receives the data successfully, and build reports

1. Client SDK configuration

The first step in integrating AppLovin data is to connect the AE SDK with the AppLovin SDK on the client.

1.1 Option 1 (automatic linking)

• If you integrate the Android or iOS SDK:

  • If the SDK version is 2.8.0~2.8.1, you can use this option directly
  • If the SDK version is 2.8.2 or later, you also need to install the third-party data plugin. For details, see Android SDK third-party data and iOS SDK third-party data

tip

Note that AE SDK initialization and the code that enables automatic integration must run before the AppLovin SDK is initialized. Follow these steps:

1. Initialize the AE SDK.

2. Call `enableThirdPartySharing` to set the distinct ID automatically.

3. Initialize the AppLovin SDK.

The following are code samples for the SDK on each platform:

Android

// 1. Initialize the Android SDK
TDConfig config = TDConfig.getInstance(this, APPID, TE_SERVER_URL);
TDAnalytics.init(config);
// 2. Call the enableThirdPartySharing API to set ta_distinct_id in AppLovin events
TDAnalytics.enableThirdPartySharing(TDThirdPartyType.APPLOVIN_IMPRESSION)
// 3. Initialize the AppLovin SDK
//  ...

iOS

// 1. Initialize the iOS SDK
TDConfig *config = [[TDConfig alloc] init];
config.appid = appid;
config.serverUrl = url;
[TDAnalytics startAnalyticsWithConfig:config];
// 2. Call the enableThirdPartySharing API to set ta_distinct_id in AppLovin events
[TDAnalytics enableThirdPartySharing:TDThirdPartyTypeAppLovin];
// 3. Initialize the AppLovin SDK
//  ...

This option works by automatically calling the setUserIdentifier() method of the AppLovinSdk SDK internally to pass in the distinct ID of the AE project.

1.2 Option 2 (manual linking)

With manual linking, you use the setUserIdentifier() API in AppLovin to set the distinct ID of the AE project.

tip

Note that AE SDK initialization and the setUserIdentifier call must run before the AppLovin SDK is initialized. Follow these steps:

1. Initialize the AE SDK.

2. Call `setUserIdentifier` to set the distinct ID.

3. Initialize the AppLovin SDK.

The following are manual integration code samples for the SDK on each platform:

Android

// 1. Initialize the Android SDK
TDConfig config = TDConfig.getInstance(this, APPID, TE_SERVER_URL);
TDAnalytics.init(config);
// 2. Get the AE distinct ID, which corresponds to #distinct_id in AE
String distinctId = TDAnalytics.getDistinctId();
// 3. Set the distinct ID in events collected by AppLovin
AppLovinSdk.getInstance(context).setUserIdentifier(distinctId);
// 4. Initialize the AppLovin SDK
//  ...

iOS

// 1. Initialize the iOS SDK
TDConfig *config = [[TDConfig alloc] init];
config.appid = appid;
config.serverUrl = url;
[TDAnalytics startAnalyticsWithConfig:config];
// 2. Get the AE distinct ID, which corresponds to #distinct_id in AE
NSString *distinctId = [TDAnalytics getDistinctId];
// 3. Set the distinct ID in events collected by AppLovin
[ALSdk shared].userIdentifier = distinctId;
// 4. Initialize the AppLovin SDK
//  ...

Unity

// 1. Initialize the Unity SDK
TDConfig config = new TDConfig("APPID","SERVER");
TDAnalytics.Init(config);
// 2. Get the AE distinct ID, which corresponds to #distinct_id in AE
var distinctId = TDAnalytics.GetDistinctId();
// 3. Set the distinct ID in events collected by AppLovin
MaxSdk.SetUserId(distinctId);
// 4. Initialize the AppLovin SDK
//  ...

2. Plan configuration

After completing the SDK configuration, log in to the AE backend and complete the AppLovin MAX S2S Impression Revenue API configuration in the Third-party Integration module. The image below shows the AppLovin configuration page:

2.1 User identification fields

Because AppLovin sends back user-level data, you need to set user identification rules for it, that is, the fields in the AppLovin callback data that correspond to #distinct_id and #account_id. Based on this configuration, the AE system sets these fields as the user identification fields of the data when it converts the callback data.

If you configured the client SDK as described in the previous step of this document, use the following configuration:

• Field associated with the account ID: none
• Field associated with the distinct ID: user_id

2.2 Event Data Configuration

After you turn on the Event Data Configuration switch, all data sent back is written to the event table. We recommend that you enable event data ingestion.

2.3 User Properties Configuration

By default, the AE system does not write AppLovin callback data to user properties. To write some fields to the user table, first turn on the rule so that it runs, and then use the Property Mapping feature to add the fields to write to the user table. For Source Property, enter the ingested name of the field. For details, see Section 3.1:

2.4 Configuration

In the Configuration module, you can control the detailed settings of data pulling, such as the event name after ingestion.

Module	Name	Description
sink_event	event_name	Event name after ingestion; customizable

2.5 End Point

End Point shows the URL at which the AE system receives AppLovin callback data. Copy this URL directly and use it as the main callback URL when you configure AppLovin callbacks in the next step:

If no URL is displayed here, open Project Settings → Settings → Implementation from the menu in the upper right corner and configure the URL for public network. This URL is the data reporting URL configured in the AE SDK. After configuring it, go back to End Point on the AppLovin configuration page and copy the endpoint URL.

3. Complete the AppLovin callback configuration

3.1 Callback macro settings

Finally, you need to configure the callback URL. The fields that can be received in the callback data are called "macros". By default, we recommend that you pull all fields (that is, configure all macros). The following table lists all macros supported by MAX S2S Impression Revenue API:

Macro	Ingested name	Description	Required or optional
{AD_UNIT_ID}	ad_unit_id	MAX ad ID
{AD_UNIT_NAME}	ad_unit_name	MAX ad name
{AD_UNIT_TEST_NAME}	ad_unit_test_name	Name of the ad test group
{ALL_REVENUE}	all_revenue	Estimated revenue, including revenue from FB Bidding	Yes
{CC}	cc	Two-letter Country Code
{CUSTOM_DATA}	custom_data	Custom data set through the SDK
{EVENT_ID}	event_id	Unique event ID
{EVENT_TOKEN}	event_token	Event token (generated from the unique event ID)
{EVENT_TOKEN_ALL}	event_token_all	Global event token (generated from the unique event ID and all request parameter macros)
{FORMAT}	format	Ad type
{IDFA}	idfa	IDFA on iOS or Google Advertising ID on Android
{IDFV}	idfv	IDFV
{IP}	ip	User's IP address
{NETWORK}	network	The Ad Network that displayed the ad
{NETWORK_PLACEMENT}	network_placement	Internal Placement name of the Ad Network
{PACKAGE_NAME}	package_name	Package name: the App Package Name on Android and the Bundle ID (iOS) on iOS
{PLACEMENT}	placement	Placement name customized in the SDK
{PLATFORM}	platform	Platform
{PRECISION}	precision	Precision of the revenue data, which depends on the data source: publisher_defined: the price set by the publisher exact: the result of real-time bidding estimated: an estimate from Auto CPM or FB Bidding undefined: not enough data to estimate revenue
{REVENUE}	revenue	Estimated revenue; the value is 0 for FB Bidding	Yes
{TS}	ts	Time of the ad impression	Yes
{USER_ID}	user_id	User ID set by the SDK, which corresponds to the distinct ID of the AE project	Yes
{WATERFALL_NAME}	waterfall_name	Name of the ad Waterfall

The following are the callback macros we recommend. The first part is the callback URL you obtained in Section 2.5. Append the ? and everything after it to the endpoint URL, and provide the result to AppLovin staff to complete the callback URL configuration (use the Server-to-Server Impression Revenue API):

https://{receiver-host}/attribution/callback/applovin/{app-id}?ad_unit_id={AD_UNIT_ID}&ad_unit_name={AD_UNIT_NAME}&ad_unit_test_name={AD_UNIT_TEST_NAME}&all_revenue={ALL_REVENUE}&cc={CC}&custom_data={CUSTOM_DATA}&event_id={EVENT_ID}&event_token={EVENT_TOKEN}&event_token_all={EVENT_TOKEN_ALL}&format={FORMAT}&idfa={IDFA}&idfv={IDFV}&ip={IP}&network={NETWORK}&network_placement={NETWORK_PLACEMENT}&package_name={PACKAGE_NAME}&placement={PLACEMENT}&platform={PLATFORM}&precision={PRECISION}&revenue={REVENUE}&ts={TS}&user_id={USER_ID}&waterfall_name={WATERFALL_NAME}

3.2 Data ingestion rules

• user_id in the data is used as the distinct ID of the data. This field should correspond to the distinct ID in the AE project
• The ts field in the data, that is, the ad impression time, is used as the event's #event_time
• With the default configuration, the event name is -- applovin_max_s2s_impression_revenue
• All other fields configured in the callback link are stored

3.3 Standardized fields

The following event properties are standardized:

Original field	Standardized field	Description
network_name	te_ads_object.media_source	Media source
ad_mediation_platform	te_ads_object.media_source	Monetization channel
campaign_name	te_ads_object.campaign_name	Campaign name
google_ads_campaign_name	te_ads_object.campaign_name	Campaign name (Google Ads data only)
google_ads_campaign_id	te_ads_object.campaign_id	Campaign ID (Google Ads data only)
adgroup_name	te_ads_object.ad_group_name	Ad group name
google_ads_adgroup_name	te_ads_object.ad_group_name	Ad group name (Google Ads data only)
google_ads_adgroup_id	te_ads_object.ad_group_id	Ad group ID (Google Ads data only)
creative_name	te_ads_object.ad_name	Ad name
google_ads_creative_id	te_ads_object.ad_id	Ad ID (Google Ads data only)
ad_revenue_placement	te_ads_object.placement	Monetization ad placement
google_ads_placement	te_ads_object.placement	Ad placement (Google Ads data only)
cost_amount	te_ads_object.cost	Campaign cost
cost_currency	te_ads_object.currency	Currency of the user acquisition spend
revenue_usd	te_ads_object.revenue	Monetization revenue
Fixed value USD	te_ads_object.currency	Currency of the monetization revenue
country	te_ads_object.country	Country or region code
os_name	te_ads_object.platform	Platform, such as Android or iOS
app_id	te_ads_object.app_id	App ID
app_name	te_ads_object.app_name	App name