תחילת העבודה עם דוחות שיוך (Attribution)

כאן מתחילים, כולל ההגדרה וסקירה כללית קצרה.

בחירת סוג הדוח

באמצעות Attribution Reporting API אפשר ליצור שני סוגי דוחות: דוחות ברמת האירוע ודוחות סיכום. דוחות ברמת האירוע דורשים פחות הגדרה מאשר דוחות נצברים או דוחות סיכום, ולכן מומלץ להתחיל בהם. כדי ליצור דוחות סיכום צריך לשלב אותם עם שירות הצבירה. לא בדוחות ברמת האירוע.

אפשר להגדיר דוחות גם ברמת האירוע וגם לדוחות סיכום. השימוש בהם משלים.

דוחות ברמת האירוע

דוחות ברמת האירוע משייכים צפייה מסוימת או קליק מסוים על מודעה (בצד המודעה) לנתונים מצד ההמרות. כדי לשמור על פרטיות המשתמשים על ידי הגבלת האיחוד של זהות המשתמשים באתרים שונים, הנתונים בצד ההמרה מוגבלים מאוד והנתונים רועשים.

דוחות סיכום

דוח סיכום הוא סוג הדוח Attribution Reporting API ו-Private Aggregation API. סיכום כולל נתוני משתמשים נצברים, ויכול לכלול נתוני המרות מפורטים, יחד עם רעשי רקע. דוחות סיכום מורכבים מדוחות מצטברים. דוחות סיכום מאפשרים גמישות רבה יותר ומודל נתונים עשיר יותר מאשר הדוחות ברמת האירוע, במיוחד בתרחישים מסוימים, כמו ערכי המרות.

הטמעה

כדי להתחיל, נסו את השלבים הבאים.

לתשומת ליבכם: למקור אירוע נתון, אפשר ליצור גם ברמת האירוע ובדוח מצטבר. הדגמה תדריך אתכם בתהליך.

יצירת דוח ברמת האירוע

כדי ליצור דוחות ברמת האירוע, צריך לפעול לפי השלבים המינימליים:

  1. לרישום מקור. הוראות מופיעות במאמר רישום מקורות שיוך. לתשומת ליבכם: השלבים שונים עבור קליקים וצפיות.

  2. רושמים טריגר. הוראות מפורטות במאמר רישום טריגרים של שיוך (Attribution).

  3. מגדירים נקודת קצה עם כתובת ה-URL הבאה:
    {REPORTING_ENDPOINT}/.well-known/attribution-reporting/report-event-attribution
    ניתן לעיין בקוד לדוגמה ב-adtech.js כדי לראות את שיטת POST. מידע נוסף על .well-known זמין ב-wikipedia.

פרטים נוספים זמינים בהסבר על הדוח ברמת האירוע.

יצירת דוח סיכום

כדי להפיק דוחות סיכום, צריך לבצע את השלבים הכלליים הבאים:

  1. לרישום מקור. הוראות מופיעות במאמר רישום מקורות שיוך. לתשומת ליבכם: השלבים שונים עבור קליקים וצפיות. פרטים נוספים זמינים בקטע רישום מקור השיוך.

  2. רושמים טריגר. הוראות מפורטות במאמר רישום טריגרים של שיוך (Attribution).

  3. מגדירים נקודת קצה (endpoint) לדוחות נצברים עם כתובת ה-URL הבאה:
    {REPORTING_ENDPOINT}/.well-known/attribution-reporting/report-aggregate-attribution
    ניתן לעיין בקוד לדוגמה ב-adtech.js כדי לראות את שיטת POST. מידע נוסף על .well-known זמין ב-wikipedia.

  4. אצווה ושליחה של הדוחות להמשך עיבוד על ידי שירות הצבירה, שיפיק דוחות סיכום. ניתן לעיין בדוחות נצברים מצטברים.

פרטים נוספים זמינים בהסבר על הדוח המצטבר.

בסדרת ניפוי הבאגים בדוחות השיוך (Attribution) מוסבר איך להגדיר דוחות ניפוי באגים.

דוחות סיכום מושגים נוספים

בנוסף להבנת שלבי ההטמעה בקטע הזה, המושגים הבאים יעזרו לכם לתכנן את אסטרטגיית הדיווח המסכם:

שלבים אופציונליים

  1. הגדרת מסננים (אופציונלי):
    1. פועלים לפי ההוראות ב הגדרת כללים בהתאמה אישית באמצעות מסננים
    2. עיון בפרטים ספציפיים למסננים של דוחות נצברים בקטע בקטע של הטריגרים הסברים.

לא לשכוח את זיהוי התכונות

לפני שמשתמשים ב-API, חשוב לזהות אם הוא לא נחסם בדף באמצעות מדיניות הרשאות. כדי לעשות את זה, מריצים את הקוד הבא:

if (document.featurePolicy.allowsFeature('attribution-reporting')) {
  // the Attribution Reporting API is enabled
}

אם בדיקת זיהוי התכונות הזו מחזירה True, ה-API מותר בהקשר (דף) שבו מתבצעת הבדיקה.

שימו לב שהבדיקה הזו בלבד לא מבטיחה שאפשר להשתמש ב-API בדף הזה. יכול להיות שהמשתמש השבית את ה-API דרך הגדרות הדפדפן, או שיש לו הגדרות אחרות שמונעות את השימוש ב-API. כדי להגן על פרטיות המשתמשים, אין דרך לבדוק את זה באופן פרוגרמטי.

השלבים הבאים

אם אתם מוכנים להתחיל בהטמעה, אפשר לעיין במסמכים הבאים:

הגדרה

רקע

הדגמות וכלים

תכנון

אם אתם עדיין בשלב התכנון, כדאי לעיין במסמכים הבאים: