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

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

เมธอด

getAdId, getAdPodInfo, getAdSystem, getAdvertiserName, getApiFramework, getCompanionAds, getCreativeAdId, getCreativeId, getDealId{/17, getApiFramework,getDescriptiongetDurationgetTitlegetVastMediaHeightgetVastMediaWidthgetWrapperAdIdsgetWrapperAdSystemsgetWrapperCreativeIds

คลาสที่แสดงถึงออบเจ็กต์โฆษณาระหว่างการแทรกโฆษณาแบบไดนามิก คลาสนี้จะแสดงพร็อพเพอร์ตี้ 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:

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

ช่อง

adBreakDuration, adPosition, currentTime, duration, totalAds

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

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

ชื่อ	Type	คำอธิบาย
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:

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

ช่อง

end, เล่นแล้ว, start

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

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

ชื่อ	Type	คำอธิบาย
end		เวลาสิ้นสุดสำหรับจุดเริ่มโฆษณานี้
played		หากมีการเล่นจุดเริ่มโฆษณานี้
start		เวลาเริ่มต้นสำหรับจุดเริ่มโฆษณานี้

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

ช่อง

assetKey

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

เครื่องมือสร้าง:

พารามิเตอร์	Type	คำอธิบาย
opt_liveStreamRequest	Object	ที่ได้กำหนดพร็อพเพอร์ตี้คำขอสตรีมไว้แล้ว

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

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

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

ช่อง

adProgressData, จุดเริ่มโฆษณา, errorMessage, streamId, คำบรรยาย, url

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

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

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

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

เมธอด

getAd, getStreamData

เหตุการณ์ประเภทนี้เพิ่มโดยผู้จัดการสตรีมเป็นการแจ้งเตือนเมื่อสถานะของสตรีมเปลี่ยนไป

getAd()

แสดงผล google.ima.dai.api.Ad: แสดงผลออบเจ็กต์ที่มีข้อมูลโฆษณา

getStreamData()

แสดงผล google.ima.dai.api.StreamData: แสดงผลออบเจ็กต์ที่มีข้อมูลสตรีม

แจกแจง google.ima.dai.api.StreamEvent.Type

ช่อง

AD_BREAK_ENDED, AD_BREAK_STARTED, AD_PROGRESS, คลิก, COMPLETE, CUEPOINTS_CHANGED, ข้อผิดพลาด, FIRST_QUARTILE, LOADED,LOADED LOADED MIDPOINTSTREAM_INITIALIZEDTHIRD_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

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

เมธอด

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

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

เครื่องมือสร้าง:

พารามิเตอร์	Type	คำอธิบาย
videoElement	HTMLVideoElement	องค์ประกอบจริงของโปรแกรมเล่นวิดีโอ

contentTimeForStreamTime(streamTime)

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

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

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

onTimedMetadata(metadata)

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

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

previousCuePointForStreamTime(streamTime)

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

แสดงผล google.ima.dai.api.CuePoint: จุดเริ่มโฆษณาก่อนหน้าสำหรับเวลาสตรีมที่ระบุ

พารามิเตอร์	Type	คำอธิบาย
streamTime	number	เวลาที่ต้องการสตรีม

processMetadata(type, data, timestamp)

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

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

requestStream(streamRequest)

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

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

setClickElement(clickElement)

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

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

streamTimeForContentTime(contentTime)

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

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

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

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

ช่อง

adTagParameters, apiKey, streamActivityMonitorId

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

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

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

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

ช่อง

contentSourceId, videoId

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

เครื่องมือสร้าง:

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

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

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

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

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