WebhookNotification

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

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

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

string

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

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

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

כששרת ה-webhook מקבל התראה, הוא אמור להשיב עם קוד הסטטוס 200 של תגובת HTTP תוך 5 שניות.

נדרש 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.