Server-to-Server Events

Request Body Key	데이터 패칭 필드명	운영체제
device.deviceUUID	Airbridge Device ID	All
device.gaid	GAID (Google Advertising ID)	Android
device.appSetID	App Set ID	Android
device.ifa	IDFA	iOS, iPadOS
device.ifv	IDFV	iOS, iPadOS

Request Body Key

데이터 패칭 필드명

운영체제

device.deviceUUID

Airbridge Device ID

All

device.gaid

GAID (Google Advertising ID)

Android

device.appSetID

App Set ID

Android

device.ifa

IDFA

iOS, iPadOS

device.ifv

IDFV

iOS, iPadOS

Headers

Accept-Language

string

API 요청 및 결과 반환에 사용할 언어를 지정할 수 있습니다. ISO-639-1 포맷을 따릅니다.

Content-Type

string

리소스의 미디어 타입을 나타냅니다. 기본값으로 application/json을 사용합니다.

Authorization

string

API 요청에 사용하는 키값입니다. 키값 생성 및 조회 방법을 확인하여 획득할 수 있습니다.

X-Forwarded-For

필수string

사용자의 IP를 X-Forwarded-For 헤더로 보낼 수 있습니다. X-Forwarded-For가 없는 경우 사용자의 IP(클라이언트 요청 IP)가 아닌 Server To Server API를 요청한 서버의 IP로 사용자 행동이 기록됩니다.

ipv4(123.123.123.123), ipv6(2001:e60:87e3:81d4:cd57:5d52:ee2e:ff8d) 형태의 값을 받습니다.

Path Params

app_name

필수string

에어브릿지 앱 이름(App Name)

Body Params

eventUUID

string

고유 이벤트 ID.

uuid4 포맷의 event uuid는 이벤트 고유 ID로 Deduplication에 사용되며, 넣지 않으면 event api에서 자동 생성하게 됩니다.

eventTimestamp

number

이벤트 발생 시간.

Millisecond 단위의 Unix Timestamp입니다. (Unixtime 기준 13자리)

eventTimestamp가 이벤트 전송 시점 기준으로 24시간을 지나면 서버에서 처리하지 않습니다. 전송 시점 기준 24시간 이내의 timestamp를 사용해주세요.

user

object

유저에 관한 정보를 담을 수 있습니다.

device

object

디바이스 정보를 담습니다.

device.deviceUUID

stringnullable

에어브릿지 디바이스 ID.

GAID, IDFA, IDFV, Random Generated UUID, App Set ID를 받습니다.

device.gaid

stringnullable

구글에서 제공하는 광고 ID

device.ifa

stringnullable

애플에서 제공하는 광고 ID (IDFA)

device.appSetID

stringnullable

구글에서 제공하는 AppSetID.

device.ifv

stringnullable

애플에서 제공하는 IDFV.

device.limitAdTracking

boolean

디바이스의 광고 추적 제한 설정값.

true : 광고 추적 제한
false : 광고 추적 허용

device.deviceModel

stringnullable

디바이스 모델명.

device.appTrackingTransparency

integer

App Tracking Transparency

Value	ATT Status
0	Not Determined
1	Restricted
2	Denied
3	Authorized

device.deviceIdentifier

string

iPhone11,2과 같은 구체적인 디바이스 식별자. (iPhone만 가능)

device.manufacturer

string

디바이스 제조사.

device.osName

필수enum

디바이스 운영체제 이름.

ENUM VALUES

Android

안드로이드

iOS

iOS

device.osVersion

필수string

디바이스 운영체제 버전.

device.locale

string

디바이스 로케일.

device.timezone

string

디바이스 타임존.

device.orientation

string

디바이스 방향.

device.screen

string

디바이스 스크린 정보.

device.location

object

디바이스 위치.

device.network

object

디바이스 네트워크 정보.

device.alias

object

디지털 시장법(DMA)을 준수하기 위해 필요한 유저 응답 정보를 에어브릿지에 전송할 수 있습니다. DMA에 대한 자세한 내용은 에어브릿지 가이드를 참고해 주세요.

app

필수object

사용자의 앱 정보를 담습니다.

eventData

필수object

에어브릿지에 전송할 이벤트를 정의하는 객체입니다.

Request

123456
curl -X POST 'https://api.airbridge.io/events/v1/apps/{app_name}/mobile-app/9360' \
  -H 'Accept-Language: ko' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}' \
  -H 'X-Forwarded-For: 2001:e60:87e3:81d4:cd57:5d52:ee2e:ff8d' \
  -d '{"eventUUID":"9b4b3e4e-2162-4ae6-8986-91ee84644262","user":{"externalUserID":"19443","externalUserEmail":"example@ab180.co","externalUserPhone":"821012341234"},"device":{"deviceUUID":"2dfca632-86f3-4d22-9746-cdfe7985c471","gaid":"2dfca632-86f3-4d22-9746-cdfe7985c471","ifa":"542177F1-5C23-438B-8088-82D34C94F6D7","appSetID":"7c4681ef-97c6-4ebd-9c04-e22f584b3746","ifv":"37EEC3E0-BF15-412E-ADBA-7D2E82E7A75F","deviceModel":"LG-H542","appTrackingTransparency":0,"deviceIdentifier":"iPhone11,2","manufacturer":"Samsung","osName":"Android","osVersion":"5.0.2","locale":"ko-KR","timezone":"Asia/Seoul","orientation":"portrait","screen":{"width":123},"location":{"latitude":120.103,"speed":"12"},"network":{"carrier":"SKTelecom","cellular":true,"wifi":true}},"app":{"packageName":"com.ab180.co","version":"1.2.3"},"eventData":{"goal":{"category":"airbridge.ecommerce.product.addedToCart","semanticAttributes":{"currency":"KRW","action":"shoes","label":"nike","transactionID":"12939172","inAppPurchased":true,"products":[{"currency":"KRW","name":"나이키 커스텀","price":10990}]}}}}'

Payload

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
{
  "eventUUID": "9b4b3e4e-2162-4ae6-8986-91ee84644262",
  "user": {
    "externalUserID": "19443",
    "externalUserEmail": "example@ab180.co",
    "externalUserPhone": "821012341234"
  },
  "device": {
    "deviceUUID": "2dfca632-86f3-4d22-9746-cdfe7985c471",
    "gaid": "2dfca632-86f3-4d22-9746-cdfe7985c471",
    "ifa": "542177F1-5C23-438B-8088-82D34C94F6D7",
    "appSetID": "7c4681ef-97c6-4ebd-9c04-e22f584b3746",
    "ifv": "37EEC3E0-BF15-412E-ADBA-7D2E82E7A75F",
    "deviceModel": "LG-H542",
    "appTrackingTransparency": 0,
    "deviceIdentifier": "iPhone11,2",
    "manufacturer": "Samsung",
    "osName": "Android",
    "osVersion": "5.0.2",
    "locale": "ko-KR",
    "timezone": "Asia/Seoul",
    "orientation": "portrait",
    "screen": {
      "width": 123
    },
    "location": {
      "latitude": 120.103,
      "speed": "12"
    },
    "network": {
      "carrier": "SKTelecom",
      "cellular": true,
      "wifi": true
    }
  },
  "app": {
    "packageName": "com.ab180.co",
    "version": "1.2.3"
  },
  "eventData": {
    "goal": {
      "category": "airbridge.ecommerce.product.addedToCart",
      "semanticAttributes": {
        "currency": "KRW",
        "action": "shoes",
        "label": "nike",
        "transactionID": "12939172",
        "inAppPurchased": true,
        "products": [
          {
            "currency": "KRW",
            "name": "나이키 커스텀",
            "price": 10990
          }
        ]
      }
    }
  }
}

파라미터	데이터 패칭 필드명	설명
eventData.shortID	Attribution Short ID	캠페인 파라미터 ID
eventData.trackingData.channel	Default Attribution Channel	캠페인 채널
eventData.trackingData.params	Default Attribution Parameters	캠페인 파라미터

파라미터

데이터 패칭 필드명

설명

eventData.shortID

Attribution Short ID

캠페인 파라미터 ID

eventData.trackingData.channel

Default Attribution Channel

캠페인 채널

eventData.trackingData.params

Default Attribution Parameters

캠페인 파라미터

Headers

Accept-Language

string

API 요청 및 결과 반환에 사용할 언어를 지정할 수 있습니다. ISO-639-1 포맷을 따릅니다.

Content-Type

string

리소스의 미디어 타입을 나타냅니다. 기본값으로 application/json을 사용합니다.

Authorization

string

API 요청에 사용하는 키값입니다. 키값 생성 및 조회 방법을 확인하여 획득할 수 있습니다.

X-Forwarded-For

필수string

ipv4(123.123.123.123), ipv6(2001:e60:87e3:81d4:cd57:5d52:ee2e:ff8d) 형태의 값을 받습니다.

Path Params

app_name

필수string

에어브릿지 앱 이름(App Name)

Body Params

eventUUID

string

고유 이벤트 ID.

uuid4 포맷의 event uuid는 이벤트 고유 ID로 Deduplication에 사용되며, 넣지 않으면 event api에서 자동 생성하게 됩니다.

eventTimestamp

number

이벤트 발생 시간.

Millisecond 단위의 Unix Timestamp입니다. (Unixtime 기준 13자리)

eventTimestamp가 이벤트 전송 시점 기준으로 24시간을 지나면 서버에서 처리하지 않습니다. 전송 시점 기준 24시간 이내의 timestamp를 사용해주세요.

user

object

유저에 관한 정보를 담을 수 있습니다.

browser

object

브라우저 정보를 담을 수 있습니다.

eventData

필수object

에어브릿지에 전송할 이벤트를 정의하는 객체입니다.

eventData.shortID

필수string

어트리뷰션 캠페인 파라미터 ID. SDK Data Fetching을 통해 획득한 값을 전송하여야합니다.

중요: 이 값은 처리나 여과 없이 에어브릿지 서버로 전송되어야합니다.

Data Fetching이 불가능한 경우 User ID(user.externalUserID)를 전송하는 조건으로 생략할 수 있습니다.

eventData.trackingData

필수object

에어브릿지의 어트리뷰션에 적용할 데이터를 담을 수 있습니다.

eventData.goal

필수object

이벤트에 관한 정보를 담을 수 있는 객체입니다.
카테고리, 액션, 라벨, 밸류, 시맨틱 어트리뷰트(Semantic Attributes)를 담을 수 있습니다.
(관련 가이드)

curl -X POST 'https://api.airbridge.io/events/v1/apps/{app_name}/web/9320' \ -H 'Accept-Language: ko' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}' \ -H 'X-Forwarded-For: 2001:e60:87e3:81d4:cd57:5d52:ee2e:ff8d' \ -d '{"eventUUID":"9b4b3e4e-2162-4ae6-8986-91ee84644262","user":{"externalUserID":"19443","externalUserEmail":"example@ab180.co","externalUserPhone":"821012341234"},"browser":{"clientID":"05609013-bb5a-4594-bbc3-832cb1b87072","userAgent":"Mozilla/5.0 (iPhone; CPU iPhone OS 11_3 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E302"},"eventData":{"shortID":"aef04","trackingData":{"channel":"blog"},"goal":{"category":"airbridge.ecommerce.product.addedToCart","semanticAttributes":{"action":"shoes","label":"nike","query":"나이키","transactionID":"12939172","inAppPurchased":true,"currency":"KRW","products":[{"position":"1","productID":"30372425","name":"나이키 커스텀","price":10990,"quantity":1,"currency":"KRW"}]}}}}'

{ "eventUUID": "9b4b3e4e-2162-4ae6-8986-91ee84644262", "user": { "externalUserID": "19443", "externalUserEmail": "example@ab180.co", "externalUserPhone": "821012341234" }, "browser": { "clientID": "05609013-bb5a-4594-bbc3-832cb1b87072", "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 11_3 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E302" }, "eventData": { "shortID": "aef04", "trackingData": { "channel": "blog" }, "goal": { "category": "airbridge.ecommerce.product.addedToCart", "semanticAttributes": { "action": "shoes", "label": "nike", "query": "나이키", "transactionID": "12939172", "inAppPurchased": true, "currency": "KRW", "products": [ { "position": "1", "productID": "30372425", "name": "나이키 커스텀", "price": 10990, "quantity": 1, "currency": "KRW" } ] } } } }

인앱 이벤트 전송하기

유저 식별자 유형

1. Device ID

전송 예시

2. User ID(`user.externalUserID`)

전송 예시

이벤트 예시

상품 구매 예시

Request

Headers

Path Params

Body Params

Response

200SUCCESS

400ERROR

401ERROR

인웹 이벤트 전송하기

유저 식별자 유형

전송 예시

II. User ID(`user.externalUserID`)

전송 예시

Request

Headers

Path Params

Body Params

Response

200SUCCESS

400ERROR

401ERROR

Server-to-Server Eventsself.__wrap_n!=1&&self.__wrap_b(":R29jtt7ppjtsba:",0.5)

인앱 이벤트 전송하기

유저 식별자 유형

1. Device ID

전송 예시

2. User ID(user.externalUserID)

전송 예시

이벤트 예시

상품 구매 예시

Request

Headers

Path Params

Body Params

Response

200SUCCESS

400ERROR

401ERROR

인웹 이벤트 전송하기

유저 식별자 유형

I. Cookie ID(browser.clientID)

전송 예시

II. User ID(user.externalUserID)

전송 예시

Request

Headers

Path Params

Body Params

Response

200SUCCESS

400ERROR

401ERROR

Server-to-Server Events

2. User ID(`user.externalUserID`)

I. Cookie ID(`browser.clientID`)

II. User ID(`user.externalUserID`)