Google Mobile Ads React Native API

โมดูล @google/mobile-ads มีอินเทอร์เฟซ คลาส และฟังก์ชันระดับบนสุดของ TypeScript หลักสำหรับการผสานรวมโฆษณา Google ในอุปกรณ์เคลื่อนที่เข้ากับแอปพลิเคชัน React Native

ภาพรวม

ชื่อแทนประเภท
AdapterState
แสดงสถานะการเริ่มต้นที่เป็นไปได้ของอะแดปเตอร์สื่อกลาง
AdChoicesPlacement
ตำแหน่งของไอคอนตัวเลือกโฆษณาอื่นๆ ในการดูโฆษณา
AdFormat
รูปแบบของโฆษณาที่ขอ
AdInspectorError
ข้อมูลข้อผิดพลาดเกี่ยวกับสาเหตุที่เครื่องมือตรวจสอบโฆษณาล้มเหลว
AdInspectorErrorCode
ข้อผิดพลาดที่มีผลต่อการเปิดหรือการทำงานของเครื่องมือตรวจสอบโฆษณา
AdOrientation
ตัวเลือกการวางแนวสำหรับโฆษณาแบนเนอร์แบบปรับขนาดได้ที่แทรกในบรรทัดและแบบปรับขนาดได้ที่ยึดตำแหน่งไว้ขนาดใหญ่
AdSize
แสดงมิติข้อมูลของโฆษณา
AgeRestrictedTreatment
กำหนดตัวเลือกการดูแลแบบจำกัดอายุสำหรับคำขอโฆษณา
ConsentStatus
ค่าสถานะความยินยอม
DebugGeography
ค่าการแก้ไขข้อบกพร่องสำหรับการทดสอบภูมิศาสตร์
FormErrorCode
แสดงรหัสข้อผิดพลาดสำหรับการดำเนินการที่ล้มเหลวของแบบฟอร์ม User Messaging Platform (UMP)
FullScreenContentErrorCode
LoadAdErrorCode
แสดงรหัสข้อผิดพลาดสำหรับการดำเนินการโหลดโฆษณาที่ไม่สำเร็จ
MaxAdContentRating
กำหนดการจัดประเภทเนื้อหาโฆษณาสูงสุดสำหรับแอป โดยจัดประเภท ประเภทโฆษณาที่แสดงได้
NativeAdAssetNames
ชื่อที่ใช้ระบุชิ้นงานโฆษณาเนทีฟมาตรฐาน
NativeAdType
ระบุรูปแบบของโฆษณาเนทีฟที่โหลดแล้ว
NativeMediaAspectRatio
ค่ากำหนดสำหรับสัดส่วนภาพของสื่อโฆษณาเนทีฟที่แสดง
OnAdInspectorClosedListener
คำจำกัดความของอินเทอร์เฟซสำหรับ Callback ที่จะเรียกใช้เมื่อ UI เครื่องมือตรวจสอบโฆษณา ปิด
PrecisionType
ความแม่นยําของมูลค่าโฆษณาที่รายงาน
PrivacyOptionsRequirementStatus
สถานะข้อกำหนดของตัวเลือกความเป็นส่วนตัว
PublisherPrivacyPersonalizationState
ระบุสถานะการปรับตามโปรไฟล์ของผู้ใช้ของการดูแลด้านความเป็นส่วนตัวสำหรับผู้เผยแพร่โฆษณา
ResizeMode
ตัวเลือกในการปรับแต่งโหมดการปรับขนาดของเนื้อหารูปภาพใน NativeAdMediaView
ResolvedAdSize
แสดงสถานะสุดท้ายของขนาดโฆษณาหลังจากโหลดโฆษณาแล้ว
SwipeGestureDirection
วิธีการสำหรับท่าทางการปัดคลิกที่กำหนดเอง
ตัวแปร
AdSize
ขนาดโฆษณาที่กําหนดไว้ล่วงหน้าและเมธอดช่วยสําหรับการสร้างขนาดที่ปรับเปลี่ยนได้และ ขนาดที่กําหนดเอง
ฟังก์ชัน
canRequestAds
ตรวจสอบว่าสถานะความยินยอมปัจจุบันอนุญาตให้คุณขอ โฆษณาหรือไม่
getConsentStatus
รับสถานะความยินยอมปัจจุบันของผู้ใช้
getInitializationStatus
รับสถานะการเริ่มต้น SDK
getPrivacyOptionsRequirementStatus
ตรวจสอบว่าแอปของคุณต้องมีจุดแรกเข้าของตัวเลือกความเป็นส่วนตัวหรือไม่
getRequestConfiguration
รับการกำหนดค่าคำขอส่วนกลาง
initialize
เริ่มต้นใช้งาน Google Mobile Ads SDK
isConsentFormAvailable
ตรวจสอบว่ามีแบบฟอร์มความยินยอมหรือไม่
loadAndShowConsentFormIfRequired
โหลดแบบฟอร์มความยินยอมและแสดงต่อผู้ใช้หากสถานะความยินยอมปัจจุบัน กำหนดให้ทำเช่นนั้น (เช่น สถานะเป็น REQUIRED)
openAdInspector
เปิดการวางซ้อนเครื่องมือตรวจสอบโฆษณาของ Google Mobile Ads SDK
openDebugMenu
เปิดเมนูแก้ไขข้อบกพร่อง
parseLoadAdError
แยกวิเคราะห์ข้อผิดพลาดดั้งเดิมที่เกิดขึ้นระหว่างการโหลดโฆษณาและรวมไว้ใน LoadAdError
requestConsentInfoUpdate
ขออัปเดตข้อมูลความยินยอม
reset
ล้างสถานะความยินยอมทั้งหมดจากพื้นที่เก็บข้อมูลถาวร
setPublisherFirstPartyIdEnabled
ควบคุมว่าจะเปิดใช้ตัวระบุของบุคคลที่หนึ่งของผู้เผยแพร่โฆษณาหรือไม่
setRequestConfiguration
ตั้งค่าคำขอส่วนกลางเพื่อการปฏิบัติตามข้อกำหนดและการกำหนดเป้าหมาย
setUserControlledAppVolume
ตั้งค่าระดับเสียงของแอปพลิเคชันที่ผู้ใช้ควบคุม
setUserMutedApp
กำหนดว่าแอปพลิเคชันจะปิดเสียงหรือไม่
showPrivacyOptionsForm
แสดงแบบฟอร์มตัวเลือกความเป็นส่วนตัว

ชื่อแทนประเภท

AdapterState

AdapterState: typeof AdapterState[keyof typeof AdapterState]
แสดงสถานะการเริ่มต้นที่เป็นไปได้ของอะแดปเตอร์สื่อกลาง
พร็อพเพอร์ตี้
NOT_READY
ระบุว่ายังไม่ได้เริ่มต้นใช้งานอะแดปเตอร์สื่อกลาง หรือเริ่มต้นใช้งานไม่สำเร็จ
READY
ระบุว่าอะแดปเตอร์สื่อกลางเริ่มต้นใช้งานสำเร็จ และพร้อมแสดงโฆษณา

AdChoicesPlacement

AdChoicesPlacement: typeof AdChoicesPlacement[keyof typeof AdChoicesPlacement]
ตำแหน่งของไอคอนตัวเลือกโฆษณาอื่นๆ ในการดูโฆษณา
พร็อพเพอร์ตี้
BOTTOM_LEFT
มุมซ้ายล่างของโฆษณา
BOTTOM_RIGHT
มุมขวาล่างของโฆษณา
TOP_LEFT
มุมซ้ายบนของโฆษณา
TOP_RIGHT
มุมขวาบนของโฆษณา

AdFormat

AdFormat: typeof AdFormat[keyof typeof AdFormat]
รูปแบบของโฆษณาที่ขอ
พร็อพเพอร์ตี้
APP_OPEN
รูปแบบโฆษณาเปิดแอป
BANNER
รูปแบบโฆษณาแบนเนอร์
INTERSTITIAL
รูปแบบโฆษณาคั่นระหว่างหน้า
NATIVE
รูปแบบโฆษณาเนทีฟ
REWARDED
รูปแบบโฆษณาที่มีการให้รางวัล
REWARDED_INTERSTITIAL
รูปแบบโฆษณาคั่นระหว่างหน้าที่มีการให้รางวัล

AdInspectorError

AdInspectorError: BaseError<AdInspectorErrorCode>
ข้อมูลข้อผิดพลาดเกี่ยวกับสาเหตุที่เครื่องมือตรวจสอบโฆษณาล้มเหลว

AdInspectorErrorCode

AdInspectorErrorCode: typeof AdInspectorErrorCode[keyof typeof AdInspectorErrorCode]
ข้อผิดพลาดที่มีผลต่อการเปิดหรือการทำงานของเครื่องมือตรวจสอบโฆษณา
พร็อพเพอร์ตี้
ALREADY_OPEN
เปิดเครื่องมือตรวจสอบโฆษณาไม่ได้เนื่องจากเปิดอยู่แล้ว
FAILED_TO_LOAD
โหลดเครื่องมือตรวจสอบโฆษณาไม่สำเร็จ
INTERNAL_ERROR
เครื่องมือตรวจสอบโฆษณามีข้อผิดพลาดภายใน
NOT_IN_TEST_MODE
เปิดเครื่องมือตรวจสอบโฆษณาไม่ได้เนื่องจากอุปกรณ์ไม่ได้อยู่ใน โหมดทดสอบ

AdOrientation

AdOrientation: typeof AdOrientation[keyof typeof AdOrientation]
ตัวเลือกการวางแนวสำหรับโฆษณาแบนเนอร์แบบปรับขนาดได้ที่แทรกในบรรทัดและแบบปรับขนาดได้ที่ยึดตำแหน่งไว้ขนาดใหญ่
พร็อพเพอร์ตี้
CURRENT
LANDSCAPE
PORTRAIT

AdSize

แสดงขนาดของโฆษณา

อาจเป็นหนึ่งใน ชุดขนาดที่กำหนดไว้ล่วงหน้า (เช่น AdSize.LARGE_BANNER) หรือขนาดที่ปรับเปลี่ยนได้

AgeRestrictedTreatment

AgeRestrictedTreatment: typeof AgeRestrictedTreatment[keyof typeof AgeRestrictedTreatment]
กำหนดตัวเลือกการดูแลแบบจำกัดอายุสำหรับคำขอโฆษณา
พร็อพเพอร์ตี้
CHILD
ระบุว่าคำขอโฆษณาควรได้รับการดูแลตามอายุของเด็ก
TEEN
ระบุว่าคำขอโฆษณาควรได้รับการดูแลตามอายุของวัยรุ่น
UNSPECIFIED
บ่งชี้ว่าคำขอโฆษณาไม่มีสัญญาณการดูแลแบบจำกัดอายุที่เฉพาะเจาะจง

ConsentStatus

ConsentStatus: typeof ConsentStatus[keyof typeof ConsentStatus]
ค่าสถานะความยินยอม
พร็อพเพอร์ตี้
NOT_REQUIRED
ไม่ต้องได้รับความยินยอม
OBTAINED
ความยินยอมของผู้ใช้ที่ได้รับ, ปรับตามโปรไฟล์ของผู้ใช้เทียบกับไม่ปรับตามโปรไฟล์ของผู้ใช้ undefined.
REQUIRED
ต้องได้รับความยินยอมของผู้ใช้ แต่ยังไม่ได้รับ
UNKNOWN
สถานะความยินยอมที่ไม่รู้จัก

DebugGeography

DebugGeography: typeof DebugGeography[keyof typeof DebugGeography]
ค่าการแก้ไขข้อบกพร่องสำหรับการทดสอบภูมิศาสตร์
พร็อพเพอร์ตี้
DISABLED
ปิดใช้การแก้ไขข้อบกพร่องทางภูมิศาสตร์สำหรับอุปกรณ์ที่ใช้แก้ไขข้อบกพร่อง
EEA
ภูมิศาสตร์จะปรากฏใน EEA สำหรับอุปกรณ์แก้ไขข้อบกพร่อง
OTHER
ภูมิศาสตร์ปรากฏในภูมิภาคที่ไม่มีกฎระเบียบใน บังคับใช้อุปกรณ์แก้ไขข้อบกพร่อง
REGULATED_US_STATE
ภูมิศาสตร์จะปรากฏในรัฐของสหรัฐอเมริกาที่มีการกำกับดูแลสำหรับอุปกรณ์ดีบัก

FormErrorCode

FormErrorCode: typeof FormErrorCode[keyof typeof FormErrorCode]
แสดงรหัสข้อผิดพลาดสำหรับการดำเนินการที่ล้มเหลวของแบบฟอร์ม User Messaging Platform (UMP)
พร็อพเพอร์ตี้
ALREADY_USED
มีการใช้แบบฟอร์มความยินยอมไปแล้ว
INTERNAL_ERROR
มีบางอย่างเกิดขึ้นภายใน SDK
INVALID_OPERATION
การดำเนินการไม่ถูกต้อง
NETWORK_ERROR
การดำเนินการในแบบฟอร์มไม่สำเร็จเนื่องจากการเชื่อมต่อเครือข่าย
TIMEOUT
การดำเนินการในแบบฟอร์มหมดเวลาแล้ว
UNAVAILABLE
ไม่มีแบบฟอร์มความยินยอม
UNKNOWN
จับคู่รหัสข้อผิดพลาดกับรหัสข้อผิดพลาดที่รู้จักไม่ได้

FullScreenContentErrorCode

FullScreenContentErrorCode: typeof FullScreenContentErrorCode[keyof typeof FullScreenContentErrorCode]
พร็อพเพอร์ตี้
AD_ALREADY_USED
โฆษณาแสดงไปแล้ว
AD_NOT_READY
โฆษณาไม่พร้อมแสดง
AD_TOO_LARGE
โฆษณามีขนาดใหญ่เกินไปสำหรับฉาก (iOS เท่านั้น)
APP_NOT_FOREGROUND
แอปไม่ได้อยู่ในเบื้องหน้า
INTERNAL_ERROR
มีบางอย่างเกิดขึ้นภายใน เช่น เกิดข้อยกเว้น ขณะเตรียมแสดงเนื้อหาโฆษณา
MEDIATION_ERROR
อะแดปเตอร์สื่อกลางแสดงโฆษณาไม่สำเร็จ ดูสาเหตุที่แท้จริงได้ที่ FullScreenContentError.mediationAdError
UNKNOWN
จับคู่รหัสข้อผิดพลาดกับรหัสข้อผิดพลาดที่รู้จักไม่ได้

LoadAdErrorCode

LoadAdErrorCode: typeof LoadAdErrorCode[keyof typeof LoadAdErrorCode]
แสดงรหัสข้อผิดพลาดสำหรับการดำเนินการโหลดโฆษณาที่ไม่สำเร็จ
พร็อพเพอร์ตี้
AD_ALREADY_USED
มีการใช้การตอบกลับของโฆษณาเพื่อโหลดโฆษณาแล้ว
APP_ID_MISSING
ไม่ได้ส่งคำขอโฆษณาเนื่องจากไม่มีรหัสแอปพลิเคชัน
CANCELLED
ยกเลิกคำขอโฆษณาแล้ว (Android เท่านั้น)
INTERNAL_ERROR
มีบางอย่างเกิดขึ้นภายใน SDK
INVALID_REQUEST
คำขอโฆษณาไม่ถูกต้อง เช่น รหัสหน่วยโฆษณา ไม่ถูกต้อง
INVALID_RESPONSE
การตอบกลับของโฆษณาแบบเซิร์ฟเวอร์ต่อเซิร์ฟเวอร์ไม่ถูกต้อง เช่น ไม่มีรหัสคำขอในการตอบกลับของโฆษณา
MEDIATION_ERROR
ไม่พบอะแดปเตอร์สื่อกลาง หรือดำเนินการส่งคำขอโฆษณาไม่สำเร็จ
NETWORK_ERROR
คำขอโฆษณาไม่สำเร็จเนื่องจาก การเชื่อมต่อเครือข่าย
NO_FILL
คำขอโฆษณาสําเร็จ แต่ไม่มีการแสดงโฆษณาเนื่องจากไม่มีพื้นที่โฆษณา
TIMEOUT
คำขอโฆษณาหมดเวลาแล้ว
UNKNOWN
จับคู่รหัสข้อผิดพลาดกับรหัสข้อผิดพลาดที่รู้จักไม่ได้

MaxAdContentRating

MaxAdContentRating: typeof MaxAdContentRating[keyof typeof MaxAdContentRating]
กำหนดการจัดประเภทเนื้อหาโฆษณาสูงสุดสำหรับแอป โดยจัดประเภท ประเภทโฆษณาที่แสดงได้
พร็อพเพอร์ตี้
G
เนื้อหาเหมาะสำหรับผู้ชมทั่วไป รวมถึงครอบครัวและเด็ก
MA
เนื้อหาเหมาะกับกลุ่มเป้าหมายที่บรรลุนิติภาวะแล้วเท่านั้น
PG
เนื้อหาเหมาะกับผู้ชมส่วนใหญ่ โดยที่ผู้ปกครองควรให้คำแนะนำ
T
เนื้อหาเหมาะกับกลุ่มเป้าหมายที่เป็นวัยรุ่นขึ้นไป
UNSPECIFIED
ไม่มีการจัดประเภทเนื้อหาที่ระบุ

NativeAdAssetNames

NativeAdAssetNames: typeof NativeAdAssetNames[keyof typeof NativeAdAssetNames]
ชื่อที่ใช้ระบุชิ้นงานโฆษณาเนทีฟมาตรฐาน
พร็อพเพอร์ตี้
ADCHOICES_CONTAINER_VIEW
คอนเทนเนอร์สำหรับการวางซ้อนตัวเลือกโฆษณาอื่นๆ
ADVERTISER
ชื่อของผู้ลงโฆษณา
BODY
ข้อความส่วนเนื้อหาหลักของโฆษณา
CALL_TO_ACTION
ข้อความคำกระตุ้นให้ดำเนินการสำหรับโฆษณา (เช่น "ติดตั้ง" หรือ "ดูข้อมูลเพิ่มเติม")
HEADLINE
บรรทัดแรกหรือชื่อของโฆษณา
ICON
รูปภาพไอคอนสำหรับโฆษณา
MEDIA_CONTENT
เนื้อหาสื่อหลักของโฆษณา (รูปภาพหรือวิดีโอ)
PRICE
ราคาของแอปหรือผลิตภัณฑ์ที่โฆษณา
STAR_RATING
การให้ดาวสำหรับแอปหรือผลิตภัณฑ์ที่โฆษณา
STORE
ชื่อร้านค้า

NativeAdType

NativeAdType: typeof NativeAdType[keyof typeof NativeAdType]
ระบุรูปแบบของโฆษณาเนทีฟที่โหลดแล้ว
พร็อพเพอร์ตี้
BANNER
โฆษณาแบนเนอร์
CUSTOM_NATIVE
โฆษณารูปแบบเนทีฟที่กำหนดเอง
NATIVE
โฆษณาเนทีฟ

NativeMediaAspectRatio

NativeMediaAspectRatio: typeof NativeMediaAspectRatio[keyof typeof NativeMediaAspectRatio]
ค่ากำหนดสำหรับสัดส่วนภาพของสื่อโฆษณาเนทีฟที่แสดง
พร็อพเพอร์ตี้
ANY
ไม่มีค่ากำหนดสำหรับสัดส่วนภาพของสื่อโฆษณาเนทีฟที่แสดงผล
LANDSCAPE
ขอสัดส่วนภาพแนวนอนสำหรับสื่อโฆษณาเนทีฟที่แสดงผล
PORTRAIT
ขอสัดส่วนภาพแนวตั้งสำหรับสื่อโฆษณาเนทีฟที่แสดง
SQUARE
ขอสัดส่วนภาพสี่เหลี่ยมจัตุรัสสำหรับสื่อโฆษณาเนทีฟที่ส่งกลับ
UNKNOWN
ไม่ทราบสัดส่วนภาพ

OnAdInspectorClosedListener

OnAdInspectorClosedListener: ((error?) => void)
คำจำกัดความของอินเทอร์เฟซสำหรับ Callback ที่จะเรียกใช้เมื่อ UI เครื่องมือตรวจสอบโฆษณา ปิด

PrecisionType

PrecisionType: typeof PrecisionType[keyof typeof PrecisionType]
ความแม่นยําของมูลค่าโฆษณาที่รายงาน
พร็อพเพอร์ตี้
ESTIMATED
มูลค่าโฆษณาโดยประมาณจากข้อมูลรวม
PRECISE
มูลค่าที่ตรงกับค่าใช้จ่ายโฆษณานี้
PUBLISHER_PROVIDED
มูลค่าโฆษณาที่ผู้เผยแพร่โฆษณาระบุ เช่น CPM ที่กำหนดเองใน กลุ่มสื่อกลาง
UNKNOWN
มูลค่าโฆษณาที่มีความแม่นยําที่ไม่รู้จัก

PrivacyOptionsRequirementStatus

PrivacyOptionsRequirementStatus: typeof PrivacyOptionsRequirementStatus[keyof typeof PrivacyOptionsRequirementStatus]
สถานะข้อกำหนดของตัวเลือกความเป็นส่วนตัว
พร็อพเพอร์ตี้
NOT_REQUIRED
ไม่จำเป็นต้องมีจุดแรกเข้าของตัวเลือกความเป็นส่วนตัว
REQUIRED
ต้องมีจุดแรกเข้าของตัวเลือกความเป็นส่วนตัว
UNKNOWN
ไม่ทราบสถานะข้อกำหนดตัวเลือกความเป็นส่วนตัว

PublisherPrivacyPersonalizationState

PublisherPrivacyPersonalizationState: typeof PublisherPrivacyPersonalizationState[keyof typeof PublisherPrivacyPersonalizationState]
ระบุสถานะการปรับตามโปรไฟล์ของผู้ใช้ของการดูแลด้านความเป็นส่วนตัวสำหรับผู้เผยแพร่โฆษณา
พร็อพเพอร์ตี้
DEFAULT
ระบุว่าคำขอโฆษณาควรได้รับการดูแลด้านความเป็นส่วนตัวของผู้เผยแพร่โฆษณาเริ่มต้น
DISABLED
ระบุว่าคำขอโฆษณาควรได้รับการ การดูแลความเป็นส่วนตัวของผู้เผยแพร่โฆษณาที่ไม่ได้ปรับตามโปรไฟล์ของผู้ใช้
ENABLED
ระบุว่าคำขอโฆษณาควรได้รับการ ดูแลด้านความเป็นส่วนตัวของผู้เผยแพร่โฆษณาที่ปรับตามโปรไฟล์ของผู้ใช้

ResizeMode

ResizeMode: typeof ResizeMode[keyof typeof ResizeMode]
ตัวเลือกในการปรับแต่งโหมดการปรับขนาดของเนื้อหารูปภาพใน NativeAdMediaView
พร็อพเพอร์ตี้
CONTAIN
ปรับขนาดอย่างสม่ำเสมอให้พอดีกับภายในมุมมอง

รูปภาพ ความสูงและความกว้างจะปรับขนาดพร้อมกันเพื่อให้แต่ละ มิติมีขนาดน้อยกว่าหรือเท่ากับมิติที่สอดคล้องกัน ของมุมมอง ระบบจะปรับขนาดรูปภาพให้พอดีกับภายใน ของมุมมองโดยไม่บิดเบือนสัดส่วนภาพหรือ ครอบตัด
COVER
ปรับขนาดอย่างสม่ำเสมอเพื่อให้ครอบคลุมวิว

ระบบจะปรับขนาดความสูง และความกว้างของรูปภาพพร้อมกันเพื่อให้แต่ละมิติ มีขนาดเท่ากับหรือใหญ่กว่ามิติที่สอดคล้องกันของ วิว ระบบจะครอบตัดรูปภาพให้พอดีกับมุมมองโดยไม่บิดเบือนสัดส่วนภาพ
STRETCH
ปรับขนาดความกว้างและความสูงแยกกันเพื่อให้พอดีกับมุมมอง

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

ResolvedAdSize

ResolvedAdSize: FixedAdSize | FluidAdSize
แสดงสถานะสุดท้ายของขนาดโฆษณาหลังจากที่โหลดโฆษณาแล้ว

สำหรับโฆษณาส่วนใหญ่ สถานะนี้จะเปลี่ยนเป็น FixedAdSize ที่มีขนาด width และ height ที่แน่นอน สำหรับโฆษณาแบนเนอร์ที่มีขนาดแบบไดนามิก ระบบจะแปลงเป็น FluidAdSize ซึ่งมีการจัดการมิติข้อมูลโดยลำดับชั้นการแสดงผล

SwipeGestureDirection

SwipeGestureDirection: typeof SwipeGestureDirection[keyof typeof SwipeGestureDirection]
วิธีการสำหรับท่าทางการปัดคลิกที่กำหนดเอง
พร็อพเพอร์ตี้
DOWN
ปัดลง
LEFT
ปัดไปทางซ้าย
RIGHT
ปัดไปทางขวา
UP
ปัดขึ้น

ตัวแปร

AdSize

AdSize: {
  BANNER: FixedAdSize;
  custom: ((width, height) => FixedAdSize);
  FLUID: FluidAdSize;
  FULL_BANNER: FixedAdSize;
  getCurrentOrientationInlineAdaptiveBannerAdSize: ((width) => InlineAdaptiveAdSize);
  getInlineAdaptiveBannerAdSize: ((width, maxHeight) => InlineAdaptiveAdSize);
  getLandscapeInlineAdaptiveBannerAdSize: ((width) => InlineAdaptiveAdSize);
  getLargeAnchoredAdaptiveBannerAdSize: ((width) => Promise<LargeAnchoredAdaptiveAdSize>);
  getLargeLandscapeAnchoredAdaptiveBannerAdSize: ((width) => Promise<LargeAnchoredAdaptiveAdSize>);
  getLargePortraitAnchoredAdaptiveBannerAdSize: ((width) => Promise<LargeAnchoredAdaptiveAdSize>);
  getPortraitInlineAdaptiveBannerAdSize: ((width) => InlineAdaptiveAdSize);
  LARGE_BANNER: FixedAdSize;
  LEADERBOARD: FixedAdSize;
  MEDIUM_RECTANGLE: FixedAdSize;
}
ขนาดโฆษณาที่กําหนดไว้ล่วงหน้าและเมธอดช่วยสําหรับการสร้างขนาดที่ปรับเปลี่ยนได้และ ขนาดที่กําหนดเอง

ฟังก์ชัน

canRequestAds

canRequestAds(): boolean
ตรวจสอบว่าสถานะความยินยอมปัจจุบันอนุญาตให้คุณขอโฆษณาหรือไม่
การคืนสินค้า
boolean true หากคุณขอโฆษณาได้ false มิฉะนั้น

getConsentStatus

getConsentStatus(): ConsentStatus
รับสถานะความยินยอมปัจจุบันของผู้ใช้
การคืนสินค้า
ConsentStatus สถานะความยินยอมปัจจุบัน

getInitializationStatus

getInitializationStatus(): InitializationStatus
รับสถานะการเริ่มต้น SDK

ใช้เมธอดนี้เพื่อ ตรวจสอบว่า SDK เริ่มต้นเสร็จแล้วหรือไม่ และเพื่อตรวจสอบ สถานะของอะแดปเตอร์สื่อกลางแต่ละรายการ
การคืนสินค้า
InitializationStatus สถานะการเริ่มต้นปัจจุบัน

getPrivacyOptionsRequirementStatus

getPrivacyOptionsRequirementStatus(): PrivacyOptionsRequirementStatus
ตรวจสอบว่าแอปของคุณต้องมีจุดแรกเข้าของตัวเลือกความเป็นส่วนตัวหรือไม่

หากต้องมีจุดแรกเข้า ให้เพิ่มองค์ประกอบ UI ที่มองเห็นได้และ โต้ตอบได้ลงในแอปซึ่งเรียกใช้ showPrivacyOptionsForm เพื่อแสดงแบบฟอร์มตัวเลือกความเป็นส่วนตัว หากไม่จำเป็นต้องมีจุดแรกเข้า ให้กำหนดค่าองค์ประกอบ UI ไม่ให้แสดงและโต้ตอบไม่ได้
การคืนสินค้า
PrivacyOptionsRequirementStatus สถานะข้อกำหนดของตัวเลือกความเป็นส่วนตัว

getRequestConfiguration

getRequestConfiguration(): RequestConfiguration
รับการกำหนดค่าคำขอส่วนกลาง

ใช้วิธีนี้ เพื่อเรียกการกำหนดค่าคำขอปัจจุบันที่ ใช้กับทั่วโลก
การคืนสินค้า
RequestConfiguration การกำหนดค่าคำขอส่วนกลางปัจจุบัน

initialize

initialize(config, onInitializationComplete?): void
เริ่มต้นใช้งาน Google Mobile Ads SDK

เรียกใช้เมธอดนี้ ก่อนโหลดโฆษณาและก่อนโต้ตอบกับส่วนอื่นๆ ของ Google Mobile Ads SDK
พารามิเตอร์
config: InitializationConfig ตัวเลือกในการควบคุมการเริ่มต้น SDK
Optional onInitializationComplete: ((status) => void) ฟังก์ชัน Callback ที่จะเรียกใช้เมื่อ SDK เริ่มต้นเสร็จสิ้น

isConsentFormAvailable

isConsentFormAvailable(): boolean
ตรวจสอบว่ามีแบบฟอร์มความยินยอมหรือไม่
การคืนสินค้า
boolean true หากมีแบบฟอร์มความยินยอม false หรือไม่

loadAndShowConsentFormIfRequired

loadAndShowConsentFormIfRequired(onDismissed?): void
โหลดแบบฟอร์มความยินยอมและแสดงต่อผู้ใช้หากสถานะความยินยอมปัจจุบัน กำหนดให้ทำเช่นนั้น (เช่น สถานะเป็น REQUIRED)
พารามิเตอร์
Optional onDismissed: ((error?) => void) ฟังก์ชัน Callback ที่เรียกใช้เมื่อปิดแบบฟอร์ม หรือหากไม่จำเป็นต้องใช้แบบฟอร์ม โดยมีFormError ที่ไม่บังคับ หากการนำเสนอไม่สำเร็จ

openAdInspector

openAdInspector(_listener): void
เปิดการวางซ้อนเครื่องมือตรวจสอบโฆษณาของ Google Mobile Ads SDK

ใช้วิธีนี้เพื่อแก้ไขข้อบกพร่องในการตั้งค่าสื่อกลางและแหล่งที่มาของโฆษณา
พารามิเตอร์
_listener: OnAdInspectorClosedListener

openDebugMenu

openDebugMenu(adUnitId): void
เปิดเมนูแก้ไขข้อบกพร่อง

ใช้วิธีนี้เพื่อเปิดเมนูแก้ไขข้อบกพร่อง สำหรับหน่วยโฆษณาที่เฉพาะเจาะจงเพื่อช่วยในการทดสอบและ การแก้ปัญหาการกำหนดค่าโฆษณา
พารามิเตอร์
adUnitId: string รหัสหน่วยโฆษณาที่จะเปิดเมนูการแก้ไขข้อบกพร่อง

parseLoadAdError

parseLoadAdError(error): LoadAdError
แยกวิเคราะห์ข้อผิดพลาดดั้งเดิมที่เกิดขึ้นระหว่างการโหลดโฆษณาและรวมไว้ใน LoadAdError
พารามิเตอร์
error: unknown ออบเจ็กต์ข้อผิดพลาดที่โมดูลเนทีฟส่งคืน
การคืนสินค้า
LoadAdError ออบเจ็กต์ LoadAdError ที่แยกวิเคราะห์แล้ว

requestConsentInfoUpdate

requestConsentInfoUpdate(params?, onComplete?): void
ขออัปเดตข้อมูลความยินยอม

API นี้ต้องเรียกใช้ในเซสชันของแอปแต่ละรายการก่อนเรียกใช้ getConsentStatus

หลังจากเรียกใช้ API นี้แล้ว ระบบจะอัปเดตค่าที่ส่งคืนของ getConsentStatus พร้อมกันเพื่อเก็บสถานะความยินยอมจากเซสชันของแอปก่อนหน้า หากมี

คุณอัปเดต getConsentStatus อีกครั้งเป็นสถานะล่าสุดได้หลังจากเรียกใช้onComplete Callback
พารามิเตอร์
Optional params: ConsentRequestParameters การกำหนดค่าที่ไม่บังคับสำหรับการแก้ไขข้อบกพร่องและการกำหนดเป้าหมาย
Optional onComplete: ((error?) => void) ฟังก์ชัน Callback ที่เรียกใช้เมื่อการอัปเดตข้อมูลความยินยอม เสร็จสิ้น โดยมี FormError ที่ไม่บังคับหากคำขอไม่สำเร็จ

รีเซ็ต

reset(): void
ล้างสถานะความยินยอมทั้งหมดจากพื้นที่เก็บข้อมูลถาวร

ใช้ เพื่อวัตถุประสงค์ในการแก้ไขข้อบกพร่องเท่านั้น

setPublisherFirstPartyIdEnabled

setPublisherFirstPartyIdEnabled(enabled): void
ควบคุมว่าจะเปิดใช้รหัสของบุคคลที่หนึ่งของผู้เผยแพร่โฆษณาหรือไม่

เปิดใช้ หรือปิดใช้รหัสของบุคคลที่หนึ่งของผู้เผยแพร่โฆษณาใน Google Mobile Ads SDK เดิมเรียกว่าคีย์แอปเดียวกัน
ดูเพิ่มเติม
พารามิเตอร์
enabled: boolean จริงเพื่อเปิดใช้ตัวระบุของบุคคลที่หนึ่งของผู้เผยแพร่โฆษณา เท็จเพื่อ ปิดใช้ ค่าเริ่มต้นคือ true

setRequestConfiguration

setRequestConfiguration(_config): void
กำหนดค่าคำขอส่วนกลางเพื่อการปฏิบัติตามข้อกำหนดและ การกำหนดเป้าหมาย

ใช้วิธีนี้เพื่อระบุรายละเอียดการกำหนดเป้าหมาย เช่น การจัดประเภทเนื้อหาโฆษณาสูงสุด การตั้งค่าการปฏิบัติตามข้อกำหนด เช่น แท็กสำหรับการดูแลตามอายุ และรหัสอุปกรณ์ทดสอบ
พารามิเตอร์
_config: RequestConfiguration

setUserControlledAppVolume

setUserControlledAppVolume(volume): void
ตั้งค่าระดับเสียงของแอปพลิเคชันที่ผู้ใช้ควบคุม

ใช้วิธีนี้เพื่อปรับระดับเสียงของโฆษณาทั้งหมดเมื่อเทียบกับเอาต์พุตเสียงอื่นๆ ในอุปกรณ์
พารามิเตอร์
volume: number ระดับเสียงระหว่าง 0.0 (เงียบ) ถึง 1.0 (สูงสุด) ค่าจุดลอยตัวใดก็ได้ภายในช่วงนี้ถือว่าถูกต้อง (เช่น 0.001 หรือ 0.33333) ค่านี้ไม่ได้จำกัด เฉพาะการเพิ่มขนาดทีละขั้น เช่น 0.1

setUserMutedApp

setUserMutedApp(muted): void
กำหนดว่าแอปพลิเคชันจะปิดเสียงหรือไม่

ใช้วิธีนี้ เพื่อควบคุมสถานะปิดเสียงเริ่มต้นของโฆษณาที่ตามมา
พารามิเตอร์
muted: boolean ควรปิดเสียงแอปพลิเคชันหรือไม่ ค่าเริ่มต้นคือ false

showPrivacyOptionsForm

showPrivacyOptionsForm(onDismissed?): void
แสดงแบบฟอร์มตัวเลือกความเป็นส่วนตัว

แสดงแบบฟอร์มตัวเลือกความเป็นส่วนตัวหาก getPrivacyOptionsRequirementStatus เป็น REQUIRED

ควรเรียกใช้เมธอดนี้เมื่อตอบสนองต่อข้อมูลจากผู้ใช้เพื่อขอให้แสดงแบบฟอร์มตัวเลือกความเป็นส่วนตัวเท่านั้น

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

ระบบจะเรียกใช้onDismissed Callback หลังจากที่ผู้ใช้เห็นแบบฟอร์ม เลือกตัวเลือก และปิดแบบฟอร์ม นอกจากนี้ยังอาจแสดงผลเป็น FormError ในกรณีต่อไปนี้
  • แบบฟอร์มไม่พร้อมใช้งาน
  • แบบฟอร์มแสดงไม่สำเร็จ
  • ระบบยังคงโหลดแบบฟอร์มล่วงหน้าอยู่
พารามิเตอร์
Optional onDismissed: ((error?) => void) ฟังก์ชัน Callback ที่เรียกใช้เมื่อปิดแบบฟอร์ม โดยมี FormError ที่ไม่บังคับหากการนำเสนอไม่สำเร็จ