클래스 ima
메서드
IMA SDK를 제어하는 전역 함수
disableLogging()
SDK 로깅을 사용 중지합니다. Logging은 기본적으로 사용 설정됩니다.
getStreamManager()
스트림 관리자가 사용 가능한 경우 이를 반환합니다.
스트림 관리자를 아직 사용할 수 없는 경우 Invalid가 반환됩니다.
스트림 관리자를 만드는 중에 오류가 발생하면 오류 객체가 반환됩니다.
반환하는 object
: 스트림 관리자 또는 오류 객체.
initSdk(settings)
SDK를 초기화합니다.
파라미터 | 유형 | 설명 |
---|---|---|
settings |
object |
선택적 IMA 설정 객체입니다. |
requestStream(streamRequest)
비동기 스트림 요청을 시작합니다. 이 메서드를 호출한 후 Control이 즉시 플레이어에 반환됩니다.
반환하는 object
: 오류를 반환하거나 오류가 없으면 무효합니다.
파라미터 | 유형 | 설명 |
---|---|---|
streamRequest |
object |
ima.AdBreakInfo 클래스
필드
메서드
광고 시점에 대한 정보를 포함합니다. SDK에 의해 이벤트 콜백에 전달됩니다.
속성
이름 | 유형 | 설명 |
---|---|---|
adPosition |
|
광고 시점의 광고 색인입니다. 독립형 광고의 경우 1입니다. |
duration |
|
광고 시점의 최대 지속 시간(초 단위) 또는 -1(알 수 없는 경우)입니다. |
podIndex |
|
라이브 스트림의 경우 항상 -1을 반환합니다. VOD의 경우 광고 모음의 색인을 반환합니다. 프리롤 광고 모음의 경우 0을 반환합니다. 미드롤의 경우 1, 2, ..., n을 반환합니다. 포스트롤 광고 모음의 경우 n+1...n+x를 반환합니다. 이 광고가 광고 모음에 속하지 않거나 이 광고 모음이 재생목록에 속하지 않는 경우 기본값은 0입니다. |
timeOffset |
|
콘텐츠 내 광고 모음의 위치(초) 프리롤은 0을 반환하고 포스트롤은 -1을 반환하며 미드롤은 광고 모음의 예약된 시간을 반환합니다. |
totalAds |
|
이 광고 시점에 포함된 광고의 총 개수입니다. 독립형 광고의 경우 1입니다. |
createAdBreakInfo()
반환하는 ima.AdBreakInfo
:
ima.AdEvent 클래스
필드
광고 관리자에 의해 실행된 이벤트입니다.
속성
이름 | 유형 | 설명 |
---|---|---|
AD_PERIOD_ENDED |
|
스트림이 광고 또는 슬레이트에서 콘텐츠로 전환될 때마다 실행됩니다. 광고가 두 번 재생되거나 광고를 탐색하는 경우에도 실행됩니다. |
AD_PERIOD_STARTED |
|
스트림이 콘텐츠에서 광고 또는 슬레이트로 전환될 때마다 실행됩니다. 광고가 두 번 재생되거나 광고를 탐색하는 경우에도 실행됩니다. |
COMPLETE |
|
광고 재생이 완료되면 시작됩니다. |
ERROR |
|
오류가 발생하면 실행됩니다. |
FIRST_QUARTILE |
|
광고 플레이헤드가 1분위를 넘어가면 시작됩니다. |
ICON_FALLBACK_IMAGE_CLOSED |
|
사용자가 아이콘 대체 이미지 대화상자를 닫으면 실행됩니다. |
ICON_FALLBACK_IMAGE_SHOWN |
|
아이콘 대체 이미지가 표시될 때 실행됩니다. |
MIDPOINT |
|
광고 플레이헤드가 중간 지점을 넘어가면 시작됩니다. |
PROGRESS |
|
광고 진행 상황이 업데이트되면 실행됩니다. |
SKIPPABLE_STATE_CHANGED |
|
광고의 건너뛸 수 있는 상태가 변경되면 실행됩니다. |
SKIPPED |
|
광고를 건너뛰면 시작됩니다. |
START |
|
광고 재생이 시작되면 시작됩니다. |
THIRD_QUARTILE |
|
광고 플레이헤드가 3분위를 넘어가면 시작됩니다. |
ima.AdInfo 클래스
필드
메서드
광고 정보를 포함합니다. SDK에 의해 이벤트 콜백에 전달됩니다.
속성
이름 | 유형 | 설명 |
---|---|---|
adBreakInfo |
|
이 광고가 포함된 전체 광고 시점과 관련된 정보입니다. |
adDescription |
|
광고에 대한 설명입니다. |
adId |
|
광고의 ID이거나 빈 문자열(알 수 없는 경우)입니다. |
adSystem |
|
광고 소재를 제공하는 광고 시스템입니다. |
adTitle |
|
광고의 제목입니다. |
advertiserName |
|
게재업체에서 정의한 광고주 이름입니다. |
companions |
|
VAST 응답에 지정된 컴패니언 광고입니다. |
currentTime |
|
광고 내의 현재 시간(초 단위) 또는 -1(알 수 없는 경우)입니다. |
duration |
|
이 단일 광고의 길이(초 단위) 또는 -1(알 수 없는 경우)입니다. |
skipOffset |
|
광고를 건너뛸 수 있게 되는 데 걸리는 시간 또는 알 수 없는 경우 -1로 표시됩니다. |
universalAdIDRegistry |
|
선택한 광고 소재의 범용 광고 ID가 카탈로그화된 레지스트리 웹사이트의 URL을 식별하는 데 사용되는 문자열입니다. |
universalAdIDValue |
|
광고에 대해 선택된 광고 소재의 범용 광고 ID |
wrappers |
|
이 광고에 대한 래퍼 정보가 포함된 ima.WrapperInfo의 배열입니다. 순서는 외부 래퍼에서 내부 래퍼가 될 것입니다. |
createAdInfo()
반환하는 ima.AdInfo
:
ima.Companion 클래스
필드
메서드
광고의 컴패니언에 대한 정보를 포함합니다.
속성
이름 | 유형 | 설명 |
---|---|---|
apiFramework |
|
이 광고를 실행하는 데 필요한 API이거나 사용할 수 없는 경우 잘못되었습니다. |
creativeType |
|
광고 소재 유형(일반적으로 MIME 유형)을 나타냅니다. |
height |
|
컴패니언의 높이(픽셀)입니다. 사용할 수 없는 경우 0입니다. |
trackingEvents |
|
키가 이벤트이고 값은 이벤트 시 핑할 URL 목록인 추적 이벤트의 맵입니다. |
url |
|
이 컴패니언의 정적 리소스에 대한 URL입니다. |
width |
|
컴패니언의 너비(픽셀)입니다. 사용할 수 없는 경우 0입니다. |
createCompanion()
반환하는 ima.Companion
:
ima.CuePoint 클래스
필드
메서드
큐 포인트에 대한 정보를 포함합니다.
속성
이름 | 유형 | 설명 |
---|---|---|
end |
|
큐 시점의 종료 시간(초)입니다. 광고 시점에 해당합니다. |
hasPlayed |
|
큐 시점이 이미 재생되었음을 나타내는 부울입니다. |
start |
|
큐 시점의 시작 시간(초)입니다. 광고 시점에 해당합니다. |
createCuePoint()
반환하는 ima.CuePoint
:
ima.Error 클래스
필드
메서드
오류가 있는 경우 오류 핸들러에 전달되는 객체입니다.
속성
이름 | 유형 | 설명 |
---|---|---|
id |
|
오류의 ID입니다. 오류 코드 목록은 ErrorEvent 상수를 참조하세요. |
info |
|
오류에 대한 추가 정보입니다. |
type |
|
이 객체의 유형을 나타내려면 항상 오류로 설정하세요. |
createError()
반환하는 ima.Error
:
ima.ErrorEvent 클래스
필드
SDK에서 반환할 수 있는 모든 오류입니다.
속성
이름 | 유형 | 설명 |
---|---|---|
BAD_STREAM_REQUEST |
|
스트림 요청이 제대로 채워지지 않았습니다. |
COULD_NOT_LOAD_STREAM |
|
스트림을 로드할 수 없습니다. |
ERROR |
|
알 수 없는 오류입니다. |
INVALID_RESPONSE |
|
서버 응답이 잘못되었습니다. |
STREAM_API_KEY_NOT_VALID |
|
제공된 API 키를 서버에서 승인하지 않았습니다. |
ima.Player 클래스
메서드
adBreakEnded(adBreakInfo)
선택사항입니다. 광고 시간이 종료되었을 때 호출됩니다.
파라미터 | 유형 | 설명 |
---|---|---|
adBreakInfo |
ima.AdBreakInfo |
광고 시점 정보를 포함합니다. |
adBreakStarted(adBreakInfo)
선택사항입니다. 광고 시간이 시작되었을 때 호출됩니다.
파라미터 | 유형 | 설명 |
---|---|---|
adBreakInfo |
ima.AdBreakInfo |
광고 시점 정보를 포함합니다. |
allVideoComplete()
선택사항입니다. 모든 동영상이 완료되면 호출됩니다.
createPlayer()
빈 IMA Player
객체를 생성합니다. 광고를 재생하려면
loadUrl
함수를 구현해야 합니다. 다른 함수는 선택사항입니다.
반환하는 ima.Player
:
loadUrl(streamInfo)
플레이어가 URL 재생을 시작해야 할 때 호출됩니다. 스트림을 로드하려면 이 메서드를 구현해야 합니다.
파라미터 | 유형 | 설명 |
---|---|---|
streamInfo |
ima.StreamInfo |
콘텐츠를 재생하는 데 필요한 정보가 포함되어 있습니다. |
ima.StreamFormat 클래스
필드
스트림의 형식을 정의합니다.
속성
이름 | 유형 | 설명 |
---|---|---|
DASH |
|
|
HLS |
|
ima.StreamInfo 클래스
필드
메서드
스트림에 대해 SDK에서 플레이어로 전달된 정보입니다.
속성
이름 | 유형 | 설명 |
---|---|---|
format |
|
동영상 형식: hls 또는 대시. ima.StreamFormat에 정의됩니다. |
manifest |
|
스트림의 URL입니다. |
streamId |
|
스트림의 고유 ID입니다. |
streamType |
|
동영상 유형(라이브 또는 주문형) ima.StreamType에 정의됩니다. |
subtitles |
|
자막(제공되는 경우) 그렇지 않은 경우 유효하지 않습니다. |
createStreamInfo()
반환하는 ima.StreamInfo
:
ima.StreamManager 클래스
메서드
스트림 재생을 관리하기 위한 객체입니다.
addEventListener(event, callback)
지정된 이벤트에 대한 리스너를 추가합니다. 지원되는 이벤트에 대한
AdEvents 상수를 참조하세요.
파라미터 | 유형 | 설명 |
---|---|---|
event |
string |
|
callback |
function |
createStreamManager(streamRequest, streamInitResponse)
반환하는 ima.StreamManager
:
파라미터 | 유형 | 설명 |
---|---|---|
streamRequest |
ima.StreamRequest |
|
streamInitResponse |
ima.StreamInitResponse |
enableInteractiveAds()
지원되지 않습니다. 대신 컴패니언 광고의 데이터를 직접 RAF로 전달합니다.
지금은 노옵스(no-ops)입니다.
getContentTime(streamTime)
VOD 스트림의 시간을 밀리초 단위로 가져와 광고가 없는 콘텐츠의 시간을 나타냅니다.
다음 페이지를 참조하세요. https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq
현재 스트림 시간의 콘텐츠 시간을 확인하려면 -1로 전달합니다.
반환하는 Integer
: 지정된 스트림 시간에 해당하는 콘텐츠 시간.
파라미터 | 유형 | 설명 |
---|---|---|
streamTime |
Integer |
스트림의 시간입니다. |
getCuePoints()
모든 광고 시간에 해당하는 모든 큐 포인트를 반환합니다. 모든 광고 시점이 미리 알려진 VOD 콘텐츠에만 유효합니다. 모든 시간은 스트림 시간을 초 단위로 나타냅니다.
반환하는 Object
: 모든 큐 포인트가 포함된 배열
getPreviousCuePoint(time)
이 시간 이전의 큐 포인트를 반환합니다. 큐 포인트는 광고 시점을 나타냅니다. 모든 시간은 스트림 시간을 초 단위로 나타냅니다.
반환하는 ima.CuePoint
: start, end 및 hasPlayed가 있는 객체입니다. 사용할 수 있는 큐 포인트가 없으면 무효를 반환합니다.
파라미터 | 유형 | 설명 |
---|---|---|
time |
Float |
조회할 시간으로, -1은 현재 시간을 나타냅니다. |
getStreamTime(contentTime)
VOD 콘텐츠 시간에서 스트림 시간을 밀리초 단위로 가져옵니다.
https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq를 참고하세요.
반환하는 Integer
: 지정된 콘텐츠 시간에 해당하는 스트림 시간입니다.
파라미터 | 유형 | 설명 |
---|---|---|
contentTime |
Integer |
콘텐츠가 표시되는 시간입니다. |
loadThirdPartyStream(streamManifest, streamSubtitle)
광고 메타데이터를 로드하고 제공된 streamManifestUrl
및 streamSubtitle
데이터를 사용하여 loadUrl
함수를 호출합니다. 이 함수는 스트림 요청 유형이 ima.StreamType.POD_VOD
인 경우에만 작동합니다.
파라미터 | 유형 | 설명 |
---|---|---|
streamManifest |
string |
광고가 연결된 스트림 매니페스트 URL입니다. |
streamSubtitle |
ifArray |
스트림과 연결된 자막이며, 없는 경우 |
onMessage(msg)
Video 객체에서 보낸 모든 메시지를 처리합니다.
roMessagePort에서 수신된 각 메시지에 대해 호출되어야 합니다.
파라미터 | 유형 | 설명 |
---|---|---|
msg |
object |
roVideo 포트의 메시지입니다. |
replaceAdTagParameters(adTagParameters)
라이브 스트림의 예정된 광고 요청에 사용할 모든 광고 태그 매개변수를
대체합니다. 이 통화는 VOD 스트림에서 사용할 수 없습니다.
파라미터 | 유형 | 설명 |
---|---|---|
adTagParameters |
string |
새 광고 태그 매개변수입니다. |
start()
스트림 재생을 시작합니다.
ima.StreamRequest 클래스
필드
메서드
스트림 요청의 속성을 지정하는 데 사용됩니다.
속성
이름 | 유형 | 설명 |
---|---|---|
adTagParameters |
|
선택사항입니다. 스트림 요청에서 제한된 광고 태그 매개변수 집합을 재정의할 수 있습니다. 타겟팅 매개변수를 스트림에 제공에서 자세한 정보를 제공합니다. 스트림 변형 환경설정에 dai-ot 및 dai-ov 매개변수를 사용할 수도 있습니다. 자세한 내용은 스트림 변형 매개변수 재정의를 참고하세요. |
adUiNode |
|
광고 UI가 표시되는 장면 그래프 노드입니다. IMA는 광고가 게재되는 동안 이 요소에 이 광고가 표시된 이유, 건너뛰기 버튼과 같은 요소를 배치합니다. 이 요소는 전체 동영상 요소를 오버레이해야 합니다. |
apiKey |
|
선택사항입니다. 이러한 키는 스트림 요청을 인증하는 데 사용할 수 있습니다. DAI 인증 키는 Google Ad Manager UI에서 설정해야 합니다. |
assetKey |
|
라이브 스트림의 필수 속성입니다. 어떤 스트림을 재생해야 하는지 결정하는 데 사용됩니다. 실시간 스트림 요청 애셋 키는 DFP UI에서 확인할 수 있는 식별자입니다. |
authToken |
|
스트림 요청 승인 토큰입니다. 더 엄격한 콘텐츠 승인을 위해 API 키 대신 사용됩니다. 게시자는 이 토큰을 기반으로 개별 콘텐츠 스트림 승인을 제어할 수 있습니다. |
contentSourceId |
|
주문형 스트림에 필요합니다. cmsid는 DFP UI의 DFP 동영상 콘텐츠 소스에서 제공됩니다. |
customAssetKey |
|
맞춤 애셋 키는 재생할 스트림을 결정하는 데 사용됩니다. 포드 게재 스트림 요청에는 커스텀 애셋 키가 필요합니다. |
format |
|
스트림의 형식입니다. 기본값은 |
networkCode |
|
스트림을 요청하는 게시자의 네트워크 코드입니다. 포드 제공 스트림 요청에는 네트워크 코드가 필요합니다. |
player |
|
플레이어 인터페이스의 구현입니다. |
ppid |
|
지원이 중단되었습니다. adTagParameters를 사용합니다. 선택사항입니다. DFP 잠재고객 게시자 제공 식별자 |
streamActivityMonitorId |
|
스트림 활동 모니터로 스트림을 디버그하는 데 사용되는 ID입니다. 게시자가 스트림 활동 모니터링 도구에서 스트림 로그를 찾을 수 있는 편리한 방법을 제공하는 데 사용됩니다. |
videoId |
|
주문형 스트림에 필요합니다. 동영상 콘텐츠 소스의 식별자입니다. |
videoObject |
|
클라이언트 앱에서 동영상 재생을 담당하는 동영상 객체 (예: Video roSGNode)입니다. 이 객체는 실시간 HLS ID3 이벤트의 적절한 타이밍에 사용될 다양한 데이터를 확인하기 위해 폴링됩니다. |
videoStitcherSessionOptions |
|
세션 옵션은 VideoStitcher StreamRequest의 동영상 스티처 관련 매개변수를 설정하는 데 사용됩니다. |
createLiveStreamRequest(assetKey, apiKey)
라이브 StreamRequest
의 필수 속성을 초기화합니다. 이 API를 사용하면 다른 StreamType
관련 속성이 무시됩니다.
필수 매개변수가 빈 문자열인 경우 오류 로깅이 발생하고 API는 속성이 무시되지 않는 일반 StreamRequest
를 반환합니다.
반환하는 ima.StreamRequest
: 필수 실시간 속성이 있는 ima.StreamRequest
객체.
파라미터 | 유형 | 설명 |
---|---|---|
assetKey |
string |
|
apiKey |
string |
반환된 |
createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)
포드 라이브 ima.StreamRequest
의 필수 속성을 초기화합니다.
이 API를 사용하면 다른 ima.StreamType
관련 속성이 무시됩니다.
필수 매개변수가 빈 문자열인 경우 오류 로깅이 발생하고 API는 속성이 무시되지 않는 일반 StreamRequest
를 반환합니다.
반환하는 StreamRequest
: 필수 PodLive 속성이 있는 ima.StreamRequest
객체.
파라미터 | 유형 | 설명 |
---|---|---|
customAssetKey |
string |
|
networkCode |
string |
|
apiKey |
string |
반환된 |
createPodVodStreamRequest(networkCode)
서드 파티 동영상 합치기로 DAI 포드 게재를 사용할 때 VOD 스트림을 등록하기 위해 ima.StreamRequest
의 필수 속성을 초기화합니다. 이 함수는 요청 유형을 ima.StreamType.POD_VOD
로 설정하고 누락된 데이터에 대한 모든 필수 속성의 유효성을 검사합니다. 유효성 검사에 실패하면 디버그 콘솔에 오류가 로깅됩니다.
반환하는 StreamRequest
: ima.StreamRequest
객체 모든 필수 속성이 지정되면 요청 유형이 ima.StreamType.POD_VOD
로 설정됩니다.
파라미터 | 유형 | 설명 |
---|---|---|
networkCode |
string |
Google Ad Manager 네트워크 코드는 |
createStreamRequest()
반환하는 ima.StreamRequest
: 빈 ima.StreamRequest
객체입니다.
createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken)
동영상 합치기 라이브 StreamRequest
의 필수 속성을 초기화합니다. 이 API를 사용하면 다른 StreamType
관련 속성이 무시됩니다.
필수 매개변수가 빈 문자열인 경우 오류 로깅이 발생하고 API는 속성이 무시되지 않는 일반 StreamRequest
를 반환합니다.
반환하는 ima.StreamRequest
: 필수 VideoStitcherLive 속성이 있는 ima.StreamRequest
객체.
파라미터 | 유형 | 설명 |
---|---|---|
customAssetKey |
string |
|
networkCode |
string |
|
liveConfigId |
string |
|
region |
string |
|
projectNumber |
string |
|
oAuthToken |
string |
createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken)
동영상 합치기 VOD StreamRequest
의 필수 속성을 초기화합니다. 이 API를 사용하면 다른 StreamType
관련 속성이 무시됩니다.
필수 매개변수가 빈 문자열인 경우 오류 로깅이 발생하고 API는 속성이 무시되지 않는 일반 StreamRequest
를 반환합니다.
반환하는 ima.StreamRequest
: 필수 VideoStitcherVod 속성이 있는 ima.StreamRequest
객체
파라미터 | 유형 | 설명 |
---|---|---|
adTagUrl |
string |
|
networkCode |
string |
|
contentSourceUrl |
string |
|
region |
string |
|
projectNumber |
string |
|
oAuthToken |
string |
CreateVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken)
클라우드 동영상 합치기에서 생성된 vodConfigId
를 사용하여 동영상 합치기 VOD StreamRequest
의 필수 속성을 초기화합니다.
이 API를 사용하면 다른 StreamType
관련 속성이 무시됩니다.
필수 매개변수가 빈 문자열인 경우 오류 로깅이 발생하고 API는 속성이 무시되지 않는 일반 StreamRequest
를 반환합니다.
반환하는 ima.StreamRequest
: 필수 VideoStitcherVod 속성이 있는 ima.StreamRequest
객체
파라미터 | 유형 | 설명 |
---|---|---|
vodConfigId |
string |
|
networkCode |
string |
|
region |
string |
|
projectNumber |
string |
|
oAuthToken |
string |
createVodStreamRequest(contentSourceId, videoId, apiKey)
VOD ima.StreamRequest
의 필수 속성을 초기화합니다. 이 API를 사용하면 다른 ima.StreamType
관련 속성이 무시됩니다.
필수 매개변수가 빈 문자열인 경우 오류 로깅이 발생하고 API는 속성이 무시되지 않는 일반 StreamRequest
를 반환합니다.
반환하는 ima.StreamRequest
: 필수 VOD 속성이 있는 ima.StreamRequest
객체.
파라미터 | 유형 | 설명 |
---|---|---|
contentSourceId |
string |
|
videoId |
string |
|
apiKey |
string |
반환된 |
ima.StreamType 클래스
필드
플레이어에게 재생을 요청하는 스트림의 유형을 정의합니다. 프리롤과 VOD는 스트림 시작부터 재생되어야 합니다.
속성
이름 | 유형 | 설명 |
---|---|---|
LIVE |
|
동영상이 게시되었습니다. |
VOD |
|
주문형 동영상입니다. |
ima.WrapperInfo 클래스
필드
메서드
래퍼에 대한 정보를 포함합니다.
속성
이름 | 유형 | 설명 |
---|---|---|
adId |
|
광고의 ID이거나 빈 문자열(알 수 없는 경우)입니다. |
adSystem |
|
선언된 광고 시스템 이름 또는 빈 문자열(알 수 없는 경우)입니다. |
creativeAdId |
|
광고 소재의 광고 ID 또는 빈 문자열(알 수 없는 경우)입니다. |
creativeId |
|
광고 소재의 ID이거나 빈 문자열(알 수 없는 경우)입니다. |
dealId |
|
거래 ID 또는 빈 문자열(알 수 없는 경우)입니다. |
createWrapperInfo()
반환하는 ima.WrapperInfo
: