Server To Server Event

Server to Server 방식으로 인앱/인웹 이벤트를 전송할 수 있습니다.

인웹 이벤트 전송하기

POST

https://api.airbridge.io/events/v1/apps/{app_name}/web/9320

Try API Request

Server To Server 방식으로 인웹 이벤트를 전송합니다.

전송 방식

웹 SDK의 Cookie ID를 기준으로 어트리뷰션이 필요한 경우 사용합니다. [데이터 패칭 가이드]

2. User ID(`user.externalUserId`)를 기준으로 한 이벤트 전송.

User ID를 기준으로 어트리뷰션이 필요한 경우 사용합니다. Airbridge는 내부 ID 테이블에 기존에 user.externalUserID와 매칭되어있는 clientID를 기준으로 어트리뷰션 합니다. User ID를 사용하여 매칭하는 경우 Client ID를 보내지 않아도 되며, 아래 필드는 선택적 파라미터가 됩니다.

파라미터	설명
eventData.shortID	어트리뷰션 캠페인 파라미터 ID
eventData.trackingData.channel	어트리뷰션 캠페인 채널
eventData.trackingData.params	어트리뷰션 캠페인 파라미터

Request

Headers

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

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

user.externalUserID

필수string

사용자 아이디.

User ID(user.externalUserId)를 기준으로 이벤트 전송을 할 경우 browser.clientID는 필수 필드가 아니게 됩니다.

user.externalUserEmail

string

사용자 이메일.

user.externalUserPhone

string

사용자 전화번호.

user.attributes

object

커스텀 사용자 속성.

JSON 형태의 데이터를 받습니다.

{ "age_group": "30", "brand": "Nike" }

browser

object

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

browser.clientID

필수string

브라우저 쿠키 아이디. SDK에서 Fetching한 값이 필요합니다. 관련 문서

Cookie ID(browser.clientID)를 기준으로 이벤트 전송을 할 경우 user.externalUserId는 필수 필드가 아니게 됩니다.

browser.userAgent

string

브라우저의 유저 에이전트.

eventData

object

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

eventData.shortID

필수string

어트리뷰션 캠페인 파라미터 ID.

User ID(user.externalUserId)를 기준으로 이벤트 전송을 할 경우 필수 필드가 아니게 됩니다.

eventData.trackingData

필수object

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

eventData.trackingData.channel

필수string

어트리뷰션 캠페인 채널.

User ID(user.externalUserId)를 기준으로 이벤트 전송을 할 경우 필수 필드가 아니게 됩니다.

eventData.trackingData.params

필수object

어트리뷰션 캠페인 파라미터.

{medium: "posting", campaign: "blog", term: "airbridge", content: "martech-solution"} })

User ID(user.externalUserId)를 기준으로 이벤트 전송을 할 경우 필수 필드가 아니게 됩니다.

eventData.goal

object

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

eventData.goal.category

필수string

에어브릿지 이벤트 카테고리.

eventData.goal.action

string

이벤트 액션.

eventData.goal.label

string

이벤트 라벨.

eventData.goal.value

number

이벤트 값.

eventData.goal.semanticAttributes

object

에어브릿지가 수집할 데이터를 미리 정의한 속성입니다.

eventData.goal.semanticAttributes.query

string

사용자 검색 쿼리.

eventData.goal.semanticAttributes.productListID

string

상품 리스트 ID.

eventData.goal.semanticAttributes.cartID

string

장바구니 ID.

eventData.goal.semanticAttributes.transactionID

string

거래 ID.

eventData.goal.semanticAttributes.inAppPurchased

boolean

In-app 구매 여부.

true : In-app 구매
false : In-app 구매 아님

eventData.goal.semanticAttributes.products

object[]

상품에 대한 정보를 리스트로 담을 수 있습니다.

eventData.goal.semanticAttributes.products.[0].position

string

상품 위치.

eventData.goal.semanticAttributes.products.[0].productID

string

상품 ID.

eventData.goal.semanticAttributes.products.[0].name

string

상품 이름.

eventData.goal.semanticAttributes.products.[0].price

number

상품 가격.

eventData.goal.semanticAttributes.products.[0].quantity

string

상품 수량.

eventData.goal.semanticAttributes.products.[0].currency

string

화폐 단위.

eventData.goal.customAttributes

object

커스텀 이벤트 속성.

{ "color": "red" }

Request

123456
curl -X POST 'https://api.airbridge.io/events/v1/apps/{app_name}/web/9320' \
  -H 'Aceept-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":"add-to-cart","action":"shoes","label":"nike","semanticAttributes":{"query":"나이키","productListID":"list-id-1","cartID":"cart-id-1","transactionID":"12939172","inAppPurchased":true,"products":[{"position":"1","productID":"30372425","name":"\b나이키 커스텀","price":1000,"quantity":"1","currency":"KRW"}]}}}}'

Payload

12345678910111213141516171819202122232425262728293031323334353637383940
{
  "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": "add-to-cart",
      "action": "shoes",
      "label": "nike",
      "semanticAttributes": {
        "query": "나이키",
        "productListID": "list-id-1",
        "cartID": "cart-id-1",
        "transactionID": "12939172",
        "inAppPurchased": true,
        "products": [
          {
            "position": "1",
            "productID": "30372425",
            "name": "\b나이키 커스텀",
            "price": 1000,
            "quantity": "1",
            "currency": "KRW"
          }
        ]
      }
    }
  }
}

Response

200 SUCCESS

Response

1234
{
  "at": "2020-02-06 16:06:49",
  "data": "Event(9320) is successfully proccessed."
}

인앱 이벤트 전송하기

POST

https://api.airbridge.io/events/v1/apps/{app_name}/mobile-app/9360

Try API Request

Server To Server 방식으로 인앱 이벤트를 전송할 수 있습니다.

전송 방식

1. Device ID(device.deviceUUID)를 기준으로 한 이벤트 전송.

SDK의 Device ID를 기준으로 어트리뷰션이 필요한 경우 사용합니다. [데이터 패칭 가이드]

2. User ID(user.externalUserID)를 기준으로 한 이벤트 전송.

User ID를 기준으로 어트리뷰션이 필요한 경우 사용합니다. Airbridge는 내부 ID 테이블에 기존에 user.externalUserID와 매칭되어있는 Device를 기준으로 어트리뷰션 합니다. User ID를 사용하여 매칭을 하는 경우 Device ID를 보내지 않아도 되며, User ID와 매칭된 디바이스가 없을 경우 해당 이벤트는 처리되지 않습니다.

Request

Headers

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 형식의 랜덤한 문자열을 받습니다.

eventTimestamp

필수number

이벤트 발생 시간.

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

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

user

string

사용자 정보를 담습니다.

user.externalUserID

string

사용자 아이디.

user.externalUserEmail

string

사용자 이메일.

user.externalUserPhone

string

사용자 전화번호.

user.attributes

object

커스텀 사용자 속성.

{ "age_group": "30", "brand": "Nike" }

device

object

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

device.deviceUUID

필수string

에어브릿지 디바이스 ID.

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

device.gaid

필수stringnullable

구글에서 제공하는 광고 ID

device.ifa

필수stringnullable

애플에서 제공하는 광고 ID

device.ifv

필수stringnullable

애플에서 제공하는 IFV.

device.limitAdTracking

string

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

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

device.deviceModel

필수string

디바이스 모델명.

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.screen.density

string

디바이스 해상도.

device.screen.height

number

디바이스 스크린 높이.

device.screen.width

number

디바이스 스크린 너비.

device.location

object

디바이스 위치.

device.location.longitude

number

디바이스 위치 위도.

device.location.latitude

number

디바이스 위치 경도.

device.location.altitude

number

디바이스 위치 고도.

device.location.speed

string

디바이스 위치 속도.

device.network

object

디바이스 네트워크 정보.

device.network.carrier

string

디바이스 통신사.

device.network.bluetooth

boolean

디바이스 블루투스 활성화 여부.

true: 블루투스 활성화
false: 블루투스 비활성화

device.network.cellular

boolean

디바이스 셀룰러 데이터 활성화 여부.

true: 셀룰러 데이터 활성화
false: 셀룰러 데이터 비활성화

device.network.wifi

boolean

디바이스의 와이파이 활성화 여부.

true: 와이파이 활성화
false: 와이파이 비활성화

app

필수object

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

app.packageName

필수string

구글 플레이 스토어에 등록된 앱 패키지 이름. (Android 한정)

app.version

string

앱 사용자가 사용하고 있는 앱의 버전.

eventData

필수object

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

eventData.goal

필수object

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

eventData.goal.category

필수string

에어브릿지 이벤트 카테고리.

eventData.goal.action

string

이벤트 액션.

eventData.goal.label

string

이벤트 라벨.

eventData.goal.value

number

이벤트 값.

eventData.goal.semanticAttributes

object

에어브릿지가 수집할 데이터를 미리 정의한 속성입니다.

eventData.goal.semanticAttributes.productListID

string

상품 리스트 ID.

eventData.goal.semanticAttributes.cartID

string

장바구니 ID.

eventData.goal.semanticAttributes.transactionID

string

거래 ID.

eventData.goal.semanticAttributes.inAppPurchased

boolean

인앱 구매 여부.

true: 인앱 구매
false: 인앱 구매 아님

eventData.goal.semanticAttributes.products

object[]

상품에 대한 정보를 리스트로 담을 수 있습니다.

eventData.goal.semanticAttributes.products.[0].position

number

상품 위치.

eventData.goal.semanticAttributes.products.[0].productID

string

상품 ID.

eventData.goal.semanticAttributes.products.[0].name

string

상품 이름.

eventData.goal.semanticAttributes.products.[0].price

number

상품 가격.

eventData.goal.semanticAttributes.products.[0].quantity

string

상품 수량.

eventData.goal.semanticAttributes.products.[0].currency

string

화폐 단위.

eventData.goal.customAttributes

object

커스텀 이벤트 속성.

`{ "color": "red" }`

Request

123456
curl -X POST 'https://api.airbridge.io/events/v1/apps/{app_name}/mobile-app/9360' \
  -H 'Aceept-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","eventTimestamp":1479186394000,"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","ifv":"37EEC3E0-BF15-412E-ADBA-7D2E82E7A75F","limitAdTracking":"true","deviceModel":"LG-H542","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":"add-to-cart","action":"shoes","label":"nike","value":890000,"semanticAttributes":{"productListID":"list-id-1","cartID":"card-id-1","transactionID":"12939172","inAppPurchased":true,"products":[{"position":1,"productID":"30372425","name":"custom","price":1000,"quantity":"1","currency":"KRW"}]}}}}'

Payload

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
{
  "eventUUID": "9b4b3e4e-2162-4ae6-8986-91ee84644262",
  "eventTimestamp": 1479186394000,
  "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",
    "ifv": "37EEC3E0-BF15-412E-ADBA-7D2E82E7A75F",
    "limitAdTracking": "true",
    "deviceModel": "LG-H542",
    "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": "add-to-cart",
      "action": "shoes",
      "label": "nike",
      "value": 890000,
      "semanticAttributes": {
        "productListID": "list-id-1",
        "cartID": "card-id-1",
        "transactionID": "12939172",
        "inAppPurchased": true,
        "products": [
          {
            "position": 1,
            "productID": "30372425",
            "name": "custom",
            "price": 1000,
            "quantity": "1",
            "currency": "KRW"
          }
        ]
      }
    }
  }
}

Response

200 SUCCESS

Response

1234
{
  "at": "2020-02-06 16:06:49",
  "data": "Event(9360) is successfully proccessed."
}

이 페이지가 도움이 되었나요?

추가, 수정하면 좋을 내용이 있나요?

Server To Server Eventself.__wrap_n!=1&&self.__wrap_b(":R29lllb7ammda:",0.5)

인웹 이벤트 전송하기

전송 방식

1. Cookie ID(browser.clientID)를 기준으로 한 이벤트 전송.

2. User ID(user.externalUserId)를 기준으로 한 이벤트 전송.

Request

Headers

Path Params

Body Params

Response

200 SUCCESS

인앱 이벤트 전송하기

전송 방식

Request

Headers

Path Params

Body Params

Response

200 SUCCESS

Server To Server Event

1. Cookie ID(`browser.clientID`)를 기준으로 한 이벤트 전송.

2. User ID(`user.externalUserId`)를 기준으로 한 이벤트 전송.