Google Mobile Ads React Native API

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


Aliasy typów
AdapterState
Reprezentuje możliwe stany inicjowania adaptera zapośredniczenia.
AdChoicesPlacement
Pozycje ikony Informacja w wyświetleniu reklamy.
AdFormat
Format reklamy, o którą wysyłane jest żądanie.
AdInspectorError
Informacje o błędach, które wyjaśniają, dlaczego inspektor reklam nie działa.
AdInspectorErrorCode
Błędy wpływające na otwieranie lub działanie inspektora reklam.
AdOrientation
Opcje orientacji w przypadku wbudowanych banerów adaptacyjnych i dużych zakotwiczonych banerów adaptacyjnych.
AdSize
Określa wymiary reklamy.
AgeRestrictedTreatment
Określa opcje przetwarzania żądań reklam z uwzględnieniem ograniczeń wiekowych.
ConsentStatus
Wartości stanu zgody.
DebugGeography
Wartości debugowania na potrzeby testowania lokalizacji.
FormErrorCode
Reprezentuje kody błędów związane z niepowodzeniami operacji formularza platformy do personalizowania wiadomości wyświetlanych użytkownikom (UMP).
FullScreenContentErrorCode
LoadAdErrorCode
Reprezentuje kody błędów w przypadku niepowodzenia operacji wczytywania reklamy.
MaxAdContentRating
Określa maksymalną ocenę treści reklam w aplikacji, klasyfikując typy reklam, które mogą się w niej wyświetlać.
NativeAdAssetNames
Nazwy używane do identyfikowania standardowych komponentów reklamy natywnej.
NativeAdType
Określa format wczytanej reklamy natywnej.
NativeMediaAspectRatio
Ustawienia dotyczące formatu zwracanych multimediów reklam natywnych.
OnAdInspectorClosedListener
Definicja interfejsu wywołania zwrotnego, które ma zostać wywołane po zamknięciu interfejsu inspektora reklam.
PrecisionType
Precyzja raportowanej wartości reklamy.
PrivacyOptionsRequirementStatus
Stan wymagań dotyczących opcji prywatności.
PublisherPrivacyPersonalizationState
Wskazuje stany personalizacji związane z podejściem do prywatności wydawcy.
ResizeMode
Opcje dostosowywania trybu zmiany rozmiaru treści obrazu w klasie NativeAdMediaView.
ResolvedAdSize
Reprezentuje ostateczny stan rozmiaru reklamy po jej wczytaniu.
SwipeGestureDirection
Instrukcje dotyczące niestandardowych gestów przesuwania kliknięciem.
Zmienne
AdSize
Wstępnie zdefiniowane rozmiary reklam i metody pomocnicze do tworzenia reklam adaptacyjnych i o rozmiarach niestandardowych.
Funkcje
canRequestAds
Sprawdza, czy bieżący stan zgody użytkownika umożliwia wysyłanie żądań reklam.
getConsentStatus
Pobiera bieżący stan zgody użytkownika.
getInitializationStatus
Pobiera stan inicjowania pakietu SDK.
getPrivacyOptionsRequirementStatus
Sprawdza, czy w przypadku Twojej aplikacji wymagany jest punkt wejścia opcji prywatności.
getRequestConfiguration
Pobiera globalną konfigurację żądania.
initialize
Inicjuje pakiet SDK do reklam mobilnych Google.
isConsentFormAvailable
Sprawdza, czy dostępny jest formularz zgody.
loadAndShowConsentFormIfRequired
Wczytuje formularz zgody i wyświetla go użytkownikowi, jeśli wymaga tego jego obecny stan zgody (np. stan to REQUIRED).
openAdInspector
Otwiera nakładkę inspektora reklam pakietu SDK do reklam mobilnych Google.
openDebugMenu
Otwiera menu debugowania.
parseLoadAdError
Analizuje błąd natywny zgłoszony podczas wczytywania reklamy i zawiera go w obiekcie LoadAdError.
requestConsentInfoUpdate
Wysyła prośbę o aktualizację informacji o zgodzie.
reset
Usuwa z pamięci trwałej wszystkie stany zgody użytkownika.
setPublisherFirstPartyIdEnabled
Określa, czy własny identyfikator wydawcy jest włączony.
setRequestConfiguration
Ustawia globalną konfigurację żądań na potrzeby zgodności i kierowania.
setUserControlledAppVolume
Ustawia głośność dźwięku aplikacji sterowanej przez użytkownika.
setUserMutedApp
Określa, czy aplikacja jest wyciszona.
showPrivacyOptionsForm
Wyświetla formularz opcji prywatności.

Aliasy typów


AdapterState

AdapterState: typeof AdapterState[keyof typeof AdapterState]
Reprezentuje możliwe stany inicjowania adaptera zapośredniczenia.
Właściwości
NOT_READY
Wskazuje, że adapter zapośredniczenia nie został jeszcze zainicjowany lub nie udało się go zainicjować.
READY
Wskazuje, że adapter zapośredniczenia został zainicjowany i jest gotowy do wyświetlania reklam.

AdChoicesPlacement

AdChoicesPlacement: typeof AdChoicesPlacement[keyof typeof AdChoicesPlacement]
Pozycje ikony Informacja w wyświetleniu reklamy.
Właściwości
BOTTOM_LEFT
Lewy dolny róg reklamy.
BOTTOM_RIGHT
Prawy dolny róg reklamy.
TOP_LEFT
Lewy górny róg reklamy.
TOP_RIGHT
w prawym górnym rogu reklamy.

AdFormat

AdFormat: typeof AdFormat[keyof typeof AdFormat]
Format reklamy, o którą wysyłane jest żądanie.
Właściwości
APP_OPEN
Format reklamy wyświetlanej przy otwarciu aplikacji.
BANNER
Format banera reklamowego.
INTERSTITIAL
Format reklamy pełnoekranowej.
NATIVE
Format reklamy natywnej.
REWARDED
Format reklamy z nagrodą.
REWARDED_INTERSTITIAL
format reklamy pełnoekranowej z nagrodą.

AdInspectorError

AdInspectorError: BaseError<AdInspectorErrorCode>
Informacje o błędach, które wyjaśniają, dlaczego inspektor reklam nie działa.

AdInspectorErrorCode

AdInspectorErrorCode: typeof AdInspectorErrorCode[keyof typeof AdInspectorErrorCode]
Błędy wpływające na otwieranie lub działanie inspektora reklam.
Właściwości
ALREADY_OPEN
Nie można otworzyć narzędzia do inspekcji reklam, ponieważ jest już otwarte.
FAILED_TO_LOAD
Nie udało się wczytać inspektora reklam.
INTERNAL_ERROR
W inspektorze reklam wystąpił błąd wewnętrzny.
NOT_IN_TEST_MODE
Inspektora reklam nie można otworzyć, ponieważ urządzenie nie jest w trybie testowym.

AdOrientation

AdOrientation: typeof AdOrientation[keyof typeof AdOrientation]
Opcje orientacji w przypadku wbudowanych banerów adaptacyjnych i dużych zakotwiczonych banerów adaptacyjnych.
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.

AgeRestrictedTreatment

AgeRestrictedTreatment: typeof AgeRestrictedTreatment[keyof typeof AgeRestrictedTreatment]
Określa opcje przetwarzania żądań reklam z uwzględnieniem ograniczeń wiekowych.
Właściwości
CHILD
Wskazuje, że żądania reklamy powinny być traktowane jako treści skierowane do dzieci.
TEEN
Wskazuje, że żądania reklamy powinny być traktowane jako treści skierowane do nastolatków.
UNSPECIFIED
Wskazuje, że do żądania reklamy nie ma zastosowania żaden konkretny sygnał dotyczący przetwarzania z ograniczeniami wiekowymi.

ConsentStatus

ConsentStatus: typeof ConsentStatus[keyof typeof ConsentStatus]
Wartości stanu zgody.
Właściwości
NOT_REQUIRED
Zgoda nie jest wymagana.
OBTAINED
Uzyskano zgodę użytkownika, reklamy spersonalizowane i niespersonalizowane undefined.
REQUIRED
Wymagana zgoda użytkownika, ale nie została jeszcze uzyskana.
UNKNOWN
Nieznany stan zgody.

DebugGeography

DebugGeography: typeof DebugGeography[keyof typeof DebugGeography]
Wartości debugowania na potrzeby testowania lokalizacji.
Właściwości
DISABLED
Debugowanie lokalizacji jest wyłączone na urządzeniach do debugowania.
EEA
W przypadku urządzeń do debugowania region geograficzny jest wyświetlany jako Europejski Obszar Gospodarczy.
OTHER
Lokalizacja geograficzna jest wyświetlana jako region, w którym nie obowiązują żadne przepisy dotyczące urządzenia debugowania.
REGULATED_US_STATE
W przypadku urządzeń debugujących lokalizacja geograficzna jest wyświetlana jako stan USA objęty regulacjami.

FormErrorCode

FormErrorCode: typeof FormErrorCode[keyof typeof FormErrorCode]
Reprezentuje kody błędów związane z nieudanymi operacjami na formularzu platformy do personalizowania wiadomości wyświetlanych użytkownikom (UMP).
Właściwości
ALREADY_USED
Formularz zgody został już wykorzystany.
INTERNAL_ERROR
W SDK wystąpił problem wewnętrzny.
INVALID_OPERATION
Operacja była nieprawidłowa.
NETWORK_ERROR
Operacja na formularzu nie powiodła się z powodu problemów z połączeniem sieciowym.
TIMEOUT
Przekroczono limit czasu operacji formularza.
UNAVAILABLE
Brak dostępnego formularza wyrażenia zgody.
UNKNOWN
Nie udało się przypisać kodu błędu do znanego kodu błędu.

FullScreenContentErrorCode

FullScreenContentErrorCode: typeof FullScreenContentErrorCode[keyof typeof FullScreenContentErrorCode]
Właściwości
AD_ALREADY_USED
Reklama została już wyświetlona.
AD_NOT_READY
Reklama nie jest gotowa do wyświetlenia.
AD_TOO_LARGE
Reklama jest za duża w stosunku do sceny (tylko iOS).
APP_NOT_FOREGROUND
Aplikacja nie jest na pierwszym planie.
INTERNAL_ERROR
Wystąpił problem wewnętrzny, np. podczas przygotowywania treści reklamy wystąpił wyjątek.
MEDIATION_ERROR
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]
Reprezentuje kody błędów w przypadku niepowodzenia operacji wczytywania reklamy.
Właściwości
AD_ALREADY_USED
Odpowiedź na żądanie reklamy została już użyta do wczytania reklamy.
APP_ID_MISSING
Żądanie reklamy nie zostało wysłane, ponieważ brakuje identyfikatora aplikacji.
CANCELLED
Żądanie reklamy zostało anulowane (tylko na Androidzie).
INTERNAL_ERROR
W SDK wystąpił problem wewnętrzny.
INVALID_REQUEST
Żądanie reklamy było nieprawidłowe, np. identyfikator jednostki reklamowej był nieprawidłowy.
INVALID_RESPONSE
Odpowiedź na żądanie reklamy serwer-serwer jest nieprawidłowa. Na przykład w odpowiedzi na żądanie reklamy nie ma identyfikatora żądania.
MEDIATION_ERROR
Nie udało się znaleźć adaptera do zapośredniczenia lub nie udało się mu wysłać żądania reklamy.
NETWORK_ERROR
Żądanie reklamy nie zostało zrealizowane z powodu problemów z połączeniem sieciowym.
NO_FILL
Żądanie reklamy zostało zrealizowane, ale nie zwrócono żadnej reklamy z powodu braku zasobów reklamowych.
TIMEOUT
Upłynął limit czasu żądania reklamy.
UNKNOWN
Nie udało się przypisać kodu błędu do znanego kodu błędu.

MaxAdContentRating

MaxAdContentRating: typeof MaxAdContentRating[keyof typeof MaxAdContentRating]
Określa maksymalną ocenę treści reklam w aplikacji, klasyfikując typy reklam, które mogą się w niej wyświetlać.
Właściwości
G
Treści odpowiednie dla wszystkich odbiorców, w tym rodzin i dzieci.
MA
Treści odpowiednie tylko dla odbiorców dorosłych.
PG
Treści odpowiednie dla większości odbiorców pod nadzorem rodziców.
T
Treści odpowiednie dla nastolatków i starszych odbiorców.
UNSPECIFIED
Brak określonej oceny treści.

NativeAdAssetNames

NativeAdAssetNames: typeof NativeAdAssetNames[keyof typeof NativeAdAssetNames]
Nazwy używane do identyfikowania standardowych komponentów reklamy natywnej.
Właściwości
ADCHOICES_CONTAINER_VIEW
Kontener nakładki Informacja.
ADVERTISER
Nazwa reklamodawcy.
BODY
Główny tekst reklamy.
CALL_TO_ACTION
Tekst wezwania do działania w reklamie (np. „Zainstaluj” lub „Dowiedz się więcej”).
HEADLINE
Nagłówek lub tytuł reklamy.
ICON
Obraz ikony reklamy.
MEDIA_CONTENT
Główne treści multimedialne reklamy (obraz lub film).
PRICE
Cena reklamowanej aplikacji lub produktu.
STAR_RATING
Ocena w gwiazdkach reklamowanej aplikacji lub produktu.
STORE
Nazwa sklepu.

NativeAdType

NativeAdType: typeof NativeAdType[keyof typeof NativeAdType]
Określa format wczytanej reklamy natywnej.
Właściwości
BANNER
Baner reklamowy.
CUSTOM_NATIVE
Reklama w niestandardowym formacie natywnym.
NATIVE
Reklama natywna.

NativeMediaAspectRatio

NativeMediaAspectRatio: typeof NativeMediaAspectRatio[keyof typeof NativeMediaAspectRatio]
Ustawienia dotyczące formatu zwracanych multimediów reklam natywnych.
Właściwości
ANY
Brak preferencji dotyczących formatu zwracanych multimediów reklamy natywnej.
LANDSCAPE
Żądanie formatu poziomego w przypadku zwróconych multimediów reklamy natywnej.
PORTRAIT
Żądanie formatu pionowego w przypadku zwróconych multimediów reklamy natywnej.
SQUARE
Żądanie kwadratowego formatu zwróconych multimediów reklamy natywnej.
UNKNOWN
Współczynnik proporcji jest nieznany.

OnAdInspectorClosedListener

OnAdInspectorClosedListener: ((error?) => void)
Definicja interfejsu wywołania zwrotnego, które ma być wywoływane po zamknięciu interfejsu inspektora reklam.

PrecisionType

PrecisionType: typeof PrecisionType[keyof typeof PrecisionType]
Precyzja raportowanej wartości reklamy.
Właściwości
ESTIMATED
Wartość reklamy została oszacowana na podstawie danych zbiorczych.
PRECISE
Dokładna kwota zapłacona za tę reklamę.
PUBLISHER_PROVIDED
Wartość reklamy podana przez wydawcę, np. ręcznie ustawione stawki CPM w grupie zapośredniczenia.
UNKNOWN
Wartość reklamy o nieznanej precyzji.

PrivacyOptionsRequirementStatus

PrivacyOptionsRequirementStatus: typeof PrivacyOptionsRequirementStatus[keyof typeof PrivacyOptionsRequirementStatus]
Stan wymagań dotyczących opcji prywatności.
Właściwości
NOT_REQUIRED
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]
Wskazuje stany personalizacji związane z podejściem do prywatności wydawcy.
Właściwości
DEFAULT
Wskazuje, że żądanie reklamy powinno być traktowane zgodnie z domyślnym podejściem wydawcy do ochrony prywatności.
DISABLED
Wskazuje, że żądanie reklamy powinno być traktowane zgodnie z zasadami ochrony prywatności wydawcy dotyczącymi reklam niespersonalizowanych.
ENABLED
Wskazuje, że żądanie reklamy powinno być traktowane zgodnie z zasadami ochrony prywatności wydawcy dotyczącymi reklam spersonalizowanych.

ResizeMode

ResizeMode: typeof ResizeMode[keyof typeof ResizeMode]
Opcje dostosowywania trybu zmiany rozmiaru treści obrazu w widoku NativeAdMediaView.
Właściwości
CONTAIN
Skaluj równomiernie, aby dopasować obraz do widoku.

Obraz wysokość i szerokość są skalowane razem, tak aby każdy wymiar był mniejszy lub równy odpowiedniemu wymiarowi widoku. Obraz jest skalowany tak, aby zmieścił się w widoku bez zniekształcania współczynnika proporcji i przycinania.
COVER
Skaluj równomiernie, aby wypełnić widok.

Wysokość i szerokość obrazu są skalowane razem, tak aby każdy wymiar był równy odpowiedniemu wymiarowi widoku lub większy od niego. Obraz jest przycinany tak, aby pasował do widoku, bez zniekształcania jego formatu.
STRETCH
Skaluj szerokość i wysokość niezależnie od siebie, aby wypełnić widok.

Wysokość i szerokość obrazu są skalowane oddzielnie, aby dopasować je do wymiarów widoku. Obraz jest skalowany tak, aby wypełnić widok w całości bez przycinania, ale współczynnik proporcji obrazu nie jest zachowywany.

ResolvedAdSize

ResolvedAdSize: FixedAdSize | FluidAdSize
Reprezentuje ostateczny stan rozmiaru reklamy po jej załadowaniu.

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]
Instrukcje dotyczące niestandardowych gestów przesuwania kliknięciem.
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;
}
Wstępnie zdefiniowane rozmiary reklam i metody pomocnicze do tworzenia reklam adaptacyjnych i o rozmiarach niestandardowych.

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.
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ę.
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.
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.
Parametry
config: InitializationConfig Opcje kontrolowania inicjowania pakietu SDK.
Optional onInitializationComplete: ((status) => void) 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
Optional onDismissed: ((error?) => void) 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.
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.
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 onComplete.
Parametry
Optional params: ConsentRequestParameters Opcjonalne konfiguracje do debugowania i kierowania.
Optional onComplete: ((error?) => void) 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.

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.
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.
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.
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.
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ść 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
Optional onDismissed: ((error?) => void) Funkcja wywołania zwrotnego wywoływana po zamknięciu formularza. Zawiera opcjonalny element FormError, jeśli prezentacja się nie powiodła.