IMA DAI SDK สำหรับ Roku

    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

เมธอด

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

disableLogging()

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

getStreamManager()

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

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

initSdk(settings)

เริ่มต้น SDK

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

ออบเจ็กต์การตั้งค่า IMA ที่ไม่บังคับ
requestStream(streamRequest)

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

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

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

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

คลาส ima.AdBreakInfo

ช่อง

เมธอด

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

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

ชื่อ ประเภท คำอธิบาย
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

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

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

คลาส ima.AdInfo

ช่อง

เมธอด

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

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

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

ข้อมูลที่เกี่ยวข้องกับช่วงพักทั้งหมดของโฆษณานี้
adDescription

คำอธิบายของโฆษณา
adId

รหัสของโฆษณาหรือสตริงว่างเปล่าหากไม่ทราบ
adSystem

ระบบโฆษณาที่จัดหาครีเอทีฟโฆษณา
adTitle

ชื่อของโฆษณา
advertiserName

ชื่อผู้ลงโฆษณาตามที่กำหนดโดยฝ่ายที่แสดงโฆษณา
companions

โฆษณาที่แสดงร่วมที่ระบุในการตอบกลับด้วย VAST
currentTime

เวลาปัจจุบันภายในโฆษณาเป็นวินาที หรือ -1 หากไม่ทราบ
duration

ระยะเวลาของโฆษณาเดียวนี้เป็นวินาที หรือ -1 หากไม่ทราบ
skipOffset

ระยะเวลาที่โฆษณาใช้ในการข้ามได้หรือ -1 หากไม่ทราบ
universalAdIDRegistry

สตริงที่ใช้ระบุ URL ของเว็บไซต์รีจิสทรีที่มีแคตตาล็อกรหัสโฆษณาสากลของครีเอทีฟโฆษณาที่เลือก
universalAdIDValue

รหัสโฆษณาสากลของครีเอทีฟโฆษณาที่เลือกสำหรับโฆษณานั้น
wrappers

อาร์เรย์ของ ima.WrapperInfo ที่มีข้อมูล Wrapper สำหรับโฆษณานี้ โดยเรียงลำดับจาก Wrapper ด้านนอกไปยังด้านใน
createAdInfo()


ส่งคืน ima.AdInfo:

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

คลาส ima.Companion

ช่อง

เมธอด

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

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

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

API จำเป็นต้องเรียกใช้โฆษณานี้ หรือ "ไม่ถูกต้อง" หากไม่มี
creativeType

แสดง Creativetype ที่โดยทั่วไปจะเป็น mimetype
height

ความสูงของโฆษณาที่แสดงร่วมกัน หน่วยเป็นพิกเซล 0 หากไม่มี
trackingEvents

การแมปเหตุการณ์การติดตามซึ่งมีคีย์เป็นเหตุการณ์และค่าเป็นรายการ URL ที่จะใช้คำสั่ง ping เมื่อเกิดเหตุการณ์นั้น
url

URL สำหรับทรัพยากรแบบคงที่ของโฆษณาที่แสดงร่วมนี้
width

ความกว้างของโฆษณาที่แสดงร่วมเป็นพิกเซล 0 หากไม่มี
createCompanion()


ส่งคืน ima.Companion:

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

คลาส ima.CuePoint

ช่อง

เมธอด

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

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

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

เวลาสิ้นสุดของจุดเริ่มโฆษณาเป็นวินาที ซึ่งสอดคล้องกับช่วงพักโฆษณา
hasPlayed

บูลีนที่ระบุว่าจุดเริ่มโฆษณาเล่นไปแล้ว
start

เวลาเริ่มต้นของจุดเริ่มโฆษณาเป็นวินาที ซึ่งสอดคล้องกับช่วงพักโฆษณา
createCuePoint()


ส่งคืน ima.CuePoint:

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

คลาส ima.Error

ช่อง

เมธอด

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

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

ชื่อ ประเภท คำอธิบาย
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

รหัสที่ไม่ซ้ำกันสำหรับสตรีม
streamType

ประเภทของวิดีโอ ได้แก่ สดหรือออนดีมานด์ กำหนดไว้ใน ima.StreamType
subtitles

คำบรรยาย (หากมี) หากไม่เป็นเช่นนั้น
createStreamInfo()


ส่งคืน ima.StreamInfo:

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

คลาส ima.StreamManager

เมธอด

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

addEventListener(event, callback)

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

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

โหลดข้อมูลเมตาของโฆษณาและเรียกใช้ฟังก์ชัน 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

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

ระบบใช้ตัวเลือกเซสชันเพื่อตั้งค่าพารามิเตอร์เฉพาะสำหรับเครื่องมือจัดระเบียบวิดีโอสำหรับ StreamRequests ของ VideoStitcher
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 กับเครื่องมือต่อเชื่อมวิดีโอของบุคคลที่สาม ฟังก์ชันนี้จะกำหนดประเภทคำขอเป็น 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)

เริ่มต้นพร็อพเพอร์ตี้ที่จำเป็นของ 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 ควรเล่นตั้งแต่ต้นของสตรีม

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

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

ถ่ายทอดสดวิดีโอ
VOD

วิดีโอออนดีมานด์

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

คลาส ima.WrapperInfo

ช่อง

เมธอด

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

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

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

รหัสของโฆษณาหรือสตริงว่างเปล่าหากไม่ทราบ
adSystem

ชื่อที่ประกาศของระบบโฆษณาหรือสตริงว่างเปล่าหากไม่ทราบ
creativeAdId

รหัสโฆษณาในครีเอทีฟโฆษณาหรือสตริงว่างเปล่าหากไม่ทราบ
creativeId

รหัสของครีเอทีฟโฆษณาหรือสตริงว่างเปล่าหากไม่ทราบ
dealId

รหัสดีลหรือสตริงว่างเปล่าหากไม่ทราบ
createWrapperInfo()


ส่งคืน ima.WrapperInfo:

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