Download the PHP package blessedzulu/nativephp-admob without Composer

On this page you can find all versions of the php package blessedzulu/nativephp-admob. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of blessedzulu/nativephp-admob

Informations about the package nativephp-admob

NativePHP AdMob

Google AdMob plugin for NativePHP Mobile. Banner, interstitial, rewarded, rewarded interstitial, and app-open ads, with built-in UMP consent and iOS App Tracking Transparency.

Ad units are named slots you configure once, then call from PHP or JavaScript:

Features

Requirements

Installation

Configuration

Required: AdMob app ID

Set your AdMob app ID in .env before running native:run. The app ID is validated per platform at compile time, so the build fails with a clear error if the app ID for the platform you're building is missing:

ADMOB_ENABLED is a real kill-switch: when false, every ad load() / show() / hide() no-ops across all formats (and the Blade/JS banner + JS API). Consent (UMP) and tracking (ATT) still run, so you can keep gathering consent while ads are toggled off.

The plugin's manifest takes care of writing this into the right places on each platform:

You do not need to edit either of those files yourself.

For separate Android + iOS apps, set the app ID per platform - each build reads ADMOB_APP_ID_ANDROID / ADMOB_APP_ID_IOS for its target, falling back to a universal ADMOB_APP_ID:

Where ad units are configured

Ad units live under named slots in config/admob.php - never as raw IDs in your app code. A slot is just a name you pick (home_footer, level_complete, ...) mapped to the AdMob ad unit ID for that placement.

The package has no env-key convention. It resolves a slot solely from config('admob.slots.{format}.{name}'). Where each ID comes from is entirely your choice - hardcode it, or read it from an env var you name yourself.

Publish the config and add your slots:

Outside production, test_mode is on and these IDs are ignored in favour of Google's reserved test IDs, so you cannot accidentally serve a real ad in development.

Platform-specific ad units (Android & iOS)

AdMob ad units and app IDs are per platform - Android and iOS are separate apps in AdMob, and a unit belongs to one of them. Give any slot (or the app ID) a platform-keyed array and the plugin resolves the running platform automatically:

A plain string is still valid - treated as a universal value for single-platform apps ('home_footer' => env('ADMOB_BANNER_HOME')). Resolution is lazy: the platform is only queried (a cached native call) when a slot is actually platform-keyed, so string slots cost nothing extra.

Need the resolved unit yourself - e.g. to gate UI on "is this configured?" Both helpers are non-throwing and platform + test-mode aware:

Displaying each format

Format How to display
Banner <x-admob::banner slot="home_footer" position="bottom" /> (screen-anchored native overlay, one per slot) - or manually Admob::banner('home_footer')->load()->show('bottom') / ->hide()
Interstitial Admob::interstitial('level_complete')->load(); then ->show() when ->isReady(); listen for lifecycle events
Rewarded Admob::rewarded('unlock_feature')->load()->show(); grant on the UserEarnedReward event
Rewarded interstitial Admob::rewardedInterstitial('session_break')->load()->show();
App open Admob::appOpen('cold_start')->load() on boot; the native lifecycle observer auto-shows on foreground

SKAdNetwork list (iOS)

The plugin ships a starter list of SKAdNetwork identifiers in its iOS Info.plist contribution. Google publishes the canonical list at developers.google.com/admob/ios/privacy/strategies and updates it from time to time. Check that page before each App Store submission and add any new entries to your consumer app's Info.plist - your additions are merged with the plugin's defaults.

PHP Usage

Banner ads

Register the home_footer slot in config/admob.php (see Blade component, which loads, shows, and tears the banner down for you.

The banner uses Google's adaptive banner sizing - the SDK picks the right height for the device. Width is full screen width. Banners are attached to the activity's root view (Android) or key window (iOS) as an overlay, so they don't shift your existing layout.

Test mode is automatic outside production. Real ad unit IDs are silently swapped for Google's reserved test IDs, so you can never accidentally show a real ad during development.

Interstitial ads

Interstitials are one-shot: each loaded ad survives until it is shown and dismissed, then the slot must be loaded again. The plugin clears the registry slot on AdDismissed and AdFailedToShow automatically.

Register the between_calculations slot in config/admob.php (see Where ad units are configured).

Events dispatched for the interstitial lifecycle: AdLoaded, AdFailedToLoad, AdShown, AdFailedToShow, AdImpression, AdClicked, AdDismissed. Listen with #[OnNative(EventClass::class)] on any Livewire component.

Rewarded ads

The UserEarnedReward event fires ONLY if the user watches to the rewardable threshold. Dismissing early fires AdDismissed without UserEarnedReward.

Register the export_pdf slot in config/admob.php (see Where ad units are configured).

Rewarded interstitial ads

Same API surface as rewarded, but the ad auto-plays on entry with a 5-second skip warning rather than an opt-in "Watch ad" tap. Useful between level transitions where you want to reward continuation without requiring an explicit tap.

UserEarnedReward event payload includes format: 'rewarded_interstitial' so a single listener can branch.

App Open ads

App Open ads are the format Google designed for the brief moment between app foreground and your splash/home screen. The plugin's recommended path is auto-show: call load() once on app start; the native lifecycle observer presents the cached ad on every subsequent foreground (skipping the cold-start resume), and discards anything older than 4 hours.

Locked behaviours:

Suppressing the auto-show. Because app-open presents on foreground outside any per-request gate, a normal "don't load new ads" check can't stop an already-loaded one. To stand the auto-show down (e.g. while a user holds a temporary ad-free pass), call:

The flag lives in the native layer and resets on app restart, so re-sync it at boot (e.g. Admob::setAppOpenSuppressed($user->hasAdFreePass())).

Manual override when the auto-show flow doesn't fit (e.g. you want to gate on a feature-flag or an in-app purchase state):

Register the warm_resume slot in config/admob.php (see Where ad units are configured).

Quick reference

A single snippet covering SDK boot, consent, and one call per format:

Listening for events (Livewire)

Blade

Drop this on any page that should show a banner. On render it loads and shows the banner for the slot; when you navigate away it tears the native overlay down for you. Because the banner is a screen-anchored native overlay (not a WebView element), teardown happens by listening for a DOM event and calling Admob.HideBanner through NativePHP's own JS bridge.

Since the banner pins to the very top/bottom edge, it can sit on top of chrome like a native bottom-nav. Lift it off the edge with an offset (dp) - per call (<x-admob::banner slot="home_footer" offset="56" />, <admob-banner offset="56">, Admob::banner('home_footer')->show('bottom', 56)) or globally via config('admob.banner.offset.{top,bottom}').

By default the banner also auto-insets past the OS system bars (status bar at top, navigation/gesture bar at bottom) so it isn't clipped behind them - your offset stacks on top of that. iOS does this via its safe-area guide; Android reads WindowInsets. NativePHP's own safe-area support is CSS (--inset-*) for WebView content and doesn't cover this native overlay, hence the plugin handles it. Set ADMOB_BANNER_SAFE_AREA=false (or config('admob.banner.safe_area')) for a true edge-to-edge banner against the raw screen edge.

No Livewire dependency. The teardown events are configurable, defaulting to Livewire's SPA navigation:

Auto-hide needs some navigation event from your host app: Livewire dispatches livewire:navigating on window, Inertia dispatches inertia:* on document, and pagehide covers full-page unloads. Override the list for a different router, or set [] to disable and call Admob::banner($slot)->hide() yourself. Notes: one native overlay per slot; sharing a slot across pages is safe; don't mount two different positions for the same slot at once (last wins). Inertia/Vue/React apps should use the JS API + <admob-banner> Web Component below instead - its connect/disconnect lifecycle drives show/hide with no event guessing.

JavaScript API (Inertia / Vue / React / vanilla)

The plugin ships a JS module so you can drive ads from JavaScript without Livewire or Blade. Publish it into your app and import it:

Banner - <admob-banner> Web Component (framework-agnostic mirror of <x-admob::banner>):

Works in Vue (hyphenated tags resolve as custom elements; mark it via app.config.compilerOptions.isCustomElement = t => t === 'admob-banner'), React 19+ (native custom-element support), and vanilla. The element's own lifecycle is the teardown signal: connect → load + show, disconnect → hide - no navigation-event wiring. For manual control use Admob.banner('home_footer').show('bottom') / .hide() (e.g. in onMounted / onBeforeUnmount).

How it works. Every JS call POSTs to a thin same-origin endpoint (/_admob/call) that runs the PHP Admob facade, so slot resolution, the consent gate, frequency caps, and the ADMOB_ENABLED kill-switch all apply server-side - the JS layer duplicates none of it. Ad events still arrive in JS via the runtime's On(). The endpoint is CSRF-exempt and session-less, exactly like NativePHP's own /_native/api/call - it only exists inside the localhost native WebView. Toggle it off with ADMOB_JS_API=false; change its prefix with config('admob.js_api_prefix').

npm-packaged distribution is a planned follow-up; for now publish the file as above (or import it via a #admob alias you define).

Built-in test page

The plugin ships a generic, self-contained test/debug page so you can exercise every format + the consent flow and watch a live event log - no scaffolding needed. It's a plain HTML page (own inline styles, no Livewire/Inertia/CSRF dependency) that drives the JS API.

It's served at /_admob/test whenever config('admob.test_page') is true - which defaults on outside production (like test_mode) and off in production. Override with ADMOB_TEST_PAGE / ADMOB_TEST_ROUTE. Boot straight into it during development:

Buttons cover banner show/hide/flip, load/ready/show for the full-screen formats, UMP request/form/status/reset, and the iOS ATT prompt; the event log streams native events (AdLoaded, ConsentChanged, …). Intended for test_mode, where any slot name resolves to Google's demo ad units.

Events

Event Payload
AdLoaded slot, format
AdFailedToLoad slot, format, errorCode, errorMessage
AdShown slot, format
AdDismissed slot, format
AdFailedToShow slot, format, errorCode, errorMessage
AdImpression slot, format
AdClicked slot, format
UserEarnedReward slot, format, type, amount
AdShowThrottled slot, format, reason
ConsentFormShown -
ConsentFormDismissed status
ConsentChanged status
TrackingAuthorizationGranted -
TrackingAuthorizationDenied -

Permissions

Declared automatically via the plugin's manifest:

You do not need to add any of these to your own app's manifest.

UMP and ATT Compliance

UMP (consent) and ATT (iOS tracking) are enabled by default. If your audience is entirely outside the EEA + UK and you only ever serve non-personalised ads, you can opt out:

Testing the consent form

The UMP consent form only appears for users in the EEA + UK. To exercise it during development on a device anywhere, either:

Set ADMOB_UMP_DEBUG_GEOGRAPHY=DISABLED (the default) for production.

Test devices are managed entirely in the AdMob console - the plugin bakes in no device IDs (a baked-in ID goes stale the moment a device resets its advertising ID). The same console registration makes both real ads serve as test ads and the UMP debug geography take effect.

You are responsible for following Google's AdMob policies and Apple's App Tracking Transparency requirements.

Frequency caps

Throttle how often the full-screen formats (interstitial, rewarded, rewarded interstitial, app open) show, per format or per slot. Banners are exempt. Both constraints are opt-in - omit or set 0 to disable. Caps are persisted in the cache, so they survive app relaunches, and reset at local midnight. test_mode bypasses caps so you can spam-test.

When a show() is suppressed, it no-ops and dispatches AdShowThrottled (slot, format, reason = cooldown | daily_cap) so you can react or log it.

Debugging

Set ADMOB_DEBUG=true to trace every native bridge call (method, params, and response) at debug log level. When a bridge call fails (success: false), the plugin logs a warning rather than throwing - a failed ad never crashes your app.

Testing

Outside production, the plugin automatically swaps registered ad unit IDs for Google's reserved test IDs - you cannot accidentally show a real ad in local or staging.

For unit tests in your own app, swap the live bridge for a fake:

Contributing

See issue tracker.

License

MIT. See LICENSE.

All versions of nativephp-admob with dependencies

PHP Build Version
Package Version
Requires php Version ^8.3
illuminate/contracts Version ^11.0 || ^12.0 || ^13.0
nativephp/mobile Version ^3.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package blessedzulu/nativephp-admob contains the following files

Loading the files please wait ...