Fence: reportEvent() method

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

Phương thức reportEvent() của giao diện Fence kích hoạt việc gửi dữ liệu báo cáo thông qua beacon đến một hoặc nhiều URL cụ thể được đăng ký thông qua phương thức registerAdBeacon() của Protected Audience API, nhằm mục đích thu thập kết quả đấu giá quảng cáo.

Note: setReportEventDataForAutomaticBeacons() cung cấp việc gửi dữ liệu báo cáo tương tự, ngoại trừ trong trường hợp đó việc gửi được kích hoạt qua điều hướng thay vì bằng lệnh gọi phương thức rõ ràng.

Cú pháp

js
reportEvent(event)

Tham số

event

Đối tượng hoặc chuỗi đại diện cho dữ liệu cần gửi.

  • Giá trị đối tượng xác định một sự kiện báo cáo cụ thể mà bạn muốn gửi. Các thuộc tính bắt buộc như sau:
    eventType

    Chuỗi đại diện cho loại sự kiện đang được báo cáo, ví dụ bạn có thể quan tâm đến số lần nhấp vào quảng cáo. Chuỗi này có thể là bất kỳ tên sự kiện liên quan nào (ví dụ: click). Chuỗi này cần khớp với loại sự kiện được chỉ định trong lệnh gọi registerAdBeacon() liên quan trong worklet Protected Audience API.

    eventData

    Chuỗi đại diện cho dữ liệu cần gửi.

    destination

    Mảng chứa một hoặc nhiều giá trị liệt kê đại diện cho các loại đích. Đây là các bên liên quan sẽ nhận dữ liệu đến URL đã đăng ký của họ (thông qua registerAdBeacon()). Các giá trị có thể là:

    • "buyer": Người đặt giá trong cuộc đấu giá quảng cáo.
    • "seller": Người bán cấp cao nhất điều hành cuộc đấu giá quảng cáo.
    • "component-seller": Người bán cho cuộc đấu giá thành phần trong cuộc đấu giá nhiều cấp.
    • "direct-seller": Người bán đã trực tiếp điều hành cuộc đấu giá mà người mua đã đặt giá. Nếu quảng cáo là cuộc đấu giá một cấp, giá trị được sử dụng sẽ là "seller". Nếu là cuộc đấu giá nhiều cấp, giá trị được sử dụng sẽ là "component-seller".
    • "shared-storage-select-url": Vị trí lưu trữ Shared Storage API, được xác định trong lệnh gọi phương thức Window.sharedStorage.selectURL().
  • Giá trị chuỗi đại diện cho eventType, ví dụ "click" (xem định nghĩa trước đó về eventType). Khi một chuỗi eventType được truyền làm giá trị của reportEvent(), nó kích hoạt tất cả các đóng góp Private Aggregation được thực hiện có điều kiện trên loại sự kiện đó (ví dụ: thông qua PrivateAggregation.contributeToHistogramOnEvent()) để được gửi.

Giá trị trả về

Không có (Undefined).

Ví dụ

js
window.fence.reportEvent({
  eventType: "click",
  eventData: JSON.stringify({ clickX: "123", clickY: "456" }),
  destination: ["buyer", "seller"],
});

Thông số kỹ thuật

Specification
Fenced Frame
# dom-fence-reportevent

Tương thích trình duyệt

Xem thêm