Daily Exports & API

Overview

Branch의 Daily Exports는 세밀한 Branch 이벤트 데이터를 직접 가져옵니다. Branch 대시보드의 Daily Exports 섹션 또는 직접 API를 통해 수행할 수 있습니다.

몇 가지 중요 참고 사항 :

  • 과거 최대 6개월 간의 데이터만 검색할 수 있습니다.
  • 한 번에 최대 7일 분량의 데이터만 검색할 수 있습니다.
  • 데이터는 24시간마다 처리되므로 하루가 끝난 후에만 표시됩니다.
  • 화이트리스트 날짜 이전에는 데이터가 표시되지 않습니다. 등록하면 그 이후 UTC 날에 대한 데이터가 생성됩니다.
  • 데이터는 테스트 키가 아닌 라이브 키에 대해서만 표시됩니다.
  • SAN(예: 구글 애즈)과 관련된 클릭 데이터는 디바이스 레벨이 아닌 캠페인 레벨에서 찾을 수 있습니다.

❗️

7일 후 데이터 해싱

GDPR 및 기타 데이터 보호법과 관련된 내부 정책에 따라 IP 주소 및 광고 식별자를 포함한 많은 필드를 7일 후에 해시합니다.

즉, 대시보드의 CSV Export를 이용하거나 수동 데이터 덤프를 요청하여 7일이 지난 데이터를 내보내려는 경우 해당 필드에 더 이상 원래 값이 포함되지 않습니다.

따라서 항상 7일 이내에 원시 데이터를 내보내는 것이 좋습니다.

📘

Data Feeds 솔루션은 프리미엄 솔루션입니다.

Daily Export API는 Branch의 Data Feeds(데이터 연동) 오퍼링에 포함되어 있습니다. Branch의 가격 책정 일정 에 따라 구매할 수 있으며 Journeys (웹-투-앱 스마트배너), Universal Email(이메일-투-앱) 또는 Universal Ads(광고 어트리뷰션)에 대한 Launch 및 Startup을 이용하는 고객은 추가 요금 없이 이용 가능합니다.

Data Feeds 솔루션이 없어도 Sources또는 CSV Exports 를 통해 Branch 대시보드에서 직접 CSV 형식으로 Branch 데이터를 내보낼 수 있습니다.

❗️

써드파티 액세스

계정의 API 키에 액세스할 수 있는 모든 유저는 Branch의 Daily Export API (및 필터링 되지 않은 로그 레벨 데이터)에 액세스할 수 있습니다. 따라서 초대 프로세스 중에 민감한 데이터 및 앱 레벨 설정과 같은 API 키를 보는 데 필요한 권한을 써드파티(에이전시와 광고 파트너)에게 제공하지 않는 것이 좋습니다.

요구 사항

  • Data Feeds을 구독해야 합니다.
  • Data Feeds Manager page의 슬라이더를 사용하여 Data Export API을 전환합니다.
  • API에 액세스하려면 Sensitive DataExport 액세스 권한이 있어야합니다.

Branch 대시보드를 통해 액세스

Daily Export API에 직접 액세스하는 대신 Branch 대시보드의 Daily Exports 섹션을 사용하여 CSV를 통해 적절한 데이터를 요청할 수 있습니다.

📘

CSV 전송

대시보드를 통해 내보낸 모든 데이터는 이메일의 CSV 첨부 파일에 포함됩니다. 이메일 주소가 Account Settings에서 최신 상태인지 확인하십시오.

추출작업 요청하기:

  1. Branch대시보드 왼쪽 메뉴에서 Custom Exports를 클릭합니다.
  2. Daily Exports 페이지에서 데이터를 내보낼 기간을 선택합니다.
    • 지난 1일
    • 지난 3일
    • 지난 7일
    • Custom
  3. 내보낼 이벤트 유형을 선택하십시오.
  • 각각을 클릭하여 개별적으로 처리. Download arrow
  • Export All 버튼을 클릭하여 일괄 처리.

imageimage

요청이 있으면 요청 세부 정보를 확인하는 확인 이메일을 받게 됩니다. 내보내기 처리가 완료되면 CSV 첨부 파일로 포함된 다른 이메일을 받게 됩니다. 내보내기가 많으면 처리 시간이 더 오래 걸린다는 점에 주의하십시오.

API를 통한 액세스

해당 API를 사용하려면 앱 ID와 Branch 공개 키가 있어야 합니다.

Account Settings 에서 키를 찾을 수 있습니다.

Base URL:
https://api2.branch.io/v3/export/

엔드 포인트

쿼리 파라미터

branch_key 필수 :
발신 앱의 Branch 키

branch_secret 필수 :
발신 앱의 Branch 시크릿 키

export_date 필수 :
요청된 데이터 내보내기의 UTC 날짜

요청의 예:

curl -X POST api2.branch.io/v3/export -H 'content-type:application/json' -d '{"branch_key":"key_live_gcASshuadd7l39m36NhdsDPWRjmkdcgh12jsg1", "branch_secret": "secret_live_ztPsdKIjUtcjkUYF732nsl81HJ75BJqiv24J86", "export_date": "2017-10-21"}'

📘

Windows 명령 프롬프트 형식

Windows를 실행하는 기기의 명령 프롬프트에서 해당 curl 명령을 실행하려는 경우 '"로 변경하고 \로 중괄호 안에 있는 "를 이스케이프 해야 합니다. 다음은 최종 예시입니다. curl -X POST api2.branch.io/v3/export -H "content-type:application/json" -d "{\"branch_key\":\"key_live_gcASshuadd7l39m36NhdsDPWRjmkdcgh12jsg1\", \"branch_secret\": \"secret_live_ztPsdKIjUtcjkUYF732nsl81HJ75BJqiv24J86\", \"export_date\": \"2017-10-01\"}"

응답

응답 페이로드는 JSON 형식이며 각 내보내기에 대해 다운로드 할 S3의 파일 경로 배열이 있습니다. 여러 파일이 있을 수 있으며 (당일 내보내기 크기에 따라 다름) 각 csv 파일이 gzip으로 압축됩니다. 아래 예의 각 키는 지정된 날짜에 해당 토픽에 대한 이벤트가 있었는지 여부에 따라 응답에 표시되지 않을 수 있습니다.

{
 "eo_branch_cta_view": <Array of String(s)>,
  "eo_click": <Array of String(s)>,
  "eo_commerce_event": <Array of String(s)>,
  "eo_content_event": <Array of String(s)>,
  "eo_custom_event": <Array of String(s)>,
  "eo_impression": <Array of String(s)>,
  "eo_install": <Array of String(s)>,
  "eo_open": <Array of String(s)>,
  "eo_pageview": <Array of String(s)>,
  "eo_reinstall": <Array of String(s)>,
  "eo_sms_sent": <Array of String(s)>,
  "eo_user_lifecycle_event": <Array of String(s)>,
  "eo_web_session_start": <Array of String(s)>,
  "eo_web_to_app_auto_redirect": <Array of String(s)>,
  "eo_dismissal": <Array of String(s)>
}

Data Feeds 솔루션을 통한 모든 내보내기는 Branch의 사용자 중심 어트리뷰션을 기반으로 합니다. 해당 내보내기에 포함된 이벤트의 전체 목록과 각 이벤트에 대한 자세한 정의는 Event Ontology Data Scheme 를 참조하십시오.

📘

정보

해당 위치의 S3 버킷에서 하루 전체 파일을 사용할 수 있으며 UTC 기준 오후 7시경에 다운로드할 수 있습니다. UTC 날이 끝나고 데이터가 S3으로 전송될 때까지 빈 파일에 대해 S3에서 공백 배열을 반환하므로 전날 오후 7:00 UTC (12pm PST) 정도에 데이터를 가져오도록 ETL을 예약하는 것이 좋습니다.

❗️

IP와 위치정보의 불일치

IP로 위치를 분석할 수 없는 매우 적은 비율의 이벤트에 대해서는 국가 및 도시와 같은 지리 데이터를 사용하지 못할 수 있습니다.

서포트

시간 제한

데이터는 게시일 이후 6개월 동안만 API를 통해 이용 가능합니다. 6개월 전의 데이터 기록이 필요한 경우, 반복 추출을 설정하고 시스템에 데이터를 저장하십시오.

7일 이상 내보내기

GDPR 및 기타 데이터 보호법과 관련된 내부 정책에 따라 IP 주소 및 광고 식별자를 포함한 많은 필드를 7일 후에 해시합니다. 즉, 대시보드의 CSV Export를 이용하거나 수동 데이터 덤프를 요청하여 7일이 지난 데이터를 내보내려는 경우 해당 필드에 더 이상 원래 값이 포함되지 않습니다. 따라서 항상 7일 이내에 원시 데이터를 내보내는 것이 좋습니다.

📘

수동 데이터 덤프

수동 데이터 덤프를 완료하는 데 필요한 리소스로 인해 해당 서비스는 Branch 엔터프라이즈 Tier 클라이언트에서만 사용할 수 있습니다.

File Limitations

When using Daily Exports, multiple files are expected with 200K rows per file. If your export has less than 200K rows, there will only be one file.

11일 전에 업데이트됨


Recommended Next Steps

일일 Export FAQ

Daily Exports & API


제안된 편집은 API 참조 페이지에서 제한됩니다.

Markdown 본문 콘텐츠에 대한 편집만 제안할 수 있지만 API 사양에는 제안할 수 없습니다.


필터