คลาส: AdsRequest

ผู้ผลิต

คําขอโฆษณา

adsRequest() ใหม่

ใช้งาน
google.ima.AdsRequestInterface

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

URL แท็กโฆษณา

สตริง

ระบุ URL แท็กโฆษณาที่ขอจากเซิร์ฟเวอร์โฆษณา ดูรายละเอียดการสร้าง URL แท็กโฆษณาได้ที่ สร้างแท็กโฆษณาวิดีโอหลักด้วยตนเอง

ต้องระบุพารามิเตอร์นี้

การตอบสนองของโฆษณา

(เอกสาร Null, สตริง หรือเอกสารที่ไม่มีค่าว่าง)

ระบุเอกสาร VAST 2.0 ที่จะใช้เป็นการตอบกลับโฆษณาแทนที่จะส่งคําขอผ่าน URL แท็กโฆษณา ซึ่งจะมีประโยชน์ในการแก้ไขข้อบกพร่องและสถานการณ์อื่นๆ ที่มีการตอบสนองด้วย VAST อยู่แล้ว

พารามิเตอร์นี้จะใส่หรือไม่ใส่ก็ได้

ระยะเวลาของเนื้อหา

(null หรือตัวเลข)

ระบุระยะเวลาของเนื้อหาเป็นวินาทีที่จะแสดง โดยจะมีการใช้ 2 กรณี ได้แก่ 1) การกําหนดเป้าหมายโฆษณา AdX และ 2) การกําหนดเวลาให้โหลดวิดีโอหลังเล่น VMAP ล่วงหน้า

พารามิเตอร์นี้จะใส่หรือไม่ใส่ก็ได้

คําหลักของเนื้อหา

(อาร์เรย์สตริงที่ไม่มีค่าหรือค่าว่าง)

ระบุคําหลักที่ใช้อธิบายเนื้อหาที่จะแสดง ใช้ในคําขอ AdX

พารามิเตอร์นี้จะใส่หรือไม่ใส่ก็ได้

ชื่อเนื้อหา

(null หรือสตริง)

ระบุชื่อเนื้อหาที่จะแสดง ใช้ในคําขอ AdX

พารามิเตอร์นี้จะใส่หรือไม่ใส่ก็ได้

forceNonLinearFullSlot

บูลีน

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

ความสูงของช่องโฆษณาแบบเชิงเส้น

ตัวเลข

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

ต้องระบุพารามิเตอร์นี้

ความกว้างช่องโฆษณาเชิงเส้น

ตัวเลข

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

ต้องระบุพารามิเตอร์นี้

liveStreamPrefetch วินาที

ตัวเลข

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

ความสูงที่ไม่ใช่ช่องโฆษณาเชิงเส้น

ตัวเลข

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

ต้องระบุพารามิเตอร์นี้

ความกว้างโฆษณาที่ไม่ใช่เชิงเส้น

ตัวเลข

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

ต้องระบุพารามิเตอร์นี้

omidAccessModeRules

ออบเจ็กต์ที่ไม่ใช่ Null พร้อมพร็อพเพอร์ตี้สตริง

ออบเจ็กต์การตั้งค่าสําหรับผู้ให้บริการตรวจสอบการแมปกับโหมดการเข้าถึง OMID คีย์ต้องเป็นค่าใน google.ima.OmidVerificationVendor และค่าต้องเป็นค่าใน google.ima.OmidAccessMode

ระบบจะจับคู่ URL ของสคริปต์การยืนยันกับนิพจน์ทั่วไปที่ได้จากผู้ให้บริการเพื่อแก้คีย์ OmidVerificationVendor จากนั้น IMA จะมองหาโหมดการเข้าถึงสําหรับผู้ให้บริการที่กําหนดโดยใช้ออบเจ็กต์นี้

สําหรับ URL ของสคริปต์ที่ไม่ได้แปลงเป็นผู้ให้บริการที่รู้จัก หรือหากไม่ได้ระบุ OmidVerificationVendor ในออบเจ็กต์นี้ IMA จะใช้โหมดการเข้าถึงที่มีให้สําหรับ OmidVerificationVendorOTHER หากไม่ได้ระบุ OmidVerificationVendor.OTHER จะใช้โหมดการเข้าถึงแบบจํากัด

URL หน้าเว็บ

(null หรือสตริง)

ระบุ URL เต็มของหน้าเว็บที่จะรวมไว้ในคําขอโฆษณาของ Google เพื่อกําหนดเป้าหมาย URL ต้องเป็น URL ที่ถูกต้อง หากระบุไว้ ระบบจะใช้ค่านี้สําหรับมาโคร VAST [PAGEURL]

พารามิเตอร์นี้จะใส่หรือไม่ใส่ก็ได้

vastLoadTimeout

ตัวเลข

ลบล้างระยะหมดเวลาการโหลด VAST เริ่มต้นเป็นมิลลิวินาทีสําหรับ Wrapper รายการเดียว ระยะหมดเวลาเริ่มต้นคือ 5,000 มิลลิวินาที

พารามิเตอร์นี้จะใส่หรือไม่ใส่ก็ได้

วิธีการ

ตั้งค่าโฆษณาอัตโนมัติ

setAdWillAutoPlay(autoPlay) ส่งกลับ

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

พารามิเตอร์

เล่นอัตโนมัติ

บูลีน

เนื้อหาและโฆษณาจะเล่นโดยอัตโนมัติหรือจะเริ่มต้นขึ้นจากการดําเนินการของผู้ใช้

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

void 

setAdWillPlay แบบปิดเสียง

setAdWillPlayMuted(ปิดเสียง) เป็นโมฆะ

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

พารามิเตอร์

ปิดเสียงอยู่

บูลีน

โฆษณาจะเล่นขณะที่ปิดเสียงอยู่หรือไม่

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

void 

ตั้งค่าการเล่นอย่างต่อเนื่อง

setContinuousPlay(continuousPlay) ส่งกลับ

แจ้งให้ SDK ทราบว่าโปรแกรมเล่นวิดีโอจะเล่นเนื้อหาวิดีโออย่างต่อเนื่องหลังจากการเล่นในลักษณะเดียวกับการออกอากาศทางทีวีหรือไม่ การเปลี่ยนแปลงการตั้งค่านี้จะไม่ส่งผลต่อการเล่นโฆษณา แต่จะส่งสัญญาณที่เหมาะสมในคําขอโฆษณานี้เพื่อให้ผู้ซื้อเสนอราคาในประเภทพื้นที่โฆษณาได้

พารามิเตอร์

การเล่นอย่างต่อเนื่อง

บูลีน

วิดีโอจะเล่นเป็นวิดีโออื่นอย่างต่อเนื่องหรือไม่

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

void