webRequest.onCompleted

Wird ausgelöst, wenn eine Anfrage abgeschlossen wurde.

Dieses Ereignis ist nur informativ.

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 diesem Ereignis einen Listener hinzu.

removeListener(listener)

Stoppt das Zuhören auf dieses Ereignis. Das Argument listener ist der zu entfernende Listener.

hasListener(listener)

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

addListener Syntax

Parameter

listener

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

details

object. Details über die Anfrage. Siehe den Details-Abschnitt für weitere 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 nur einen Wert übergeben:

  • "responseHeaders": Schließen Sie responseHeaders im details-Objekt ein, das an den Listener übergeben wird.

Zusätzliche Objekte

details

cookieStoreId

string. Falls die Anfrage von einem Tab stammt, das in einer kontextuellen Identität geöffnet ist, die Cookie Store ID der kontextuellen Identität. Weitere Informationen finden Sie unter Mit kontextuellen Identitäten arbeiten.

documentUrl

string. URL des Dokuments, in dem die Ressource geladen wird. Wenn zum Beispiel die Webseite bei "https://example.com" ein Bild oder ein <iframe> enthält, wird die documentUrl für das Bild oder <iframe> "https://example.com" sein. Für ein oberstes Dokument ist documentUrl undefiniert.

frameId

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

fromCache

boolean. Gibt an, ob diese Antwort aus dem Festplattencache abgerufen wurde.

incognito

boolean. Ob die Anfrage aus einem privaten Browserfenster stammt.

ip

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

method

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

originUrl

string. URL der Ressource, die die Anfrage ausgelöst hat. Wenn zum Beispiel "https://example.com" einen Link enthält und der Benutzer auf den Link klickt, ist die originUrl für die resultierende Anfrage "https://example.com".

Die originUrl ist oft, aber nicht immer, die gleiche wie die documentUrl. Wenn zum Beispiel 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 <iframe> 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. Auf -1 gesetzt, wenn kein übergeordneter Frame existiert.

proxyInfo

object. Diese Eigenschaft ist nur vorhanden, wenn die Anfrage über einen Proxy erfolgt. Sie enthält die folgenden 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 Proxydienst.

proxyDNS

boolean. True, wenn der Proxy die DNS-Auflösung basierend auf dem bereitgestellten Hostnamen durchführt, was bedeutet, dass der Client keine eigene DNS-Abfrage durchführen sollte.

failoverTimeout

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

requestId

string. Die ID der Anfrage. Anfragen-IDs sind innerhalb einer Browsersitzung eindeutig, sodass Sie sie verwenden können, um verschiedene Ereignisse, die mit der gleichen Anfrage verbunden sind, zuzuordnen.

responseHeaders Optional

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

statusCode

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

statusLine

string. HTTP-Statuszeile der Antwort oder die Zeichenfolge 'HTTP/0.9 200 OK' für HTTP/0.9-Antworten (d.h. Antworten, die keine Statuszeile haben) oder eine leere Zeichenfolge, wenn keine Header vorhanden sind.

tabId

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

thirdParty

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

timeStamp

number. Die Zeit, zu der 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. Die Art der Nachverfolgung, die mit der Anfrage verbunden ist, wenn die Anfrage durch Firefox Tracking-Schutz klassifiziert wird. Dies ist ein Objekt mit diesen Eigenschaften:

firstParty

array von strings. Klassifizierungsflags für die erste Partei der Anfrage.

thirdParty

array von strings. Klassifizierungsflags für die dritte Partei der Anfrage oder die Fensterhierarchie.

Die Klassifizierungsflags umfassen:

  • fingerprinting und fingerprinting_content: zeigt an, dass die Anfrage am Fingerprinting beteiligt ist ("ein Ursprung, der als Fingerprinting bekannt ist").
    • fingerprinting zeigt an, dass die Domain in der Fingerprinting- und Tracking-Kategorie ist. Beispiele für diesen Typ von Domain sind Werbetreibende, die ein Profil mit dem besuchenden Benutzer verknüpfen möchten.
    • fingerprinting_content zeigt an, dass die Domain in der Fingerprinting-Kategorie ist, aber nicht in der Tracking-Kategorie. Beispiele für diesen Typ von Domain sind Zahlungsanbieter, die Fingerprinting-Techniken verwenden, um den besuchenden Benutzer zur Betrugsprävention zu identifizieren.
  • cryptomining und cryptomining_content: ähnlich wie die Fingerprinting-Kategorie, jedoch für Krypto-Mining-Ressourcen.
  • tracking, tracking_ad, tracking_analytics, tracking_social und tracking_content: zeigt an, dass die Anfrage am Tracking beteiligt ist. tracking ist jede generische Tracking-Anfrage, die ad, analytics, social und content-Suffixe identifizieren den Typ des Trackers.
  • any_basic_tracking: ein Metaflag, das Tracking- und Fingerprinting-Flags kombiniert, aber tracking_content und fingerprinting_content ausschließt.
  • any_strict_tracking: ein Metaflag, das alle Tracking- und Fingerprinting-Flags kombiniert.
  • any_social_tracking: ein Metaflag, das alle sozialen Tracking-Flags kombiniert.

Browser-Kompatibilität

BCD tables only load in the browser

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] });

Beispiel-Erweiterungen

Hinweis: Diese API basiert auf der Chromium-API chrome.webRequest. Diese Dokumentation stammt von web_request.json im Chromium-Code.