google. ima
เนมสเปซ google.ima
ให้สิทธิ์เข้าถึงคลาส อินเทอร์เฟซ การแจงนับ และพร็อพเพอร์ตี้ของ SDK
ชั้นเรียน
โฆษณา
คลาสของโฆษณาที่ขยายโดยคลาสที่แทนโฆษณาประเภทต่างๆ
จุดอ้างอิง
รายการจุดเริ่มโฆษณาแสดงถึงกําหนดการของช่วงพักโฆษณา โปรดทราบว่าโฆษณาแต่ละรายการในช่วงพักโฆษณาจะไม่รวมอยู่ในกําหนดการ
คอนเทนเนอร์แบบดิสเพลย์
คลาสนี้แสดงถึงคอนเทนเนอร์สําหรับการแสดงโฆษณา SDK จะสร้างโครงสร้างภายในพารามิเตอร์ containerElement โดยอัตโนมัติเพื่อจัดเก็บโฆษณาวิดีโอและโฆษณาซ้อนทับ
เมื่อสร้างอินสแตนซ์ของคลาสนี้แล้ว ระบบจะสร้าง IFRAME ใน containerElement และโหลดแกน SDK คุณต้องเก็บรักษา IFRAME นี้เพื่อให้ SDK ทํางานได้อย่างถูกต้อง เมื่อมีการเล่นโฆษณาทั้งหมดและไม่จําเป็นต้องใช้ SDK แล้ว ให้ใช้เมธอด destroy()
เพื่อยกเลิกการโหลด SDK
พารามิเตอร์ containerElement ต้องเป็นองค์ประกอบที่เป็นส่วนหนึ่งของ DOM คุณต้องวาง ContainerElement ให้ถูกต้องเพื่อให้โฆษณาแสดงได้อย่างถูกต้อง ขอแนะนําให้จัดตําแหน่งไว้ที่ด้านบนของโปรแกรมเล่นวิดีโอเนื้อหา และกําหนดขนาดให้ครอบคลุมโปรแกรมเล่นวิดีโอทั้งหมด โปรดดูเอกสาร SDK สําหรับรายละเอียดเกี่ยวกับการใช้งานที่แนะนํา
หมายเหตุ: คุณจําเป็นต้องเรียกใช้เมธอด initialize()
ในโค้ดที่เรียกใช้โดยการกระทําของผู้ใช้โดยตรง (เช่น การคลิกหรือแตะ)
ข้อผิดพลาดโฆษณา
AdError จะแสดงข้อมูลแก่ผู้ใช้ว่าเกิดความล้มเหลวขึ้นในระหว่างการโหลดหรือการเล่นโฆษณา ตัวเข้าถึง errorType จะให้ข้อมูลว่าเกิดข้อผิดพลาดระหว่างการโหลดโฆษณาหรือการเล่นโฆษณาหรือไม่
AdErrorEvent
เหตุการณ์นี้เกิดขึ้นเมื่อเกิดข้อผิดพลาดขณะโหลดโฆษณาจาก เซิร์ฟเวอร์ของ Google หรือ DoubleClick ประเภทที่ลงทะเบียนได้สําหรับกิจกรรม ได้แก่ AdsLoader และ AdsManager
AdEvent
เหตุการณ์นี้จะเพิ่มโดยโฆษณาเป็นการแจ้งเตือนเมื่อ สถานะโฆษณาเปลี่ยนแปลงและเมื่อผู้ใช้โต้ตอบกับโฆษณา ตัวอย่างเช่น เมื่อโฆษณาเริ่มเล่น มีการคลิก และอื่นๆ คุณลงทะเบียนในกิจกรรมที่มีการเปลี่ยนแปลงสถานะต่างๆ ได้ใน AdsManager
เหตุการณ์ AdMetadata
คลาสนี้เลิกใช้แล้ว ใช้ AdsManager.getCuePoints() API เหตุการณ์โฆษณาที่เฉพาะเจาะจงที่มีข้อมูลเมตา
AdPodInfo
โฆษณาอาจเป็นส่วนหนึ่งของพ็อดโฆษณา ออบเจ็กต์นี้จะแสดงข้อมูลเมตาที่เกี่ยวข้องกับพ็อดนั้น เช่น จํานวนโฆษณาในพ็อดและตําแหน่งโฆษณาในพ็อด
API ของ getTotalAds
ที่อยู่ภายในออบเจ็กต์นี้มักถูกต้อง แต่ในบางสถานการณ์ API ดังกล่าวจะแสดงการคาดเดาที่ดีที่สุดของ SDK ดูข้อมูลเพิ่มเติมได้ในเอกสารประกอบของวิธีการนั้น
AdProgressData
ออบเจ็กต์นี้จะแสดงข้อมูลเกี่ยวกับความคืบหน้าปัจจุบันขณะที่โฆษณากําลังเล่น
AdsLoader
AdsLoader ช่วยให้ลูกค้าขอโฆษณาจากเซิร์ฟเวอร์โฆษณาได้ โดยผู้ใช้ต้องลงทะเบียนสําหรับเหตุการณ์ AdsManagerLoadedEvent แล้วขอโฆษณา
AdsManager
ให้ API สาธารณะภายนอกแก่ผู้เผยแพร่โฆษณาและสื่อสารกับอินสแตนซ์ภายในของตัวจัดการโฆษณา
เหตุการณ์ AdsManagerLoaded
เหตุการณ์นี้จะเกิดขึ้นเมื่อโหลดโฆษณาจากเซิร์ฟเวอร์โฆษณาของ Google หรือ DoubleClick ผ่าน AdsLoader สําเร็จ คุณสามารถลงทะเบียนกิจกรรมนี้ใน AdsLoader ได้
AdsRenderingSettings
กําหนดพารามิเตอร์ที่ควบคุมการแสดงโฆษณา
AdsRequest
คลาสสําหรับการระบุพร็อพเพอร์ตี้ของคําขอโฆษณา
โฆษณาที่แสดงร่วม
แสดงโฆษณาที่แสดงร่วม
การตั้งค่าโฆษณาที่แสดงร่วมจากโฆษณา
ออบเจ็กต์ CompanionAdSelectionSettings ใช้เพื่อกําหนดเกณฑ์การเลือกเมื่อเรียกใช้ฟังก์ชัน ima.Ad.getCompanionAds
การตั้งค่า ImaSdk
คลาสนี้มีการตั้งค่าแบบ SDK ทั้งหมด
ข้อมูลโฆษณาสากล
ออบเจ็กต์นี้จะแสดงข้อมูลเกี่ยวกับรหัสโฆษณาสากลที่เชื่อมโยงกับครีเอทีฟโฆษณา รวมถึงค่ารหัสโฆษณาและรีจิสทรีรหัสโฆษณา
แจกแจง
โหมดการเข้าถึงระดับกลาง
สตริง
โหมดการเข้าถึงที่พร้อมใช้งานสําหรับ OMID สําหรับเว็บ ซึ่งจะควบคุมจํานวนสคริปต์การยืนยันที่เข้าถึงได้
ค่า |
|
---|---|
ถูกจํากัด |
สคริปต์การยืนยันจะอยู่ในแซนด์บ็อกซ์และเข้าถึงครีเอทีฟโฆษณาหรือหน้าผู้เผยแพร่โฆษณาไม่ได้ แต่จะยืนยันโดยตรงไม่ได้ว่าโดเมนนี้เป็นโดเมนของผู้เผยแพร่โฆษณาใด |
โดเมน |
สคริปต์การยืนยันจะอยู่ในแซนด์บ็อกซ์และเข้าถึงครีเอทีฟโฆษณาหรือหน้า ผู้เผยแพร่โฆษณาไม่ได้ อย่างไรก็ตาม สคริปต์จะโหลดด้วยวิธีที่สามารถยืนยันโดเมนผู้เผยแพร่โฆษณานั้นได้โดยตรง |
เต็มแล้ว |
สคริปต์การยืนยันมีสิทธิ์เข้าถึงครีเอทีฟโฆษณาและหน้าผู้เผยแพร่โฆษณาโดยตรง |
OmidVerificationVendor
ตัวเลข
ระบุผู้ให้บริการยืนยัน OMID รายชื่อผู้ให้บริการแสดงตามลําดับตัวอักษร
ค่า |
|
---|---|
แหล่งที่มา |
|
ซ้ําซ้อน |
|
|
|
วิทยาศาสตร์ข้อมูลIntegral_AD_S |
|
เมทริกซ์ |
|
MOAT |
|
นีลเซน |
|
Pixelate |
|
อื่นๆ |
ผู้ให้บริการเริ่มต้นที่จะใช้เมื่อ URL ของสคริปต์ไม่ตรงกับผู้ให้บริการรายอื่น |
องค์ประกอบ UI
สตริง
ระบุองค์ประกอบ UI ต่างๆ ที่กําหนดค่าให้แสดงหรือซ่อนได้ ระบบอาจไม่สนใจการตั้งค่าเหล่านี้สําหรับโฆษณา AdSense และ ADX
ค่า |
|
---|---|
การระบุแหล่งที่มาโฆษณา |
แสดงข้อความ "โฆษณา" ใน UI ของโฆษณา ต้องมีเพื่อแสดงนาฬิกานับเวลาถอยหลัง |
COUNTDOWN |
การระบุแหล่งที่มานับถอยหลังต้องระบุการระบุแหล่งที่มาของโฆษณาเพื่อให้แสดงการนับถอยหลังได้ ต้องมีทั้ง |
โหมดมุมมอง
สตริง
การระบุโหมดการดู VPAID แบบต่างๆ สําหรับโฆษณา
ค่า |
|
---|---|
ปกติ |
โหมดมุมมองโฆษณาปกติ |
เต็มหน้าจอ |
โหมดการดูโฆษณาแบบเต็มหน้าจอ บ่งบอกว่าผู้จัดการโฆษณาเห็นว่า การจัดวาง AdDisplayContainer ในปัจจุบันเป็นแบบเต็มหน้าจอ (เช่น การจําลองแบบเต็มหน้าจอ) การดําเนินการนี้จะไม่ทําให้ผู้จัดการโฆษณาเข้าสู่ โหมดเต็มหน้าจอ |
- เลิกใช้
พร็อพเพอร์ตี้
โหมดการเข้าถึงระดับกลาง
สตริง
โหมดการเข้าถึงที่พร้อมใช้งานสําหรับ OMID สําหรับเว็บ ซึ่งจะควบคุมจํานวนสคริปต์การยืนยันที่เข้าถึงได้
ค่า |
|
---|---|
ถูกจํากัด |
สคริปต์การยืนยันจะอยู่ในแซนด์บ็อกซ์และเข้าถึงครีเอทีฟโฆษณาหรือหน้าผู้เผยแพร่โฆษณาไม่ได้ แต่จะยืนยันโดยตรงไม่ได้ว่าโดเมนนี้เป็นโดเมนของผู้เผยแพร่โฆษณาใด |
โดเมน |
สคริปต์การยืนยันจะอยู่ในแซนด์บ็อกซ์และเข้าถึงครีเอทีฟโฆษณาหรือหน้า ผู้เผยแพร่โฆษณาไม่ได้ อย่างไรก็ตาม สคริปต์จะโหลดด้วยวิธีที่สามารถยืนยันโดเมนผู้เผยแพร่โฆษณานั้นได้โดยตรง |
เต็มแล้ว |
สคริปต์การยืนยันมีสิทธิ์เข้าถึงครีเอทีฟโฆษณาและหน้าผู้เผยแพร่โฆษณาโดยตรง |
OmidVerificationVendor
ตัวเลข
ระบุผู้ให้บริการยืนยัน OMID รายชื่อผู้ให้บริการแสดงตามลําดับตัวอักษร
ค่า |
|
---|---|
แหล่งที่มา |
|
ซ้ําซ้อน |
|
|
|
วิทยาศาสตร์ข้อมูลIntegral_AD_S |
|
เมทริกซ์ |
|
MOAT |
|
นีลเซน |
|
Pixelate |
|
อื่นๆ |
ผู้ให้บริการเริ่มต้นที่จะใช้เมื่อ URL ของสคริปต์ไม่ตรงกับผู้ให้บริการรายอื่น |
องค์ประกอบ UI
สตริง
ระบุองค์ประกอบ UI ต่างๆ ที่กําหนดค่าให้แสดงหรือซ่อนได้ ระบบอาจไม่สนใจการตั้งค่าเหล่านี้สําหรับโฆษณา AdSense และ ADX
ค่า |
|
---|---|
การระบุแหล่งที่มาโฆษณา |
แสดงข้อความ "โฆษณา" ใน UI ของโฆษณา ต้องมีเพื่อแสดงนาฬิกานับเวลาถอยหลัง |
COUNTDOWN |
การระบุแหล่งที่มานับถอยหลังต้องระบุการระบุแหล่งที่มาของโฆษณาเพื่อให้แสดงการนับถอยหลังได้ ต้องมีทั้ง |
โหมดมุมมอง
สตริง
การระบุโหมดการดู VPAID แบบต่างๆ สําหรับโฆษณา
ค่า |
|
---|---|
ปกติ |
โหมดมุมมองโฆษณาปกติ |
เต็มหน้าจอ |
โหมดการดูโฆษณาแบบเต็มหน้าจอ บ่งบอกว่าผู้จัดการโฆษณาเห็นว่า การจัดวาง AdDisplayContainer ในปัจจุบันเป็นแบบเต็มหน้าจอ (เช่น การจําลองแบบเต็มหน้าจอ) การดําเนินการนี้จะไม่ทําให้ผู้จัดการโฆษณาเข้าสู่ โหมดเต็มหน้าจอ |
- เลิกใช้
การตั้งค่า
ImaSdkSettings ที่ไม่เป็นค่าว่าง
อินสแตนซ์การตั้งค่า Single Global Global Settings