Branch 통합 계획
서드파티 데이터 통합으로 생성된 데이터는 클러스터의 소비 데이터양에 포함됩니다
개요
인터페이스 소개
| 인터페이스명 | 타입 | 세분화 | 어트리뷰션 | 비용 | 수익 | 노출 | 클릭 | 전환 |
|---|---|---|---|---|---|---|---|---|
| Webhooks | 콜백 | 유저 수준 | ✅ | ✅ |
Branch는 Webhooks로 유저 단위 데이터를 콜백합니다. 그중 채널 어트리뷰션 등의 정보를 AE의 유저 속성으로 전달할 수 있으며, 콜백 데이터를 이벤트로 기록할 수도 있습니다
Branch 데이터 연동을 시작하기 전에 AE 시스템의 유저 식별 규칙을 읽고 AE가 #distinct_id와 #account_id로 유저를 식별하는 방식을 이해했는지 확인하십시오
통합 절차
- Branch SDK와 AE SDK를 도입하고, Branch SDK에 AE 시스템의 게스트 ID와 계정 ID를 설정합니다
- AE 백엔드에 로그인하여 서드파티 통합 모듈로 이동한 후 Branch Webhook 콜백 계획을 추가하고 관련 설정을 완료합니다
- Branch 백엔드에서 Webhooks를 설정하고 AE의 콜백 링크를 입력합니다
- AE 시스템이 데이터를 정상적으로 수신했는지 확인하고 리포트를 구축합니다
1. 클라이언트 SDK 전송
클라이언트 SDK로 데이터를 전송하려면 먼저 App에 Branch SDK와 AE SDK를 통합하십시오. 그런 다음 Branch SDK의 initialization metadata 파라미터 설정 메서드를 사용하여 Branch SDK에 AE 시스템의 유저 식별 ID인 계정 ID와 게스트 ID를 설정합니다. Branch의 콜백 데이터에 이 ID 필드가 포함되므로 Branch 데이터와 AE 데이터를 연결할 수 있습니다.
1.1 방안 1(자동 통합)
-
Android, iOS SDK를 연동한 경우
- SDK 버전이 2.8.0~2.8.1이면 이 방안을 바로 사용할 수 있습니다
- SDK 버전이 2.8.2 이상이면 서드파티 데이터 플러그인도 설치해야 합니다. 자세한 내용은 Android SDK 서드파티 데이터와 iOS SDK 서드파티 데이터를 참고하십시오
-
Unity SDK 버전 2.4.0 이상, Unreal SDK 버전 1.5.0 이상을 연동한 경우 이 방안을 바로 사용할 수 있습니다
AE의 SDK 초기화는 반드시 Branch SDK 초기화 전에 완료해야 하며, 자동 통합 활성화 코드는 반드시 Branch SDK 초기화 직후에 호출해야 합니다. 다음 단계에 따라 진행하십시오:
- AE SDK를 초기화합니다.
- Branch SDK를 초기화합니다.
enableThirdPartySharing을 호출하여 게스트 ID를 자동으로 설정합니다.
다음은 각 플랫폼 SDK의 코드 예시입니다:
- Android
- iOS
- Unity
- Unreal
// 1. Android SDK 초기화
TDConfig config = TDConfig.getInstance(this, APPID, TE_SERVER_URL);
TDAnalytics.init(config);
// 2. Branch SDK 초기화
// ...
// 3. enableThirdPartySharing 인터페이스를 호출하여 ta_distinct_id를 Branch 이벤트에 설정
TDAnalytics.enableThirdPartySharing(TDThirdPartyType.BRANCH);
// 4. 회원가입 또는 캐릭터 생성 후 login을 호출하여 계정 ID를 설정한 다음 데이터를 다시 동기화해야 함(선택 사항)
TDAnalytics.login("account_id");
TDAnalytics.enableThirdPartySharing(TDThirdPartyType.BRANCH);
// 1. iOS SDK 초기화
TDConfig *config = [[TDConfig alloc] init];
config.appid = appid;
config.serverUrl = url;
[TDAnalytics startAnalyticsWithConfig:config];
// 2. Branch SDK 초기화
// ...
// 3. enableThirdPartySharing 인터페이스를 호출하여 ta_distinct_id를 Branch 이벤트에 설정
[TDAnalytics enableThirdPartySharing:TDThirdPartyTypeBranch];
// 4. 회원가입 또는 캐릭터 생성 후 login을 호출하여 계정 ID를 설정한 다음 데이터를 다시 동기화해야 함(선택 사항)
[TDAnalytics login:@"account_id"];
[TDAnalytics enableThirdPartySharing:TDThirdPartyTypeBranch];
// 1. Unity SDK 초기화
TDConfig config = new TDConfig("APPID","SERVER");
TDAnalytics.Init(config);
// 2. Branch SDK 초기화
// ...
// 3. enableThirdPartySharing을 호출하여 ta_distinct_id를 Branch 이벤트에 설정
TDAnalytics.EnableThirdPartySharing(TDThirdPartyType.BRANCH);
// 4. 회원가입 또는 캐릭터 생성 후 login을 호출하여 계정 ID를 설정한 다음 데이터를 다시 동기화해야 함(선택 사항)
TDAnalytics.Login("account_id");
TDAnalytics.EnableThirdPartySharing(TDThirdPartyType.BRANCH);
// 1. Unreal SDK 초기화
UTDAnalytics::Initialize();
// 2. Branch SDK 초기화
// ...
// 3. enableThirdPartySharing을 호출하여 ta_distinct_id를 Branch 이벤트에 설정
TArray<FString> EventTypeList;
EventTypeList.Emplace(TEXT("TAThirdPartyShareTypeBRANCH"));
UTDAnalytics::EnableThirdPartySharing(EventTypeList, AppID);
// 4. 회원가입 또는 캐릭터 생성 후 login을 호출하여 계정 ID를 설정한 다음 데이터를 다시 동기화해야 함(선택 사항)
UTDAnalytics::Login("account_id", AppID);
TArray<FString> EventTypeList;
EventTypeList.Emplace(TEXT("TAThirdPartyShareTypeBRANCH"));
UTDAnalytics::EnableThirdPartySharing(EventTypeList, AppID);
이 방안은 내부에서 Branch의 setRequestMetadata 메서드를 자동으로 호출하여 ta_distinct_id와 ta_account_id를 전달하는 방식으로 동작합니다.
1.2 방안 2(수동 통합)
수동 통합 방안에서는 Branch SDK에서 setRequestMetadata() 인터페이스로 AE 프로젝트의 게스트 ID와 계정 ID를 설정해야 합니다.
AE SDK 초기화는 Branch SDK 초기화 전에 완료해야 합니다. 다음 단계에 따라 진행하십시오:
- AE SDK를 초기화합니다.
- Branch SDK를 초기화합니다.
setRequestMetadata를 호출하여 게스트 ID를 설정합니다.
- 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. Branch SDK 초기화
// ...
// 4. 게스트 ID를 Branch 수집 이벤트에 설정
Branch.getInstance().setRequestMetadata("ta_distinct_id", distinctId);
// 5. 회원가입 또는 캐릭터 생성 후 login을 호출하여 계정 ID를 설정한 다음 데이터를 다시 동기화해야 함(선택 사항)
String accountId = "account_id";
TDAnalytics.login(accountId);
Branch.getInstance().setRequestMetadata("ta_account_id", accountId);
// 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. Branch SDK 초기화
// ...
// 4. 게스트 ID를 Branch 수집 이벤트에 설정
[[Branch getInstance] setRequestMetadataKey:@"ta_distinct_id" value: distinctId];
// 5. 회원가입 또는 캐릭터 생성 후 login을 호출하여 계정 ID를 설정한 다음 데이터를 다시 동기화해야 함(선택 사항)
NSString *accountId = @"account_id";
[TDAnalytics login:accountId];
[[Branch getInstance] setRequestMetadataKey:@"ta_account_id" value: accountId];
// 1. Unity SDK 초기화
TDConfig config = new TDConfig("APPID","SERVER");
TDAnalytics.Init(config);
// 2. AE의 게스트 ID 가져오기, AE의 #distinct_id에 대응
var distinctId = TDAnalytics.GetDistinctId();
// 3. Branch SDK 초기화
// ...
// 4. 게스트 ID를 Branch 수집 이벤트에 설정
Branch.setRequestMetadata("ta_distinct_id" , distinctId);
// 5. 회원가입 또는 캐릭터 생성 후 login을 호출하여 계정 ID를 설정한 다음 데이터를 다시 동기화해야 함(선택 사항)
var accountId = "account_id";
TDAnalytics.Login(accountId);
Branch.setRequestMetadata("ta_account_id" , accountId);
Branch의 Webhook 콜백 데이터에서 ta_distinct_id와 ta_account_id는 AE 시스템의 게스트 ID와 계정 ID에 해당합니다.
Branch SDK 초기화가 끝나면 바로 setRequestMetadata()를 호출하여 metadata 파라미터를 설정해야 일부 Branch 데이터에서 metadata 파라미터가 누락되는 것을 막을 수 있습니다. 그래도 데이터에 metadata 파라미터가 포함되지 않거나 초기화 직후 유저 식별 필드를 가져올 수 없는 경우, Branch가 제공하는 Delay Session Initialization 메서드로 session 초기화를 지연시키고 지연 기간 동안 metadata 설정을 완료하여 모든 데이터에 유저 식별 필드가 포함되도록 할 수 있습니다.
2. 계획 설정
SDK 설정을 완료한 후 AE 시스템 백엔드에 로그인하여 서드파티 통합 모듈에서 Branch 설정을 완료해야 합니다. 아래 그림은 Branch의 설정 화면입니다:
2.1 유저 식별 필드
Branch Webhook 데이터는 유저 수준 데이터이므로 유저 식별 규칙, 즉 Branch SDK에 설정한 AE 시스템의 유저 식별 ID를 설정해야 합니다. AE 시스템은 이 설정에 따라 콜백 데이터를 변환할 때 해당 필드를 데이터의 유저 식별 필드로 설정합니다.
이 문서의 이전 단계에 따라 클라이언트 SDK를 설정한 경우 다음 설정을 사용하십시오:
- 계정 ID 연관 필드: ta_account_id
- 게스트 ID 연관 필드: ta_distinct_id
2.2 이벤트 테이블 저장 설정
이벤트 테이블 저장 설정 스위치를 켜면 Branch가 콜백한 데이터가 모두 이벤트 테이블에 기록됩니다. 이벤트 데이터 저장을 활성화할 것을 권장합니다.
2.3 유저 속성 저장 규칙
기본적으로 AE 시스템은 Branch 콜백 데이터의 어트리뷰션 필드를 표준화 처리된 유저 속성에 자동으로 기록합니다. 다음은 유저 속성에 기록되는 필드와 그 의미입니다:
| Branch 필드 | AE 저장 후 유저 속성 이름 | 설명 |
|---|---|---|
| query.channel | te_ads_object.media_source | 채널 |
| query.campaign | te_ads_object.campaign_name | 캠페인 |
| query.ad_set_name | te_ads_object.ad_group_name | 광고 그룹 |
| query.creative_name | te_ads_object.ad_name | 광고 소재 |
수정이 필요하면 규칙 설정을 클릭하여 저장 규칙 설정 페이지로 이동합니다. 아래 그림과 같습니다
유저 속성의 저장 방식을 수정할 수 있습니다. 기본값은 user_setOnce이며, 최초로 전송된 정보만 유지됩니다.
소스 속성명에는 저장 필드명 앞에 query. 접두사를 붙여 입력하십시오
속성 매핑 버튼을 클릭하여 유저 속성에 기록할 필드를 추가할 수 있습니다. 또한 왼쪽의 규칙 버튼을 클릭하여 새 규칙 세트를 추가할 수도 있습니다.
유저 속성 저장을 끄려면 모든 규칙을 중지하면 됩니다:
2.4 통합 설정
통합 설정 모듈에서 데이터 수집의 세부 설정을 제어할 수 있습니다. 예를 들어 저장 후 이벤트 이름 등이 있습니다
통합 설정의 내용은 JSON이며, 다음 내용에 따라 커스텀 설정할 수 있습니다:
| 모듈 | 이름 | 의미 |
|---|---|---|
| sink_event | event_mapping | 저장 후 이벤트 이름, 커스텀 가능. Key는 Branch 콜백 데이터의 이벤트 이름이고, Value는 해당 이벤트의 저장 후 이벤트 이름입니다 |
2.5 엔드포인트 주소
시스템 및 프로젝트 수준의 데이터 수집 주소를 설정한 경우 다음과 같은 링크가 표시됩니다
여기에 주소가 표시되지 않으면 오른쪽 상단 메뉴의 프로젝트 관리 → 프로젝트 구성 → 연동 설정에서 공용 네트워크 주소를 설정하십시오. 설정 페이지 알림 배너의 데이터 수집 주소 링크를 클릭하여 이동할 수도 있습니다. 이 주소는 AE SDK에 설정한 데이터 수집 주소입니다. 설정한 후 Branch Webhook 설정 페이지의 엔드포인트 주소로 돌아와 엔드포인트 주소를 복사하십시오.
2.5.1 커스텀 매크로
Branch Webhook의 콜백 주소에는 매크로라는 구조가 포함되며, ${(macro_name)!} 형식으로 표기합니다. 매크로는 일종의 플레이스홀더로, Branch가 콜백할 데이터에 매크로에 대응하는 필드가 포함되면 해당 필드의 값을 매크로가 있는 위치에 채웁니다. ${(last_attributed_touch_data.~campaign)!}를 예로 들면, Branch는 데이터를 콜백할 때 Campaign의 값을 콜백 주소에서 매크로가 있는 위치에 채웁니다.
방금 가져온 엔드포인트 주소로 다음 주소의 앞부분을 교체하고, 교체한 콜백 주소를 복사해 두십시오. 이후 Branch 백엔드에서 이 주소를 입력해야 합니다:
https://{엔드포인트 주소}?branch_id=${(id)!}&campaign=${(last_attributed_touch_data.~campaign)!}&campaign_id=${(last_attributed_touch_data.~campaign_id)!}&campaign_type=${(last_attributed_touch_data.~campaign_type)!}&customer_campaign=${(last_attributed_touch_data.~customer_campaign)!}&channel=${(last_attributed_touch_data.~channel)!}&feature=${(last_attributed_touch_data.~feature)!}&stage=${(last_attributed_touch_data.~stage)!}&tags=${(last_attributed_touch_data.~tags)!}&advertising_partner_name=${(last_attributed_touch_data.~advertising_partner_name)!}&advertising_partner_id=${(last_attributed_touch_data.~advertising_partner_id)!}&secondary_publisher=${(last_attributed_touch_data.~secondary_publisher)!}&secondary_publisher_id=${(last_attributed_touch_data.~secondary_publisher_id)!}&customer_secondary_publisher=${(last_attributed_touch_data.~customer_secondary_publisher)!}&creative_name=${(last_attributed_touch_data.~creative_name)!}&creative_id=${(last_attributed_touch_data.~creative_id)!}&ad_set_name=${(last_attributed_touch_data.~ad_set_name)!}&ad_set_id=${(last_attributed_touch_data.~ad_set_id)!}&customer_ad_set_name=${(last_attributed_touch_data.~customer_ad_set_name)!}&ad_name=${(last_attributed_touch_data.~ad_name)!}&ad_id=${(last_attributed_touch_data.~ad_id)!}&customer_ad_name=${(last_attributed_touch_data.~customer_ad_name)!}&keyword=${(last_attributed_touch_data.~keyword)!}&keyword_id=${(last_attributed_touch_data.~keyword_id)!}&customer_keyword=${(last_attributed_touch_data.~customer_keyword)!}&branch_ad_format=${(last_attributed_touch_data.~branch_ad_format)!}&technology_partner=${(last_attributed_touch_data.~technology_partner)!}&banner_dimensions=${(last_attributed_touch_data.~banner_dimensions)!}&placement=${(last_attributed_touch_data.~placement)!}&placement_id=${(last_attributed_touch_data.~placement_id)!}&customer_placement=${(last_attributed_touch_data.~customer_placement)!}&sub_site_name=${(last_attributed_touch_data.~sub_site_name)!}&customer_sub_site_name=${(last_attributed_touch_data.~customer_sub_site_name)!}&agency=${(last_attributed_touch_data.~agency)!}&agency_id=${(last_attributed_touch_data.~agency_id)!}&ta_distinct_id=${(custom_data.ta_distinct_id)!}&ta_account_id=${(custom_data.ta_account_id)!}
2.6 계획 저장
설정을 완료한 후 오른쪽 상단의 저장 버튼을 클릭하여 계획을 저장하십시오.
3. Branch Webhook 콜백 설정
계획을 저장한 후 Branch 백엔드에 로그인하여 Data Feeds 페이지로 이동하고, WEBHOOKS 탭에서 새 Webhook을 추가하십시오:
Webhook 링크와 상세 정보를 설정합니다. 위에서 아래로, 왼쪽에서 오른쪽으로 총 세 부분을 입력해야 합니다:
- Send a webhook to: AE 백엔드에서 가져온 엔드포인트 주소에 필요한 커스텀 매크로를 붙여 여기에 입력합니다
- using a ...: POST 메서드를 선택합니다
- every time users trigger the event ...: 클라이언트 SDK로 전송하는 경우 INSTALL 이벤트를 선택할 수 있습니다
Save Rule을 클릭하여 규칙을 저장하면 Branch 콜백 설정이 완료됩니다
iOS 14.5 이후 install 활성화 이벤트 안내:
활성화가 유료 광고에 어트리뷰션된 경우, 유저가 ATT에서 opt-in을 선택하면 두 번째 install 활성화 이벤트가 트리거됩니다
opt-in 선택은 최종 활성화 수 집계에 영향을 줍니다. 다른 식별자(예: IDFV)를 사용하여 내부 시스템에서 중복 활성화 이벤트를 제거할 것을 권장합니다(AE 시스템 내에서 2차 개발 도구로 처리할 수 있습니다).
4. 데이터 저장
4.1 이벤트 저장 규칙
-
데이터의 event_timestamp 필드를 이벤트의 #event_time으로 사용합니다
-
데이터의 이벤트 이름은 통합 설정의 sink_event.event_mapping에서 가져오며, 기본값은 다음과 같습니다:
- 설치: branch_install
- sink_event.event_mapping에 없는 기타 이벤트: name 필드 앞에
branch_접두사를 붙입니다
-
콜백 주소의 기타 매크로에 대응하는 속성은 모두 저장됩니다
다음은 이 문서에서 제공하는 콜백 주소를 사용할 때 Branch가 콜백하는 속성 목록입니다:
| 저장명 | 의미 |
|---|---|
| name | Branch 이벤트 이름 |
| event_timestamp | 데이터 시간 |
| campaign | 어트리뷰션 Campaign 이름 |
| campaign_id | 어트리뷰션 Campaign ID |
| campaign_type | 어트리뷰션 Campaign 타입(Google AAP 어트리뷰션에서 가져옴) |
| customer_campaign | 커스텀 어트리뷰션 Campaign 이름 |
| channel | 어트리뷰션 Channel 이름 |
| feature | 어트리뷰션 Feature, 값 예: "paid advertising" |
| stage | Stage |
| tags | 어트리뷰션 태그 |
| advertising_partner_name | 읽을 수 있는 Advertising Partner 이름 |
| advertising_partner_id | Advertising Partner ID |
| secondary_publisher | Secondary Publisher 이름 |
| secondary_publisher_id | Secondary Publisher ID |
| customer_secondary_publisher | 커스텀 Secondary Publisher ID |
| creative_name | 어트리뷰션 Creative 이름 |
| creative_id | 어트리뷰션 Creative ID |
| ad_set_name | 어트리뷰션 Ad Set 이름 |
| ad_set_id | 어트리뷰션 Ad Set ID |
| customer_ad_set_name | 커스텀 Ad Set 이름 |
| ad_name | 어트리뷰션 Ad 이름 |
| ad_id | 어트리뷰션 Ad ID |
| customer_ad_name | 커스텀 Ad 이름 |
| keyword | 어트리뷰션 Keyword |
| keyword_id | 어트리뷰션 Keyword ID |
| customer_keyword | 커스텀 Keyword |
| branch_ad_format | 광고 타입, 값 예: Search, Display, Product Ad, App only |
| technology_partner | 서드파티 Technology Partner |
| banner_dimensions | Banner 크기 |
| placement | 어트리뷰션 Placement |
| placement_id | 어트리뷰션 Placement ID |
| customer_placement | 커스텀 Placement |
| sub_site_name | Sub Site 이름 |
| customer_sub_site_name | 커스텀 Sub Site 이름 |
| agency | Agency 이름 |
| agency_id | Agency ID |
| ta_distinct_id | AE 시스템의 게스트 ID |
| ta_account_id | AE 시스템의 계정 ID |
4.2 표준화 필드
Branch Webhook 콜백 데이터 리포트의 일부 필드는 AE 시스템에서 표준화 처리됩니다
| 원본 필드 | 표준화 필드 | 의미 |
|---|---|---|
| campaign | te_ads_object.campaign_name | 캠페인 이름 |
| campaign_id | te_ads_object.campaign_id | 캠페인 ID |
| ad_set_name | te_ads_object.ad_group_name | 광고 그룹 이름, 수익화 광고의 Unit 이름 |
| ad_set_id | te_ads_object.ad_group_id | 광고 그룹 ID, 수익화 광고의 Unit ID |
| ad_name | te_ads_object.ad_name | 광고 이름 |
| ad_id | te_ads_object.ad_id | 광고 ID |
| placement | te_ads_object.placement | 광고 위치 |
| channel | te_ads_object.media_source | 미디어 채널 |