H5AdsWebViewClient

Kotlin |Java

@RequiresApi(api = VERSION_CODES.LOLLIPOP)
public final class H5AdsWebViewClient extends WebViewClient

java.lang.Object
↳	android.webkit.WebViewClient
	↳	com.google.android.gms.ads.h5.H5AdsWebViewClient

A WebViewClient that intercepts and handles H5 ad requests. To use this, set this as the client of the WebView that contains the web apps that will be making H5 ad requests.

IMPORTANT: This WebViewClient cannot be used for multiple WebViews. Every new WebView that will support H5 ads must use a new H5AdsWebViewClient.

Example code:

public void onCreate(Bundle savedInstanceState) {
  ...

  // Initialize early to reduce latency on the session's first ad request.
  MobileAds.initialize(this);

  WebView myWebView = findViewById(R.id.my_webview);

  // JavaScript must be enabled.
  WebSettings settings = myWebView.getSettings();
  settings.setJavaScriptEnabled(true);

  H5AdsWebViewClient h5Client = new H5AdsWebViewClient(this, myWebView);

  // (Optional) any existing WebViewClient
  WebViewClient myClient = ...;
  h5Client.setDelegateWebViewClient(myClient);

  webView.setWebViewClient(h5Client);
}

Summary

Public constructors
`H5AdsWebViewClient(Context context, WebView webView)` Constructor for `H5AdsWebViewClient`.

Public methods
`void`	`clearAdObjects()` Destroys all ads being managed by H5 ads.
`@Nullable WebViewClient`	`getDelegateWebViewClient()` Gets the delegate `WebViewClient`.
`void`	`setDelegateWebViewClient(@Nullable WebViewClient delegate)` Sets a `WebViewClient` to delegate methods not handled by `H5AdsWebViewClient`.

Protected methods
`WebViewClient`	`getDelegate()`

Inherited Constants

From android.webkit.WebViewClient

`static final int`	`ERROR_AUTHENTICATION = -4`
`static final int`	`ERROR_BAD_URL = -12`
`static final int`	`ERROR_CONNECT = -6`
`static final int`	`ERROR_FAILED_SSL_HANDSHAKE = -11`
`static final int`	`ERROR_FILE = -13`
`static final int`	`ERROR_FILE_NOT_FOUND = -14`
`static final int`	`ERROR_HOST_LOOKUP = -2`
`static final int`	`ERROR_IO = -7`
`static final int`	`ERROR_PROXY_AUTHENTICATION = -5`
`static final int`	`ERROR_REDIRECT_LOOP = -9`
`static final int`	`ERROR_TIMEOUT = -8`
`static final int`	`ERROR_TOO_MANY_REQUESTS = -15`
`static final int`	`ERROR_UNKNOWN = -1`
`static final int`	`ERROR_UNSAFE_RESOURCE = -16`
`static final int`	`ERROR_UNSUPPORTED_AUTH_SCHEME = -3`
`static final int`	`ERROR_UNSUPPORTED_SCHEME = -10`
`static final int`	`SAFE_BROWSING_THREAT_BILLING = 4`
`static final int`	`SAFE_BROWSING_THREAT_MALWARE = 1`
`static final int`	`SAFE_BROWSING_THREAT_PHISHING = 2`
`static final int`	`SAFE_BROWSING_THREAT_UNKNOWN = 0`
`static final int`	`SAFE_BROWSING_THREAT_UNWANTED_SOFTWARE = 3`

Inherited methods

From android.webkit.WebViewClient

`void`	`doUpdateVisitedHistory(WebView p, String p1, boolean p2)`
`void`	`onFormResubmission(WebView p, Message p1, Message p2)`
`void`	`onLoadResource(WebView p, String p1)`
`void`	`onPageCommitVisible(WebView p, String p1)`
`void`	`onPageFinished(WebView p, String p1)`
`void`	`onPageStarted(WebView p, String p1, Bitmap p2)`
`void`	`onReceivedClientCertRequest(WebView p, ClientCertRequest p1)`
`void`	`onReceivedError(WebView p, WebResourceRequest p1, WebResourceError p2)`
`void`	`onReceivedHttpAuthRequest( WebView p, HttpAuthHandler p1, String p2, String p3 )`
`void`	`onReceivedHttpError( WebView p, WebResourceRequest p1, WebResourceResponse p2 )`
`void`	`onReceivedLoginRequest(WebView p, String p1, String p2, String p3)`
`void`	`onReceivedSslError(WebView p, SslErrorHandler p1, SslError p2)`
`boolean`	`onRenderProcessGone(WebView p, RenderProcessGoneDetail p1)`
`void`	`onSafeBrowsingHit( WebView p, WebResourceRequest p1, int p2, SafeBrowsingResponse p3 )`
`void`	`onScaleChanged(WebView p, float p1, float p2)`
`void`	`onTooManyRedirects(WebView p, Message p1, Message p2)` This method is deprecated.
`void`	`onUnhandledKeyEvent(WebView p, KeyEvent p1)`
`WebResourceResponse`	`shouldInterceptRequest(WebView p, WebResourceRequest p1)`
`boolean`	`shouldOverrideKeyEvent(WebView p, KeyEvent p1)`
`boolean`	`shouldOverrideUrlLoading(WebView p, WebResourceRequest p1)`

Public constructors

H5AdsWebViewClient

public H5AdsWebViewClient(Context context, WebView webView)

Constructor for H5AdsWebViewClient.

Parameters
`Context context`	An activity or application context.
`WebView webView`	The `WebView` that will be associated with this `H5AdsWebViewClient`. JavaScript must be enabled on the WebView.

Public methods

clearAdObjects

public void clearAdObjects()

Destroys all ads being managed by H5 ads.

Note: This method has no effect on any ads created by the non-H5 AdMob API, such as com.google.android.gms.ads.interstitial.InterstitialAd and com.google.android.gms.ads.rewarded.RewardedAd.

getDelegateWebViewClient

public @Nullable WebViewClient getDelegateWebViewClient()

Gets the delegate WebViewClient.

setDelegateWebViewClient

public void setDelegateWebViewClient(@Nullable WebViewClient delegate)

Sets a WebViewClient to delegate methods not handled by H5AdsWebViewClient.

Protected methods

getDelegate

protected WebViewClient getDelegate()