IMA DAI SDK สำหรับ Roku

1. 1. ima
   2. ima.AdBreakInfo
   3. ima.AdEvent
   4. ima.AdInfo
   5. ima.Companion
   6. ima.CuePoint
   7. ima.Error
   8. ima.ErrorEvent
   9. ima.Player
   10. ima.StreamFormat
   11. ima.StreamInfo
   12. ima.StreamManager
   13. ima.StreamRequest
   14. ima.StreamType
   15. ima.WrapperInfo

ประเภท ima

เมธอด

disableLogging, getStreamManager, initSdk, requestStream

ฟังก์ชันส่วนกลางที่ควบคุม IMA SDK

disableLogging()

ปิดใช้การบันทึก SDK การบันทึกจะเปิดอยู่โดยค่าเริ่มต้น

getStreamManager()

แสดงผลตัวจัดการสตรีม (หากมี) หากตัวจัดการสตรีมยังไม่พร้อมให้บริการ ระบบจะแสดงผลเป็น "ไม่ถูกต้อง" หากเกิดข้อผิดพลาดในการสร้างตัวจัดการสตรีม ระบบจะแสดงผลออบเจ็กต์ข้อผิดพลาด

แสดงผล object: ตัวจัดการสตรีมหรือออบเจ็กต์ข้อผิดพลาด

initSdk(settings)

เริ่มต้น SDK

พารามิเตอร์	ประเภท	คำอธิบาย
settings	object	ออบเจ็กต์การตั้งค่า IMA ที่ไม่บังคับ

requestStream(streamRequest)

เริ่มคำขอสตรีมอะซิงโครนัส ตัวควบคุมจะกลับไปที่โปรแกรมเล่นทันทีหลังจากเรียกใช้เมธอดนี้

แสดงผล object: ข้อผิดพลาดหรือไม่ถูกต้องหากไม่มีข้อผิดพลาด

พารามิเตอร์	ประเภท	คำอธิบาย
streamRequest	object

กลับไปด้านบน

คลาส ima.AdBreakInfo

ช่อง

adPosition, duration, podIndex, timeOffset, totalAds

เมธอด

createAdBreakInfo

มีข้อมูลเกี่ยวกับช่วงพักโฆษณา ส่งไปยังโค้ดเรียกกลับเหตุการณ์โดย 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, ข้อผิดพลาด, FIRST_QUARTILE, MIDPOINT, ความคืบหน้า, SKIPPABLE_STATE_CHANGED, SKIPPED, SKIPPEDTHIRD_QUARTILE

เหตุการณ์ที่ตัวจัดการโฆษณาเริ่มการทำงาน

พร็อพเพอร์ตี้

ชื่อ	ประเภท	คำอธิบาย
AD_PERIOD_ENDED		เริ่มทำงานทุกครั้งที่สตรีมเปลี่ยนจากการโฆษณาหรือแถบสเลทเป็นเนื้อหา ซึ่งจะเริ่มทำงานแม้ว่าโฆษณาจะเล่นเป็นครั้งที่ 2 หรือขณะค้นหาโฆษณา
AD_PERIOD_STARTED		เริ่มทำงานทุกครั้งที่สตรีมเปลี่ยนจากเนื้อหาเป็นการโฆษณาหรือแถบสเลท ซึ่งจะเริ่มทำงานแม้ว่าโฆษณาจะเล่นเป็นครั้งที่ 2 หรือขณะค้นหาโฆษณา
COMPLETE		เริ่มทำงานเมื่อโฆษณาเล่นจบ
ERROR		เริ่มทำงานเมื่อเกิดข้อผิดพลาด
FIRST_QUARTILE		เริ่มทำงานเมื่อส่วนหัวของตัวควบคุมการเล่นโฆษณาข้ามควอไทล์แรก
MIDPOINT		เริ่มทำงานเมื่อส่วนหัวของตัวควบคุมการเล่นโฆษณาข้ามจุดกึ่งกลาง
PROGRESS		เริ่มทำงานเมื่อมีข้อมูลอัปเดตความคืบหน้าของโฆษณา
SKIPPABLE_STATE_CHANGED		เริ่มทำงานเมื่อสถานะของโฆษณาที่ข้ามได้มีการเปลี่ยนแปลง
SKIPPED		เริ่มทำงานเมื่อโฆษณาถูกข้าม
START		เริ่มทำงานเมื่อโฆษณาเริ่มเล่น
THIRD_QUARTILE		เริ่มทำงานเมื่อส่วนหัวของตัวควบคุมการเล่นโฆษณาข้ามควอไทล์ที่ 3

กลับไปด้านบน

คลาส ima.AdInfo

ช่อง

adBreakInfo, adDescription, adId, adSystem, adTitle, advertiserName, companions, currentTime, duration, universalAdIDRegistry universalAdIDValue

เมธอด

createAdInfo

มีข้อมูลเกี่ยวกับโฆษณา ส่งไปยังโค้ดเรียกกลับเหตุการณ์โดย SDK

พร็อพเพอร์ตี้

ชื่อ	ประเภท	คำอธิบาย
adBreakInfo		ข้อมูลที่เกี่ยวข้องกับช่วงพักโฆษณาทั้งหมดที่โฆษณานี้แสดง
adDescription		คำอธิบายของโฆษณา
adId		รหัสของโฆษณาหรือสตริงว่าง หากไม่ทราบ
adSystem		ระบบโฆษณาที่ส่งครีเอทีฟโฆษณา
adTitle		ชื่อของโฆษณา
advertiserName		ชื่อผู้ลงโฆษณาตามที่ฝ่ายที่แสดงโฆษณากำหนด
companions		โฆษณาที่แสดงร่วมที่ระบุในการตอบสนองด้วย VAST
currentTime		เวลาปัจจุบันภายในโฆษณาเป็นวินาที หรือ -1 หากไม่ทราบ
duration		ระยะเวลาของโฆษณาเดียวนี้เป็นวินาที หรือ -1 หากไม่ทราบ
universalAdIDRegistry		สตริงที่ใช้เพื่อระบุ URL ของเว็บไซต์รีจิสทรีที่มีแคตตาล็อกรหัสโฆษณา Universal ของครีเอทีฟโฆษณาที่เลือก
universalAdIDValue		รหัสโฆษณาสากลของครีเอทีฟโฆษณาที่เลือกสำหรับโฆษณา
wrappers		อาร์เรย์ของ ima.WrapperInfo ที่มีข้อมูล Wrapper สำหรับโฆษณานี้ โดยลำดับจะเปลี่ยนจาก Wrapper ด้านนอกไปจนถึงด้านใน

createAdInfo()

ส่งคืน ima.AdInfo:

กลับไปด้านบน

คลาส ima.Companion

ช่อง

apiFramework, creativeType, height, trackingEvents, url, width

เมธอด

createCompanion

มีข้อมูลเกี่ยวกับโฆษณาที่แสดงร่วมของโฆษณา

พร็อพเพอร์ตี้

ชื่อ	ประเภท	คำอธิบาย
apiFramework		ต้องใช้ API เพื่อเรียกใช้โฆษณานี้ หรือ "ไม่ถูกต้อง" หากไม่พร้อมใช้งาน
creativeType		แสดงประเภทครีเอทีฟโฆษณาที่โดยทั่วไปจะเป็น mimetype
height		ความสูงของโฆษณาแสดงร่วม หน่วยเป็นพิกเซล เป็น 0 หากไม่พร้อมใช้งาน
trackingEvents		แผนที่การติดตามเหตุการณ์ซึ่งมีคีย์คือเหตุการณ์และค่าเป็นรายการ URL ที่จะใช้คำสั่ง ping กับเหตุการณ์นั้น
url		URL สำหรับทรัพยากรแบบคงที่ของการแสดงร่วมนี้
width		ความกว้างของโฆษณาแสดงร่วมในหน่วยพิกเซล เป็น 0 หากไม่พร้อมใช้งาน

createCompanion()

ส่งคืน ima.Companion:

กลับไปด้านบน

คลาส ima.CuePoint

ช่อง

end, hasPlayed, start

เมธอด

createCuePoint

มีข้อมูลเกี่ยวกับจุดเริ่มโฆษณา

พร็อพเพอร์ตี้

ชื่อ	ประเภท	คำอธิบาย
end		เวลาสิ้นสุดของจุดเริ่มโฆษณาเป็นวินาที ซึ่งสอดคล้องกับช่วงพักโฆษณา
hasPlayed		บูลีนที่ระบุว่าจุดเริ่มโฆษณาเล่นไปแล้ว
start		เวลาเริ่มต้นสำหรับจุดเริ่มโฆษณาเป็นวินาที ซึ่งสอดคล้องกับช่วงพักโฆษณา

createCuePoint()

ส่งคืน ima.CuePoint:

กลับไปด้านบน

คลาส ima.Error

ช่อง

รหัส, ข้อมูล, ประเภท

เมธอด

createError

มีการส่งออบเจ็กต์ไปยังเครื่องจัดการข้อผิดพลาด หากมีข้อผิดพลาด

พร็อพเพอร์ตี้

ชื่อ	ประเภท	คำอธิบาย
id		รหัสของข้อผิดพลาด ดูรายการรหัสข้อผิดพลาดที่ค่าคงที่ ErrorEvent
info		ข้อมูลเพิ่มเติมเกี่ยวกับข้อผิดพลาด
type		ตั้งค่าเป็นข้อผิดพลาดเสมอเพื่อระบุประเภทของออบเจ็กต์นี้

createError()

ส่งคืน ima.Error:

กลับไปด้านบน

คลาส ima.ErrorEvent

ช่อง

BAD_STREAM_REQUEST, COULD_NOT_LOAD_STREAM, ข้อผิดพลาด, INVALID_RESPONSE, STREAM_API_KEY_NOT_VALID

ข้อผิดพลาดทั้งหมดที่ SDK อาจส่งกลับมา

พร็อพเพอร์ตี้

ชื่อ	ประเภท	คำอธิบาย
BAD_STREAM_REQUEST		สร้างคำขอสตรีมไม่ถูกต้อง
COULD_NOT_LOAD_STREAM		โหลดสตรีมไม่ได้
ERROR		ข้อผิดพลาดที่ไม่รู้จัก
INVALID_RESPONSE		การตอบสนองของเซิร์ฟเวอร์ไม่ถูกต้อง
STREAM_API_KEY_NOT_VALID		เซิร์ฟเวอร์ไม่ยอมรับคีย์ API ที่ระบุ

กลับไปด้านบน

คลาส ima.Player

เมธอด

adBreakEnded, adBreakStarted, allVideoComplete, createPlayer, loadUrl

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

กำหนดรูปแบบของสตรีม

พร็อพเพอร์ตี้

ชื่อ	ประเภท	คำอธิบาย
DASH
HLS

กลับไปด้านบน

คลาส ima.StreamInfo

ช่อง

format, ไฟล์ Manifest, streamId, streamType, คำบรรยาย

เมธอด

createStreamInfo

ข้อมูลเกี่ยวกับสตรีมที่ส่งจาก SDK ไปยังโปรแกรมเล่น

พร็อพเพอร์ตี้

ชื่อ	ประเภท	คำอธิบาย
format		รูปแบบของวิดีโอ: hls หรือขีดกลาง กำหนดไว้ใน ima.StreamFormat
manifest		URL สำหรับสตรีม
streamId		รหัสที่ไม่ซ้ำกันสำหรับสตรีม
streamType		ประเภทของวิดีโอ: สดหรือออนดีมานด์ กำหนดไว้ใน ima.StreamType
subtitles		คำบรรยาย หากมี ไม่ถูกต้องหากไม่ใช่

createStreamInfo()

ส่งคืน ima.StreamInfo:

กลับไปด้านบน

คลาส ima.StreamManager

เมธอด

addEventListener, createStreamManager, enableInteractiveAds, getContentTime, getCuePoints, getPreviousCuePoint, getStreamTime, loadThirdPartyStream, onMessage,replace onMessage แทน getStreamTimereplaceAdTagParameters

ออบเจ็กต์สำหรับจัดการการเล่นสตรีม

addEventListener(event, callback)

เพิ่ม Listener สำหรับเหตุการณ์ที่ระบุ ดูค่าคงที่ AdEvents สำหรับ เหตุการณ์ที่รองรับ

พารามิเตอร์	ประเภท	คำอธิบาย
event	string
callback	function

createStreamManager(streamRequest, streamInitResponse)

ส่งคืน ima.StreamManager:

พารามิเตอร์	ประเภท	คำอธิบาย
streamRequest	ima.StreamRequest
streamInitResponse	ima.StreamInitResponse

enableInteractiveAds()

ไม่รองรับ แต่ให้ส่งข้อมูลจากโฆษณาที่แสดงร่วมไปยัง RAF โดยตรงแทน ตอนนี้ไม่มีการดำเนินการแล้ว

getContentTime(streamTime)

รับเวลาเป็นมิลลิวินาทีสำหรับสตรีม VOD ซึ่งแสดงเวลาในเนื้อหาที่ไม่มีโฆษณา ดู: https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq หากต้องการดูเวลาเนื้อหาสำหรับเวลาสตรีมปัจจุบันที่ผ่านไป -1

แสดงผล Integer: เวลาของเนื้อหาที่สอดคล้องกับเวลาการสตรีมที่ระบุ

พารามิเตอร์	ประเภท	คำอธิบาย
streamTime	Integer	เวลาในสตรีม

getCuePoints()

แสดงจุดเริ่มโฆษณาทั้งหมดที่เกี่ยวข้องกับช่วงพักโฆษณาทั้งหมด ซึ่งใช้ได้กับเนื้อหาวิดีโอออนดีมานด์ที่มีการรู้ช่วงพักโฆษณาทั้งหมดล่วงหน้าเท่านั้น เวลาทั้งหมดแสดงเวลาการสตรีมเป็นวินาที

แสดงผล Object: อาร์เรย์ที่มีจุดเริ่มโฆษณาทั้งหมด

getPreviousCuePoint(time)

แสดงผลจุดเริ่มโฆษณาก่อนหน้าเวลานี้ จุดเริ่มโฆษณาบ่งบอกถึงช่วงพักโฆษณา เวลาทั้งหมดแสดงเวลาการสตรีมเป็นวินาที

แสดงผล ima.CuePoint: ออบเจ็กต์ที่มีจุดเริ่มต้น สิ้นสุด และ 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)

โหลดข้อมูลเมตาของโฆษณาและเรียกใช้ฟังก์ชัน loadUrl ด้วยข้อมูล streamManifestUrl และ streamSubtitle ที่ให้ไว้ ฟังก์ชันนี้จะทำงานเมื่อประเภทคำขอสตรีมคือ ima.StreamType.POD_VOD เท่านั้น

พารามิเตอร์	ประเภท	คำอธิบาย
streamManifest	string	URL ไฟล์ Manifest ของสตรีมที่มีโฆษณาที่ต่อเข้าด้วยกัน
streamSubtitle	ifArray>|Invalid	คำบรรยายจะเชื่อมโยงกับสตรีม หรือ Invalid หากไม่มี

onMessage(msg)

จัดการข้อความทั้งหมดที่มาจากออบเจ็กต์วิดีโอ ต้องเรียกใช้สำหรับแต่ละข้อความที่ได้รับใน roMessagePort

พารามิเตอร์	ประเภท	คำอธิบาย
msg	object	ข้อความจากพอร์ต roVideo

replaceAdTagParameters(adTagParameters)

แทนที่พารามิเตอร์แท็กโฆษณาทั้งหมดที่ใช้สำหรับคำขอโฆษณาที่กำลังจะมาถึงสำหรับสตรีมแบบสด โปรดทราบว่าการโทรนี้ไม่ได้ดำเนินการสำหรับสตรีม VOD

พารามิเตอร์	ประเภท	คำอธิบาย
adTagParameters	string	พารามิเตอร์แท็กโฆษณาใหม่

start()

เริ่มเล่นสตรีม

กลับไปด้านบน

คลาส ima.StreamRequest

ช่อง

adTagParameters, adUiNode, apiKey, assetKey, authToken, contentSourceId, customAssetKey, รูปแบบ, networkCode, networkCode contentSourceId, contentSourceId, customAssetKey}ppidstreamActivityMonitorIdvideoIdvideoObject

เมธอด

createLiveStreamRequest, createPodLiveStreamRequest, createPodVodStreamRequest, createStreamRequest, createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest, createVodStreamRequest

ใช้สำหรับระบุพร็อพเพอร์ตี้ของคำขอสตรีม

พร็อพเพอร์ตี้

ชื่อ	ประเภท	คำอธิบาย
adTagParameters		ไม่บังคับ คุณลบล้างชุดพารามิเตอร์แท็กโฆษณาอย่างจำกัดได้ ในคำขอสตรีม การระบุพารามิเตอร์การกำหนดเป้าหมายในสตรีมของคุณจะให้ข้อมูลเพิ่มเติม คุณสามารถใช้พารามิเตอร์ dai-ot และ dai-ov สำหรับค่ากำหนดตัวแปรสตรีมได้ด้วย ดูข้อมูลเพิ่มเติมได้ที่ลบล้างพารามิเตอร์ตัวแปรสตรีม
adUiNode		โหนดกราฟฉากที่ UI ของโฆษณาแสดง IMA วางองค์ประกอบต่างๆ เช่น ทำไมจึงแสดงโฆษณานี้ และปุ่มข้ามไว้ในองค์ประกอบนี้ระหว่างโฆษณา โดยองค์ประกอบนี้ต้องวางซ้อนองค์ประกอบวิดีโอทั้งหมด
apiKey		ไม่บังคับ คีย์เหล่านี้ใช้ตรวจสอบสิทธิ์ของคำขอสตรีมได้ คีย์การตรวจสอบสิทธิ์ DAI ต้องตั้งค่าใน UI ของ DFP
assetKey		ต้องระบุสำหรับสตรีมแบบสด ข้อมูลนี้ใช้เพื่อกำหนดว่า ควรเล่นสตรีมใด คีย์เนื้อหาของคำขอสตรีมแบบสดคือตัวระบุซึ่งอยู่ใน UI ของ DFP
authToken		โทเค็นการให้สิทธิ์คำขอสตรีม โดยใช้แทนคีย์ API สำหรับการให้สิทธิ์เนื้อหาที่เข้มงวดขึ้น ผู้เผยแพร่โฆษณาจะควบคุมการให้สิทธิ์สตรีมเนื้อหาแต่ละรายการโดยอิงตามโทเค็นนี้ได้
contentSourceId		ต้องระบุสำหรับสตรีมแบบออนดีมานด์ cmsid มาจากแหล่งที่มาของเนื้อหาวิดีโอ DFP ใน UI ของ DFP
customAssetKey		คีย์เนื้อหาที่กำหนดเองใช้เพื่อกำหนดว่าสตรีมใดควรเล่น ต้องมีคีย์เนื้อหาที่กำหนดเองสำหรับคำขอสตรีมที่แสดงพ็อด
format		รูปแบบของสตรีม ค่าเริ่มต้นคือ ima.StreamFormat.HLS
networkCode		รหัสเครือข่ายสำหรับผู้เผยแพร่โฆษณาที่ส่งคำขอสตรีม ต้องระบุรหัสเครือข่ายสำหรับคำขอสตรีมที่แสดงพ็อด
player		การใช้งานอินเทอร์เฟซโปรแกรมเล่น
ppid		เลิกใช้งานแล้ว ใช้ adTagParameters ไม่บังคับ ตัวระบุที่ผู้เผยแพร่โฆษณามีให้กลุ่มเป้าหมาย DFP
streamActivityMonitorId		รหัสที่จะใช้ในการแก้ไขข้อบกพร่องของสตรีมด้วยเครื่องมือตรวจสอบกิจกรรมการสตรีม ซึ่งจะเป็นวิธีที่ช่วยให้ผู้เผยแพร่โฆษณาค้นหาบันทึกสตรีมในเครื่องมือตรวจสอบกิจกรรมการสตรีมได้อย่างสะดวก
videoId		ต้องระบุสำหรับสตรีมแบบออนดีมานด์ ตัวระบุแหล่งที่มาของเนื้อหาวิดีโอ
videoObject		ออบเจ็กต์วิดีโอ (เช่น Video roSGNode) ที่รับผิดชอบการเล่นวิดีโอในแอปไคลเอ็นต์ ระบบจะสำรวจออบเจ็กต์นี้เพื่อหาข้อมูลต่างๆ ที่จะใช้ในกำหนดเวลาเหตุการณ์ Live HLS ID3 อย่างเหมาะสม

createLiveStreamRequest(assetKey, apiKey)

เริ่มต้นพร็อพเพอร์ตี้ที่จำเป็นของ StreamRequest แบบสด การใช้ API นี้จะทำให้ระบบละเว้นพร็อพเพอร์ตี้เฉพาะ StreamType อื่นๆ หากพารามิเตอร์ที่จำเป็นเป็นสตริงว่าง การบันทึกข้อผิดพลาดจะเกิดขึ้นและ API จะแสดงผล StreamRequest ทั่วไปโดยไม่ละเว้นพร็อพเพอร์ตี้

แสดงผล ima.StreamRequest: ออบเจ็กต์ ima.StreamRequest รายการที่มีพร็อพเพอร์ตี้ Live ที่จำเป็น

พารามิเตอร์	ประเภท	คำอธิบาย
assetKey	string
apiKey	string	พารามิเตอร์ที่ไม่บังคับซึ่งจะกำหนดให้กับพร็อพเพอร์ตี้ apiKey ของ StreamRequest ที่ส่งคืน โดยค่าเริ่มต้นเป็นสตริงว่างเปล่า

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

เริ่มต้นพร็อพเพอร์ตี้ที่จำเป็นของ Pod Live ima.StreamRequest การใช้ API นี้จะไม่สนใจพร็อพเพอร์ตี้เฉพาะ ima.StreamType อื่นๆ หากพารามิเตอร์ที่จำเป็นเป็นสตริงว่าง การบันทึกข้อผิดพลาดจะเกิดขึ้นและ API จะแสดงผล StreamRequest ทั่วไปโดยไม่ละเว้นพร็อพเพอร์ตี้

แสดงผล StreamRequest: ima.StreamRequest ออบเจ็กต์ที่มีพร็อพเพอร์ตี้ PodLive ที่จำเป็น

พารามิเตอร์	ประเภท	คำอธิบาย
customAssetKey	string
networkCode	string
apiKey	string	พารามิเตอร์ที่ไม่บังคับซึ่งจะกำหนดให้กับพร็อพเพอร์ตี้ ima.StreamRequest.apiKey ของ ima.StreamRequest ที่แสดง ค่าเริ่มต้นคือสตริงว่างเปล่า

createPodVodStreamRequest(networkCode)

เริ่มต้นพร็อพเพอร์ตี้ที่จำเป็นของ ima.StreamRequest เพื่อลงทะเบียนสตรีม VOD เมื่อใช้การแสดง DAI Pod ด้วยเครื่องมือตัดต่อวิดีโอของบุคคลที่สาม ฟังก์ชันนี้จะกำหนดประเภทคำขอเป็น ima.StreamType.POD_VOD และตรวจสอบพร็อพเพอร์ตี้ที่จำเป็นทั้งหมดสำหรับข้อมูลที่ขาดหายไป การตรวจสอบที่ไม่สำเร็จจะบันทึกข้อผิดพลาดในคอนโซลดีบัก

แสดงผล StreamRequest: ออบเจ็กต์ ima.StreamRequest หากระบุพร็อพเพอร์ตี้ที่จำเป็นทั้งหมด ระบบจะตั้งค่าประเภทคำขอเป็น ima.StreamType.POD_VOD

พารามิเตอร์	ประเภท	คำอธิบาย
networkCode	string	รหัสเครือข่าย Ad Manager ของ Google

createStreamRequest()

แสดงผล ima.StreamRequest: ออบเจ็กต์ ima.StreamRequest ที่ว่างเปล่า

createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken)

เริ่มต้นพร็อพเพอร์ตี้ที่จำเป็นของเครื่องมือตัดต่อวิดีโอแบบสด StreamRequest การใช้ API นี้จะทำให้ระบบละเว้นพร็อพเพอร์ตี้เฉพาะ StreamType อื่นๆ หากพารามิเตอร์ที่จำเป็นเป็นสตริงว่าง การบันทึกข้อผิดพลาดจะเกิดขึ้นและ API จะแสดงผล StreamRequest ทั่วไปโดยไม่ละเว้นพร็อพเพอร์ตี้

แสดงผล ima.StreamRequest: ออบเจ็กต์ ima.StreamRequest รายการที่มีพร็อพเพอร์ตี้ VideoStitcherLive ที่จำเป็น

พารามิเตอร์	ประเภท	คำอธิบาย
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: ออบเจ็กต์ ima.StreamRequest รายการที่มี พร็อพเพอร์ตี้ VideoStitcherVod ที่จำเป็น

พารามิเตอร์	ประเภท	คำอธิบาย
adTagUrl	string
networkCode	string
contentSourceUrl	string
region	string
projectNumber	string
oAuthToken	string

createVodStreamRequest(contentSourceId, videoId, apiKey)

เริ่มต้นพร็อพเพอร์ตี้ที่จำเป็นของ VOD ima.StreamRequest การใช้ API นี้จะทำให้ระบบละเว้นพร็อพเพอร์ตี้เฉพาะ ima.StreamType อื่นๆ หากพารามิเตอร์ที่จำเป็นเป็นสตริงว่าง การบันทึกข้อผิดพลาดจะเกิดขึ้นและ API จะแสดงผล StreamRequest ทั่วไปโดยไม่ละเว้นพร็อพเพอร์ตี้

ส่งคืน ima.StreamRequest: ออบเจ็กต์ ima.StreamRequest รายการที่มีพร็อพเพอร์ตี้ VOD ที่จำเป็น

พารามิเตอร์	ประเภท	คำอธิบาย
contentSourceId	string
videoId	string
apiKey	string	พารามิเตอร์ที่ไม่บังคับซึ่งจะกำหนดให้กับพร็อพเพอร์ตี้ ima.StreamRequest.apiKey ของ ima.StreamRequest ที่แสดง ค่าเริ่มต้นคือสตริงว่างเปล่า

กลับไปด้านบน

คลาส ima.StreamType

ช่อง

สด, VOD

กำหนดประเภทของสตรีมที่ขอให้โปรแกรมเล่นเล่น โฆษณาตอนต้นและ VOD ควรเล่นตั้งแต่ต้นสตรีม

พร็อพเพอร์ตี้

ชื่อ	ประเภท	คำอธิบาย
LIVE		ถ่ายทอดสดวิดีโอ
VOD		วิดีโอเป็นแบบออนดีมานด์

กลับไปด้านบน

คลาส ima.WrapperInfo

ช่อง

adId, adSystem, creativeAdId, creativeId, dealId

เมธอด

createWrapperInfo

มีข้อมูลเกี่ยวกับ Wrapper

พร็อพเพอร์ตี้

ชื่อ	ประเภท	คำอธิบาย
adId		รหัสของโฆษณาหรือสตริงว่าง หากไม่ทราบ
adSystem		ชื่อระบบโฆษณาที่ประกาศหรือสตริงว่างหากไม่ทราบ
creativeAdId		รหัสโฆษณาในครีเอทีฟโฆษณาหรือสตริงว่าง หากไม่ทราบ
creativeId		รหัสของครีเอทีฟโฆษณาหรือสตริงว่างหากไม่ทราบ
dealId		รหัสดีลหรือสตริงว่าง หากไม่ทราบ

createWrapperInfo()

ส่งคืน ima.WrapperInfo:

กลับไปด้านบน