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

Class 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

Class 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

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

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

ชื่อ	ประเภท	คำอธิบาย
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 รวมถึงจัดการการติดตาม Ping รวมถึงส่งต่อสตรีมและเหตุการณ์โฆษณาไปยังผู้เผยแพร่โฆษณา ตัวแฮนเดิลนี้ไม่ได้รับค่ามาจาก 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 ของคําขอสตรีม โดยกำหนดค่าผ่าน Admin UI ของ DFP และมอบให้ผู้เผยแพร่โฆษณาเพื่อปลดล็อกเนื้อหา โดยจะยืนยันแอปพลิเคชันที่พยายามเข้าถึงเนื้อหา
streamActivityMonitorId		รหัสที่จะใช้แก้ไขข้อบกพร่องของสตรีมด้วยเครื่องมือตรวจสอบกิจกรรมการสตรีม ข้อมูลนี้ใช้เพื่อให้ผู้เผยแพร่โฆษณาค้นหาบันทึกสตรีมในเครื่องมือตรวจสอบกิจกรรมการสตรีมได้อย่างสะดวก

Class google.ima.dai.api.VODStreamRequest

ฟิลด์

contentSourceId, videoId

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

Constructor:

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

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

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

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

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