google. ima ImaSdkSettings
ชั้นเรียนนี้มีการตั้งค่าทั้ง SDK
การแจกแจง
โหมดแยกหน้าจอประชุมที่ใช้ร่วมกัน
สตริง
กําหนดค่าคงที่สําหรับการตั้งค่าโฆษณาทดแทนที่แสดงร่วม การตั้งค่านี้ระบุว่าโฆษณาที่แสดงร่วมควรได้รับทดแทนในสถานการณ์ต่างๆ หรือไม่
หากค่าเป็น ALWAYS
ระบบจะพยายามใช้โฆษณาทดแทนที่แสดงร่วมกันในทุกสถานการณ์ แม้ว่าจะไม่มีโฆษณาหลักกลับมาก็ตาม
หากค่าคือ ON_MASTER_AD
ระบบจะพยายามโฆษณาทดแทนร่วมหากมีโฆษณาหลักที่มีโฆษณาที่แสดงร่วมน้อยกว่าช่องโฆษณาที่แสดงร่วม ครีเอทีฟโฆษณาที่แสดงร่วมที่หายไปจะได้รับการทดแทน
ค่าเริ่มต้นคือ ALWAYS
... let slot1 = googletag.defineSlot('/1234/adunit', [300, 250], 'slot-div'); slot1.addService(googletag.companionAds()).addService(googletag.pubads()); ... googletag.companionAds().setRefreshUnfilledSlots(true); ... googletag.enableServices();สําหรับวิดีโอที่เล่นอัตโนมัติ ขอแนะนําให้ทําการเปลี่ยนแปลงเพิ่มเติมต่อไปนี้เพื่อป้องกันไม่ให้ช่องโฆษณาที่แสดงร่วมโหลดล่วงหน้า แล้วแทนที่ด้วยโฆษณาที่แสดงร่วมทันที
googletag.pubads().disableInitialLoad(); ... googletag.enableServices();
ค่า |
|
---|---|
ทุกครั้ง |
|
เปิดอยู่ |
โหมด VPAID
number
ชุดค่าคงที่สําหรับการเปิดใช้ฟังก์ชัน VPAID
ค่า |
|
---|---|
ปิดใช้อยู่ |
โฆษณา VPAID จะไม่เล่น และจะแสดงข้อผิดพลาด |
เปิดใช้ |
โฆษณา VPAID เปิดใช้งานโดยใช้ iframe ข้ามโดเมน โฆษณา VPAID ไม่สามารถเข้าถึงเว็บไซต์ โฆษณา VPAID ที่อาศัยการเข้าถึง Friendly iframe อาจเกิดข้อผิดพลาด นี่คือค่าเริ่มต้น |
รักษาความปลอดภัย |
เปิดใช้โฆษณา VPAID โดยใช้ Friendly iframe ซึ่งจะทําให้โฆษณาเข้าถึงเว็บไซต์ผ่าน JavaScript ได้ |
พร็อพเพอร์ตี้
โหมดแยกหน้าจอประชุมที่ใช้ร่วมกัน
สตริง
กําหนดค่าคงที่สําหรับการตั้งค่าโฆษณาทดแทนที่แสดงร่วม การตั้งค่านี้ระบุว่าโฆษณาที่แสดงร่วมควรได้รับทดแทนในสถานการณ์ต่างๆ หรือไม่
หากค่าเป็น ALWAYS
ระบบจะพยายามใช้โฆษณาทดแทนที่แสดงร่วมกันในทุกสถานการณ์ แม้ว่าจะไม่มีโฆษณาหลักกลับมาก็ตาม
หากค่าคือ ON_MASTER_AD
ระบบจะพยายามโฆษณาทดแทนร่วมหากมีโฆษณาหลักที่มีโฆษณาที่แสดงร่วมน้อยกว่าช่องโฆษณาที่แสดงร่วม ครีเอทีฟโฆษณาที่แสดงร่วมที่หายไปจะได้รับการทดแทน
ค่าเริ่มต้นคือ ALWAYS
... let slot1 = googletag.defineSlot('/1234/adunit', [300, 250], 'slot-div'); slot1.addService(googletag.companionAds()).addService(googletag.pubads()); ... googletag.companionAds().setRefreshUnfilledSlots(true); ... googletag.enableServices();สําหรับวิดีโอที่เล่นอัตโนมัติ ขอแนะนําให้ทําการเปลี่ยนแปลงเพิ่มเติมต่อไปนี้เพื่อป้องกันไม่ให้ช่องโฆษณาที่แสดงร่วมโหลดล่วงหน้า แล้วแทนที่ด้วยโฆษณาที่แสดงร่วมทันที
googletag.pubads().disableInitialLoad(); ... googletag.enableServices();
ค่า |
|
---|---|
ทุกครั้ง |
|
เปิดอยู่ |
โหมด VPAID
number
ชุดค่าคงที่สําหรับการเปิดใช้ฟังก์ชัน VPAID
ค่า |
|
---|---|
ปิดใช้อยู่ |
โฆษณา VPAID จะไม่เล่น และจะแสดงข้อผิดพลาด |
เปิดใช้ |
โฆษณา VPAID เปิดใช้งานโดยใช้ iframe ข้ามโดเมน โฆษณา VPAID ไม่สามารถเข้าถึงเว็บไซต์ โฆษณา VPAID ที่อาศัยการเข้าถึง Friendly iframe อาจเกิดข้อผิดพลาด นี่คือค่าเริ่มต้น |
รักษาความปลอดภัย |
เปิดใช้โฆษณา VPAID โดยใช้ Friendly iframe ซึ่งจะทําให้โฆษณาเข้าถึงเว็บไซต์ผ่าน JavaScript ได้ |
วิธีการ
getCompanionBackfill
getCompanionBackfill() แสดงผล CompanionBackfillMode
แสดงผลโหมดโฆษณาทดแทนที่ใช้ร่วมกันในปัจจุบัน
- การคืนสินค้า
-
non-null CompanionBackfillMode
มูลค่าปัจจุบัน
รับการปิดใช้CustomCustomForIOS10Plus
getDisableCustomPlaybackForIOS10Plus() แสดงผลบูลีน
เลือกว่าจะปิดใช้การเล่นที่กําหนดเองในเบราว์เซอร์ iOS 10 ขึ้นไปหรือไม่ ค่าเริ่มต้นจะเป็น "เท็จ"
- การคืนสินค้า
-
boolean
getFeatureFlags
getFeatureFlags() จะแสดงผลออบเจ็กต์ที่มีพร็อพเพอร์ตี้ประเภทใดก็ได้
แสดงผลออบเจ็กต์ที่มีคีย์เป็นแฟล็กฟีเจอร์และค่าเป็นสถานะปัจจุบันของออบเจ็กต์
- การคืนสินค้า
-
non-null Object with any type properties
GetLocale
สตริงส่งกลับ getLocale()
แสดงผลภาษาที่ระบุโดยผู้เผยแพร่โฆษณา
- การคืนสินค้า
-
string
ผู้เผยแพร่โฆษณาระบุภาษา
getNumRedirects
ตัวเลขการส่งกลับ getNumRedirects()
จะแสดงจํานวนการเปลี่ยนเส้นทางสูงสุดสําหรับการเปลี่ยนเส้นทางที่ตามมาจะถูกปฏิเสธ
- การคืนสินค้า
-
number
จํานวนการเปลี่ยนเส้นทางสูงสุด
ประเภท getPlayer
getPlayerType() แสดงผลสตริง
แสดงประเภทโปรแกรมเล่นที่พาร์ทเนอร์ให้ไว้
- การคืนสินค้า
-
string
ประเภทโปรแกรมเล่นของพาร์ทเนอร์
รับ getPlayerVersion
getPlayerVersion() แสดงผลสตริง
แสดงเวอร์ชันโปรแกรมเล่นที่พาร์ทเนอร์ระบุ
- การคืนสินค้า
-
string
เวอร์ชันโปรแกรมเล่นของพาร์ทเนอร์
getPpid
getPpid() การคืนสินค้า (Null หรือสตริง)
แสดงผลรหัสที่ผู้เผยแพร่โฆษณาระบุ
- การคืนสินค้า
-
รหัสที่ผู้เผยแพร่โฆษณามีให้
(null or string)
รายการ
เปิดใช้คุกกี้
isCookieEnabled() ส่งคืนบูลีน
- การคืนสินค้า
-
boolean
ผู้เผยแพร่โฆษณายินยอมให้ใช้คุกกี้หรือไม่
ตั้งค่าช่วงพักโฆษณาอัตโนมัติใน Play
ตั้งค่า setAutoPlayAdBreaks(autoPlayAdBreaks) เป็นโมฆะ
ตั้งค่าว่าจะให้ช่วงพักโฆษณาของ VMAP และกฎโฆษณาโดยอัตโนมัติหรือไม่
พารามิเตอร์ |
|
---|---|
AutoPlayAdBreaks |
บูลีน เปิดใช้ช่วงพักโฆษณาอัตโนมัติหรือไม่ |
- การคืนสินค้า
-
void
setCompanionBackfill
การคืนสินค้าของ setCompanionBackfill(mode) เป็นโมฆะ
ตั้งค่าโหมดโฆษณาทดแทนที่ใช้ร่วมกัน ดูโหมดต่างๆ ที่มีใน ImaSdkSettings.CompanionBackfillMode
โหมดเริ่มต้นคือ ImaSdkSettings.CompanionBackfillMode.ALWAYS
พารามิเตอร์ |
|
---|---|
โหมด |
โหมดแยกหน้าจอประชุมที่ใช้ร่วมกัน โหมดโฆษณาทดแทนที่แสดงร่วมที่เลือก ค่าต้องไม่เป็นค่าว่าง |
- การคืนสินค้า
-
void
เปิดใช้คุกกี้
ตั้งค่า setCookieEnabled(cookiesEnabled) เป็นโมฆะ
ระบุว่า SDK ควรจัดเก็บคุกกี้ Google Ad Manager (คุกกี้ GFP) ในโดเมนของผู้เผยแพร่โฆษณาในฐานะคุกกี้ของบุคคลที่หนึ่งหรือไม่ การดําเนินการนี้จะทําให้ระบบคงการเข้าชมหลายครั้งในโดเมนเดียวกันโดยไม่ใช้คุกกี้ของบุคคลที่สาม ค่าเริ่มต้นจะเป็นจริง
การตั้งค่านี้จะไม่ส่งผลต่อคุกกี้อื่นๆ ที่อาจตั้งค่าโดยบุคคลอื่นหรือเพื่อวัตถุประสงค์อื่นๆ ความยินยอมของผู้ใช้และการเลือกไม่ใช้อาจปิดการใช้คุกกี้ของบุคคลที่หนึ่งด้วย ซึ่งจะใช้โดยผู้ให้บริการการจัดการความยินยอมที่เป็นไปตามข้อกําหนดของ IAB หากอยู่ในเฟรมเดียวกัน
พารามิเตอร์ |
|
---|---|
เปิดใช้คุกกี้ |
บูลีน |
- การคืนสินค้า
-
void
ตั้งค่าปิดใช้ CustomCustomForIOS10Plus
ตั้งค่าการคืนสินค้าเป็นปิดใช้ CustomCustomForIOS10Plus(ปิดใช้)
ตั้งค่าว่าจะปิดใช้การเล่นที่กําหนดเองในเบราว์เซอร์ iOS 10 ขึ้นไปหรือไม่ หากเป็น "จริง" โฆษณาจะเล่นในหน้าผลการค้นหาหากวิดีโอในหน้าเป็นแบบอินไลน์ ซึ่งจะเป็นการเปิดใช้โฆษณาแบบข้ามได้ของ TrueView แต่โฆษณาจะแสดงในบรรทัดต่อไปและไม่รองรับโหมดเต็มหน้าจอของ iOS เมื่อเป็นเท็จ โฆษณาจะเล่นในโปรแกรมเล่นวิดีโอเดียวกันกับเนื้อหาของคุณ ค่าที่ตั้งไว้ที่นี่เมื่อมีการสร้าง AdDisplayContainer ตลอดอายุการใช้งานของคอนเทนเนอร์ ค่าเริ่มต้นจะเป็น "เท็จ"
พารามิเตอร์ |
|
---|---|
ปิดใช้ |
บูลีน ปิดใช้การเล่นที่กําหนดเองหรือไม่ |
- การคืนสินค้า
-
void
ตั้งค่าฟีเจอร์แฟล็ก
ตั้งค่า setFeatureFlags(featureFlags) เป็นโมฆะ
กําหนดค่าสําหรับแฟล็กฟีเจอร์ ควรตั้งค่าให้เร็วที่สุดเท่าที่จะทําได้ก่อนที่จะขอโฆษณา การตั้งค่าจะยังคงเหมือนเดิมจนกว่าจะมีการส่งคําขอโฆษณาถัดไป การเรียกใช้วิธีนี้อีกครั้งจะรีเซ็ตแฟล็กฟีเจอร์สําหรับคําขอโฆษณาถัดไป
พารามิเตอร์ |
|
---|---|
แฟล็กฟีเจอร์ |
ออบเจ็กต์ทุกประเภท ค่าต้องไม่เป็นค่าว่าง |
- การคืนสินค้า
-
void
setLocale
ส่งคืน setlocale(ภาษา) เป็นโมฆะ
ตั้งค่าภาษาของผู้เผยแพร่โฆษณา ต้องเรียกใช้ก่อนสร้าง AdsLoader หรือ AdDisplayContainer ภาษาจะระบุภาษาที่จะแสดงองค์ประกอบ UI ดูรหัสที่รองรับได้ในการแปลสําหรับภาษาและท้องถิ่น
พารามิเตอร์ |
|
---|---|
ภาษา |
สตริง ภาษาที่ผู้เผยแพร่โฆษณาระบุ |
- การคืนสินค้า
-
void
setNumRedirects
แสดงผล setNumRedirects(จํานวนการเปลี่ยนเส้นทาง) เป็นโมฆะ
ระบุจํานวนการเปลี่ยนเส้นทางสูงสุดก่อนที่การเปลี่ยนเส้นทางที่ตามมาจะถูกปฏิเสธ และการโหลดโฆษณาถูกยกเลิก จํานวนของการเปลี่ยนเส้นทางจะส่งผลต่อเวลาในการตอบสนองโดยตรง ซึ่งเป็นประสบการณ์ของผู้ใช้ ข้อกําหนดนี้มีผลกับโฆษณา VAST Wrapper ทั้งหมด
พารามิเตอร์ |
|
---|---|
การเปลี่ยนเส้นทางหมายเลข |
number จํานวนสูงสุดของการเปลี่ยนเส้นทาง |
- การคืนสินค้า
-
void
ประเภท seterer
แสดงผล setPlayerType(playerType) เป็นโมฆะ
ตั้งค่าประเภทโปรแกรมเล่นที่พาร์ทเนอร์ให้ไว้ ควรใช้การตั้งค่านี้เพื่อระบุชื่อของโปรแกรมเล่นที่ผสานรวมกับ SDK ระบบจะตัดประเภทของผู้เล่นที่ยาวเกิน 20 อักขระให้สั้นลง ประเภทของผู้เล่นที่ระบุควรสั้นและไม่ซ้ํากัน นี่เป็นการตั้งค่าที่ไม่บังคับที่ใช้เพื่อปรับปรุงความสามารถในการใช้งาน SDK โดยการติดตามประเภทโปรแกรมเล่น
ตัวอย่าง
settings.setPlayerType('google/gmf-player');
พารามิเตอร์ |
|
---|---|
ประเภทของผู้เล่น |
สตริง ประเภทของโปรแกรมเล่นวิดีโอของพาร์ทเนอร์ |
- การคืนสินค้า
-
void
เวอร์ชัน setPlayer
แสดงผล setPlayerVersion(playerVersion) เป็นโมฆะ
ตั้งค่าเวอร์ชันโปรแกรมเล่นที่พาร์ทเนอร์ระบุไว้ ควรใช้การตั้งค่านี้เพื่อระบุเวอร์ชันของโปรแกรมเล่นวิดีโอของพาร์ทเนอร์ที่ผสานรวมไว้กับ SDK ระบบจะตัดเวอร์ชันอักขระที่ยาวเกิน 20 อักขระให้สั้นลง นี่เป็นการตั้งค่าที่ไม่บังคับที่ใช้เพื่อปรับปรุงความสามารถในการใช้งาน SDK โดยการติดตามเวอร์ชันโปรแกรมเล่น
ตัวอย่าง
settings.setPlayerVersion('1.0.0');
พารามิเตอร์ |
|
---|---|
เวอร์ชันโปรแกรมเล่น |
สตริง เวอร์ชันโปรแกรมเล่นของพาร์ทเนอร์ |
- การคืนสินค้า
-
void
setPpid
ตั้งค่าการคืนสินค้า setPpid(ppid)
ตั้งค่ารหัสที่ผู้เผยแพร่โฆษณามีให้
พารามิเตอร์ |
|
---|---|
ppi |
สตริง รหัสที่ผู้เผยแพร่โฆษณามีให้ |
- การคืนสินค้า
-
void
รหัสชุดเซสชัน
แสดงผล setSessionId(sessionId) เป็นโมฆะ
รหัสเซสชันคือรหัสแบบสุ่มชั่วคราว และใช้สําหรับการกําหนดความถี่สูงสุดเท่านั้น รหัสเซสชันต้องเป็น UUID
พารามิเตอร์ |
|
---|---|
รหัสเซสชัน |
สตริง การใช้ UUID ชั่วคราวที่ใช้สําหรับการกําหนดความถี่สูงสุด |
- การคืนสินค้า
-
void
setVpaid ที่อนุญาต
ตั้งค่าการคืนสินค้า setVpaidAllowed(allowVpaid) เป็นโมฆะ
เลิกใช้งานแล้ว ใช้ setVpaidMode ตั้งค่าว่าอนุญาตครีเอทีฟโฆษณา VPAID หรือไม่
พารามิเตอร์ |
|
---|---|
AllowVpaid |
บูลีน จะอนุญาตครีเอทีฟโฆษณา VPAID หรือไม่ |
- การคืนสินค้า
-
void
ตั้งค่าVpaidMode
ตั้งค่าการคืนสินค้า setVpaidMode(vpaidMode) เป็นโมฆะ
ตั้งค่าโหมดการเล่น VPAID
พารามิเตอร์ |
|
---|---|
โหมดการชําระเงิน |
โหมด VPAID กําหนดวิธีการเล่นโฆษณา VPAID ค่าเริ่มต้นคือโหมดปลอดภัย ค่าต้องไม่เป็นค่าว่าง |
- การคืนสินค้า
-
void