מטא-נתונים לסוגים שונים של webhooks. אם משתמשים ב-inlineCloudFunction
, קוד המקור חייב להיות בספרייה עם שם שזהה לערך של המפתח executeFunction
. לדוגמה, לערך של my_webhook
עבור המפתח executeFunction
יהיה מבנה קוד כמו: - /webhooks/my_webhook.yaml
- /webhooks/my_webhook/index.js
- /webhooks/my_webhook/package.json
ייצוג YAML | |
---|---|
handlers: - object ( |
שדות | ||
---|---|---|
handlers[] |
רשימת גורמי handler ל-webhook הזה. |
|
שדה איחוד webhook_type . יש תמיכה רק בסוג אחד של תגובה לפעולה מאתר אחר (webhook). הערך של webhook_type יכול להיות רק אחת מהאפשרויות הבאות: |
||
httpsEndpoint |
נקודת קצה (endpoint) מסוג webhook HTTPS בהתאמה אישית. |
|
inlineCloudFunction |
מטא-נתונים של הפונקציה ב-Cloud Functions שנפרסה מקוד בתיקיית ה-webhooks. |
מטפל
הצהרה על השם של ה-handler של webhoook. ל-webhook יכולים להיות כמה גורמי handler רשומים. אפשר לקרוא לרכיבי ה-handler האלה מכמה מקומות בפרויקט הפעולות.
ייצוג YAML | |
---|---|
name: string |
שדות | |
---|---|
name |
חובה. שם ה-handler. חייב להיות ייחודי בכל ה-handlers בפרויקט הפעולות. אפשר לבדוק את השם של ה-handler הזה כדי להפעיל את הפונקציה הנכונה בקוד המקור של מילוי הבקשה. |
HttpsEndpoint
נקודת הקצה של REST לקבלת התראה אם אתם לא משתמשים בעורך המוטבע.
ייצוג YAML | |
---|---|
baseUrl: string httpHeaders: string: string endpointApiVersion: integer |
שדות | |
---|---|
baseUrl |
כתובת ה-URL הבסיסית מסוג HTTPS של נקודת הקצה של מילוי הבקשה (אין תמיכה ב-HTTP). שמות של כינויים מצורפים לנתיב כתובת ה-URL הבסיסית אחרי נקודתיים (לפי מדריך הסגנון בכתובת https://cloud.google.com/apis/design/custom_methods). לדוגמה, כתובת ה-URL הבסיסית 'https://gactions.service.com/api' תקבל בקשות עם כתובת ה-URL 'https://gactions.service.com/api:{method}'. |
httpHeaders |
מפה של הפרמטרים של HTTP שיש לכלול בבקשת ה-POST. אובייקט שמכיל רשימה של |
endpointApiVersion |
גרסת הפרוטוקול המשמשת את נקודת הקצה. זה הפרוטוקול שמשותף לכל סוגי מילוי ההזמנות, ולא ספציפי לסוג מילוי הבקשה ב-Google. |
InlineCloudFunction
מכילה את המטא-נתונים של פונקציה מוטבעת ב-Cloud Functions שנפרסה מתיקיית ה-webhooks.
ייצוג YAML | |
---|---|
executeFunction: string |
שדות | |
---|---|
executeFunction |
שם נקודת הכניסה של הפונקציה ב-Cloud Functions. הערך בשדה הזה צריך להתאים לשם השיטה שיוצאה מקוד המקור. |