browser.history

Mô tả

Sử dụng API chrome.history để tương tác với bản ghi của trình duyệt về các trang đã truy cập. Bạn có thể thêm, xoá và truy vấn URL trong nhật ký của trình duyệt. Để ghi đè trang nhật ký bằng phiên bản của riêng bạn, hãy xem phần Ghi đè trang.

Quyền

history

Để tương tác với nhật ký duyệt web của người dùng, hãy sử dụng API nhật ký.

Để sử dụng API nhật ký, hãy khai báo quyền "history" trong tệp kê khai tiện ích. Ví dụ:

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

Khái niệm và cách sử dụng

Loại chuyển tiếp

API nhật ký sử dụng các loại chuyển đổi để mô tả cách trình duyệt chuyển đến một URL cụ thể trong một lượt truy cập cụ thể. Ví dụ: nếu người dùng truy cập vào một trang bằng cách nhấp vào đường liên kết trên một trang khác, thì loại chuyển đổi là "đường liên kết". Xem nội dung tham khảo để biết danh sách các loại hiệu ứng chuyển đổi.

Ví dụ

Để dùng thử API này, hãy cài đặt ví dụ về API nhật ký từ kho lưu trữ chrome-extension-samples.

Loại

HistoryItem

Một đối tượng đóng gói một kết quả của truy vấn nhật ký.

Thuộc tính

  • id

    chuỗi

    Giá trị nhận dạng riêng biệt của mặt hàng.

  • lastVisitTime

    number không bắt buộc

    Thời điểm gần đây nhất trang này được tải, tính bằng mili giây kể từ thời gian bắt đầu của hệ thống.

  • tiêu đề

    chuỗi không bắt buộc

    Tiêu đề của trang trong lần tải gần đây nhất.

  • typedCount

    number không bắt buộc

    Số lần người dùng đã chuyển đến trang này bằng cách nhập địa chỉ.

  • url

    chuỗi không bắt buộc

    URL mà người dùng đã truy cập.

  • visitCount

    number không bắt buộc

    Số lần người dùng đã chuyển đến trang này.

TransitionType

Trình duyệt Chrome 44 trở lên .* kể từ Chrome 148

Loại chuyển đổi cho lượt truy cập này từ trang giới thiệu.

Enum

"link"
Người dùng truy cập vào trang này bằng cách nhấp vào một đường liên kết trên một trang khác.

"typed"
Người dùng truy cập vào trang này bằng cách nhập URL vào thanh địa chỉ. Thao tác này cũng được dùng cho các thao tác điều hướng rõ ràng khác.

"auto_bookmark"
Người dùng truy cập vào trang này thông qua một đề xuất trong giao diện người dùng, chẳng hạn như thông qua một mục trong trình đơn.

"auto_subframe"
Người dùng đã truy cập vào trang này thông qua thao tác di chuyển trong khung phụ mà họ không yêu cầu, chẳng hạn như thông qua một quảng cáo đang tải trong một khung trên trang trước. Những thao tác này không phải lúc nào cũng tạo ra các mục điều hướng mới trong trình đơn quay lại và tiến lên.

"manual_subframe"
Người dùng truy cập vào trang này bằng cách chọn một mục trong khung phụ.

"generated"
Người dùng truy cập vào trang này bằng cách nhập vào thanh địa chỉ và chọn một mục không giống URL, chẳng hạn như một cụm từ tìm kiếm được đề xuất trên Google Tìm kiếm. Ví dụ: một kết quả trùng khớp có thể có URL của trang kết quả tìm kiếm trên Google, nhưng có thể xuất hiện trước người dùng dưới dạng "Tìm kiếm trên Google cho ...". Những kết quả này khác với thao tác điều hướng bằng cách nhập vì người dùng không nhập hoặc không thấy URL đích. Các lớp này cũng liên quan đến thao tác di chuyển bằng từ khoá.

"auto_toplevel"
Trang được chỉ định trong dòng lệnh hoặc là trang bắt đầu.

"form_submit"
Người dùng đã truy cập vào trang này bằng cách điền các giá trị vào một biểu mẫu rồi gửi biểu mẫu đó. Không phải tất cả các lượt gửi biểu mẫu đều sử dụng loại chuyển đổi này.

"reload"
Người dùng đã tải lại trang bằng cách nhấp vào nút tải lại hoặc nhấn phím Enter trên thanh địa chỉ. Tính năng khôi phục phiên và Mở lại thẻ đã đóng cũng sử dụng loại chuyển đổi này.

"keyword"
URL của trang này được tạo từ một từ khoá có thể thay thế không phải là nhà cung cấp dịch vụ tìm kiếm mặc định.

"keyword_generated"
Tương ứng với một lượt truy cập được tạo cho một từ khoá.

UrlDetails

Chrome 88 trở lên trình duyệt.* kể từ Chrome 148

Thuộc tính

  • url

    chuỗi

    URL cho thao tác. Giá trị này phải ở định dạng được trả về từ lệnh gọi đến history.search().

VisitItem

Một đối tượng đóng gói một lượt truy cập vào một URL.

Thuộc tính

  • id

    chuỗi

    Giá trị nhận dạng riêng biệt của history.HistoryItem tương ứng.

  • isLocal

    boolean

    Chrome 115 trở lên browser.* kể từ Chrome 148

    Đúng nếu lượt ghé thăm bắt đầu trên thiết bị này. False nếu được đồng bộ hoá từ một thiết bị khác.

  • referringVisitId

    chuỗi

    Mã lượt truy cập của người giới thiệu.

  • chuyển cảnh

    TransitionType

    Loại chuyển đổi cho lượt truy cập này từ trang giới thiệu.

  • visitId

    chuỗi

    Giá trị nhận dạng riêng biệt cho lượt ghé thăm này.

  • visitTime

    number không bắt buộc

    Thời điểm diễn ra lượt truy cập này, được biểu thị bằng mili giây kể từ thời gian bắt đầu của hệ thống.

Phương thức

addUrl()

browser.history.addUrl(
  details: UrlDetails,
): Promise<void>

Thêm một URL vào nhật ký tại thời điểm hiện tại với loại chuyển đổi là "đường liên kết".

Thông số

Giá trị trả về

  • Promise<void>

    Chrome 96 trở lên browser.* kể từ Chrome 148

deleteAll()

browser.history.deleteAll(): Promise<void>

Xoá tất cả các mục khỏi nhật ký.

Giá trị trả về

  • Promise<void>

    Chrome 96 trở lên browser.* kể từ Chrome 148

deleteRange()

browser.history.deleteRange(
  range: object,
): Promise<void>

Xoá tất cả các mục trong phạm vi ngày đã chỉ định khỏi nhật ký. Các trang sẽ không bị xoá khỏi nhật ký trừ phi tất cả các lượt truy cập đều nằm trong phạm vi.

Thông số

  • phạm vi

    đối tượng

    • endTime

      số

      Các mục được thêm vào nhật ký trước ngày này, được biểu thị bằng mili giây kể từ thời gian bắt đầu của hệ thống.

    • startTime

      số

      Các mục được thêm vào nhật ký sau ngày này, được biểu thị bằng mili giây kể từ thời gian bắt đầu của hệ thống.

Giá trị trả về

  • Promise<void>

    Chrome 96 trở lên browser.* kể từ Chrome 148

deleteUrl()

browser.history.deleteUrl(
  details: UrlDetails,
): Promise<void>

Xoá tất cả các lần xuất hiện của URL đã cho khỏi nhật ký.

Thông số

Giá trị trả về

  • Promise<void>

    Chrome 96 trở lên browser.* kể từ Chrome 148

getVisits()

browser.history.getVisits(
  details: UrlDetails,
): Promise<VisitItem[]>

Truy xuất thông tin về các lượt truy cập vào một URL.

Thông số

Giá trị trả về

  • Promise<VisitItem[]>

    Chrome 96 trở lên browser.* kể từ Chrome 148 
browser.history.search(
  query: object,
): Promise<HistoryItem[]>

Tìm kiếm trong nhật ký để biết thời gian truy cập gần đây nhất của mỗi trang khớp với cụm từ tìm kiếm.

Thông số

  • truy vấn

    đối tượng

    • endTime

      number không bắt buộc

      Giới hạn kết quả ở những kết quả được truy cập trước ngày này, được biểu thị bằng mili giây kể từ thời điểm bắt đầu thời gian Unix.

    • maxResults

      number không bắt buộc

      Số lượng kết quả tối đa cần truy xuất. Giá trị mặc định là 100.

    • startTime

      number không bắt buộc

      Giới hạn kết quả ở những kết quả được truy cập sau ngày này, được biểu thị bằng mili giây kể từ thời điểm bắt đầu hệ thống. Nếu bạn không chỉ định thuộc tính, thì thuộc tính này sẽ mặc định là 24 giờ.

    • văn bản

      chuỗi

      Một truy vấn văn bản tuỳ ý đến dịch vụ nhật ký. Hãy để trống trường này để truy xuất tất cả các trang.

Giá trị trả về

  • <HistoryItem[]> hứa hẹn

    Chrome 96 trở lên browser.* kể từ Chrome 148

Sự kiện

onVisited

browser.history.onVisited.addListener(
  callback: function,
)

Được kích hoạt khi người dùng truy cập vào một URL, cung cấp dữ liệu HistoryItem cho URL đó. Sự kiện này kích hoạt trước khi trang tải xong.

Thông số

  • callback

    hàm

    Tham số callback có dạng như sau: 

    (result: HistoryItem) => void

onVisitRemoved

browser.history.onVisitRemoved.addListener(
  callback: function,
)

Kích hoạt khi một hoặc nhiều URL bị xoá khỏi nhật ký. Khi tất cả lượt truy cập đã bị xoá, URL sẽ bị xoá khỏi nhật ký.

Thông số

  • callback

    hàm

    Tham số callback có dạng như sau: 

    (removed: object) => void

    • đã xóa

      đối tượng

      • allHistory

        boolean

        Đúng nếu tất cả nhật ký đã bị xoá. Nếu đúng, thì URL sẽ trống.

      • url

        string[] không bắt buộc