REST Resource: subscriptions

{
  "name": string,
  "uid": string,
  "targetResource": string,
  "eventTypes": [
    string
  ],
  "payloadOptions": {
    object (PayloadOptions)
  },
  "notificationEndpoint": {
    object (NotificationEndpoint)
  },
  "state": enum (State),
  "suspensionReason": enum (ErrorType),
  "authority": string,
  "createTime": string,
  "updateTime": string,
  "reconciling": boolean,
  "etag": string,

  // Union field expiration can be only one of the following:
  "expireTime": string,
  "ttl": string
  // End of list of possible types for union field expiration.
}

string

זה שינוי אופציונלי. בלתי ניתן לשינוי. מזהה. שם המשאב של המינוי.

פורמט: subscriptions/{subscription}

string

פלט בלבד. מזהה ייחודי שהוקצה על ידי המערכת עבור המינוי.

string

חובה. בלתי ניתן לשינוי. המשאב ב-Google Workspace שנמצא במעקב אחרי אירועים, בפורמט של שם המשאב המלא. מידע נוסף על משאבי יעד והאירועים שהם תומכים בהם זמין במאמר אירועים נתמכים ב-Google Workspace.

המשתמש יכול לתת לאפליקציה הרשאה ליצור מינוי אחד בלבד למשאב יעד נתון. אם האפליקציה שלך תנסה ליצור מינוי נוסף עם אותם פרטי כניסה של משתמש, הבקשה תחזיר את השגיאה ALREADY_EXISTS.

string

חובה. בלתי ניתן לשינוי. רשימה לא ממוינת. קלט ליצירת מינוי. אחרת, יתבצע רק פלט. אחד או יותר מסוגי האירועים לקבלת מידע על משאב היעד. בפורמט שתואם למפרט CloudEvents.

סוגי האירועים הנתמכים תלויים במשאב היעד של המינוי. מידע נוסף מופיע במאמר על אירועים נתמכים ב-Google Workspace.

כברירת מחדל, תקבלו גם אירועים על מחזור החיים של המינוי. אין צורך לציין אירועים של מחזור חיים בשדה הזה.

אם מציינים סוג אירוע שלא קיים למשאב היעד, הבקשה מחזירה קוד סטטוס 400 Bad Request של HTTP.

object (PayloadOptions)

זה שינוי אופציונלי. אפשרויות לגבי הנתונים שצריך לכלול במטען הייעודי (Payload) של האירוע. הפעולה הזו נתמכת רק באירועים ב-Google Chat.

object (NotificationEndpoint)

חובה. בלתי ניתן לשינוי. נקודת הקצה שבה המינוי מספק אירועים, כמו נושא Pub/Sub.

enum (State)

פלט בלבד. מצב המינוי. המדיניות הזו קובעת אם המינוי יכול לקבל אירועים ולשלוח אותם לנקודת הקצה של ההתראה.

enum (ErrorType)

פלט בלבד. השגיאה שגרמה להשעיית המינוי.

כדי להפעיל מחדש את המינוי, פותרים את השגיאה וקוראים ל-method subscriptions.reactivate.

string

פלט בלבד. המשתמש שאישר את יצירת המינוי.

פורמט: users/{user}

למשתמשי Google Workspace, הערך {user} הוא השדה user.id מ-Directory API.

string (Timestamp format)

פלט בלבד. השעה שבה נוצר המינוי.

string (Timestamp format)

פלט בלבד. הפעם האחרונה שבה המינוי מתעדכן.

boolean

פלט בלבד. אם הערך שלו הוא true, המינוי בתהליך עדכון.

string

זה שינוי אופציונלי. השרת מחשב את סיכום הביקורת (checksum) הזה על סמך הערך של שדות אחרים, והוא עשוי להישלח בבקשות עדכון כדי לוודא שללקוח יש ערך עדכני לפני שממשיכים.

string (Timestamp format)

ברירת מחדל לא ריקה. חותמת הזמן לפי שעון UTC שבה יפוג תוקף המינוי. מוצג תמיד בפלט, ללא קשר למה שנעשה בו שימוש בקלט.

string (Duration format)

קלט בלבד. אורך החיים (TTL) או משך תקופת המינוי. אם הערך שהוגדר הוא 0 או לא צוין, ייעשה שימוש במשך הזמן המקסימלי האפשרי.

{
  "includeResource": boolean,
  "fieldMask": string
}

boolean

זה שינוי אופציונלי. האם המטען הייעודי של האירוע כולל נתונים על המשאב שהשתנה. לדוגמה: לאירוע שבו נוצרה הודעה ב-Google Chat, למשל אם המטען הייעודי (Payload) מכיל נתונים על המשאב Message. אם הערך הוא False, המטען הייעודי של האירועים כולל רק את שם המשאב שהשתנה.

string (FieldMask format)

זה שינוי אופציונלי. אם המדיניות includeResource מוגדרת לערך true, רשימת השדות שצריך לכלול במטען הייעודי (Payload) של האירועים. יש להפריד בין השדות באמצעות פסיק. לדוגמה, כדי לכלול שולח של הודעה ב-Google Chat ולקבוע שעת יצירה, צריך להזין message.sender,message.createTime. אם לא צוין אחרת, המטען הייעודי כולל את כל השדות של המשאב.

אם תציינו שדה שלא קיים עבור המשאב, המערכת תתעלם מהשדה.

{

  // Union field endpoint can be only one of the following:
  "pubsubTopic": string
  // End of list of possible types for union field endpoint.
}

string

בלתי ניתן לשינוי. הנושא ב-Cloud Pub/Sub שמקבל אירועים של המינוי.

פורמט: projects/{project}/topics/{topic}

צריך ליצור את הנושא באותו פרויקט ב-Google Cloud שבו יוצרים את המינוי.

כשהנושא מקבל אירועים, האירועים מקודדים כהודעות Cloud Pub/Sub. מידע נוסף מופיע במאמר בנושא קישור פרוטוקול Google Cloud Pub/Sub ל-CloudEvents.