로딩중입니다
애드브릭스 포스트백 가이드
3/23/2018 1:48:49 PM

애드브릭스 오리지널 포스트백 가이드


본 문서를 이용하여 애드브릭스가 제공하는 각 포스트백을 연동할 수 있습니다.

본 문서는 애드브릭스 오리지널 버전으로 새로 출시된 리마스터 버전의 연동 가이드는 다음의 링크를 참고 부탁 드립니다.

[애드브릭스 리마스터 파트너 연동 안내]


*미디어 파트너사(광고매체)로 등록하고자 하시는 경우
애드브릭스의 Integrated Partner로 참여하기 원하는 파트너 사는 본 문서를 참고하여 포스트백을 구성하여 등록 신청을 완료해야 합니다.
본 문서의 'Integrated Partner 등록 안내'를 확인 해주세요.


*커스텀 포스트백을 활용하고자 하시는 경우
애드브릭스의 커스텀 포스트백은 별도의 신청 절차 없이 광고주가 직접 채널 생성 및 포스트백 설정 후 진행 가능합니다.
자체 B.I(Business Intelligence) 솔루션과의 연동 등에 이용할 수 있습니다. 별도 이용가이드를 참고 확인 해주세요.


업데이트 안내 [2018.11.28]

1. 이벤트 포스트백에서의 Fraud 의심 플래그 추가

[상세보기]




파트너 등록 안내


안내!!!


신청서를 작성하시기 전에 [포스트백 구성 지원 툴] 을 이용하여 템플릿 테스트를 먼저 진행 부탁 드립니다.



Integrated Partner 는 애드브릭스 트래킹 파트너로서 어트리뷰션 포스트백과 이벤트 포스트백을 사전에 연동된 포스트백 서버로 전송받을 수 있습니다.

파트너로 등록하기 위해서는 다음의 신청서를 작성하여 제출하여야 합니다.

신청서 양식 열기


제출된 신청서를 애드브릭스 담당자가 검토 후에 기재하신 메일 주소로 테스트 방법을 안내 드립니다.

테스트가 완료된 뒤에 양사가 모두 결과가 확인되면 요청한 포스트백 기능을 라이브 처리하게 됩니다.


주의사항 


최소 SDK 버전

모든 포스트백 기능을 정상적으로 사용하기 위해서는 반드시 다음의 최소 SDK 버전이 앱에 탑재되어 있어야 합니다.

  • 안드로이드 : IgawCommon ver_4.3.0
  • iOS : IgaworksCore ver_2.2.8


방화벽 예외 등록

애드브릭스는 AWS 클라우드 서비스를 이용하고 있습니다. 포스트백을 구성하는 서버에서 방화벽 예외 등록이 필요한 경우 애드브릭스 파트너 지원팀(abx_partner@igaworks.com)으로 관련 정보를 요청 부탁 드립니다.



포스트백 매크로


포스트백 타입

애드브릭스의 포스트백 타입은 크게 2가지로 구분됩니다.

  • 어트리뷰션 포스트백

트래킹링크 클릭을 통한 앱의 신규설치, 재설치, 재오픈 이벤트에 대해서 포스트백을 전송합니다.

  • 이벤트 포스트백

앱에서 발생한 유저 액션 이벤트에 대해서 포스트백을 전송합니다.


각각의 포스트백 타입(install, re-install, re-open, event)에서 지원하는 매크로를 적절하게 활용하여 포스트백 서버를 구성할 수 있습니다.


App Data Macros

macro disc example install re-install re-open event
{appkey} 애드브릭스 앱키 48793762
{package_name} 안드로이드 패키지 네임 or iOS 번들 네임 com.igaworks.myapp


Device Data Macros

macro disc example install re-install re-open event
{gaid} 구글 광고ID (GAID) e74b4849-5f91-4ad7-9ece-96f131f5945f
{ifa} 애플 광고ID (IFA) 31C7AE39-68A9-4281-8647-3C6F0A573E79
{ifv} 애플 벤더ID (IFV) 5EC237DF-B877-4726-B1E0-F6BC6A24BC4D
{model} 디바이스 모델 네임 SM-G935K
{network} 디바이스 네트워크 타입 mobile
{os_ver} 운영체제 버전 10.1.1
{sdk_version} 애드브릭스 SDK 버전 5.1.1
{platform} 플랫폼 타입 ios
{country} 2자리 문자열의 국가코드 KR
{language} 2자리 문자열의 언어코드 ko
{width} 디바이스 해상도 너비 1920
{height} 디바이스 해상도 높이 1080
{carrier} 통신사 명 olleh
  • {ifa} : 기본적으로 애플광고식별자를 전달하며 iOS10 이상에서 Limited Advertising Tracking 기능이 활성화되었을 때에는 공백으로 전달됩니다.


  • {first_install_datetime_kst} , {first_install_time} : 앱에 탑재된 애드브릭스 SDK가 최초로 실행된 시각을 전달합니다.


Conversion Data Macros

macro disc example install re-install re-open event
{is_install_attributed} 포스트백을 수신하는 Integrated Partner 채널을 통해 어트리뷰션이 발생했을 때 1을 전달. (기타 : 0을 전달) 1
{is_last_attributed} 포스트백을 수신하는 Integrated Partner 채널을 통해 이벤트가 발생했을 때 1을 전달. (Last Attribution 이 대상 채널로 발생했을 때.) 1
{is_suspicious} fraud 로 의심되는 이벤트가 발생했을 때 1을 전달. (이벤트 포스트백에서만 제공) 1
{event_type_code} 애드브릭스 이벤트 타입 코드 (1:install, 2:re-open, 3:inapp-event, 4:commerce-event) 1
{measurement_type} 어트리뷰션 방식 (google_referrer, fingerprint, advertising_id, click_id) google_referrer
{installer} 안드로이드 패키지 인스톨러 com.android.vending
{channel_id} 애드브릭스 채널ID, {is_attributed}가 1인 경우에만 전달. 1001
{channel_name} 애드브릭스 채널명, {is_attributed}가 1인 경우에만 전달. My Channel
{conversion_key} 애드브릭스 트래킹링크ID, {is_attributed}가 1인 경우에만 전달. 5000121
{conversion_name} 애드브릭스 트래킹링크 명, {is_attributed}가 1인 경우에만 전달. sample_tracking_link_name
{sub_conversion_key} 애드브릭스 서브 트래킹링크ID, {is_attributed}가 1인 경우에만 전달. 2012451
{sub_conversion_name} 애드브릭스 서브 트래킹링크 명, {is_attributed}가 1인 경우에만 전달. sample_tracking_link_name_type_A
{event_datetime_kst} 트래킹링크를 통해 유입된 시각, KST 기준 20170209194246010
{event_datetime_utc} 트래킹링크를 통해 유입된 시각, UTC 기준 20170209104246010
{event_time} 트래킹링크를 통해 유입된 시각 (Unix Timestamp) 1511145144
{is_new_user} 신규유저일 때 1을 전달. (기타 : 0을 전달) 20170209104246010
{conversion_ip} 유입될 때 취득된 디바이스 아이피 정보 255.255.255.255
{click_to_install_time} 트래킹링크 클릭 후 앱 설치완료까지 걸린 시간(second) 120
  • {measurement_type},{channel_id},{channel_name},{conversion_key}.{conversion_name},{sub_conversion_key},{sub_conversion_name} :  {is_install_attributed}가 1인 경우에 어트리뷰션 포스트백에서 전달되며 다른 경우에서는 전달되지 않습니다.
  • {is_last_attributed} :   채널을 통해 발급된 트래킹링크를 통해서 기존유저가 앱을 재설치, 혹은 오픈한 이후에 발생한 이벤트에 대해서 {is_last_attributed}에 1을 전달합니다.


Click Data Macros

macro disc example install re-install re-open event
{session_datetime_kst} 애드브릭스 트래킹링크 클릭 시각 (KST 기준) 20170209194246010
{session_datetime_utc} 애드브릭스 트래킹링크 클릭 시각 (UTC 기준) 20170209104246010
{session_time} 애드브릭스 트래킹링크 클릭 시각 (Unix Timestamp) 1511145144
{session_id} 애드브릭스 세션넘버 8348687_4115541102
{click_ip} 트래킹링크를 클릭한 유저의 아이피 정보 255.255.255.255
{cb_param1} Integrated Partner가 트래킹링크의 cb_param1로 전달한 값. (Install 포스트백에서만 전달) my%23cusmtom%26value%3D1
{cb_param2} Integrated Partner가 트래킹링크의 cb_param2로 전달한 값. (Install 포스트백에서만 전달) my%23cusmtom%26value%3D2
{cb_param3} Integrated Partner가 트래킹링크의 cb_param3로 전달한 값. (Install 포스트백에서만 전달) my%23cusmtom%26value%3D3
{cb_param4} Integrated Partner가 트래킹링크의 cb_param4로 전달한 값. (Install 포스트백에서만 전달) my%23cusmtom%26value%3D4
{cb_param5} Integrated Partner가 트래킹링크의 cb_param5로 전달한 값. (Install 포스트백에서만 전달) my%23cusmtom%26value%3D5
{install_cb_param1} Integrated Partner가 최초 유입된 트래킹링크의 cb_param1로 전달한 값. (is_install_attributed가 1인 event 포스트백에서만 전달) my%23cusmtom%26value%3D1
{install_cb_param2} Integrated Partner가 최초 유입된 트래킹링크의 cb_param2로 전달한 값. (is_install_attributed가 1인 event 포스트백에서만 전달) my%23cusmtom%26value%3D2
{install_cb_param3} Integrated Partner가 최초 유입된 트래킹링크의 cb_param3로 전달한 값. (is_install_attributed가 1인 event 포스트백에서만 전달) my%23cusmtom%26value%3D3
{install_cb_param4} Integrated Partner가 최초 유입된 트래킹링크의 cb_param4로 전달한 값. (is_install_attributed가 1인 event 포스트백에서만 전달) my%23cusmtom%26value%3D4
{install_cb_param5} Integrated Partner가 최초 유입된 트래킹링크의 cb_param5로 전달한 값. (is_install_attributed가 1인 event 포스트백에서만 전달) my%23cusmtom%26value%3D5
{last_cb_param1} Integrated Partner가 최종 클릭된 트래킹링크의 cb_param1로 전달한 값. (is_last_attributed가 1인 이벤트 포스트백에서만 전달) my%23cusmtom%26value%3D1
{last_cb_param2} Integrated Partner가 최종 클릭된 트래킹링크의 cb_param2로 전달한 값. (is_last_attributed가 1인 이벤트 포스트백에서만 전달)
my%23cusmtom%26value%3D2
{last_cb_param3} Integrated Partner가 최종 클릭된 트래킹링크의 cb_param3로 전달한 값. (is_last_attributed가 1인 이벤트 포스트백에서만 전달) my%23cusmtom%26value%3D3
{last_cb_param4} Integrated Partner가 최종 클릭된 트래킹링크의 cb_param4로 전달한 값. (is_last_attributed가 1인 이벤트 포스트백에서만 전달) my%23cusmtom%26value%3D4
{last_cb_param5} Integrated Partner가 최종 클릭된 트래킹링크의 cb_param5로 전달한 값. (is_last_attributed가 1인 이벤트 포스트백에서만 전달) my%23cusmtom%26value%3D5
  • {cb_param1}~{cb_param5} : Integrated Partener를 통해 신규유입이 발생했을 때, {is_install_attributed}가 1인 경우에 트래킹링크 클릭 시 cb_param1~5 파라미터로 전달된 값을 어트리뷰션 포스트백에서 전달합니다. 
  • {install_cb_param1}~{install_cb_param5} : Integrated Partner를 신규유입된 유저가 포스트백에 설정된 이벤트를 발생시켰을 때, {is_install_attributed}가 1인 경우에 신규유입 트래킹링크 클릭 시 cb_param1~5 파라미터로 전달된 값을 이벤트 포스트백에서 전달합니다.
  • {last_cb_param1}~{last_cb_param5} : Integration Partner를 통해서 재유입된 유저가 포스트백에 설정된 이벤트를 발생시켰을 때, {is_last_attributed}가 1인 경우에 라스트 클릭 시 cb_param1~5 파라미터로 전달된 값을 이벤트 포스트백에서 전달합니다. 

 Caution!   cb_param1~5 로 전달되어지는 값에 특수문자가 포함되는 경우에는 반드시 URL인코딩 처리를 해야 합니다.


Event Data Macros

macro disc example install re-install re-open event
{activity_group} 발생한 유저 행동의 애드브릭스 액티비티 그룹명. (session, fte, ret, commerce) ret
{activity} 발생한 유저 행동의 애드브릭스 액티비티 명. 광고주가 API를 통해 세팅한 값에 따라 변동. login_complete
{activity_param} 발생한 유저 행동의 애드브릭스 액티비티 파라미터, 광고주가 API를 통해 세팅한 값에 따라 변동. kakaotalk
{order_id} 애드브릭스 Purchase API를 통해 전달된 주문ID. (커머스 이벤트에서만 전달) oid_10001
{product_id} 애드브릭스 커머스 API를 통해 전달된 상품ID. (커머스 이벤트에서만 전달) pid_10001
{product_name} 애드브릭스 커머스 API를 통해 전달된 상품명. (커머스 이벤트에서만 전달) Pencil and eraser
{price} 애드브릭스 커머스 API를 통해 전달된 상품단가. (커머스 이벤트에서만 전달) 9900.00
{quantity} 애드브릭스 커머스 API를 통해 전달된 상품구매수량. (커머스 이벤트에서만 전달) 2
{sales} 애드브릭스 커머스 API를 통해 전달된 상품단가 X 구매수량. (커머스 이벤트에서만 전달) 19800.00
{category} 애드브릭스 커머스 API를 통해 전달된 상품 카테고리. (커머스 이벤트에서만 전달) Cat1.Cat2.Cat3.Cat4.Cat5
{currency} 애드브릭스 커머스 API를 통해 전달된 결제 화폐 단위. (커머스 이벤트에서만 전달) KRW
{deeplink_url} 애드브릭스 커머스 deeplink open API를 통해 전달된 딥링크 오픈 url. (커머스 이벤트에서만 전달) scheme://host?path
{keyword} 애드브릭스 커머스 search API를 통해 전달된 검색 문자열. (커머스 이벤트에서만 전달) 검색어
{event_detail} 애드브릭스 커머스 API를 통해 전달된 Json 형태의 이벤트 정보. (커머스 이벤트에서만 전달, Url Encoded, [참고 가이드]) URL ENCODED JSON OBJECT
{event_datetime_kst} 이벤트 발생 시각 (KST 기준) 20170209194246010
{event_datetime_utc} 이벤트 발생 시각 (UTC 기준) 20170209194246010
{event_time} 이벤트 발생 시각 (Unix Timestamp) 1511145144
  • 일반 유저 이벤트 : 일반 유저 이벤트들에 대해서는 광고주가 애드브릭스 API를 연동한 방식에 따라서 {activity_group}은 fte, ret 등으로 전달되고, {activity}는 API에 입력한 액티비티명으로 전달됩니다.
  • 데일리 앱 오픈 이벤트 : 위 이벤트에 대해서는 {activity_group} 은 session으로, {activity}는 retention 의 고정값으로 전달 됩니다.
  • 커머스 이벤트 : 아래 이벤트에 대해서는 {activity_group} 은 commerce 로 전달되며 activity는 다음의 항목으로 전달됩니다.
커머스 이벤트 {activity} 값 이벤트 상세 (커머스 api를 이용하여 측정되는 이벤트)
로그인 login 유저가 앱에 로그인을 하는 이벤트
딥링킹 앱 오픈 deeplink_open 딥링킹을 이용하여 앱이 오픈되는 이벤트
뷰 홈 view_home 앱의 메인화면(홈)으로 이동한 이벤트
카테고리 뷰 category_view 기획전이나 카테고리 뷰로 이동한 이벤트
상품 상세보기 product_view 상품 상세보기로 이동한 이벤트
장바구니 담기 add_to_cart 상품을 장바구니에 담는 이벤트
위시리스트 추가 add_to_wishlist 상품을 위시리스트에 추가하는 이벤트(관심상품 등록)
주문 내역 검토 review_order 주문을 진행하기 전 주문 내역을 검토하는 이벤트
상품 결제 purchase 상품을 결제하는 이벤트
주문 취소 refund 완료한 주문을 취소하거나 환불을 요청하는 이벤트
상품 검색 search 유저가 키워드를 입력하여 상품을 검색하는 이벤트
상품 공유 share 유저가 상품을 메신저나 문자를 통하여 공유하는 이벤트

       Caution!!!  purchase 를 제외한 커머스 이벤트들을 모두 사용하기 위해서는 Adbrix SDK의 버전이 aos 4.4.6, ios 2.2.3 이상이어야 합니다.




      포스트백 프로토콜 테스트 지원 툴

      프로토콜 테스트 지원 툴을 이용하여 애드브릭스 포스트백 발송 조건 별로 전송되어지는 데이터를 확인할 수 있습니다.