AppLovin User Revenue API
서드파티 데이터 통합으로 생성된 데이터는 클러스터의 소비 데이터양에 포함됩니다
개요
인터페이스 소개
| 인터페이스명 | 타입 | 세분화 | 어트리뷰션 | 비용 | 수익 | 노출 | 클릭 | 전환 |
|---|---|---|---|---|---|---|---|---|
| User Revenue API | API | 유저 수준 | ✅ | ✅ |
AppLovin은 SDK와 콜백 링크 외에도 데이터 수집 인터페이스인 User Revenue API를 제공하며, 유저 수준 또는 노출 수준의 광고 수익 데이터를 수집할 수 있습니다.
통합 절차
- AppLovin SDK와 AE SDK를 연동하고, AppLovin SDK에 AE의 유저 식별 ID를 설정합니다
- AppLovin 백엔드에 로그인하여 User Revenue API에 필요한 인증 정보를 가져옵니다
- AE 백엔드에 로그인하여 서드파티 통합 모듈로 이동한 후 AppLovin User Revenue API 계획을 추가하고 관련 설정을 완료합니다
- AE 시스템이 데이터를 정상적으로 수신했는지 확인하고 리포트를 구축합니다
1. 클라이언트 SDK 설정
AppLovin 데이터 통합의 첫 단계는 클라이언트에서 AE SDK와 AppLovin SDK를 연결하는 것입니다.
1.1 방안 1(자동 연결)
-
Android, iOS SDK를 연동한 경우
- SDK 버전이 2.8.0~2.8.1이면 이 방안을 바로 사용할 수 있습니다
- SDK 버전이 2.8.2 이상이면 서드파티 데이터 플러그인도 설치해야 합니다. 자세한 내용은 Android SDK 서드파티 데이터와 iOS SDK 서드파티 데이터를 참고하십시오
AE SDK 초기화와 자동 통합 활성화 코드는 반드시 AppLovin SDK 초기화 전에 완료해야 합니다. 다음 단계에 따라 진행하십시오:
1. AE SDK를 초기화합니다.
2. `enableThirdPartySharing`을 호출하여 게스트 ID를 자동으로 설정합니다.
3. AppLovin SDK를 초기화합니다.
다음은 각 플랫폼 SDK의 코드 예시입니다:
- Android
- iOS
// 1. Android SDK 초기화
TDConfig config = TDConfig.getInstance(this, APPID, TE_SERVER_URL);
TDAnalytics.init(config);
// 2. enableThirdPartySharing 인터페이스를 호출하여 ta_distinct_id를 applovin 이벤트에 설정
TDAnalytics.enableThirdPartySharing(TDThirdPartyType.APPLOVIN_IMPRESSION)
// 3. applovin SDK 초기화
// ...
// 1. iOS SDK 초기화
TDConfig *config = [[TDConfig alloc] init];
config.appid = appid;
config.serverUrl = url;
[TDAnalytics startAnalyticsWithConfig:config];
// 2. enableThirdPartySharing 인터페이스를 호출하여 ta_distinct_id를 applovin 이벤트에 설정
[TDAnalytics enableThirdPartySharing:TDThirdPartyTypeAppLovin];
// 3. applovin SDK 초기화
// ...
이 방안의 원리는 내부에서 AppLovinSdk SDK의 setUserIdentifier() 메서드를 자동으로 호출하여 AE 프로젝트의 게스트 ID를 전달하는 것입니다.
1.2 방안 2(수동 연결)
수동 연결 방안에서는 AF AppLovin에서 setUserIdentifier() 인터페이스를 사용하여 AE 프로젝트의 게스트 ID를 설정해야 합니다.
AE SDK 초기화와 setUserIdentifier 인터페이스 호출은 반드시 AppLovin SDK 초기화 전에 완료해야 합니다. 다음 단계에 따라 진행하십시오:
1. AE SDK를 초기화합니다.
2. `setUserIdentifier`를 호출하여 게스트 ID를 설정합니다.
3. AppLovin SDK를 초기화합니다.
다음은 각 플랫폼 SDK의 수동 통합 코드 예시입니다:
- Android
- iOS
- Unity
// 1. Android SDK 초기화
TDConfig config = TDConfig.getInstance(this, APPID, TE_SERVER_URL);
TDAnalytics.init(config);
// 2. AE의 게스트 ID 가져오기(AE의 #distinct_id에 해당)
String distinctId = TDAnalytics.getDistinctId();
// 3. 게스트 ID를 applovin 수집 이벤트에 설정
AppLovinSdk.getInstance(context).setUserIdentifier(distinctId);
// 4. applovin SDK 초기화
// ...
// 1. iOS SDK 초기화
TDConfig *config = [[TDConfig alloc] init];
config.appid = appid;
config.serverUrl = url;
[TDAnalytics startAnalyticsWithConfig:config];
// 2. AE의 게스트 ID 가져오기(AE의 #distinct_id에 해당)
NSString *distinctId = [TDAnalytics getDistinctId];
// 3. 게스트 ID를 applovin 수집 이벤트에 설정
[ALSdk shared].userIdentifier = distinctId;
// 4. applovin SDK 초기화
// ...
// 1. Unity SDK 초기화
TDConfig config = new TDConfig("APPID","SERVER");
TDAnalytics.Init(config);
// 2. AE의 게스트 ID 가져오기(AE의 #distinct_id에 해당)
var distinctId = TDAnalytics.GetDistinctId();
// 3. 게스트 ID를 Applovin 수집 이벤트에 설정
MaxSdk.SetUserId(distinctId);
// 4. Applovin SDK 초기화
// ...
2. Report Key 가져오기
다음으로 AppLovin 백엔드에 로그인하여 Account - Key에서 Report Key를 가져오고, 이 Key를 안전하게 보관하십시오
3. 계획 설정
SDK 설정을 완료하고 Report Key를 가져온 후 AE 시스템에 로그인하여 서드파티 통합 모듈에서 새 계획을 설정할 수 있습니다. 다음은 AppLovin User Revenue API의 설정 화면입니다. 이 장의 내용에 따라 계획을 생성하십시오:
3.1 인증 정보 설정
인증 정보 아래의 인증 정보 설정 버튼을 클릭하고, 팝업 창에 인증 작업에서 가져온 정보를 입력합니다(API Key는 오른쪽의 편집 아이콘을 먼저 클릭해야 입력할 수 있습니다)
참고:
- APP ID: iOS 플랫폼의 iTunes ID 숫자 부분 또는 Android 플랫폼의 앱 패키지명
- Platform: 게임이 서비스되는 플랫폼으로, android 또는 ios를 입력하십시오
- API Key: 방금 가져온 Report Key
3.2 동기화
동기화 모듈에서 AE 시스템이 AppLovin User Revenue API 데이터를 정기적으로 수집하는 전략을 설정할 수 있으며, 매일 특정 시각 또는 매시간 일정 기간의 데이터를 수집하도록 선택할 수 있습니다. 수집한 데이터도 데이터량에 포함되므로 너무 긴 기간의 데이터를 정기적으로 수집하지 않는 것을 권장합니다
3.3 유저 식별 필드
AppLovin User Revenue API의 데이터는 유저 수준 데이터이므로 유저 식별 규칙, 즉 AppLovin User Revenue API 데이터에서 #distinct_id 및 #account_id에 대응하는 필드를 설정해야 합니다. AE 시스템은 이 설정에 따라 수집한 데이터를 변환할 때 해당 필드를 데이터의 유저 식별 필드로 설정합니다.
이 문서의 이전 단계에 따라 클라이언트 SDK를 설정한 경우 다음 설정을 사용하십시오:
- 계정 ID 연관 필드: 없음
- 게스트 ID 연관 필드: user_id
3.4 이벤트 테이블 저장 설정
이벤트 테이블 저장 설정 스위치를 켜면 콜백 데이터가 모두 이벤트 테이블에 기록됩니다. 이벤트 데이터 저장을 활성화할 것을 권장합니다.
3.5 유저 속성 저장 규칙
기본적으로 AE 시스템은 AppLovin User Revenue API 데이터를 유저 속성에 기록하지 않습니다. 일부 필드를 유저 테이블에 기록하려면 먼저 규칙을 켜서 실행되도록 한 다음, 속성 매핑 기능으로 유저 테이블에 기록할 필드를 추가하십시오. 소스 속성명에는 필드의 저장명을 입력해야 합니다:
3.6 통합 설정
통합 설정 모듈에서 데이터 수집의 세부 설정을 제어할 수 있습니다. 예를 들어 저장 후 이벤트 이름 등을 설정할 수 있습니다.
통합 설정은 JSON이며, 필요에 따라 내용을 조정할 수 있습니다
| 모듈 | 이름 | 의미 |
|---|---|---|
| sink_event | event_name | 저장 후 이벤트 이름, 커스텀 가능 |
3.7 데이터 저장 규칙
- 데이터의 user_id를 데이터의 게스트 ID로 사용합니다. 이 필드는 AE 프로젝트의 게스트 ID와 대응해야 합니다
- 데이터의 date 필드, 즉 광고 표시 시간을 이벤트의 #event_time으로 사용합니다
- 데이터 이벤트 이름은 -- applovin_ad_revenue_impression_level입니다
- 그 밖의 필드는 모두 저장되며, 반환되는 모든 데이터 필드의 의미는 다음과 같습니다:
| 필드 | 저장명 | 설명 | 예시 |
|---|---|---|---|
| Ad Format | ad_format | 광고 유형 | INTER, BANNER, REWARD |
| Ad Placement | ad_placement | SDK에서 정의한 커스텀 Placement 이름 | Launch%20Screen |
| Ad Unit ID | ad_unit_id | MAX 광고 ID | 9ad0816ac071552a |
| Ad Unit Name | ad_unit_name | MAX 광고 이름 | Control |
| Country | country | 영문 두 글자 Country Code | gb |
| Custom Data | custom_data | SDK로 설정한 커스텀 데이터 | gb |
| Date | date | 광고 노출 시간 | 2019-07-29 15:53:07.39 |
| Device Type | device_type | 디바이스 타입 | PHONE, TABLET |
| IDFA | idfa | iOS의 IDFA 또는 Android의 Google Advertising ID | 860635ea-65bc-eaed-d355-1b5283b30b94 |
| IDFV | idfv | IDFV | 4CD1C3C4-3FD7-00F5-1635-7BC6D9387E60 |
| Network | network | 광고를 표시한 Ad Network | 값 참고(MAX Mediation Documentation (applovin.com))APPLOVIN_NETWORK |
| Placement | placement | Ad Network의 Placement 이름 | MY_NATIVE_PLACEMENT |
| Revenue | revenue | 예상 수익, FB Bidding 값 포함 | 0.0121, 5.74466e-05 |
| User ID | user_id | SDK에서 설정한 유저 ID, AE 프로젝트의 게스트 ID에 대응 | 7634657898 |
| Waterfall | waterfall | 광고 Waterfall 이름 | LAT |
3.8 표준화 필드
다음 이벤트 속성은 표준화 처리됩니다:
| 원본 필드 | 표준화 필드 | 의미 |
|---|---|---|
| network_name | te_ads_object.media_source | 미디어 채널 |
| ad_mediation_platform | te_ads_object.media_source | 수익화 채널 |
| ad_unit_name | te_ads_object.ad_group_name | 수익화 광고 Unit 이름 |
| ad_unit_id | te_ads_object.ad_group_id | 수익화 광고 Unit ID |
| ad_placement | te_ads_object.placement | 수익화 광고 위치 |
| app_id | te_ads_object.app_id | 앱 ID |
| country | te_ads_object.country | 국가/지역 코드 |
| platform | te_ads_object.platform | 플랫폼(Android, iOS 등) |
| USD 고정값 | te_ads_object.currency | 수익화 수익의 통화 |
| revenue | te_ads_object.revenue | 수익화 수익 |