chrome.browsingData

תיאור

משתמשים ב-chrome.browsingData API כדי להסיר נתוני גלישה מהפרופיל המקומי של המשתמש.

הרשאות

browsingData

כדי להשתמש ב-API הזה, צריך להצהיר על ההרשאה "browsingData" במניפסט של התוסף.

{
  "name": "My extension",
  ...
  "permissions": [
    "browsingData",
  ],
  ...
}

מושגים ושימוש

תרחיש השימוש הפשוט ביותר ב-API הזה הוא מנגנון מבוסס-זמן למחיקת נתוני הגלישה של משתמש. הקוד צריך לספק חותמת זמן שמציינת את התאריך ההיסטורי שאחריו צריך להסיר את נתוני הגלישה של המשתמש. חותמת הזמן הזו מפורמטת כמספר אלפיות השנייה מאז ראשית זמן יוניקס (שאפשר לאחזר מאובייקט JavaScript Date באמצעות השיטה getTime()).

לדוגמה, כדי לנקות את כל נתוני הגלישה של משתמש מהשבוע האחרון, אפשר לכתוב קוד באופן הבא:

var callback = function () {
  // Do something clever here once data has been removed.
};

var millisecondsPerWeek = 1000 * 60 * 60 * 24 * 7;
var oneWeekAgo = (new Date()).getTime() - millisecondsPerWeek;
chrome.browsingData.remove({
  "since": oneWeekAgo
}, {
  "appcache": true,
  "cache": true,
  "cacheStorage": true,
  "cookies": true,
  "downloads": true,
  "fileSystems": true,
  "formData": true,
  "history": true,
  "indexedDB": true,
  "localStorage": true,
  "passwords": true,
  "serviceWorkers": true,
  "webSQL": true
}, callback);

השיטה chrome.browsingData.remove() מאפשרת להסיר סוגים שונים של נתוני גלישה באמצעות קריאה אחת, והיא מהירה בהרבה מקריאה של כמה שיטות ספציפיות יותר. עם זאת, אם אתם רוצים למחוק רק סוג ספציפי אחד של נתוני גלישה (לדוגמה, קובצי Cookie), השיטות המפורטות יותר מציעות חלופה קריאה לקריאה שמלאה ב-JSON.

var callback = function () {
  // Do something clever here once data has been removed.
};

var millisecondsPerWeek = 1000 * 60 * 60 * 24 * 7;
var oneWeekAgo = (new Date()).getTime() - millisecondsPerWeek;
chrome.browsingData.removeCookies({
  "since": oneWeekAgo
}, callback);

אם המשתמש מסנכרן את הנתונים שלו, יכול להיות ש-chrome.browsingData.remove() יבנה מחדש את קובץ ה-Cookie באופן אוטומטי עבור חשבון הסנכרון אחרי שהוא יימחק. הסיבה לכך היא כדי לוודא שהסנכרון ימשיך לפעול, כך שבסופו של דבר הנתונים יימחקו מהשרת. עם זאת, אפשר להשתמש בפקודה הספציפית יותר chrome.browsingData.removeCookies() כדי לנקות את קובץ ה-Cookie של חשבון הסנכרון, ובמקרה כזה הסנכרון יושהה.

חשוב: הסרת נתוני הגלישה כרוכה בפעולות רבות ברקע, והיא יכולה להימשך עשרות שניות, בהתאם לפרופיל המשתמש. כדי שהמשתמשים שלכם יישארו מעודכנים לגבי סטטוס ההסרה, אתם צריכים להשתמש בהבטחה שהוחזרה או בקריאה החוזרת.

מקורות ספציפיים

כדי להסיר נתונים ממקור ספציפי או כדי להחריג קבוצה של מקורות ממחיקה, אפשר להשתמש בפרמטרים RemovalOptions.origins ו-RemovalOptions.excludeOrigins. אפשר להחיל אותם רק על קובצי Cookie, על מטמון ועל אחסון (CacheStorage,‏ FileSystems,‏ IndexedDB,‏ LocalStorage,‏ ServiceWorkers ו-WebSQL).

chrome.browsingData.remove({
  "origins": ["https://www.example.com"]
}, {
  "cacheStorage": true,
  "cookies": true,
  "fileSystems": true,
  "indexedDB": true,
  "localStorage": true,
  "serviceWorkers": true,
  "webSQL": true
}, callback);

חשוב: קובצי Cookie חלים על היקף רחב יותר מאשר סוגים אחרים של אחסון, ולכן מחיקה של קובצי Cookie עבור מקור מסוים תגרום למחיקה של כל קובצי ה-Cookie של הדומיין שניתן לרישום. לדוגמה, אם מוחקים נתונים של https://www.example.com, יימחקו גם קובצי Cookie עם דומיין של .example.com.

סוגי מקורות

הוספה של מאפיין originTypes לאובייקט האפשרויות של ממשקי ה-API מאפשרת לציין אילו סוגים של מקורות צריכים להיות מושפעים. המקורות מחולקים לשלוש קטגוריות:

• ‫unprotectedWeb מתייחס למקרה הכללי של אתרים שמשתמשים מבקרים בהם בלי לבצע פעולה מיוחדת. אם לא מציינים originTypes, ה-API יסיר כברירת מחדל נתונים ממקורות אינטרנט לא מוגנים.
• ‫protectedWeb כולל את מקורות האינטרנט שהותקנו כאפליקציות מתארחות. לדוגמה, התקנה של Angry Birds מגנה על המקור https://chrome.angrybirds.com ומסירה אותו מהקטגוריה unprotectedWeb. צריך להיזהר כשמפעילים מחיקה של נתונים מהמקורות האלה: חשוב לוודא שהמשתמשים יודעים מה הם מקבלים, כי הפעולה הזו תסיר את נתוני המשחק שלהם באופן סופי. אף אחד לא רוצה להפיל בתי חזירים קטנים יותר מהנדרש.
• ‫extension מכסה מקורות במסגרת הסכימה chrome-extensions:. כמו שאמרנו, צריך להיזהר מאוד כשמסירים נתונים של תוספים.

אפשר לשנות את הדוגמה הקודמת כדי להסיר רק נתונים מאתרים מוגנים, באופן הבא:

var callback = function () {
  // Do something clever here once data has been removed.
};

var millisecondsPerWeek = 1000 * 60 * 60 * 24 * 7;
var oneWeekAgo = (new Date()).getTime() - millisecondsPerWeek;
chrome.browsingData.remove({
  "since": oneWeekAgo,
  "originTypes": {
    "protectedWeb": true
  }
}, {
  "appcache": true,
  "cache": true,
  "cacheStorage": true,
  "cookies": true,
  "downloads": true,
  "fileSystems": true,
  "formData": true,
  "history": true,
  "indexedDB": true,
  "localStorage": true,
  "passwords": true,
  "serviceWorkers": true,
  "webSQL": true
}, callback);

אזהרה: צריך להיזהר עם סוגי המקור protectedWeb ו-extension. אלה פעולות הרסניות שעלולות להפתיע את המשתמשים אם הם לא יודעים למה לצפות כשתוסף מסיר נתונים בשמם.

דוגמאות

כדי לנסות את ה-API הזה, מתקינים את הדוגמה ל-browsingData API ממאגר chrome-extension-samples.

סוגים

DataTypeSet

קבוצה של סוגי נתונים. סוגי נתונים חסרים מפוענחים כ-false.

מאפיינים

• appcache

  boolean אופציונלי

  מטמון האפליקציות של אתרים.

• קובץ שמור

  boolean אופציונלי

  המטמון של הדפדפן.

• cacheStorage

  boolean אופציונלי

  ‫Chrome 72 ואילך

  אחסון המטמון

• קובצי cookie

  boolean אופציונלי

  קובצי ה-Cookie של הדפדפן.

• הורדות

  boolean אופציונלי

  רשימת ההורדות של הדפדפן.

• fileSystems

  boolean אופציונלי

  מערכות הקבצים של אתרים.

• formData

  boolean אופציונלי

  נתוני הטפסים שמאוחסנים בדפדפן.

• היסטוריה

  boolean אופציונלי

  ההיסטוריה של הדפדפן.

• indexedDB

  boolean אופציונלי

  נתוני IndexedDB של אתרים.

• localStorage

  boolean אופציונלי

  נתונים של אחסון מקומי של אתרים.

• סיסמאות

  boolean אופציונלי

  הוצא משימוש מאז Chrome 144

  הוסרה התמיכה במחיקת סיסמאות באמצעות תוספים. המערכת תתעלם מסוג הנתונים הזה.

  סיסמאות שמורות.

• pluginData

  boolean אופציונלי

  הוצא משימוש מאז Chrome 88

  התמיכה ב-Flash הוסרה. המערכת תתעלם מסוג הנתונים הזה.

  נתונים של תוספים.

• serverBoundCertificates

  boolean אופציונלי

  הוצא משימוש מאז Chrome 76

  הוסר התמיכה באישורים שקשורים לשרת. המערכת תתעלם מסוג הנתונים הזה.

  אישורים שקשורים לשרת.

• serviceWorkers

  boolean אופציונלי

  קובצי שירות (service worker).

• webSQL

  boolean אופציונלי

  נתוני WebSQL של אתרים.

RemovalOptions

אפשרויות שקובעות בדיוק אילו נתונים יוסרו.

מאפיינים

• excludeOrigins

  string[] אופציונלי

  ‫Chrome 74 ואילך

  אם יש מקורות ברשימה הזו, הנתונים שלהם לא יימחקו. אי אפשר להשתמש בהן יחד עם origins. התמיכה זמינה רק לקובצי Cookie, לאחסון ולמטמון. קובצי ה-Cookie מוחרגים לכל הדומיין שניתן לרישום.

• originTypes

  אובייקט אופציונלי

  אובייקט שהמאפיינים שלו מציינים אילו סוגי מקורות צריך לנקות. אם לא מציינים את האובייקט הזה, ברירת המחדל היא ניקוי רק של מקורות 'לא מוגנים'. לפני שמוסיפים את protectedWeb או extensions, חשוב לוודא שבאמת רוצים להסיר את נתוני האפליקציה.

  • תוסף

    boolean אופציונלי

    תוספים ואפליקציות ארוזות שהמשתמש התקין (צריך להיזהר מאוד!).

  • protectedWeb

    boolean אופציונלי

    אתרים שהותקנו כאפליקציות מארחות (חשוב להיזהר!).

  • unprotectedWeb

    boolean אופציונלי

    אתרים רגילים.

• מקורות

  ‫[string, ...string[]] אופציונלי

  ‫Chrome 74 ואילך

  אם הרשימה קיימת, יימחקו רק נתונים ממקורות שמופיעים בה. התמיכה זמינה רק לקובצי Cookie, לאחסון ולמטמון. קובצי ה-Cookie נמחקים לכל הדומיין שניתן לרישום.

• מאז

  מספר אופציונלי

  הסרת נתונים שנצברו בתאריך הזה או אחריו, שמוצגים באלפיות השנייה מאז תקופת האפוק (אפשר לגשת אליהם באמצעות השיטה getTime של אובייקט JavaScript‏ Date). אם לא מציינים ערך, ברירת המחדל היא 0 (שמשמעותה הסרת כל נתוני הגלישה).

Methods

remove()

chrome.browsingData.remove(
  options: RemovalOptions,
  dataToRemove: DataTypeSet,
): Promise<void>

מחיקת סוגים שונים של נתוני גלישה שמאוחסנים בפרופיל של המשתמש.

פרמטרים

• options

  RemovalOptions

• dataToRemove

  DataTypeSet

  קבוצת סוגי הנתונים להסרה.

החזרות

• Promise<void>

  ‫Chrome 96 ואילך

  ההבטחה מתקיימת כשהמחיקה מסתיימת.

removeAppcache()

chrome.browsingData.removeAppcache(
  options: RemovalOptions,
): Promise<void>

מנקה את נתוני מטמון האפליקציות של אתרים.

פרמטרים

• options

  RemovalOptions

החזרות

• Promise<void>

  ‫Chrome 96 ואילך

  הבעיה נפתרת כשנתוני מטמון האפליקציות של אתרים נוקו.

removeCache()

chrome.browsingData.removeCache(
  options: RemovalOptions,
): Promise<void>

מנקה את המטמון של הדפדפן.

פרמטרים

• options

  RemovalOptions

החזרות

• Promise<void>

  ‫Chrome 96 ואילך

  הבעיה נפתרת כשמנקים את המטמון של הדפדפן.

removeCacheStorage()

‫Chrome 72 ואילך

chrome.browsingData.removeCacheStorage(
  options: RemovalOptions,
): Promise<void>

מחיקת נתוני אחסון במטמון של אתרים.

פרמטרים

• options

  RemovalOptions

החזרות

• Promise<void>

  ‫Chrome 96 ואילך

  הפעולה הזו מתבצעת כשמאחסון המטמון של האתרים נמחקים נתונים.

removeCookies()

chrome.browsingData.removeCookies(
  options: RemovalOptions,
): Promise<void>

מחיקת קובצי ה-Cookie בדפדפן והאישורים שקשורים לשרת, ששונו במסגרת זמן מסוימת.

פרמטרים

• options

  RemovalOptions

החזרות

• Promise<void>

  ‫Chrome 96 ואילך

  הפונקציה הזו מופעלת כשקובצי ה-Cookie של הדפדפן והאישורים שקשורים לשרת נוקו.

removeDownloads()

chrome.browsingData.removeDownloads(
  options: RemovalOptions,
): Promise<void>

מחיקת רשימת הקבצים שהורדו בדפדפן (לא הקבצים עצמם).

פרמטרים

• options

  RemovalOptions

החזרות

• Promise<void>

  ‫Chrome 96 ואילך

  ההבטחה מתקיימת כשמנקים את רשימת הקבצים שהורדו בדפדפן.

removeFileSystems()

chrome.browsingData.removeFileSystems(
  options: RemovalOptions,
): Promise<void>

מחיקת נתונים ממערכת הקבצים של אתרים.

פרמטרים

• options

  RemovalOptions

החזרות

• Promise<void>

  ‫Chrome 96 ואילך

  ההבטחה מתקיימת כשמערכות הקבצים של האתרים נוקו.

removeFormData()

chrome.browsingData.removeFormData(
  options: RemovalOptions,
): Promise<void>

מנקה את נתוני הטפסים המאוחסנים בדפדפן (מילוי אוטומטי).

פרמטרים

• options

  RemovalOptions

החזרות

• Promise<void>

  ‫Chrome 96 ואילך

  ההבטחה מתקיימת כשנתוני הטופס של הדפדפן נוקו.

removeHistory()

chrome.browsingData.removeHistory(
  options: RemovalOptions,
): Promise<void>

מחיקה של היסטוריית הגלישה בדפדפן.

פרמטרים

• options

  RemovalOptions

החזרות

• Promise<void>

  ‫Chrome 96 ואילך

  ההבטחה מתקיימת כשההיסטוריה של הדפדפן נוקתה.

removeIndexedDB()

chrome.browsingData.removeIndexedDB(
  options: RemovalOptions,
): Promise<void>

מנקה את נתוני IndexedDB של אתרים.

פרמטרים

• options

  RemovalOptions

החזרות

• Promise<void>

  ‫Chrome 96 ואילך

  ההבטחה מתקיימת כשנתוני IndexedDB של אתרים נוקו.

removeLocalStorage()

chrome.browsingData.removeLocalStorage(
  options: RemovalOptions,
): Promise<void>

מחיקת נתונים של אחסון מקומי של אתרים.

פרמטרים

• options

  RemovalOptions

החזרות

• Promise<void>

  ‫Chrome 96 ואילך

  הבעיה נפתרת כשמנקים את האחסון המקומי של אתרים.

removePasswords()

הוצא משימוש מאז Chrome 144

chrome.browsingData.removePasswords(
  options: RemovalOptions,
): Promise<void>

הוסרה התמיכה במחיקת סיסמאות באמצעות תוספים. לפונקציה הזו אין השפעה.

מוחק את הסיסמאות השמורות בדפדפן.

פרמטרים

• options

  RemovalOptions

החזרות

• Promise<void>

  ‫Chrome 96 ואילך

  הפונקציה מופעלת כשמנקים את הסיסמאות בדפדפן.

removePluginData()

הוצא משימוש מאז Chrome 88

chrome.browsingData.removePluginData(
  options: RemovalOptions,
): Promise<void>

התמיכה ב-Flash הוסרה. לפונקציה הזו אין השפעה.

מחיקת הנתונים של התוספים.

פרמטרים

• options

  RemovalOptions

החזרות

• Promise<void>

  ‫Chrome 96 ואילך

  הפונקציה מסתיימת כשנתוני הפלאגינים נוקו.

removeServiceWorkers()

‫Chrome 72 ואילך

chrome.browsingData.removeServiceWorkers(
  options: RemovalOptions,
): Promise<void>

מנקה את קובצי השירות (Service Workers) של אתרים.

פרמטרים

• options

  RemovalOptions

החזרות

• Promise<void>

  ‫Chrome 96 ואילך

  ההבטחה מתקיימת כשעובדי השירות של האתרים נוקו.

removeWebSQL()

chrome.browsingData.removeWebSQL(
  options: RemovalOptions,
): Promise<void>

מחיקת נתוני WebSQL של אתרים.

פרמטרים

• options

  RemovalOptions

החזרות

• Promise<void>

  ‫Chrome 96 ואילך

  הבעיה נפתרת כשמסירים את מסדי הנתונים של WebSQL באתרים.

settings()

chrome.browsingData.settings(): Promise<object>

הדוחות מציגים את סוגי הנתונים שנבחרו כרגע בממשק המשתמש של ההגדרות 'ניקוי נתוני הגלישה'. הערה: חלק מסוגי הנתונים שנכללים בממשק ה-API הזה לא זמינים בממשק המשתמש של ההגדרות, וחלק מההגדרות בממשק המשתמש שולטות ביותר מסוג נתונים אחד שמופיע כאן.

החזרות

• Promise<object>

  ‫Chrome 96 ואילך