משאב: Subscription
ייצוג ב-JSON |
---|
{ "name": string, "uid": string, "targetResource": string, "eventTypes": [ string ], "payloadOptions": { object ( |
שדות | |
---|---|
name |
מזהה. שם המשאב של המינוי. פורמט: |
uid |
פלט בלבד. מזהה ייחודי שהמערכת מקצה למינויים. |
targetResource |
חובה. קבוע. משאב Google Workspace שנעקב אחרי אירועים, בפורמט של שם המשאב המלא. מידע נוסף על משאבי היעד ועל האירועים שהם תומכים בהם זמין במאמר אירועים נתמכים ב-Google Workspace. משתמש יכול להעניק לאפליקציה הרשאה ליצור רק מינוי אחד למשאב יעד נתון. אם האפליקציה תנסה ליצור מינוי נוסף עם אותם פרטי כניסה של משתמש, הבקשה תחזיר שגיאה מסוג |
eventTypes[] |
חובה. רשימה לא ממוינת. קלט ליצירת מינוי. אחרת, פלט בלבד. אחד או יותר מסוגי האירועים לקבלת מידע על משאב היעד. הפורמט תואם למפרט של CloudEvents. סוגי האירועים הנתמכים תלויים במשאב היעד של המינוי. פרטים נוספים זמינים במאמר אירועים נתמכים ב-Google Workspace. כברירת מחדל, אתם מקבלים גם אירועים לגבי מחזור החיים של המינוי. אין צורך לציין אירועים של מחזור חיים בשדה הזה. אם מציינים סוג אירוע שלא קיים במשאב היעד, הבקשה מחזירה את קוד הסטטוס |
payloadOptions |
זה שינוי אופציונלי. אפשרויות לגבי הנתונים שרוצים לכלול בתוכן של האירוע. הפעולה הזו נתמכת רק באירועים ב-Google Chat. |
notificationEndpoint |
חובה. קבוע. נקודת הקצה שבה המינויים מעבירים אירועים, כמו נושא Pub/Sub. |
state |
פלט בלבד. המצב של המינוי. המדיניות הזו קובעת אם המינוי יכול לקבל אירועים ולשלוח אותם לנקודת הקצה של ההתראה. |
suspensionReason |
פלט בלבד. השגיאה שגרמה להשעיית המינוי. כדי להפעיל מחדש את המינוי, צריך לפתור את השגיאה ולקרוא ל-method |
authority |
פלט בלבד. המשתמש שהעניק הרשאה ליצירת המינוי. פורמט: למשתמשי Google Workspace, הערך |
createTime |
פלט בלבד. המועד שבו נוצר המינוי. |
updateTime |
פלט בלבד. הפעם האחרונה שבה המינוי עודכן. |
reconciling |
פלט בלבד. אם הערך הוא |
etag |
זה שינוי אופציונלי. השרת מחשב את סיכום הביקורות הזה על סמך הערכים של שדות אחרים, ויכול לשלוח אותו בבקשות לעדכון כדי לוודא שללקוח יש ערך עדכני לפני שהוא ממשיך. |
שדה האיחוד זמן התפוגה המקסימלי תלוי בשאלה אם המינוי כולל נתוני משאבים במטענים ייעודיים (payloads) של אירועים (מצוין בשדה
אחרי שתוקף המינוי יפוג, הוא נמחק באופן אוטומטי. מקבלים אירועים במחזור החיים של כדי למנוע את תפוגת התוקף של מינוי, אפשר להשתמש בשיטה |
|
expireTime |
ברירת מחדל לא ריקה. חותמת הזמן לפי שעון UTC שבה יפוג תוקף המינוי. תמיד מוצג בפלט, ללא קשר למה שנעשה בו שימוש בקלט. |
ttl |
קלט בלבד. אורך החיים (TTL) או משך תקופת המינוי. אם לא צוין ערך או שהוגדר הערך |
PayloadOptions
אפשרויות לגבי הנתונים שרוצים לכלול בתוכן של האירוע. הפעולה הזו נתמכת רק באירועים ב-Google Chat.
ייצוג ב-JSON |
---|
{ "includeResource": boolean, "fieldMask": string } |
שדות | |
---|---|
includeResource |
זה שינוי אופציונלי. האם המטען הייעודי של האירוע כולל נתונים על המשאב שהשתנה. לדוגמה: לאירוע שבו נוצרה הודעה ב-Google Chat, למשל אם המטען הייעודי (Payload) מכיל נתונים על המשאב |
fieldMask |
זה שינוי אופציונלי. אם הערך של אם מציינים שדה שלא קיים במשאב, המערכת מתעלמת מהשדה. |
NotificationEndpoint
נקודת הקצה (endpoint) שבה המינוי מעביר אירועים.
ייצוג ב-JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה האיחוד הערך של |
|
pubsubTopic |
קבוע. הנושא ב-Cloud Pub/Sub שבו מתקבלים אירועים עבור המינוי. פורמט: צריך ליצור את הנושא באותו פרויקט ב-Google Cloud שבו יוצרים את המינוי. כשהנושא מקבל אירועים, האירועים מקודדים כהודעות של Cloud Pub/Sub. פרטים נוספים זמינים במאמר קישור פרוטוקול של Google Cloud Pub/Sub ל-CloudEvents. |
מדינה
המצבים האפשריים של המינוי.
טיפוסים בני מנייה (enum) | |
---|---|
STATE_UNSPECIFIED |
ערך ברירת המחדל. הערך הזה לא בשימוש. |
ACTIVE |
המינוי פעיל ויכול לקבל ולשלוח אירועים לנקודת הקצה שלו של ההתראות. |
SUSPENDED |
המינוי לא יכול לקבל אירועים בגלל שגיאה. כדי לזהות את השגיאה, בודקים את השדה . |
DELETED |
המינוי נמחק. |
ErrorType
שגיאות אפשריות במינוי.
טיפוסים בני מנייה (enum) | |
---|---|
ERROR_TYPE_UNSPECIFIED |
ערך ברירת המחדל. הערך הזה לא בשימוש. |
USER_SCOPE_REVOKED |
המשתמש המאשר ביטל את ההקצאה של היקף OAuth אחד או יותר. מידע נוסף על הרשאה ל-Google Workspace זמין במאמר הגדרת מסך ההסכמה של OAuth. |
RESOURCE_DELETED |
משאב היעד של המינוי כבר לא קיים. |
USER_AUTHORIZATION_FAILURE |
למשתמש שהעניק הרשאה ליצירת המינוי אין יותר גישה למשאב היעד של המינוי. |
ENDPOINT_PERMISSION_DENIED |
לאפליקציית Google Workspace אין גישה להעברת אירועים לנקודת הקצה של ההתראות של המינוי שלך. |
ENDPOINT_NOT_FOUND |
נקודת הקצה לקבלת התראות של המינוי לא קיימת, או שלא ניתן למצוא את נקודת הקצה בפרויקט ב-Google Cloud שבו יצרתם את המינוי. |
ENDPOINT_RESOURCE_EXHAUSTED |
נקודת הקצה לקבלת התראות של המינוי לא הצליחה לקבל אירועים בגלל מכסה לא מספיקה או הגעה למגבלת הקצב. |
OTHER |
אירעה שגיאה לא מזוהה. |