S2S 展示收益 API

展示层级收入数据能帮助您更好地理解用户，精准计算 ROI，并打造精确的 LTV 模型。对于受支持的平台，MAX 会为您提供每个展示的数据，包括收入、广告来源和素材信息。

您可以直接自行处理此数据。 您还可以让任何 AppLovin 支持的数据分析提供商对数据进行分析 (您可以在本页的 MMP 集成：从 MAX 到 MMP 部分查看这些服务商的列表）。

将 MAX 接入您的应用

您可以通过以下三种方式获取用户层级收入数据：

1. 用户收入 API： 使用该 API 调取每日用户层级收入数据。您可以用两种形式导出这些数据：汇总某个特定用户的数据，或以每次展示一行的形式导出。数据会在 UTC 当日结束 8 小时后提供。要了解更多信息，请参阅用户收入 API 文档页面。
2. 客户端： 您可以在客户端实时访问展示层级用户收入数据。在本文档中，您可以找到 Android 和 iOS 的集成说明。
3. Server-to-Server: You can also access real-time revenue data on the server side. To do this, provide an impression postback that tracks impression-level user ad revenue data. Contact your account team or <SupportLink title=“支持团队” /> to enable this feature. This feature, and the macros that the impression postback supports, are described in the “Server-to-Server Impression Revenue API” section of this page.

MMP 集成：MAX 到 MMP

MAX 拥有多位分析合作伙伴，他们可以帮助您在一个控制面板中就访问您的所有数据。您可以与任何 AppLovin 支持的合作伙伴合作，获取展示层级广告收入或汇总广告收入数据。这些受支持的合作伙伴包括 Adjust、GameAnalytics、AppsFlyer 和 Singular。如需了解这些合作伙伴的能力，请参阅他们维护的文档页面。

服务器端到服务器端展示收入 API

Contact your account team or <SupportLink title=“支持团队” /> to enable this feature.

AppLovin’s servers can send postbacks to an external endpoint whenever they record a MAX impression. You define which endpoint receives these requests. The postbacks are in the form of HTTP or HTTPS GET requests. AppLovin makes these postbacks soon after the impression, but they may be delayed by a few minutes. You can use an impression timestamp macro to reconcile any delay between the impression and the postback times.

如果 5 秒后，您的终端没有做出响应，那么回调请求就会超时。回调请求不可重试。

示例

https://myimpressionserver.com/impression?idfa={IDFA}&user_id={USER_ID}&event={EVENT_ID}&token={EVENT_TOKEN}

可用宏

您可以将下表中的任意宏加入到回调 URL 。上述示例 URL 中包含 {IDFA}、{USER_ID}、{EVENT_ID} 和 {EVENT_TOKEN} 宏。当 AppLovin 服务器向您的终端发出请求时，这些宏就会被准确的值代替。

名称	描述
{AD_UNIT_ID}	MAX ad unit ID (16 hex characters)<br /><br />Example: 9ad0816ac071552a
{AD_UNIT_NAME}	Ad unit name (URL-encoded)<br /><br />Example: My%20App%20Banners
{AD_UNIT_TEST_NAME}	Name of the ad unit test, URL-encoded<br /><br />Example: Control
{ALL_REVENUE}	Estimated revenue, including FB Bidding estimates<br /><br />Examples: 0.0121, 5.74466e-05
{CC}	Two-letter country code of the user<br /><br />Example: gb
{CUSTOM_DATA}	Custom data passed in from the integration (URL-encoded). AppLovin recommends that you keep the size of the string under 8192 characters. You must not include ampersand (&amp;) characters in the custom data if you include this macro.<br /><br />Example: my%20custom%20data
{DEVICE_TYPE}	User’s device type.<br /><br />Example: Tablet
{EVENT_ID}	Unique event ID, 40 hex characters<br /><br />Example: 8dc948013d71f04264b8e5c1c61933154b226e08
{EVENT_TOKEN}	sha1( «event-ID» + «your-event-key» )<br /><br />Example: e000949f6d851c1f34adae08e6ef1076ba43cf31
{EVENT_TOKEN_ALL}	<code>sha256( «All macros alphabetically as-is, <em>not</em> URL-decoded» + «your-event-key» )</code><br /><br />Note: If EVENT_TOKEN is one of your macros, omit it from the “All macros alphabetically” string.<br /><br />Example: eba615583ed59bc679a495…ff6be5f218702a97a
{FORMAT}	Ad Unit format<br /><br />Examples: reward, banner, inter
{IDFA}	iOS IDFA or Google Advertising ID<br /><br />Example: 860635ea-65bc-eaed-d355-1b5283b30b94
{IDFV}	Identifier for Vendor<br /><br />Example: 4CD1C3C4-3FD7-00F5-1635-7BC6D9387E60
{IP}	User’s IP address. (IPv6 values are URL-encoded)<br /><br />Examples: 162.1.1.1, fe80%3A%3A1ff%3Afe23%3A4567%3A890a%0A
{NETWORK}	Name of the ad network that served the impression. Names should match the names used in the Management API.<br /><br />Example: APPLOVIN_NETWORK
{NETWORK_PLACEMENT}	Placement name of the external ad network<br /><br />Example: ca-app-pub-12345678%2F0987654321
{PACKAGE_NAME}	应用包名 (Android) 或 Bundle ID (iOS)。URL 编码。
{PLACEMENT}	Publisher-defined MAX ad placement name (URL-encoded)<br /><br />Example: Launch%20Screen
{PLATFORM}	Platform<br /><br />Examples: android, ios
{PRECISION}	Information on how precise the revenue value is. Options are: <dl><dt>publisher_defined</dt><dd>if revenue is the price assigned to the line item by the publisher</dd><dt>exact</dt><dd>if revenue is the resulting price of a real-time auction</dd><dt>estimated</dt><dd>if the revenue amount is based on Auto-CPM or FB Bidding estimates</dd><dt>undefined</dt><dd>if no line item amount is defined and there is not enough data to estimate</dd></dl><br />Example: exact
{REVENUE}	Estimated revenue. Set to 0 when FB Bidding.<br /><br />Examples: 0.0121, 5.74466e-05
{TS}	Timestamp of impression (integer, seconds since epoch)<br /><br />Example: 1546300800
{USER_ID}	Publisher-defined, URL-encoded, user ID; maximum length is 8192 characters<br /><br />Example: 7634657898
{WATERFALL_NAME}	The name of the Ad Unit waterfall<br /><br />Example: LAT

设置广告位名称

下面的代码片段展示了如何向广告单元添加广告位名称。 广告位名称的值会替换回调请求中的 {PLACEMENT} 宏：

ActionScript

横幅

AppLovinMAX.setBannerPlacement(«ad-unit-ID», «placement»);

MREC

AppLovinMAX.setMRecPlacement(«ad-unit-ID», «placement»);

插屏

AppLovinMAX.showInterstitial(«ad-unit-ID», «placement»);

原生广告

nativeAdLoader.setPlacement(«placement»);

激励广告

AppLovinMAX.showRewardedAd(«ad-unit-ID», «placement»);

Blueprint

横幅

MREC

插屏

激励广告

C++

横幅

UAppLovinMAX::CreateBanner(«ad-unit-ID», «position»);
UAppLovinMAX::SetBannerPlacement(«ad-unit-ID», «placement»);

MREC

UAppLovinMAX::CreateMRec(«ad-unit-ID», «position»);
UAppLovinMAX::SetMRecPlacement(«ad-unit-ID», «placement»);

插屏

UAppLovinMAX::ShowInterstitial(«ad-unit-ID», «placement»);

激励广告

UAppLovinMAX::ShowInterstitial(«ad-unit-ID», «placement»);

C#

横幅

MaxSdk.CreateBanner(«ad-unit-ID», «position»);
MaxSdk.SetBannerPlacement(«ad-unit-ID», "«placement»");

MREC

MaxSdk.CreateMRec(«ad-unit-ID», «position»);
MaxSdk.SetMRecPlacement(«ad-unit-ID», "«placement»");

插屏

MaxSdk.ShowInterstitial(«ad-unit-ID», "«placement»");

激励广告

MaxSdk.ShowRewardedAd(«ad-unit-ID», "«placement»");

Dart

横幅

AppLovinMAX.createBanner(«ad-unit-ID», «position»);
AppLovinMAX.setBannerPlacement(«ad-unit-ID», «placement»);

MREC

AppLovinMAX.createMRec(«ad-unit-ID», «position»);
AppLovinMAX.setMRecPlacement(«ad-unit-ID», «placement»);

插屏

AppLovinMAX.showInterstitial(«ad-unit-ID», placement: «placement»);

激励广告

AppLovinMAX.showRewardedAd(«ad-unit-ID», placement: «placement»);

GDScript

横幅

AppLovinMAX.createBanner(«ad-unit-ID», «position»);
AppLovinMAX.set_banner_placement(«ad-unit-ID», «placement»);

MREC

AppLovinMAX.createMRec(«ad-unit-ID», «position»);
AppLovinMAX.set_mrec_placement(«ad-unit-ID», «placement»);

插屏

AppLovinMAX.show_interstitial(«ad-unit-ID», «placement»);

激励广告

AppLovinMAX.show_rewarded_ad(«ad-unit-ID», «placement»);

Java

横幅

adViewAd.setPlacement( "«placement»" );

插屏

interstitial.showAd( "«placement»" );

激励广告

rewardedAd.showAd( "«placement»" );

原生广告

nativeAdLoader.setPlacement( "«placement»" );

原生广告 (Ad Placer)

MaxAdPlacerSettings settings = new MaxAdPlacerSettings( "«ad-unit-ID»" );
settings.setPlacement( "«placement»" );

JavaScript (Cordova)

横幅

AppLovinMAX.createBanner(«ad-unit-ID», «position»);
AppLovinMAX.setBannerPlacement(«ad-unit-ID», «placement»);

MREC

AppLovinMAX.createMRec(«ad-unit-ID», «position»);
AppLovinMAX.setMRecPlacement(«ad-unit-ID», «placement»);

插屏

AppLovinMAX.showInterstitial(«ad-unit-ID», «placement»);

激励广告

AppLovinMAX.showRewardedAd(«ad-unit-ID», «placement»);

JavaScript (React Native)

横幅 (程序化)

AppLovinMAX.createBanner(«ad-unit-ID», «position»);
AppLovinMAX.setBannerPlacement(«ad-unit-ID», «placement»);

横幅 (原生 UI 组件)

import { AdView, AdFormat } from 'react-native-applovin-max';
⋮
<AdView adUnitId={«ad-unit-ID»}
        adFormat={AdFormat.BANNER}
        placement={«placement»} />

MREC (程序化)

import { MRecAd } from 'react-native-applovin-max';
⋮
MRecAd.createAd(«ad-unit-ID», «position»);
MRecAd.setPlacement(«ad-unit-ID», «placement»);

MREC (原生 UI 组件)

import { AdView, AdFormat } from 'react-native-applovin-max';
⋮
<AdView adUnitId={«ad-unit-ID»}
        adFormat={AdFormat.MREC}
        placement={«placement»} />

插屏

import { InterstitialAd } from 'react-native-applovin-max';
⋮
InterstitialAd.showAd(«ad-unit-ID», "«placement»");

激励广告

import { RewardedAd } from 'react-native-applovin-max';
⋮
RewardedAd.showAd(«ad-unit-ID», "«placement»");

原生广告

<NativeAdView
  adUnitId={«ad-unit-ID»}
  placement="«placement»"
  ⋮
/>

Kotlin

横幅

adView.setPlacement( "«placement»" )

插屏

interstitial.showAd( "«placement»" )

激励广告

rewardedAd.showAd( "«placement»" )

原生广告

nativeAdLoader.setPlacement( "«placement»" )

原生广告 (Ad Placer)

val settings = MaxAdPlacerSettings( "«ad-unit-ID»" )
settings.placement = "«placement»"

Lua

横幅

applovin.create_banner(«ad-unit-ID», «position»)
applovin.set_banner_placement(«ad-unit-ID», «placement»)

MREC

applovin.create_mrec(«ad-unit-ID», «position»)
applovin.set_mrec_placement(«ad-unit-ID», «placement»)

插屏

applovin.show_interstitial(«ad-unit-ID», «placement»);

激励广告

applovin.show_rewarded_ad(«ad-unit-ID», «placement»);

Objective-C

横幅

adView.placement = @"«placement»";
[adView loadAd];

插屏

[interstitialAd showAdForPlacement: @"«placement»"];

激励广告

[rewardedAd showAdForPlacement: @"«placement»"];

原生广告

nativeAdLoader.placement = @"«placement»";

原生广告 (Ad Placer)

MAAdPlacerSettings *settings = [MAAdPlacerSettings settingsWithAdUnitIdentifier: @"«ad-unit-ID»"];
settings.placement = @"«placement»";

Swift

横幅

adView.placement = "«placement»"
adView.loadAd()

插屏

interstitial.show(forPlacement: "«placement»")

激励广告

rewardedAd.show(forPlacement: "«placement»")

原生广告

nativeAdLoader.placement = "«placement»"

原生广告 (Ad Placer)

let settings = MAAdPlacerSettings(adUnitIdentifier: "«ad-unit-ID»")
settings.placement = @"«placement»"

设置内部用户 ID

下面的代码片段展示了如何使用您的内部用户 ID 来标记用户。 User ID 字符串的长度上限为 8192 个字符。

ActionScript

AppLovinMAX.setUserId("«user-ID»");

C#

MaxSdk.SetUserId("«user-ID»");

Java

val settings = AppLovinSdk.getInstance( this ).getSettings();
settings.setUserIdentifier( "«user-ID»" );

JavaScript

AppLovinMAX.setUserId("«user-ID»");

Kotlin

val settings = AppLovinSdk.getInstance( this ).settings
settings.userIdentifier = "«user-ID»"

Lua

applovin.set_user_id("«user-ID»")

Objective-C

ALSdkSettings *settings = [ALSdk shared].settings;
settings.userIdentifier = @"«user-ID»";

Swift

let settings = ALSdk.shared().settings
settings.userIdentifier = "«user-ID»"

设置自定义数据

以下代码片段展示了如何向回调添加自定义字符串数据。 该字符串数据将替换回调中的 {CUSTOM_DATA} 宏。 AppLovin 建议字符串不要超过 8192 个字符。

注意

在加载横幅广告或 MREC 广告之前，必须设置自定义数据。 否则，数据将不会出现在与广告关联的回调中。

横幅和 MREC

C#

MaxSdk.SetBannerCustomData("«ad-unit-ID»", "«custom-data»"); // Banners
MaxSdk.SetMRecCustomData("«ad-unit-ID»", "«custom-data»"); // MRECs

Java

adViewAd.setCustomData( "«custom-data»" );

JavaScript

BannerAd.setCustomData("«ad-unit-ID»", "«custom-data»"); // Banners
MRec.setCustomData("«ad-unit-ID»", "«custom-data»"); // MRECs

Kotlin

adView.setCustomData( "«custom-data»" )

Objective-C

adView.customData = @"«custom-data»";

Swift

adView.customData = "«custom-data»"

插屏

C#

MaxSdk.ShowInterstitial(«adUnitIdentifier», «placement», «custom data»);

Java

MaxInterstitialAd.showAd(«placement», «custom data»);

JavaScript

InterstitialAd.showAd(interAdUnitId, "«placement»", "«custom data»");

Kotlin

MaxInterstitialAd.showAd(«placement», «custom data»)

Objective-C

-[MAInterstitialAd showAdForPlacement:customData:]

Swift

[interstitialAd showAdForPlacement: @"«placement»" customData: @"«custom-data»"];

激励广告

C#

MaxSdk.ShowRewardedAd(«adUnitIdentifier», «placement», «custom data»);

Java

MaxRewardedAd.showAd(«placement», «custom data»);

JavaScript

RewardedAd.showAd(adUnitId, "«placement»", "«custom data»");

Kotlin

MaxRewardedAd.showAd(«placement», «custom data»)

Objective-C

-[MARewardedAd showAdForPlacement:customData:]

Swift

rewardedAd.show(forPlacement: "«placement»" customData: "«custom-data»")

原生广告

Java

nativeAdLoader.setCustomData( "«custom data»" );

JavaScript

<NativeAdView
  adUnitId={«ad-unit-ID»}
  customData="«custom-data»"
  ⋮
/>

Kotlin

nativeAdLoader.setCustomData( "«custom data»" )

Objective-C

nativeAdLoader.customData = @"«custom data»";

Swift

nativeAdLoader.customData = "«custom data»"