클래스: StreamRequest

ima.StreamRequest

class   static

생성자

StreamRequest

새로운 StreamRequest()

스트림 요청의 속성을 지정하는 데 사용됩니다.

속성

adTagParameters

정적

문자열

선택사항입니다. 스트림 요청에서 제한된 광고 태그 매개변수 세트를 재정의할 수 있습니다. 스트림에 타겟팅 매개변수 제공에서 자세한 정보를 확인하세요. 스트림 변형 기본 설정에 dai-ot 및 dai-ov 매개변수를 사용할 수도 있습니다. 자세한 내용은 스트림 변형 매개변수 재정의를 참조하세요.

adUiNode

정적

roSGNode

광고 UI가 표시되는 장면 그래프 노드입니다. IMA는 광고 중에 이 요소에 이 광고의 이유 및 건너뛰기 버튼과 같은 요소를 배치합니다. 해당 요소는 비디오 요소 전체를 덮어야 합니다.

apiKey

정적

문자열

선택사항입니다. 이러한 키는 스트림 요청을 인증하는 데 사용할 수 있습니다. DAI 인증 키는 DFP UI에서 설정해야 합니다.

assetKey

정적

문자열

라이브 스트리밍에 필요합니다. 이는 어떤 스트림을 재생할지 결정하는 데 사용됩니다. 라이브 스트림 요청 자산 키는 DFP UI에서 찾을 수 있는 식별자입니다.

authToken

정적

문자열

스트림 요청 승인 토큰입니다. 더욱 엄격한 콘텐츠 인증을 위해 API 키 대신 사용됩니다. 게시자는 이 토큰을 기반으로 개별 콘텐츠 스트림 승인을 제어할 수 있습니다.

contentSourceId

정적

문자열

주문형 스트림에 필요합니다. cmsid는 DFP UI의 DFP 동영상 콘텐츠 소스에서 가져옵니다.

customAssetKey

정적

문자열

사용자 지정 자산 키는 어떤 스트림을 재생할지 결정하는 데 사용됩니다. Pod 제공 스트림 요청에는 사용자 정의 자산 키가 필요합니다.

형식

정적

ima.StreamFormat

스트림의 형식. 기본값은 ima.StreamFormat.HLS입니다.

networkCode

정적

문자열

스트림 요청을 하는 게시자의 네트워크 코드입니다. createPodLiveStreamRequest 또는 createPodVodStreamRequest로 생성된 스트림 요청을 제공하는 Pod에는 네트워크 코드가 필요합니다. 이러한 코드는 createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest 또는 createVideoStitcherVodStreamRequestWithVodConfig로 만든 클라우드 스티칭 스트림 요청에도 필요합니다. 이러한 코드는 선택 사항이며 createLiveStreamRequest 또는 createVodStreamRequest로 만든 전체 서비스 스트림 요청에 권장됩니다. 네트워크 코드를 추가하면 Ad Manager UI에서 선택한 설정(예: 프로그래밍 방식의 제한 광고 활성화)이 적용됩니다. Pod 제공 및 클라우드 스티칭의 경우, 네트워크 코드를 추가하면 스트림을 찾아 재생합니다. 네트워크 코드를 찾으려면 이 문서를 참조하세요.

플레이어

정적

(ima.Player 또는 Invalid)

플레이어 인터페이스의 구현.

ppid

정적

문자열

지원 중단되었습니다. adTagParameters를 사용합니다. 선택사항입니다. DFP Audience 게시자가 제공한 식별자입니다.

streamActivityMonitorId

정적

문자열

스트림 활동 모니터로 스트림을 디버깅하는 데 사용되는 ID입니다. 이는 게시자가 스트림 활동 모니터 도구에서 스트림 로그를 찾을 수 있는 편리한 방법을 제공하는 데 사용됩니다.

videoId

정적

문자열

주문형 스트리밍에 필요합니다. 비디오 콘텐츠 소스에 대한 식별자입니다.

videoObject

정적

(roVideo 또는 무효)

클라이언트 앱에서 비디오 재생을 담당하는 비디오 객체 (예: 비디오 roSGNode)입니다. 이 객체는 라이브 HLS ID3 이벤트의 적절한 타이밍을 설정하는 데 사용할 다양한 데이터를 폴링합니다.

videoStitcherSessionOptions

정적

V의 배열

세션 옵션은 VideoStitcher streamRequests의 동영상 광고 삽입 도구 관련 매개변수를 설정하는 데 사용됩니다.

메서드

createLiveStreamRequest

정적

createLiveStreamRequest(assetKey, apiKey, networkCode)는 ima.StreamRequest를 반환합니다.

Live StreamRequest의 필수 속성을 초기화합니다. 이 API를 사용하면 다른 StreamType 관련 속성이 무시됩니다. 필수 매개변수가 빈 문자열이면 오류 로깅이 발생하고 API는 무시된 속성 없이 일반 StreamRequest을 반환합니다.

매개변수

assetKey

문자열

apiKey

문자열

반환된 ima.StreamRequest의 ima.StreamRequest.apiKey 속성에 할당된 매개변수입니다. API 키가 없는 경우 빈 문자열을 전달합니다.

networkCode

문자열

스트림 요청을 하는 게시자를 위한 네트워크 코드입니다. 네트워크 코드를 포함하는 것은 선택 사항이지만 권장됩니다.
반환 값

필수 Live 속성이 있는 ima.StreamRequest ima.StreamRequest 객체

createPodLiveStreamRequest

정적

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)는 StreamRequest를 반환합니다.

Pod Live ima.StreamRequest의 필수 속성을 초기화합니다. 이 API를 사용하면 다른 ima.StreamType 관련 속성이 무시됩니다. 필수 매개변수가 빈 문자열이면 오류 로깅이 발생하고 API는 무시된 속성 없이 일반 StreamRequest을 반환합니다.

매개변수

customAssetKey

문자열

networkCode

문자열

apiKey

문자열

반환된 ima.StreamRequest의 ima.StreamRequest.apiKey 속성에 할당된 선택적 매개변수입니다. 기본값은 빈 문자열입니다.

반환 값

StreamRequest 필수 PodLive 속성이 있는 ima.StreamRequest 객체입니다.

createPodVodStreamRequest

정적

createPodVodStreamRequest(networkCode)는 StreamRequest를 반환합니다.

타사 비디오 스티처와 함께 제공되는 DAI Pod를 사용할 때 VOD 스트림을 등록하기 위해 ima.StreamRequest의 필수 속성을 초기화합니다. 이 함수는 요청 유형을 ima.StreamType.POD_VOD로 설정하고 누락된 데이터에 필요한 모든 속성을 검증합니다. 검증에 실패하면 디버그 콘솔에 오류가 기록됩니다.

매개변수

networkCode

문자열

Google Ad Manager 네트워크 코드
반환 값

StreamRequest는 ima.StreamRequest 객체입니다. 모든 필수 속성이 지정되면 요청 유형이 ima.StreamType.POD_VOD로 설정됩니다.

createStreamRequest

정적

createStreamRequest()는 ima.StreamRequest를 반환합니다.

반환 값

ima.StreamRequest 빈 ima.StreamRequest 객체입니다.

createVideoStitcherLiveStreamRequest

정적

createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken)는 ima.StreamRequest를 반환합니다.

Video Stitcher Live StreamRequest의 필수 속성을 초기화합니다. 이 API를 사용하면 다른 StreamType 관련 속성이 무시됩니다. 필수 매개변수가 빈 문자열인 경우 오류 로깅이 발생하고 API는 속성이 무시되지 않은 일반적인 StreamRequest를 반환합니다.

매개변수

customAssetKey

문자열

networkCode

문자열

liveConfigId

문자열

지역

문자열

projectNumber

문자열

oAuthToken

문자열
반환 값

ima.StreamRequest 필수 VideoStitcherLive 속성이 있는 ima.StreamRequest 객체입니다.

createVideoStitcherVodStreamRequest

정적

createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken)는 ima.StreamRequest를 반환합니다.

비디오 스티처 VOD StreamRequest의 필수 속성을 초기화합니다. 이 API를 사용하면 다른 StreamType 관련 속성이 무시됩니다. 필수 매개변수가 빈 문자열이면 오류 로깅이 발생하고 API는 무시된 속성 없이 일반 StreamRequest을 반환합니다.

매개변수

adTagUrl

문자열

networkCode

문자열

contentSourceUrl

문자열

지역

문자열

projectNumber

문자열

oAuthToken

문자열
반환 값

ima.StreamRequest 필수 VideoStitcherVod 속성이 있는 ima.StreamRequest 객체입니다.

createVideoStitcherVodStreamRequestWithVodConfig

정적

createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken)는 ima.StreamRequest를 반환합니다.

클라우드 비디오 스티처에서 생성된 vodConfigId를 사용하여 비디오 스티처 VOD StreamRequest의 필수 속성을 초기화합니다. 이 API를 사용하면 다른 StreamType 관련 속성이 무시됩니다. 필수 매개변수가 빈 문자열이면 오류 로깅이 발생하고 API는 무시된 속성 없이 일반 StreamRequest을 반환합니다.

매개변수

vodConfigId

문자열

networkCode

문자열

지역

문자열

projectNumber

문자열

oAuthToken

문자열
반환 값

ima.StreamRequest 필수 VideoStitcherVod 속성이 있는 ima.StreamRequest 객체입니다.

createVodStreamRequest

정적

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)는 ima.StreamRequest를 반환합니다.

VOD ima.StreamRequest의 필수 속성을 초기화합니다. 이 API를 사용하면 다른 ima.StreamType 관련 속성이 무시됩니다. 필수 매개변수가 빈 문자열이면 오류 로깅이 발생하고 API는 무시된 속성 없이 일반 StreamRequest을 반환합니다.

매개변수

contentSourceId

문자열

videoId

문자열

apiKey

문자열

반환된 ima.StreamRequest의 ima.StreamRequest.apiKey 속성에 할당된 매개변수입니다. API 키가 없는 경우 빈 문자열을 전달합니다.

networkCode

문자열

스트림 요청을 하는 게시자를 위한 네트워크 코드입니다. 네트워크 코드를 포함하는 것은 선택 사항이지만 권장됩니다.
반환 값

ima.StreamRequest 필수 VOD 속성이 있는 ima.StreamRequest 개체입니다.