Method: users.watch

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

בקשת HTTP

POST https://gmail.googleapis.com/gmail/v1/users/{userId}/watch

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

פרמטרים של נתיב

פרמטרים
userId

string

זוהי כתובת האימייל של המשתמש. אפשר להשתמש בערך המיוחד me כדי לציין את המשתמש המאומת.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "labelIds": [
    string
  ],
  "labelFilterAction": enum (LabelFilterAction),
  "labelFilterBehavior": enum (LabelFilterAction),
  "topicName": string
}
שדות
labelIds[]

string

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

enum (LabelFilterAction)

התנהגות הסינון של labelIds list שצוינה. השדה הזה הוצא משימוש כי הוא גרם להתנהגות שגויה במקרים מסוימים. במקום זאת, צריך להשתמש ב-labelFilterBehavior.
labelFilterBehavior

enum (LabelFilterAction)

התנהגות הסינון של labelIds list שצוינה. השדה הזה מחליף את labelFilterAction. אם הוא מוגדר, המערכת מתעלמת מ-labelFilterAction.
topicName

string

שם נושא מלא של Google Cloud Pub/Sub API שאליו רוצים לפרסם את האירועים. שם הנושא הזה חייב כבר להיות קיים ב-Cloud Pub/Sub, וחובה שכבר הענקתם ל-Gmail הרשאת 'פרסום' בנושא הזה. לדוגמה, 'projects/my-project-identifier/topics/my-topic-name' (באמצעות פורמט השמות של נושאים ב-Cloud Pub/Sub בגרסה 'v1').

שימו לב שהחלק my-project-identifier חייב להתאים בדיוק למזהה הפרויקט שלכם בתוכנית המפתחים של Google (זה שמפעיל את בקשת המעקב הזו).

גוף התשובה

תגובה לשעון של התראות.

אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "historyId": string,
  "expiration": string
}
שדות
historyId

string

המזהה של רשומת ההיסטוריה הנוכחית של תיבת הדואר.
expiration

string (int64 format)

המועד שבו Gmail יפסיק לשלוח התראות על עדכונים בתיבת הדואר הנכנס (epoch millis). עליך להתקשר שוב למספר watch לפני המועד הזה כדי לחדש את המינוי לשעון.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.readonly
  • https://www.googleapis.com/auth/gmail.metadata

מידע נוסף זמין במדריך ההרשאות.

LabelFilterAction

התנהגות הסינון של רשימת labelIds שצוינה.

טיפוסים בני מנייה (enum)
include קבלת התראות רק על שינויים בהודעות שקשורים למזהי התווית שצוינו.
exclude קבלת התראות על כל השינויים בהודעה, מלבד שינויים שקשורים למזהי התווית שצוינו.