WebhookNotification

המדיניות הזו מגדירה משאב של פעולה ממושכת כך שישלח התראת webhook מ-Google Analytics Data API לשרת ה-webhook שלכם כשהמשאב מתעדכן.

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

ייצוג JSON 
{
  "uri": string,
  "channelToken": string
}
שדות
uri

string

זה שינוי אופציונלי. כתובת האינטרנט שאליה תישלח התראת ה-webhook. לכתובת הזו יתקבלו בקשות POST בהתאם לשינויים במשאב הפעולה הממושכת. בקשת ה-POST תכיל גם גרסת JSON של משאב הפעולה לטווח ארוך בגוף וגם שדה sentTimestamp. חותמת הזמן שנשלחת תציין את מיליוניות השנייה שחלפו מאז תחילת התקופה שבה הבקשה נשלחה. חותמת הזמן מאפשרת לכם לזהות התראות שהופעלו מחדש.

דוגמה ל-URI היא https://us-central1-example-project-id.cloudfunctions.net/example-function-1.

ה-URI חייב להשתמש ב-HTTPS ולהפנות לאתר עם אישור SSL חוקי בשרת האינטרנט. האורך המקסימלי של ה-URI הוא 128 תווים, וצריך להשתמש רק בתווים שברשימת ההיתרים מ-RFC 1738.

כששרת התגובה לפעולה מאתר אחר (webhook) מקבל התראה, הוא צפוי להשיב תוך 5 שניות עם קוד הסטטוס של תגובת HTTP: 200.

נדרש URI כדי להשתמש בהתראות webhook.

הבקשות לשרת ה-webhook הזה יכילו אסימון מזהה שמאמת את חשבון השירות google-analytics-audience-export@system.gserviceaccount.com. מידע נוסף על אסימונים מזהים זמין בכתובת https://cloud.google.com/docs/authentication/token-types#id. ב-Google Cloud Functions, אפשר להגדיר שהפונקציה תדרוש אימות. ב-Cloud IAM, צריך להעניק לחשבון השירות הרשאות ל-Cloud Run Invoker (roles/run.invoker) ול-Cloud Functions Invoker (roles/cloudfunctions.invoker) כדי שהתגובה לפעולה מאתר אחר (webhook) שתפורסם תעבור אימות של Google Cloud Functions. ה-API הזה יכול לשלוח התראות webhook למזהי URI שרירותיים. כשמדובר בשרתי webhook שאינם Google Cloud Functions, יש להתעלם מהאסימון המזהה הזה בכותרת של נושא ההרשאה אם אין בו צורך.
channelToken

string

זה שינוי אופציונלי. אסימון הערוץ הוא ערך מחרוזת שרירותי והוא צריך להיות באורך של 64 תווים לכל היותר. אסימוני ערוץ מאפשרים לך לאמת את המקור של התראה על תגובה לפעולה מאתר אחר (webhook). כך תוכלו להגן מפני הזיוף של ההודעה. אסימון הערוץ יצויין בכותרת ה-HTTP של X-Goog-Channel-Token של בקשת ה-webhook POST.

לא נדרש אסימון ערוץ כדי להשתמש בהתראות תגובה לפעולה מאתר אחר (webhook).