webRequest.onResponseStarted

Wird ausgelöst, wenn das erste Byte des Antwortkörpers empfangen wird.

Dieses Ereignis ist nur informativ.

Syntax

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

Ereignisse haben drei Funktionen:

addListener(listener, filter, extraInfoSpec)

Fügt einen Listener zu diesem Ereignis hinzu.

removeListener(listener)

Stoppt das Abhören dieses Ereignisses. Das Argument listener ist der zu entfernende Listener.

hasListener(listener)

Überprüfen, 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 eintritt. Der Funktion wird dieses Argument übergeben:

details

object. Details zur Anfrage. Siehe den Abschnitt details für weitere Informationen.

filter

webRequest.RequestFilter. Ein Filter, der die Ereignisse einschränkt, die zu diesem Listener gesendet werden.

extraInfoSpec Optional

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

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

Zusätzliche Objekte

details

cookieStoreId

string. Wenn die Anfrage von einem Tab mit kontextueller Identität erfolgt, ist dies die ID des Cookie-Stores der kontextuellen Identität. Siehe Arbeiten mit kontextuellen Identitäten für weitere Informationen.

documentUrl

string. Die URL des Dokuments, in dem die Ressource geladen wird. Wenn beispielsweise die Webseite bei "https://example.com" ein Bild oder ein <iframe> enthält, ist die documentUrl für das Bild oder <iframe> "https://example.com". 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 Unter-Frames, 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 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 kommt.

ip

string. Die IP-Adresse des Servers, an den die Anfrage gesendet wurde. Möglicherweise ist es eine wörtliche IPv6-Adresse.

method

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

originUrl

string. URL der Ressource, die die Anfrage ausgelöst hat. Beispielsweise, wenn "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, dieselbe wie die documentUrl. Wenn beispielsweise eine Seite ein <iframe> enthält und das <iframe> einen Link enthält, der ein neues Dokument in das <iframe> lädt, dann ist die documentUrl für die resultierende Anfrage das übergeordnete Dokument des <iframe>, aber die originUrl ist die URL des Dokuments im <iframe>, das den Link enthielt.

parentFrameId

integer. ID des Frames, der den Frame enthält, der die Anfrage gesendet hat. Setzt auf -1, 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. Eine der folgenden Möglichkeiten:

  • "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. Wahr, wenn der Proxy die Domainname-Auflösung basierend auf dem angegebenen Hostnamen durchführt, d. h., der Client sollte seine eigene DNS-Abfrage nicht durchführen.

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 miteinander in Verbindung zu bringen, 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 die Zeichenfolge 'HTTP/0.9 200 OK' für HTTP/0.9-Antworten (d. h. Antworten, denen eine Statuszeile fehlt) oder eine leere Zeichenfolge, wenn keine Header vorhanden sind.

tabId

integer. Die ID des Tabs, in dem die Anfrage stattfindet. Setzt auf -1, wenn die Anfrage nicht mit einem Tab verknüpft ist.

thirdParty

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

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 Verfolgung, die mit der Anfrage verbunden ist, wenn die Anfrage durch Firefox Tracking Protection klassifiziert wird. Dies ist ein Objekt mit diesen Eigenschaften:

firstParty

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

thirdParty

array von strings. Klassifikationsflags für die Anfrage oder die dritten Parteien in der Fensterhierarchie.

Die Klassifikationsflags umfassen:

  • fingerprinting und fingerprinting_content: zeigt an, dass die Anfrage in Fingerprinting involviert ist ("ein Ursprung, der festgestellt hat, dass er Fingerprinting betreibt").
    • fingerprinting zeigt an, dass die Domain in der Kategorie Fingerprinting und Tracking ist. Beispiele für diese Art von Domain sind Werbetreibende, die ein Profil mit dem besuchenden Benutzer verknüpfen möchten.
    • fingerprinting_content zeigt an, dass die Domain in der Kategorie Fingerprinting, aber nicht in der Tracking-Kategorie ist. Beispiele für diese Art von Domain sind Zahlungsanbieter, die Fingerprinting-Techniken verwenden, um den besuchenden Benutzer für Zwecke der Betrugsprävention 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 involviert ist. tracking ist jede generische Tracking-Anfrage, die Suffixe ad, analytics, social, und content identifizieren die Art des Trackers.
  • any_basic_tracking: ein Metaflag, das Tracking- und Fingerprinting-Flags kombiniert, jedoch 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/Firefox/Releases"
200
HTTP/1.1 200 OK
*/
function logResponse(responseDetails) {
  console.log(responseDetails.url);
  console.log(responseDetails.statusCode);
  console.log(responseDetails.statusLine);
}

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

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