Google IMA DAI SDK API

1. 1. google.ima.dai.api.Ad
   2. google.ima.dai.api.AdPodInfo
   3. google.ima.dai.api.AdProgressData
   4. google.ima.dai.api.CompanionAd
   5. google.ima.dai.api.CuePoint
   6. google.ima.dai.api.LiveStreamRequest
   7. google.ima.dai.api.StreamData
   8. google.ima.dai.api.StreamEvent
   9. google.ima.dai.api.StreamEvent.Type
   10. google.ima.dai.api.StreamManager
   11. google.ima.dai.api.StreamRequest
   12. google.ima.dai.api.VODStreamRequest
   13. google.ima.VERSION

Class google.ima.dai.api.Ad

เมธอด

getAdId, getAdPodInfo, getAdSystem, getAdvertiserName, getApiFramework, getCompanionAds, getCreativeAdId, getCreativeId, getDealId, getDescription, getDuration, getTitle, getVastMediaHeight, getVastMediaWidth, getWrapperAdIds, getWrapperAdSystems, getWrapperCreativeIds

คลาสที่แสดงออบเจ็กต์โฆษณาระหว่างการแทรกโฆษณาแบบไดนามิก คลาสนี้แสดงพร็อพเพอร์ตี้ย่อยของ ima.Ad

getAdId()

การคืนสินค้า string:

getAdPodInfo()

การคืนสินค้า google.ima.dai.api.AdPodInfo:

getAdSystem()

การคืนสินค้า string:

getAdvertiserName()

การคืนสินค้า string:

getApiFramework()

การคืนสินค้า string:

getCompanionAds()

การคืนสินค้า Array.<google.ima.dai.api.CompanionAd>:

getCreativeAdId()

การคืนสินค้า string:

getCreativeId()

การคืนสินค้า string:

getDealId()

การคืนสินค้า string:

getDescription()

การคืนสินค้า string:

getDuration()

การคืนสินค้า number:

getTitle()

การคืนสินค้า string:

getVastMediaHeight()

การคืนสินค้า number:

getVastMediaWidth()

การคืนสินค้า number:

getWrapperAdIds()

การคืนสินค้า Array.<string>:

getWrapperAdSystems()

การคืนสินค้า Array.<string>:

getWrapperCreativeIds()

การคืนสินค้า Array.<string>:

คลาส google.ima.dai.api.AdPodInfo

เมธอด

getAdPosition getMaxDuration getPodIndex getTimeOffset getTotalAds

คลาสที่แสดงออบเจ็กต์ข้อมูลพ็อดโฆษณาในระหว่างการแทรกโฆษณาแบบไดนามิก คลาสนี้จะแสดงพร็อพเพอร์ตี้ย่อยของ ima.AdPodInfo

getAdPosition()

การคืนสินค้า number:

getMaxDuration()

การคืนสินค้า number:

getPodIndex()

การคืนสินค้า number:

getTimeOffset()

การคืนสินค้า number:

getTotalAds()

การคืนสินค้า number:

Class google.ima.dai.api.AdProgressData

ฟิลด์

adBreakDuration, adPosition, currentTime, duration, totalAds

คลาสสำหรับระบุข้อมูลความคืบหน้าของโฆษณา

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

ชื่อ	ประเภท	คำอธิบาย
adBreakDuration
adPosition
currentTime
duration
totalAds

คลาส google.ima.dai.api.CompanionAd

เมธอด

getAdSlotId, getContent, getContentType, getHeight, getWidth

คลาสที่แสดงออบเจ็กต์โฆษณาที่แสดงร่วมระหว่างการแทรกโฆษณาแบบไดนามิก คลาสนี้จะแสดงพร็อพเพอร์ตี้ย่อยของ ima.CompanionAd

getAdSlotId()

การคืนสินค้า string:

getContent()

การคืนสินค้า string:

getContentType()

การคืนสินค้า string:

getHeight()

การคืนสินค้า number:

getWidth()

การคืนสินค้า number:

Class google.ima.dai.api.CuePoint

ฟิลด์

end, played, start

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

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

ชื่อ	ประเภท	คำอธิบาย
end		เวลาสิ้นสุดของคิวพอยต์นี้
played		หากเล่นคิวพอยต์นี้แล้ว
start		เวลาเริ่มต้นของคิวพอยต์นี้

Class google.ima.dai.api.LiveStreamRequest

ฟิลด์

assetKey

คลาสสำหรับระบุพร็อพเพอร์ตี้ของคำขอไลฟ์สด

Constructor:

พารามิเตอร์	ประเภท	คำอธิบาย
opt_liveStreamRequest	Object	ออบเจ็กต์ที่มีพร็อพเพอร์ตี้คำขอสตรีม อยู่แล้ว

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

ชื่อ	ประเภท	คำอธิบาย
assetKey		ซึ่งใช้เพื่อกำหนดว่าควรเล่นสตรีมใด คีย์ชิ้นงานของคำขอไลฟ์สดคือตัวระบุที่ดูได้ใน UI ของ DFP

Class google.ima.dai.api.StreamData

ฟิลด์

adProgressData, cuepoints, errorMessage, streamId, subtitles, url

คลาสสําหรับระบุข้อมูลสตรีม

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

ชื่อ	ประเภท	คำอธิบาย
adProgressData		ข้อมูลที่เกี่ยวข้องกับเวลาสำหรับโฆษณาที่กำลังเล่นอยู่
cuepoints		คิวพอยต์โฆษณาสําหรับสตรีมแบบออนดีมานด์ ซึ่งอาจเปลี่ยนแปลงได้เมื่อสตรีม ดำเนินไป ฟิลด์นี้จะสร้างขึ้นใน Listener เหตุการณ์สำหรับ CUEPOINTS_CHANGED AdEvent เท่านั้น
errorMessage
streamId
subtitles
url

Class google.ima.dai.api.StreamEvent

เมธอด

getAd getStreamData

ประเภทเหตุการณ์นี้จะได้รับการแจ้งเตือนจากตัวจัดการสตรีม เมื่อสถานะสตรีมมีการเปลี่ยนแปลง

getAd()

การคืนค่า google.ima.dai.api.Ad: คืนค่าออบเจ็กต์พร้อมข้อมูลโฆษณา

getStreamData()

การคืนค่า google.ima.dai.api.StreamData: คืนค่าออบเจ็กต์ที่มีข้อมูลสตรีม

Enum google.ima.dai.api.StreamEvent.Type

ฟิลด์

AD_BREAK_ENDED AD_BREAK_STARTED AD_PROGRESS CLICK COMPLETE CUEPOINTS_CHANGED ERROR FIRST_QUARTILE LOADED MIDPOINT STARTED STREAM_INITIALIZED THIRD_QUARTILE

รายการประเภทเหตุการณ์ที่ IMA SDK รองรับ

ค่า

ค่า	คำอธิบาย
AD_BREAK_ENDED	เริ่มทำงานเมื่อช่วงพักโฆษณาสิ้นสุด
AD_BREAK_STARTED	เริ่มทำงานเมื่อช่วงพักโฆษณาเริ่มต้น
AD_PROGRESS	เริ่มทำงานเมื่อมีการอัปเดตความคืบหน้าของโฆษณา
CLICK	เรียกใช้เมื่อมีการคลิกหรือแตะองค์ประกอบคลิกระหว่างที่โฆษณากำลังเล่น
COMPLETE	เริ่มทำงานเมื่อโฆษณาเล่นจบ
CUEPOINTS_CHANGED	ส่งสำหรับสตรีมแบบออนดีมานด์เมื่อคิวพอยต์มีการเปลี่ยนแปลง
ERROR	เริ่มทำงานเมื่อเกิดข้อผิดพลาด
FIRST_QUARTILE	เริ่มทำงานเมื่อโฆษณาเล่นถึงควอไทล์แรก
LOADED	เริ่มทำงานเมื่อมีไฟล์ Manifest ของสตรีม
MIDPOINT	เริ่มทำงานเมื่อโฆษณาเล่นถึงช่วงกลาง
STARTED	เริ่มทำงานเมื่อโฆษณาเริ่ม
STREAM_INITIALIZED	เริ่มทำงานเมื่อมีการเริ่มต้นสตรีม
THIRD_QUARTILE	เริ่มทำงานเมื่อโฆษณาเล่นไปจนถึงควอไทล์ที่ 3

Class google.ima.dai.api.StreamManager

เมธอด

contentTimeForStreamTime, onTimedMetadata, previousCuePointForStreamTime, processMetadata, requestStream, setClickElement, streamTimeForContentTime

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

Constructor:

พารามิเตอร์	ประเภท	คำอธิบาย
videoElement	HTMLVideoElement	องค์ประกอบวิดีโอเพลเยอร์จริง

contentTimeForStreamTime(streamTime)

แสดงเวลาของเนื้อหาที่ไม่มีโฆษณาสำหรับเวลาสตรีมที่ระบุ แสดงเวลาสตรีมที่ระบุสำหรับไลฟ์สด

ส่งคืน number: เวลาของเนื้อหาที่สอดคล้องกับเวลาของสตรีมที่ระบุ เมื่อนำโฆษณาออกแล้ว

พารามิเตอร์	ประเภท	คำอธิบาย
streamTime	number	เวลาสตรีมที่มีโฆษณาแทรก (เป็นวินาที)

onTimedMetadata(metadata)

ส่งในพจนานุกรมของข้อมูลเมตาที่ประมวลผลแล้ว พจนานุกรมคาดหวังคีย์ "TXXX" ที่มีสตริงข้อมูลเมตาที่ผู้ใช้กำหนดเป็นค่า หากเพลเยอร์แสดงข้อมูลเมตาแบบดิบ ให้เรียกใช้ ima.dai.api.StreamManager.processMetadataแทน

พารามิเตอร์	ประเภท	คำอธิบาย
metadata	Object	พจนานุกรมของข้อมูลเมตา

previousCuePointForStreamTime(streamTime)

แสดงผลคิวพอยต์ก่อนหน้าสำหรับเวลาสตรีมที่ระบุ แสดงผล Null หากไม่มี คิวพอยต์ดังกล่าว ใช้เพื่อติดตั้งใช้งานฟีเจอร์ต่างๆ เช่น การย้อนกลับ และ เรียกใช้เมื่อผู้เผยแพร่โฆษณาทราบว่าผู้ใช้กรอวิดีโอเพื่อกลับไป ยังช่วงพักโฆษณา

คืนค่า google.ima.dai.api.CuePoint: คิวพอยต์ก่อนหน้าสำหรับเวลาสตรีมที่ระบุ

พารามิเตอร์	ประเภท	คำอธิบาย
streamTime	number	เวลาสตรีมที่ผู้ใช้เลื่อนไป

processMetadata(type, data, timestamp)

ประมวลผลข้อมูลเมตาที่กำหนดเวลาสำหรับไลฟ์สด ใช้ในกรณีที่วิดีโอเพลเยอร์มี ข้อมูลเมตาที่ยังไม่ได้แยกวิเคราะห์พร้อมกับการประทับเวลา มิฉะนั้น ให้เรียกใช้ ima.dai.api.StreamManager.onTimedMetadata

พารามิเตอร์	ประเภท	คำอธิบาย
type	string	ประเภทสำหรับข้อมูลเมตา ต้องเป็น "ID3"
data	Uint8Array	ข้อมูลแท็กดิบ สำหรับ ID3 ต้องเป็นแท็กทั้งหมด
timestamp	number	เวลาที่ควรประมวลผลข้อมูล

requestStream(streamRequest)

ขอให้โหลดสตรีมโดยใช้พารามิเตอร์ของสตรีมที่ระบุ

พารามิเตอร์	ประเภท	คำอธิบาย
streamRequest	google.ima.dai.api.StreamRequest	มีพารามิเตอร์สำหรับโหลด ข้อมูลเมตาของสตรีม

setClickElement(clickElement)

ตั้งค่าองค์ประกอบการคลิกผ่านโฆษณา องค์ประกอบนี้ใช้เป็นตัวรับการคลิกหรือแตะ ขณะที่โฆษณากำลังเล่น และอาจทําให้เกิดการนําทางออกจาก หน้าปัจจุบัน

พารามิเตอร์	ประเภท	คำอธิบาย
clickElement	Element	องค์ประกอบที่ใช้เป็นการคลิกผ่านโฆษณา

streamTimeForContentTime(contentTime)

แสดงเวลาสตรีมที่มีโฆษณาสำหรับเวลาเนื้อหาที่ระบุ แสดงผลเวลาเนื้อหาที่ระบุสำหรับไลฟ์สด

การคืนค่า number: เวลาสตรีมที่สอดคล้องกับเวลาเนื้อหาที่ระบุ เมื่อมีการแทรกโฆษณา

พารามิเตอร์	ประเภท	คำอธิบาย
contentTime	number	เวลาของเนื้อหาที่ไม่มีโฆษณา (เป็นวินาที)

Class google.ima.dai.api.StreamRequest

ฟิลด์

adTagParameters, apiKey, streamActivityMonitorId

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

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

ชื่อ	ประเภท	คำอธิบาย
adTagParameters		คุณลบล้างพารามิเตอร์แท็กโฆษณาแบบจำกัดในคำขอสตรีมได้ จัดเตรียมพารามิเตอร์การกำหนดเป้าหมายไปยังสตรีมของคุณจะให้ข้อมูลเพิ่มเติม คุณใช้พารามิเตอร์ dai-ot และ dai-ov เพื่อกำหนดค่ากำหนดตัวแปรของสตรีมได้ ดูข้อมูลเพิ่มเติมได้ที่ ลบล้างพารามิเตอร์ตัวแปรสตรีม
apiKey		คีย์ API ของคำขอสตรีม โดยกำหนดค่าผ่าน UI ผู้ดูแลระบบ DFP และมอบให้ผู้เผยแพร่โฆษณาเพื่อปลดล็อกเนื้อหา โดยจะตรวจสอบแอปพลิเคชันที่พยายามเข้าถึงเนื้อหา
streamActivityMonitorId		รหัสที่จะใช้ในการแก้ไขข้อบกพร่องของสตรีมด้วยเครื่องมือตรวจสอบกิจกรรมการสตรีม ใช้เพื่ออำนวยความสะดวกให้ผู้เผยแพร่โฆษณาค้นหาบันทึกสตรีมในเครื่องมือตรวจสอบกิจกรรมการสตรีม

Class google.ima.dai.api.VODStreamRequest

ฟิลด์

contentSourceId, videoId

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

Constructor:

พารามิเตอร์	ประเภท	คำอธิบาย
opt_VODStreamRequest	Object	ออบเจ็กต์ที่มีการกำหนดพร็อพเพอร์ตี้ คำขอสตรีมอยู่แล้ว

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

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

ค่าคงที่ google.ima.VERSION

สตริงที่มีเวอร์ชันเต็มของ SDK