Moduł @google/mobile-ads zawiera podstawowe interfejsy, klasy i funkcje najwyższego poziomu w języku TypeScript, które umożliwiają integrację reklam mobilnych Google z aplikacjami React Native.
Przegląd
-
Cykl życia i inicjowanie pakietu SDK: użyj funkcji
initializez funkcjąInitializationConfigdo zainicjowania pakietu SDK i sprawdź stany inicjowania adaptera za pomocą funkcjigetInitializationStatusiInitializationStatus. -
Platforma do personalizowania wiadomości wyświetlanych użytkownikom (UMP): zarządzaj zgodą użytkowników za pomocą funkcji
requestConsentInfoUpdate,loadAndShowConsentFormIfRequiredishowPrivacyOptionsFormoraz sprawdzaj stan zgody użytkownika za pomocą funkcjigetConsentStatusicanRequestAds. -
Request Configuration (Konfiguracja żądania): określ globalne ustawienia kierowania i zasad za pomocą elementów
setRequestConfigurationiRequestConfiguration, konfigurując opcje takie jakAgeRestrictedTreatment,MaxAdContentRatingiPublisherPrivacyPersonalizationState. -
Formaty reklam: wczytuj i wyświetlaj reklamy za pomocą klas formatów, takich jak
AppOpenAd,InterstitialAd,RewardedAdiRewardedInterstitialAd. -
Narzędzia dla deweloperów: sprawdzaj w czasie rzeczywistym wyświetlanie reklam, stan adaptera i konfiguracje pakietu SDK za pomocą
openAdInspectorlubopenDebugMenu.
| Aliasy typów | |
|---|---|
Adapter
|
Reprezentuje możliwe stany inicjowania adaptera zapośredniczenia.
|
Ad
|
Pozycje ikony Informacja w wyświetleniu reklamy. |
Ad
|
Format reklamy, o którą wysyłane jest żądanie. |
Ad
|
Informacje o błędach, które wyjaśniają, dlaczego inspektor reklam nie działa.
|
Ad
|
Błędy wpływające na otwieranie lub działanie inspektora reklam.
|
Ad
|
Opcje orientacji w przypadku wbudowanych banerów adaptacyjnych i dużych zakotwiczonych banerów adaptacyjnych.
|
Ad
|
Określa wymiary reklamy. |
Age
|
Określa opcje przetwarzania żądań reklam z uwzględnieniem ograniczeń wiekowych.
|
Consent
|
Wartości stanu zgody. |
Debug
|
Wartości debugowania na potrzeby testowania lokalizacji. |
Form
|
Reprezentuje kody błędów związane z niepowodzeniami operacji formularza platformy do personalizowania wiadomości wyświetlanych użytkownikom (UMP).
|
Full
|
|
Load
|
Reprezentuje kody błędów w przypadku niepowodzenia operacji wczytywania reklamy.
|
Max
|
Określa maksymalną ocenę treści reklam w aplikacji, klasyfikując typy reklam, które mogą się w niej wyświetlać.
|
Native
|
Nazwy używane do identyfikowania standardowych komponentów reklamy natywnej.
|
Native
|
Określa format wczytanej reklamy natywnej. |
Native
|
Ustawienia dotyczące formatu zwracanych multimediów reklam natywnych.
|
On
|
Definicja interfejsu wywołania zwrotnego, które ma zostać wywołane po zamknięciu interfejsu inspektora reklam.
|
Precision
|
Precyzja raportowanej wartości reklamy. |
Privacy
|
Stan wymagań dotyczących opcji prywatności. |
Publisher
|
Wskazuje stany personalizacji związane z podejściem do prywatności wydawcy.
|
Resize
|
Opcje dostosowywania trybu zmiany rozmiaru treści obrazu w klasie NativeAdMediaView.
|
Resolved
|
Reprezentuje ostateczny stan rozmiaru reklamy po jej wczytaniu.
|
Swipe
|
Instrukcje dotyczące niestandardowych gestów przesuwania kliknięciem. |
| Zmienne | |
|---|---|
Ad
|
Wstępnie zdefiniowane rozmiary reklam i metody pomocnicze do tworzenia reklam adaptacyjnych i o rozmiarach niestandardowych.
|
| Funkcje | |
|---|---|
can
|
Sprawdza, czy bieżący stan zgody użytkownika umożliwia wysyłanie żądań reklam.
|
get
|
Pobiera bieżący stan zgody użytkownika. |
get
|
Pobiera stan inicjowania pakietu SDK. |
get
|
Sprawdza, czy w przypadku Twojej aplikacji wymagany jest punkt wejścia opcji prywatności.
|
get
|
Pobiera globalną konfigurację żądania. |
initialize
|
Inicjuje pakiet SDK do reklam mobilnych Google. |
is
|
Sprawdza, czy dostępny jest formularz zgody. |
load
|
Wczytuje formularz zgody i wyświetla go użytkownikowi, jeśli wymaga tego jego obecny stan zgody (np. stan to REQUIRED).
|
open
|
Otwiera nakładkę inspektora reklam pakietu SDK do reklam mobilnych Google.
|
open
|
Otwiera menu debugowania. |
parse
|
Analizuje błąd natywny zgłoszony podczas wczytywania reklamy i zawiera go w obiekcie LoadAdError.
|
request
|
Wysyła prośbę o aktualizację informacji o zgodzie. |
reset
|
Usuwa z pamięci trwałej wszystkie stany zgody użytkownika.
|
set
|
Określa, czy własny identyfikator wydawcy jest włączony.
|
set
|
Ustawia globalną konfigurację żądań na potrzeby zgodności i kierowania.
|
set
|
Ustawia głośność dźwięku aplikacji sterowanej przez użytkownika.
|
set
|
Określa, czy aplikacja jest wyciszona. |
show
|
Wyświetla formularz opcji prywatności. |
Aliasy typów
AdapterState
AdapterState: typeof AdapterState[keyof typeof AdapterState]
AdChoicesPlacement
AdChoicesPlacement:
typeof AdChoicesPlacement[keyof typeof AdChoicesPlacement]
| Właściwości | |
|---|---|
BOTTOM_
|
Lewy dolny róg reklamy. |
BOTTOM_
|
Prawy dolny róg reklamy. |
TOP_
|
Lewy górny róg reklamy. |
TOP_
|
w prawym górnym rogu reklamy. |
AdFormat
Format reklamy, o którą wysyłane jest żądanie.
AdInspectorError
AdInspectorError:
BaseError<AdInspectorErrorCode>
AdInspectorErrorCode
AdInspectorErrorCode:
typeof AdInspectorErrorCode[keyof typeof AdInspectorErrorCode]
AdOrientation
AdOrientation: typeof AdOrientation[keyof typeof AdOrientation]
| Właściwości | |
|---|---|
CURRENT
|
|
LANDSCAPE
|
|
PORTRAIT
|
|
AdSize
Reprezentuje wymiary reklamy.
Może to być jeden ze wstępnie zdefiniowanych rozmiarów (np. AdSize.LARGE_BANNER) lub rozmiar adaptacyjny.
Może to być jeden ze wstępnie zdefiniowanych rozmiarów (np. AdSize.LARGE_BANNER) lub rozmiar adaptacyjny.
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]
| Właściwości | |
|---|---|
AD_
|
Reklama została już wyświetlona. |
AD_
|
Reklama nie jest gotowa do wyświetlenia. |
AD_
|
Reklama jest za duża w stosunku do sceny (tylko iOS). |
APP_
|
Aplikacja nie jest na pierwszym planie. |
INTERNAL_
|
Wystąpił problem wewnętrzny, np. podczas przygotowywania treści reklamy wystąpił wyjątek.
|
MEDIATION_
|
Adapter mediacji nie zdołał wyświetlić reklamy. Zobacz FullScreenContentError.mediationAdError, aby poznać przyczynę.
|
UNKNOWN
|
Nie udało się przypisać kodu błędu do znanego kodu błędu.
|
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]
| Właściwości | |
|---|---|
BANNER
|
Baner reklamowy. |
CUSTOM_
|
Reklama w niestandardowym formacie natywnym. |
NATIVE
|
Reklama natywna. |
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]
| Właściwości | |
|---|---|
NOT_
|
Punkt wejścia opcji prywatności nie jest wymagany.
|
REQUIRED
|
Punkt wejścia opcji prywatności jest wymagany. |
UNKNOWN
|
Stan wymagania dotyczącego opcji prywatności jest nieznany.
|
PublisherPrivacyPersonalizationState
PublisherPrivacyPersonalizationState: typeof PublisherPrivacyPersonalizationState[keyof typeof PublisherPrivacyPersonalizationState]
ResizeMode
ResizeMode: typeof ResizeMode[keyof typeof ResizeMode]
ResolvedAdSize
ResolvedAdSize:
FixedAdSize | FluidAdSize
W przypadku większości reklam jest to FixedAdSize o dokładnych wymiarach
width i height.
W przypadku banerów reklamowych o rozmiarze dynamicznym jest to wartość FluidAdSize, w której wymiarami zarządza hierarchia widoków.
SwipeGestureDirection
SwipeGestureDirection:
typeof SwipeGestureDirection[keyof typeof SwipeGestureDirection]
| Właściwości | |
|---|---|
DOWN
|
Przesuń palcem w dół. |
LEFT
|
Przesuń palcem w lewo. |
RIGHT
|
Przesuń palcem w prawo. |
UP
|
Przesuń palcem w górę. |
Zmienne
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;
}
Funkcje
canRequestAds
canRequestAds(): boolean
Sprawdza, czy bieżący stan zgody użytkownika pozwala na wysyłanie żądań reklam.
| Zwroty | |
|---|---|
boolean
|
true jeśli możesz wysyłać żądania reklam,
false w przeciwnym razie.
|
getConsentStatus
getConsentStatus(): ConsentStatus
Pobiera bieżący stan zgody użytkownika.
| Zwroty | |
|---|---|
ConsentStatus
|
Bieżący stan zgody. |
getInitializationStatus
getInitializationStatus(): InitializationStatus
Pobiera stan inicjowania pakietu SDK.
Użyj tej metody, aby sprawdzić, czy pakiet SDK zakończył inicjowanie, i aby sprawdzić stan poszczególnych adapterów zapośredniczenia.
Użyj tej metody, aby sprawdzić, czy pakiet SDK zakończył inicjowanie, i aby sprawdzić stan poszczególnych adapterów zapośredniczenia.
| Zwroty | |
|---|---|
InitializationStatus
|
Bieżący stan inicjowania. |
getPrivacyOptionsRequirementStatus
getPrivacyOptionsRequirementStatus(): PrivacyOptionsRequirementStatus
Sprawdza, czy w aplikacji wymagany jest punkt wejścia opcji prywatności.
Jeśli jest wymagany, dodaj do aplikacji widoczny element interfejsu, który można kliknąć i który wywołuje funkcję showPrivacyOptionsForm, aby wyświetlić formularz opcji prywatności. Jeśli punkt wejścia nie jest wymagany, skonfiguruj element interfejsu tak, aby nie był widoczny i nie można było z nim wchodzić w interakcję.
Jeśli jest wymagany, dodaj do aplikacji widoczny element interfejsu, który można kliknąć i który wywołuje funkcję showPrivacyOptionsForm, aby wyświetlić formularz opcji prywatności. Jeśli punkt wejścia nie jest wymagany, skonfiguruj element interfejsu tak, aby nie był widoczny i nie można było z nim wchodzić w interakcję.
| Zwroty | |
|---|---|
PrivacyOptionsRequirementStatus
|
Stan wymagania dotyczącego opcji prywatności. |
getRequestConfiguration
getRequestConfiguration(): RequestConfiguration
Pobiera globalną konfigurację żądania.
Użyj tej metody, aby pobrać bieżącą konfigurację żądania, która została zastosowana globalnie.
Użyj tej metody, aby pobrać bieżącą konfigurację żądania, która została zastosowana globalnie.
| Zwroty | |
|---|---|
RequestConfiguration
|
Bieżąca globalna konfiguracja żądań. |
initialize
initialize(config,
onInitializationComplete?): void
Inicjuje pakiet SDK do reklam mobilnych Google.
Wywołaj tę metodę przed wczytaniem reklamy i przed interakcją z pozostałą częścią pakietu SDK do reklam mobilnych Google.
Wywołaj tę metodę przed wczytaniem reklamy i przed interakcją z pozostałą częścią pakietu SDK do reklam mobilnych Google.
| Parametry | |
|---|---|
config:
InitializationConfig
|
Opcje kontrolowania inicjowania pakietu SDK. |
|
Funkcja wywołania zwrotnego, która ma zostać uruchomiona po zakończeniu inicjowania pakietu SDK. |
isConsentFormAvailable
isConsentFormAvailable(): boolean
Sprawdza, czy dostępny jest formularz zgody.
| Zwroty | |
|---|---|
boolean
|
true jeśli dostępny jest formularz zgody,
false w przeciwnym razie.
|
loadAndShowConsentFormIfRequired
loadAndShowConsentFormIfRequired(onDismissed?): void
Wczytuje formularz zgody i wyświetla go użytkownikowi, jeśli wymaga tego jego bieżący stan zgody (np. stan to REQUIRED).
| Parametry | |
|---|---|
|
Funkcja wywołania zwrotnego wywoływana po zamknięciu formularza lub gdy nie jest on wymagany. W przypadku niepowodzenia wyświetlania może zawierać opcjonalny argument FormError. |
openAdInspector
openAdInspector(_listener): void
Otwiera nakładkę inspektora reklam pakietu SDK do reklam mobilnych Google.
Użyj tej metody, aby debugować konfiguracje zapośredniczenia i źródła reklam.
Użyj tej metody, aby debugować konfiguracje zapośredniczenia i źródła reklam.
| Parametry | |
|---|---|
_listener:
OnAdInspectorClosedListener
|
|
openDebugMenu
openDebugMenu(adUnitId): void
Otwiera menu debugowania.
Użyj tej metody, aby otworzyć menu debugowania dla konkretnej jednostki reklamowej, co ułatwi testowanie i rozwiązywanie problemów z konfiguracjami reklam.
Użyj tej metody, aby otworzyć menu debugowania dla konkretnej jednostki reklamowej, co ułatwi testowanie i rozwiązywanie problemów z konfiguracjami reklam.
| Parametry | |
|---|---|
adUnitId: string
|
Identyfikator jednostki reklamowej, dla której ma zostać otwarte menu debugowania. |
parseLoadAdError
parseLoadAdError(error): LoadAdError
Analizuje błąd natywny zgłoszony podczas wczytywania reklamy i zawiera go w obiekcie LoadAdError.
| Parametry | |
|---|---|
error: unknown
|
Obiekt błędu zgłoszony przez moduł natywny. |
| Zwroty | |
|---|---|
LoadAdError
|
Przeanalizowany obiekt LoadAdError. |
requestConsentInfoUpdate
requestConsentInfoUpdate(params?, onComplete?): void
Wysyła żądanie aktualizacji informacji o uzyskanej zgodzie.
Ten interfejs API musi być wywoływany w każdej sesji aplikacji przed wywołaniem funkcji getConsentStatus.
Po wywołaniu tego interfejsu API wartość zwracana przez funkcję getConsentStatus jest aktualizowana synchronicznie, aby zawierać stan zgody użytkownika z poprzedniej sesji aplikacji (jeśli taka sesja miała miejsce).
Funkcja getConsentStatus może zostać ponownie zaktualizowana do aktualnego stanu po wywołaniu zwrotnej funkcji
Ten interfejs API musi być wywoływany w każdej sesji aplikacji przed wywołaniem funkcji getConsentStatus.
Po wywołaniu tego interfejsu API wartość zwracana przez funkcję getConsentStatus jest aktualizowana synchronicznie, aby zawierać stan zgody użytkownika z poprzedniej sesji aplikacji (jeśli taka sesja miała miejsce).
Funkcja getConsentStatus może zostać ponownie zaktualizowana do aktualnego stanu po wywołaniu zwrotnej funkcji
onComplete.
| Parametry | |
|---|---|
|
Opcjonalne konfiguracje do debugowania i kierowania. |
|
Funkcja wywołania zwrotnego, która jest wywoływana po zakończeniu aktualizacji informacji o zgodzie użytkownika. W przypadku niepowodzenia żądania może zawierać opcjonalny obiekt FormError. |
reset
reset(): void
Usuwa z pamięci trwałej wszystkie stany zgody użytkownika.
Używaj tej funkcji tylko do debugowania.
Używaj tej funkcji tylko do debugowania.
setPublisherFirstPartyIdEnabled
setPublisherFirstPartyIdEnabled(enabled): void
Określa, czy własny identyfikator wydawcy jest włączony.
Włącza lub wyłącza własny identyfikator wydawcy w pakiecie SDK do reklam mobilnych Google, dawniej znany jako funkcja Same App Key.
Włącza lub wyłącza własny identyfikator wydawcy w pakiecie SDK do reklam mobilnych Google, dawniej znany jako funkcja Same App Key.
- Zobacz też
| Parametry | |
|---|---|
enabled: boolean
|
Wartość „true” włącza własny identyfikator wydawcy, a wartość „false” go wyłącza. Domyślna wartość to true.
|
setRequestConfiguration
setRequestConfiguration(_config): void
Ustawia globalną konfigurację żądania na potrzeby zgodności i kierowania.
Użyj tej metody, aby określić szczegóły kierowania, takie jak maksymalna ocena treści reklam, ustawienia zgodności, np. tagowanie treści pod kątem wieku odbiorców, oraz identyfikatory urządzeń testowych.
Użyj tej metody, aby określić szczegóły kierowania, takie jak maksymalna ocena treści reklam, ustawienia zgodności, np. tagowanie treści pod kątem wieku odbiorców, oraz identyfikatory urządzeń testowych.
| Parametry | |
|---|---|
_config:
RequestConfiguration
|
|
setUserControlledAppVolume
setUserControlledAppVolume(volume): void
Ustawia poziom głośności aplikacji kontrolowany przez użytkownika.
Użyj tej metody, aby dostosować poziom głośności wszystkich reklam w stosunku do innych wyjść audio na urządzeniu.
Użyj tej metody, aby dostosować poziom głośności wszystkich reklam w stosunku do innych wyjść audio na urządzeniu.
| Parametry | |
|---|---|
volume: number
|
Poziom głośności z zakresu od 0,0 (cisza) do 1,0 (maksymalny). Dozwolona jest dowolna wartość zmiennoprzecinkowa z tego zakresu (np. 0,001 lub 0,33333). Wartość nie jest ograniczona do określonych przyrostów, np.0,1. |
setUserMutedApp
setUserMutedApp(muted): void
Określa, czy aplikacja jest wyciszona.
Użyj tej metody, aby kontrolować początkowy stan wyciszenia dźwięku w kolejnych reklamach.
Użyj tej metody, aby kontrolować początkowy stan wyciszenia dźwięku w kolejnych reklamach.
| Parametry | |
|---|---|
muted: boolean
|
Czy dźwięk aplikacji ma być wyciszony. Domyślna wartość to false.
|
showPrivacyOptionsForm
showPrivacyOptionsForm(onDismissed?): void
Wyświetla formularz opcji prywatności.
Wyświetla formularz opcji prywatności, jeśli funkcja getPrivacyOptionsRequirementStatus zwraca wartość
Tę metodę należy wywoływać tylko w odpowiedzi na działanie użytkownika, który chce wyświetlić formularz opcji prywatności.
Gdy formularz stanie się dostępny, pakiet SDK automatycznie go wstępnie wczytuje. Jeśli nie został wstępnie wczytany żaden formularz, pakiet SDK spróbuje wczytać go asynchronicznie.
Wywołanie zwrotne
Wyświetla formularz opcji prywatności, jeśli funkcja getPrivacyOptionsRequirementStatus zwraca wartość
REQUIRED.Tę metodę należy wywoływać tylko w odpowiedzi na działanie użytkownika, który chce wyświetlić formularz opcji prywatności.
Gdy formularz stanie się dostępny, pakiet SDK automatycznie go wstępnie wczytuje. Jeśli nie został wstępnie wczytany żaden formularz, pakiet SDK spróbuje wczytać go asynchronicznie.
Wywołanie zwrotne
onDismissed jest wywoływane po wyświetleniu formularza użytkownikowi, wybraniu przez niego opcji i zamknięciu formularza. Może też zwrócić błąd FormError, jeśli:- Formularz jest niedostępny.
- Formularz nie wyświetla się.
- Formularz jest nadal wstępnie wczytywany.
| Parametry | |
|---|---|
|
Funkcja wywołania zwrotnego wywoływana po zamknięciu formularza. Zawiera opcjonalny element FormError, jeśli prezentacja się nie powiodła. |