Báo cáo về kết quả đấu giá Protected Audience API

Hướng dẫn cho người bán và người mua để tạo báo cáo phiên đấu giá Protected Audience API.

Bài viết này là tài liệu tham khảo kỹ thuật để tạo báo cáo về các lượt thắng trong phiên đấu giá Protected Audience API, như được dùng trong lần lặp lại hiện tại của Protected Audience API thử nghiệm.

Hãy đọc hướng dẫn cho nhà phát triển để biết toàn bộ vòng đời của Protected Audience API, đồng thời tham khảo tài liệu giải thích về Protected Audience API để biết thông tin thảo luận chuyên sâu về báo cáo ở cấp sự kiện (tạm thời).

Bạn không phải là nhà phát triển? Tham khảo Tổng quan về Protected Audience API.

Protected Audience API báo cáo những gì?

Có 2 báo cáo Protected Audience API:

  • Báo cáo của người bán: Thông báo cho người bán về người thắng trong phiên đấu giá quảng cáo.
  • Báo cáo người mua: Chỉ dành cho người mua giành chiến thắng, để biết rằng họ đã thắng một phiên đấu giá.

Kế hoạch dài hạn là cho phép trình duyệt báo cáo kết quả phiên đấu giá cho người bán và người mua bằng API Private Aggregation. Là một cơ chế báo cáo tạm thời ở cấp sự kiện, mã triển khai reportResult() cho người bán và reportWin() cho người đặt giá thầu giành chiến thắng có thể gọi hàm sendReportTo(). Phương thức này sử dụng một đối số duy nhất: một chuỗi đại diện cho một URL được tìm nạp sau khi phiên đấu giá hoàn tất, mã hoá thông tin cấp sự kiện sẽ được báo cáo.

Các hàm API

Người bán: reportResult()

JavaScript của người bán được cung cấp trong decisionLogicUrl (cũng cung cấp scoreAd()) có thể bao gồm một hàm reportResult() để báo cáo kết quả của phiên đấu giá.

reportResult(auctionConfig, browserSignals) {
  ...
  return signalsForWinner;
}

Các đối số được truyền đến hàm này là:

auctionConfig

Đối tượng cấu hình phiên đấu giá được truyền đến navigator.runAdAuction().

browserSignals

Một đối tượng do trình duyệt tạo ra, cung cấp thông tin về phiên đấu giá. Ví dụ:

  {
    'topWindowHostname': 'publisher.example',
    'interestGroupOwner': 'https://dsp.example',
    'renderUrl': 'https://cdn.example/url-of-winning-creative.wbn',
    'bid': <bidValue>,
    'desirability': <winningAdScore>
  }

Giá trị trả về của hàm này được dùng làm đối số sellerSignals cho hàm reportWin() của người đặt giá thầu chiến thắng.

Người mua: reportWin()

JavaScript của bên đặt giá thầu chiến thắng (cũng cung cấp generateBid()) có thể bao gồm một hàm reportWin() để báo cáo kết quả phiên đấu giá.

reportWin(auctionSignals, perBuyerSignals, sellerSignals, browserSignals) {
  ...
}

Các đối số được truyền đến hàm này là:

auctionSignals và perBuyerSignals

Các giá trị giống nhau được truyền đến generateBid() cho giá thầu chiến thắng.

sellerSignals

Giá trị trả về của reportResult(), giúp người bán có cơ hội truyền thông tin cho người mua.

browserSignals

Một đối tượng do trình duyệt tạo ra, cung cấp thông tin về phiên đấu giá. Ví dụ:

{
  'topWindowHostname': 'publisher.example',
  'seller': 'https://ssp.example',
  'interestGroupOwner': 'https://dsp.example',
  'interestGroupName': 'custom-bikes',
  'renderUrl': 'https://cdn.example/winning-creative.wbn',
  'bid': <bidValue>
}

Triển khai báo cáo tạm thời

Chrome tạm thời cung cấp 2 phương thức báo cáo phiên đấu giá:

  • forDebuggingOnly.reportAdAuctionLoss()
  • forDebuggingOnly.reportAdAuctionWin()

Mỗi phương thức này đều có một đối số duy nhất: một URL để tìm nạp sau khi phiên đấu giá hoàn tất. Bạn có thể gọi các phương thức này nhiều lần, trong cả scoreAd() và generateBid(), với các đối số URL khác nhau.

Chrome chỉ gửi báo cáo gỡ lỗi về lượt thua/thắng khi một phiên đấu giá kết thúc. Nếu một phiên đấu giá bị huỷ (ví dụ: do một thao tác điều hướng mới), thì sẽ không có báo cáo nào được tạo.

Theo mặc định, các phương thức này có sẵn trong Chrome khi bạn bật tất cả Ad Privacy API trong chrome://settings/adPrivacy. Nếu đang chạy Chrome bằng các cờ dòng lệnh để bật Protected Audience API, bạn sẽ cần bật các phương thức một cách rõ ràng bằng cách thêm cờ BiddingAndScoringDebugReportingAPI. Nếu cờ này không được bật, các phương thức vẫn sẽ có sẵn nhưng không làm gì cả.

Tất cả tài liệu tham khảo về Protected Audience API

Hướng dẫn tham khảo API có sẵn:

Thông tin giải thích về Protected Audience API cũng cung cấp thông tin chi tiết về các quy tắc hỗ trợ và các quy tắc ràng buộc của tính năng.

Tiếp theo là gì?

Chúng tôi muốn thảo luận với bạn để đảm bảo việc xây dựng một API phù hợp với tất cả mọi người.

Thảo luận về API

Giống như các API Hộp cát về quyền riêng tư khác, API này được ghi lại và thảo luận công khai.

Thử nghiệm với API

Bạn có thể thử nghiệm và tham gia cuộc trò chuyện về Protected Audience API.