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

Class ima

เมธอด

disableLogging, getStreamManager, initSdk, requestStream

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

disableLogging()

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

getStreamManager()

แสดงผล StreamManager หากมี หากยังไม่มีตัวจัดการสตรีม ระบบจะแสดงผล Invalid หากเกิดข้อผิดพลาดขณะสร้าง StreamManager ระบบจะแสดงออบเจ็กต์ข้อผิดพลาด

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

initSdk(settings)

เริ่มต้น SDK

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

requestStream(streamRequest)

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

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

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

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

Class ima.AdBreakInfo

ฟิลด์

adPosition, duration, podIndex, timeOffset, totalAds

เมธอด

createAdBreakInfo

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

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

ชื่อ	ประเภท	คำอธิบาย
adPosition		ดัชนีของโฆษณาในช่วงพักโฆษณา ดัชนีคือ 1 สำหรับโฆษณาแบบสแตนด์อโลน
duration		ระยะเวลาสูงสุดของช่วงพักเป็นวินาที หรือ -1 หากไม่ทราบ
podIndex		สำหรับไลฟ์สด จะแสดงผลรหัสช่วงพักโฆษณาเป็นดัชนีพ็อด หรือ 0 สำหรับโฆษณาก่อนวิดีโอ ไลฟ์สดจะไม่มีโฆษณาท้ายวิดีโอ ค่าเริ่มต้นคือ -2 สำหรับวิดีโอออนดีมานด์ (VOD) จะแสดงดัชนีของพ็อดโฆษณา สำหรับพ็อดโฆษณาตอนต้น ผลตอบแทน 0 สำหรับโฆษณาตอนกลาง ให้ส่งคืน 1, 2, ..., n สำหรับพ็อดโฆษณาท้ายวิดีโอ จะแสดงผล n+1...n+x ค่าเริ่มต้นเป็น 0 หากโฆษณานี้ไม่ได้เป็นส่วนหนึ่งของพ็อด หรือ พ็อดนี้ไม่ได้เป็นส่วนหนึ่งของเพลย์ลิสต์
timeOffset		ตำแหน่งของพ็อดในเนื้อหาเป็นวินาที โฆษณาตอนต้นแสดง 0 โฆษณาตอนท้ายแสดง -1 และ โฆษณาตอนกลางแสดงเวลาที่กำหนดไว้ของพอดแคสต์
totalAds		จำนวนโฆษณาทั้งหมดที่มีในช่วงพักโฆษณานี้ ค่าคือ 1 สำหรับโฆษณาแบบสแตนด์อโลน

createAdBreakInfo()

การคืนสินค้า ima.AdBreakInfo:

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

Class ima.AdEvent

ฟิลด์

AD_PERIOD_ENDED, AD_PERIOD_STARTED, COMPLETE, ERROR, FIRST_QUARTILE, ICON_FALLBACK_IMAGE_CLOSED, ICON_FALLBACK_IMAGE_SHOWN, MIDPOINT, PROGRESS, SKIPPABLE_STATE_CHANGED, SKIPPED, START, THIRD_QUARTILE

เหตุการณ์ที่ทริกเกอร์โดยผู้จัดการโฆษณา

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

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

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

Class ima.AdInfo

ฟิลด์

adBreakInfo, adDescription, adId, adSystem, adTitle, advertiserName, companions, creativeAdId, creativeId, currentTime, dealId, duration, skipOffset, universalAdIDRegistry, universalAdIDValue, wrappers

เมธอด

createAdInfo

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

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

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

createAdInfo()

การคืนสินค้า ima.AdInfo:

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

Class ima.Companion

ฟิลด์

adSlotId, apiFramework, companionClickThrough, creativeType, height, trackingEvents, url, width

เมธอด

createCompanion

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

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

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

createCompanion()

การคืนสินค้า ima.Companion:

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

Class ima.CuePoint

ฟิลด์

end, hasPlayed, start

เมธอด

createCuePoint

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

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

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

createCuePoint()

การคืนสินค้า ima.CuePoint:

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

Class ima.Error

ฟิลด์

id, info, type

เมธอด

createError

ออบเจ็กต์ที่ส่งไปยังตัวแฮนเดิลข้อผิดพลาดหากมีข้อผิดพลาด

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

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

createError()

การคืนสินค้า ima.Error:

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

Class ima.ErrorEvent

ฟิลด์

BAD_STREAM_REQUEST, COULD_NOT_LOAD_STREAM, ERROR, INVALID_RESPONSE, STREAM_API_KEY_NOT_VALID

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

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

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

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

Class ima.Player

เมธอด

adBreakEnded, adBreakStarted, allVideoComplete, createPlayer, loadUrl, streamInitialized

adBreakEnded(adBreakInfo)

ไม่บังคับ เรียกใช้เมื่อช่วงพักโฆษณาสิ้นสุดลง

พารามิเตอร์	ประเภท	คำอธิบาย
adBreakInfo	ima.AdBreakInfo	มีข้อมูลเกี่ยวกับช่วงพักโฆษณา

adBreakStarted(adBreakInfo)

ไม่บังคับ เรียกใช้เมื่อช่วงพักโฆษณาเริ่มขึ้น

พารามิเตอร์	ประเภท	คำอธิบาย
adBreakInfo	ima.AdBreakInfo	มีข้อมูลเกี่ยวกับช่วงพักโฆษณา

allVideoComplete()

ไม่บังคับ เรียกใช้เมื่อวิดีโอทั้งหมดเล่นจบ

createPlayer()

สร้างออบเจ็กต์ IMA Player ที่ว่างเปล่า คุณต้องใช้ฟังก์ชัน loadUrl เพื่อเล่นโฆษณา ฟังก์ชันอื่นๆ เป็นตัวเลือก

การคืนสินค้า ima.Player:

loadUrl(streamInfo)

เรียกใช้เมื่อเพลเยอร์ควรเริ่มเล่น URL คุณต้องใช้ วิธีนี้เพื่อโหลดสตรีม

พารามิเตอร์	ประเภท	คำอธิบาย
streamInfo	ima.StreamInfo	มีข้อมูลที่จำเป็นต่อการเล่น เนื้อหา

streamInitialized(streamInfo)

เรียกใช้เมื่อมีการเริ่มต้นสตรีม

พารามิเตอร์	ประเภท	คำอธิบาย
streamInfo	ima.StreamInfo	มีข้อมูลที่จำเป็นต่อการเล่น เนื้อหา

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

Class ima.StreamFormat

ฟิลด์

DASH HLS

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

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

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

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

Class ima.StreamInfo

ฟิลด์

format, manifest, streamId, streamType, subtitles

เมธอด

createStreamInfo

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

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

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

createStreamInfo()

การคืนสินค้า ima.StreamInfo:

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

Class ima.StreamManager

เมธอด

addEventListener, createStreamManager, enableInteractiveAds, getContentTime, getCuePoints, getPreviousCuePoint, getStreamTime, loadThirdPartyStream, onMessage, replaceAdTagParameters, start

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

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 ซึ่งแสดงเวลาใน เนื้อหาที่ไม่มีโฆษณา ดูรายละเอียดเพิ่มเติมได้ที่คำถามที่พบบ่อย หากต้องการดูเวลาเนื้อหาสำหรับบัตรผ่านเวลาสตรีมปัจจุบันใน -1

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

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

getCuePoints()

แสดงผลเครื่องหมายทั้งหมดที่สอดคล้องกับช่วงพักโฆษณาทั้งหมด พารามิเตอร์นี้ใช้ได้กับเนื้อหาวิดีโอออนดีมานด์ที่ทราบช่วงพักโฆษณาทั้งหมดล่วงหน้าเท่านั้น เวลาทั้งหมดแสดงเวลาสตรีมเป็นวินาที สำหรับสตรีม Cloud Stitching API พร็อพเพอร์ตี้ hasPlayed ของ ima.CuePoint แต่ละรายการจะเป็นเท็จเสมอ

ส่งคืน Object: อาร์เรย์ที่มีเครื่องหมายทั้งหมด

getPreviousCuePoint(time)

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

ส่งคืน ima.CuePoint: ออบเจ็กต์ที่มี start, end และ hasPlayed แสดงผล ไม่ถูกต้องหากไม่มีจุดเริ่มโฆษณา

พารามิเตอร์	ประเภท	คำอธิบาย
time	Float	เวลาในการค้นหา -1 จะระบุเวลาปัจจุบัน และแสดง Invalid สำหรับสตรีมอื่นๆ ทั้งหมด

getStreamTime(contentTime)

รับเวลาสำหรับสตรีมจากเวลาเนื้อหาสำหรับ VOD ในหน่วยมิลลิวินาที ดูรายละเอียดเพิ่มเติมได้ที่คำถามที่พบบ่อย

ส่งคืน 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()

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

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

Class ima.StreamRequest

ฟิลด์

adTagParameters, adUiNode, apiKey, assetKey, authToken, contentSourceId, customAssetKey, format, networkCode, player, ppid, streamActivityMonitorId, videoId, videoObject, videoStitcherSessionOptions

เมธอด

createLiveStreamRequest, createPodLiveStreamRequest, createPodVodStreamRequest, createStreamRequest, createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest, createVideoStitcherVodStreamRequestWithVodConfig, 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		รหัสเครือข่ายของผู้เผยแพร่โฆษณาที่ส่งคำขอสตรีม ต้องระบุรหัสเครือข่าย สำหรับคำขอสตรีมที่แสดงในพ็อดซึ่งสร้างด้วย createPodLiveStreamRequest หรือ createPodVodStreamRequest นอกจากนี้ โค้ดเหล่านี้ยังจำเป็นสำหรับคำขอสตรีมการต่อวิดีโอในระบบคลาวด์ที่สร้างด้วย createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest หรือ createVideoStitcherVodStreamRequestWithVodConfig รหัสเหล่านี้เป็นรหัสที่ไม่บังคับและแนะนำสำหรับคำขอสตรีมแบบบริการเต็มที่สร้างด้วย createLiveStreamRequest หรือ createVodStreamRequest การเพิ่มรหัสเครือข่ายจะใช้การตั้งค่าที่เลือกใน UI ของ Ad Manager เช่น การเปิดใช้โฆษณาแบบจำกัดแบบเป็นโปรแกรม สําหรับการแสดงโฆษณาพ็อดและการต่อเนื้อหาในระบบคลาวด์ การเพิ่มรหัสเครือข่ายจะ ค้นหาและเล่นสตรีม หากต้องการค้นหารหัสเครือข่าย โปรดดูบทความนี้
player		การใช้งานอินเทอร์เฟซของเพลเยอร์
ppid		เลิกใช้งานแล้ว ใช้ adTagParameters ไม่บังคับ กลุ่มเป้าหมาย DFP ตัวระบุที่ผู้เผยแพร่โฆษณามีให้
streamActivityMonitorId		รหัสที่จะใช้ในการแก้ไขข้อบกพร่องของสตรีมด้วยเครื่องมือตรวจสอบกิจกรรมการสตรีม ใช้เพื่ออำนวยความสะดวกให้ผู้เผยแพร่โฆษณาค้นหาบันทึกสตรีมในเครื่องมือตรวจสอบกิจกรรมการสตรีม
videoId		ต้องระบุสำหรับสตรีมแบบออนดีมานด์ ตัวระบุสำหรับแหล่งที่มาของเนื้อหาวิดีโอ
videoObject		ออบเจ็กต์วิดีโอ (เช่น Video roSGNode) ที่รับผิดชอบการเล่นวิดีโอ ในแอปไคลเอ็นต์ ระบบจะสำรวจออบเจ็กต์นี้เพื่อหาข้อมูลต่างๆ ที่จะใช้ในการ กำหนดเวลาเหตุการณ์ ID3 ของ HLS แบบสดอย่างเหมาะสม
videoStitcherSessionOptions		ตัวเลือกเซสชันใช้เพื่อตั้งค่าพารามิเตอร์เฉพาะของ Video Stitcher สำหรับ VideoStitcher streamRequests

createLiveStreamRequest(assetKey, apiKey, networkCode)

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

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

พารามิเตอร์	ประเภท	คำอธิบาย
assetKey	string
apiKey	string	พารามิเตอร์ที่กำหนดให้กับพร็อพเพอร์ตี้ ima.StreamRequest ของ ima.StreamRequest.apiKey ที่แสดง หากไม่มีคีย์ API ให้ส่งสตริงว่าง
networkCode	string	รหัสเครือข่ายของผู้เผยแพร่โฆษณาที่ส่งคำขอสตรีม คุณจะใส่หรือไม่ใส่รหัสเครือข่ายก็ได้ แต่เราขอแนะนำให้ใส่

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 Serving กับโปรแกรมต่อวิดีโอของบุคคลที่สาม ฟังก์ชันนี้จะตั้งค่าประเภทคำขอเป็น 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)

เริ่มต้นพร็อพเพอร์ตี้ที่จำเป็นของ Video Stitcher Live 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

createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken)

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

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

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

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)

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

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

พารามิเตอร์	ประเภท	คำอธิบาย
contentSourceId	string
videoId	string
apiKey	string	พารามิเตอร์ที่กำหนดให้กับพร็อพเพอร์ตี้ ima.StreamRequest ของ ima.StreamRequest.apiKey ที่แสดง หากไม่มีคีย์ API ให้ส่งสตริงว่าง
networkCode	string	รหัสเครือข่ายของผู้เผยแพร่โฆษณาที่ส่งคำขอสตรีม คุณจะใส่หรือไม่ใส่รหัสเครือข่ายก็ได้ แต่เราขอแนะนำให้ใส่

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

Class ima.StreamType

ฟิลด์

สด VOD

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

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

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

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

Class ima.WrapperInfo

ฟิลด์

adId, adSystem, creativeAdId, creativeId, dealId

เมธอด

createWrapperInfo

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

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

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

createWrapperInfo()

การคืนสินค้า ima.WrapperInfo:

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