Create a filter list
Creating a filter list
A filter list is a text file that contains, in this order:
The header line must be the first line of the file.
It should say
[Adblock Plus]. It might also contain a version number, for example
[Adblock Plus 2.0], but the version is ignored by the eyeo Browser Ad-Filtering Solution.
Special comments are a single block of consecutive comments that start from an exclamation mark (
!) and follow a
The Browser Ad-Filtering Solution interprets the following special comments:
There are other special comments that may be interpreted by other eyeo Ad-Filtering Solution, for example:
Parsing of the special comments block stops after encountering a line that isn't a
! key : value. All further comments are treated as not special and ignored.
This is probably the most important block of a filter list - the actual filters.
Comment lines start from an exclamation mark (
!) and are skipped during parsing.
The filters are parsed until the end of file.
! Version: 202306020710
! Title: My list
! Expires: 2 days
! Allow loading all resources on mysite.net
! Unhide banner element on example.com
For a big working example, consider
For a more minimal example, compare the filter list used for test pages:
For safety, the Browser Ad-Filtering Solution will only download filter lists from HTTPS servers, HTTP is not allowed.
An exception is
localhost- the Solution will download a filter list from
http://localhost/any/path.txtto facilitate local development and testing.
The eyeo Browser Ad-Filtering Solution will periodically download filter list updates. It will respect the interval specified in
! Expiresor revert to the default period of 5 days.
The update check interval is clamped between 1 hour and 14 days.
If a new version of the filter list fails to download or parse correctly, the SDK will retain the old version and retry the update in an hour.