Method: users.watch

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

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של 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" (באמצעות הפורמט של שמות הנושאים "v1" ב-Cloud Pub/Sub).

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

גוף התשובה

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

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

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

string

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

string (int64 format)

מתי Gmail יפסיק לשלוח התראות על עדכונים בתיבת הדואר (ראשית זמן אלפיות שנייה). כדי לחדש את השעון, צריך להתקשר שוב אל 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 קבלת התראות רק על שינויים בהודעות שקשורים למזהי ה-labelId שצוינו.
exclude קבלת התראות על כל השינויים בהודעה, חוץ מאלה שצוינו במזהי התוויות שצוינו.