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 מקבל התראה, הוא אמור להשיב עם קוד סטטוס תגובה מסוג HTTP 200 תוך 5 שניות. כדי להשתמש בהתראות webhook, נדרש URI. בקשות לשרת ה-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) כדי שבקשת ה-post של ה-webhook תעבור את האימות של Google Cloud Functions. ממשק ה-API הזה יכול לשלוח התראות webhook למזהי URI שרירותיים. בשרתים של webhook שאינם Google Cloud Functions, צריך להתעלם מאסימון המזהה בכותרת של בעל ההרשאה אם הוא לא נדרש.
|
channelToken |
string
זה שינוי אופציונלי. אסימון הערוץ הוא ערך מחרוזת שרירותי, והאורך המקסימלי של המחרוזת הוא 64 תווים. טוקני ערוץ מאפשרים לכם לאמת את המקור של התראה מ-webhook. כך אפשר למנוע זיוף של ההודעה. אסימון הערוץ יופיע בכותרת ה-HTTP X-Goog-Channel-Token של בקשת ה-POST ל-webhook. לא נדרש אסימון ערוץ כדי להשתמש בהתראות webhook.
|
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2024-11-20 (שעון UTC).
[null,null,["עדכון אחרון: 2024-11-20 (שעון UTC)."],[[["Webhook notifications can be configured for long-running operations in the Google Analytics Data API to send updates to your server."],["These notifications are project-specific and include a JSON payload with operation details and a timestamp."],["The webhook configuration requires a URI using HTTPS with a valid SSL certificate, and optionally, a channel token for verification."],["When receiving a notification, your server should respond with an HTTP 200 status code within 5 seconds."],["Authentication for Google Cloud Functions is provided through an ID token representing the service account `google-analytics-audience-export@system.gserviceaccount.com`, while other webhook servers can ignore this token."]]],[]]
