Method: users.watch

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

בקשת 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

רשימה של labelIds שצריך להגביל את ההתראות לגביהם. כברירת מחדל, אם לא צוין, כל השינויים נדחים. אם צוין, המדיניות הזו קובעת אילו תוויות נדרשות ליצירת התראת Push.
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').

שימו לב שהחלק 'מזהה הפרויקט שלי' חייב להיות זהה למזהה פרויקט המפתח ב-Google (המזהה שמבצע את בקשת הצפייה הזו).

גוף התגובה

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

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

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

string

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

string (int64 format)

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

טיפוסים בני מנייה (enums)
include קבלת התראות רק לגבי שינויים בהודעות שקשורים ל-labelIds שצוינו.
exclude קבלת התראות על כל השינויים בהודעות מלבד אלה שקשורים ל-labelIds שצוינו.