react-native-google-mobile-ads
    Preparing search index...

    Type Alias FullScreenAdHookOptions

    Options object accepted by the second call form of every fullscreen ad hook.

    Passing this instead of a positional ad unit id opts into the v17 shape: the hook loads on its own, status reports where the ad is, and separate fields report what has happened to it.

    The positional form remains a manual-load compatibility shim in v17. Move consent gating into autoLoad when adopting this form:

    // Before: useInterstitialAd(unit), then call load() from an effect.
    const { status, show, load } = useInterstitialAd({
      adUnitId: unit,
      autoLoad: consentReady,
    });

    // Automatic loading is once per identity. Warm another ad only when another
    // impression is plausible; `load` has stable identity.
    useEffect(() => {
      if (status === 'closed') load();
    }, [status, load]);
    type FullScreenAdHookOptions = {
        adUnitId: string | null;
        autoLoad?: boolean;
        requestOptions?: RequestOptions;
    }
    Index
    adUnitId autoLoad? requestOptions?
    adUnitId: string | null

    The ad unit to load.

    null means there is no ad unit yet, so no ad instance is created and status stays 'idle'. Useful when the unit arrives from remote config. Changing this value, including to or from null, replaces the underlying ad instance and therefore destroys the previous one.

    autoLoad?: boolean

    Controls automatic loading. Defaults to true.

    Set it to false to wait for something the load depends on, such as consent or SDK initialization; the hook loads as soon as it flips true. Turning it back off stops future automatic loads. It does not destroy the ad and does not cancel a load already in flight, because neither platform exposes load cancellation.

    An explicit load() or retry() still works while autoLoad is false.

    requestOptions?: RequestOptions

    Request options forwarded to the underlying createForAdRequest. Changing them replaces and destroys the previous ad instance.

    Settings
    Member Visibility

    On This Page
    Properties