ADVERTISE

MONETIZE

User-Level Ad Revenue API

使用此 API 检索用户层级的收入数据。您可以检索特定用户聚合后的数据，也可以检索每个 impression 占一行的明细数据。

用户层级收入数据会在 UTC 日结束 8 小时后提供。例如，UTC 时间 2019-01-01 的数据可在 UTC 时间 2019-01-02 08:00 之后获得。

您可以与您选择的移动测量合作伙伴（MMP）分享用户层级和 impression 层级的广告收入数据，例如 Adjust、AppsFlyer、GameAnalytics 或 Singular，支持所有受支持的 network。您还可以在客户端访问 impression 层级的用户收入数据。您可以在 SDK 集成指南 > Platform > 概览 > 高级设置中阅读更多相关信息。

info

另请参阅

如何查找您的 AppLovin SDK 版本。

每当记录到 MAX impression 时，MAX 都会通过服务器到服务器（S2S）Impression Revenue API 将数据发送到您选择的追踪 URL。有关更多信息，请参阅 S2S impression-level API 文档页面。

info

另请参阅

来自 AppLovin 博客的 “Take Ad-Revenue Attribution to the Next Level With MAX”

请求格式

info

Note

您必须进行认证才能使用此 API。为此，请将 URL 参数 api_key 的值设置为您的 Report Key。

目标 URL

https://r.applovin.com/max/userAdRevenueReport?api_key=«report-key»&date=«report-day»&platform=«app-platform»&application=«app-package-name»&store_id=«app-store-ID»&aggregated=«is-aggregated»

请求参数

名称	说明	示例
`aggregated`	API 是否应聚合数据（按用户）或不聚合（按 impression）。默认为 `true`。	`false`
`api_key`	Report Key，用于认证。	`tgCe3d7SFRU0S…304ZKs6ba`
`application`	应用包名（适用于 Android）或 bundle ID（适用于 iOS）。（如果定义了 `store_id`，则无法使用此参数）	`com.mycompany.application`
`date`¹	要返回数据的日期，格式为 `«YYYY»-«MM»-«DD»`。	`2019-02-06`
`platform`	应用平台：`android`、`fireos` 或 `ios`。	`android`
`store_id`	iOS 上 iTunes ID 的数字部分，或 Android 上的应用包名。如果您不知道 iTunes ID，请改用 bundle ID。如果定义了 `application`，则无法使用此参数。	`1207472156`

¹ 此 API 的请求窗口为 45 天。请确保日期参数在过去 45 天内。

响应格式

响应体

{
  "status": 200,
  "ad_revenue_report_url": "https://applovin-externalreports.s3.amazonaws.com/%2Fmediation_reports/report_date%3D1549756800/pub_id%3D12345/mediation_app_id%3D12345/user_report.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20190216T000208Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=dataio.amazon.s3.access_key%2F20190216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=e45bdfbd88cbcf4e[…]927dd"
}

响应参数

名称	说明
`ad_revenue_report_url`	包含所有收入（包括预估 Meta Audience Network Bidding 数据）的 CSV 文件位置。
`status`	请求状态：如果可以访问用户报告，则为 `200`。

用户层级收入数据 CSV 格式

示例

Ad Unit ID,Placement,IDFA,IDFV,User Id,Impressions,Revenue
da39a3ee5e6b4b0,home_screen,04034992-E5AA-4BA1-890C-5075B2504050,4F2A07BC-315B-11E9-B210-D663BD873D93,20349,27,5.000025
da39a3ee5e6b4b0,level_end,12309422-331C-41A3-9BF5-2D7D1C04A4E0,4F2A0A6E-315B-11E9-B210-AD023491FF20,,11,0.006100

Date,Ad Unit ID,Ad Unit Name,Waterfall,Ad Format,Placement,Country,Device Type,IDFA,IDFV,User ID,Revenue, Ad Placement
2019-07-29 15:53:07.39,97f7d2048121fe62,sc-and-v1,Default Waterfall,BANNER,home-screen,gb,PHONE,34d5d192-4d67-4382-a730-6828a5f769a2,,e41aaf1d-72ea-4c02-8543-27a2ba09a258,0.000079,1642799
2019-07-29 15:49:31.468,97f7d2048121fe62,sc-and-v1,LAT Users,BANNER,level-end,de,TABLET,31dae586-12d9-47dc-99bd-80855feb2afd,,cf-3042e652059847e5b0911dca682e9509,0.006000,202009

字段

名称	说明
`Ad Format`	`INTER`、`BANNER`、`REWARD`（仅限非聚合）。
`Ad Placement`	展示广告的外部广告 network 的 placement ID（仅限非聚合）。
`Ad Unit ID`	产生收入的 MAX 广告单元 ID。
`Ad Unit Name`	产生收入的 MAX 广告单元名称（仅限非聚合）。
`Country`	impression 的两位字母国家/地区代码（仅限非聚合）。
`Custom Data`	从集成中传入的自定义数据。
`Date`	impression 的时间（仅限非聚合）。
`Device Type`	`PHONE`、`TABLET`（仅限非聚合）。
`IDFA`	广告标识符：iOS 设备为 IDFA，Android 设备为 GAID。
`IDFV`	供应商标识符 (IDFV)。
`Impressions`	向用户展示的广告数量（仅限聚合）。
`Network`	产生 impression 的广告 network。您可以在此表的“Network API Name”列中找到广告 network 的值。（仅限非聚合 `ad_revenue_report_url`）
`Placement`	用户产生 impression 和收入的广告 placement 名称。
`Revenue`	用户产生的收入，以美元 (USD) 为单位，精确到小数点后六位。
`User ID`	可选的用户 ID，通过 AppLovin SDK 设置。（请参阅下文的“设置内部用户 ID”部分。）
`Waterfall`	MAX 广告单元 waterfall 名称（仅限非聚合）。

设置广告位名称

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

ActionScript

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

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

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

nativeAdLoader.setPlacement(«placement»);

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

Blueprint

Ad Unit Identifier. Create Banner: Ad Unit Identifier. Banner Position: Bottom Center. Set Banner Placement: Ad Unit Identifier, Placement: YOUR_BANNER_PLACEMENT.

C++

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

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»");

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»);

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»);

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»" );

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

JavaScript (Cordova)

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

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»);

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

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

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»" )

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»)

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»";

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»"

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

设置内部用户 ID

以下代码片段展示了如何使用您自己的内部用户 ID 来标记用户。用户 ID 字符串的最大长度为 8192 个字符。

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

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

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

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

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

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

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

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

自定义数据

以下代码片段展示了如何向 postback 添加自定义字符串数据。此字符串数据将替换这些 postback 中的 {CUSTOM_DATA} 宏。 AppLovin 建议您的字符串长度少于 8192 个字符。

info

Note

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

Banners & MRECs

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

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

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

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

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

adView.customData = "«custom-data»"

Interstitials

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

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

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

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

-[MAInterstitialAd showAdForPlacement:customData:]

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

Rewarded ads

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

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

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

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

-[MARewardedAd showAdForPlacement:customData:]

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

Native ads

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

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

nativeAdLoader.setCustomData( "«custom data»" )

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

nativeAdLoader.customData = "«custom data»"

收入报告 API

Cohort API

政策中心使用条款发布商政策需求方合作伙伴政策平台管控隐私隐私选项

Cookies Settings