ironSource Reporting API
서드파티 데이터 통합으로 생성된 데이터는 클러스터의 소비 데이터양에 포함됩니다
개요
인터페이스 소개
| 인터페이스명 | 타입 | 세분화 | 어트리뷰션 | 비용 | 수익 | 노출 | 클릭 | 전환 |
|---|---|---|---|---|---|---|---|---|
| Reporting API | API | 집계 지표 | ✅ | ✅ | ✅ |
Reporting API는 ironSource의 집계 지표 데이터 인터페이스로, 이 인터페이스로 노출, 수익, 유저 활성 등의 집계 지표 데이터를 가져올 수 있습니다.
통합 절차
- ironSource 백엔드에 로그인하여 App Key, Secret Key, Refresh Token을 가져옵니다
- AE 백엔드에 로그인하여 서드파티 통합 모듈로 이동한 후 ironSource Reporting API 통합 계획을 추가하고 관련 설정을 완료합니다
- AE 시스템이 데이터를 정상적으로 수신했는지 확인하고 리포트를 구축합니다
1. 인증 정보 가져오기
먼저 ironSource 백엔드에 로그인하여 필요한 인증 정보를 가져와야 합니다
- 먼저 오른쪽 상단의 사용자 메뉴를 클릭하여 My Account 페이지의 Reporting API 탭으로 이동한 후 Secret Key와 Refresh Token을 가져옵니다
- 다음으로 ironSource 백엔드의 Ad Unit 페이지로 이동하여 APPLICATIONS 목록에서 연동할 앱을 선택하면 오른쪽 카드에 해당 앱의 App Key가 표시되므로 이를 기록해 둡니다(iOS와 Android는 별개이므로 두 플랫폼의 데이터를 모두 연동하려면 계획 두 개를 설정하고 각각의 App Key를 입력해야 합니다)
2. 계획 설정
인증 정보를 가져온 후 AE 시스템 백엔드에 로그인하여 서드파티 통합 모듈에서 ironSource Reporting API 설정을 완료해야 합니다. 아래 그림은 ironSource의 설정 화면입니다:
2.1 인증 정보 설정
인증 정보 아래의 인증 정보 설정 버튼을 클릭하고, 팝업 창에 인증 작업에서 가져온 정보를 입력합니다
2.2 동기화
동기화 모듈에서 AE 시스템이 ironSource Reporting API 데이터를 정기적으로 수집하는 정책을 설정할 수 있으며, 매일 특정 시각 또는 매시간 일정 기간의 데이터를 수집하도록 선택할 수 있습니다. 수집한 데이터도 데이터양에 포함되므로 너무 긴 기간의 데이터를 정기적으로 수집하지 않는 것을 권장합니다
2.3 이벤트 테이블 저장 설정
이벤트 테이블 저장 설정 스위치를 켜면 콜백 데이터가 모두 이벤트 테이블에 기록됩니다. 이벤트 데이터 저장을 활성화할 것을 권장합니다.
2.4 통합 설정
통합 설정 모듈에서 데이터 수집의 세부 설정을 제어할 수 있습니다. 예를 들어 저장 후 이벤트 이름, 수집할 지표, 선택 가능한 차원 등이 있습니다.
통합 설정은 JSON이며, 필요에 따라 내용을 조정할 수 있습니다
| 모듈 | 이름 | 의미 |
|---|---|---|
| sink_event | event_name | 저장 후 이벤트 이름, 커스텀 가능 |
| source | metrics | 데이터의 지표 차원, 리스트 타입, 커스텀 가능 |
| group_by | 데이터의 그룹 차원, 리스트 타입, 커스텀 가능 |
- 선택 가능한 차원
다음은 Reporting API에서 선택할 수 있는 차원입니다. 분석 차원마다 지원하는 지표가 다르며, 구체적인 대응 관계는 ironSource 공식 문서를 참고하십시오. 조정이 필요하면 필요한 차원명을 source.group_by에 입력하십시오
| 차원명 | 저장 필드명 | 설명 | 기본 여부 | 비고 |
|---|---|---|---|---|
| date | date | 데이터 시간 | 예 | |
| adUnits | adUnits | 광고 유닛 | 예 | |
app | appKey | 앱 Key | 예 | |
| bundleId | 앱 ID | 예 | ||
| appName | 앱 이름 | 예 | ||
| platform | platform | 앱 플랫폼 | 예 | |
| adSource | providerName | 광고 소스 | 예 | |
| instance | instanceName | 인스턴스 이름 | segment, placement와 상호 배타적 | |
| instanceId | 인스턴스 ID | |||
| country | countryCode | 국가(지역) 코드 | 예 | |
| segment | segment | 유저가 분류된 트래픽 그룹 이름 | instance, placement와 상호 배타적 | |
| placement | placement | 게재 위치 | instance, segment와 상호 배타적 | |
| osVersion | osVersion | OS 버전 | 최대 4개 중 하나 선택 | |
| connectionType | connectionType | 네트워크 연결 타입 | ||
| sdkVersion | sdkVersion | SDK 버전 | ||
| appVersion | appVersion | 앱 버전 | ||
| att | att | ATT 상태 | ||
| idfa | idfa | IDFA 사용 가능 여부 | ||
| abTest | abTest | A/B Test 태그 |
- 지표 필드
다음은 Reporting API가 지원하는 지표 목록이며, 기본적으로 모든 필드를 수집합니다. 사용할 수 있는 지표는 분석 차원의 영향을 받으므로 실제로 수신하는 지표는 아래 표보다 적을 수 있습니다. 조정이 필요하면 필요한 필드명을 source.metrics에 입력하십시오
| 필드 이름 | 설명 |
|---|---|
| revenue | 총수익 |
| eCPM | eCPM |
| appFillRate | 광고 채움률(노출 수 / 요청 수) |
| appRequests | 광고 요청 수 |
| impressions | 노출 수 |
| completions | 완료 수
|
| revenuePerCompletion | 평균 완료 수익(수익 / 완료 수) |
| appFills | 광고 채움 수 |
| useRate | 광고 노출 대비 채움 비율 |
| activeUsers | DAU |
| engagedUsers | 광고 참여 유저 수 |
| engagedUsersRate | 광고 참여 유저 비율 |
| impressionsPerEngagedUser | 광고 참여 유저의 평균 광고 노출 수 |
| revenuePerActiveUser | 즉 ARPU 값(단위: 센트) |
| revenuePerEngagedUser | 광고 참여 유저 ARPU 값(단위: 센트) |
| clicks | 총클릭 수 |
| clickThroughRate | 클릭률(CTR) |
| completionRate | 완료율 |
| adSourceChecks | 광고 소스가 광고 사용 가능 여부를 확인한 횟수 |
| adSourceResponses | 광고 소스가 응답한 횟수 |
| adSourceAvailabilityRate | 광고 사용 가능 비율(노출 수 / 광고 응답 수) |
| sessions | Session 수 |
| engagedSessions | 광고 참여가 있었던 Session 수 |
| impressionsPerSession | Session당 평균 노출 수 |
| impressionPerEngagedSessions | 광고 참여가 있었던 Session당 평균 노출 수 |
| sessionsPerActiveUser | 유저당 평균 Session 수 |
2.5 이벤트 저장 규칙
- 데이터의 date 필드, 즉 데이터 시간을 이벤트의 #event_time으로 사용합니다
- 데이터 이벤트 이름은 ironsource_reporting_level입니다
- 나머지 필드는 모두 저장됩니다
2.6 표준화 필드
다음 이벤트 속성은 표준화 처리됩니다:
| 원본 필드 | 표준화 필드 | 의미 |
|---|---|---|
| providerName | te_ads_object.media_source | 수익화 채널 |
| adUnits | te_ads_object.ad_group_name | 수익화 광고의 Unit 이름 |
| placement | te_ads_object.placement | 광고 위치 |
| countryCode | te_ads_object.country | 국가/지역 코드 |
| platform | te_ads_object.platform | 플랫폼(Android, iOS 등) |
| bundleId | te_ads_object.app_id | 앱 ID |
| appName | te_ads_object.app_name | 앱 이름 |
| impressions | te_ads_object.impressions | 노출 수 |
| clicks | te_ads_object.clicks | 클릭 수 |
| revenue | te_ads_object.revenue | 수익화 수익 |