주요 콘텐츠로 건너뛰기

게임 내 팝업 웹후크

Aghanim LiveOps Builder를 사용하면 개발자는 플레이어의 행동이나 Aghanim이 생성한 게임 허브에서의 상호작용에 대응하여 인게임 팝업을 트리거할 수 있습니다. 캠페인에서 설정한 조건이 충족되면 Aghanim은 캠페인에 지정된 팝업 콘텐츠를 게임에 전송하는 웹후크를 발송합니다.

이 웹후크를 수신한 후, 게임은 플레이어에게 게임 내 팝업을 보여주어야 합니다. 팝업의 프론트엔드 디자인과 개발은 게임의 시각적 및 상호작용 지침에 맞춰져야 합니다.

요구 사항

Aghanim의 게임 내 팝업 웹훅을 사용하려면 웹훅 서버를 다음과 같이 구성해야 합니다:

  • POST 웹후크 요청을 수락하는 HTTPS 엔드포인트.
  • Aghanim이 생성하고 서명한 이벤트를 수신합니다.
  • 수신된 콘텐츠를 사용하여 게임 디자인 기준에 따라 게임 내 팝업을 표시합니다.
  • 웹훅을 성공적으로 수신하고 처리한 경우에는 2xx 상태 코드를 응답하며, 거부 또는 오류가 발생한 경우에는 4xx 또는 5xx를 응답합니다.

구성

  1. ingame.popup 웹훅 처리를 위한 함수를 개발합니다.
  2. 엔드포인트를 사용 가능하게 설정하세요.
  3. Aghanim 계정 내에서 엔드포인트를 등록하려면 게임웹훅새 웹훅을(를) 선택하고 게임 내 팝업 이벤트 유형을 선택합니다.
  4. 게임 내 팝업 웹훅을 트리거하는 liveops 캠페인을 구성합니다.

게임 내 팝업을 위한 캠페인 구성 가이드

대안으로, 웹후크 생성 API 방법을 사용하여 Aghanim 내에서 엔드포인트를 등록할 수 있습니다.

요청 스키마

아래는 예시입니다 ingame.popup 웹훅 요청:

POST /your/webhook/uri HTTP/1.1
Content-Type: application/json
Host: your-webhook-endpoint.com
User-Agent: Aghanim/0.1.0
X-Aghanim-Signature: 2e45ed4dede5e09506717490655d2f78e96d4261040ef48cc623a780bda38812
X-Aghanim-Signature-Timestamp: 1725548450

{
"event_type": "ingame.popup",
"event_data": {
"player_id": "2D2R-OP3C",
"title": "Hello!",
"body": "How are you today? Claim your reward now!",
"icon": null,
"url": null
},
"event_time": 1725548450,
"event_id": "whevt_eCacGbJVbvToOgzjXUgOCitkQE",
"idempotency_key": null,
"request_id": "d1593e9c-c291-4004-8846-6679c2e5810b",
"sandbox": false,
"trigger": "liveops.execute_action",
"transaction_id": "whtx_eCacGbJVbvT",
"context": null,
"game_id": "gm_exTAyxPsVwh"
}

이벤트 스키마

Key유형설명
event_idstringAghanim에 의해 생성된 고유 이벤트 ID.
game_idstringAghanim 시스템에서의 귀하의 게임 ID.
event_typestring이벤트의 유형, ingame.popup 이럴 경우.
event_timenumber유닉스 에포크 시간으로 된 이벤트 날짜.
event_dataEventData이벤트 특정 데이터가 포함되어 있으며, 상속된 객체에 대한 가능한 키가 포함됩니다.
idempotency_keystring|null웹훅 작업이 재시도되어도 한 번만 실행되도록 보장합니다. 일 수 있습니다 null 이벤트 유형에 따라 달라집니다.
request_idstring|null이벤트가 API 요청에 의해 트리거된 경우, 요청 ID가 포함됩니다.
sandboxboolean이 이벤트가 샌드박스 게임 환경에서 전송되었는지를 표시합니다.
triggerstring|nullThe trigger that caused the event to be sent.
transaction_idstringAghanim이 생성한 거래 ID입니다. 이 ID는 동일한 거래 내에서 발생한 여러 이벤트에서 동일할 수 있습니다.
contextEventContext|null이벤트에 대한 컨텍스트 정보.

EventContext 스키마

Key유형설명
orderOrderContext|null해당되는 경우 이벤트와 관련된 주문 정보입니다.
playerPlayerContext|null플레이어 정보를 추가하려면 웹훅 설정에서 "플레이어 컨텍스트 추가"를 활성화하세요.

EventData 스키마

Key유형설명
player_idstring팝업을 표시할 고유한 플레이어 인증을 위해 선택된 플레이어 ID입니다.
titlestring팝업 제목입니다.
bodystring팝업 본문입니다.
icon`string\null`
url`string\null`

도움이 필요하세요?
통합팀에 문의하십시오 integration@aghanim.com