본문으로 건너뛰기

광고 이벤트

광고 이벤트는 네이티브 SDK의 FlowerAdsManagerListener 인터페이스를 대체합니다. 리스너 객체를 구현하는 대신 AdEvent 값의 스트림을 구독합니다.

모든 이벤트는 자신이 속한 <Video>의 nativeId를 함께 전달하므로, 여러 플레이어를 구분할 수 있습니다.

구독​

addAdEventListener​

function addAdEventListener(listener: (event: AdEvent) => void): EmitterSubscription;

모든 세션의 광고 이벤트를 구독합니다. event.nativeId로 구분하세요.

addAdEventListenerFor​

function addAdEventListenerFor(
  nativeId: string,
  listener: (event: AdEvent) => void,
): EmitterSubscription;

하나의 세션의 광고 이벤트만 구독합니다. 다른 nativeId의 이벤트는 필터링됩니다.

두 함수 모두 구독 객체를 반환합니다. 컴포넌트가 unmount될 때 remove()를 호출하세요:

useEffect(() => {
  const subscription = addAdEventListenerFor(nativeId, event => {
    // …
  });
  return () => subscription.remove();
}, [nativeId]);
주의

이벤트 구독은 release와 독립적입니다. 세션을 release해도 앱이 직접 추가한 리스너는 제거되지 않습니다.

AdEvent​

AdEvent는 event 필드를 기준으로 하는 discriminated union이므로, 이 필드로 좁히면 해당 payload 필드에 접근할 수 있습니다:

export type AdEvent = {nativeId: string} & (
  | {event: 'adBreakPrepare'; adCount: number}
  | {event: 'prepare'; adDurationMs: number}
  | {event: 'play'}
  | {event: 'adPlay'; adId: string; durationMs: number}
  | {event: 'completed'}
  | {event: 'error'; message: string | null}
  | {event: 'adUserAction'; action: string; adId: string}
  | {event: 'adBreakSkipped'; reason: number}
);
addAdEventListenerFor(nativeId, event => {
  switch (event.event) {
    case 'prepare':
      console.log(`break ready, ${event.adDurationMs}ms`); // adDurationMs 접근 가능
      break;
    case 'adPlay':
      console.log(`ad ${event.adId} started`); // adId 접근 가능
      break;
  }
});

이벤트​

adBreakPrepare​

전면 광고 또는 VOD 광고의 광고 매니페스트가 로드되었을 때 발생합니다.

필드타입설명
nativeIdstring이벤트가 속한 세션
adCountnumber해당 브레이크에 로드된 광고 개수

prepare​

전면 광고 또는 VOD 광고의 브레이크가 로드되었을 때 발생합니다. 앱은 이 시점에 콘텐츠를 일시정지하고 play를 호출합니다.

필드타입설명
nativeIdstring이벤트가 속한 세션
adDurationMsnumber광고 브레이크 전체 길이(밀리초)

play​

광고 재생이 시작되었을 때 발생합니다.

필드타입설명
nativeIdstring이벤트가 속한 세션

adPlay​

개별 광고 단위의 재생이 시작될 때마다 발생합니다.

필드타입설명
nativeIdstring이벤트가 속한 세션
adIdstringVAST 응답에 명시된 광고 ID. 응답에 없으면 빈 문자열
durationMsnumber해당 광고의 길이(밀리초)

completed​

광고 재생이 종료되었을 때 발생합니다. VOD와 인라인 브레이크에서는 앱이 이 시점에 콘텐츠를 재개합니다.

필드타입설명
nativeIdstring이벤트가 속한 세션

error​

Flower SDK에서 오류가 발생했을 때 발생합니다.

필드타입설명
nativeIdstring이벤트가 속한 세션
messagestring | nullSDK가 제공한 오류 메시지
주의

VOD 또는 인라인 브레이크 도중 error가 발생하면, 콘텐츠를 일시정지한 주체가 앱이므로 콘텐츠는 멈춘 상태로 남습니다. completed뿐 아니라 이 분기에서도 콘텐츠를 재개하지 않으면 시청자가 멈춘 화면에 남게 됩니다.

adUserAction​

사용자가 광고와 상호작용했을 때 발생합니다.

필드타입설명
nativeIdstring이벤트가 속한 세션
actionstring사용자 동작 유형
learn_more: 자세히 보기 / 클릭 영역을 클릭
skip: 건너뛰기 버튼을 누름
adIdstring해당 동작이 수행된 광고 ID

adBreakSkipped​

광고 브레이크가 건너뛰어졌을 때 발생합니다.

필드타입설명
nativeIdstring이벤트가 속한 세션
reasonnumber건너뛴 사유 코드
0: Unknown
1: No Ad
2: Timeout
3: Error

관련 API​