webRequest.onCompleted

Wird ausgelöst, wenn eine Anfrage abgeschlossen ist.

Dieses Ereignis dient nur zu Informationszwecken.

Syntax

js
browser.webRequest.onCompleted.addListener(
  listener,             // function
  filter,               //  object
  extraInfoSpec         //  optional array of strings
)
browser.webRequest.onCompleted.removeListener(listener)
browser.webRequest.onCompleted.hasListener(listener)

Ereignisse haben drei Funktionen:

addListener(listener, filter, extraInfoSpec)

Fügt einen Listener zu diesem Ereignis hinzu.

removeListener(listener)

Hört auf, auf dieses Ereignis zu lauschen. Das listener Argument ist der zu entfernende Listener.

hasListener(listener)

Überprüfen Sie, ob listener für dieses Ereignis registriert ist. Gibt true zurück, wenn es zuhört, andernfalls false.

addListener-Syntax

Parameter

listener

Die Funktion, die aufgerufen wird, wenn dieses Ereignis auftritt. Der Funktion wird dieses Argument übergeben:

details

object. Details zu der Anfrage. Siehe den Abschnitt details für mehr Informationen.

filter

webRequest.RequestFilter. Ein Filter, der die Ereignisse einschränkt, die an diesen Listener gesendet werden.

extraInfoSpec Optional

array von string. Zusätzliche Optionen für das Ereignis. Sie können einen Wert übergeben:

  • "responseHeaders": Einschließen von responseHeaders im details Objekt, das an den Listener übergeben wird

Zusätzliche Objekte

details

cookieStoreId

string. Wenn die Anfrage von einem Tab stammt, der in einer kontextuellen Identität geöffnet ist, ist dies die ID des Cookie-Stores der kontextuellen Identität. Weitere Informationen finden Sie unter Arbeiten mit kontextuellen Identitäten.

documentUrl

string. URL des Dokuments, in dem die Ressource geladen wird. Wenn z. B. die Webseite "https://example.com" ein Bild oder ein iframe enthält, dann wird die documentUrl für das Bild oder das iframe "https://example.com" sein. Für ein Dokument auf oberster Ebene ist documentUrl undefiniert.

frameId

integer. Null, wenn die Anfrage im Hauptframe erfolgt; ein positiver Wert ist die ID eines Unterframes, in dem die Anfrage erfolgt. Wenn das Dokument eines (Unter-)Frames geladen wird (type ist main_frame oder sub_frame), gibt frameId die ID dieses Frames an, nicht die ID des äußeren Frames. Frame-IDs sind einmalig innerhalb eines Tabs.

fromCache

boolean. Gibt an, ob diese Antwort aus dem Festplatten-Cache geladen wurde.

incognito

boolean. Ob die Anfrage aus einem privaten Browsing-Fenster stammt.

ip

string. Die IP-Adresse des Servers, an den die Anfrage gesendet wurde. Es kann sich um eine IPv6-Literaladresse handeln.

method

string. Standard-HTTP-Methode: zum Beispiel "GET" oder "POST".

originUrl

string. URL der Ressource, die die Anfrage ausgelöst hat. Wenn z. B. "https://example.com" einen Link enthält und der Nutzer darauf klickt, dann ist die originUrl der resultierenden Anfrage "https://example.com".

Die originUrl ist oft, aber nicht immer, dieselbe wie die documentUrl. Wenn z. B. eine Seite ein iframe enthält und das iframe einen Link enthält, der ein neues Dokument in das iframe lädt, dann wird die documentUrl für die resultierende Anfrage das übergeordnete Dokument des iframes sein, aber die originUrl wird die URL des Dokuments im iframe sein, das den Link enthielt.

parentFrameId

integer. ID des Frames, der den Frame enthält, der die Anfrage gesendet hat. Ist auf -1 gesetzt, wenn es keinen übergeordneten Frame gibt.

proxyInfo

object. Diese Eigenschaft ist nur vorhanden, wenn die Anfrage über einen Proxy geleitet wird. Sie enthält folgende Eigenschaften:

host

string. Der Hostname des Proxy-Servers.

port

integer. Die Portnummer des Proxy-Servers.

type

string. Der Typ des Proxy-Servers. Einer von:

  • "http": HTTP-Proxy (oder SSL CONNECT für HTTPS)
  • "https": HTTP-Proxying über TLS-Verbindung zum Proxy
  • "socks": SOCKS v5 Proxy
  • "socks4": SOCKS v4 Proxy
  • "direct": kein Proxy
  • "unknown": unbekannter Proxy
username

string. Benutzername für den Proxy-Dienst.

proxyDNS

boolean. True, wenn der Proxy die Namensauflösung anhand des angegebenen Hostnamens durchführt, d.h. der Client sollte keine eigene DNS-Abfrage durchführen.

failoverTimeout

integer. Failover-Timeout in Sekunden. Wenn die Proxy-Verbindung fehlschlägt, wird der Proxy für diesen Zeitraum nicht mehr verwendet.

requestId

string. Die ID der Anfrage. Anfrage-IDs sind innerhalb einer Browser-Sitzung einmalig, sodass Sie sie verwenden können, um verschiedene Ereignisse zuzuordnen, die mit derselben Anfrage verbunden sind.

responseHeaders Optional

webRequest.HttpHeaders. Die HTTP-Antwortheader, die zusammen mit dieser Antwort empfangen wurden.

statusCode

integer. Standard-HTTP-Statuscode, der vom Server zurückgegeben wurde.

statusLine

string. HTTP-Statuszeile der Antwort oder der 'HTTP/0.9 200 OK'-String für HTTP/0.9-Antworten (d.h. Antworten ohne Statuszeile) oder ein leerer String, wenn keine Header vorhanden sind.

tabId

integer. Die ID des Tabs, in dem die Anfrage stattfindet. Ist auf -1 gesetzt, wenn die Anfrage nicht mit einem Tab verbunden ist.

thirdParty

boolean. Gibt an, ob die Anfrage und ihre Inhaltsfensterhierarchie von Drittanbietern stammen.

timeStamp

number. Der Zeitpunkt, an dem dieses Ereignis ausgelöst wurde, in Millisekunden seit der Epoche.

type

webRequest.ResourceType. Der Typ der angeforderten Ressource: zum Beispiel "image", "script", "stylesheet".

url

string. Ziel der Anfrage.

urlClassification

object. Der Typ von Tracking, der mit der Anfrage verbunden ist, wenn diese durch den Firefox Tracking-Schutz klassifiziert wird. Dies ist ein Objekt mit diesen Eigenschaften:

firstParty

array von string. Klassifikationsflags für den First Party der Anfrage.

thirdParty

array von string. Klassifikationsflags für Drittanbieter der Anfrage oder deren Fensterhierarchie.

Die Klassifikationsflags beinhalten:

  • fingerprinting und fingerprinting_content: zeigt an, dass die Anfrage in Fingerprinting verwickelt ist („eine Herkunft, die Fingerabdrücke ermittelt“).
    • fingerprinting gibt an, dass die Domain in der Fingerprinting- und Tracking-Kategorie ist. Beispiele für diese Art von Domain sind Werbetreibende, die ein Profil mit dem besuchenden Benutzer verknüpfen möchten.
    • fingerprinting_content gibt an, dass die Domain in der Fingerprinting-Kategorie, aber nicht in der Tracking-Kategorie ist. Beispiele für diese Art von Domain sind Zahlungsanbieter, die Fingerprinting-Techniken verwenden, um den besuchenden Benutzer aus Anti-Betrugsgründen zu identifizieren.
  • cryptomining und cryptomining_content: ähnlich der Fingerprinting-Kategorie, aber für Kryptomining-Ressourcen.
  • tracking, tracking_ad, tracking_analytics, tracking_social und tracking_content: zeigt an, dass die Anfrage in Tracking verwickelt ist. tracking ist eine allgemeine Tracking-Anfrage, die ad, analytics, social und content Suffixe identifizieren die Art des Trackers.
  • emailtracking und emailtracking_content: zeigt an, dass die Anfrage in das Tracking von E-Mails verwickelt ist.
  • any_basic_tracking: ein Metaflag, das Tracking- und Fingerprinting-Flags kombiniert, ausgenommen tracking_content und fingerprinting_content.
  • any_strict_tracking: ein Metaflag, das alle Tracking- und Fingerprinting-Flags kombiniert.
  • any_social_tracking: ein Metaflag, das alle sozialen Tracking-Flags kombiniert.

Weitere Informationen zu Tracker-Typen finden Sie auf der disconnect.me Website. Das content Suffix zeigt Tracker an, die Inhalte verfolgen und bereitstellen. Deren Blockierung schützt die Nutzer, kann jedoch dazu führen, dass Websites nicht funktionieren oder Elemente nicht angezeigt werden.

Browser-Kompatibilität

Beispiele

js
let target = "https://developer.mozilla.org/*";

/*
e.g.
"https://developer.mozilla.org/en-US/"
200

or:

"https://developer.mozilla.org/en-US/xfgkdkjdfhs"
404
*/
function logResponse(responseDetails) {
  console.log(responseDetails.url);
  console.log(responseDetails.statusCode);
}

browser.webRequest.onCompleted.addListener(logResponse, { urls: [target] });

Beispielerweiterungen

Hinweis: Diese API basiert auf Chromiums chrome.webRequest API. Diese Dokumentation ist abgeleitet von web_request.json im Chromium-Code.