คลาส: AdsManager

google.imaAds Manager

class คงที่

ให้ API สาธารณะภายนอกไปยังผู้เผยแพร่โฆษณาและสื่อสารกับอินสแตนซ์ภายในของตัวจัดการโฆษณา

วิธีการ

ยุบ

ยุบ()

ยุบโฆษณาปัจจุบัน ซึ่งไม่ใช่ HTML5 SDK

กําหนดค่าAdsAds

ConfigureAdsManager(content, adsRenderingSettings)

ตั้งค่าพารามิเตอร์ที่จําเป็นสําหรับการอ้างอิง Ad Manager นี้จากเหตุการณ์ AdsManagerLoaded

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

ทำลาย

ทําลาย()

นําชิ้นงานโฆษณาที่โหลดขณะรันไทม์ออก ซึ่งจําเป็นต้องนําออกอย่างถูกต้องเมื่อมีโฆษณาจบและหยุดโฆษณาและการติดตามทั้งหมด

ทิ้งช่วงพักโฆษณา

ทิ้งช่วงพักโฆษณา()

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

ขยาย

ขยาย()

ขยายโฆษณาปัจจุบัน ซึ่งไม่ใช่ HTML5 SDK

โฟกัส

โฟกัส()

โฟกัสที่ปุ่มข้าม (หากมี) หากไม่มีโฟกัส ให้โฟกัสที่องค์ประกอบแบบอินเทอร์แอกทีฟ ซึ่งรวมถึงไอคอนหรือครีเอทีฟโฆษณาแบบอินเทอร์แอกทีฟ

รับสถานะโฆษณาที่ข้ามได้

getAdข้ามได้State() ส่งคืนบูลีน

แสดงผลค่าจริงหากข้ามโฆษณาได้ในปัจจุบัน เมื่อค่านี้มีการเปลี่ยนแปลง AdsManager จะทําให้เหตุการณ์ AdEvent.SKIPPABLE_STATE_CHANGED เริ่มทํางาน

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

boolean จริง หากข้ามโฆษณาปัจจุบันได้ เป็นเท็จ หากเป็นเท็จ

รับ PointCue

getCuePoints() แสดงผลอาร์เรย์ของจํานวน

แสดงผลอาร์เรย์ของออฟเซ็ตเป็นวินาทีที่จะระบุช่วงพักโฆษณาที่ตั้งเวลา โฆษณาตอนต้นจะแสดงด้วย 0 และโฆษณาตอนท้ายจะแสดงด้วย -1 อาร์เรย์ที่ว่างเปล่าบ่งบอกว่าโฆษณาหรือพ็อดโฆษณาไม่มีกําหนดเวลาและจะเล่นได้ทุกเมื่อ

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

non-null Array of number รายการการชดเชยเวลาเป็นวินาที

ดูเวลาที่เหลือ

ตัวเลขที่แสดงผล getRemainingTime()

รับเวลาที่เหลือของโฆษณาปัจจุบันที่เล่นอยู่ หากโฆษณายังไม่ได้โหลดหรือเล่นเสร็จแล้ว API จะแสดงผล -1

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

number แสดงเวลาที่เหลือสําหรับโฆษณาปัจจุบัน หากไม่ได้กําหนดเวลาที่เหลือสําหรับโฆษณาปัจจุบัน (เช่น โฆษณาที่กําหนดเอง) ค่าจะแสดงผลเป็น -1

GetVolume

หมายเลขส่งกลับ getVolume()

ดูปริมาณของโฆษณาปัจจุบัน

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

number ระดับเสียงของโฆษณาปัจจุบันจาก 0 (ปิดเสียง) เป็น 1 (ดังที่สุด)

init

init(width, height, viewMode, videoElement)

เรียกใช้ init เพื่อเริ่มต้นประสบการณ์การใช้งานโฆษณาในตัวจัดการโฆษณา

พารามิเตอร์
ความกว้าง	number ความกว้างที่เลือกของโฆษณา
ส่วนสูง	number ความสูงที่เลือกของโฆษณา
โหมดมุมมอง	โหมดมุมมอง โหมดมุมมองที่เลือก ค่าต้องไม่เป็นค่าว่าง
องค์ประกอบวิดีโอ	ไม่บังคับ องค์ประกอบ HTMLHTML องค์ประกอบวิดีโอสําหรับการเล่นที่กําหนดเอง องค์ประกอบวิดีโอนี้จะลบล้างองค์ประกอบที่ระบุไว้ในเครื่องมือสร้าง AdDisplayContainer ใช้พร็อพเพอร์ตี้นี้เมื่อจําเป็นจริงๆ เท่านั้น มิเช่นนั้น เราขอแนะนําให้ระบุองค์ประกอบวิดีโอนี้ขณะสร้าง AdDisplayContainer ค่าอาจเป็นค่าว่างได้

เป็นการติดตามการคลิกที่กําหนดเองที่ใช้

isCustomClickTrackingUsed() แสดงผลบูลีน

แสดงค่า "จริง" หากมีการใช้องค์ประกอบการติดตามการคลิกที่กําหนดเองสําหรับการติดตามการคลิกในโฆษณาปัจจุบัน ระบบจะใช้การติดตามการคลิกที่กําหนดเองเมื่อให้องค์ประกอบการติดตามการคลิกที่ไม่บังคับแก่ AdDisplayContainer เท่านั้น มีการใช้การเล่นที่กําหนดเอง และโฆษณาปัจจุบันไม่ใช่โฆษณา AdSense/AdX

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

boolean กําหนดว่าจะใช้การติดตามการคลิกที่กําหนดเองหรือไม่

ใช้งานการเล่นที่กําหนดเอง

isCustomPlaybackUsed() แสดงผลบูลีน

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

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

boolean กําหนดว่าจะใช้การเล่นที่กําหนดเองหรือไม่

หยุดชั่วคราว

หยุดชั่วคราว()

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

ปรับขนาด

ปรับขนาด(กว้าง สูง มุมมอง)

ปรับขนาดโฆษณาปัจจุบัน

พารามิเตอร์
ความกว้าง	number ความกว้างของช่องโฆษณาใหม่
ส่วนสูง	number ความสูงของช่องโฆษณาใหม่
โหมดมุมมอง	โหมดมุมมอง โหมดมุมมองใหม่ ค่าต้องไม่เป็นค่าว่าง

ฟังต่อ

เล่นต่อ()

กลับมาใช้โฆษณาปัจจุบันที่โหลดและหยุดชั่วคราวต่อไป ฟังก์ชันนี้จะไม่ใช่แบบ No-po เมื่อแสดงการวางซ้อนแบบคงที่ หรือหากโฆษณายังไม่ได้โหลดหรือเล่นเสร็จแล้ว

ตั้งระดับเสียง

setVolume(Volume)

ตั้งค่าระดับเสียงของโฆษณาปัจจุบัน

พารามิเตอร์
ระดับเสียง	number ระดับเสียงที่ตั้งไว้ตั้งแต่ 0 (ปิดเสียง) ถึง 1 (ดังที่สุด)

skip

ข้าม()

ข้ามโฆษณาปัจจุบันเมื่อ AdsManager.getAdSkippableState() เป็นจริง เมื่อมีการเรียกใช้ภายใต้สถานการณ์อื่น การข้ามจะไม่มีผลใดๆ หลังจากที่ข้ามเสร็จ AdsManager จะทําให้เหตุการณ์ AdEvent.SKIPPED เริ่มทํางาน

เริ่มต้น

เริ่มต้น()

เริ่มเล่นโฆษณา

นักพัฒนาแอปต้องโทรหา AdDisplayContainer.initialize() ก่อน

หยุด

หยุด()

หยุดโฆษณา การเรียกนี้จะทําให้ผู้เผยแพร่โฆษณากลับมาที่เนื้อหา

อัปเดตการตั้งค่าโฆษณา

อัปเดต AdsAdsingSettings(adsRenderingSettings)

อัปเดตการตั้งค่าการแสดงโฆษณา ควรใช้สําหรับ Use Case ของ VMAP ระหว่างช่วงพักโฆษณาโดยเฉพาะเมื่อต้องอัปเดตการตั้งค่าการแสดงโฆษณา เช่น อัตราบิต

พารามิเตอร์
การตั้งค่าโฆษณาแสดงผล	การตั้งค่าโฆษณา การตั้งค่าการแสดงโฆษณาที่อัปเดต ค่าต้องไม่เป็นค่าว่าง