Google IMA DAI SDK API

    1. google.ima.dai.api.Ad
    2. google.ima.dai.api.AdPodInfo
    3. google.ima.dai.api.AdProgressData
    4. google.ima.dai.api.CompanionAd
    5. google.ima.dai.api.CuePoint
    6. google.ima.dai.api.LiveStreamRequest
    7. google.ima.dai.api.StreamData
    8. google.ima.dai.api.StreamEvent
    9. google.ima.dai.api.StreamEvent.Type
    10. google.ima.dai.api.StreamManager
    11. google.ima.dai.api.StreamRequest
    12. google.ima.dai.api.VODStreamRequest
    13. google.ima.VERSION

google.ima.dai.api.Ad 클래스

메서드

동적 광고 삽입 중에 광고 객체를 나타내는 클래스입니다. 이 클래스는 ima.Ad 속성의 하위 집합을 노출합니다.

getAdId()


반환하는 string:

getAdPodInfo()


반환하는 google.ima.dai.api.AdPodInfo:

getAdSystem()


반환하는 string:

getAdvertiserName()


반환하는 string:

getApiFramework()


반환하는 string:

getCompanionAds()


반환하는 Array.<google.ima.dai.api.CompanionAd>:

getCreativeAdId()


반환하는 string:

getCreativeId()


반환하는 string:

getDealId()


반환하는 string:

getDescription()


반환하는 string:

getDuration()


반환하는 number:

getTitle()


반환하는 string:

getVastMediaHeight()


반환하는 number:

getVastMediaWidth()


반환하는 number:

getWrapperAdIds()


반환하는 Array.<string>:

getWrapperAdSystems()


반환하는 Array.<string>:

getWrapperCreativeIds()


반환하는 Array.<string>:

google.ima.dai.api.AdPodInfo 클래스

메서드

동적 광고 삽입 시 광고 모음 정보 객체를 나타내는 클래스입니다. 이 클래스는 ima.AdPodInfo 속성의 하위 집합을 노출합니다.

getAdPosition()


반환하는 number:

getMaxDuration()


반환하는 number:

getPodIndex()


반환하는 number:

getTimeOffset()


반환하는 number:

getTotalAds()


반환하는 number:

google.ima.dai.api.AdProgressData 클래스

필드

광고 진행률 데이터를 지정하기 위한 클래스입니다.

속성

이름 유형 설명
adBreakDuration

adPosition

currentTime

duration

totalAds

클래스 google.ima.dai.api.CompanionAd

메서드

동적 광고 삽입 시 컴패니언 광고 객체를 나타내는 클래스입니다. 이 클래스는 ima.CompanionAd 속성의 하위 집합을 노출합니다.

getAdSlotId()


반환하는 string:

getContent()


반환하는 string:

getContentType()


반환하는 string:

getHeight()


반환하는 number:

getWidth()


반환하는 number:

google.ima.dai.api.CuePoint 클래스

필드

DAI VOD 스트림의 광고 시점을 나타내는 큐 시점의 속성을 지정하는 클래스입니다.

속성

이름 유형 설명
end

이 큐 포인트의 종료 시간입니다.
played

이 큐 시점이 재생되었는지 여부
start

이 큐 포인트의 시작 시간입니다.

google.ima.dai.api.LiveStreamRequest 클래스

필드

실시간 스트림 요청의 속성을 지정하기 위한 클래스입니다.

생성자:
매개변수 유형 설명
opt_liveStreamRequest Object

객체에 이미 할당된 스트림 요청 속성이 있습니다.

속성

이름 유형 설명
assetKey

재생할 스트림을 결정하는 데 사용됩니다. 실시간 스트림 요청 애셋 키는 API UI에서 확인할 수 있는 식별자입니다.

google.ima.dai.api.StreamData 클래스

필드

스트림 데이터를 지정하기 위한 클래스.

속성

이름 유형 설명
adProgressData

현재 재생 중인 광고의 타이밍 관련 정보입니다.
cuepoints

주문형 스트림의 광고 큐 시점입니다. 이는 스트림이 진행됨에 따라 변경될 수 있습니다. CUEPOINTS_CHANGED AdEvent의 이벤트 리스너에만 채워집니다.
errorMessage

streamId

subtitles

url

google.ima.dai.api.StreamEvent 클래스

메서드

이 이벤트 유형은 스트림 상태가 변경되면 스트림 관리자에 의해 알림으로 발생합니다.

getAd()


반환하는 google.ima.dai.api.Ad: 광고 정보와 함께 객체를 반환합니다.

getStreamData()


반환하는 google.ima.dai.api.StreamData: 스트림 정보와 함께 객체를 반환합니다.

enum google.ima.dai.api.StreamEvent.Type

필드

IMA SDK에서 지원하는 이벤트 유형의 목록입니다.

값

값 설명
AD_BREAK_ENDED

광고 시간이 끝나면 실행됩니다.
AD_BREAK_STARTED

광고 시간이 시작되면 실행됩니다.
AD_PROGRESS

광고 진행 상황이 업데이트되면 실행됩니다.
CLICK

광고가 재생되는 동안 클릭 요소를 클릭하거나 탭하면 전달됩니다.
COMPLETE

광고가 완료되면 시작됩니다.
CUEPOINTS_CHANGED

큐 시점이 변경되면 주문형 스트림에 전달됩니다.
ERROR

오류가 발생하면 실행됩니다.
FIRST_QUARTILE

광고가 1분위에 도달하면 시작됩니다.
LOADED

스트림 매니페스트를 사용할 수 있으면 실행됩니다.
MIDPOINT

광고가 중간 지점에 도달하면 시작됩니다.
STARTED

광고가 시작되면 실행됩니다.
STREAM_INITIALIZED

스트림이 초기화되면 실행됩니다.
THIRD_QUARTILE

광고가 3분위에 도달하면 시작됩니다.

google.ima.dai.api.StreamManager 클래스

메서드

동적 광고 삽입 스트림을 처리합니다. DAI 백엔드와의 상호작용을 관리하고 핑 추적은 물론 스트림과 광고 이벤트를 게시자에게 전달하는 작업을 처리합니다. 이 관리자는 특정 광고의 관리자가 아니라 전체 스트림의 관리자이기 때문에 BaseAD에서 상속되지 않습니다.

생성자:
매개변수 유형 설명
videoElement HTMLVideoElement

실제 동영상 플레이어 요소입니다.

contentTimeForStreamTime(streamTime)

지정된 스트리밍 시간에 광고가 없는 콘텐츠 시간을 반환합니다. 실시간 스트림에 지정된 스트림 시간을 반환합니다.

반환하는 number: 광고가 삭제된 후 지정된 스트림 시간에 해당하는 콘텐츠 시간

매개변수 유형 설명
streamTime number

삽입된 광고가 있는 스트리밍 시간 (초)입니다.

onTimedMetadata(metadata)

처리된 메타데이터 사전을 전달합니다. 사전에는 사용자 정의 메타데이터 문자열이 값으로 포함된 'TXXX' 키가 필요합니다. 플레이어가 원시 메타데이터를 제공하는 경우 대신 ima.dai.api.StreamManager.processMetadata를 호출하세요.

매개변수 유형 설명
metadata Object

메타데이터 사전입니다.

previousCuePointForStreamTime(streamTime)

지정된 스트리밍 시간의 이전 큐 시점을 반환합니다. 이러한 큐 포인트가 없으면 null을 반환합니다. 스냅백과 같은 기능을 구현하는 데 사용되며 게시자가 사용자가 사용자를 광고 시점으로 되돌리기 위해 탐색했음을 감지할 때 호출됩니다.

반환하는 google.ima.dai.api.CuePoint: 지정된 스트리밍 시간의 이전 큐 시점

매개변수 유형 설명
streamTime number

찾으려는 스트림 시간.

processMetadata(type, data, timestamp)

실시간 스트림의 시간 지정 메타데이터를 처리합니다. 동영상 플레이어에서 타임스탬프와 함께 파싱되지 않은 메타데이터를 제공하는 경우 사용하고, 그렇지 않으면 ima.dai.api.StreamManager.onTimedMetadata를 호출합니다.

매개변수 유형 설명
type string

메타데이터의 유형입니다. 'ID3'이어야 합니다.
data Uint8Array

원시 태그 데이터입니다. ID3의 경우 전체 태그여야 합니다.
timestamp number

데이터를 처리해야 하는 시간입니다.

requestStream(streamRequest)

제공된 스트림 매개변수를 사용하여 스트림이 로드되도록 요청합니다.

매개변수 유형 설명
streamRequest google.ima.dai.api.StreamRequest

스트림 메타데이터를 로드하는 매개변수가 포함됩니다.

setClickElement(clickElement)

광고 클릭연결 요소를 설정합니다. 이 요소는 광고가 재생되는 동안 클릭 또는 탭 수신기로 사용되며, 결과적으로는 현재 페이지에서 벗어날 수 있습니다.

매개변수 유형 설명
clickElement Element

광고를 클릭연결하는 데 사용되는 요소입니다.

streamTimeForContentTime(contentTime)

지정된 콘텐츠 시간의 광고가 있는 스트리밍 시간을 반환합니다. 실시간 스트림의 지정된 콘텐츠 시간을 반환합니다.

반환하는 number: 광고가 삽입된 후 지정된 콘텐츠 시간에 해당하는 스트림 시간

매개변수 유형 설명
contentTime number

광고가 없는 콘텐츠 시간 (초)을 표시합니다.

google.ima.dai.api.StreamRequest 클래스

필드

스트림 요청의 속성을 지정하기 위한 클래스입니다.

속성

이름 유형 설명
adTagParameters

스트림 요청에서 제한된 광고 태그 매개변수 집합을 재정의할 수 있습니다. 자세한 내용은 타겟팅 매개변수를 스트림에 공급하세요. 스트림 변형 환경설정에 dai-ot 및 dai-ov 매개변수를 사용할 수 있습니다. 자세한 내용은 스트림 변형 매개변수 재정의를 참고하세요.
apiKey

스트림 요청 API 키입니다. 이는 DFP 관리 UI를 통해 구성되며 콘텐츠를 잠금 해제할 수 있도록 게시자에게 제공됩니다. 콘텐츠에 액세스하려는 애플리케이션을 확인합니다.
streamActivityMonitorId

스트림 활동 모니터로 스트림을 디버그하는 데 사용되는 ID입니다. 이렇게 하면 게시자가 스트림 활동 모니터링 도구에서 스트림 로그를 편리하게 찾을 수 있습니다.

google.ima.dai.api.VODStreamRequest 클래스

필드

VOD 스트림 요청의 속성을 지정하기 위한 클래스입니다.

생성자:
매개변수 유형 설명
opt_VODStreamRequest Object

객체에 이미 할당된 스트림 요청 속성이 있습니다.

속성

이름 유형 설명
contentSourceId

CMS에서 게시자 콘텐츠의 고유 식별자입니다. 주문형 스트림에 필요합니다.
videoId

동영상 콘텐츠 소스의 식별자입니다. 주문형 스트림에 필요합니다.

상수 google.ima.VERSION

SDK의 전체 버전이 포함된 문자열입니다.