מדידת נתונים ותוצאות של מכרזים ב-Protected Audience API
במאמר הזה מוצג סקירה כללית של המנגנונים השונים שזמינים לכם לדיווח על נתוני מכרזים של Protected Audience API לשרת שלכם, וגם של מנגנוני המעבר שזמינים לכם כרגע לשימוש במהלך המעבר עד שפתרונות חלופיים יהיו מוכנים.
כדי לדווח על מדדים חשובים שנאספים ממכרז של מודעות, Protected Audience API פועל עם:
- Private Aggregation, שמאפשר איסוף של אותות ותוצאות מהמכרז כדי ליצור דוחות סיכום.
- Ads Reporting API ל-Fenced Frames ול-iframes, שהוא ערוץ בתוך המסגרות לתקשורת עם worklets של Protected Audience API. ה-API מאפשר לשייך נתונים ברמת האירוע לאותות של מכרזים. הדיווח ברמת האירוע של Ads Reporting API הוא מנגנון מעבר עד שייבנה מנגנון דיווח פרטי יותר.
- דוחות שיוך שמאפשרים לשייך נתוני המרות לאותות מהמכרז.
- Shared Storage מאפשר לכתוב אותות של מכרזים באחסון חוצה מקורות, ואז לדווח על הנתונים האלה מאוחר יותר באמצעות Private Aggregation.
סקירה כללית על דיווח ב-Protected Audience API
יש שלושה פרקי זמן עיקריים שבהם אפשר לדווח לשרת על נתונים מתהליך המכרז של Protected Audience API: זמן המכרז, שבו המכרז מבוצע באתר בעל התוכן הדיגיטלי, זמן העיבוד, שבו המודעה מעובדת בתוך fenced frame או iframe באתר בעל התוכן הדיגיטלי, וזמן ההמרה, שבו המשתמש מבצע פעולה באתר אחר שאפשר לשייך למכרז.
במהלך המכירה הפומבית, אפשר לדווח על נתוני המכירה הפומבית באמצעות מודולים קטנים של דיווח. במהלך זמן הרינדור, אפשר לדווח על נתוני מעורבות מ-iframe או מ-fenced frame. במהלך זמן ההמרה, אפשר לדווח על נתוני שיוך מדף היעד באמצעות Attribution Reporting API.
דיווח על מיקומים
במהלך מכרז, הקונים יכולים לדווח על אותות שזמינים ב-worklets generateBid() ו-reportWin(), והמוכרים יכולים לדווח על אותות שזמינים ב-worklets scoreAd() ו-reportResult(). מחוץ למכרז, הקונים והמוכרים יכולים לדווח על נתונים מתוך מסגרת שבה המודעה הוצגה, ומתוך האתר שבו בוצעה ההמרה.
| תקופה | יעד | מיקום | יש נתונים זמינים | ממשקי API לדיווח שזמינים |
| מכרז | קונים | generateBid() |
אותות, תוצאות מכרזים וביצועים במכרזים | Private Aggregation API |
reportWin() |
Private Aggregation API Ads Reporting API |
|||
| מפיץ | scoreAd() |
Private Aggregation API | ||
reportResult() |
Private Aggregation API Ads Reporting API |
|||
| עיבוד | קונה / מוכר | מסגרת באתר של בעל התוכן הדיגיטלי | נתונים ברמת האירוע בתוך מסגרת המודעה | Private Aggregation API Ads Reporting API |
| המרה | קונה / מוכר | אתר המרות | נתונים ברמת ההמרה והאירוע מאתר ההמרה | Attribution Reporting API Private Aggregation API Ads Reporting API |
במהלך כל אחד מפרקי הזמן שמופיעים ברשימה, קונים ומוכרים יוכלו לגשת לממשקי API שונים של דיווח שזמינים לדיווח על נתונים כמו אותות מכרז, נתונים ברמת האירוע ונתוני המרות.
נתונים שזמינים במכרז בשילוב עם Protected Audience API
הנתונים הבאים זמינים לדיווח מתוך worklet של Protected Audience API במהלך המכרז.
אותות
אותות הם נתונים הקשריים של המכרז, נתוני משתמשים, נתונים בזמן אמת ונתוני דפדפן שזמינים לקונים ולמוכרים ב-worklet כדי ליצור הצעת מחיר, לתת ניקוד למודעה ולדווח על תוצאות המכרז.
| Signal | תיאור | הגדרת מיקום | משתמשים | זמינות |
| auctionSignals | הנתונים זמינים בהקשר של המקום שבו מתנהל המכרז. הנתונים האלה יכולים לכלול מידע על תוכן הדף, נתוני משתמשים מאינטראקציה ישירה (First-Party) ועוד. | המוכר מגדיר את הערך הזה באתר של המוציא לאור בהגדרות המכרז. | קונה מוכר |
generateBid scoreAd reportWin reportResult |
| directFromSellerSignals | אותם נתונים לגבי auctionSignals, perBuyerSignals, sellerSignals, אבל האותות מגיעים בוודאות מהמוכר שצוין. |
הגדרה דרך כותרות תגובת HTTP מהמוֹכר | קונה מוכר |
generateBid scoreAd reportWin reportResult |
| browserSignals | נתונים שונים שמסופקים על ידי הדפדפן (topWindowHostname, interestGroupOwner, renderUrl, adComponents, biddingDurationMsec, IGJoinCount, IGRecency, modelingSignals). |
מוגדר על ידי הדפדפן. | קונה מוכר |
generateBid scoreAd reportWin reportResult |
| sellerSignals | אותות שמועברים למוכר לצורך ניקוד המודעות. | המוכר מגדיר את הערך הזה באתר של המוציא לאור בהגדרות המכרז. | מפיץ | scoreAd reportWin reportResult |
| trustedScoringSignals | אותות בזמן אמת שמועברים למוכר לצורך דירוג המודעות. | המוכר מגדיר את כתובת האתר באתר של המוציא לאור בהגדרות המכרז. | מפיץ | scoreAd reportResult |
| perBuyerSignals | נתונים הקשריים של המכרז שמועברים לקונים ספציפיים. המוכר יכול לאחזר את הערכים של הקונים לפני תחילת המכרז. הידע של הקונה לגבי הזדמנות הפרסום. | המוכר מגדיר את הערך הזה באתר של המוציא לאור בהגדרות המכרז. | קונים | generateBid scoreAd reportWin reportResult |
| trustedBiddingSignals | אותות בזמן אמת שמועברים לקונים לצורך בידינג על מודעות. | כתובת ה-URL מוגדרת על ידי הקונה מאתר המפרסם כשהקבוצה מוגדרת. | קונים | generateBid |
| userBiddingSignals | נתוני משתמשים שסופקו על ידי הקונה. | ההגדרה מתבצעת על ידי הקונה באתר המפרסם כשהקבוצה לפי נושאים מוגדרת . | קונים | generateBid |
האובייקט auction config הוא מקור הנתונים העיקרי שמועבר כדי שיהיה זמין כסיגנלים ב-worklet. בעל האתר והמוכר יכולים לספק נתונים הקשריים ונתונים מאינטראקציה ישירה (First-Party) בהגדרות המכרז, ואפשר להעשיר את האותות האלה בנתונים של קבוצות אינטרסים מהקונה, בנתונים ברמת האירוע מהמסגרת של הצגת המודעה ובנתוני שיוך מהדף שאליו מגיעים אחרי קליק. אפשר להשתמש בנתונים שמדווחים לדיווח על קונים או מוכרים, לחיוב, לתקצוב, לאימון מודלים של למידת מכונה ועוד.
נתונים זמינים אחרים
- נתוני תוצאות שקשורים לנתוני זכייה והפסד במכרז, כמו מחיר הצעת המחיר הזוכה והסיבה לדחיית הצעת המחיר.
- נתוני ביצועים שכוללים מידע על זמן האחזור, כמו כמה זמן לקח לאחזר ולהפעיל את ה-worklet של הבידינג.
נתונים שזמינים מחוץ למכרז של Protected Audience API
מחוץ למכרז של Protected Audience API, יש שני פרקי זמן שבהם הנתונים זמינים לדיווח.
במהלך זמן הרינדור, כשהמודעה עוברת רינדור באתר של בעל התוכן הדיגיטלי, אפשר לשייך את הנתונים ברמת האירוע מתוך ה-iframe או ה-fenced frame לנתוני המכרז של Protected Audience API, ולדווח עליהם לשרת שלכם. דוגמאות לנתונים ברמת האירוע כוללות חשיפה של מודעה, קליק, ריחוף מעל מודעה וכל אירוע אחר שמתרחש בתוך המסגרת.
במהלך זמן ההמרה, כשמשתמש מבצע פעולה בדף המעבר בלחיצה שמשויכת למכרז, אפשר לשייך את הנתונים ברמת האירוע מדף ההמרה לנתוני המכרז של Protected Audience API ולדווח עליהם לשרת.
דיווח ברמת האירוע
בדוחות ברמת האירוע מפורט מידע מאירוע אחד או יותר. אירוע יכול להיות זכייה במכרז, חשיפה של מודעה או המרה. לפחות עד 2026, דיווח על זכייה במכרז ברמת האירוע יישאר בתוקף, לא יהיה צורך ב-fenced frames כדי להציג מודעה של Protected Audience, ואפשר יהיה להשתמש ב-iframe עם גישה בלתי מוגבלת לרשת לדיווח ברמת האירוע. בנוסף, Ads Reporting API זמין ב-fenced frames וב-iframes, כדי שתוכלו לשייך נתוני מכרז והמרה לנתונים ברמת האירוע מה-frame. המטרה היא להקל על המעבר של המערכת האקולוגית, כי תוכלו להמשיך להשתמש בתשתית הדיווח הקיימת לפחות עד 2026, בזמן שאתם מעבירים את המערכת אל Protected Audience.
דיווח על זכייה במכרז ברמת האירוע באמצעות sendReportTo()
sendReportTo() function הוא מנגנון שזמין לדיווח על נתונים ברמת האירוע בתוך מכרז של Protected Audience. הפונקציה זמינה ב-worklets של דוחות קונים ומוכרים, והדפדפן שולח בקשת GET למחרוזת כתובת ה-URL שסופקה כשהמודעה מתחילה להופיע. אתם יכולים לקודד כל אות שזמין ב-worklet כפרמטרים של שאילתה בכתובת ה-URL.
לדוגמה, קונה יכול לדווח על סכום הצעת המחיר הזוכה מתוך reportWin() ה-worklet למטרות חיוב:
// Buyer reporting worklet
function reportWin(auctionSignals, perBuyerSignals, sellerSignals, browserSignals, directFromSellerSignals) {
sendReportTo(`https://buyer-reporting-server.example/reporting?bid=${browserSignals.bid}`);
}
אפשר להשתמש בפונקציה sendReportTo() כדי ליצור דוח על זכייה בבקשה בשביל המוכר כשקוראים לה מ-reportResult(), ודוח על זכייה בבקשה בשביל הקונה כשקוראים לה מ-reportWin(). הפונקציה sendReportTo() זמינה לפחות עד 2026,
הדוח 'מעורבות' (Engagement)
דוח על אינטראקציות ראשוניות עם מודעה מכיל נתונים ברמת האירוע מנכס קריאייטיב של מודעה, כמו נתוני חשיפות או קליקים שמשויכים לאותות של מכרז Protected Audience API שבו המודעה הוצגה. המודעה מוצגת אחרי שהמכרז מסתיים, ולכן האותות מהמכרז לא זמינים בתוך המסגרת שבה המודעה מוצגת. כדי לשייך את הנתונים האלה מטווחי זמן שונים, אנחנו מספקים שני מנגנוני מעבר ליצירת דוחות על אינטראקציות ראשוניות עם העסק.
אפשר להשתמש בפונקציה sendReportTo() שמתוארת למעלה כדי לשייך נתוני מכרז לנתונים ברמת האירוע מ-iframe, אבל היא לא פועלת ב-fenced frame כי אי אפשר להעביר מזהה ייחודי מהקוד שמטמיע את ה-iframe, בגלל שהתקשורת בין הקוד שמטמיע את ה-iframe לבין ה-fenced frame מוגבלת. כדי לשייך נתוני מכרז לנתונים ברמת האירוע ממודעה ב-Fenced Frame, אפשר להשתמש ב-Ads Reporting API.
Ads Reporting API ל-fenced frames ול-iframes
Ads Reporting API ל-fenced frames ול-iframes מספק מנגנון לשיוך נתונים ברמת האירוע של משתמשים מתוך מסגרת של מודעה לאותות במכרז של Protected Audience.
ב-worklet של דיווח ב-Protected Audience API, אפשר לרשום משואת מודעה באמצעות הפונקציה registerAdBeacon() ולהעביר את כתובת ה-URL של הדיווח עם האותות שנוספו כפרמטרים של שאילתה. אתם גם מציינים את האירוע בהתאמה אישית שאתם רוצים לשייך לכתובת ה-URL של הדוחות. לאחר מכן, בשלב מאוחר יותר, כשהמודעה מוצגת במסגרת מוגבלת, אפשר להפעיל את האירוע המותאם אישית על ידי קריאה לפונקציה window.fence.reportEvent(). אפשר להוסיף את הנתונים שזמינים בתוך המסגרת המוגבלת כמטען ייעודי (payload).
הפונקציה registerAdBeacon() זמינה רק בפונקציות הדיווח, ולא זמינה בלוגיקת הבידינג של הקונה ובלוגיקת הניקוד של המוכר.
בדוגמה הבאה, מזהה קמפיין משויך למטען ייעודי (payload) ברמת האירוע עם קואורדינטות הקליק:
// 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 של דוחות על מודעות ב-Fenced Frames יהיה זמין לפחות עד 2026, מאותן סיבות שצוינו לגבי דוחות על ניצחונות.
למידע נוסף, אפשר לקרוא את ההסבר.
גישה בלתי מוגבלת לרשת
מסגרות מגודרות יאפשרו טעינה של משאבי רשת באותו אופן כמו ב-iframe, ותוכלו לשלוח נתונים ברמת האירוע במסגרות מגודרות לשרת שלכם. אפשר ליצור דוחות ברמת האירוע בצד השרת בשלב מאוחר יותר על ידי שיוך הנתונים ברמת האירוע מתוך fenced frame לנתוני המכרז שנשלחו עם sendReportTo(), כפי שמתואר בקטע מנגנון הדיווח ברמת האירוע על מכרזים שלמעלה.
בעתיד, הגישה לרשת תהיה מוגבלת.
דוח ייחוס למקורות תנועה
דוח שיוך (Attribution) מאפשר לכם לשייך המרה באתר למודעה שנבחרה ממכרז של Protected Audience API. לדוגמה, משתמש לוחץ על מודעת מוצר שמוצגת לו, מועבר לאתר של המפרסם, מבצע שם רכישה ואתם רוצים לשייך את הרכישה למודעה שהוצגה. Attribution Reporting API ישולב עם Protected Audience API כדי לשלב את נתוני המכרז מאתר בעל התוכן הדיגיטלי ואת נתוני ההמרות מאתר המפרסם.
בזמן שאנחנו עובדים על פתרון קבוע יותר, אתם יכולים להשתמש ב-Ads Reporting API עבור fenced frames כמנגנון מעבר ליצירת דוח ברמת האירוע ודוח ניתן לצבירה באמצעות Attribution Reporting. חשוב לזכור שהדוחות האלה מיועדים למדידת המרות, והם נפרדים מדוחות ההתעניינות ברמת האירוע ובצורה מצטברת שנוצרים מהמכרז וממסגרת המודעה. נפרסם הסבר על פתרון קבוע יותר כשהוא יהיה מוכן.
מנגנון מעבר
כשרושמים משואת מודעות, אפשר להשתמש במילת המפתח reserved.top_navigation. המערכת תוסיף באופן אוטומטי את הכותרת Attribution-Reporting-Eligible למשואה, כדי שהיא תעמוד בדרישות לרישום כמקור שיוך.
registerAdBeacon({
'reserved.top_navigation': 'https://adtech.example/click?buyer_event_id=123',
});
כדי לצרף נתונים ברמת האירוע למשואה שרשמתם, אתם יכולים לקרוא לפונקציה setReportEventDataForAutomaticBeacons() מהמסגרת המגודרת עם מטען הייעודי (payload) של האירוע.
window.fence.setReportEventDataForAutomaticBeacons({
eventType: 'reserved.top_navigation',
eventData: 'data from the frame',
destination:['seller', 'buyer']
})
מידע נוסף זמין בקטע בנושא Attribution Reporting ב-Ads Reporting API.
דוגמה לדיווח על מעורבות והמרות
בדוגמה הזו, נבחן את המצב מנקודת המבט של הקונה שמעוניין לשייך את הנתונים מהמכרז, ממסגרת המודעה ומאתר ההמרה.
בתהליך העבודה הזה, הקונה מתאם עם המוכר כדי לשלוח מזהה ייחודי למכרז. במהלך המכרז, הקונה שולח את המזהה הייחודי הזה עם נתוני המכרז. במהלך העיבוד וההמרה, הנתונים מהמסגרת המוגבלת או מה-iframe נשלחים גם הם עם אותו מזהה ייחודי. בהמשך, אפשר להשתמש במזהה הייחודי כדי לקשר בין הדוחות האלה.
Workflow:
- לפני שהמכרז מתחיל, הקונה שולח מזהה ייחודי למוכר כחלק מהתגובה שלו להצעת מחיר בבידינג בזמן אמת (RTB). אפשר להגדיר את המזהה כמשתנה כמו
auctionId. המזהה מועבר כ-perBuyerSignalsב-auctionConfigוהוא זמין ב-worklets של הקונים. - במהלך זמן המכרז, הקונה יכול לרשום משואה של מודעה שתופעל במהלך זמן הצגת המודעה וזמן ההמרה (
registerAdBeacon()).- כדי לשייך אותות של מכרז לאירוע של מסגרת מודעה, מגדירים את
auctionIdכפרמטר של שאילתה בכתובת ה-URL של ה-beacon. - כדי לשייך אותות של מכרז לאירוע המרה, מגדירים את
auctionIdבכתובת ה-URL של המשואה.
- כדי לשייך אותות של מכרז לאירוע של מסגרת מודעה, מגדירים את
- במהלך זמן העיבוד של המודעה, אפשר להפעיל את משואות ה-Beacon שרשמתם במהלך זמן המכרז או לשפר אותן באמצעות נתונים ברמת האירוע.
- מפעילים את אירוע ה-iframe באמצעות
reportEvent()ומעבירים את הנתונים ברמת האירוע. - הוספת מטען ייעודי (payload) ברמת האירוע למשואת השיוך באמצעות
setReportEventDataForAutomaticBeacons() - רושמים את המודעה ב-Attribution Reporting API באמצעות תגובה לבקשות של משואות (beacons) המודעות עם הכותרת
Attribution-Reporting-Register-Source.
- מפעילים את אירוע ה-iframe באמצעות
- במהלך זמן ההמרה, אפשר להפעיל את המקור שנרשם במהלך זמן המכרז.
אחרי התהליך שלמעלה, לקונה יהיו דוח מכרז, דוח מעורבות ודוח המרות, שכולם מקושרים באמצעות מפתח ייחודי יחיד שאפשר להשתמש בו כדי לשייך אותם זה לזה.
תהליך עבודה דומה חל על מוֹכר שזקוק לגישה לנתוני שיוך (Attribution), והמוֹכר יכול גם להשתמש במזהה ייחודי כדי לשלוח עם registerAdBeacon(). מהמסגרת, הקריאה reportEvent() מכילה נכס יעד שאפשר להשתמש בו כדי לשלוח את הדוח גם לקונה וגם למוכר. חשוב לזכור שפלטפורמת ה-SSP צריכה להופיע גם בדף הנחיתה כדי שהטריגר ישויך למקור.
צבירת נתונים של Protected Audience
Private Aggregation API הוא המנגנון שמשמש לדיווח על נתונים של Protected Audience כדי ליצור דוח סיכום, שהוא דוח מצטבר עם רעשי רקע של נתונים שנאספו בקטגוריות. באמצעות מפתח צבירה אפשר לייצג דלי, וחלק מהמידע יכול להיות מקודד במפתח.
לדוגמה, אפשר לספור אירוע של חשיפת מודעה בכמה קטגוריות שונות, כשכל קטגוריה מייצגת קמפיין מודעות אחר. דוח סיכום שונה מדוח ברמת האירוע בכך שהוא לא חושף מידע על כל אירוע בודד. בעזרת דוח ברמת האירוע, אפשר לראות שהמשתמשים א', ב' וג' ראו את קמפיין 123. בדוחות הסיכום אפשר למדוד את מספר המשתמשים שצפו בקמפיין 123, ונוספים נתונים מיותרים כדי להגן על פרטיות המשתמשים.
מידע נוסף על ה-API זמין במאמר בנושא Private Aggregation.
צבירת אותות מהמכרז
אתם יכולים לצבור את האותות שזמינים ב-worklets בשרת שלכם באמצעות Private Aggregation. כדי לצבור אותות, אפשר להשתמש בשיטה privateAggregation.contributeToHistogram() שזמינה ב-worklet של הצעת מחיר של הקונה, ב-worklet של דירוג המוכר וב-worklet של דיווח לקונה ולמוכר.
בדוגמה הזו, הצעת המחיר הזוכה מצטברת בקטגוריה של הבעלים של קבוצת האינטרס:
function convertBuyerToBucket(igOwner) {}
function convertWinningBidToValue(winningBid) {}
function reportResult(auctionConfig, browserSignals) {
privateAggregation.contributeToHistogram({
bucket: convertBuyerToBucket(browserSignals.interestGroupOwner),
value: convertWinningBidToValue(browserSignals.bid)
});
}
זהו המנגנון הכללי שבו משתמשים כשהאותות שרוצים לצבור לא משויכים לנתונים ברמת האירוע ולא מופעלים על ידי אירוע מחוץ למכרז. מידע נוסף על דיווח על אותות מכרז
צבירת אותות מהמכרז עם נתוני אירועים
אתם יכולים לצבור אותות מכרז עם מידע מוגבל על אירוע שמתרחש במסגרת מודעה. לדוגמה, אפשר ליצור מאגר שמייצג קמפיין מסוים ואירוע קליק, כדי למדוד באופן מצטבר כמה קליקים קיבלה מודעה בקמפיין. שימו לב: מתוך מסגרת המודעה, אפשר לציין איזה אירוע התרחש, אבל אי אפשר לצרף מטען ייעודי (payload) ברמת האירוע.
כדי לצבור אותות של מכרזים לפי אירועים, אפשר להשתמש ב-privateAggregation.contributeToHistogramOnEvent(eventType, contribution) שמקבל מחרוזת שמציינת את סוג האירוע ואת התרומה לדיווח כשהאירוע הזה מופעל. אפשר לקרוא לשיטה עם סוג אירוע מותאם אישית, ואז לקרוא ל-window.fence.reportEvent(eventType) מתוך מסגרת המודעה כדי להפעיל את שליחת הדוח.
נניח שאתם רוצים למדוד כמה קליקים קיבלה מודעה בקמפיין.
// 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
});
}
בפונקציה ליצירת הצעות מחיר, אפשר להגדיר קבוצה כצירוף של מזהה הקמפיין ואירוע הקליק, ואז להגדיל את הערך של הקבוצה ב-1 בכל פעם שהאירוע מופעל.
// Ad frame
window.fence.reportEvent('click');
אחר כך, בשלב מאוחר יותר, אפשר להפעיל את שליחת הדוח מתוך מסגרת המודעה על ידי קריאה ל-reportEvent(eventType):
במאמר הזה מוסבר איך להפעיל תרומות של Private Aggregation מתוך iframe.
דיווח על תוצאות וביצועים במכרז
אפשר גם לצבור תוצאות של מכרזים כשמופעל אירוע של זכייה או הפסד במכרז עם contributeToHistogramOnEvent(eventType, contribution) כשמעבירים מילות מפתח מסוג אירוע שמור (reserved.win, reserved.loss ו-reserved.always).
צבירה פרטית מספקת רשימה של ערכי בסיס שבעזרתם אפשר לחשב את הדלי ואת הערך של התרומה שלכם. ערכי הבסיס שזמינים לתוצאות המכרז הם ערך הצעת המחיר של המודעה הזוכה, ערך הצעת המחיר שדורגה במקום השני וסיבת הדחייה של הצעת מחיר מהמכרז.
אם מסופק ערך בסיסי כלשהו, כמו סכום הצעת המחיר הזוכה, אפשר להגדיר כמה להוסיף או לגרוע מהערך הזה, ואז לדווח על הערך הסופי. לדוגמה, אם הצעת המחיר הזוכה בסך 5 $מופיעה כערך הבסיס, אפשר להפחית ממנה את הצעת המחיר שלכם בסך 2 $כדי לחשב את הערך בפועל של 3 $שמשקף את ההפרש ביניכם לבין הצעת המחיר הזוכה.
דיווח על תוצאות המכרז
נבחן דוגמה שבה הפסדתם במכרז, ואתם רוצים לדעת מה היה ההפרש בין הצעת המחיר שלכם לבין מחיר הזכייה במכרז.
כדי לדעת בכמה הפסדתם במכרז, אתם יכולים להפחית את מחיר הצעת המחיר שלכם ממחיר הצעת המחיר הזוכה:
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
}
});
}
כששולחים את הדוח, הערך שמופיע בו הוא הערך המקורי baseValue אחרי שבוצע בו שינוי בקנה מידה של offset. מידע נוסף זמין בהסבר.
דיווח על ביצועים
קונים ומוכרים יכולים לדווח על משך הביצוע של סקריפט ועל משך האחזור של האותות המהימנים. מפיצים יכולים לאסוף את נתוני הזמן של יצירת הצעת המחיר ושל האותות המהימנים של הבידינג של כל קונה, באישורו.
מידע נוסף זמין בהסבר.
אחסון אותות של מכרזים ב-Shared Storage
אחסון משותף הוא אחסון לא מחולק שניתן לכתוב בו באופן חופשי, אבל יש בו שערים שמונעים קריאה ועיבוד של הערכים המאוחסנים. אחד משערי הגישה שזמינים ל-Shared Storage API הוא Private Aggregation. אפשר לקרוא את הערכים באחסון המשותף רק מתוך Worklet, ואפשר לדווח על הערכים האלה באמצעות Private Aggregation מתוך Worklet.
אפשר גם לכתוב ל-Shared Storage מתוך worklets של בידינג, ניקוד ודיווח ב-Protected Audience API. בשלב מאוחר יותר, תוכלו לדווח על הערכים האלה ב-Shared Storage לשרת שלכם באמצעות Private Aggregation . אפשר גם להשתמש בערכים המאוחסנים לפעולה URL Selection.
מ-worklet של Protected Audience API, אפשר לכתוב כל מפתח וערך ל-Shared Storage:
// Protected Audience API worklet
function generateBid() {
sharedStorage.set('test-bucket', 123);
}
בשלב מאוחר יותר, אפשר לטעון worklet של Shared Storage כדי לקרוא את הערך הזה ולשלוח אותו באמצעות Private Aggregation:
// 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);
מידע נוסף על Shared Storage זמין בקטע בנושא Shared Storage במדריך למפתחים בנושא Protected Audience API reporting, בהסבר, בהדגמה בזמן אמת ובקוד ההדגמה ב-GitHub.
מה השלב הבא?
אנחנו רוצים להיות מעורבים בשיחות כדי לוודא שאנחנו מפתחים API שעובד עבור כולם.
דיון על ה-API
כמו ממשקי API אחרים של ארגז החול לפרטיות, ממשק ה-API הזה מתועד ונושא דיון ציבורי.
התנסות עם ה-API
אתם יכולים לערוך ניסויים ולהשתתף בשיחה על Protected Audience API.