Mô-đun @google/mobile-ads cung cấp các giao diện, lớp và hàm cấp cao nhất của TypeScript cốt lõi để tích hợp Quảng cáo của Google trên thiết bị di động vào các ứng dụng React Native.
Tổng quan
-
Vòng đời và quá trình khởi chạy SDK: Sử dụng
initializevớiInitializationConfigđể khởi chạy SDK và kiểm tra trạng thái khởi chạy bộ chuyển đổi bằnggetInitializationStatusvàInitializationStatus. -
User Messaging Platform (UMP): Quản lý sự đồng ý của người dùng bằng
requestConsentInfoUpdate,loadAndShowConsentFormIfRequired,showPrivacyOptionsFormvà kiểm tra trạng thái đồng ý bằnggetConsentStatusvàcanRequestAds. -
Cấu hình yêu cầu: Xác định chế độ cài đặt chính sách và tiêu chí nhắm mục tiêu trên toàn cầu bằng
setRequestConfigurationvàRequestConfiguration, định cấu hình các lựa chọn nhưAgeRestrictedTreatment,MaxAdContentRatingvàPublisherPrivacyPersonalizationState. -
Định dạng quảng cáo: Tải và trình bày quảng cáo bằng cách sử dụng các lớp định dạng như
AppOpenAd,InterstitialAd,RewardedAdvàRewardedInterstitialAd. -
Công cụ dành cho nhà phát triển: Kiểm tra việc phân phối quảng cáo, trạng thái bộ chuyển đổi và cấu hình SDK theo thời gian thực bằng cách sử dụng
openAdInspectorhoặcopenDebugMenu.
| Loại bí danh | |
|---|---|
Adapter
|
Biểu thị các trạng thái khởi chạy có thể có của một bộ chuyển đổi dàn xếp.
|
Ad
|
Vị trí đặt biểu tượng Lựa chọn quảng cáo trong lượt xem quảng cáo. |
Ad
|
Định dạng của quảng cáo đang được yêu cầu. |
Ad
|
Thông tin lỗi về lý do khiến công cụ kiểm tra quảng cáo không hoạt động.
|
Ad
|
Các lỗi ảnh hưởng đến việc mở hoặc vận hành công cụ kiểm tra quảng cáo.
|
Ad
|
Các lựa chọn về hướng cho quảng cáo biểu ngữ thích ứng dạng cùng dòng và biểu ngữ thích ứng cố định cỡ lớn.
|
Ad
|
Biểu thị kích thước của một quảng cáo. |
Age
|
Xác định các lựa chọn xử lý bị giới hạn độ tuổi cho yêu cầu quảng cáo.
|
Consent
|
Giá trị trạng thái đồng ý. |
Debug
|
Giá trị gỡ lỗi để kiểm thử vị trí địa lý. |
Form
|
Biểu thị mã lỗi cho các lỗi trong thao tác biểu mẫu Nền tảng thông báo cho người dùng (UMP).
|
Full
|
|
Load
|
Biểu thị mã lỗi cho các lỗi trong thao tác tải quảng cáo.
|
Max
|
Xác định mức phân loại nội dung quảng cáo tối đa cho ứng dụng, phân loại các loại quảng cáo có thể hiển thị.
|
Native
|
Tên dùng để xác định các thành phần quảng cáo gốc chuẩn.
|
Native
|
Xác định định dạng của một quảng cáo gốc đã tải. |
Native
|
Lựa chọn ưu tiên về tỷ lệ khung hình của thành phần nghe nhìn trong quảng cáo gốc được trả về.
|
On
|
Định nghĩa giao diện cho một lệnh gọi lại sẽ được gọi khi giao diện người dùng công cụ kiểm tra quảng cáo đóng.
|
Precision
|
Độ chính xác của giá trị quảng cáo được báo cáo. |
Privacy
|
Trạng thái yêu cầu về các lựa chọn về quyền riêng tư. |
Publisher
|
Cho biết các trạng thái cá nhân hoá Cách nhà xuất bản xử lý quyền riêng tư.
|
Resize
|
Các lựa chọn để tuỳ chỉnh chế độ đổi kích thước của nội dung hình ảnh trong NativeAdMediaView.
|
Resolved
|
Biểu thị trạng thái được phân giải cuối cùng của kích thước quảng cáo sau khi quảng cáo đã tải.
|
Swipe
|
Hướng dẫn về cử chỉ vuốt khi nhấp tuỳ chỉnh. |
| Biến | |
|---|---|
Ad
|
Kích thước quảng cáo được xác định trước và các phương thức trợ giúp để tạo kích thước thích ứng và tuỳ chỉnh.
|
| Hàm | |
|---|---|
can
|
Kiểm tra xem trạng thái đồng ý hiện tại có cho phép bạn yêu cầu quảng cáo hay không.
|
get
|
Lấy trạng thái đồng ý hiện tại của người dùng. |
get
|
Lấy trạng thái khởi chạy SDK. |
get
|
Kiểm tra xem ứng dụng của bạn có cần một điểm truy cập các lựa chọn về quyền riêng tư hay không.
|
get
|
Lấy cấu hình yêu cầu chung. |
initialize
|
Khởi chạy Google Mobile Ads SDK. |
is
|
Kiểm tra xem có biểu mẫu yêu cầu đồng ý hay không. |
load
|
Tải biểu mẫu yêu cầu sự đồng ý và trình bày biểu mẫu đó cho người dùng nếu trạng thái đồng ý hiện tại của họ yêu cầu (ví dụ: trạng thái là REQUIRED).
|
open
|
Mở lớp phủ Công cụ kiểm tra quảng cáo của Google Mobile Ads SDK.
|
open
|
Mở trình đơn gỡ lỗi. |
parse
|
Phân tích cú pháp một lỗi gốc phát sinh trong quá trình tải quảng cáo và gói lỗi đó trong một LoadAdError.
|
request
|
Yêu cầu cập nhật thông tin về sự đồng ý. |
reset
|
Xoá tất cả trạng thái đồng ý khỏi bộ nhớ liên tục.
|
set
|
Kiểm soát việc có bật mã nhận dạng bên thứ nhất của nhà xuất bản hay không.
|
set
|
Đặt cấu hình yêu cầu chung để tuân thủ và nhắm mục tiêu.
|
set
|
Đặt âm lượng âm thanh của ứng dụng do người dùng kiểm soát.
|
set
|
Đặt xem ứng dụng có bị tắt tiếng hay không. |
show
|
Hiện biểu mẫu lựa chọn về quyền riêng tư. |
Loại bí danh
AdapterState
AdapterState: typeof AdapterState[keyof typeof AdapterState]
AdChoicesPlacement
AdChoicesPlacement:
typeof AdChoicesPlacement[keyof typeof AdChoicesPlacement]
AdFormat
Định dạng của quảng cáo đang được yêu cầu.
AdInspectorError
AdInspectorError:
BaseError<AdInspectorErrorCode>
AdInspectorErrorCode
AdInspectorErrorCode:
typeof AdInspectorErrorCode[keyof typeof AdInspectorErrorCode]
AdOrientation
AdOrientation: typeof AdOrientation[keyof typeof AdOrientation]
| Thuộc tính | |
|---|---|
CURRENT
|
|
LANDSCAPE
|
|
PORTRAIT
|
|
AdSize
Biểu thị kích thước của một quảng cáo.
Có thể là một trong những tập hợp kích thước được xác định trước (ví dụ: AdSize.LARGE_BANNER) hoặc kích thước thích ứng.
Có thể là một trong những tập hợp kích thước được xác định trước (ví dụ: AdSize.LARGE_BANNER) hoặc kích thước thích ứng.
AgeRestrictedTreatment
AgeRestrictedTreatment:
typeof AgeRestrictedTreatment[keyof typeof AgeRestrictedTreatment]
ConsentStatus
ConsentStatus: typeof ConsentStatus[keyof typeof ConsentStatus]
DebugGeography
DebugGeography: typeof DebugGeography[keyof typeof DebugGeography]
FormErrorCode
FormErrorCode: typeof FormErrorCode[keyof typeof FormErrorCode]
FullScreenContentErrorCode
FullScreenContentErrorCode:
typeof FullScreenContentErrorCode[keyof typeof FullScreenContentErrorCode]
| Thuộc tính | |
|---|---|
AD_
|
Quảng cáo đã xuất hiện. |
AD_
|
Quảng cáo chưa sẵn sàng hiển thị. |
AD_
|
Quảng cáo quá lớn so với cảnh (chỉ dành cho iOS). |
APP_
|
Ứng dụng không ở nền trước. |
INTERNAL_
|
Đã xảy ra lỗi nội bộ; ví dụ: đã xảy ra một ngoại lệ khi chuẩn bị hiển thị nội dung quảng cáo.
|
MEDIATION_
|
Bộ chuyển đổi dàn xếp không hiển thị được quảng cáo. Hãy xem FullScreenContentError.mediationAdError để biết nguyên nhân cơ bản.
|
UNKNOWN
|
Không thể liên kết mã lỗi với một mã lỗi đã biết.
|
LoadAdErrorCode
LoadAdErrorCode: typeof LoadAdErrorCode[keyof typeof LoadAdErrorCode]
MaxAdContentRating
MaxAdContentRating:
typeof MaxAdContentRating[keyof typeof MaxAdContentRating]
NativeAdAssetNames
NativeAdAssetNames:
typeof NativeAdAssetNames[keyof typeof NativeAdAssetNames]
NativeAdType
NativeAdType: typeof NativeAdType[keyof typeof NativeAdType]
| Thuộc tính | |
|---|---|
BANNER
|
Quảng cáo biểu ngữ. |
CUSTOM_
|
Quảng cáo ở định dạng gốc tuỳ chỉnh. |
NATIVE
|
Quảng cáo gốc. |
NativeMediaAspectRatio
NativeMediaAspectRatio:
typeof NativeMediaAspectRatio[keyof typeof NativeMediaAspectRatio]
OnAdInspectorClosedListener
OnAdInspectorClosedListener:
((error?) => void)
PrecisionType
PrecisionType: typeof PrecisionType[keyof typeof PrecisionType]
PrivacyOptionsRequirementStatus
PrivacyOptionsRequirementStatus:
typeof PrivacyOptionsRequirementStatus[keyof typeof PrivacyOptionsRequirementStatus]
PublisherPrivacyPersonalizationState
PublisherPrivacyPersonalizationState: typeof PublisherPrivacyPersonalizationState[keyof typeof PublisherPrivacyPersonalizationState]
ResizeMode
ResizeMode: typeof ResizeMode[keyof typeof ResizeMode]
ResolvedAdSize
ResolvedAdSize:
FixedAdSize | FluidAdSize
Đối với hầu hết các quảng cáo, trạng thái này sẽ phân giải thành một FixedAdSize có kích thước chính xác là
width và height.
Đối với quảng cáo biểu ngữ có kích thước linh hoạt, điều này sẽ chuyển thành một FluidAdSize, trong đó các kích thước được quản lý theo hệ phân cấp view.
SwipeGestureDirection
SwipeGestureDirection:
typeof SwipeGestureDirection[keyof typeof SwipeGestureDirection]
| Thuộc tính | |
|---|---|
DOWN
|
Vuốt xuống. |
LEFT
|
Vuốt sang trái. |
RIGHT
|
Vuốt sang phải. |
UP
|
Vuốt lên. |
Biến
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;
}
Hàm
canRequestAds
canRequestAds(): boolean
Kiểm tra xem trạng thái đồng ý hiện tại có cho phép bạn yêu cầu quảng cáo hay không.
| Giá trị trả về | |
|---|---|
boolean
|
true nếu bạn có thể yêu cầu quảng cáo, false nếu không.
|
getConsentStatus
getConsentStatus(): ConsentStatus
Lấy trạng thái đồng ý hiện tại của người dùng.
| Giá trị trả về | |
|---|---|
ConsentStatus
|
Trạng thái đồng ý hiện tại. |
getInitializationStatus
getInitializationStatus(): InitializationStatus
Lấy trạng thái khởi chạy SDK.
Sử dụng phương thức này để kiểm tra xem SDK đã hoàn tất quá trình khởi chạy hay chưa và để kiểm tra trạng thái của từng bộ chuyển đổi dàn xếp.
Sử dụng phương thức này để kiểm tra xem SDK đã hoàn tất quá trình khởi chạy hay chưa và để kiểm tra trạng thái của từng bộ chuyển đổi dàn xếp.
| Giá trị trả về | |
|---|---|
InitializationStatus
|
Trạng thái khởi tạo hiện tại. |
getPrivacyOptionsRequirementStatus
getPrivacyOptionsRequirementStatus(): PrivacyOptionsRequirementStatus
Kiểm tra xem ứng dụng của bạn có cần một điểm truy cập các lựa chọn về quyền riêng tư hay không.
Nếu cần một điểm truy cập, hãy thêm một phần tử trên giao diện người dùng có thể nhìn thấy và tương tác vào ứng dụng của bạn để gọi showPrivacyOptionsForm nhằm hiển thị biểu mẫu các lựa chọn về quyền riêng tư. Nếu không bắt buộc phải có một điểm truy cập, hãy định cấu hình phần tử trên giao diện người dùng của bạn sao cho không hiển thị và tương tác được.
Nếu cần một điểm truy cập, hãy thêm một phần tử trên giao diện người dùng có thể nhìn thấy và tương tác vào ứng dụng của bạn để gọi showPrivacyOptionsForm nhằm hiển thị biểu mẫu các lựa chọn về quyền riêng tư. Nếu không bắt buộc phải có một điểm truy cập, hãy định cấu hình phần tử trên giao diện người dùng của bạn sao cho không hiển thị và tương tác được.
| Giá trị trả về | |
|---|---|
PrivacyOptionsRequirementStatus
|
Trạng thái yêu cầu đối với lựa chọn về quyền riêng tư. |
getRequestConfiguration
getRequestConfiguration(): RequestConfiguration
Lấy cấu hình yêu cầu chung.
Sử dụng phương thức này để truy xuất cấu hình yêu cầu hiện tại đã được áp dụng trên toàn cầu.
Sử dụng phương thức này để truy xuất cấu hình yêu cầu hiện tại đã được áp dụng trên toàn cầu.
| Giá trị trả về | |
|---|---|
RequestConfiguration
|
Cấu hình yêu cầu chung hiện tại. |
initialize
initialize(config,
onInitializationComplete?): void
Khởi chạy Google Mobile Ads SDK.
Gọi phương thức này trước khi tải quảng cáo và trước khi tương tác với phần còn lại của Google Mobile Ads SDK.
Gọi phương thức này trước khi tải quảng cáo và trước khi tương tác với phần còn lại của Google Mobile Ads SDK.
| Thông số | |
|---|---|
config:
InitializationConfig
|
Các lựa chọn để kiểm soát quá trình khởi chạy SDK. |
|
Một hàm callback sẽ chạy khi SDK hoàn tất quá trình khởi động. |
isConsentFormAvailable
isConsentFormAvailable(): boolean
Kiểm tra xem có biểu mẫu yêu cầu đồng ý hay không.
| Giá trị trả về | |
|---|---|
boolean
|
true nếu có biểu mẫu yêu cầu đồng ý, false nếu không.
|
loadAndShowConsentFormIfRequired
loadAndShowConsentFormIfRequired(onDismissed?): void
Tải biểu mẫu yêu cầu sự đồng ý và trình bày biểu mẫu đó cho người dùng nếu trạng thái đồng ý hiện tại của họ yêu cầu (ví dụ: trạng thái là REQUIRED).
| Thông số | |
|---|---|
|
Hàm gọi lại được gọi khi biểu mẫu bị đóng hoặc nếu không cần biểu mẫu, với FormError không bắt buộc nếu quá trình trình bày không thành công. |
openAdInspector
openAdInspector(_listener): void
Mở lớp phủ Công cụ kiểm tra quảng cáo của Google Mobile Ads SDK.
Sử dụng phương thức này để gỡ lỗi chế độ thiết lập dàn xếp và nguồn quảng cáo.
Sử dụng phương thức này để gỡ lỗi chế độ thiết lập dàn xếp và nguồn quảng cáo.
| Thông số | |
|---|---|
_listener:
OnAdInspectorClosedListener
|
|
openDebugMenu
openDebugMenu(adUnitId): void
Mở trình đơn gỡ lỗi.
Sử dụng phương thức này để mở trình đơn gỡ lỗi cho một đơn vị quảng cáo cụ thể nhằm hỗ trợ kiểm thử và khắc phục sự cố về cấu hình quảng cáo.
Sử dụng phương thức này để mở trình đơn gỡ lỗi cho một đơn vị quảng cáo cụ thể nhằm hỗ trợ kiểm thử và khắc phục sự cố về cấu hình quảng cáo.
| Thông số | |
|---|---|
adUnitId: string
|
Mã đơn vị quảng cáo để mở trình đơn gỡ lỗi. |
parseLoadAdError
parseLoadAdError(error): LoadAdError
Phân tích cú pháp một lỗi gốc phát sinh trong quá trình tải quảng cáo và gói lỗi đó trong một LoadAdError.
| Thông số | |
|---|---|
error: unknown
|
Đối tượng lỗi do mô-đun gốc tạo ra. |
| Giá trị trả về | |
|---|---|
LoadAdError
|
Một đối tượng LoadAdError đã phân tích cú pháp. |
requestConsentInfoUpdate
requestConsentInfoUpdate(params?, onComplete?): void
Yêu cầu cập nhật thông tin về sự đồng ý.
Bạn phải gọi API này trong mỗi phiên ứng dụng trước khi gọi getConsentStatus.
Sau khi gọi API này, giá trị trả về getConsentStatus sẽ được cập nhật đồng bộ để giữ trạng thái đồng ý từ phiên ứng dụng trước đó (nếu có).
Bạn có thể cập nhật lại getConsentStatus thành trạng thái mới nhất sau khi gọi lệnh gọi lại
Bạn phải gọi API này trong mỗi phiên ứng dụng trước khi gọi getConsentStatus.
Sau khi gọi API này, giá trị trả về getConsentStatus sẽ được cập nhật đồng bộ để giữ trạng thái đồng ý từ phiên ứng dụng trước đó (nếu có).
Bạn có thể cập nhật lại getConsentStatus thành trạng thái mới nhất sau khi gọi lệnh gọi lại
onComplete.
| Thông số | |
|---|---|
|
Cấu hình không bắt buộc để gỡ lỗi và nhắm mục tiêu. |
|
Hàm callback được gọi khi quá trình cập nhật thông tin về sự đồng ý hoàn tất, có FormError không bắt buộc nếu yêu cầu không thành công. |
reset
reset(): void
Xoá tất cả trạng thái đồng ý khỏi bộ nhớ liên tục.
Chỉ sử dụng cho mục đích gỡ lỗi.
Chỉ sử dụng cho mục đích gỡ lỗi.
setPublisherFirstPartyIdEnabled
setPublisherFirstPartyIdEnabled(enabled): void
Kiểm soát việc có bật mã nhận dạng bên thứ nhất của nhà xuất bản hay không.
Bật hoặc tắt mã nhận dạng bên thứ nhất của nhà xuất bản trong Google Mobile Ads SDK (trước đây gọi là khoá cho cùng ứng dụng).
Bật hoặc tắt mã nhận dạng bên thứ nhất của nhà xuất bản trong Google Mobile Ads SDK (trước đây gọi là khoá cho cùng ứng dụng).
| Thông số | |
|---|---|
enabled: boolean
|
True để bật mã nhận dạng bên thứ nhất của nhà xuất bản; false để tắt. Giá trị mặc định là true.
|
setRequestConfiguration
setRequestConfiguration(_config): void
Đặt cấu hình yêu cầu chung cho việc tuân thủ và nhắm mục tiêu.
Sử dụng phương thức này để chỉ định thông tin chi tiết về việc nhắm mục tiêu, chẳng hạn như mức phân loại nội dung quảng cáo tối đa, chế độ cài đặt tuân thủ (chẳng hạn như thẻ xử lý theo độ tuổi) và mã nhận dạng thiết bị thử nghiệm.
Sử dụng phương thức này để chỉ định thông tin chi tiết về việc nhắm mục tiêu, chẳng hạn như mức phân loại nội dung quảng cáo tối đa, chế độ cài đặt tuân thủ (chẳng hạn như thẻ xử lý theo độ tuổi) và mã nhận dạng thiết bị thử nghiệm.
| Thông số | |
|---|---|
_config:
RequestConfiguration
|
|
setUserControlledAppVolume
setUserControlledAppVolume(volume): void
Đặt âm lượng âm thanh của ứng dụng do người dùng kiểm soát.
Sử dụng phương thức này để điều chỉnh âm lượng âm thanh của tất cả quảng cáo so với đầu ra âm thanh khác trên thiết bị.
Sử dụng phương thức này để điều chỉnh âm lượng âm thanh của tất cả quảng cáo so với đầu ra âm thanh khác trên thiết bị.
| Thông số | |
|---|---|
volume: number
|
Mức âm lượng, từ 0,0 (im lặng) đến 1,0 (tối đa). Mọi giá trị dấu phẩy động trong phạm vi này đều hợp lệ (ví dụ: 0,001 hoặc 0,33333). Giá trị này không bị giới hạn ở mức tăng kích thước bước cụ thể, chẳng hạn như 0,1. |
setUserMutedApp
setUserMutedApp(muted): void
Đặt xem ứng dụng có bị tắt tiếng hay không.
Sử dụng phương thức này để kiểm soát trạng thái tắt tiếng âm thanh ban đầu của các quảng cáo tiếp theo.
Sử dụng phương thức này để kiểm soát trạng thái tắt tiếng âm thanh ban đầu của các quảng cáo tiếp theo.
| Thông số | |
|---|---|
muted: boolean
|
Có nên tắt tiếng âm thanh của ứng dụng hay không. Giá trị mặc định là false.
|
showPrivacyOptionsForm
showPrivacyOptionsForm(onDismissed?): void
Hiện biểu mẫu lựa chọn về quyền riêng tư.
Hiển thị biểu mẫu lựa chọn về quyền riêng tư nếu getPrivacyOptionsRequirementStatus là
Bạn chỉ nên gọi phương thức này để phản hồi thông tin đầu vào của người dùng nhằm yêu cầu hiển thị biểu mẫu lựa chọn về quyền riêng tư.
SDK sẽ tự động tải sẵn biểu mẫu lựa chọn về quyền riêng tư khi có biểu mẫu. Nếu chưa tải sẵn biểu mẫu nào, SDK sẽ cố gắng tải một biểu mẫu theo cách không đồng bộ.
Lệnh gọi lại
Hiển thị biểu mẫu lựa chọn về quyền riêng tư nếu getPrivacyOptionsRequirementStatus là
REQUIRED.Bạn chỉ nên gọi phương thức này để phản hồi thông tin đầu vào của người dùng nhằm yêu cầu hiển thị biểu mẫu lựa chọn về quyền riêng tư.
SDK sẽ tự động tải sẵn biểu mẫu lựa chọn về quyền riêng tư khi có biểu mẫu. Nếu chưa tải sẵn biểu mẫu nào, SDK sẽ cố gắng tải một biểu mẫu theo cách không đồng bộ.
Lệnh gọi lại
onDismissed sẽ được gọi sau khi người dùng nhìn thấy biểu mẫu, chọn một lựa chọn và đóng biểu mẫu. Phương thức này cũng có thể trả về FormError nếu:
- Biểu mẫu này không hoạt động.
- Biểu mẫu không xuất hiện.
- Biểu mẫu vẫn đang được tải trước.
| Thông số | |
|---|---|
|
Hàm gọi lại được gọi khi biểu mẫu bị đóng, với FormError không bắt buộc nếu quá trình trình bày không thành công. |