All about the eyeo Chromium SDK.
Integrating the eyeo Chromium SDK provides a browsing experience that benefits users. On this page, you'll learn about the SDK's main features and services.
Advertisements frustrate users, as they take up valuable screen space and can slow page load time. By integrating a proven, widely used ad-filtering solution directly into the browser, your users will no longer need to install and configure ad-filtering extensions manually.
With the eyeo Chromium SDK, ad filtering is automatically enabled, giving users an immediate improvement in browsing speed and aesthetics.
The eyeo Chromium SDK enables partners with Chromium-based browsers to introduce ad filtering and related features to their browsers across multiple platforms. As a result, Chromium-enforced limitations on desktop extensions (like Manifest V3) no longer apply.
The feature-rich SDK works alongside other services offered to all partners. In this section, you'll learn about the benefits and capabilities of integrating an ad filtering SDK into a browser.
Ad filtering is the core feature of the SDK, which uses two approaches to remove ads:
- Network blocking, which blocks ads from being requested and downloaded. This approach saves data and helps web pages loader faster.
- Element hiding, which hides ads. Element hiding also hides white spaces left from hidden ads, improving the user experience even after removing ads.
Partners can access an API to introduce an on/off switch for ad filtering features in the UI.
Snippets are built into the browser as a library, rather then being downloaded from the Internet, to avoid running untrusted code. Partners can update the snippets library on their own as part of their release pipeline. Snippets are enabled by default but can be disabled if needed.
Acceptable Ads gives users the option to support content creators and contribute to a fair online ecosystem. Users who enable Acceptable Ads see non-intrusive advertising that respects the online user experience. In so doing, they help reward content creators for their free content.
Keep the following in mind when configuring Acceptable Ads for your project:
- This feature is powered by exception rules, a proprietary eyeo filter list. eyeo recommends all partners enable this filter list by default.
- Inform users about Acceptable Ads during onboarding so that they can opt out if they wish.
- Make sure that Acceptable Ads has a dedicated on/off switch in the browser settings.
Acceptable Ads explained during onboarding
Acceptable Ads on the Settings UI
To turn this feature off, you'll need to disable (that is, unsubscribe from) the exception rules filter list through the Subscription API.
Filter lists power ad filtering. EasyList, the standard for filtering ad content online, is the default filter list enabled in the ad filtering solution. The eyeo Chromium solution also includes language-specific versions of EasyList that are automatically selected based on the user's device language.
Browser partners can configure the default filter list for users who have ad filtering enabled. This feature lets you enable your own blocklists and allowlist by default.
Using the Subscription API, browser partners can add and remove custom filter lists during browser runtime. You can also expose this option to your end users.
The eyeo Chromium SDK updates all installed filter lists automatically, according to their expiration time.
Browser partners can add an expiration value to their filter lists by setting special headers in the filter list content.
With this feature enabled, you can count how many ad requests were blocked or allowed. The SDK sends a notification for each blocked request, which the browser can then count and display to users in their UI.
Depending on your project, you can also use a global counter to engage users who reach a specific milestone of blocked ads.
User counting helps browser partners and eyeo count the following:
- How many users are using the eyeo Chromium SDK
- How many users support content creators via the Acceptable Ads program
eyeo counts users in a way that preserves privacy. The SDK sends regular, anonymous ping requests to eyeo servers. These requests let eyeo apply formulas and identify unique, active users without knowing any personal information about the user.
Browser partners can add or remove domains to and from a local allowlist during runtime.
With this feature, your end users can disable ad filtering for specific websites. This lets users support certain websites, or turn ad filtering off for websites with ad blocker walls or websites that break when ads are blocked.
By providing this feature to users, you give them the option to keep ad filtering enabled for all other websites, resulting in a low opt-out rate for ad filtering.
You can also let some users manage their local allowlist. Adding and removing domains to the local allowlist is done through the custom allowlist API.
eyeo recommends to reserve this capability for power users or developers.
Partners only need to integrate the ad-filtering solution into their Chromium codebase once. The SDK supports the following platforms:
The Desktop Extension API lets browser partners implement the UI for the ad filtering feature set so that it looks like an extension. This extension can be used to control the settings and configuration of the ad filtering functionality, which is natively integrated in the browser. eyeo offers a test extension to demonstrate this feature.
This optional feature is a settings screen for most ad-filtering features. Browsers are free to re-use this UI or implement their own.
The Android settings screen
Now that you're familiar with the features of the eyeo Chromium SDK, jump right in and follow the Quickstart guide to begin building on top of the SDK.