משאב: מנוי
ייצוג JSON |
---|
{ "name": string, "uid": string, "targetResource": string, "eventTypes": [ string ], "payloadOptions": { object ( |
שדות | |
---|---|
name |
אפשרות. בלתי משתנה. מזהה. שם המשאב של המינוי. פורמט: |
uid |
פלט בלבד. מזהה ייחודי שהוקצה על ידי המערכת עבור המינוי. |
targetResource |
חובה. בלתי משתנה. המשאב ב-Google Workspace שאחריו מתבצע מעקב אחרי אירועים, בפורמט של שם המשאב המלא. מידע נוסף על משאבי היעד והאירועים הנתמכים זמין במאמר אירועים נתמכים ב-Google Workspace. משתמש יכול לתת לאפליקציה הרשאה ליצור מינוי אחד בלבד למשאב יעד נתון. אם האפליקציה תנסה ליצור מינוי אחר עם אותם פרטי כניסה של המשתמש, הבקשה תחזיר את השגיאה |
eventTypes[] |
חובה. בלתי משתנה. רשימה לא ממוינת. קלט ליצירת מינוי. אחרת, פלט רק. סוג אחד או יותר של אירועים לקבל לגבי משאב היעד. בפורמט שתואם למפרט של CloudEvents. סוגי האירועים הנתמכים תלויים במשאב היעד של המינוי. לפרטים נוספים, קראו את המאמר אירועים נתמכים ב-Google Workspace. כברירת מחדל, תקבלו גם אירועים שקשורים למחזור החיים של המינוי שלכם. אין צורך לציין אירועים במחזור החיים בשדה הזה. אם מציינים סוג אירוע שאינו קיים למשאב היעד, הבקשה תחזיר את קוד הסטטוס |
payloadOptions |
אפשרות. אפשרויות לגבי הנתונים שיש לכלול במטען הייעודי (payload) של האירוע. התכונה נתמכת רק עבור אירועים ב-Google Chat. |
notificationEndpoint |
חובה. בלתי משתנה. נקודת הקצה שבה המינוי מעביר אירועים, כמו נושא Pub/Sub. |
state |
פלט בלבד. מצב המינוי. המדיניות קובעת אם המינוי יכול לקבל אירועים ולהעביר אותם לנקודת הקצה של ההתראות. |
suspensionReason |
פלט בלבד. השגיאה שגרמה להשעיית המינוי. כדי להפעיל מחדש את המינוי, צריך לפתור את השגיאה ולהתקשר לשיטה |
authority |
פלט בלבד. המשתמש שאישר את יצירת המינוי. פורמט: למשתמשי Google Workspace, הערך |
createTime |
פלט בלבד. השעה שבה המינוי נוצר. |
updateTime |
פלט בלבד. הפעם האחרונה שהמינוי מתעדכן. |
reconciling |
פלט בלבד. אם |
etag |
אפשרות. סיכום הביקורת הזה מחושב על ידי השרת על סמך הערך של שדות אחרים, ועשוי להישלח כששולחים בקשות עדכון כדי לוודא שללקוח יש ערך עדכני לפני המשך התהליך. |
שדה איחוד זמן התפוגה המקסימלי תלוי בשאלה אם המינוי כולל נתוני משאבים במטענים ייעודיים (payloads) של אירועים (מצוין בשדה
כשתוקף המינוי פג, הוא נמחק באופן אוטומטי. יתקבלו אירועים במחזור החיים של כדי שתוקף של מינוי לא יפוג, אפשר להשתמש בשיטה |
|
expireTime |
שדה ברירת המחדל לא ריק. חותמת הזמן לפי שעון UTC (זמן אוניברסלי מתואם) של המינוי. תמיד מוצג בפלט, ללא קשר למה שנעשה בו שימוש בקלט. |
ttl |
קלט בלבד. משך החיים (TTL) או משך המינוי. אם לא צוין או מוגדר הערך |
PayloadOptions
אפשרויות לגבי הנתונים שיש לכלול במטען הייעודי (payload) של האירוע. התכונה נתמכת רק עבור אירועים ב-Google Chat.
ייצוג JSON |
---|
{ "includeResource": boolean, "fieldMask": string } |
שדות | |
---|---|
includeResource |
אפשרות. האם המטען הייעודי של האירוע כולל נתונים על המשאב שהשתנה. לדוגמה, באירוע שבו נוצרה הודעה ב-Google Chat, האם המטען הייעודי מכיל נתונים על המשאב |
fieldMask |
אפשרות. אם המדיניות אם תציינו שדה שלא קיים עבור המשאב, המערכת תתעלם מהשדה. |
NotificationEndpoint
נקודת הקצה שבה המינוי מעביר אירועים.
ייצוג JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד
|
|
pubsubTopic |
בלתי משתנה. הנושא ב-Cloud Pub/Sub שמקבל אירועים עבור המינוי. פורמט: עליכם ליצור את הנושא באותו פרויקט ב-Google Cloud שבו יצרתם את המינוי הזה. כשהנושא מקבל אירועים, האירועים מקודדים כהודעות Cloud Pub/Sub. פרטים נוספים זמינים במאמר קישור של פרוטוקול Google Cloud Pub/Sub for CloudEvents. |
ארץ
מצבים אפשריים למינוי.
טיפוסים בני מנייה (enums) | |
---|---|
STATE_UNSPECIFIED |
ערך ברירת המחדל. הערך הזה לא בשימוש. |
ACTIVE |
המינוי פעיל ויכול לקבל אירועים ולשלוח אותם לנקודת הקצה של ההתראות. |
SUSPENDED |
אי אפשר לשלוח אירועים במינוי עקב שגיאה. כדי לזהות את השגיאה, אפשר לבדוק את השדה . |
DELETED |
המינוי נמחק. |
ErrorType
שגיאות אפשריות במינוי.
טיפוסים בני מנייה (enums) | |
---|---|
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 |
אירעה שגיאה לא מזוהה. |
שיטות |
|
---|---|
|
יצירת מינוי ל-Google Workspace. |
|
מחיקת המינוי ל-Google Workspace. |
|
קבלת פרטים על מינוי ל-Google Workspace. |
|
בתיבת הדו-שיח הזו מפורטים המינויים ל-Google Workspace. |
|
עדכון או חידוש של המינוי ל-Google Workspace. |
|
הפעלה מחדש של מינוי ל-Google Workspace שהושעה. |