Báo cáo phiên đấu giá Protected Audience API

Đo lường kết quả và dữ liệu phiên đấu giá Protected Audience API

Trong bài viết này, bạn sẽ tìm thấy thông tin tổng quan về nhiều cơ chế hiện có để báo cáo dữ liệu phiên đấu giá Protected Audience API cho máy chủ của bạn, cùng với các cơ chế chuyển đổi hiện có để bạn sử dụng trong quá trình di chuyển cho đến khi có các giải pháp thay thế.

Để báo cáo về các chỉ số quan trọng mà bạn thu thập được từ một phiên đấu giá quảng cáo, Protected Audience API hoạt động với:

  • Tính năng Tổng hợp riêng tư giúp thu thập các tín hiệu của phiên đấu giá và kết quả để tạo báo cáo tóm tắt.
  • Ads Reporting API dành cho Khung bảo vệiframe (là một kênh trong khung) để giao tiếp với các công việc của Protected Audience API. API này cho phép liên kết dữ liệu ở cấp sự kiện với các tín hiệu phiên đấu giá. Báo cáo cấp sự kiện của Ads Reporting API là một cơ chế chuyển đổi cho đến khi một cơ chế báo cáo riêng tư hơn được thiết kế.
  • Báo cáo phân bổ cho phép bạn liên kết dữ liệu chuyển đổi với các tín hiệu đấu giá.
  • Bộ nhớ dùng chung cho phép bạn ghi các tín hiệu phiên đấu giá vào một bộ nhớ nhiều nguồn gốc, sau đó dùng tính năng Tổng hợp riêng tư để báo cáo dữ liệu đó.

Tổng quan về báo cáo Protected Audience API

Quy trình làm việc tổng thể của Protected Audience
Quy trình làm việc tổng thể của Protected Audience

Có 3 khoảng thời gian chính mà dữ liệu từ quy trình đấu giá Protected Audience API có thể được báo cáo cho máy chủ của bạn: thời gian đấu giá khi phiên đấu giá được thực thi trên trang web của nhà xuất bản, thời gian hiển thị khi quảng cáo hiển thị vào khung bảo vệ hoặc iframe trên trang web của nhà xuất bản và thời gian chuyển đổi khi người dùng thực hiện một hành động nào đó trên một trang web khác có thể được phân bổ cho phiên đấu giá.

Trong thời gian đấu giá, bạn có thể báo cáo dữ liệu phiên đấu giá bằng cách sử dụng các worklet báo cáo. Trong thời gian hiển thị, bạn có thể báo cáo dữ liệu tương tác từ iframe hoặc khung được bảo vệ. Trong thời gian chuyển đổi, bạn có thể báo cáo dữ liệu phân bổ từ trang đích bằng cách sử dụng Attribution Reporting API.

Báo cáo vị trí

Trong phiên đấu giá, người mua có thể báo cáo các tín hiệu có trong các chương trình công việc generateBid()reportWin(), đồng thời người bán có thể báo cáo các tín hiệu có trong scoreAd()reportResult(). Ngoài phiên đấu giá, người mua và người bán có thể báo cáo dữ liệu từ khung hiển thị quảng cáo và từ trang web mà lượt chuyển đổi được thực hiện.

Khoảng thời gian Đích đến Vị trí Có sẵn dữ liệu Có các API báo cáo
Phiên đấu giá Bên mua generateBid() Tín hiệu, kết quả phiên đấu giá và hiệu suất của phiên đấu giá Private Aggregation API
reportWin() API tổng hợp riêng tư
API báo cáo quảng cáo
Người bán scoreAd() Private Aggregation API
reportResult() API tổng hợp riêng tư
API báo cáo quảng cáo
Kết xuất Người mua / Người bán Khung trên trang web của nhà xuất bản Dữ liệu cấp sự kiện trong khung quảng cáo API tổng hợp riêng tư
API báo cáo quảng cáo
Chuyển đổi Người mua / Người bán Trang web chuyển đổi Dữ liệu cấp lượt chuyển đổi và cấp sự kiện từ trang web chuyển đổi Attribution Reporting API
API Tổng hợp riêng tư
API Báo cáo quảng cáo

Trong mỗi khoảng thời gian được nêu, người mua và người bán sẽ có quyền truy cập vào nhiều API báo cáo có sẵn để báo cáo dữ liệu, chẳng hạn như tín hiệu phiên đấu giá, dữ liệu ở cấp sự kiện và dữ liệu lượt chuyển đổi.

Dữ liệu có sẵn trong phiên đấu giá Protected Audience API

Dữ liệu sau đây có sẵn để báo cáo từ một worklet Protected Audience API trong phiên đấu giá.

Tín hiệu

Tín hiệu là dữ liệu bối cảnh của phiên đấu giá, dữ liệu người dùng, dữ liệu theo thời gian thực và dữ liệu trình duyệt mà người mua và người bán có thể sử dụng trong một tệp worklet để tạo giá thầu, tính điểm quảng cáo và báo cáo kết quả của phiên đấu giá.

Tín hiệu Nội dung mô tả Đặt vị trí Số người dùng Phạm vi cung cấp
auctionSignals Dữ liệu có sẵn trong bối cảnh nơi phiên đấu giá được tổ chức. Dữ liệu này có thể bao gồm thông tin về nội dung trang, dữ liệu người dùng của bên thứ nhất và nhiều dữ liệu khác. Do người bán đặt trên trang web của nhà xuất bản trong cấu hình phiên đấu giá. Người mua
Người bán
generateBid scoreAd reportWin reportResult
directFromSellerSignals Dữ liệu tương tự cho auctionSignals, perBuyerSignals, sellerSignals nhưng các tín hiệu được đảm bảo đến từ người bán đã chỉ định. Đặt qua tiêu đề phản hồi HTTP từ người bán Người mua
Người bán
generateBid scoreAd reportWin reportResult
browserSignals Nhiều dữ liệu do trình duyệt cung cấp (topWindowHostname, interestGroupOwner, renderUrl, adComponents, biddingDurationMsec, IGJoinCount, IGRecency, modelingSignals). Do trình duyệt thiết lập. Người mua
Người bán
generateBid scoreAd reportWin reportResult
sellerSignals Các tín hiệu được cung cấp cho người bán để tính điểm quảng cáo. Do người bán đặt trên trang web của nhà xuất bản trong cấu hình phiên đấu giá. Người bán scoreAd
reportWin
reportResult
trustedScoringSignals Các tín hiệu theo thời gian thực được cung cấp cho người bán để tính điểm quảng cáo. URL do người bán đặt từ trang web của nhà xuất bản trong cấu hình phiên đấu giá. Người bán scoreAd reportResult
perBuyerSignals Dữ liệu bối cảnh về phiên đấu giá được cung cấp cho người mua cụ thể. Người bán có thể truy xuất các giá trị cho người mua trước khi phiên đấu giá bắt đầu. Đây là kiến thức của người mua về cơ hội quảng cáo. Do người bán đặt trên trang web của nhà xuất bản trong cấu hình phiên đấu giá. Bên mua generateBid scoreAd reportWin reportResult
trustedBiddingSignals Tín hiệu theo thời gian thực được cung cấp cho người mua để đặt giá thầu quảng cáo. URL do người mua đặt từ trang web của nhà quảng cáo khi nhóm mối quan tâm được thiết lập. Bên mua generateBid
userBiddingSignals Dữ liệu người dùng do người mua cung cấp. Do người mua thiết lập từ trang web của nhà quảng cáo khi nhóm mối quan tâm được thiết lập . Bên mua generateBid

Đối tượng cấu hình đấu giá là nguồn dữ liệu chính được cung cấp để có sẵn dưới dạng tín hiệu trong worklet. Nhà xuất bản và người bán có thể cung cấp dữ liệu bối cảnh và dữ liệu của bên thứ nhất trong cấu hình phiên đấu giá. Các tín hiệu này có thể được bổ sung chi tiết bằng dữ liệu nhóm mối quan tâm từ người mua, dữ liệu cấp sự kiện từ khung hiển thị quảng cáo và dữ liệu phân bổ trên trang nhấp chuột. Bạn có thể sử dụng dữ liệu đã báo cáo để báo cáo người mua/người bán, thanh toán, lập ngân sách, huấn luyện mô hình học máy, v.v.

Dữ liệu có sẵn khác

  • Dữ liệu kết quả liên quan đến dữ liệu thắng và thua trong phiên đấu giá, chẳng hạn như giá của giá thầu giành chiến thắng và lý do từ chối giá thầu.
  • Dữ liệu hiệu suất chứa thông tin về độ trễ, chẳng hạn như thời gian tìm nạp và thực thi worklet đặt giá thầu.

Dữ liệu có sẵn bên ngoài phiên đấu giá Protected Audience API

Ngoài phiên đấu giá Protected Audience API, có hai khoảng thời gian dữ liệu được báo cáo.

Trong thời gian hiển thị, khi quảng cáo hiển thị trên trang web của nhà xuất bản, dữ liệu cấp sự kiện từ bên trong iframe hoặc khung bảo vệ có thể được liên kết với dữ liệu phiên đấu giá Protected Audience API và được báo cáo cho máy chủ của bạn. Ví dụ về dữ liệu ở cấp sự kiện bao gồm lượt hiển thị quảng cáo, lượt nhấp, thao tác di chuột và bất kỳ sự kiện nào khác xảy ra bên trong khung.

Trong thời gian chuyển đổi, khi người dùng thực hiện một hành động nào đó trên trang nhấp chuột được phân bổ trở lại cho phiên đấu giá, dữ liệu cấp sự kiện từ trang chuyển đổi có thể được liên kết với dữ liệu phiên đấu giá Protected Audience API và được báo cáo cho máy chủ của bạn.

Báo cáo cấp sự kiện

Báo cáo cấp sự kiện nêu chi tiết thông tin của một hoặc nhiều sự kiện. Sự kiện có thể là lượt thắng trong phiên đấu giá, lượt hiển thị quảng cáo hoặc lượt chuyển đổi. Cho đến ít nhất là năm 2026, tính năng báo cáo giành chiến thắng trong phiên đấu giá ở cấp sự kiện vẫn sẽ giữ nguyên. Bạn không cần phải có khung bảo vệ để hiển thị quảng cáo Protected Audience và iframe có quyền truy cập mạng không bị giới hạn có thể dùng cho báo cáo ở cấp sự kiện. Ngoài ra, Ads Reporting API hoạt động trong các khung và iframe được bảo vệ để bạn liên kết dữ liệu phiên đấu giá và dữ liệu chuyển đổi với dữ liệu ở cấp sự kiện trong khung đó. Điều này được thiết kế để giúp hệ sinh thái di chuyển dễ dàng hơn, vì bạn có thể tiếp tục sử dụng cơ sở hạ tầng báo cáo hiện có cho đến ít nhất là năm 2026 trong khi di chuyển hệ thống sang Protected Audience.

Báo cáo giành chiến thắng trong phiên đấu giá ở cấp sự kiện với sendReportTo()

Cơ chế có thể sử dụng để báo cáo dữ liệu ở cấp sự kiện trong phiên đấu giá sử dụng Protected Audience API là sendReportTo() function đối với chiến thắng trong phiên đấu giá. Hàm này có trong các tệp công việc báo cáo của người mua và người bán, đồng thời trình duyệt sẽ gửi yêu cầu GET đến chuỗi URL đã cung cấp khi quá trình hiển thị quảng cáo bắt đầu. Bạn có thể mã hoá bất kỳ tín hiệu nào có sẵn trong các worklet của mình dưới dạng tham số truy vấn của URL.

Ví dụ: người mua có thể báo cáo số tiền giá thầu giành chiến thắng từ worklet reportWin() cho mục đích thanh toán:

// Buyer reporting worklet
function reportWin(auctionSignals, perBuyerSignals, sellerSignals, browserSignals, directFromSellerSignals) {
  sendReportTo(`https://buyer-reporting-server.example/reporting?bid=${browserSignals.bid}`);
}

Bạn có thể dùng hàm sendReportTo() để tạo báo cáo chiến thắng cho người bán khi được gọi từ reportResult() và báo cáo chiến thắng cho người mua khi được gọi từ reportWin(). Hàm sendReportTo() được cung cấp cho đến ít nhất là năm 2026,

Báo cáo Mức độ tương tác

Báo cáo mức độ tương tác chứa dữ liệu cấp sự kiện của một mẫu quảng cáo, chẳng hạn như dữ liệu về lượt hiển thị hoặc lượt nhấp liên kết với các tín hiệu của phiên đấu giá Protected Audience API đã hiển thị quảng cáo. Vì quảng cáo xuất hiện sau khi phiên đấu giá kết thúc, nên tín hiệu đấu giá sẽ không có trong khung hiển thị quảng cáo đó. Để liên kết những dữ liệu này trong các khoảng thời gian khác nhau, chúng tôi cung cấp cho bạn 2 cơ chế chuyển đổi để tạo báo cáo về mức độ tương tác.

Hàm sendReportTo() được mô tả ở trên có thể dùng để liên kết dữ liệu phiên đấu giá với dữ liệu cấp sự kiện từ iframe. Tuy nhiên, hàm này không hoạt động đối với khung bảo vệ vì không thể truyền mã nhận dạng duy nhất từ trình nhúng vì khả năng giao tiếp giữa trình nhúng và khung được bảo vệ bị giới hạn. Để liên kết dữ liệu phiên đấu giá với dữ liệu cấp sự kiện của quảng cáo có khung bảo vệ, bạn có thể sử dụng Ads Reporting API.

Ads Reporting API cho khung và iframe được bảo vệ

Ads Reporting API đối với các khung và iframe được bảo vệ cung cấp cơ chế để bạn liên kết dữ liệu ở cấp sự kiện của người dùng từ một khung quảng cáo với các tín hiệu trong phiên đấu giá sử dụng Protected Audience API.

Trong một worklet báo cáo Protected Audience API, bạn có thể đăng ký beacon quảng cáo bằng hàm registerAdBeacon() và truyền URL báo cáo với các tín hiệu được thêm vào dưới dạng tham số truy vấn. Bạn cũng phải chỉ định sự kiện tuỳ chỉnh mà bạn muốn liên kết với URL báo cáo. Sau đó, khi quảng cáo hiển thị trong một khung bảo vệ, bạn có thể kích hoạt sự kiện tuỳ chỉnh đó bằng cách gọi hàm window.fence.reportEvent(). Bạn có thể thêm dữ liệu có sẵn trong khung bảo vệ dưới dạng tải trọng.

Hàm registerAdBeacon() chỉ có trong các hàm báo cáo và không có trong logic đặt giá thầu của người mua cũng như logic tính điểm của người bán.

Trong ví dụ sau, mã chiến dịch được liên kết với một tải trọng cấp sự kiện có toạ độ lượt nhấp:

// Protected Audience API buyer win reporting worklet
function reportWin(auctionSignals) {
  const { campaignId } = auctionSignals

  registerAdBeacon({
    click: `https://buyer-server.example/report/click?campaignId=${campaignId}`
  })
}
// Protected Audience API seller reporting worklet
function reportResult(auctionConfig) {
  const { campaignId } = auctionConfig.auctionSignals;

  registerAdBeacon({
    click: `https://seller-server.example/report/click?campaignId=${campaignId}`
  })
}
// Ad frame
window.fence.reportEvent({
  eventType: 'click',
  eventData: JSON.stringify({'clickX': '123', 'clickY': '456'}),
  destination:['buyer', 'seller']
});

API Báo cáo quảng cáo khung bảo vệ cũng sẽ được cung cấp cho đến ít nhất là năm 2026 vì những lý do tương tự như báo cáo giành chiến thắng.

Để tìm hiểu kỹ hơn, hãy xem phần giải thích.

Quyền truy cập mạng không bị giới hạn

Khung bảo vệ sẽ cho phép tải tài nguyên mạng giống như iframe và bạn có thể gửi dữ liệu cấp sự kiện trong các khung được bảo vệ tới máy chủ của mình. Sau này, bạn có thể tạo báo cáo cấp sự kiện ở phía máy chủ bằng cách liên kết dữ liệu cấp sự kiện từ một khung bảo vệ với dữ liệu phiên đấu giá đã gửi bằng sendReportTo() (đã được thảo luận trong mục cơ chế báo cáo ở cấp sự kiện đấu giá) ở trên.

Quyền truy cập mạng sẽ bị hạn chế trong tương lai.

Báo cáo phân bổ

Báo cáo phân bổ cho phép bạn liên kết một lượt chuyển đổi trên một trang web với một quảng cáo đã chọn từ phiên đấu giá Protected Audience API. Ví dụ: người dùng có thể nhấp vào quảng cáo sản phẩm mà bạn phân phát, được chuyển hướng đến trang web của nhà quảng cáo, mua hàng ở đó và bạn quan tâm đến việc phân bổ giao dịch mua cho quảng cáo đã hiển thị. Attribution Reporting API sẽ được tích hợp với Protected Audience API để kết hợp dữ liệu phiên đấu giá từ trang web của nhà xuất bản và dữ liệu chuyển đổi từ trang web của nhà quảng cáo.

Mặc dù chúng tôi thiết kế một giải pháp lâu dài hơn, nhưng bạn có thể sử dụng API Báo cáo quảng cáo cho các khung bảo vệ làm cơ chế chuyển đổi để tạo báo cáo cấp sự kiện và báo cáo tổng hợp bằng Báo cáo phân bổ. Xin lưu ý rằng các báo cáo này dùng để đo lường lượt chuyển đổi, đồng thời tách biệt với các báo cáo tương tác cấp sự kiện và báo cáo tương tác tổng hợp được tạo từ phiên đấu giá và khung quảng cáo. Khi sẵn sàng, chúng tôi sẽ đăng nội dung giải thích để cung cấp một giải pháp lâu dài hơn.

Cơ chế chuyển tiếp

Khi đăng ký beacon quảng cáo, bạn có thể sử dụng từ khoá reserved.top_navigation. Từ khoá này sẽ tự động thêm tiêu đề Attribution-Reporting-Eligible để beacon đủ điều kiện đăng ký làm nguồn phân bổ.

registerAdBeacon({
 'reserved.top_navigation': 'https://adtech.example/click?buyer_event_id=123',
});

Để đính kèm dữ liệu ở cấp sự kiện vào beacon mà bạn đã đăng ký, bạn có thể gọi setReportEventDataForAutomaticBeacons() từ khung bảo vệ với tải trọng sự kiện.

window.fence.setReportEventDataForAutomaticBeacons({
  eventType: 'reserved.top_navigation',
  eventData: 'data from the frame',
  destination:['seller', 'buyer']
})

Hãy xem phần Báo cáo phân bổ trong tài liệu giải thích về API Báo cáo quảng cáo để tìm hiểu thêm.

Ví dụ về báo cáo lượt tương tác và lượt chuyển đổi

Trong ví dụ này, chúng ta sẽ xem xét điều này từ góc độ người mua muốn liên kết dữ liệu từ phiên đấu giá, khung quảng cáo và trang web chuyển đổi với nhau.

Trong quy trình công việc này, người mua phối hợp với người bán để gửi một mã nhận dạng duy nhất vào phiên đấu giá. Trong phiên đấu giá, người mua gửi mã nhận dạng duy nhất này cùng với dữ liệu phiên đấu giá. Trong thời gian kết xuất và chuyển đổi, dữ liệu từ khung bảo vệ hoặc iframe cũng được gửi đi với cùng một mã nhận dạng duy nhất. Sau đó, mã nhận dạng duy nhất có thể được dùng để liên kết các báo cáo này với nhau.

Luồng công việc:

  1. Trước khi phiên đấu giá bắt đầu, người mua gửi một mã nhận dạng duy nhất cho người bán trong quá trình phản hồi giá thầu đặt giá thầu theo thời gian thực ("RTB") có lập trình. Mã nhận dạng có thể được đặt ở dạng một biến như auctionId. Mã nhận dạng được truyền vào dưới dạng perBuyerSignals trong auctionConfig và có trong worklet của người mua.
  2. Trong thời gian đấu giá, người mua có thể đăng ký một beacon quảng cáo để được kích hoạt trong thời gian hiển thị quảng cáo và thời gian chuyển đổi (registerAdBeacon()).
    1. Để liên kết các tín hiệu đấu giá cho một sự kiện khung quảng cáo, hãy đặt auctionId làm tham số truy vấn của URL beacon.
    2. Để liên kết các tín hiệu đấu giá cho một sự kiện chuyển đổi, hãy đặt auctionId trong URL beacon.
  3. Trong thời gian hiển thị quảng cáo, beacon mà bạn đã đăng ký trong thời gian đấu giá có thể được kích hoạt hoặc nâng cao bằng dữ liệu cấp sự kiện.
    1. Kích hoạt sự kiện khung bằng reportEvent() và truyền dữ liệu cấp sự kiện.
    2. Thêm tải trọng cấp sự kiện vào beacon phân bổ bằng setReportEventDataForAutomaticBeacons()
    3. Đăng ký quảng cáo với Attribution Reporting API bằng cách phản hồi các yêu cầu beacon quảng cáo có tiêu đề Attribution-Reporting-Register-Source.
  4. Trong thời gian chuyển đổi, bạn có thể kích hoạt nguồn mà bạn đã đăng ký trong thời gian đấu giá.

Sau quá trình trên, người mua sẽ có báo cáo phiên đấu giá, báo cáo mức độ tương tác và báo cáo lượt chuyển đổi. Tất cả được liên kết với nhau bằng một khoá duy nhất có thể dùng để liên kết với nhau.

Quy trình công việc tương tự sẽ áp dụng cho người bán nếu cần quyền truy cập vào dữ liệu phân bổ và người bán cũng có thể sử dụng một mã nhận dạng duy nhất để gửi bằng registerAdBeacon(). Từ khung, lệnh gọi reportEvent() chứa một thuộc tính đích có thể dùng để gửi báo cáo cho cả người mua và người bán. Xin lưu ý rằng SSP cũng phải xuất hiện trên trang đích để phân bổ điều kiện kích hoạt cho nguồn.

Tổng hợp dữ liệu Protected Audience

API tổng hợp riêng tư là cơ chế dùng để báo cáo dữ liệu Protected Audience nhằm tạo báo cáo tóm tắt. Báo cáo này là một báo cáo tổng hợp và ồn ào về dữ liệu được thu thập trong các bộ chứa. Bộ chứa được biểu thị bằng một khoá tổng hợp và một số thông tin có thể được mã hoá thành khoá.

Ví dụ: một sự kiện hiển thị quảng cáo có thể được tính vào nhiều nhóm, trong đó mỗi nhóm đại diện cho một chiến dịch quảng cáo khác nhau. Báo cáo tóm tắt khác với báo cáo cấp sự kiện ở chỗ báo cáo này không tiết lộ thông tin về từng sự kiện riêng lẻ. Với báo cáo cấp sự kiện, bạn có thể xác định rằng người dùng A, B và C đã xem chiến dịch 123. Với báo cáo tóm tắt, bạn có thể đo lường số lượng người dùng đã xem chiến dịch 123 và thêm dữ liệu nhiễu để bảo vệ quyền riêng tư của người dùng.

Hãy xem bài viết về Tổng hợp riêng tư để tìm hiểu thêm về API.

Tổng hợp các tín hiệu phiên đấu giá

Bạn có thể tổng hợp các tín hiệu có trong các worklet gửi tới máy chủ của mình bằng tính năng Tổng hợp riêng tư. Để tổng hợp tín hiệu, bạn có thể sử dụng phương thức privateAggregation.contributeToHistogram() có trong worklet đặt giá thầu của người mua, worklet tính điểm của người bán và worklet báo cáo người mua/người bán.

Trong ví dụ này, giá thầu giành chiến thắng được tổng hợp vào nhóm chủ sở hữu nhóm mối quan tâm:

function convertBuyerToBucket(igOwner) {}
function convertWinningBidToValue(winningBid) {}

function reportResult(auctionConfig, browserSignals) {
  privateAggregation.contributeToHistogram({
    bucket: convertBuyerToBucket(browserSignals.interestGroupOwner),
    value: convertWinningBidToValue(browserSignals.bid)
  });
} 

Đây là cơ chế chung được sử dụng khi các tín hiệu mà bạn muốn tổng hợp không được liên kết với dữ liệu ở cấp sự kiện và không được kích hoạt bởi một sự kiện bên ngoài phiên đấu giá. Để tìm hiểu thêm về cách báo cáo tín hiệu đấu giá, hãy xem nội dung giải thích.

Tổng hợp các tín hiệu phiên đấu giá với dữ liệu sự kiện

Bạn có thể tổng hợp các tín hiệu đấu giá với thông tin hạn chế về một sự kiện xảy ra trong khung quảng cáo. Ví dụ: bạn có thể đo lường tổng hợp số lượt nhấp mà một quảng cáo cho một chiến dịch nhận được bằng cách tạo một bộ chứa đại diện cho chiến dịch đó và sự kiện nhấp chuột. Xin lưu ý rằng từ khung quảng cáo, bạn có thể chỉ định sự kiện nào đã xảy ra, nhưng không thể đính kèm tải trọng cấp sự kiện.

Để tổng hợp các tín hiệu phiên đấu giá theo sự kiện, bạn có thể sử dụng privateAggregation.contributeToHistogramOnEvent(eventType, contribution) để lấy một chuỗi chỉ định loại sự kiện và mức đóng góp cần báo cáo khi sự kiện đó được kích hoạt. Bạn có thể gọi phương thức bằng một loại sự kiện tuỳ chỉnh, sau đó gọi window.fence.reportEvent(eventType) từ khung quảng cáo để kích hoạt báo cáo cần được gửi.

Giả sử bạn muốn đo lường số lượt nhấp mà một quảng cáo cho một chiến dịch đã nhận được.

// Protected Audience API worklet
function getClickReportBucketForCampaign(campaignId) {
  // return a bucket for the campaign ID and the click event
}

function generateBid(interestGroup) {
  privateAggregation.contributeToHistogramOnEvent('click', {
    bucket: getClickReportBucketForCampaign(interestGroup.ads.metadata.campaignId), 
    value: 1
  });
}

Trong hàm tạo giá thầu, bạn có thể xác định một nhóm là sự kết hợp giữa mã chiến dịch và sự kiện nhấp chuột, sau đó tăng giá trị cho nhóm đó thêm 1 mỗi khi sự kiện được kích hoạt.

// Ad frame
window.fence.reportEvent('click');

Sau đó, từ khung quảng cáo, bạn có thể kích hoạt tính năng gửi báo cáo bằng cách gọi reportEvent(eventType):

Tìm hiểu thêm về cách kích hoạt nội dung đóng góp của tính năng Tổng hợp riêng tư từ một khung hình trong phần giải thích.

Báo cáo hiệu suất và kết quả phiên đấu giá

Bạn cũng có thể tổng hợp kết quả phiên đấu giá khi được một sự kiện thắng hoặc thua trong phiên đấu giá kích hoạt bằng contributeToHistogramOnEvent(eventType, contribution) khi chuyển vào một từ khoá loại sự kiện đặt trước (reserved.win, reserved.lossreserved.always).

Tính năng Tổng hợp riêng tư cung cấp danh sách giá trị cơ sở để bạn tính toán bộ chứa và giá trị của nội dung mà mình đóng góp. Giá trị cơ sở có thể sử dụng cho kết quả phiên đấu giá là giá trị giá thầu của quảng cáo giành chiến thắng, giá trị giá thầu được tính là cao thứ hai và lý do khiến giá thầu bị từ chối khỏi phiên đấu giá.

Khi cung cấp một số giá trị cơ sở (như số tiền giá thầu giành chiến thắng), bạn có thể đặt mức cộng hoặc trừ khỏi giá trị đó, sau đó báo cáo giá trị cuối cùng. Ví dụ: nếu giá thầu giành chiến thắng là 5 đô la được cung cấp làm giá trị cơ sở, thì bạn có thể trừ đi giá thầu 2 đô la để tính giá trị thực tế là 3 đô la so với số tiền bạn đã thua trong phiên đấu giá.

Báo cáo kết quả phiên đấu giá

Hãy xem xét ví dụ mà bạn đã thua trong một phiên đấu giá và bạn muốn biết khoảng cách giữa giá thầu của bạn và giá bù trừ trong phiên đấu giá.

Để biết bạn đã thua trong phiên đấu giá bao nhiêu, bạn có thể lấy giá thầu giành chiến thắng trừ đi giá thầu:

function generateBid() {
  const bid = calculateBidAmount();

  privateAggregation.contributeToHistogramOnEvent('reserved.loss', {
    bucket: getBucketForCampaign(interestGroup.ads.metadata.campaignId),
    value: {
      baseValue: 'winning-bid',
      scale: 1 // Scale the value to minimize noise-to-signal ratio 
      offset: -bid, // Numbers added to browser value after scaling 
    }
  });
}

Khi báo cáo được gửi, giá trị thực tế được báo cáo sẽ là baseValue được điều chỉnh theo tỷ lệ thay đổi theo giá trị offset. Để tìm hiểu thêm, hãy xem công cụ giải thích.

Báo cáo hiệu suất

Người mua và người bán có thể báo cáo khoảng thời gian cần để thực thi một tập lệnh cũng như khoảng thời gian cần để tìm nạp các tín hiệu đáng tin cậy. Người bán có thể thu thập thời gian tạo giá thầu và thời gian tín hiệu đặt giá thầu đáng tin cậy của từng người mua nếu được họ cho phép.

Hãy xem nội dung giải thích để tìm hiểu thêm.

Lưu trữ tín hiệu đấu giá trong Bộ nhớ dùng chung

Bộ nhớ dùng chung là bộ nhớ không được phân vùng và nhiều nguồn gốc mà bạn có thể thoải mái ghi vào. Tuy nhiên, bộ nhớ này được bảo vệ bằng các cổng khi đọc và xử lý các giá trị được lưu trữ. Một trong những cổng có thể sử dụng cho API Bộ nhớ dùng chung là tính năng Tổng hợp riêng tư. Bạn chỉ có thể đọc các giá trị trong bộ nhớ dùng chung từ bên trong một worklet và có thể báo cáo các giá trị đó bằng tính năng Tổng hợp riêng tư từ worklet.

Bạn cũng có thể ghi vào bộ nhớ dùng chung từ các công việc báo cáo, tính điểm và đặt giá thầu Protected Audience API. Sau này, bạn có thể báo cáo các giá trị đó trong bộ nhớ dùng chung cho máy chủ của mình bằng tính năng Tổng hợp riêng tư . Bạn cũng có thể sử dụng các giá trị đã lưu trữ cho thao tác Lựa chọn URL.

Từ một worklet Protected Audience API, bạn có thể ghi bất kỳ khoá và giá trị nào vào bộ nhớ dùng chung:

// Protected Audience API worklet
function generateBid() {
  sharedStorage.set('test-bucket', 123);
}

Sau này, bạn có thể tải một worklet bộ nhớ dùng chung để đọc và gửi giá trị đó bằng tính năng Tổng hợp riêng tư:

// Shared Storage worklet
class SendReachReport{
  async run() {
    const testBucket = await this.sharedStorage.get('test-bucket');

    privateAggregation.contributeToHistogram({
      bucket: testBucket,
      value: 1
    });
  }
}

register('send-report', SendReachReport);

Để tìm hiểu thêm về Bộ nhớ dùng chung, hãy xem mục bộ nhớ dùng chung trong hướng dẫn cho nhà phát triển báo cáo Protected Audience API, công cụ giải thích, bản minh hoạ trực tiếpmã minh hoạ trên GitHub.

What's next?

We want to engage in conversations with you to ensure we build an API that works for everyone.

Discuss the API

Like other Privacy Sandbox APIs, this API is documented and discussed publicly.

Experiment with the API

You can experiment and participate in conversation about the Protected Audience API.