คลาส: โฆษณา

google.imaโฆษณา

class   แบบคงที่

คลาสของโฆษณาที่ขยายโดยคลาสที่แทนโฆษณาประเภทต่างๆ

วิธีการ

getAdId

getAdId() สตริงการส่งกลับ

รหัสโฆษณาจะใช้ในการซิงค์โฆษณาหลักและโฆษณาที่แสดงร่วม

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

string รหัสของโฆษณา หรือสตริงว่างหากไม่มีข้อมูลนี้

getAdPodInfo

getAdPodInfo() แสดงผล AdPodInfo

แสดงข้อมูลพ็อดของโฆษณา

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

non-null AdPodInfo ข้อมูลพ็อดของโฆษณา

getAdSystem

getAdSystem() สตริงการส่งกลับ

ข้อมูลเซิร์ฟเวอร์โฆษณาต้นทางที่รวมอยู่ในการตอบกลับโฆษณา

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

string เซิร์ฟเวอร์โฆษณาต้นทางของโฆษณา หรือสตริงว่างหากไม่มีข้อมูลนี้

รับชื่อผู้ลงโฆษณา

getAdvertiserName() สตริงการคืนสินค้า

ชื่อผู้ลงโฆษณาตามที่กําหนดโดยฝ่ายที่แสดงผล

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

string ชื่อผู้ลงโฆษณา หรือสตริงว่างเปล่า หากไม่มีข้อมูลนี้

getApiFramework

getApiFramework() สตริงการส่งกลับ

ระบุ API ที่ต้องใช้ในการแสดงโฆษณา ซึ่งสอดคล้องกับ apiFramework ที่ระบุไว้ใน VAST

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

nullable string เฟรมเวิร์ก API ต้องเรียกใช้โฆษณาหรือไม่มีข้อมูล หากข้อมูลนี้ไม่พร้อมใช้งาน

รับโฆษณาที่แสดงร่วม

getCompanionAds(adSlotWidth, adSlotHeight, settings) แสดงผลอาร์เรย์ของ CompanionAd ที่ไม่เป็นค่าว่าง

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

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

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

non-null Array of non-null CompanionAd อาร์เรย์ของโฆษณาที่แสดงร่วมที่ตรงกับการตั้งค่าและขนาดช่องโฆษณา

รับประเภทเนื้อหา

getContentType() สตริงผลลัพธ์

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

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

string ประเภทเนื้อหา สตริงว่าง (หากมี)

รับรหัสโฆษณา

getCreativeAdId() สตริงการส่งกลับ

ส่งกลับรหัส ISCI (รหัสมาตรฐานเชิงพาณิชย์) สําหรับโฆษณา หรือสตริงว่างหากไม่มีรหัส นี่คือรหัสโฆษณาของครีเอทีฟโฆษณาในการตอบกลับ VAST

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

string 

รับรหัสโฆษณา

getCreativeId() สตริงการส่งกลับ

ดึงรหัสของโฆษณาที่เลือกสําหรับโฆษณา

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

string รหัสของครีเอทีฟโฆษณาที่เลือกสําหรับโฆษณา หรือสตริงว่างหากไม่มีข้อมูลนี้

รับรหัสดีล

getDealId() สตริงการส่งกลับ

แสดงรหัสดีลแรกที่แสดงในห่วงโซ่ Wrapper สําหรับโฆษณาปัจจุบันโดยเริ่มจากด้านบน แสดงผลสตริงว่างหากไม่มี

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

string 

รับคําอธิบาย

getDescription() สตริงการส่งกลับ

ส่งคืนรายละเอียดของโฆษณานี้จากการตอบสนองด้วย VAST

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

string คําอธิบายจะว่างเปล่าหากไม่ได้ระบุ

ระยะเวลารับ

getDuration() returns number

แสดงผลระยะเวลาของครีเอทีฟโฆษณาที่เลือก หรือ -1 สําหรับครีเอทีฟโฆษณาที่ไม่ใช่แบบเชิงเส้น

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

number ระยะเวลาของครีเอทีฟโฆษณาที่เลือกเป็นวินาที โดยมี -1 หากไม่ใช่เชิงเส้น

GetHeight

getHeight() ส่งคืนหมายเลข

แสดงความสูงของโฆษณาที่ไม่ใช่เชิงเส้นที่เลือกไว้

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

number ความสูงของครีเอทีฟโฆษณาที่ไม่ใช่เชิงเส้นที่เลือกไว้ หรือ 0 สําหรับครีเอทีฟโฆษณาเชิงเส้น

เรียก URL สื่อ

getMediaUrl() สตริงการส่งกลับ

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

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

nullable string 

ระยะเวลาขั้นต่ําที่แนะนํา

getMinSuggestDuration() แสดงผล

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

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

number ระยะเวลาขั้นต่ําที่แนะนําเป็นวินาทีที่จะแสดงครีเอทีฟโฆษณา

getSkipTimeOffset

getSkipTimeOffset() จํานวน

จํานวนวินาทีของการเล่นก่อนที่โฆษณาจะข้ามได้ -1 จะแสดงผลสําหรับโฆษณาที่ข้ามไม่ได้หรือไม่สามารถใช้ได้

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

number ออฟเซ็ตเป็นวินาที หรือ -1

รับ URLUrl

getSurveyUrl() สตริงการส่งกลับ

แสดงผล URL ที่เชื่อมโยงกับแบบสํารวจสําหรับโฆษณานั้นๆ แสดงผลเป็น null หากมี

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

nullable string 

ดาวน์โหลดชื่อ

getTitle() สตริงการส่งกลับ

แสดงชื่อของโฆษณานี้จากการตอบสนองด้วย VAST

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

string ชื่อจะว่างเปล่าหากไม่ได้ระบุไว้

พารามิเตอร์รับการเข้าชม

getTraffickingParameters() แสดงผลออบเจ็กต์ที่มีพร็อพเพอร์ตี้สตริง

รับพารามิเตอร์ที่กําหนดเองที่เชื่อมโยงกับโฆษณาในขณะที่ดูแลการแสดงโฆษณา

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

non-null Object with string properties การแมปคีย์การดูแลการแสดงโฆษณากับค่า หรือออบเจ็กต์ที่ว่างเปล่าหากไม่มีข้อมูลนี้

สตริงพารามิเตอร์รับการเข้าชม

getTraffickingParametersString() สตริงการส่งคืน

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

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

string การดูแลการแสดงโฆษณาด้วยพารามิเตอร์ หรือสตริงว่างเปล่าหากไม่มีข้อมูลนี้

getUiElements

getUiElements() ส่งคืนอาร์เรย์ของสตริง

แสดงองค์ประกอบ UI ที่แสดงเมื่อมีการเล่นโฆษณานี้ โปรดดู UiElements สําหรับองค์ประกอบที่เป็นไปได้ของอาร์เรย์ที่แสดงผล

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

non-null Array of string องค์ประกอบ UI ที่แสดง

getUniversalAdIdRegistry

getUniversalAdIdRegistry() สตริงการส่งคืน

รีจิสทรีที่เกี่ยวข้องกับแคตตาล็อก UniversalAdId ของครีเอทีฟโฆษณาที่เลือกสําหรับโฆษณา

เลิกใช้

ใช้ ad.getUniversalAdIds() แทน

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

string แสดงผลค่ารีจิสทรี หรือ "unknown" (หากมี)

ค่า UniversalAdId

getUniversalAdIdValue() สตริงการส่งกลับ

UniversalAdId ของโฆษณาที่เลือกสําหรับโฆษณา

เลิกใช้

ใช้ ad.getUniversalAdIds() แทน

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

string แสดงผลค่ารหัสหรือ "unknown" (หากไม่มี)

getUniversalAdIds

getUniversalAdIds() ส่งคืนอาร์เรย์ของ UniversalAdIdInfo ที่ไม่เป็นค่าว่าง

รายการ UniversalAdIds ของโฆษณาที่เลือกสําหรับโฆษณา

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

non-null Array of non-null UniversalAdIdInfo ส่งกลับรายการข้อมูล รหัสโฆษณาสากลที่ใช้กับโฆษณานี้

getVastMediaBitrate

getVastMediaBitrate() แสดงจํานวน

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

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

number อัตราบิตของไฟล์สื่อที่เลือกหรือ 0

getVastMediaHeight

getVastMediaHeight() แสดงจํานวน

แสดงความสูงสื่อ VAST ของครีเอทีฟโฆษณาที่เลือก

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

number ความสูงสื่อ VAST ของครีเอทีฟโฆษณาที่เลือกหรือ 0 หากไม่มีการเลือก

getVastMediaWidth

getVastMediaWidth() ตัวเลขที่ส่งกลับ

แสดงความกว้างของสื่อ VAST ของครีเอทีฟโฆษณาที่เลือก

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

number ความกว้างสื่อ VAST ของครีเอทีฟโฆษณาที่เลือกไว้หรือ 0 ถ้าไม่มีการเลือก

รับความกว้าง

getWidth() จํานวนส่งคืน

แสดงผลความกว้างของโฆษณาที่เลือก

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

number ความกว้างของครีเอทีฟโฆษณาแบบไม่ใช่เชิงเส้นที่เลือกไว้ หรือ 0 สําหรับครีเอทีฟโฆษณาเชิงเส้น

getWrapperAdIds

getWrapperAdIds() ส่งคืนอาร์เรย์ของสตริง

รหัสโฆษณาที่ใช้สําหรับโฆษณา Wrapper รหัสที่แสดงผลจะเริ่มต้นที่โฆษณาแบบอินไลน์ (ภายใน) และข้ามผ่านไปยังโฆษณาแบบ Wrapper ด้านนอกสุด ระบบจะแสดงผลอาร์เรย์ที่ว่างเปล่าหากไม่มีโฆษณา Wrapper

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

non-null Array of string รหัสของโฆษณา เริ่มต้นที่โฆษณาอินไลน์ หรืออาร์เรย์ว่างเปล่าหากไม่มีโฆษณา Wrapper

getWrapperAdSystems

getWrapperAdSystems() ส่งคืนอาร์เรย์ของสตริง

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

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

non-null Array of string ระบบโฆษณาของโฆษณา เริ่มต้นที่ โฆษณาแบบอินไลน์ หรืออาร์เรย์ว่างเปล่าหากไม่มีโฆษณา Wrapper

รับ Wrapper รหัสโฆษณา

getWrapperCreativeIds() ส่งคืนอาร์เรย์ของสตริง

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

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

non-null Array of string รหัสของครีเอทีฟโฆษณาของโฆษณา เริ่มจาก โฆษณาแบบอินไลน์ หรืออาร์เรย์ว่างเปล่าหากไม่มีโฆษณา Wrapper

เป็นเส้นตรง

isLinear() บูลีนการคืนสินค้า

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

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

boolean เป็นจริงถ้าโฆษณานั้นเป็นแบบเชิงเส้น เท็จ