Collapsible banner ads are banner ads that are initially presented as a larger overlay, with a button to collapse them to the originally requested banner size. Collapsible banner ads are intended to improve performance of anchored ads that are otherwise a smaller size. This guide shows how to turn on collapsible banner ads for existing banner placements.
Prerequisites
- Complete the banner ads get started guide.
Implementation
Make sure your banner view is defined with the size you would like users to see
in the regular (collapsed) banner state. Include an extras parameter in the ad
request with collapsible
as the key and the placement of the ad as the value.
The collapsible placement defines how the expanded region anchors to the banner ad.
Placement value
|
Behavior | Intended use case |
---|---|---|
top |
The top of the expanded ad aligns to the top of the collapsed ad. | The ad is placed at the top of the screen. |
bottom |
The bottom of the expanded ad aligns to the bottom of the collapsed ad. | The ad is placed at the bottom of the screen. |
If the loaded ad is a collapsible banner, the banner shows the collapsible overlay immediately once it's placed in the view hierarchy.
void _loadAd() async {
// Replace these test ad units with your own ad units.
final String adUnitId = Platform.isAndroid
? 'ca-app-pub-3940256099942544/2014213617'
: 'ca-app-pub-3940256099942544/8388050270';
// Get the size before loading the ad.
final size = await AdSize.getCurrentOrientationAnchoredAdaptiveBannerAdSize(
MediaQuery.sizeOf(context).width.truncate());
if (size == null) {
// Unable to get the size.
return;
}
// Create an extra parameter that aligns the bottom of the expanded ad to the
// bottom of the banner ad.
const adRequest = AdRequest(extras: {
"collapsible": "bottom",
});
BannerAd(
adUnitId: adUnitId,
request: adRequest,
size: size,
listener: const BannerAdListener()
).load();
}
Ads refreshing behavior
import 'package:uuid/uuid.dart';
// Generate a UUID.
String uuidString = const Uuid().v4();
final adRequest = AdRequest(extras: {
"collapsible": "bottom",
"collapsible_banner_id": uuidString,
});
If you want to load another collapsible banner ad later in the session, you can
call loadAd()
manually with a request containing the collapsible parameter.
Check if a loaded ad is collapsible
Call isCollapsible
to check if the last banner loaded is collapsible.
If the request fails to load and the previous banner is collapsible, the API returns true.
Mediation
Collapsible banner ads are only available for Google demand during the beta period. Ads served through mediation show as normal, non-collapsible banner ads.
Ads serving behavior
To maximize performance of your banner ads, ads that don't support a larger-size collapsible overlay could return some collapsible banner requests and render immediately in the regular banner size.