# AppsFlyer Cohort API
::: Tip
주의. 플랫폼 데이터 통합을 통해 생성된 데이터는 클러스터의 데이터 소비량으로 계산됨을 유의하십시오.
:::
# 개요
API 이름 | 통합 유형 | 데이터 세분화 | 어트리뷰션 | 비용 | 수익 | 노출 | 클릭 | 전환 |
|---|---|---|---|---|---|---|---|---|
Cohort API | API | 집계 | ✅ | ✅ | ✅ |
Cohort API (opens new window)는 데이터의 집계 API입니다. 다른 데이터 집계 API와 비교하여, 데이터 지표는 AppsFlyer의 코호트 대시보드나 TE 시스템의 리텐션 분석 모델 결과와 유사한 형태이며, 즉 신규 유저의 N일차(또는 누적 N일차) 지표입니다.
# 통합 프로세스
- AppsFlyer의 백엔드에 로그인하고, V2.0 API 토큰과 App ID를 획득하세요.
- TE 백엔드에 로그인하여, 서드파티 통합으로 들어가 AppsFlyer 코호트 API 플랜을 추가하고, 관련 설정을 완료하세요.
- TE 시스템이 데이터를 정상적으로 수신하고, 리포트 구축이 완료되었는지 확인하세요.
# API Token과 App ID 획득
# 1.1 API 토큰 획득
관리자 계정에 로그인하고, [API Access]를 AppsFlyer의 사이드바 메뉴에서 찾아, Pull API를 위한 V2.0 API 토큰을 획득하세요.
# 1.2 App ID 획득
AppsFlyer의 백엔드 'My Apps'에서, 앱의 App ID를 찾을 수 있습니다. Android는 com.으로 시작하며, 예를 들어 com.demoapp.ta입니다. iOS는 id로 시작하며, 예를 들어 id12345678입니다.
# 플랜 구성
AppsFlyer의 API 토큰과 App ID를 획득한 후, TE 시스템에 로그인하여, '서드파티' 모듈에서 새 플랜의 설정을 완료할 수 있습니다. 아래는 AppsFlyer 코호트 API의 설정 화면입니다. 이 장의 내용을 따라 플랜을 생성하세요：
# 2.1 인증 정보 설정
[설정] 버튼을 클릭하고, 팝업 내에 App ID와 API Token를 입력하세요.
# 동기화
[동기화] 모듈에서, TE 시스템이 AppsFlyer Master API 데이터를 정기적으로 수집하는 규칙을 설정할 수 있습니다. 특정 시간대에 매일 일정 기간의 데이터를 수집할 수 있습니다. 수집된 데이터도 데이터 양에 포함되므로, 긴 시간의 데이터를 정기적으로 수집하지 않는 것이 좋습니다.
# 저장 설정
데이터가 이벤트 형식으로 작성되는지를 제어할 수 있습니다. 닫히면, 데이터는 이벤트 테이블에 작성되지 않으므로, 이 설정을 닫지 마세요.
# 2.5 통합 구성
마지막으로, 데이터 수집의 자세한 설정을 통합 구성 모듈에서 제어할 수 있습니다. 데이터 유형, 수집할 차원, 및 저장 후의 이벤트 이름 등이 포함됩니다.
통합 설정의 내용은 JSON 형식이며, 아래의 내용을 따라 커스텀 설정을 할 수 있습니다.
API | 이름 | 의미 |
|---|---|---|
| sink_event | event_name | 저장된 이벤트명, 커스터마이즈 가능 |
| source | metrics | 데이터 내의 지표, 리스트 타입은 커스터마이즈 가능 |
| group_by | 데이터의 그룹화, 리스트 타입은 커스터마이즈 가능 | |
| transfer | fields_whitelist | 필드의 필터링, 리스트 타입, 리스트가 비어있지 않은 경우, TE 시스템은 리스트에 포함된 필드만을 데이터베이스에 저장하고, 리스트에 포함되지 않은 필드는 버립니다 |
| extra_params | double_columns | 숫자 타입의 필드 정의, 여기에 기술된 필드는 숫자 타입으로 데이터베이스에 저장됩니다. 저장 후의 필드명을 입력하세요 |
| aggregation_type | 누적 데이터를 반환할지 여부, 즉 N일의 데이터를 반환할 때 N일차 데이터 또는 누적된 N일차 데이터를 반환합니다. 기본값은 'cumulative' 또는 'on_day' | |
| partial_data | 기본 날짜 데이터를 반환할지 여부, 기본값은 false이며, 완전한 날의 데이터만 반환됩니다. true로 설정하면, 최대 180일간의 불완전한 날의 데이터도 포함됩니다. |
아래는 그룹화의 차원입니다. 조정이 필요한 경우, source.group_by를 변경하세요. 조정할 때는 필드명을 사용하세요.
필드 정의 | 필드명 | 저장명 | 기본값 |
|---|---|---|---|
Ad | af_ad | ✓ | ✓ |
Ad ID | af_ad_id | ✓ | |
Campaign | c | ✓ | ✓ |
Campaign ID | af_c_id | ✓ | |
Channel | af_channel | ✓ | ✓ |
Media Source | pid | ✓ | ✓ |
Sub Param 1 | af_sub1 | ✓ | |
Keywords | af_keywords | ✓ | |
Agency | af_prt | ||
Conversion Type | cohort_type | ||
Site ID | site_id | ||
Attributed Touch Type | attributed_touch_type | ||
Adset | af_adset | ✓ | |
Adset ID | af_adset_id | ✓ | |
Country | geo | ✓ | |
Date | date | ✓ | ✓ |
- 지표 필드
주목할 점은, 코호트 API는 3개의 기본 지표와 1개의 추가 지표를 반환합니다. 아래는 기본 지표 필드이지만, 필요에 따라 source.group_by를 변경할 수 있습니다. 변경할 때는 필드명을 사용하세요. 또한, extra_params.double_columns 및 transfer.fields_whitelist에 해당하는 필드명을 추가해야 합니다.
주의: '저장명' 열에서, N은 N일차 지표를 나타냅니다. 기본적으로, 값의 범위는 0에서 30입니다. 따라서, 이러한 필드를 정상적으로 저장하기 위해서는, extra_params.double_columns와 transfer.fields_whitelist에 실제 저장명(revenue_count_day_7이나 roi_rate_day_30 등)을 추가해야 합니다.
필드 이름 | 저장명 | 설명 | 기본값 |
|---|---|---|---|
users(기본 지표) | users | 총 유저 수(시간 윈도우와 관계 없음) | ✓ |
ecpi(기본 지표) | ecpi | 총 eCPI(시간 윈도우와 관계 없음) | ✓ |
cost(기본 지표) | cost | 총 비용(시간 윈도우와 관계 없음) | ✓ |
"event_name"(커스텀 이벤트의 이름을 사용) | "event_name"_unique_users_day_N | N일차 커스텀 이벤트 트리거 유저 수 | |
"event_name"_count_day_N | N일차 커스텀 이벤트 완료 수 | ||
"event_name"_rate_day_N | N일차 커스텀 이벤트의 완료율 | ||
"event_name"_sum_day_N | N일차 커스텀 이벤트 수익액 | ||
revenue | revenue_count_day_N | N일차 수익 이벤트 트리거 수 | |
revenue_sum_day_N | N일차 수익액 | ||
roas | roas_rate_day_N | N일차 ROAS | |
roi | roi_rate_day_N | N일차 ROI | |
sessions | sessions_unique_users_day_N | N일차 세션 트리거 유저 수(누적 지표인 경우 이 데이터는 반환되지 않음) | |
sessions_count_day_N | N일차 세션 수 | ||
sessions_rate_day_N | N일차 잔존율(세션 유니크 유저 수 / 총 유저 수) | ||
uninstalls | uninstalls_count_day_N | N일차 언인스톨 수 | |
uninstalls_rate_day_N | N일차 언인스톨율 |
# 2.6 데이터 저장 규칙
기본적으로, 수집된 데이터는 이벤트 형식으로 TE 프로젝트에 쓰여집니다.
- 코호트 API의 집계 지표 인터페이스는, 집계 데이터를 반환하기 때문에, 사용자 식별자로 고정값을 사용합니다. 모든 데이터가 가상 사용자에게 마운트된다고 생각하세요.
- 데이터 중의date필드, 즉 사용자의 어트리뷰션/전환 시간을 이벤트의 #event_time으로 사용합니다.
- 데이터 이벤트 이름：appsflyer_cohort_api
- 다른 필드는 모두 데이터베이스에 저장됩니다.
# 2.7 표준화 필드
메타 필드 | 표준화 필드 | 설명 |
|---|---|---|
media_source | te_ads_object.media_source | 미디어 소스 |
campaign | te_ads_object.campaign_name | 캠페인 명 |
campaign_id | te_ads_object.campaign_id | 캠페인 ID |
adset | te_ads_object.ad_group_name | 그룹명 |
adset_id | te_ads_object.ad_group_id | 그룹 ID |
ad | te_ads_object.ad_name | 광고 명 |
ad_id | te_ads_object.ad_id | 광고 ID |
app_id | te_ads_object.app_id | APP ID |
geo | te_ads_object.country | 국가 지역 코드 |
impressions | te_ads_object.impressions | 노출량 |
clicks | te_ads_object.clicks | 클릭량 |
installs | te_ads_object.installs | 전환량(설치) |
cost | te_ads_object.cost | 비용 |
revenue | te_ads_object.revenue | 수익 |