Deskripsi
chrome.declarativeNetRequest
API digunakan untuk memblokir atau mengubah permintaan jaringan dengan menentukan aturan deklaratif. Hal ini memungkinkan ekstensi mengubah permintaan jaringan tanpa mencegat dan melihat kontennya, sehingga memberikan privasi yang lebih besar.
Izin
declarativeNetRequest
declarativeNetRequestWithHostAccess
Izin "declarativeNetRequest
" dan "declarativeNetRequestWithHostAccess
"
memberikan kemampuan yang sama. Perbedaan di antara keduanya adalah ketika izin
diminta atau diberikan.
"declarativeNetRequest"
- Memicu peringatan izin pada waktu penginstalan, tetapi memberikan akses implisit ke
aturan
allow
,allowAllRequests
, danblock
. Gunakan metode ini jika memungkinkan agar tidak perlu meminta akses penuh ke host. "declarativeNetRequestFeedback"
- Mengaktifkan fitur proses debug untuk ekstensi yang belum dipaketkan, khususnya
getMatchedRules()
danonRuleMatchedDebug
. "declarativeNetRequestWithHostAccess"
- Peringatan izin tidak ditampilkan pada waktu penginstalan, tetapi Anda harus meminta izin host sebelum dapat melakukan tindakan apa pun pada host. Hal ini tepat jika Anda ingin menggunakan aturan permintaan bersih deklaratif dalam ekstensi yang sudah memiliki izin host tanpa menghasilkan peringatan tambahan.
Ketersediaan
Manifes
Selain izin yang dijelaskan sebelumnya, jenis kumpulan aturan tertentu, khususnya kumpulan aturan statis, memerlukan deklarasi kunci manifes "declarative_net_request"
, yang harus berupa kamus dengan satu kunci yang disebut "rule_resources"
. Kunci ini adalah array yang berisi kamus jenis Ruleset
, seperti yang ditunjukkan berikut ini. (Perhatikan, nama 'Ruleset' tidak muncul dalam JSON manifes karena hanya berupa array.) Kumpulan aturan statis akan dijelaskan kemudian dalam dokumen ini.
{
"name": "My extension",
...
"declarative_net_request" : {
"rule_resources" : [{
"id": "ruleset_1",
"enabled": true,
"path": "rules_1.json"
}, {
"id": "ruleset_2",
"enabled": false,
"path": "rules_2.json"
}]
},
"permissions": [
"declarativeNetRequest",
"declarativeNetRequestFeedback",
],
"host_permissions": [
"http://www.blogger.com/*",
"http://*.google.com/*"
],
...
}
Konsep dan penggunaan
Untuk menggunakan API ini, tentukan satu atau beberapa kumpulan aturan. Kumpulan aturan berisi array aturan. Satu aturan melakukan salah satu hal berikut:
- Memblokir permintaan jaringan.
- Mengupgrade skema (http ke https).
- Mencegah permintaan diblokir dengan mengabaikan aturan diblokir yang cocok.
- Mengalihkan permintaan jaringan.
- Mengubah header permintaan atau respons.
Ada tiga jenis kumpulan aturan, yang dikelola dengan cara yang sedikit berbeda.
- Dinamis
- Terus ada di seluruh sesi browser dan upgrade ekstensi, serta dikelola menggunakan JavaScript saat ekstensi sedang digunakan.
- Sesi
- Dihapus saat browser dinonaktifkan dan saat versi ekstensi baru diinstal. Aturan sesi dikelola menggunakan JavaScript saat ekstensi sedang digunakan.
- Statis
- Dikemas, diinstal, dan diupdate saat ekstensi diinstal atau diupgrade. Aturan statis disimpan dalam file aturan berformat JSON dan dicantumkan dalam file manifes.
Beberapa bagian selanjutnya akan menjelaskan jenis aturan secara detail.
Kumpulan aturan dinamis dan cakupan sesi
Kumpulan aturan dinamis dan sesi dikelola menggunakan JavaScript saat ekstensi sedang digunakan.
- Aturan dinamis tetap ada di seluruh sesi browser dan upgrade ekstensi.
- Aturan sesi akan dihapus saat browser dinonaktifkan dan saat versi ekstensi baru diinstal.
Hanya ada satu dari setiap jenis kumpulan aturan ini. Ekstensi dapat menambahkan atau menghapus aturan secara dinamis dengan memanggil updateDynamicRules()
dan updateSessionRules()
, asalkan batas aturan tidak terlampaui. Untuk mengetahui informasi tentang batas aturan, lihat Batas aturan. Anda dapat melihat contohnya di bagian contoh kode.
Kumpulan aturan statis
Tidak seperti aturan dinamis dan sesi, aturan statis dikemas, diinstal, dan diupdate saat ekstensi diinstal atau diupgrade. Kunci tersebut disimpan dalam file aturan dalam format JSON, yang ditunjukkan ke ekstensi menggunakan kunci "declarative_net_request"
dan "rule_resources"
seperti yang dijelaskan di atas, serta satu atau beberapa kamus Ruleset
. Kamus Ruleset
berisi jalur ke file aturan, ID untuk kumpulan aturan yang terdapat dalam file, dan apakah kumpulan aturan diaktifkan atau dinonaktifkan. Dua yang terakhir penting saat Anda mengaktifkan atau menonaktifkan kumpulan aturan secara terprogram.
{
...
"declarative_net_request" : {
"rule_resources" : [{
"id": "ruleset_1",
"enabled": true,
"path": "rules_1.json"
},
...
]
}
...
}
Untuk menguji file aturan, muat ekstensi yang belum dibuka. Error dan peringatan tentang aturan statis yang tidak valid hanya ditampilkan untuk ekstensi yang belum dipaketkan. Aturan statis yang tidak valid pada ekstensi yang dipaketkan akan diabaikan.
Peninjauan yang dipercepat
Perubahan pada kumpulan aturan statis mungkin memenuhi syarat untuk peninjauan yang lebih cepat. Lihat peninjauan yang dipercepat untuk perubahan yang memenuhi syarat.
Mengaktifkan dan menonaktifkan aturan statis dan kumpulan aturan
Aturan statis individual dan kumpulan aturan statis lengkap dapat diaktifkan atau dinonaktifkan pada runtime.
Kumpulan aturan statis dan kumpulan aturan yang diaktifkan dipertahankan di seluruh sesi browser. Keduanya tidak dipertahankan di seluruh pembaruan ekstensi, yang berarti hanya aturan yang Anda pilih untuk ditinggalkan di file aturan yang tersedia setelah pembaruan.
Untuk alasan performa, ada juga batasan jumlah aturan dan kumpulan aturan yang dapat diaktifkan pada satu waktu. Panggil getAvailableStaticRuleCount()
untuk memeriksa jumlah aturan tambahan yang mungkin diaktifkan. Untuk mengetahui informasi tentang batas aturan, lihat Batas aturan.
Untuk mengaktifkan atau menonaktifkan aturan statis, panggil updateStaticRules()
. Metode ini menggunakan objek UpdateStaticRulesOptions
, yang berisi array ID aturan untuk diaktifkan atau dinonaktifkan. ID ditentukan menggunakan kunci "id"
dari kamus Ruleset
.
Untuk mengaktifkan atau menonaktifkan rulesets statis, panggil updateEnabledRulesets()
. Metode ini menggunakan objek UpdateRulesetOptions
, yang berisi array ID kumpulan aturan untuk diaktifkan atau dinonaktifkan. ID ditentukan menggunakan kunci "id"
dari kamus Ruleset
.
Buat aturan
Apa pun jenisnya, aturan dimulai dengan empat kolom seperti yang ditunjukkan di bawah ini. Meskipun kunci "id"
dan "priority"
mengambil angka, kunci "action"
dan "condition"
dapat memberikan beberapa kondisi pemblokiran dan pengalihan. Aturan berikut memblokir semua permintaan skrip yang berasal dari "foo.com"
ke URL apa pun dengan "abc"
sebagai substring.
{
"id" : 1,
"priority": 1,
"action" : { "type" : "block" },
"condition" : {
"urlFilter" : "abc",
"initiatorDomains" : ["foo.com"],
"resourceTypes" : ["script"]
}
}
Karakter yang cocok urlFilter
Kunci "condition"
aturan memungkinkan kunci "urlFilter"
untuk bertindak atas URL dalam domain yang ditentukan. Anda membuat pola menggunakan token pencocokan pola. Berikut beberapa contohnya.
urlFilter |
Kecocokan | Tidak cocok |
---|---|---|
"abc" |
https://abcd.com https://example.com/abcd |
https://ab.com |
"abc*d" |
https://abcd.com https://example.com/abcxyzd |
https://abc.com |
"||a.example.com" |
https://a.example.com/ https://b.a.example.com/xyz |
https://example.com/ |
"|https*" |
https://example.com | http://example.com/ http://https.com |
"example*^123|" |
https://example.com/123 http://abc.com/example?123 |
https://example.com/1234 https://abc.com/example0123 |
Penentuan prioritas aturan
Aturan dipicu oleh permintaan yang dikirim dari halaman web. Jika beberapa aturan cocok dengan permintaan tertentu, maka aturan harus diprioritaskan. Bagian ini menjelaskan cara memprioritaskannya. Penentuan prioritas dilakukan dalam dua tahap.
- Prioritas ditentukan untuk aturan dalam ekstensi.
- Jika beberapa ekstensi dapat menerapkan aturan ke sebuah permintaan, prioritas akan ditentukan untuk semua ekstensi yang cocok dengan permintaan tertentu.
Misalkan cocok dengan cara ini: aturan apa pun yang diprioritaskan oleh ekstensi tertentu akan lebih diprioritaskan dibandingkan aturan dari ekstensi lain.
Penentuan prioritas aturan dalam ekstensi
Dalam satu ekstensi, penentuan prioritas diselesaikan menggunakan proses berikut:
- Aturan dengan prioritas tertinggi yang ditetapkan developer (dengan kata lain, kolom
"priority"
) ditampilkan. Jika ada lebih dari satu aturan dengan prioritas tertinggi yang ditetapkan oleh developer, aturan akan diprioritaskan menggunakan kolom
"action"
, dengan urutan berikut:allow
allowAllRequests
block
upgradeScheme
redirect
Jika jenis tindakan bukan
block
atauredirect
, aturanmodifyHeaders
yang cocok akan dievaluasi. Perlu diketahui bahwa jika ada aturan dengan prioritas yang ditentukan developer yang lebih rendah dari prioritas yang ditentukan untukallow
danallowAllRequests
, aturan tersebut akan diabaikan.Jika beberapa aturan mengubah header yang sama, perubahan akan ditentukan oleh kolom
"priority"
yang ditentukan developer dan oleh operasi yang ditentukan.- Jika aturan ditambahkan ke header, aturan berprioritas lebih rendah hanya dapat ditambahkan ke header tersebut. Operasi setel dan hapus tidak diizinkan.
- Jika aturan menetapkan header, aturan dengan prioritas yang lebih rendah hanya dapat ditambahkan ke header tersebut. Tidak ada modifikasi lain yang diizinkan.
- Jika aturan menghapus header, aturan dengan prioritas yang lebih rendah tidak dapat mengubah header lebih lanjut.
Prioritas aturan antar-ekstensi
Jika hanya satu ekstensi yang memiliki aturan yang cocok dengan permintaan, aturan tersebut akan diterapkan. Namun, jika lebih dari satu ekstensi cocok dengan sebuah permintaan, proses berikut akan digunakan:
Aturan diprioritaskan menggunakan kolom
"action"
, dalam urutan berikut:block
redirect
atauupgradeScheme
allow
atauallowAllRequests
Jika lebih dari satu aturan cocok, ekstensi yang baru diinstal akan diprioritaskan.
Aturan aman
Aturan aman didefinisikan sebagai aturan dengan tindakan block
, allow
, allowAllRequests
, atau upgradeScheme
. Aturan ini tunduk pada kuota aturan dinamis yang ditingkatkan.
Batas aturan
Ada overhead performa untuk memuat dan mengevaluasi aturan di browser, sehingga beberapa batas berlaku saat menggunakan API. Batas tergantung pada jenis aturan yang Anda gunakan.
Aturan statis
Aturan statis adalah aturan yang ditentukan dalam file aturan yang dideklarasikan di file manifes. Ekstensi dapat menentukan hingga 100 rulesets statis sebagai bagian dari kunci manifes "rule_resources"
, tetapi hanya 50 dari kumpulan aturan ini yang dapat diaktifkan sekaligus. Parameter yang disebut terakhir disebut MAX_NUMBER_OF_ENABLED_STATIC_RULESETS
. Secara kolektif, kumpulan aturan tersebut dijamin setidaknya 30.000 aturan. Ini disebut GUARANTEED_MINIMUM_STATIC_RULES
.
Jumlah aturan yang tersedia setelahnya bergantung pada jumlah aturan yang diaktifkan oleh semua ekstensi yang diinstal di browser pengguna. Anda dapat menemukan nomor ini pada saat runtime dengan memanggil getAvailableStaticRuleCount()
. Anda dapat melihat contohnya di bagian contoh kode.
Aturan sesi
Satu ekstensi dapat memiliki hingga 5.000 aturan sesi. Hal ini diekspos sebagai
MAX_NUMBER_OF_SESSION_RULES
.
Sebelum Chrome 120, ada batas 5.000 gabungan aturan dinamis dan sesi.
Aturan dinamis
Ekstensi dapat memiliki minimal 5.000 aturan dinamis. Hal ini diekspos sebagai
MAX_NUMBER_OF_UNSAFE_DYNAMIC_RULES
.
Mulai Chrome 121, ada batas lebih besar yaitu 30.000 aturan yang tersedia untuk aturan dinamis yang aman,
yang diekspos sebagai MAX_NUMBER_OF_DYNAMIC_RULES
. Setiap aturan tidak aman yang ditambahkan dalam batas 5.000 juga akan diperhitungkan dalam batas ini.
Sebelum Chrome 120, ada batas gabungan 5.000 aturan dinamis dan sesi.
Aturan yang menggunakan ekspresi reguler
Semua jenis aturan dapat menggunakan ekspresi reguler; namun, jumlah total aturan ekspresi reguler untuk setiap jenis tidak boleh melebihi 1.000. Ini disebut MAX_NUMBER_OF_REGEX_RULES.
Selain itu, setiap aturan harus kurang dari 2KB setelah dikompilasi. Hal ini kurang lebih berkorelasi dengan kompleksitas aturan. Jika Anda mencoba memuat aturan yang melebihi batas ini, Anda akan melihat peringatan seperti berikut dan aturan akan diabaikan.
rules_1.json: Rule with id 1 specified a more complex regex than allowed
as part of the "regexFilter" key.
Interaksi dengan pekerja layanan
deklaratifNetRequest hanya berlaku pada permintaan yang mencapai tumpukan jaringan. Hal ini termasuk respons dari cache HTTP, tetapi mungkin tidak menyertakan respons yang melalui pengendali onfetch
pekerja layanan. deklaratifNetRequest tidak akan memengaruhi respons yang dihasilkan oleh pekerja layanan atau diambil dari CacheStorage
, tetapi akan memengaruhi panggilan ke fetch()
yang dibuat dalam pekerja layanan.
Referensi yang dapat diakses dari web
Aturan deklaratifNetRequest tidak bisa mengalihkan dari permintaan resource publik ke resource yang tidak dapat diakses oleh web. Tindakan tersebut akan memicu error. Hal ini berlaku meskipun resource yang dapat diakses web yang ditentukan dimiliki oleh ekstensi pengalihan. Guna mendeklarasikan resource untuk deklaratifNetRequest, gunakan array "web_accessible_resources"
manifes.
Contoh
Contoh kode
Memperbarui aturan dinamis
Contoh berikut menunjukkan cara memanggil updateDynamicRules()
. Prosedur untuk updateSessionRules()
sama.
// Get arrays containing new and old rules
const newRules = await getNewRules();
const oldRules = await chrome.declarativeNetRequest.getDynamicRules();
const oldRuleIds = oldRules.map(rule => rule.id);
// Use the arrays to update the dynamic rules
await chrome.declarativeNetRequest.updateDynamicRules({
removeRuleIds: oldRuleIds,
addRules: newRules
});
Memperbarui kumpulan aturan statis
Contoh berikut menunjukkan cara mengaktifkan dan menonaktifkan kumpulan aturan sambil mempertimbangkan jumlah yang tersedia dan jumlah maksimum kumpulan aturan statis yang diaktifkan. Anda akan melakukannya bila jumlah aturan statis yang Anda butuhkan melebihi jumlah yang diizinkan. Agar hal ini berfungsi, beberapa kumpulan aturan harus diinstal dengan beberapa kumpulan aturan dinonaktifkan (menyetel "Enabled"
ke false
dalam file manifes).
async function updateStaticRules(enableRulesetIds, disableCandidateIds) {
// Create the options structure for the call to updateEnabledRulesets()
let options = { enableRulesetIds: enableRulesetIds }
// Get the number of enabled static rules
const enabledStaticCount = await chrome.declarativeNetRequest.getEnabledRulesets();
// Compare rule counts to determine if anything needs to be disabled so that
// new rules can be enabled
const proposedCount = enableRulesetIds.length;
if (enabledStaticCount + proposedCount > chrome.declarativeNetRequest.MAX_NUMBER_OF_ENABLED_STATIC_RULESETS) {
options.disableRulesetIds = disableCandidateIds
}
// Update the enabled static rules
await chrome.declarativeNetRequest.updateEnabledRulesets(options);
}
Contoh aturan
Contoh berikut menggambarkan cara Chrome memprioritaskan aturan dalam ekstensi. Saat meninjaunya, sebaiknya buka aturan penentuan prioritas di jendela terpisah.
Kunci "prioritas"
Contoh ini memerlukan izin host untuk *://*.example.com/*
.
Untuk mengetahui prioritas URL tertentu, lihat kunci "priority"
(ditentukan developer), kunci "action"
, dan kunci "urlFilter"
. Contoh-contoh ini mengacu pada file aturan contoh yang ditampilkan di bawah ini.
- Buka https://google.com
- Dua aturan mencakup URL ini: aturan dengan ID 1 dan 4. Aturan dengan ID 1 berlaku karena tindakan
"block"
memiliki prioritas lebih tinggi daripada tindakan"redirect"
. Aturan lainnya tidak berlaku karena berlaku untuk URL yang lebih panjang. - Buka https://google.com/1234
- Karena URL-nya lebih panjang, aturan dengan ID 2 kini cocok dengan aturan dengan ID 1 dan 4. Aturan dengan ID 2 berlaku karena
"allow"
memiliki prioritas yang lebih tinggi daripada"block"
dan"redirect"
. - Buka https://google.com/12345
- Keempat aturan cocok dengan URL ini. Aturan dengan ID 3 berlaku karena prioritas yang ditentukan developer adalah yang tertinggi di grup.
[
{
"id": 1,
"priority": 1,
"action": { "type": "block" },
"condition": {"urlFilter": "google.com", "resourceTypes": ["main_frame"] }
},
{
"id": 2,
"priority": 1,
"action": { "type": "allow" },
"condition": { "urlFilter": "google.com/123", "resourceTypes": ["main_frame"] }
},
{
"id": 3,
"priority": 2,
"action": { "type": "block" },
"condition": { "urlFilter": "google.com/12345", "resourceTypes": ["main_frame"] }
},
{
"id": 4,
"priority": 1,
"action": { "type": "redirect", "redirect": { "url": "https://example.com" } },
"condition": { "urlFilter": "google.com", "resourceTypes": ["main_frame"] }
},
]
Pengalihan
Contoh di bawah memerlukan izin host untuk *://*.example.com/*
.
Contoh berikut menunjukkan cara mengalihkan permintaan dari example.com ke halaman dalam ekstensi itu sendiri. Jalur ekstensi /a.jpg
di-resolve ke chrome-extension://EXTENSION_ID/a.jpg
, dengan EXTENSION_ID
sebagai ID ekstensi Anda. Agar berfungsi, manifes harus mendeklarasikan /a.jpg
sebagai resource web yang dapat diakses.
{
"id": 1,
"priority": 1,
"action": { "type": "redirect", "redirect": { "extensionPath": "/a.jpg" } },
"condition": {
"urlFilter": "https://www.example.com",
"resourceTypes": ["main_frame"]
}
}
Parameter berikut ini menggunakan kunci "transform"
untuk mengalihkan ke subdomain example.com. Anchor nama domain ("||") digunakan untuk menangkap permintaan dengan skema apa pun dari example.com. Kunci "scheme"
di "transform"
menentukan bahwa pengalihan ke subdomain akan selalu menggunakan "https".
{
"id": 1,
"priority": 1,
"action": {
"type": "redirect",
"redirect": {
"transform": { "scheme": "https", "host": "new.example.com" }
}
},
"condition": {
"urlFilter": "||example.com",
"resourceTypes": ["main_frame"]
}
}
Contoh berikut menggunakan ekspresi reguler untuk mengalihkan dari https://www.abc.xyz.com/path
ke https://abc.xyz.com/path
. Di kunci "regexFilter"
, perhatikan bagaimana titik di-escape dan grup perekam memilih "abc" atau "def". Kunci "regexSubstitution"
menentukan kecocokan ekspresi reguler pertama yang ditampilkan menggunakan "\1". Dalam hal ini, "abc" diambil dari URL yang dialihkan dan ditempatkan sebagai pengganti.
{
"id": 1,
"priority": 1,
"action": {
"type": "redirect",
"redirect": {
"regexSubstitution": "https://\\1.xyz.com/"
}
},
"condition": {
"regexFilter": "^https://www\\.(abc|def)\\.xyz\\.com/",
"resourceTypes": [
"main_frame"
]
}
}
Header
Contoh berikut menghapus semua cookie dari frame utama dan sub-frame.
{
"id": 1,
"priority": 1,
"action": {
"type": "modifyHeaders",
"requestHeaders": [{ "header": "cookie", "operation": "remove" }]
},
"condition": { "resourceTypes": ["main_frame", "sub_frame"] }
}
Jenis
DomainType
Hal ini menjelaskan apakah permintaan merupakan pihak pertama atau ketiga untuk frame tempat permintaan berasal. Permintaan disebut sebagai pihak pertama jika memiliki domain yang sama (eTLD+1) dengan frame tempat permintaan berasal.
Enum
"firstParty"
Permintaan jaringan adalah pihak pertama pada frame tempat permintaan tersebut berasal.
"thirdParty"
Permintaan jaringan adalah pihak ketiga untuk frame tempat permintaan tersebut berasal.
ExtensionActionOptions
Properti
-
displayActionCountAsBadgeText
boolean opsional
Apakah akan otomatis menampilkan jumlah tindakan untuk suatu halaman sebagai teks badge ekstensi. Preferensi ini dipertahankan di seluruh sesi.
-
tabUpdate
TabActionCountUpdate opsional
Chrome 89 dan yang lebih baruDetail tentang cara menyesuaikan jumlah tindakan tab.
GetDisabledRuleIdsOptions
Properti
-
rulesetId
string
ID yang sesuai dengan
Ruleset
statis.
GetRulesFilter
Properti
-
ruleIds
number[] opsional
Jika ditentukan, hanya aturan dengan ID yang cocok yang akan disertakan.
HeaderOperation
Deskripsi ini menjelaskan kemungkinan operasi untuk aturan "modifyHeaders".
Enum
"append"
Menambahkan entri baru untuk header yang ditentukan. Operasi ini tidak didukung untuk header permintaan.
"set"
Menetapkan nilai baru untuk header yang ditentukan, menghapus header yang ada dengan nama yang sama.
"remove"
Menghapus semua entri untuk header yang ditentukan.
IsRegexSupportedResult
Properti
-
isSupported
boolean
-
alasan
UnsupportedRegexReason opsional
Menentukan alasan ekspresi reguler tidak didukung. Hanya diberikan jika
isSupported
salah.
MatchedRule
Properti
-
ruleId
angka
ID aturan yang cocok.
-
rulesetId
string
ID
Ruleset
tempat aturan ini berada. Untuk aturan yang berasal dari kumpulan aturan dinamis, aturan ini akan sama denganDYNAMIC_RULESET_ID
.
MatchedRuleInfo
Properti
-
aturan
-
tabId
angka
TabId tab tempat permintaan berasal jika tab masih aktif. Lainnya -1.
-
timeStamp
angka
Waktu aturan dicocokkan. Stempel waktu akan sesuai dengan ketentuan JavaScript untuk waktu, yaitu jumlah milidetik sejak epoch.
MatchedRuleInfoDebug
Properti
-
minta
Detail tentang permintaan pencocokan aturan.
-
aturan
MatchedRulesFilter
Properti
-
minTimeStamp
nomor opsional
Jika ditentukan, hanya mencocokkan aturan setelah stempel waktu yang diberikan.
-
tabId
nomor opsional
Jika ditentukan, hanya mencocokkan aturan untuk tab yang ditentukan. Mencocokkan aturan yang tidak dikaitkan dengan tab aktif mana pun jika ditetapkan ke -1.
ModifyHeaderInfo
Properti
-
header
string
Nama header yang akan diubah.
-
operasi
Operasi yang akan dilakukan pada header.
-
value
string opsional
Nilai baru untuk header. Harus ditentukan untuk operasi
append
danset
.
QueryKeyValue
Properti
-
kunci
string
-
replaceOnly
boolean opsional
Chrome 94 dan yang lebih baruJika true (benar), kunci kueri akan diganti hanya jika sudah ada. Jika tidak, kunci juga akan ditambahkan jika tidak ada. Nilai defaultnya adalah false (salah).
-
value
string
QueryTransform
Properti
-
addOrReplaceParams
QueryKeyValue[] opsional
Daftar pasangan nilai kunci kueri yang akan ditambahkan atau diganti.
-
removeParams
string[] opsional
Daftar kunci kueri yang akan dihapus.
Redirect
Properti
-
extensionPath
string opsional
Jalur yang relatif ke direktori ekstensi. Harus diawali dengan '/'.
-
regexSubstitution
string opsional
Pola substitusi untuk aturan yang menentukan
regexFilter
. Kecocokan pertamaregexFilter
dalam URL akan diganti dengan pola ini. DalamregexSubstitution
, digit garis miring terbalik (\1 hingga \9) dapat digunakan untuk menyisipkan grup tangkapan yang sesuai. \0 merujuk pada keseluruhan teks yang cocok. -
dan mengubah teks tersebut
URLTransform opsional
Transformasi URL yang akan dilakukan.
-
url
string opsional
URL pengalihan. Pengalihan ke URL JavaScript tidak diizinkan.
RegexOptions
Properti
-
isCaseSensitive
boolean opsional
Apakah
regex
yang ditentukan peka huruf besar/kecil. Defaultnya adalah true (benar). -
ekspresi reguler
string
Expresson reguler untuk diperiksa.
-
requireCapturing
boolean opsional
Apakah
regex
yang ditentukan memerlukan pengambilan data. Perekaman hanya diperlukan untuk aturan pengalihan yang menentukan tindakanregexSubstition
. Default-nya adalah salah.
RequestDetails
Properti
-
documentId
string opsional
Chrome 106+ID unik untuk dokumen frame, jika permintaan ini adalah untuk frame.
-
documentLifecycle
DocumentLifecycle opsional
Chrome 106+Siklus proses dokumen frame, jika permintaan ini untuk frame.
-
frameId
angka
Nilai 0 menunjukkan bahwa permintaan terjadi di frame utama; nilai positif menunjukkan ID subframe tempat permintaan terjadi. Jika dokumen bingkai (sub-) dimuat (
type
adalahmain_frame
atausub_frame
),frameId
menunjukkan ID bingkai ini, bukan ID bingkai luar. ID Frame bersifat unik di dalam tab. -
frameType
FrameType opsional
Chrome 106+Jenis frame, jika permintaan ini adalah untuk frame.
-
inisiator
string opsional
Asal tempat permintaan dimulai. Hal ini tidak berubah melalui pengalihan. Jika asalnya buram, string 'null' akan digunakan.
-
method
string
Metode HTTP standar.
-
parentDocumentId
string opsional
Chrome 106+ID unik untuk dokumen induk frame, jika permintaan ini adalah untuk frame dan memiliki induk.
-
parentFrameId
angka
ID frame yang menggabungkan frame yang mengirim permintaan. Tetapkan ke -1 jika tidak ada frame induk.
-
requestId
string
ID permintaan. ID permintaan bersifat unik dalam sesi browser.
-
tabId
angka
ID tab tempat permintaan terjadi. Tetapkan ke -1 jika permintaan tidak terkait dengan tab.
-
tipe
Jenis resource permintaan.
-
url
string
URL permintaan.
RequestMethod
Ini menjelaskan metode permintaan HTTP dari permintaan jaringan.
Enum
"head"
"patch"
"put"
ResourceType
Pernyataan ini menjelaskan jenis resource permintaan jaringan.
Enum
"main_frame"
"sub_frame"
"stylesheet"
"script"
"font"
"xmlhttprequest"
"ping"
"csp_report"
"media"
"websocket"
"webtransport"
"webbundle"
Rule
Properti
-
action
Tindakan yang akan diambil jika aturan ini cocok.
-
kondisi
Kondisi yang menyebabkan aturan ini dipicu.
-
id
angka
ID yang mengidentifikasi aturan secara unik. Wajib dan harus >= 1.
-
prioritas
nomor opsional
Prioritas aturan. Default-nya adalah 1. Jika ditentukan, nilainya harus >= 1.
RuleAction
Properti
-
alihkan
Pengalihan opsional
Menjelaskan cara melakukan pengalihan. Hanya valid untuk aturan pengalihan.
-
requestHeaders
ModifyHeaderInfo[] opsional
Chrome 86 dan yang lebih baruHeader permintaan yang akan diubah untuk permintaan. Hanya valid jika RuleActionType adalah "modifyHeaders".
-
responseHeaders
ModifyHeaderInfo[] opsional
Chrome 86 dan yang lebih baruHeader respons yang akan diubah untuk permintaan. Hanya valid jika RuleActionType adalah "modifyHeaders".
-
tipe
Jenis tindakan yang akan dilakukan.
RuleActionType
Menjelaskan jenis tindakan yang harus diambil jika RuleCondition tertentu cocok.
Enum
"block"
Memblokir permintaan jaringan.
"redirect"
Mengalihkan permintaan jaringan.
"allow"
Mengizinkan permintaan jaringan. Permintaan tidak akan dicegat jika ada aturan izinkan yang cocok dengannya.
"upgradeScheme"
Upgrade skema URL permintaan jaringan ke https jika permintaannya adalah http atau ftp.
"modifyHeaders"
Mengubah header permintaan/respons dari permintaan jaringan.
"allowAllRequests"
Mengizinkan semua permintaan dalam hierarki frame, termasuk permintaan frame itu sendiri.
RuleCondition
Properti
-
domainType
DomainType opsional
Menentukan apakah permintaan jaringan adalah pihak pertama atau pihak ketiga atas domain tempat permintaan jaringan berasal. Jika dihilangkan, semua permintaan akan diterima.
-
domains
string[] opsional
Tidak digunakan lagi sejak Chrome 101Sebagai gantinya, gunakan
initiatorDomains
Aturan hanya akan cocok dengan permintaan jaringan yang berasal dari daftar
domains
. -
excludedDomains
string[] opsional
Tidak digunakan lagi sejak Chrome 101Sebagai gantinya, gunakan
excludedInitiatorDomains
Aturan tidak akan cocok dengan permintaan jaringan yang berasal dari daftar
excludedDomains
. -
excludedInitiatorDomains
string[] opsional
Chrome 101+Aturan tidak akan cocok dengan permintaan jaringan yang berasal dari daftar
excludedInitiatorDomains
. Jika daftar kosong atau dihilangkan, tidak ada domain yang dikecualikan. Ini lebih diprioritaskan daripadainitiatorDomains
.Catatan:
- Sub-domain seperti "a.example.com" juga diizinkan.
- Entri hanya boleh terdiri dari karakter ASCII.
- Gunakan encoding punycode untuk domain yang diinternasionalkan.
- Ini cocok dengan inisiator permintaan, bukan URL permintaan.
- Sub-domain dari domain yang tercantum juga dikecualikan.
-
excludedRequestDomains
string[] opsional
Chrome 101+Aturan tidak akan cocok dengan permintaan jaringan jika domain cocok dengan salah satu dari daftar
excludedRequestDomains
. Jika daftar kosong atau dihilangkan, tidak ada domain yang dikecualikan. Ini lebih diprioritaskan daripadarequestDomains
.Catatan:
- Sub-domain seperti "a.example.com" juga diizinkan.
- Entri hanya boleh terdiri dari karakter ASCII.
- Gunakan encoding punycode untuk domain yang diinternasionalkan.
- Sub-domain dari domain yang tercantum juga dikecualikan.
-
excludedRequestMethods
RequestMethod[] opsional
Chrome 91 dan yang lebih baruDaftar metode permintaan yang aturannya tidak akan cocok. Hanya
requestMethods
danexcludedRequestMethods
yang harus ditentukan. Jika tidak satu pun dari opsi tersebut yang ditentukan, semua metode permintaan akan dicocokkan. -
excludedResourceTypes
ResourceType[] opsional
Daftar jenis resource yang tidak akan cocok dengan aturan. Hanya
resourceTypes
danexcludedResourceTypes
yang harus ditentukan. Jika tidak satu pun yang ditetapkan, semua jenis resource kecuali "main_frame" akan diblokir. -
excludedTabIds
number[] opsional
Chrome 92 dan yang lebih baruDaftar
tabs.Tab.id
yang tidak boleh cocok dengan aturan. IDtabs.TAB_ID_NONE
mengecualikan permintaan yang tidak berasal dari tab. Hanya didukung untuk aturan cakupan sesi. -
initiatorDomains
string[] opsional
Chrome 101+Aturan hanya akan cocok dengan permintaan jaringan yang berasal dari daftar
initiatorDomains
. Jika daftar dihilangkan, aturan akan diterapkan ke permintaan dari semua domain. Daftar kosong tidak diizinkan.Catatan:
- Sub-domain seperti "a.example.com" juga diizinkan.
- Entri hanya boleh terdiri dari karakter ASCII.
- Gunakan encoding punycode untuk domain yang diinternasionalkan.
- Ini cocok dengan inisiator permintaan, bukan URL permintaan.
- Sub-domain dari domain yang tercantum juga dicocokkan.
-
isUrlFilterCaseSensitive
boolean opsional
Apakah
urlFilter
atauregexFilter
(mana saja yang ditentukan) peka huruf besar/kecil. Defaultnya adalah false. -
regexFilter
string opsional
Ekspresi reguler yang akan dicocokkan dengan URL permintaan jaringan. Ini mengikuti sintaksis RE2.
Catatan: Hanya
urlFilter
atauregexFilter
yang dapat ditentukan.Catatan:
regexFilter
harus terdiri dari karakter ASCII saja. Ini dicocokkan dengan URL tempat host dienkode dalam format punycode (dalam kasus domain yang diinternasionalkan) dan karakter non-ascii lainnya dienkodekan dalam utf-8. -
requestDomains
string[] opsional
Chrome 101+Aturan hanya akan cocok dengan permintaan jaringan jika domain cocok dengan salah satu dari daftar
requestDomains
. Jika daftar dihilangkan, aturan akan diterapkan ke permintaan dari semua domain. Daftar kosong tidak diizinkan.Catatan:
- Sub-domain seperti "a.example.com" juga diizinkan.
- Entri hanya boleh terdiri dari karakter ASCII.
- Gunakan encoding punycode untuk domain yang diinternasionalkan.
- Sub-domain dari domain yang tercantum juga dicocokkan.
-
requestMethods
RequestMethod[] opsional
Chrome 91 dan yang lebih baruDaftar metode permintaan HTTP yang dapat cocok dengan aturan. Daftar kosong tidak diizinkan.
Catatan: Menentukan kondisi aturan
requestMethods
juga akan mengecualikan permintaan non-HTTP, sedangkan menentukanexcludedRequestMethods
tidak akan. -
resourceTypes
ResourceType[] opsional
Daftar jenis resource yang dapat cocok dengan aturan. Daftar kosong tidak diizinkan.
Catatan: ini harus ditentukan untuk aturan
allowAllRequests
dan hanya dapat mencakup jenis resourcesub_frame
danmain_frame
. -
tabIds
number[] opsional
Chrome 92 dan yang lebih baruDaftar
tabs.Tab.id
yang harus cocok dengan aturan. IDtabs.TAB_ID_NONE
cocok dengan permintaan yang tidak berasal dari tab. Daftar kosong tidak diizinkan. Hanya didukung untuk aturan cakupan sesi. -
urlFilter
string opsional
Pola yang dicocokkan dengan URL permintaan jaringan. Konstruksi yang didukung:
'*' : Karakter pengganti: Mencocokkan berapa pun jumlah karakter.
'|' : Anchor kiri/kanan: Jika digunakan di salah satu akhir pola, tentukan masing-masing awal/akhir URL.
'||' : Anchor nama domain: Jika digunakan di awal pola, menentukan awal (sub-)domain URL.
'^' : Karakter pemisah: Karakter ini cocok dengan apa pun kecuali huruf, angka, atau salah satu dari karakter berikut:
_
,-
,.
, atau%
. Ini juga cocok dengan bagian akhir URL.Oleh karena itu,
urlFilter
terdiri dari bagian-bagian berikut: (Anchor kiri/nama domain opsional) + pola + (Anchor kanan opsional).Jika dihilangkan, semua URL akan cocok. String kosong tidak diizinkan.
Pola yang dimulai dengan
||*
tidak diizinkan. Sebagai gantinya, gunakan*
.Catatan: Hanya
urlFilter
atauregexFilter
yang dapat ditentukan.Catatan:
urlFilter
harus terdiri dari karakter ASCII saja. Ini dicocokkan dengan URL tempat host dienkode dalam format punycode (dalam kasus domain yang diinternasionalkan) dan karakter non-ascii lainnya dienkodekan dalam utf-8. Misalnya, jika URL permintaan adalah http://abc.р i?q=84,urlFilter
akan dicocokkan dengan URL http://abc.xn--p1ai/?q=%D1%84.
Ruleset
Properti
-
diaktifkan
boolean
Apakah kumpulan aturan diaktifkan secara default.
-
id
string
String tidak kosong yang mengidentifikasi kumpulan aturan secara unik. ID yang diawali dengan '_' dicadangkan untuk penggunaan internal.
-
jalur
string
Jalur kumpulan aturan JSON yang relatif terhadap direktori ekstensi.
RulesMatchedDetails
Properti
-
rulesMatchedInfo
Aturan yang cocok dengan filter yang ditentukan.
TabActionCountUpdate
Properti
-
increment
angka
Jumlah untuk menambah jumlah tindakan tab. Nilai negatif akan mengurangi jumlah.
-
tabId
angka
Tab yang akan digunakan untuk memperbarui jumlah tindakan.
TestMatchOutcomeResult
Properti
-
matchedRules
Aturan (jika ada) yang cocok dengan permintaan hipotetis.
TestMatchRequestDetails
Properti
-
inisiator
string opsional
URL inisiator (jika ada) untuk permintaan hipotetis.
-
method
RequestMethod opsional
Metode HTTP standar permintaan hipotetis. Nilai defaultnya adalah "get" untuk permintaan HTTP dan diabaikan untuk permintaan non-HTTP.
-
tabId
nomor opsional
ID tab tempat permintaan hipotetis dilakukan. Tidak perlu sesuai dengan ID tab yang sebenarnya. Defaultnya adalah -1, artinya permintaan tidak terkait dengan tab.
-
tipe
Jenis resource permintaan hipotetis.
-
url
string
URL permintaan hipotetis.
UnsupportedRegexReason
Menjelaskan alasan mengapa ekspresi reguler tertentu tidak didukung.
Enum
"syntaxError"
Ekspresi reguler salah secara sintaksis, atau menggunakan fitur yang tidak tersedia di sintaksis RE2.
"memoryLimitLimited"
Ekspresi reguler melebihi batas memori.
UpdateRuleOptions
Properti
-
addRules
Aturan[] opsional
Aturan untuk ditambahkan.
-
removeRuleIds
number[] opsional
ID aturan yang akan dihapus. ID yang tidak valid akan diabaikan.
UpdateRulesetOptions
Properti
UpdateStaticRulesOptions
Properti
URLTransform
Properti
-
fragmen
string opsional
Fragmen baru untuk permintaan. Harus kosong, dalam hal ini fragmen yang ada akan dihapus; atau harus diawali dengan '#'.
-
host
string opsional
Host baru untuk permintaan.
-
sandi
string opsional
Sandi baru untuk permintaan.
-
jalur
string opsional
Jalur baru untuk permintaan. Jika kosong, jalur yang ada akan dihapus.
-
port
string opsional
Port baru untuk permintaan. Jika kosong, port yang ada akan dihapus.
-
kueri
string opsional
Kueri baru untuk permintaan. Harus kosong, yang jika demikian kueri yang ada akan dihapus; atau harus diawali dengan '?'.
-
queryTransform
QueryTransform opsional
Tambahkan, hapus, atau ganti key-value pair kueri.
-
skema
string opsional
Skema baru untuk permintaan. Nilai yang diizinkan adalah "http", "https", "ftp", dan "chrome-extension".
-
nama pengguna
string opsional
Nama pengguna baru untuk permintaan.
Properti
DYNAMIC_RULESET_ID
ID kumpulan aturan untuk aturan dinamis yang ditambahkan oleh ekstensi.
Nilai
GETMATCHEDRULES_QUOTA_INTERVAL
Interval waktu saat panggilan MAX_GETMATCHEDRULES_CALLS_PER_INTERVAL getMatchedRules
dapat dilakukan, ditentukan dalam menit. Panggilan tambahan akan langsung gagal dan menyetel runtime.lastError
. Catatan: Panggilan getMatchedRules
yang terkait dengan gestur pengguna dikecualikan dari kuota.
Nilai
10
GUARANTEED_MINIMUM_STATIC_RULES
Jumlah minimum aturan statis yang dijamin ke ekstensi di seluruh kumpulan aturan statis yang diaktifkan. Setiap aturan di atas batas ini akan diperhitungkan dalam batas aturan statis global.
Nilai
30.000
MAX_GETMATCHEDRULES_CALLS_PER_INTERVAL
Frekuensi getMatchedRules
dapat dipanggil dalam periode GETMATCHEDRULES_QUOTA_INTERVAL
.
Nilai
20
MAX_NUMBER_OF_DYNAMIC_RULES
Jumlah maksimum aturan dinamis yang dapat ditambahkan ekstensi.
Nilai
30.000
MAX_NUMBER_OF_ENABLED_STATIC_RULESETS
Jumlah maksimum Rulesets
statis yang dapat diaktifkan ekstensi pada satu waktu.
Nilai
50
MAX_NUMBER_OF_REGEX_RULES
Jumlah maksimum aturan ekspresi reguler yang dapat ditambahkan ekstensi. Batas ini dievaluasi secara terpisah untuk kumpulan aturan dinamis dan aturan yang ditentukan dalam file resource aturan.
Nilai
1.000
MAX_NUMBER_OF_SESSION_RULES
Jumlah maksimum aturan cakupan sesi yang dapat ditambahkan ekstensi.
Nilai
5.000
MAX_NUMBER_OF_STATIC_RULESETS
Jumlah maksimum Rulesets
statis yang dapat ditentukan oleh ekstensi sebagai bagian dari kunci manifes "rule_resources"
.
Nilai
100
MAX_NUMBER_OF_UNSAFE_DYNAMIC_RULES
Jumlah maksimum aturan dinamis "tidak aman" yang dapat ditambahkan ekstensi.
Nilai
5.000
MAX_NUMBER_OF_UNSAFE_SESSION_RULES
Jumlah maksimum aturan cakupan sesi "tidak aman" yang dapat ditambahkan ekstensi.
Nilai
5.000
SESSION_RULESET_ID
ID kumpulan aturan untuk aturan cakupan sesi yang ditambahkan oleh ekstensi.
Nilai
"_session"
Metode
getAvailableStaticRuleCount()
chrome.declarativeNetRequest.getAvailableStaticRuleCount(
callback?: function,
)
Menampilkan jumlah aturan statis yang dapat diaktifkan ekstensi sebelum batas aturan statis global tercapai.
Parameter
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:(count: number) => void
-
jumlah
angka
-
Hasil
-
Promise<number>
Chrome 91 dan yang lebih baruPromise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.
getDisabledRuleIds()
chrome.declarativeNetRequest.getDisabledRuleIds(
options: GetDisabledRuleIdsOptions,
callback?: function,
)
Menampilkan daftar aturan statis dalam Ruleset
tertentu yang saat ini dinonaktifkan.
Parameter
-
Menentukan kumpulan aturan untuk kueri.
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:(disabledRuleIds: number[]) => void
-
disabledRuleIds
angka[]
-
Hasil
-
Promise<number[]>
Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.
getDynamicRules()
chrome.declarativeNetRequest.getDynamicRules(
filter?: GetRulesFilter,
callback?: function,
)
Menampilkan kumpulan aturan dinamis saat ini untuk ekstensi. Pemanggil dapat secara opsional memfilter daftar aturan yang diambil dengan menentukan filter
.
Parameter
-
filter
GetRulesFilter opsional
Chrome 111 dan yang lebih baruObjek untuk memfilter daftar aturan yang diambil.
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:(rules: Rule[]) => void
-
rules
Aturan[]
-
Hasil
-
Promise<Aturan[]>
Chrome 91 dan yang lebih baruPromise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.
getEnabledRulesets()
chrome.declarativeNetRequest.getEnabledRulesets(
callback?: function,
)
Menampilkan ID untuk kumpulan kumpulan aturan statis yang diaktifkan saat ini.
Parameter
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:(rulesetIds: string[]) => void
-
rulesetIds
string[]
-
Hasil
-
Promise<string[]>
Chrome 91 dan yang lebih baruPromise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.
getMatchedRules()
chrome.declarativeNetRequest.getMatchedRules(
filter?: MatchedRulesFilter,
callback?: function,
)
Menampilkan semua aturan yang cocok untuk ekstensi. Pemanggil dapat secara opsional memfilter daftar aturan yang cocok dengan menentukan filter
. Metode ini hanya tersedia untuk ekstensi dengan izin "declarativeNetRequestFeedback"
atau izin "activeTab"
yang diberikan untuk tabId
yang ditentukan di filter
. Catatan: Aturan yang tidak terkait dengan dokumen aktif yang cocok lebih dari lima menit yang lalu tidak akan ditampilkan.
Parameter
-
filter
MatchedRulesFilter opsional
Objek untuk memfilter daftar aturan yang cocok.
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:(details: RulesMatchedDetails) => void
-
detail
-
Hasil
-
Promise<RulesMatchedDetails>
Chrome 91 dan yang lebih baruPromise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.
getSessionRules()
chrome.declarativeNetRequest.getSessionRules(
filter?: GetRulesFilter,
callback?: function,
)
Menampilkan kumpulan aturan cakupan sesi saat ini untuk ekstensi. Pemanggil dapat secara opsional memfilter daftar aturan yang diambil dengan menentukan filter
.
Parameter
-
filter
GetRulesFilter opsional
Chrome 111 dan yang lebih baruObjek untuk memfilter daftar aturan yang diambil.
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:(rules: Rule[]) => void
-
rules
Aturan[]
-
Hasil
-
Promise<Aturan[]>
Chrome 91 dan yang lebih baruPromise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.
isRegexSupported()
chrome.declarativeNetRequest.isRegexSupported(
regexOptions: RegexOptions,
callback?: function,
)
Memeriksa apakah ekspresi reguler yang diberikan akan didukung sebagai kondisi aturan regexFilter
.
Parameter
-
regexOptions
Ekspresi reguler yang akan diperiksa.
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:(result: IsRegexSupportedResult) => void
-
hasil
-
Hasil
-
Promise<IsRegexSupportedResult>
Chrome 91 dan yang lebih baruPromise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.
setExtensionActionOptions()
chrome.declarativeNetRequest.setExtensionActionOptions(
options: ExtensionActionOptions,
callback?: function,
)
Mengonfigurasi apakah jumlah tindakan untuk tab harus ditampilkan sebagai teks badge tindakan ekstensi dan memberi cara agar jumlah tindakan tersebut bertambah.
Parameter
-
callback
fungsi opsional
Chrome 89 dan yang lebih baruParameter
callback
terlihat seperti:() => void
Hasil
-
Promise<void>
Chrome 91 dan yang lebih baruPromise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.
testMatchOutcome()
chrome.declarativeNetRequest.testMatchOutcome(
request: TestMatchRequestDetails,
callback?: function,
)
Memeriksa apakah salah satu aturan deklaratifNetRequest ekstensi akan cocok dengan permintaan hipotetis. Catatan: Hanya tersedia untuk ekstensi yang belum dipaketkan karena hanya dimaksudkan untuk digunakan selama pengembangan ekstensi.
Parameter
-
minta
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:(result: TestMatchOutcomeResult) => void
-
hasil
-
Hasil
-
Promise<TestMatchOutcomeResult>
Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.
updateDynamicRules()
chrome.declarativeNetRequest.updateDynamicRules(
options: UpdateRuleOptions,
callback?: function,
)
Memodifikasi kumpulan aturan dinamis saat ini untuk ekstensi. Aturan dengan ID yang tercantum di options.removeRuleIds
akan dihapus terlebih dahulu, lalu aturan yang diberikan di options.addRules
akan ditambahkan. Catatan:
- Pembaruan ini terjadi sebagai operasi atomik tunggal: semua aturan yang ditentukan ditambahkan dan dihapus, atau error ditampilkan.
- Aturan ini dipertahankan di seluruh sesi browser dan di seluruh update ekstensi.
- Aturan statis yang ditetapkan sebagai bagian dari paket ekstensi tidak dapat dihapus menggunakan fungsi ini.
MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES
adalah jumlah maksimum gabungan aturan dinamis dan sesi yang dapat ditambahkan ekstensi.
Parameter
-
opsiChrome 87 dan yang lebih baru
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:() => void
Hasil
-
Promise<void>
Chrome 91 dan yang lebih baruPromise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.
updateEnabledRulesets()
chrome.declarativeNetRequest.updateEnabledRulesets(
options: UpdateRulesetOptions,
callback?: function,
)
Memperbarui kumpulan kumpulan aturan statis yang diaktifkan untuk ekstensi. Kumpulan aturan dengan ID yang tercantum di options.disableRulesetIds
akan dihapus terlebih dahulu, lalu kumpulan aturan yang tercantum di options.enableRulesetIds
akan ditambahkan.
Perhatikan bahwa kumpulan kumpulan aturan statis yang diaktifkan dipertahankan di seluruh sesi, tetapi tidak di seluruh update ekstensi, yaitu kunci manifes rule_resources
akan menentukan kumpulan kumpulan aturan statis yang diaktifkan pada setiap update ekstensi.
Parameter
-
opsiChrome 87 dan yang lebih baru
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:() => void
Hasil
-
Promise<void>
Chrome 91 dan yang lebih baruPromise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.
updateSessionRules()
chrome.declarativeNetRequest.updateSessionRules(
options: UpdateRuleOptions,
callback?: function,
)
Mengubah kumpulan aturan cakupan sesi saat ini untuk ekstensi. Aturan dengan ID yang tercantum di options.removeRuleIds
akan dihapus terlebih dahulu, lalu aturan yang diberikan di options.addRules
akan ditambahkan. Catatan:
- Pembaruan ini terjadi sebagai operasi atomik tunggal: semua aturan yang ditentukan ditambahkan dan dihapus, atau error ditampilkan.
- Aturan ini tidak dipertahankan di seluruh sesi dan dicadangkan dalam memori.
MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES
adalah jumlah maksimum gabungan aturan dinamis dan sesi yang dapat ditambahkan ekstensi.
Parameter
-
opsi
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:() => void
Hasil
-
Promise<void>
Chrome 91 dan yang lebih baruPromise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.
updateStaticRules()
chrome.declarativeNetRequest.updateStaticRules(
options: UpdateStaticRulesOptions,
callback?: function,
)
Menonaktifkan dan mengaktifkan setiap aturan statis di Ruleset
. Perubahan pada aturan milik Ruleset
yang dinonaktifkan akan berlaku saat berikutnya setelan tersebut diaktifkan.
Parameter
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:() => void
Hasil
-
Promise<void>
Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.
Acara
onRuleMatchedDebug
chrome.declarativeNetRequest.onRuleMatchedDebug.addListener(
callback: function,
)
Diaktifkan saat aturan cocok dengan permintaan. Hanya tersedia untuk ekstensi yang belum dipaketkan dengan izin "declarativeNetRequestFeedback"
karena dimaksudkan untuk digunakan hanya untuk tujuan proses debug.
Parameter
-
callback
fungsi
Parameter
callback
terlihat seperti:(info: MatchedRuleInfoDebug) => void
-
info
-