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()

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

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

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 Manager เรียกให้แสดง

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

ชื่อ	ประเภท	คำอธิบาย
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 (ตัวระบุเชิงพาณิชย์มาตรฐานอุตสาหกรรม) ของโฆษณา นี่คือรหัสโฆษณาของครีเอทีฟโฆษณาที่เลือกในการตอบกลับ VAST
creativeId		รหัสของครีเอทีฟโฆษณาที่เลือกสําหรับโฆษณา
currentTime		เวลาปัจจุบันภายในโฆษณาเป็นวินาที หรือ -1 หากไม่ทราบ
dealId		แสดงผลรหัสดีลแรกที่อยู่ในเชน Wrapper สําหรับโฆษณาปัจจุบัน โดยเริ่มจากด้านบน
duration		ระยะเวลาของโฆษณาเดี่ยวนี้เป็นวินาที หรือ -1 หากไม่ทราบ
skipOffset		เวลาที่ใช้ในการเปลี่ยนโฆษณาให้ข้ามได้ หรือ -1 หากไม่ทราบ
universalAdIDRegistry		สตริงที่ใช้ในการระบุ URL ของเว็บไซต์รีจิสทรีที่จัดทําแคตตาล็อกรหัสโฆษณาแบบ Universal ของครีเอทีฟโฆษณาที่เลือก
universalAdIDValue		รหัสโฆษณา Universal ของครีเอทีฟโฆษณาที่เลือกสําหรับโฆษณา
wrappers		อาร์เรย์ของ ima.WrapperInfo ที่มีข้อมูล Wrapper สําหรับโฆษณานี้ ลําดับจะเรียงจาก Wrapper ภายนอกไปยัง Wrapper ภายใน

createAdInfo()

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

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

Class 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:

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

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

adBreakEnded(adBreakInfo)

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

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

adBreakStarted(adBreakInfo)

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

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

allVideoComplete()

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

createPlayer()

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

ผลลัพธ์ ima.Player:

loadUrl(streamInfo)

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

พารามิเตอร์	ประเภท	คำอธิบาย
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()

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

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

คลาส 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		ออบเจ็กต์วิดีโอ (เช่น roSGNode ของวิดีโอ) ที่รับผิดชอบการเล่นวิดีโอในแอปไคลเอ็นต์ ระบบจะทำการสำรวจออบเจ็กต์นี้เพื่อหาข้อมูลต่างๆ ที่จะใช้ในการกำหนดเวลาเหตุการณ์ ID3 ของ HLS แบบสดอย่างเหมาะสม
videoStitcherSessionOptions		ระบบจะใช้ตัวเลือกเซสชันเพื่อตั้งค่าพารามิเตอร์เฉพาะของวิดีโอต่อยต่อสำหรับ VideoStitcher streamRequests

createLiveStreamRequest(assetKey, apiKey, networkCode)

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

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

พารามิเตอร์	ประเภท	คำอธิบาย
assetKey	string
apiKey	string	พารามิเตอร์ที่กําหนดให้กับพร็อพเพอร์ตี้ ima.StreamRequest.apiKey ของ ima.StreamRequest ที่แสดง หากไม่มีคีย์ 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 กับโปรแกรมต่อวิดีโอของบุคคลที่สาม ฟังก์ชันนี้จะตั้งค่าประเภทคำขอเป็น 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: ออบเจ็กต์ 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.apiKey ของ ima.StreamRequest ที่แสดง หากไม่มีคีย์ API ให้ส่งสตริงว่าง
networkCode	string	รหัสเครือข่ายสำหรับผู้เผยแพร่โฆษณาที่ส่งคำขอสตรีม คุณจะใส่รหัสเครือข่ายหรือไม่ก็ได้ แต่เราขอแนะนําให้ใส่

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

Class ima.StreamType

ฟิลด์

LIVE, VOD

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

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

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

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

คลาส ima.WrapperInfo

ฟิลด์

adId, adSystem, creativeAdId, creativeId, dealId

เมธอด

createWrapperInfo

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

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

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

createWrapperInfo()

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

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