PC 게임 이벤트 전송 개발하기

PC 게임 캠페인 운영 과정에서 PC 게임에서 발생한 이벤트를 에어브릿지 서버로 전송해야 합니다. 아래 가이드를 함께 참고하세요.

인앱 이벤트 전송하기 API 가이드

아래는 에어브릿지로 전송해야 하는 PC 게임 이벤트 종류입니다.

이벤트 종류	설명	엔드포인트 번호
PC 게임 설치 이벤트	유저가 게임을 최초로 실행할 때 전송	9161
PC게임 실행 이벤트	유저가 최초 실행 후 재실행할 때 전송	9160
PC 인게임 이벤트	성과를 측정할 이벤트를 선택해 전송	9360

PC 게임 설치 이벤트

주의하세요

유저가 게임을 최초로 실행했을 때 PC 게임 설치 이벤트를 전송하세요. 이후에 유저가 게임을 재실행했을 때부터는 PC 게임 실행 이벤트로 전송하세요.
반드시 PC 게임 설치 이벤트가 누락되지 않도록 하세요. 이 이벤트가 없으면 에어브릿지에서 성과를 측정할 수 없습니다.

아래 항목을 참고해 개발 작업을 완료하세요.

예시 코드) PC 게임 설치 이벤트

curl --location 'https://api.airbridge.io/events/v1/apps/{{ APP_NAME }}/mobile-app/9161' \
--header 'Authorization: AIRBRIDGE-API-TOKEN {{ API_TOKEN }}' \
--header 'Content-Type: application/json' \
--header 'X-Forwarded-For: {{ DEVICE_CLIENT_IP }}' \
--data '{
    "user": {
        "externalUserID": "abrid123"
    },
    "device": {
        "platform": "steam",
        "deviceType": "desktop",
        "osName": "Windows",
        "osVersion": "11",
        "deviceModel": "pc",
        "screen": {
            "width": 1920,
            "height": 1080
        }
    }
}'

항목	세부 항목	예시
엔드포인트 URL	-	`https://api.airbridge.io/events/v1/apps/{{APP_NAME}}/mobile-app/9161`
헤더	Authorization	Bearer `{{API_TOKEN}}`
헤더	Content-Type	application/json
헤더	X-Forwarded-For	`{{DEVICE_CLIENT_IP}}`
바디	-	{ “user”: { “externalUserID”: “abrid123” }, “device”: { “platform”: “steam”, “deviceType”: “desktop”, “osName”: “Windows”, “osVersion”: “11”, “deviceModel”: “pc”, “screen”: { “width”: 1920, “height”: 1080 } }

엔드포인트 URL

아래 엔드포인트로 PC 게임 설치 이벤트를 전송하세요. 엔드포인트 끝번호는 9161입니다.

https://api.airbridge.io/events/v1/apps/{{APP_NAME}}/mobile-app/9161

주의하세요PC 게임 설치, PC 게임 실행, PC 인게임 이벤트별로 이벤트를 전송하는 엔드포인트가 다릅니다. 엔드포인트 끝번호를 확인한 후에 전송하세요.

헤더

아래 표를 참고해 헤더를 설정하세요.

이름	중요도	설명
Authorization	필수	API 토큰을 입력하세요. 에어브릿지 대시보드 [설정]>[토큰 관리]에서 확인할 수 있습니다.
X-Forwarded-For	필수	PC 게임 이벤트가 발생한 클라이언트 IP, 즉 유저의 로그가 기록된 IP를 X-Forwarded-For 헤더로 전달하세요. 클라이언트 IP를 전달하지 않으면 서버 IP가 기록되어 성과를 측정할 수 없습니다.
Accept-Language	권장	API 요청과 응답에 사용할 언어를 지정하세요. ISO-639-1 기준입니다.
Content-Type	권장	리소스의 미디어 타입을 지정하세요. 기본값은 application/json입니다.

주의하세요

X-Forwarded-For 헤더로 PC 게임 이벤트가 발생한 클라이언트 IP를 전달하세요. 그렇지 않으면 전송되는 이벤트에 서버 IP가 기록되어 에어브릿지에서 성과를 측정할 수 없게 됩니다.
Authorization에 입력하는 API 토큰은 에어브릿지 대시보드 [설정]>[토큰 관리]에서 확인하세요.

바디

아래 표를 참고해 바디를 설정하세요.

이름	중요도	설명
user.externalUserID	필수	PC 게임에서 유저 식별에 사용하는 ID를 전송하세요. 해당 ID를 기준으로 어트리뷰션이 진행됩니다.
device	필수	PC 게임에서 수집한 이벤트의 디바이스 정보를 전송하세요. 마케터로부터 전달받은 디바이스 정보가 있다면 발생한 이벤트별로 해당 정보를 입력하세요.

PC 게임 실행 이벤트

주의하세요

유저의 최초 게임 실행인 PC 게임 설치 이벤트를 전송한 이후에 발생하는 유저의 재실행부터는 PC 게임 실행 이벤트로 전송하세요. 즉, 유저의 최초 실행은 설치 이벤트로, 그 후부터 발생하는 실행은 실행 이벤트로 각각 전송하세요. 이때 실행 이벤트는 필요한 시점마다 전송해도 되니 전송 시점은 마케터에게 전달받으세요.
가장 먼저 전송한 이벤트로 PC 게임 설치 이벤트가 잘 전송됐는지 확인하세요. 이 이벤트가 없으면 에어브릿지에서 성과를 측정할 수 없습니다.

아래 항목을 참고해 개발 작업을 완료하세요.

예시 코드) PC 게임 실행 이벤트

curl --location 'https://api.airbridge.io/events/v1/apps/{{ APP_NAME }}/mobile-app/9160' \
--header 'Authorization: AIRBRIDGE-API-TOKEN {{ API_TOKEN }}' \
--header 'Content-Type: application/json' \
--header 'X-Forwarded-For: {{ DEVICE_CLIENT_IP }}' \
--data '{
    "user": {
        "externalUserID": "abrid123"
    },
    "device": {
        "platform": "playstation",
        "deviceType": "console",
        "osName": "playstation_5",
        "screen": {
            "width": 1920,
            "height": 1080
        }
    }
}'

항목	세부 항목	예시
엔드포인트 URL	-	`https://api.airbridge.io/events/v1/apps/{{APP_NAME}}/mobile-app/9160`
헤더	Authorization	Bearer `{{API_TOKEN}}`
헤더	X-Forwarded-For	`{{DEVICE_CLIENT_IP}}`
헤더	Content-Type	application/json
바디	-	{ “user”: { “externalUserID”: “abrid123” }, “device”: { “platform”: “playstation”, “deviceType”: “console”, “osName”: “playstation_5”, “screen”: { “width”: 1920, “height”: 1080 } }

엔드포인트 URL

아래 엔드포인트로 PC 게임 실행 이벤트를 전송하세요. 엔드포인트 끝번호는 9160입니다.

https://api.airbridge.io/events/v1/apps/{{APP_NAME}}/mobile-app/9160

헤더

아래 표를 참고해 헤더를 설정하세요.

이름	중요도	설명
Authorization	필수	API 토큰을 입력하세요. 에어브릿지 대시보드 [설정]>[토큰 관리]에서 확인할 수 있습니다.
X-Forwarded-For	필수	PC 게임 이벤트가 발생한 클라이언트 IP, 즉 유저의 로그가 기록된 IP를 X-Forwarded-For 헤더로 전달하세요. 클라이언트 IP를 전달하지 않으면 서버 IP가 기록되어 성과를 측정할 수 없습니다.
Accept-Language	권장	API 요청과 응답에 사용할 언어를 지정하세요. ISO-639-1 기준입니다.
Content-Type	권장	리소스의 미디어 타입을 지정하세요. 기본값은 application/json입니다.

주의하세요

X-Forwarded-For 헤더로 PC 게임 이벤트가 발생한 클라이언트 IP를 전달하세요. 그렇지 않으면 전송되는 이벤트에 서버 IP가 기록되어 에어브릿지에서 성과를 측정할 수 없게 됩니다.
Authorization에 입력하는 API 토큰은 에어브릿지 대시보드 [설정]>[토큰 관리]에서 확인하세요.

바디

아래 표를 참고해 바디를 설정하세요.

이름	중요도	설명
user.externalUserID	필수	PC 게임에서 유저 식별에 사용하는 ID를 전송하세요. 해당 ID를 기준으로 어트리뷰션이 진행됩니다.
device	필수	PC 게임에서 수집한 이벤트의 디바이스 정보를 전송하세요. 마케터로부터 전달받은 디바이스 정보가 있다면 발생한 이벤트별로 해당 정보를 입력하세요.

PC 인게임 이벤트(설치·실행 이벤트 제외)

알립니다PC 게임 설치 및 실행 이벤트 외에도 성과를 측정할 PC 인게임 이벤트를 전송하세요. 성과를 측정할 이벤트 목록은 마케터에게 전달받으세요.

아래 항목을 참고해 개발 작업을 완료하세요.

예시 코드) 스탠다드 이벤트 - 구매 완료 이벤트

알립니다전송하려는 스탠다드 이벤트의 Standard Event Category 값을 eventData.goal.category에 입력하세요.

예를 들어 에어브릿지로 구매 완료 이벤트를 전송하려면 아래처럼 입력해야 합니다.

eventData.goal.category: airbridge.ecommerce.order.completed
eventData.goal.value: 구매 완료 이벤트로 발생한 매출액

curl --location 'https://api.airbridge.io/events/v1/apps/{{ APP_NAME }}/mobile-app/9360' \
--header 'Authorization: AIRBRIDGE-API-TOKEN {{ API_TOKEN }}' \
--header 'Content-Type: application/json' \
--header 'X-Forwarded-For: {{ DEVICE_CLIENT_IP }}' \
--data '{
    "user": {
        "externalUserID": "abrid123"
    },
    "device": {
        "platform": "Android",
        "deviceType": "desktop",
        "osName": "Android",
        "osVersion": "7",
        "deviceModel": "pc",
        "screen": {
            "width": 1920,
            "height": 1080
        }
    },
    "eventData": {
        "goal": {
            "category": "airbridge.ecommerce.order.completed",
            "value": 1.234,
            "semanticAttributes": {
                "currency": "USD"
            }
        }
    }
}'

항목	세부 항목	예시
엔드포인트 URL	-	`https://api.airbridge.io/events/v1/apps/{{APP_NAME}}/mobile-app/9360`
헤더	Authorization	Bearer `{{API_TOKEN}}`
헤더	X-Forwarded-For	`{{DEVICE_CLIENT_IP}}`
헤더	Content-Type	application/json
바디	-	{ “user”: { “externalUserID”: “abrid123” }, “device”: { “platform”: “Android”, “deviceType”: “desktop”, “osName”: “Android”, “osVersion”: “7”, “deviceModel”: “pc”, “screen”: { “width”: 1920, “height”: 1080 } }, “eventData”: { “goal”: { “category”: “airbridge.ecommerce.order.completed”, “value”: 1.234, “semanticAttributes”: { “currency”: “USD” } } } }

예시 코드) 커스텀 이벤트 - 아이템 구매 이벤트

에어브릿지로 아이템 구매 이벤트를 전송하려면 아래처럼 입력해야 합니다.

eventData.goal.category: buy_item
eventData.goal.action, eventData.goal.label: 유저가 구매한 아이템 이름
eventData.goal.value: 유저가 구매한 아이템 가격
eventData.goal.customAttributes: 유저가 구매한 아이템 기타 정보

curl --location 'https://api.airbridge.io/events/v1/apps/{{ APP_NAME }}/mobile-app/9360' \
--header 'Authorization: AIRBRIDGE-API-TOKEN {{ API_TOKEN }}' \
--header 'Content-Type: application/json' \
--header 'X-Forwarded-For: {{ DEVICE_CLIENT_IP }}' \
--data '{
    "user": {
        "externalUserID": "abrid123"
    },
    "device": {
        "platform": "iOS",
        "deviceType": "desktop",
        "osName": "iOS",
        "osVersion": "17.1",
        "deviceModel": "Mac",
        "screen": {
            "width": 1920,
            "height": 1080
        }
    },
    "eventData": {
        "goal": {
            "category": "buy_item",
            "action": "weapon",
            "label": "longsword",
            "value": 1.234,
            "customAttributes": {
                "foo": "foo",
                "bar": 1.234
            }
        }
    }
}'

항목	세부 항목	예시
엔드포인트 URL	-	`https://api.airbridge.io/events/v1/apps/{{APP_NAME}}/mobile-app/9360`
헤더	Authorization	Bearer `{{API_TOKEN}}`
헤더	X-Forwarded-For	`{{DEVICE_CLIENT_IP}}`
헤더	Content-Type	application/json
바디	-	{ “user”: { “externalUserID”: “abrid123” }, “device”: { “platform”: “iOS”, “deviceType”: “desktop”, “osName”: “iOS”, “osVersion”: “17.1”, “deviceModel”: “Mac”, “screen”: { “width”: 1920, “height”: 1080 } }, “eventData”: { “goal”: { “category”: “buy_item”, “action”: “weapon”, “label”: “longsword" "value”: 1.234 ”customAttributes”: { “foo”: “foo”, “bar”: 1.234 } } } }

엔드포인트 URL

아래 엔드포인트로 PC 인게임 이벤트를 전송하세요. 엔드포인트 끝번호는 9360입니다.

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

헤더

아래 표를 참고해 헤더를 설정하세요.

이름	중요도	설명
Authorization	필수	API 토큰을 입력하세요. 에어브릿지 대시보드 [설정]>[토큰 관리]에서 확인할 수 있습니다.
X-Forwarded-For	필수	PC 게임 이벤트가 발생한 클라이언트 IP, 즉 유저의 로그가 기록된 IP를 X-Forwarded-For 헤더로 전달하세요. 클라이언트 IP를 전달하지 않으면 서버 IP가 기록되어 성과를 측정할 수 없습니다.
Accept-Language	권장	API 요청과 응답에 사용할 언어를 지정하세요. ISO-639-1 기준입니다.
Content-Type	권장	리소스의 미디어 타입을 지정하세요. 기본값은 application/json입니다.

주의하세요

X-Forwarded-For 헤더로 PC 게임 이벤트가 발생한 클라이언트 IP를 전달하세요. 그렇지 않으면 전송되는 이벤트에 서버 IP가 기록되어 에어브릿지에서 성과를 측정할 수 없게 됩니다.
Authorization에 입력하는 API 토큰은 에어브릿지 대시보드 [설정]>[토큰 관리]에서 확인하세요.

바디

아래 표를 참고해 바디를 설정하세요.

이름	중요도	설명
user.externalUserID	필수	PC 게임에서 유저 식별에 사용하는 ID를 전송하세요. 해당 ID를 기준으로 어트리뷰션이 진행됩니다.
eventData.goal	필수	PC 게임에서 수집한 이벤트의 세부 정보를 전송하세요. 마케터로부터 전달받은 이벤트 세부 정보가 있다면 발생한 이벤트별로 해당 정보를 입력하세요. - eventData.goal.`category`: 해당 이벤트 이름 - eventData.goal.`action`, eventData.goal.`label`, eventData.goal.`customAttributes`: 문자열로 나타낼 수 있는 세부 정보(예: 레벨 숫자, 아이템 이름 등) - eventData.goal.`value`: 숫자로 나타낼 수 있는 세부 정보(예: 매출 등)
device	필수	PC 게임에서 수집한 이벤트의 디바이스 정보를 전송하세요. 마케터로부터 전달받은 디바이스 정보가 있다면 발생한 이벤트별로 해당 정보를 입력하세요.

​PC 게임 설치 이벤트

​PC 게임 실행 이벤트

​PC 인게임 이벤트(설치·실행 이벤트 제외)

PC 게임 설치 이벤트

PC 게임 실행 이벤트

PC 인게임 이벤트(설치·실행 이벤트 제외)